org.apache.flink.table.factories

Interface DynamicTableFactory

All Superinterfaces:

Factory

All Known Subinterfaces:

DynamicTableSinkFactory, DynamicTableSourceFactory, ManagedTableFactory

All Known Implementing Classes:

AsyncDynamicTableSinkFactory, BlackHoleTableSinkFactory, DataGenTableSourceFactory, FileSystemTableFactory, HBase1DynamicTableFactory, HBase2DynamicTableFactory, HiveDynamicTableFactory, KafkaDynamicTableFactory, PrintTableSinkFactory, PythonDynamicTableFactory, SocketDynamicTableFactory, UpsertKafkaDynamicTableFactory, UpsertTestDynamicTableSinkFactory

@PublicEvolving
public interface DynamicTableFactory
extends Factory

Base interface for configuring a dynamic table connector for an external storage system from catalog and session information.

Dynamic tables are the core concept of Flink's Table & SQL API for processing both bounded and unbounded data in a unified fashion.

Implement DynamicTableSourceFactory for constructing a DynamicTableSource.

Implement DynamicTableSinkFactory for constructing a DynamicTableSink.

The options FactoryUtil.PROPERTY_VERSION and FactoryUtil.CONNECTOR are implicitly added and must not be declared.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DynamicTableFactory.Context Provides catalog and session information describing the dynamic table to be accessed.

Method Summary

Modifier and Type	Method and Description
default Set<ConfigOption<?>>	forwardOptions() Returns a set of ConfigOption that are directly forwarded to the runtime implementation but don't affect the final execution topology.

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

factoryIdentifier, optionalOptions, requiredOptions

Method Detail

forwardOptions

default Set<ConfigOption<?>> forwardOptions()

Returns a set of ConfigOption that are directly forwarded to the runtime implementation but don't affect the final execution topology.

Options declared here can override options of the persisted plan during an enrichment phase. Since a restored topology is static, an implementer has to ensure that the declared options don't affect fundamental abilities such as SupportsProjectionPushDown or SupportsFilterPushDown.

For example, given a database connector, if an option defines the connection timeout, changing this value does not affect the pipeline topology and can be allowed. However, an option that defines whether the connector supports SupportsReadingMetadata or not is not allowed. The planner might not react to changed abilities anymore.

See Also:

DynamicTableFactory.Context.getEnrichmentOptions(), FactoryUtil.TableFactoryHelper.getOptions(), FormatFactory.forwardOptions()