org.apache.flink.connector.jdbc.table

Class JdbcTableSource

java.lang.Object

org.apache.flink.connector.jdbc.table.JdbcTableSource

All Implemented Interfaces:

LookupableTableSource<Row>, ProjectableTableSource<Row>, StreamTableSource<Row>, TableSource<Row>

public class JdbcTableSource
extends Object
implements StreamTableSource<Row>, ProjectableTableSource<Row>, LookupableTableSource<Row>

TableSource for JDBC.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JdbcTableSource.Builder Builder for a JdbcTableSource.

Method Summary

Modifier and Type	Method and Description
static JdbcTableSource.Builder	builder()
boolean	equals(Object o)
String	explainSource() Describes the table source.
AsyncTableFunction<Row>	getAsyncLookupFunction(String[] lookupKeys) Gets the AsyncTableFunction which supports async lookup one key at a time.
DataStream<Row>	getDataStream(StreamExecutionEnvironment execEnv) Returns the data of the table as a DataStream.
TableFunction<Row>	getLookupFunction(String[] lookupKeys) Gets the TableFunction which supports lookup one key at a time.
DataType	getProducedDataType() Returns the DataType for the produced data of the TableSource.
TableSchema	getTableSchema() Returns the schema of the produced table.
boolean	isAsyncEnabled() Returns true if async lookup is enabled.
boolean	isBounded() Returns true if this is a bounded source, false if this is an unbounded source.
TableSource<Row>	projectFields(int[] fields) Creates a copy of the TableSource that projects its output to the given field indexes.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.flink.table.sources.TableSource

getReturnType

Method Detail

isBounded

public boolean isBounded()

Description copied from interface: StreamTableSource

Returns true if this is a bounded source, false if this is an unbounded source. Default is unbounded for compatibility.

Specified by:

isBounded in interface StreamTableSource<Row>

getDataStream

public DataStream<Row> getDataStream(StreamExecutionEnvironment execEnv)

Description copied from interface: StreamTableSource

Returns the data of the table as a DataStream.

NOTE: This method is for internal use only for defining a TableSource. Do not use it in Table API programs.

Specified by:

getDataStream in interface StreamTableSource<Row>

getLookupFunction

public TableFunction<Row> getLookupFunction(String[] lookupKeys)

Description copied from interface: LookupableTableSource

Gets the TableFunction which supports lookup one key at a time.

Specified by:

getLookupFunction in interface LookupableTableSource<Row>

Parameters:

lookupKeys - the chosen field names as lookup keys, it is in the defined order

getProducedDataType

public DataType getProducedDataType()

Description copied from interface: TableSource

Returns the DataType for the produced data of the TableSource.

Specified by:

getProducedDataType in interface TableSource<Row>

Returns:

The data type of the returned DataSet or DataStream.

projectFields

public TableSource<Row> projectFields(int[] fields)

Description copied from interface: ProjectableTableSource

Creates a copy of the TableSource that projects its output to the given field indexes. The field indexes relate to the physical poduced data type (TableSource.getProducedDataType()) and not to the table schema (TableSource.getTableSchema() of the TableSource.

The table schema (TableSource.getTableSchema() of the TableSource copy must not be modified by this method, but only the produced data type (TableSource.getProducedDataType()) and the produced DataSet (BatchTableSource#getDataSet() or DataStream (StreamTableSource#getDataStream).

If the TableSource implements the DefinedFieldMapping interface, it might be necessary to adjust the mapping as well.

IMPORTANT: This method must return a true copy and must not modify the original table source object.

Specified by:

projectFields in interface ProjectableTableSource<Row>

Parameters:

fields - The indexes of the fields to return.

Returns:

A copy of the TableSource that projects its output.

getAsyncLookupFunction

public AsyncTableFunction<Row> getAsyncLookupFunction(String[] lookupKeys)

Description copied from interface: LookupableTableSource

Gets the AsyncTableFunction which supports async lookup one key at a time.

Specified by:

getAsyncLookupFunction in interface LookupableTableSource<Row>

Parameters:

lookupKeys - the chosen field names as lookup keys, it is in the defined order

isAsyncEnabled

public boolean isAsyncEnabled()

Description copied from interface: LookupableTableSource

Returns true if async lookup is enabled.

The lookup function returned by LookupableTableSource.getAsyncLookupFunction(String[]) will be used if returns true. Otherwise, the lookup function returned by LookupableTableSource.getLookupFunction(String[]) will be used.

Specified by:

isAsyncEnabled in interface LookupableTableSource<Row>

getTableSchema

public TableSchema getTableSchema()

Description copied from interface: TableSource

Returns the schema of the produced table.

Specified by:

getTableSchema in interface TableSource<Row>

Returns:

The TableSchema of the produced table.

explainSource

public String explainSource()

Description copied from interface: TableSource

Describes the table source.

Specified by:

explainSource in interface TableSource<Row>

Returns:

A String explaining the TableSource.

builder

public static JdbcTableSource.Builder builder()

equals

public boolean equals(Object o)

Overrides:

equals in class Object