org.apache.flink.table.api.internal

Interface TableEnvironmentInternal

All Superinterfaces:

TableEnvironment

All Known Implementing Classes:

StreamTableEnvironmentImpl, TableEnvironmentImpl

@Internal
public interface TableEnvironmentInternal
extends TableEnvironment

An internal interface of TableEnvironment that defines extended methods used for TableImpl.

Once old planner is removed, this class also can be removed. By then, these methods can be moved into TableEnvironmentImpl.

Method Summary

Modifier and Type	Method and Description
TableResult	executeInternal(List<ModifyOperation> operations) Execute the given modify operations and return the execution result.
TableResult	executeInternal(Operation operation) Execute the given operation and return the execution result.
TableResult	executeJsonPlan(String jsonPlan) Execute the given json plan, and return the execution result.
String	explainInternal(List<Operation> operations, ExplainDetail... extraDetails) Returns the AST of this table and the execution plan to compute the result of this table.
String	explainJsonPlan(String jsonPlan, ExplainDetail... extraDetails) Returns the execution plan for the given json plan.
CatalogManager	getCatalogManager() Returns a CatalogManager that deals with all catalog objects.
String	getJsonPlan(List<ModifyOperation> operations) Get the json plan for the given ModifyOperations.
String	getJsonPlan(String stmt) Get the json plan for the given statement.
OperationTreeBuilder	getOperationTreeBuilder() Returns a OperationTreeBuilder that can create QueryOperations.
Parser	getParser() Return a Parser that provides methods for parsing a SQL string.
void	registerTableSinkInternal(String name, TableSink<?> configuredSink) Registers an external TableSink with already configured field names and field types in this TableEnvironment's catalog.
void	registerTableSourceInternal(String name, TableSource<?> tableSource) Registers an external TableSource in this TableEnvironment's catalog.

Methods inherited from interface org.apache.flink.table.api.TableEnvironment

create, create, createFunction, createFunction, createStatementSet, createTable, createTemporaryFunction, createTemporaryFunction, createTemporarySystemFunction, createTemporarySystemFunction, createTemporaryTable, createTemporaryView, dropFunction, dropTemporaryFunction, dropTemporarySystemFunction, dropTemporaryTable, dropTemporaryView, execute, executeSql, explain, explain, explain, explainSql, from, from, fromTableSource, fromValues, fromValues, fromValues, fromValues, fromValues, fromValues, getCatalog, getCompletionHints, getConfig, getCurrentCatalog, getCurrentDatabase, insertInto, insertInto, listCatalogs, listDatabases, listFullModules, listFunctions, listModules, listTables, listTemporaryTables, listTemporaryViews, listUserDefinedFunctions, listViews, loadModule, registerCatalog, registerFunction, registerTable, scan, sqlQuery, sqlUpdate, unloadModule, useCatalog, useDatabase, useModules

Method Detail

getParser

Parser getParser()

Return a Parser that provides methods for parsing a SQL string.

Returns:

initialized Parser.

getCatalogManager

CatalogManager getCatalogManager()

Returns a CatalogManager that deals with all catalog objects.

getOperationTreeBuilder

OperationTreeBuilder getOperationTreeBuilder()

Returns a OperationTreeBuilder that can create QueryOperations.

executeInternal

TableResult executeInternal(List<ModifyOperation> operations)

Execute the given modify operations and return the execution result.

Parameters:

operations - The operations to be executed.

Returns:

the affected row counts (-1 means unknown).

executeInternal

TableResult executeInternal(Operation operation)

Execute the given operation and return the execution result.

Parameters:

operation - The operation to be executed.

Returns:

the content of the execution result.

explainInternal

String explainInternal(List<Operation> operations,
                       ExplainDetail... extraDetails)

Returns the AST of this table and the execution plan to compute the result of this table.

Parameters:

operations - The operations to be explained.

extraDetails - The extra explain details which the explain result should include, e.g. estimated cost, changelog mode for streaming

Returns:

AST and the execution plan.

registerTableSourceInternal

void registerTableSourceInternal(String name,
                                 TableSource<?> tableSource)

Registers an external TableSource in this TableEnvironment's catalog. Registered tables can be referenced in SQL queries.

Temporary objects can shadow permanent ones. If a permanent object in a given path exists, it will be inaccessible in the current session. To make the permanent object available again one can drop the corresponding temporary object.

Parameters:

name - The name under which the TableSource is registered.

tableSource - The TableSource to register.

registerTableSinkInternal

void registerTableSinkInternal(String name,
                               TableSink<?> configuredSink)

Registers an external TableSink with already configured field names and field types in this TableEnvironment's catalog. Registered sink tables can be referenced in SQL DML statements.

Temporary objects can shadow permanent ones. If a permanent object in a given path exists, it will be inaccessible in the current session. To make the permanent object available again one can drop the corresponding temporary object.

Parameters:

name - The name under which the TableSink is registered.

configuredSink - The configured TableSink to register.

getJsonPlan

@Experimental
String getJsonPlan(String stmt)

Get the json plan for the given statement.

The statement can only be DML.

The json plan is the string json representation of an optimized ExecNode plan for the given statement. An ExecNode plan can be serialized to json plan, and a json plan can be deserialized to an ExecNode plan.

NOTES: This is an experimental feature now.

Parameters:

stmt - The SQL statement to generate json plan.

Returns:

the string json representation of an optimized ExecNode plan for the given statement.

getJsonPlan

@Experimental
String getJsonPlan(List<ModifyOperation> operations)

Get the json plan for the given ModifyOperations. see getJsonPlan(String) for more info about json plan.

NOTES: This is an experimental feature now.

Parameters:

operations - the ModifyOperations to generate json plan.

Returns:

the string json representation of an optimized ExecNode plan for the given operations.

explainJsonPlan

@Experimental
String explainJsonPlan(String jsonPlan,
                                     ExplainDetail... extraDetails)

Returns the execution plan for the given json plan. A SQL statement can be converted to json plan through getJsonPlan(String).

NOTES: This is an experimental feature now.

Parameters:

jsonPlan - The json plan to be explained.

extraDetails - The extra explain details which the explain result should include, e.g. estimated cost, changelog mode for streaming

Returns:

the execution plan.

executeJsonPlan

@Experimental
TableResult executeJsonPlan(String jsonPlan)

Execute the given json plan, and return the execution result. A SQL statement can be converted to json plan through getJsonPlan(String).

NOTES: This is an experimental feature now.

Parameters:

jsonPlan - The json plan to be executed.

Returns:

the affected row count for `DML` (-1 means unknown).