org.apache.flink.table.factories

Interface TableSinkFactory<T>

Type Parameters:

T - type of records that the factory produces

All Superinterfaces:

TableFactory

All Known Subinterfaces:

BatchTableSinkFactory<T>, StreamTableSinkFactory<T>

All Known Implementing Classes:

CsvAppendTableSinkFactory, CsvBatchTableSinkFactory, Elasticsearch6UpsertTableSinkFactory, Elasticsearch7UpsertTableSinkFactory, ElasticsearchUpsertTableSinkFactoryBase, FileSystemTableFactory, HBaseTableFactory, HiveTableFactory, JdbcTableSourceSinkFactory, Kafka010TableSourceSinkFactory, Kafka011TableSourceSinkFactory, KafkaTableSourceSinkFactory, KafkaTableSourceSinkFactoryBase

@PublicEvolving
public interface TableSinkFactory<T>
extends TableFactory

A factory to create configured table sink 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	TableSinkFactory.Context Context of table sink creation.

Method Summary

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

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

requiredContext, supportedProperties

Method Detail

createTableSink

@Deprecated
default TableSink<T> createTableSink(Map<String,String> properties)

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

Creates and configures a TableSink using the given properties.

Parameters:

properties - normalized properties describing a table sink.

Returns:

the configured table sink.

createTableSink

@Deprecated
default TableSink<T> createTableSink(ObjectPath tablePath,
                                                 CatalogTable table)

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

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

Parameters:

tablePath - path of the given CatalogTable

table - CatalogTable instance.

Returns:

the configured table sink.

createTableSink

default TableSink<T> createTableSink(TableSinkFactory.Context context)

Creates and configures a TableSink based on the given TableSinkFactory.Context.

Parameters:

context - context of this table sink.

Returns:

the configured table sink.