org.apache.flink.connector.jdbc.table

Class JdbcDynamicTableSource

java.lang.Object

org.apache.flink.connector.jdbc.table.JdbcDynamicTableSource

All Implemented Interfaces:

SupportsLimitPushDown, SupportsProjectionPushDown, DynamicTableSource, LookupTableSource, ScanTableSource

@Internal
public class JdbcDynamicTableSource
extends Object
implements ScanTableSource, LookupTableSource, SupportsProjectionPushDown, SupportsLimitPushDown

A DynamicTableSource for JDBC.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.table.connector.source.ScanTableSource

ScanTableSource.ScanContext, ScanTableSource.ScanRuntimeProvider

Nested classes/interfaces inherited from interface org.apache.flink.table.connector.source.LookupTableSource

LookupTableSource.LookupContext, LookupTableSource.LookupRuntimeProvider

Nested classes/interfaces inherited from interface org.apache.flink.table.connector.source.DynamicTableSource

DynamicTableSource.Context, DynamicTableSource.DataStructureConverter

Constructor Summary

Constructors

Constructor and Description
JdbcDynamicTableSource(JdbcConnectorOptions options, JdbcReadOptions readOptions, int lookupMaxRetryTimes, LookupCache cache, DataType physicalRowDataType)

Method Summary

Modifier and Type	Method and Description
void	applyLimit(long limit) Provides the expected maximum number of produced records for limiting on a best-effort basis.
void	applyProjection(int[][] projectedFields, DataType producedDataType) Provides the field index paths that should be used for a projection.
String	asSummaryString() Returns a string that summarizes this source for printing to a console or log.
DynamicTableSource	copy() Creates a copy of this instance during planning.
boolean	equals(Object o)
ChangelogMode	getChangelogMode() Returns the set of changes that the planner can expect during runtime.
LookupTableSource.LookupRuntimeProvider	getLookupRuntimeProvider(LookupTableSource.LookupContext context) Returns a provider of runtime implementation for reading the data.
ScanTableSource.ScanRuntimeProvider	getScanRuntimeProvider(ScanTableSource.ScanContext runtimeProviderContext) Returns a provider of runtime implementation for reading the data.
int	hashCode()
boolean	supportsNestedProjection() Returns whether this source supports nested projection.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.table.connector.source.abilities.SupportsProjectionPushDown

applyProjection

Constructor Detail

JdbcDynamicTableSource

public JdbcDynamicTableSource(JdbcConnectorOptions options,
                              JdbcReadOptions readOptions,
                              int lookupMaxRetryTimes,
                              @Nullable
                              LookupCache cache,
                              DataType physicalRowDataType)

Method Detail

getLookupRuntimeProvider

public LookupTableSource.LookupRuntimeProvider getLookupRuntimeProvider(LookupTableSource.LookupContext context)

Description copied from interface: LookupTableSource

Returns a provider of runtime implementation for reading the data.

There exist different interfaces for runtime implementation which is why LookupTableSource.LookupRuntimeProvider serves as the base interface.

Independent of the provider interface, a source implementation can work on either arbitrary objects or internal data structures (see org.apache.flink.table.data for more information).

The given LookupTableSource.LookupContext offers utilities by the planner for creating runtime implementation with minimal dependencies to internal data structures.

Specified by:

getLookupRuntimeProvider in interface LookupTableSource

See Also:

LookupFunctionProvider, AsyncLookupFunctionProvider

getScanRuntimeProvider

public ScanTableSource.ScanRuntimeProvider getScanRuntimeProvider(ScanTableSource.ScanContext runtimeProviderContext)

Description copied from interface: ScanTableSource

Returns a provider of runtime implementation for reading the data.

There might exist different interfaces for runtime implementation which is why ScanTableSource.ScanRuntimeProvider serves as the base interface. Concrete ScanTableSource.ScanRuntimeProvider interfaces might be located in other Flink modules.

Independent of the provider interface, the table runtime expects that a source implementation emits internal data structures (see RowData for more information).

The given ScanTableSource.ScanContext offers utilities by the planner for creating runtime implementation with minimal dependencies to internal data structures.

SourceProvider is the recommended core interface. SourceFunctionProvider in flink-table-api-java-bridge and InputFormatProvider are available for backwards compatibility.

Specified by:

getScanRuntimeProvider in interface ScanTableSource

See Also:

SourceProvider

getChangelogMode

public ChangelogMode getChangelogMode()

Description copied from interface: ScanTableSource

Returns the set of changes that the planner can expect during runtime.

Specified by:

getChangelogMode in interface ScanTableSource

See Also:

RowKind

supportsNestedProjection

public boolean supportsNestedProjection()

Description copied from interface: SupportsProjectionPushDown

Returns whether this source supports nested projection.

Specified by:

supportsNestedProjection in interface SupportsProjectionPushDown

applyProjection

public void applyProjection(int[][] projectedFields,
                            DataType producedDataType)

Description copied from interface: SupportsProjectionPushDown

Provides the field index paths that should be used for a projection. The indices are 0-based and support fields within (possibly nested) structures if this is enabled via SupportsProjectionPushDown.supportsNestedProjection().

In the example mentioned in SupportsProjectionPushDown, this method would receive:

• [[2], [1]] which is equivalent to [["s"], ["r"]] if SupportsProjectionPushDown.supportsNestedProjection() returns false.
• [[2], [1, 0]] which is equivalent to [["s"], ["r", "d"]]] if SupportsProjectionPushDown.supportsNestedProjection() returns true.

Note: Use the passed data type instead of ResolvedSchema.toPhysicalRowDataType() for describing the final output data type when creating TypeInformation.

Specified by:

applyProjection in interface SupportsProjectionPushDown

Parameters:

projectedFields - field index paths of all fields that must be present in the physically produced data

producedDataType - the final output type of the source, with the projection applied

copy

public DynamicTableSource copy()

Description copied from interface: DynamicTableSource

Creates a copy of this instance during planning. The copy should be a deep copy of all mutable members.

Specified by:

copy in interface DynamicTableSource

asSummaryString

public String asSummaryString()

Description copied from interface: DynamicTableSource

Returns a string that summarizes this source for printing to a console or log.

Specified by:

asSummaryString in interface DynamicTableSource

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

applyLimit

public void applyLimit(long limit)

Description copied from interface: SupportsLimitPushDown

Provides the expected maximum number of produced records for limiting on a best-effort basis.

Specified by:

applyLimit in interface SupportsLimitPushDown