org.apache.flink.table.api.bridge.java

Interface BatchTableEnvironment

All Superinterfaces:

TableEnvironment

@PublicEvolving
public interface BatchTableEnvironment
extends TableEnvironment

The TableEnvironment for a Java batch ExecutionEnvironment that works with DataSets.

A TableEnvironment can be used to:

• convert a DataSet to a Table
• register a DataSet in the TableEnvironment's catalog
• register a Table in the TableEnvironment's catalog
• scan a registered table to obtain a Table
• specify a SQL query on registered tables to obtain a Table
• convert a Table into a DataSet
• explain the AST and execution plan of a Table

Method Summary

Modifier and Type	Method and Description
BatchTableDescriptor	connect(ConnectorDescriptor connectorDescriptor) Deprecated. The SQL CREATE TABLE DDL is richer than this part of the API. This method might be refactored in the next versions. Please use executeSql(ddl) to register a table instead.
static BatchTableEnvironment	create(ExecutionEnvironment executionEnvironment) Returns a TableEnvironment for a Java batch ExecutionEnvironment that works with DataSets.
static BatchTableEnvironment	create(ExecutionEnvironment executionEnvironment, TableConfig tableConfig) Returns a TableEnvironment for a Java batch ExecutionEnvironment that works with DataSets.
<T> void	createTemporaryView(String path, DataSet<T> dataSet) Creates a view from the given DataSet in a given path.
<T> void	createTemporaryView(String path, DataSet<T> dataSet, Expression... fields) Creates a view from the given DataSet in a given path with specified field names.
<T> void	createTemporaryView(String path, DataSet<T> dataSet, String fields) Deprecated. use createTemporaryView(String, DataSet, Expression...)
<T> Table	fromDataSet(DataSet<T> dataSet) Converts the given DataSet into a Table.
<T> Table	fromDataSet(DataSet<T> dataSet, Expression... fields) Converts the given DataSet into a Table with specified field names.
<T> Table	fromDataSet(DataSet<T> dataSet, String fields) Deprecated. use fromDataSet(DataSet, Expression...)
<T> void	registerDataSet(String name, DataSet<T> dataSet) Deprecated. use createTemporaryView(String, DataSet)
<T> void	registerDataSet(String name, DataSet<T> dataSet, String fields) Deprecated. use createTemporaryView(String, DataSet, String)
<T,ACC> void	registerFunction(String name, AggregateFunction<T,ACC> aggregateFunction) Registers an AggregateFunction under a unique name in the TableEnvironment's catalog.
<T> void	registerFunction(String name, TableFunction<T> tableFunction) Registers a TableFunction under a unique name in the TableEnvironment's catalog.
<T> DataSet<T>	toDataSet(Table table, Class<T> clazz) Converts the given Table into a DataSet of a specified type.
<T> DataSet<T>	toDataSet(Table table, TypeInformation<T> typeInfo) Converts the given Table into a DataSet of a specified type.

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

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

registerFunction

<T> void registerFunction(String name,
                          TableFunction<T> tableFunction)

Registers a TableFunction under a unique name in the TableEnvironment's catalog. Registered functions can be referenced in Table API and SQL queries.

Type Parameters:

T - The type of the output row.

Parameters:

name - The name under which the function is registered.

tableFunction - The TableFunction to register.

registerFunction

<T,ACC> void registerFunction(String name,
                              AggregateFunction<T,ACC> aggregateFunction)

Registers an AggregateFunction under a unique name in the TableEnvironment's catalog. Registered functions can be referenced in Table API and SQL queries.

Type Parameters:

T - The type of the output value.

ACC - The type of aggregate accumulator.

Parameters:

name - The name under which the function is registered.

aggregateFunction - The AggregateFunction to register.

fromDataSet

<T> Table fromDataSet(DataSet<T> dataSet)

Converts the given DataSet into a Table.

The field names of the Table are automatically derived from the type of the DataSet.

Type Parameters:

T - The type of the DataSet.

Parameters:

dataSet - The DataSet to be converted.

Returns:

The converted Table.

fromDataSet

@Deprecated
<T> Table fromDataSet(DataSet<T> dataSet,
                                  String fields)

Deprecated. use fromDataSet(DataSet, Expression...)

Converts the given DataSet into a Table with specified field names.

There are two modes for mapping original fields to the fields of the Table:

1. Reference input fields by name: All fields in the schema definition are referenced by name (and possibly renamed using an alias (as). In this mode, fields can be reordered and projected out. This mode can be used for any input type, including POJOs.

Example:

 DataSet<Tuple2<String, Long>> set = ...
 // use the original 'f0' field and give a better name to the 'f1' field
 Table table = tableEnv.fromTable(set, "f0, f1 as name");
 

2. Reference input fields by position: In this mode, fields are simply renamed. This mode can only be used if the input type has a defined field order (tuple, case class, Row) and none of the fields references a field of the input type.

Example:

 DataSet<Tuple2<String, Long>> set = ...
 // renames the original fields as 'a' and 'b'
 Table table = tableEnv.fromDataSet(set, "a, b");
 

Type Parameters:

T - The type of the DataSet.

Parameters:

dataSet - The DataSet to be converted.

fields - The fields expressions to map original fields of the DataSet to the fields of the Table.

Returns:

The converted Table.

fromDataSet

<T> Table fromDataSet(DataSet<T> dataSet,
                      Expression... fields)

Converts the given DataSet into a Table with specified field names.

There are two modes for mapping original fields to the fields of the Table:

1. Reference input fields by name: All fields in the schema definition are referenced by name (and possibly renamed using an alias (as). In this mode, fields can be reordered and projected out. This mode can be used for any input type, including POJOs.

Example:

 DataSet<Tuple2<String, Long>> set = ...
 Table table = tableEnv.fromDataSet(
    set,
    $("f1"), // reorder and use the original field
    $("f0").as("name") // reorder and give the original field a better name
 );
 

2. Reference input fields by position: In this mode, fields are simply renamed. This mode can only be used if the input type has a defined field order (tuple, case class, Row) and none of the fields references a field of the input type.

Example:

 DataSet<Tuple2<String, Long>> set = ...
 Table table = tableEnv.fromDataSet(
    set,
    $("a"), // renames the first field to 'a'
    $("b") // renames the second field to 'b'
 );
 

Type Parameters:

T - The type of the DataSet.

Parameters:

dataSet - The DataSet to be converted.

fields - The fields expressions to map original fields of the DataSet to the fields of the Table.

Returns:

The converted Table.

registerDataSet

@Deprecated
<T> void registerDataSet(String name,
                                     DataSet<T> dataSet)

Deprecated. use createTemporaryView(String, DataSet)

Creates a view from the given DataSet. Registered views can be referenced in SQL queries.

The field names of the Table are automatically derived from the type of the DataSet.

The view is registered in the namespace of the current catalog and database. To register the view in a different catalog use createTemporaryView(String, DataSet).

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 you can drop the corresponding temporary object.

Type Parameters:

T - The type of the DataSet to register.

Parameters:

name - The name under which the DataSet is registered in the catalog.

dataSet - The DataSet to register.

createTemporaryView

<T> void createTemporaryView(String path,
                             DataSet<T> dataSet)

Creates a view from the given DataSet in a given path. Registered views can be referenced in SQL queries.

The field names of the Table are automatically derived from the type of the DataSet.

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 you can drop the corresponding temporary object.

Type Parameters:

T - The type of the DataSet.

Parameters:

path - The path under which the view is created. See also the TableEnvironment class description for the format of the path.

dataSet - The DataSet out of which to create the view.

registerDataSet

@Deprecated
<T> void registerDataSet(String name,
                                     DataSet<T> dataSet,
                                     String fields)

Deprecated. use createTemporaryView(String, DataSet, String)

Creates a view from the given DataSet in a given path with specified field names. Registered views can be referenced in SQL queries.

There are two modes for mapping original fields to the fields of the View:

1. Reference input fields by name: All fields in the schema definition are referenced by name (and possibly renamed using an alias (as). In this mode, fields can be reordered and projected out. This mode can be used for any input type, including POJOs.

Example:

 DataSet<Tuple2<String, Long>> set = ...
 // use the original 'f0' field and give a better name to the 'f1' field
 tableEnv.registerDataSet("myTable", set, "f0, f1 as name");
 

2. Reference input fields by position: In this mode, fields are simply renamed. This mode can only be used if the input type has a defined field order (tuple, case class, Row) and none of the fields references a field of the input type.

Example:

 DataSet<Tuple2<String, Long>> set = ...
 // renames the original fields as 'a' and 'b'
 tableEnv.registerDataSet("myTable", set, "a, b");
 

The view is registered in the namespace of the current catalog and database. To register the view in a different catalog use createTemporaryView(String, DataSet).

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 you can drop the corresponding temporary object.

Type Parameters:

T - The type of the DataSet to register.

Parameters:

name - The name under which the DataSet is registered in the catalog.

dataSet - The DataSet to register.

fields - The fields expressions to map original fields of the DataSet to the fields of the View.

createTemporaryView

@Deprecated
<T> void createTemporaryView(String path,
                                         DataSet<T> dataSet,
                                         String fields)

Deprecated. use createTemporaryView(String, DataSet, Expression...)

Creates a view from the given DataSet in a given path with specified field names. Registered views can be referenced in SQL queries.

There are two modes for mapping original fields to the fields of the View:

1. Reference input fields by name: All fields in the schema definition are referenced by name (and possibly renamed using an alias (as). In this mode, fields can be reordered and projected out. This mode can be used for any input type, including POJOs.

Example:

 DataSet<Tuple2<String, Long>> set = ...
 // use the original 'f0' field and give a better name to the 'f1' field
 tableEnv.createTemporaryView("cat.db.myTable", set, "f0, f1 as name");
 

2. Reference input fields by position: In this mode, fields are simply renamed. This mode can only be used if the input type has a defined field order (tuple, case class, Row) and none of the fields references a field of the input type.

Example:

 DataSet<Tuple2<String, Long>> set = ...
 // renames the original fields as 'a' and 'b'
 tableEnv.createTemporaryView("cat.db.myTable", set, "a, b");
 

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 you can drop the corresponding temporary object.

Type Parameters:

T - The type of the DataSet.

Parameters:

path - The path under which the view is created. See also the TableEnvironment class description for the format of the path.

dataSet - The DataSet out of which to create the view.

fields - The fields expressions to map original fields of the DataSet to the fields of the View.

createTemporaryView

<T> void createTemporaryView(String path,
                             DataSet<T> dataSet,
                             Expression... fields)

Creates a view from the given DataSet in a given path with specified field names. Registered views can be referenced in SQL queries.

There are two modes for mapping original fields to the fields of the View:

1. Reference input fields by name: All fields in the schema definition are referenced by name (and possibly renamed using an alias (as). In this mode, fields can be reordered and projected out. This mode can be used for any input type, including POJOs.

Example:

 DataSet<Tuple2<String, Long>> set = ...
 tableEnv.createTemporaryView(
    "cat.db.myTable",
    set,
    $("f1"), // reorder and use the original field
    $("f0").as("name") // reorder and give the original field a better name
 );
 

2. Reference input fields by position: In this mode, fields are simply renamed. This mode can only be used if the input type has a defined field order (tuple, case class, Row) and none of the fields references a field of the input type.

Example:

 DataSet<Tuple2<String, Long>> set = ...
 tableEnv.createTemporaryView(
    "cat.db.myTable",
    set,
    $("a"), // renames the first field to 'a'
    $("b") // renames the second field to 'b'
 );
 

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 you can drop the corresponding temporary object.

Type Parameters:

T - The type of the DataSet.

Parameters:

path - The path under which the view is created. See also the TableEnvironment class description for the format of the path.

dataSet - The DataSet out of which to create the view.

fields - The fields expressions to map original fields of the DataSet to the fields of the View.

toDataSet

<T> DataSet<T> toDataSet(Table table,
                         Class<T> clazz)

Converts the given Table into a DataSet of a specified type.

The fields of the Table are mapped to DataSet fields as follows:

• Row and Tuple types: Fields are mapped by position, field types must match.
• POJO DataSet types: Fields are mapped by field name, field types must match.

Type Parameters:

T - The type of the resulting DataSet.

Parameters:

table - The Table to convert.

clazz - The class of the type of the resulting DataSet.

Returns:

The converted DataSet.

toDataSet

<T> DataSet<T> toDataSet(Table table,
                         TypeInformation<T> typeInfo)

Converts the given Table into a DataSet of a specified type.

The fields of the Table are mapped to DataSet fields as follows:

• Row and Tuple types: Fields are mapped by position, field types must match.
• POJO DataSet types: Fields are mapped by field name, field types must match.

Type Parameters:

T - The type of the resulting DataSet.

Parameters:

table - The Table to convert.

typeInfo - The TypeInformation that specifies the type of the resulting DataSet.

Returns:

The converted DataSet.

connect

@Deprecated
BatchTableDescriptor connect(ConnectorDescriptor connectorDescriptor)

Deprecated. The SQL CREATE TABLE DDL is richer than this part of the API. This method might be refactored in the next versions. Please use executeSql(ddl) to register a table instead.

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 registering 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

create

static BatchTableEnvironment create(ExecutionEnvironment executionEnvironment)

Returns a TableEnvironment for a Java batch ExecutionEnvironment that works with DataSets.

A TableEnvironment can be used to:

• convert a DataSet to a Table
• register a DataSet in the TableEnvironment's catalog
• register a Table in the TableEnvironment's catalog
• scan a registered table to obtain a Table
• specify a SQL query on registered tables to obtain a Table
• convert a Table into a DataSet
• explain the AST and execution plan of a Table

Parameters:

executionEnvironment - The Java batch ExecutionEnvironment of the TableEnvironment.

create

static BatchTableEnvironment create(ExecutionEnvironment executionEnvironment,
                                    TableConfig tableConfig)

Returns a TableEnvironment for a Java batch ExecutionEnvironment that works with DataSets.

A TableEnvironment can be used to:

• convert a DataSet to a Table
• register a DataSet in the TableEnvironment's catalog
• register a Table in the TableEnvironment's catalog
• scan a registered table to obtain a Table
• specify a SQL query on registered tables to obtain a Table
• convert a Table into a DataSet
• explain the AST and execution plan of a Table

Parameters:

executionEnvironment - The Java batch ExecutionEnvironment of the TableEnvironment.

tableConfig - The configuration of the TableEnvironment.