Explainable (Flink : 2.0-SNAPSHOT API)

All Known Subinterfaces:

CompiledPlan, StatementSet, StreamStatementSet, Table, TablePipeline

All Known Implementing Classes:

StatementSetImpl, StreamStatementSetImpl, TableImpl
```
@PublicEvolving
public interface Explainable<SELF extends Explainable<SELF>>
```
Represents an artifact that can be explained using a summary string.

See Also:

explain(ExplainDetail...)

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default String`	`explain(ExplainDetail... extraDetails)`	Returns the AST of this object and the execution plan to compute the result of the given statement.
`String`	`explain(ExplainFormat format, ExplainDetail... extraDetails)`	Returns the AST of this object and the execution plan to compute the result of the given statement.
`default SELF`	`printExplain(ExplainDetail... extraDetails)`	Like `explain(ExplainDetail...)`, but piping the result to `System.out`.

- Method Detail
  - explain
```
default String explain(ExplainDetail... extraDetails)
```
    Returns the AST of this object and the execution plan to compute the result of the given statement.
    
    Parameters:
    
    extraDetails - The extra explain details which the result of this method should include, e.g. estimated cost, changelog mode for streaming
    
    Returns:
    
    AST and the execution plan.
  - explain
```
String explain(ExplainFormat format,
               ExplainDetail... extraDetails)
```
    Returns the AST of this object and the execution plan to compute the result of the given statement.
    
    Parameters:
    
    format - The output format of explained plan
    
    extraDetails - The extra explain details which the result of this method should include, e.g. estimated cost, changelog mode for streaming
    
    Returns:
    
    AST and the execution plan.
  - printExplain
```
default SELF printExplain(ExplainDetail... extraDetails)
```
    Like explain(ExplainDetail...), but piping the result to System.out.