Package org.apache.flink.table.examples.java.connectors

Class SocketDynamicTableSource

java.lang.Object

org.apache.flink.table.examples.java.connectors.SocketDynamicTableSource

All Implemented Interfaces:

DynamicTableSource, ScanTableSource

public final class SocketDynamicTableSource
extends Object
implements ScanTableSource

The SocketDynamicTableSource is used during planning.

In our example, we don't implement any of the available ability interfaces such as SupportsFilterPushDown or SupportsProjectionPushDown. Therefore, the main logic can be found in getScanRuntimeProvider(ScanContext) where we instantiate the required Source and its DeserializationSchema for runtime. Both instances are parameterized to return internal data structures (i.e. RowData).

Note: This is only an example and should not be used in production. The source is not fault-tolerant and can only work with a parallelism of 1.

Nested Class Summary

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

DynamicTableSource.Context, DynamicTableSource.DataStructureConverter

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

ScanTableSource.ScanContext, ScanTableSource.ScanRuntimeProvider

Constructor Summary

Constructors

Constructor	Description
SocketDynamicTableSource(String hostname, int port, byte byteDelimiter, DecodingFormat<DeserializationSchema<RowData>> decodingFormat, DataType producedDataType)

Method Summary

Modifier and Type	Method	Description
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.
ChangelogMode	getChangelogMode()	Returns the set of changes that the planner can expect during runtime.
ScanTableSource.ScanRuntimeProvider	getScanRuntimeProvider(ScanTableSource.ScanContext runtimeProviderContext)	Returns a provider of runtime implementation for reading the data.

Methods inherited from class java.lang.Object

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

Constructor Detail

SocketDynamicTableSource

public SocketDynamicTableSource(String hostname,
                                int port,
                                byte byteDelimiter,
                                DecodingFormat<DeserializationSchema<RowData>> decodingFormat,
                                DataType producedDataType)

Method Detail

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

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

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