org.apache.flink.connector.datagen.table

Class DataGenTableSource

java.lang.Object

org.apache.flink.connector.datagen.table.DataGenTableSource

All Implemented Interfaces:

SupportsLimitPushDown, DynamicTableSource, ScanTableSource

@Internal
public class DataGenTableSource
extends Object
implements ScanTableSource, SupportsLimitPushDown

A StreamTableSource that emits each number from a given interval exactly once, possibly in parallel. See StatefulSequenceSource.

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.DynamicTableSource

DynamicTableSource.Context, DynamicTableSource.DataStructureConverter

Constructor Summary

Constructors

Constructor and Description
DataGenTableSource(DataGenerator<?>[] fieldGenerators, String tableName, DataType rowDataType, long rowsPerSecond, Long numberOfRows)

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.
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.
DataGeneratorSource<RowData>	createSource()
ChangelogMode	getChangelogMode() Returns the set of changes that the planner can expect during runtime.
ScanTableSource.ScanRuntimeProvider	getScanRuntimeProvider(ScanTableSource.ScanContext context) 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

DataGenTableSource

public DataGenTableSource(DataGenerator<?>[] fieldGenerators,
                          String tableName,
                          DataType rowDataType,
                          long rowsPerSecond,
                          Long numberOfRows)

Method Detail

getScanRuntimeProvider

public ScanTableSource.ScanRuntimeProvider getScanRuntimeProvider(ScanTableSource.ScanContext context)

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

createSource

@VisibleForTesting
public DataGeneratorSource<RowData> createSource()

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

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

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