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(QueryOperation operation) Execute the given query operation 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.
CatalogManager	getCatalogManager() Returns a CatalogManager that deals with all catalog objects.
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

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

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.

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(QueryOperation operation)

Execute the given query operation and return the execution result.

Parameters:

operation - The QueryOperation to be executed.

Returns:

the content of the QueryOperation.

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.