TableEnvironmentImpl (flink 1.11-SNAPSHOT API)

java.lang.Object
- org.apache.flink.table.api.internal.TableEnvironmentImpl

All Implemented Interfaces:

TableEnvironmentInternal, TableEnvironment

Direct Known Subclasses:

StreamTableEnvironmentImpl
```
@Internal
public class TableEnvironmentImpl
extends Object
implements TableEnvironmentInternal
```
Implementation of TableEnvironment that works exclusively with Table API interfaces. Only TableSource is supported as an input and TableSink as an output. It also does not bind to any particular StreamExecutionEnvironment.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Executor`	`execEnv`
`protected FunctionCatalog`	`functionCatalog`
`protected Parser`	`parser`
`protected Planner`	`planner`
`protected TableConfig`	`tableConfig`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`TableEnvironmentImpl(CatalogManager catalogManager, ModuleManager moduleManager, TableConfig tableConfig, Executor executor, FunctionCatalog functionCatalog, Planner planner, boolean isStreamingMode, ClassLoader userClassLoader)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ConnectTableDescriptor`	`connect(ConnectorDescriptor connectorDescriptor)` Creates a temporary table from a descriptor.
`static TableEnvironmentImpl`	`create(EnvironmentSettings settings)` Creates a table environment that is the entry point and central context for creating Table and SQL API programs.
`void`	`createFunction(String path, Class<? extends UserDefinedFunction> functionClass)` Registers a `UserDefinedFunction` class as a catalog function in the given path.
`void`	`createFunction(String path, Class<? extends UserDefinedFunction> functionClass, boolean ignoreIfExists)` Registers a `UserDefinedFunction` class as a catalog function in the given path.
`StatementSet`	`createStatementSet()` Create a `StatementSet` instance which accepts DML statements or Tables, the planner can optimize all added statements and Tables together and then submit as one job.
`protected TableImpl`	`createTable(QueryOperation tableOperation)`
`void`	`createTemporaryFunction(String path, Class<? extends UserDefinedFunction> functionClass)` Registers a `UserDefinedFunction` class as a temporary catalog function.
`void`	`createTemporaryFunction(String path, UserDefinedFunction functionInstance)` Registers a `UserDefinedFunction` instance as a temporary catalog function.
`void`	`createTemporarySystemFunction(String name, Class<? extends UserDefinedFunction> functionClass)` Registers a `UserDefinedFunction` class as a temporary system function.
`void`	`createTemporarySystemFunction(String name, UserDefinedFunction functionInstance)` Registers a `UserDefinedFunction` instance as a temporary system function.
`void`	`createTemporaryView(String path, Table view)` Registers a `Table` API object as a temporary view similar to SQL temporary views.
`boolean`	`dropFunction(String path)` Drops a catalog function registered in the given path.
`boolean`	`dropTemporaryFunction(String path)` Drops a temporary catalog function registered in the given path.
`boolean`	`dropTemporarySystemFunction(String name)` Drops a temporary system function registered under the given name.
`boolean`	`dropTemporaryTable(String path)` Drops a temporary table registered in the given path.
`boolean`	`dropTemporaryView(String path)` Drops a temporary view registered in the given path.
`JobExecutionResult`	`execute(String jobName)` Triggers the program execution.
`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.
`TableResult`	`executeSql(String statement)` Execute the given single statement, and return the execution result.
`String`	`explain(boolean extended)` Returns the AST of the specified Table API and SQL queries and the execution plan to compute the result of multiple-sinks plan.
`String`	`explain(Table table)` Returns the AST of the specified Table API and SQL queries and the execution plan to compute the result of the given `Table`.
`String`	`explain(Table table, boolean extended)` Returns the AST of the specified Table API and SQL queries and the execution plan to compute the result of the given `Table`.
`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`	`explainSql(String statement, ExplainDetail... extraDetails)` Returns the AST of the specified statement and the execution plan to compute the result of the given statement.
`Table`	`from(String path)` Reads a registered table and returns the resulting `Table`.
`Table`	`fromTableSource(TableSource<?> source)` Creates a table from a table source.
`Table`	`fromValues(AbstractDataType<?> rowType, Expression... values)` Creates a Table from given collection of objects with a given row type.
`Table`	`fromValues(AbstractDataType<?> rowType, Iterable<?> values)` Creates a Table from given collection of objects with a given row type.
`Table`	`fromValues(AbstractDataType<?> rowType, Object... values)` Creates a Table from given collection of objects with a given row type.
`Table`	`fromValues(Expression... values)` Creates a Table from given values.
`Table`	`fromValues(Iterable<?> values)` Creates a Table from given collection of objects.
`Table`	`fromValues(Object... values)` Creates a Table from given values.
`Optional<Catalog>`	`getCatalog(String catalogName)` Gets a registered `Catalog` by name.
`CatalogManager`	`getCatalogManager()` Returns a `CatalogManager` that deals with all catalog objects.
`String[]`	`getCompletionHints(String statement, int position)` Returns completion hints for the given statement at the given cursor position.
`TableConfig`	`getConfig()` Returns the table config that defines the runtime behavior of the Table API.
`String`	`getCurrentCatalog()` Gets the current default catalog name of the current session.
`String`	`getCurrentDatabase()` Gets the current default database name of the running session.
`protected ExplainDetail[]`	`getExplainDetails(boolean extended)`
`Parser`	`getParser()` Return a `Parser` that provides methods for parsing a SQL string.
`Planner`	`getPlanner()`
`void`	`insertInto(String targetPath, Table table)` Instructs to write the content of a `Table` API object into a table.
`void`	`insertInto(Table table, String sinkPath, String... sinkPathContinued)` Writes the `Table` to a `TableSink` that was registered under the specified name.
`String[]`	`listCatalogs()` Gets the names of all catalogs registered in this environment.
`String[]`	`listDatabases()` Gets the names of all databases registered in the current catalog.
`String[]`	`listFunctions()` Gets the names of all functions in this environment.
`String[]`	`listModules()` Gets an array of names of all modules in this environment in the loaded order.
`String[]`	`listTables()` Gets the names of all tables available in the current namespace (the current database of the current catalog).
`String[]`	`listTemporaryTables()` Gets the names of all temporary tables and views available in the current namespace (the current database of the current catalog).
`String[]`	`listTemporaryViews()` Gets the names of all temporary views available in the current namespace (the current database of the current catalog).
`String[]`	`listUserDefinedFunctions()` Gets the names of all user defined functions registered in this environment.
`String[]`	`listViews()` Gets the names of all views available in the current namespace (the current database of the current catalog).
`void`	`loadModule(String moduleName, Module module)` Loads a `Module` under a unique name.
`protected QueryOperation`	`qualifyQueryOperation(ObjectIdentifier identifier, QueryOperation queryOperation)` Subclasses can override this method to transform the given QueryOperation to a new one with the qualified object identifier.
`void`	`registerCatalog(String catalogName, Catalog catalog)` Registers a `Catalog` under a unique name.
`void`	`registerFunction(String name, ScalarFunction function)` Registers a `ScalarFunction` under a unique name.
`void`	`registerTable(String name, Table table)` Registers a `Table` under a unique name in the TableEnvironment's catalog.
`void`	`registerTableSink(String name, String[] fieldNames, TypeInformation<?>[] fieldTypes, TableSink<?> tableSink)` Registers an external `TableSink` with given field names and types in this `TableEnvironment`'s catalog.
`void`	`registerTableSink(String name, TableSink<?> configuredSink)` Registers an external `TableSink` with already configured field names and field types in this `TableEnvironment`'s catalog.
`void`	`registerTableSinkInternal(String name, TableSink<?> tableSink)` Registers an external `TableSink` with already configured field names and field types in this `TableEnvironment`'s catalog.
`void`	`registerTableSource(String name, TableSource<?> tableSource)` Registers an external `TableSource` in this `TableEnvironment`'s catalog.
`void`	`registerTableSourceInternal(String name, TableSource<?> tableSource)` Registers an external `TableSource` in this `TableEnvironment`'s catalog.
`Table`	`scan(String... tablePath)` Scans a registered table and returns the resulting `Table`.
`Table`	`sqlQuery(String query)` Evaluates a SQL query on registered tables and retrieves the result as a `Table`.
`void`	`sqlUpdate(String stmt)` Evaluates a SQL statement such as INSERT, UPDATE or DELETE; or a DDL statement; NOTE: Currently only SQL INSERT statements and CREATE TABLE statements are supported.
`protected List<Transformation<?>>`	`translateAndClearBuffer()` Translate the buffered operations to Transformations, and clear the buffer.
`void`	`unloadModule(String moduleName)` Unloads a `Module` with given name.
`void`	`useCatalog(String catalogName)` Sets the current catalog to the given value.
`void`	`useDatabase(String databaseName)` Sets the current default database.
`protected void`	`validateTableSource(TableSource<?> tableSource)` Subclasses can override this method to add additional checks.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

tableConfig

protected final TableConfig tableConfig

execEnv
```
protected final Executor execEnv
```

functionCatalog

protected final FunctionCatalog functionCatalog

planner
```
protected final Planner planner
```

parser
```
protected final Parser parser
```

Constructor Detail

TableEnvironmentImpl

protected TableEnvironmentImpl(CatalogManager catalogManager,
                               ModuleManager moduleManager,
                               TableConfig tableConfig,
                               Executor executor,
                               FunctionCatalog functionCatalog,
                               Planner planner,
                               boolean isStreamingMode,
                               ClassLoader userClassLoader)

Method Detail

create
```
public static TableEnvironmentImpl create(EnvironmentSettings settings)
```
Description copied from interface: TableEnvironment
Creates a table environment that is the entry point and central context for creating Table and SQL API programs.
It is unified both on a language level for all JVM-based languages (i.e. there is no distinction between Scala and Java API) and for bounded and unbounded data processing.
A table environment is responsible for:
- Connecting to external systems.
- Registering and retrieving Tables and other meta objects from a catalog.
- Executing SQL statements.
- Offering further configuration options.
Note: This environment is meant for pure table programs. If you would like to convert from or to other Flink APIs, it might be necessary to use one of the available language-specific table environments in the corresponding bridging modules.
Specified by:

create in interface TableEnvironment

Parameters:

settings - The environment settings used to instantiate the TableEnvironment.

fromValues
```
public Table fromValues(Object... values)
```
Description copied from interface: TableEnvironment
Creates a Table from given values.
Examples:
You can use a row(...) expression to create a composite rows:
```
 tEnv.fromValues(
     row(1, "ABC"),
     row(2L, "ABCDE")
 )
 
```
will produce a Table with a schema as follows:
```
 root
 |-- f0: BIGINT NOT NULL     // original types INT and BIGINT are generalized to BIGINT
 |-- f1: VARCHAR(5) NOT NULL // original types CHAR(3) and CHAR(5) are generalized to VARCHAR(5)
                             // it uses VARCHAR instead of CHAR so that no padding is applied
 
```
The method will derive the types automatically from the input expressions. If types at a certain position differ, the method will try to find a common super type for all types. If a common super type does not exist, an exception will be thrown. If you want to specify the requested type explicitly see TableEnvironment.fromValues(AbstractDataType, Object...).
It is also possible to use Row object instead of row expressions.
ROWs that are a result of e.g. a function call are not flattened
```
 public class RowFunction extends ScalarFunction {
     {@literal @}DataTypeHint("ROW<f0 BIGINT, f1 VARCHAR(5)>")
     Row eval();
 }

 tEnv.fromValues(
     call(new RowFunction()),
     call(new RowFunction())
 )
 
```
will produce a Table with a schema as follows:
```
 root
 |-- f0: ROW<`f0` BIGINT, `f1` VARCHAR(5)>
 
```
The row constructor can be dropped to create a table with a single column:
ROWs that are a result of e.g. a function call are not flattened
```
 tEnv.fromValues(
     1,
     2L,
     3
 )
 
```
will produce a Table with a schema as follows:
```
 root
 |-- f0: BIGINT NOT NULL
 
```
Specified by:

fromValues in interface TableEnvironment

Parameters:

values - Expressions for constructing rows of the VALUES table.

fromValues
```
public Table fromValues(AbstractDataType<?> rowType,
                        Object... values)
```
Description copied from interface: TableEnvironment
Creates a Table from given collection of objects with a given row type.
The difference between this method and TableEnvironment.fromValues(Object...) is that the schema can be manually adjusted. It might be helpful for assigning more generic types like e.g. DECIMAL or naming the columns.
Examples:
```
 tEnv.fromValues(
     DataTypes.ROW(
         DataTypes.FIELD("id", DataTypes.DECIMAL(10, 2)),
         DataTypes.FIELD("name", DataTypes.STRING())
     ),
     row(1, "ABC"),
     row(2L, "ABCDE")
 )
 
```
will produce a Table with a schema as follows:
```
 root
 |-- id: DECIMAL(10, 2)
 |-- f1: STRING
 
```
For more examples see TableEnvironment.fromValues(Object...).
Specified by:

fromValues in interface TableEnvironment

Parameters:

rowType - Expected row type for the values.

values - Expressions for constructing rows of the VALUES table.

See Also:

TableEnvironment.fromValues(Object...)

fromValues
```
public Table fromValues(Expression... values)
```
Description copied from interface: TableEnvironment
Creates a Table from given values.
Examples:
You can use a row(...) expression to create a composite rows:
```
 tEnv.fromValues(
     row(1, "ABC"),
     row(2L, "ABCDE")
 )
 
```
will produce a Table with a schema as follows:
```
  root
  |-- f0: BIGINT NOT NULL     // original types INT and BIGINT are generalized to BIGINT
  |-- f1: VARCHAR(5) NOT NULL // original types CHAR(3) and CHAR(5) are generalized to VARCHAR(5)
 	 *                          // it uses VARCHAR instead of CHAR so that no padding is applied
 
```
The method will derive the types automatically from the input expressions. If types at a certain position differ, the method will try to find a common super type for all types. If a common super type does not exist, an exception will be thrown. If you want to specify the requested type explicitly see #fromValues(DataType, Expression...).
It is also possible to use Row object instead of row expressions.
ROWs that are a result of e.g. a function call are not flattened
```
 public class RowFunction extends ScalarFunction {
     {@literal @}DataTypeHint("ROW<f0 BIGINT, f1 VARCHAR(5)>")
     Row eval();
 }

 tEnv.fromValues(
     call(new RowFunction()),
     call(new RowFunction())
 )
 
```
will produce a Table with a schema as follows:
```
 root
 |-- f0: ROW<`f0` BIGINT, `f1` VARCHAR(5)>
 
```
The row constructor can be dropped to create a table with a single column:
ROWs that are a result of e.g. a function call are not flattened
```
 tEnv.fromValues(
     lit(1).plus(2),
     lit(2L),
     lit(3)
 )
 
```
will produce a Table with a schema as follows:
```
 root
 |-- f0: BIGINT NOT NULL
 
```
Specified by:

fromValues in interface TableEnvironment

Parameters:

values - Expressions for constructing rows of the VALUES table.

fromValues
```
public Table fromValues(AbstractDataType<?> rowType,
                        Expression... values)
```
Description copied from interface: TableEnvironment
Creates a Table from given collection of objects with a given row type.
The difference between this method and TableEnvironment.fromValues(Expression...) is that the schema can be manually adjusted. It might be helpful for assigning more generic types like e.g. DECIMAL or naming the columns.
Examples:
```
 tEnv.fromValues(
     DataTypes.ROW(
         DataTypes.FIELD("id", DataTypes.DECIMAL(10, 2)),
         DataTypes.FIELD("name", DataTypes.STRING())
     ),
     row(1, "ABC"),
     row(2L, "ABCDE")
 )
 
```
will produce a Table with a schema as follows:
```
 root
 |-- id: DECIMAL(10, 2)
 |-- name: STRING
 
```
For more examples see TableEnvironment.fromValues(Expression...).
Specified by:

fromValues in interface TableEnvironment

Parameters:

rowType - Expected row type for the values.

values - Expressions for constructing rows of the VALUES table.

See Also:

TableEnvironment.fromValues(Expression...)

fromValues
```
public Table fromValues(Iterable<?> values)
```
Description copied from interface: TableEnvironment

Creates a Table from given collection of objects.
See TableEnvironment.fromValues(Object...) for more explanation.

Specified by:

fromValues in interface TableEnvironment

Parameters:

values - Expressions for constructing rows of the VALUES table.

See Also:

TableEnvironment.fromValues(Object...)

fromValues
```
public Table fromValues(AbstractDataType<?> rowType,
                        Iterable<?> values)
```
Description copied from interface: TableEnvironment

Creates a Table from given collection of objects with a given row type.
See TableEnvironment.fromValues(AbstractDataType, Object...) for more explanation.

Specified by:

fromValues in interface TableEnvironment

Parameters:

rowType - Expected row type for the values.

values - Expressions for constructing rows of the VALUES table.

See Also:

TableEnvironment.fromValues(AbstractDataType, Object...)

getPlanner

@VisibleForTesting
public Planner getPlanner()

fromTableSource
```
public Table fromTableSource(TableSource<?> source)
```
Description copied from interface: TableEnvironment

Creates a table from a table source.

Specified by:

fromTableSource in interface TableEnvironment

Parameters:

source - table source used as table

registerCatalog
```
public void registerCatalog(String catalogName,
                            Catalog catalog)
```
Description copied from interface: TableEnvironment

Registers a Catalog under a unique name. All tables registered in the Catalog can be accessed.

Specified by:

registerCatalog in interface TableEnvironment

Parameters:

catalogName - The name under which the catalog will be registered.

catalog - The catalog to register.

getCatalog
```
public Optional<Catalog> getCatalog(String catalogName)
```
Description copied from interface: TableEnvironment

Gets a registered Catalog by name.

Specified by:

getCatalog in interface TableEnvironment

Parameters:

catalogName - The name to look up the Catalog.

Returns:

The requested catalog, empty if there is no registered catalog with given name.

loadModule
```
public void loadModule(String moduleName,
                       Module module)
```
Description copied from interface: TableEnvironment

Loads a Module under a unique name. Modules will be kept in the loaded order. ValidationException is thrown when there is already a module with the same name.

Specified by:

loadModule in interface TableEnvironment

Parameters:

moduleName - name of the Module

module - the module instance

unloadModule
```
public void unloadModule(String moduleName)
```
Description copied from interface: TableEnvironment

Unloads a Module with given name. ValidationException is thrown when there is no module with the given name

Specified by:

unloadModule in interface TableEnvironment

Parameters:

moduleName - name of the Module

registerFunction
```
public void registerFunction(String name,
                             ScalarFunction function)
```
Description copied from interface: TableEnvironment

Registers a ScalarFunction under a unique name. Replaces already existing user-defined functions under this name.

Specified by:

registerFunction in interface TableEnvironment

createTemporarySystemFunction
```
public void createTemporarySystemFunction(String name,
                                          Class<? extends UserDefinedFunction> functionClass)
```
Description copied from interface: TableEnvironment

Registers a UserDefinedFunction class as a temporary system function.
Compared to TableEnvironment.createTemporaryFunction(String, Class), system functions are identified by a global name that is independent of the current catalog and current database. Thus, this method allows to extend the set of built-in system functions like TRIM, ABS, etc.
Temporary functions can shadow permanent ones. If a permanent function under a given name exists, it will be inaccessible in the current session. To make the permanent function available again one can drop the corresponding temporary system function.

Specified by:

createTemporarySystemFunction in interface TableEnvironment

Parameters:

name - The name under which the function will be registered globally.

functionClass - The function class containing the implementation.

createTemporarySystemFunction
```
public void createTemporarySystemFunction(String name,
                                          UserDefinedFunction functionInstance)
```
Description copied from interface: TableEnvironment

Registers a UserDefinedFunction instance as a temporary system function.
Compared to TableEnvironment.createTemporarySystemFunction(String, Class), this method takes a function instance that might have been parameterized before (e.g. through its constructor). This might be useful for more interactive sessions. Make sure that the instance is Serializable.
Compared to TableEnvironment.createTemporaryFunction(String, UserDefinedFunction), system functions are identified by a global name that is independent of the current catalog and current database. Thus, this method allows to extend the set of built-in system functions like TRIM, ABS, etc.
Temporary functions can shadow permanent ones. If a permanent function under a given name exists, it will be inaccessible in the current session. To make the permanent function available again one can drop the corresponding temporary system function.

Specified by:

createTemporarySystemFunction in interface TableEnvironment

Parameters:

name - The name under which the function will be registered globally.

functionInstance - The (possibly pre-configured) function instance containing the implementation.

dropTemporarySystemFunction
```
public boolean dropTemporarySystemFunction(String name)
```
Description copied from interface: TableEnvironment

Drops a temporary system function registered under the given name.
If a permanent function with the given name exists, it will be used from now on for any queries that reference this name.

Specified by:

dropTemporarySystemFunction in interface TableEnvironment

Parameters:

name - The name under which the function has been registered globally.

Returns:

true if a function existed under the given name and was removed

createFunction
```
public void createFunction(String path,
                           Class<? extends UserDefinedFunction> functionClass)
```
Description copied from interface: TableEnvironment

Registers a UserDefinedFunction class as a catalog function in the given path.
Compared to system functions with a globally defined name, catalog functions are always (implicitly or explicitly) identified by a catalog and database.
There must not be another function (temporary or permanent) registered under the same path.

Specified by:

createFunction in interface TableEnvironment

Parameters:

path - The path under which the function will be registered. See also the TableEnvironment class description for the format of the path.

functionClass - The function class containing the implementation.

createFunction
```
public void createFunction(String path,
                           Class<? extends UserDefinedFunction> functionClass,
                           boolean ignoreIfExists)
```
Description copied from interface: TableEnvironment

Registers a UserDefinedFunction class as a catalog function in the given path.
Compared to system functions with a globally defined name, catalog functions are always (implicitly or explicitly) identified by a catalog and database.

Specified by:

createFunction in interface TableEnvironment

Parameters:

path - The path under which the function will be registered. See also the TableEnvironment class description for the format of the path.

functionClass - The function class containing the implementation.

ignoreIfExists - If a function exists under the given path and this flag is set, no operation is executed. An exception is thrown otherwise.

dropFunction
```
public boolean dropFunction(String path)
```
Description copied from interface: TableEnvironment

Drops a catalog function registered in the given path.

Specified by:

dropFunction in interface TableEnvironment

Parameters:

path - The path under which the function has been registered. See also the TableEnvironment class description for the format of the path.

Returns:

true if a function existed in the given path and was removed

createTemporaryFunction
```
public void createTemporaryFunction(String path,
                                    Class<? extends UserDefinedFunction> functionClass)
```
Description copied from interface: TableEnvironment

Registers a UserDefinedFunction class as a temporary catalog function.
Compared to TableEnvironment.createTemporarySystemFunction(String, Class) with a globally defined name, catalog functions are always (implicitly or explicitly) identified by a catalog and database.
Temporary functions can shadow permanent ones. If a permanent function under a given name exists, it will be inaccessible in the current session. To make the permanent function available again one can drop the corresponding temporary function.

Specified by:

createTemporaryFunction in interface TableEnvironment

Parameters:

path - The path under which the function will be registered. See also the TableEnvironment class description for the format of the path.

functionClass - The function class containing the implementation.

createTemporaryFunction
```
public void createTemporaryFunction(String path,
                                    UserDefinedFunction functionInstance)
```
Description copied from interface: TableEnvironment

Registers a UserDefinedFunction instance as a temporary catalog function.
Compared to TableEnvironment.createTemporaryFunction(String, Class), this method takes a function instance that might have been parameterized before (e.g. through its constructor). This might be useful for more interactive sessions. Make sure that the instance is Serializable.
Compared to TableEnvironment.createTemporarySystemFunction(String, UserDefinedFunction) with a globally defined name, catalog functions are always (implicitly or explicitly) identified by a catalog and database.
Temporary functions can shadow permanent ones. If a permanent function under a given name exists, it will be inaccessible in the current session. To make the permanent function available again one can drop the corresponding temporary function.

Specified by:

createTemporaryFunction in interface TableEnvironment

Parameters:

path - The path under which the function will be registered. See also the TableEnvironment class description for the format of the path.

functionInstance - The (possibly pre-configured) function instance containing the implementation.

dropTemporaryFunction
```
public boolean dropTemporaryFunction(String path)
```
Description copied from interface: TableEnvironment

Drops a temporary catalog function registered in the given path.
If a permanent function with the given path exists, it will be used from now on for any queries that reference this path.

Specified by:

dropTemporaryFunction in interface TableEnvironment

Parameters:

path - The path under which the function will be registered. See also the TableEnvironment class description for the format of the path.

Returns:

true if a function existed in the given path and was removed

registerTable
```
public void registerTable(String name,
                          Table table)
```
Description copied from interface: TableEnvironment

Registers a Table under a unique name in the 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.

Specified by:

registerTable in interface TableEnvironment

Parameters:

name - The name under which the table will be registered.

table - The table to register.

createTemporaryView
```
public void createTemporaryView(String path,
                                Table view)
```
Description copied from interface: TableEnvironment

Registers a Table API object as a temporary view similar to SQL temporary views.
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.

Specified by:

createTemporaryView in interface TableEnvironment

Parameters:

path - The path under which the view will be registered. See also the TableEnvironment class description for the format of the path.

view - The view to register.

registerTableSource
```
public void registerTableSource(String name,
                                TableSource<?> tableSource)
```
Description copied from interface: TableEnvironment

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.

Specified by:

registerTableSource in interface TableEnvironment

Parameters:

name - The name under which the TableSource is registered.

tableSource - The TableSource to register.

registerTableSink
```
public void registerTableSink(String name,
                              String[] fieldNames,
                              TypeInformation<?>[] fieldTypes,
                              TableSink<?> tableSink)
```
Description copied from interface: TableEnvironment

Registers an external TableSink with given field names and 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.

Specified by:

registerTableSink in interface TableEnvironment

Parameters:

name - The name under which the TableSink is registered.

fieldNames - The field names to register with the TableSink.

fieldTypes - The field types to register with the TableSink.

tableSink - The TableSink to register.

registerTableSink
```
public void registerTableSink(String name,
                              TableSink<?> configuredSink)
```
Description copied from interface: TableEnvironment

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.

Specified by:

registerTableSink in interface TableEnvironment

Parameters:

name - The name under which the TableSink is registered.

configuredSink - The configured TableSink to register.

scan
```
public Table scan(String... tablePath)
```
Description copied from interface: TableEnvironment
Scans a registered table and returns the resulting Table.
A table to scan must be registered in the TableEnvironment. It can be either directly registered or be an external member of a Catalog.
See the documentation of TableEnvironment.useDatabase(String) or TableEnvironment.useCatalog(String) for the rules on the path resolution.
Examples:
Scanning a directly registered table.
```
 Table tab = tableEnv.scan("tableName");
 
```
Scanning a table from a registered catalog.
```
 Table tab = tableEnv.scan("catalogName", "dbName", "tableName");
 
```
Specified by:

scan in interface TableEnvironment

Parameters:

tablePath - The path of the table to scan.

Returns:

The resulting Table.

See Also:

TableEnvironment.useCatalog(String), TableEnvironment.useDatabase(String)

from
```
public Table from(String path)
```
Description copied from interface: TableEnvironment
Reads a registered table and returns the resulting Table.
A table to scan must be registered in the TableEnvironment.
See the documentation of TableEnvironment.useDatabase(String) or TableEnvironment.useCatalog(String) for the rules on the path resolution.
Examples:
Reading a table from default catalog and database.
```
 Table tab = tableEnv.from("tableName");
 
```
Reading a table from a registered catalog.
```
 Table tab = tableEnv.from("catalogName.dbName.tableName");
 
```
Reading a table from a registered catalog with escaping. Dots in e.g. a database name must be escaped.
```
 Table tab = tableEnv.from("catalogName.`db.Name`.Table");
 
```
Specified by:

from in interface TableEnvironment

Parameters:

path - The path of a table API object to scan.

Returns:

Either a table or virtual table (=view).

See Also:

TableEnvironment.useCatalog(String), TableEnvironment.useDatabase(String)

insertInto
```
public void insertInto(String targetPath,
                       Table table)
```
Description copied from interface: TableEnvironment

Instructs to write the content of a Table API object into a table.
See the documentation of TableEnvironment.useDatabase(String) or TableEnvironment.useCatalog(String) for the rules on the path resolution.

Specified by:

insertInto in interface TableEnvironment

Parameters:

targetPath - The path of the registered TableSink to which the Table is written.

table - The Table to write to the sink.

insertInto
```
public void insertInto(Table table,
                       String sinkPath,
                       String... sinkPathContinued)
```
Description copied from interface: TableEnvironment

Writes the Table to a TableSink that was registered under the specified name.
See the documentation of TableEnvironment.useDatabase(String) or TableEnvironment.useCatalog(String) for the rules on the path resolution.

Specified by:

insertInto in interface TableEnvironment

Parameters:

table - The Table to write to the sink.

sinkPath - The first part of the path of the registered TableSink to which the Table is written. This is to ensure at least the name of the TableSink is provided.

sinkPathContinued - The remaining part of the path of the registered TableSink to which the Table is written.

connect
```
public ConnectTableDescriptor connect(ConnectorDescriptor connectorDescriptor)
```
Description copied from interface: TableEnvironment
Creates a temporary table from a descriptor.
Descriptors allow for declaring the communication to external systems in an implementation-agnostic way. The classpath is scanned for suitable table factories that match the desired configuration.
The following example shows how to read from a connector using a JSON format and register a temporary table as "MyTable":
```
 tableEnv
   .connect(
     new ExternalSystemXYZ()
       .version("0.11"))
   .withFormat(
     new Json()
       .jsonSchema("{...}")
       .failOnMissingField(false))
   .withSchema(
     new Schema()
       .field("user-name", "VARCHAR").from("u_name")
       .field("count", "DECIMAL")
   .createTemporaryTable("MyTable");
 
```
Specified by:

connect in interface TableEnvironment

Parameters:

connectorDescriptor - connector descriptor describing the external system

listCatalogs
```
public String[] listCatalogs()
```
Description copied from interface: TableEnvironment

Gets the names of all catalogs registered in this environment.

Specified by:

listCatalogs in interface TableEnvironment

Returns:

A list of the names of all registered catalogs.

listModules
```
public String[] listModules()
```
Description copied from interface: TableEnvironment

Gets an array of names of all modules in this environment in the loaded order.

Specified by:

listModules in interface TableEnvironment

Returns:

A list of the names of all modules in the loaded order.

listDatabases
```
public String[] listDatabases()
```
Description copied from interface: TableEnvironment

Gets the names of all databases registered in the current catalog.

Specified by:

listDatabases in interface TableEnvironment

Returns:

A list of the names of all registered databases in the current catalog.

listTables
```
public String[] listTables()
```
Description copied from interface: TableEnvironment

Gets the names of all tables available in the current namespace (the current database of the current catalog). It returns both temporary and permanent tables and views.

Specified by:

listTables in interface TableEnvironment

Returns:

A list of the names of all registered tables in the current database of the current catalog.

See Also:

TableEnvironment.listTemporaryTables(), TableEnvironment.listTemporaryViews()

listViews
```
public String[] listViews()
```
Description copied from interface: TableEnvironment

Gets the names of all views available in the current namespace (the current database of the current catalog). It returns both temporary and permanent views.

Specified by:

listViews in interface TableEnvironment

Returns:

A list of the names of all registered views in the current database of the current catalog.

See Also:

TableEnvironment.listTemporaryViews()

listTemporaryTables
```
public String[] listTemporaryTables()
```
Description copied from interface: TableEnvironment

Gets the names of all temporary tables and views available in the current namespace (the current database of the current catalog).

Specified by:

listTemporaryTables in interface TableEnvironment

Returns:

A list of the names of all registered temporary tables and views in the current database of the current catalog.

See Also:

TableEnvironment.listTables()

listTemporaryViews
```
public String[] listTemporaryViews()
```
Description copied from interface: TableEnvironment

Gets the names of all temporary views available in the current namespace (the current database of the current catalog).

Specified by:

listTemporaryViews in interface TableEnvironment

Returns:

A list of the names of all registered temporary views in the current database of the current catalog.

See Also:

TableEnvironment.listTables()

dropTemporaryTable
```
public boolean dropTemporaryTable(String path)
```
Description copied from interface: TableEnvironment

Drops a temporary table registered in the given path.
If a permanent table with a given path exists, it will be used from now on for any queries that reference this path.

Specified by:

dropTemporaryTable in interface TableEnvironment

Returns:

true if a table existed in the given path and was removed

dropTemporaryView
```
public boolean dropTemporaryView(String path)
```
Description copied from interface: TableEnvironment

Drops a temporary view registered in the given path.
If a permanent table or view with a given path exists, it will be used from now on for any queries that reference this path.

Specified by:

dropTemporaryView in interface TableEnvironment

Returns:

true if a view existed in the given path and was removed

listUserDefinedFunctions
```
public String[] listUserDefinedFunctions()
```
Description copied from interface: TableEnvironment

Gets the names of all user defined functions registered in this environment.

Specified by:

listUserDefinedFunctions in interface TableEnvironment

listFunctions
```
public String[] listFunctions()
```
Description copied from interface: TableEnvironment

Gets the names of all functions in this environment.

Specified by:

listFunctions in interface TableEnvironment

explain
```
public String explain(Table table)
```
Description copied from interface: TableEnvironment

Returns the AST of the specified Table API and SQL queries and the execution plan to compute the result of the given Table.

Specified by:

explain in interface TableEnvironment

Parameters:

table - The table for which the AST and execution plan will be returned.

explain
```
public String explain(Table table,
                      boolean extended)
```
Description copied from interface: TableEnvironment

Returns the AST of the specified Table API and SQL queries and the execution plan to compute the result of the given Table.

Specified by:

explain in interface TableEnvironment

Parameters:

table - The table for which the AST and execution plan will be returned.

extended - if the plan should contain additional properties, e.g. estimated cost, traits

explain
```
public String explain(boolean extended)
```
Description copied from interface: TableEnvironment

Returns the AST of the specified Table API and SQL queries and the execution plan to compute the result of multiple-sinks plan.

Specified by:

explain in interface TableEnvironment

Parameters:

extended - if the plan should contain additional properties, e.g. estimated cost, traits

explainSql
```
public String explainSql(String statement,
                         ExplainDetail... extraDetails)
```
Description copied from interface: TableEnvironment

Returns the AST of the specified statement and the execution plan to compute the result of the given statement.

Specified by:

explainSql in interface TableEnvironment

Parameters:

statement - The statement for which the AST and execution plan will be returned.

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.

explainInternal
```
public String explainInternal(List<Operation> operations,
                              ExplainDetail... extraDetails)
```
Description copied from interface: TableEnvironmentInternal

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

Specified by:

explainInternal in interface TableEnvironmentInternal

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.

getCompletionHints
```
public String[] getCompletionHints(String statement,
                                   int position)
```
Description copied from interface: TableEnvironment

Returns completion hints for the given statement at the given cursor position. The completion happens case insensitively.

Specified by:

getCompletionHints in interface TableEnvironment

Parameters:

statement - Partial or slightly incorrect SQL statement

position - cursor position

Returns:

completion hints that fit at the current cursor position

sqlQuery
```
public Table sqlQuery(String query)
```
Description copied from interface: TableEnvironment
Evaluates a SQL query on registered tables and retrieves the result as a Table.
All tables referenced by the query must be registered in the TableEnvironment. A Table is automatically registered when its Table#toString() method is called, for example when it is embedded into a String. Hence, SQL queries can directly reference a Table as follows:
```
 Table table = ...;
 String tableName = table.toString();
 // the table is not registered to the table environment
 tEnv.sqlQuery("SELECT * FROM tableName");
 
```
Specified by:

sqlQuery in interface TableEnvironment

Parameters:

query - The SQL query to evaluate.

Returns:

The result of the query as Table

executeSql
```
public TableResult executeSql(String statement)
```
Description copied from interface: TableEnvironment

Execute the given single statement, and return the execution result.
The statement can be DDL/DML/DQL/SHOW/DESCRIBE/EXPLAIN/USE. For DML and DQL, this method returns TableResult once the job has been submitted. For DDL and DCL statements, TableResult is returned once the operation has finished.

Specified by:

executeSql in interface TableEnvironment

Returns:

content for DQL/SHOW/DESCRIBE/EXPLAIN, the affected row count for `DML` (-1 means unknown), or a string message ("OK") for other statements.

createStatementSet
```
public StatementSet createStatementSet()
```
Description copied from interface: TableEnvironment

Create a StatementSet instance which accepts DML statements or Tables, the planner can optimize all added statements and Tables together and then submit as one job.

Specified by:

createStatementSet in interface TableEnvironment

executeInternal
```
public TableResult executeInternal(List<ModifyOperation> operations)
```
Description copied from interface: TableEnvironmentInternal

Execute the given modify operations and return the execution result.

Specified by:

executeInternal in interface TableEnvironmentInternal

Parameters:

operations - The operations to be executed.

Returns:

the affected row counts (-1 means unknown).

executeInternal
```
public TableResult executeInternal(QueryOperation operation)
```
Description copied from interface: TableEnvironmentInternal

Execute the given query operation and return the execution result.

Specified by:

executeInternal in interface TableEnvironmentInternal

Parameters:

operation - The QueryOperation to be executed.

Returns:

the content of the QueryOperation.

sqlUpdate

public void sqlUpdate(String stmt)

Description copied from interface: TableEnvironment

Evaluates a SQL statement such as INSERT, UPDATE or DELETE; or a DDL statement; NOTE: Currently only SQL INSERT statements and CREATE TABLE statements are supported.

All tables referenced by the query must be registered in the TableEnvironment. A Table is automatically registered when its Table#toString() method is called, for example when it is embedded into a String. Hence, SQL queries can directly reference a Table as follows:


 // register the configured table sink into which the result is inserted.
 tEnv.registerTableSinkInternal("sinkTable", configuredSink);
 Table sourceTable = ...
 String tableName = sourceTable.toString();
 // sourceTable is not registered to the table environment
 tEnv.sqlUpdate(s"INSERT INTO sinkTable SELECT * FROM tableName");

A DDL statement can also be executed to create a table: For example, the below DDL statement would create a CSV table named `tbl1` into the current catalog:

    create table tbl1(
      a int,
      b bigint,
      c varchar
    ) with (
      'connector.type' = 'filesystem',
      'format.type' = 'csv',
      'connector.path' = 'xxx'
    )

SQL queries can directly execute as follows:

    String sinkDDL = "create table sinkTable(
                        a int,
                        b varchar
                      ) with (
                        'connector.type' = 'filesystem',
                        'format.type' = 'csv',
                        'connector.path' = 'xxx'
                      )";

    String sourceDDL ="create table sourceTable(
                        a int,
                        b varchar
                      ) with (
                        'connector.type' = 'kafka',
                        'update-mode' = 'append',
                        'connector.topic' = 'xxx',
                        'connector.properties.bootstrap.servers' = 'localhost:9092',
                        ...
                      )";

    String query = "INSERT INTO sinkTable SELECT * FROM sourceTable";

    tEnv.sqlUpdate(sourceDDL);
    tEnv.sqlUpdate(sinkDDL);
    tEnv.sqlUpdate(query);
    tEnv.execute("MyJob");

This code snippet creates a job to read data from Kafka source into a CSV sink.

Specified by:: sqlUpdate in interface TableEnvironment
Parameters:: stmt - The SQL statement to evaluate.

getCurrentCatalog
```
public String getCurrentCatalog()
```
Description copied from interface: TableEnvironment

Gets the current default catalog name of the current session.

Specified by:

getCurrentCatalog in interface TableEnvironment

Returns:

The current default catalog name that is used for the path resolution.

See Also:

TableEnvironment.useCatalog(String)

useCatalog

public void useCatalog(String catalogName)

Description copied from interface: TableEnvironment

Sets the current catalog to the given value. It also sets the default database to the catalog's default one. See also TableEnvironment.useDatabase(String).

This is used during the resolution of object paths. Both the catalog and database are optional when referencing catalog objects such as tables, views etc. The algorithm looks for requested objects in following paths in that order:

[current-catalog].[current-database].[requested-path]
[current-catalog].[requested-path]
[requested-path]

Example:

Given structure with default catalog set to default_catalog and default database set to default_database.

 root:
   |- default_catalog
       |- default_database
           |- tab1
       |- db1
           |- tab1
   |- cat1
       |- db1
           |- tab1

The following table describes resolved paths:

Requested path	Resolved path
tab1	default_catalog.default_database.tab1
db1.tab1	default_catalog.db1.tab1
cat1.db1.tab1	cat1.db1.tab1

Specified by:: useCatalog in interface TableEnvironment
Parameters:: catalogName - The name of the catalog to set as the current default catalog.
See Also:: TableEnvironment.useDatabase(String)

getCurrentDatabase
```
public String getCurrentDatabase()
```
Description copied from interface: TableEnvironment

Gets the current default database name of the running session.

Specified by:

getCurrentDatabase in interface TableEnvironment

Returns:

The name of the current database of the current catalog.

See Also:

TableEnvironment.useDatabase(String)

useDatabase

public void useDatabase(String databaseName)

Description copied from interface: TableEnvironment

Sets the current default database. It has to exist in the current catalog. That path will be used as the default one when looking for unqualified object names.

[current-catalog].[current-database].[requested-path]
[current-catalog].[requested-path]
[requested-path]

Example:

Given structure with default catalog set to default_catalog and default database set to default_database.

 root:
   |- default_catalog
       |- default_database
           |- tab1
       |- db1
           |- tab1
   |- cat1
       |- db1
           |- tab1

The following table describes resolved paths:

Requested path	Resolved path
tab1	default_catalog.default_database.tab1
db1.tab1	default_catalog.db1.tab1
cat1.db1.tab1	cat1.db1.tab1

Specified by:: useDatabase in interface TableEnvironment
Parameters:: databaseName - The name of the database to set as the current database.
See Also:: TableEnvironment.useCatalog(String)

getConfig
```
public TableConfig getConfig()
```
Description copied from interface: TableEnvironment

Returns the table config that defines the runtime behavior of the Table API.

Specified by:

getConfig in interface TableEnvironment

execute
```
public JobExecutionResult execute(String jobName)
                           throws Exception
```
Description copied from interface: TableEnvironment

Triggers the program execution. The environment will execute all parts of the program.
The program execution will be logged and displayed with the provided name
NOTE:It is highly advised to set all parameters in the TableConfig on the very beginning of the program. It is undefined what configurations values will be used for the execution if queries are mixed with config changes. It depends on the characteristic of the particular parameter. For some of them the value from the point in time of query construction (e.g. the currentCatalog) will be used. On the other hand some values might be evaluated according to the state from the time when this method is called (e.g. timeZone).
Once the execution finishes, any previously defined DMLs will be cleared, no matter whether the execution succeeds or not. Therefore, if you want to retry in case of failures, you have to re-define the DMLs, i.e. by calling TableEnvironment.sqlUpdate(String), before you call this method again.

Specified by:

execute in interface TableEnvironment

Parameters:

jobName - Desired name of the job

Returns:

The result of the job execution, containing elapsed time and accumulators.

Throws:

Exception - which occurs during job execution.

getParser
```
public Parser getParser()
```
Description copied from interface: TableEnvironmentInternal

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

Specified by:

getParser in interface TableEnvironmentInternal

Returns:

initialized Parser.

getCatalogManager
```
public CatalogManager getCatalogManager()
```
Description copied from interface: TableEnvironmentInternal

Returns a CatalogManager that deals with all catalog objects.

Specified by:

getCatalogManager in interface TableEnvironmentInternal

qualifyQueryOperation
```
protected QueryOperation qualifyQueryOperation(ObjectIdentifier identifier,
                                               QueryOperation queryOperation)
```
Subclasses can override this method to transform the given QueryOperation to a new one with the qualified object identifier. This is needed for some QueryOperations, e.g. JavaDataStreamQueryOperation, which doesn't know the registered identifier when created (fromDataStream(DataStream). But the identifier is required when converting this QueryOperation to RelNode.

validateTableSource
```
protected void validateTableSource(TableSource<?> tableSource)
```
Subclasses can override this method to add additional checks.

Parameters:

tableSource - tableSource to validate

translateAndClearBuffer
```
protected List<Transformation<?>> translateAndClearBuffer()
```
Translate the buffered operations to Transformations, and clear the buffer.
The buffer will be clear even if the `translate` fails. In most cases, the failure is not retryable (e.g. type mismatch, can't generate physical plan). If the buffer is not clear after failure, the following `translate` will also fail.

getExplainDetails

@VisibleForTesting
protected ExplainDetail[] getExplainDetails(boolean extended)

registerTableSourceInternal
```
public void registerTableSourceInternal(String name,
                                        TableSource<?> tableSource)
```
Description copied from interface: TableEnvironmentInternal

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.

Specified by:

registerTableSourceInternal in interface TableEnvironmentInternal

Parameters:

name - The name under which the TableSource is registered.

tableSource - The TableSource to register.

registerTableSinkInternal
```
public void registerTableSinkInternal(String name,
                                      TableSink<?> tableSink)
```
Description copied from interface: TableEnvironmentInternal

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.

Specified by:

registerTableSinkInternal in interface TableEnvironmentInternal

Parameters:

name - The name under which the TableSink is registered.

tableSink - The configured TableSink to register.

createTable

protected TableImpl createTable(QueryOperation tableOperation)

Back to Flink Website

Class TableEnvironmentImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

tableConfig

execEnv

functionCatalog

planner

parser

Constructor Detail

TableEnvironmentImpl

Method Detail

create

fromValues

fromValues

fromValues

fromValues

fromValues

fromValues

getPlanner

fromTableSource

registerCatalog

getCatalog

loadModule

unloadModule

registerFunction

createTemporarySystemFunction

createTemporarySystemFunction

dropTemporarySystemFunction

createFunction

createFunction

dropFunction

createTemporaryFunction

createTemporaryFunction

dropTemporaryFunction

registerTable

createTemporaryView

registerTableSource

registerTableSink

registerTableSink

scan

from

insertInto

insertInto

connect

listCatalogs

listModules

listDatabases

listTables

listViews

listTemporaryTables

listTemporaryViews

dropTemporaryTable

dropTemporaryView

listUserDefinedFunctions

listFunctions

explain

explain

explain

explainSql

explainInternal

getCompletionHints

sqlQuery

executeSql

createStatementSet

executeInternal

executeInternal

sqlUpdate

getCurrentCatalog

useCatalog

getCurrentDatabase

useDatabase

getConfig

execute

getParser

getCatalogManager

qualifyQueryOperation