org.apache.flink.table.factories

Interface TableSourceFactory<T>

Type Parameters:

T - type of records that the factory produces

All Superinterfaces:

TableFactory

All Known Subinterfaces:

StreamTableSourceFactory<T>

All Known Implementing Classes:

CsvAppendTableSourceFactory, CsvBatchTableSourceFactory, HiveTableFactory, JdbcTableSourceSinkFactory

@PublicEvolving
public interface TableSourceFactory<T>
extends TableFactory

A factory to create configured table source instances in a batch or stream environment based on string-based properties. See also TableFactory for more information.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	TableSourceFactory.Context Context of table source creation.

Method Summary

Modifier and Type	Method and Description
default TableSource<T>	createTableSource(Map<String,String> properties) Deprecated. TableSourceFactory.Context contains more information, and already contains table schema too. Please use createTableSource(Context) instead.
default TableSource<T>	createTableSource(ObjectPath tablePath, CatalogTable table) Deprecated. TableSourceFactory.Context contains more information, and already contains table schema too. Please use createTableSource(Context) instead.
default TableSource<T>	createTableSource(TableSourceFactory.Context context) Creates and configures a TableSource based on the given TableSourceFactory.Context.

Methods inherited from interface org.apache.flink.table.factories.TableFactory

requiredContext, supportedProperties

Method Detail

createTableSource

@Deprecated
default TableSource<T> createTableSource(Map<String,String> properties)

Deprecated. TableSourceFactory.Context contains more information, and already contains table schema too. Please use createTableSource(Context) instead.

Creates and configures a TableSource using the given properties.

Parameters:

properties - normalized properties describing a table source.

Returns:

the configured table source.

createTableSource

@Deprecated
default TableSource<T> createTableSource(ObjectPath tablePath,
                                                     CatalogTable table)

Deprecated. TableSourceFactory.Context contains more information, and already contains table schema too. Please use createTableSource(Context) instead.

Creates and configures a TableSource based on the given CatalogTable instance.

Parameters:

tablePath - path of the given CatalogTable

table - CatalogTable instance.

Returns:

the configured table source.

createTableSource

default TableSource<T> createTableSource(TableSourceFactory.Context context)

Creates and configures a TableSource based on the given TableSourceFactory.Context.

Parameters:

context - context of this table source.

Returns:

the configured table source.