Package org.apache.flink.cdc.connectors.tidb.table

Class TiDBTableSource

java.lang.Object

org.apache.flink.cdc.connectors.tidb.table.TiDBTableSource

All Implemented Interfaces:

org.apache.flink.table.connector.source.abilities.SupportsReadingMetadata, org.apache.flink.table.connector.source.DynamicTableSource, org.apache.flink.table.connector.source.ScanTableSource

public class TiDBTableSource
extends Object
implements org.apache.flink.table.connector.source.ScanTableSource, org.apache.flink.table.connector.source.abilities.SupportsReadingMetadata

A DynamicTableSource that describes how to create a TiDB change event stream from a logical description.

Nested Class Summary

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

org.apache.flink.table.connector.source.DynamicTableSource.Context, org.apache.flink.table.connector.source.DynamicTableSource.DataStructureConverter

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

org.apache.flink.table.connector.source.ScanTableSource.ScanContext, org.apache.flink.table.connector.source.ScanTableSource.ScanRuntimeProvider

Field Summary

Fields

Modifier and Type	Field	Description
protected List<String>	metadataKeys	Metadata that is appended at the end of a physical source row.
protected org.apache.flink.table.types.DataType	producedDataType	Data type that describes the final output of the source.

Constructor Summary

Constructors

Constructor	Description
TiDBTableSource(org.apache.flink.table.catalog.ResolvedSchema physicalSchema, String database, String tableName, String pdAddresses, String hostMapping, StartupOptions startupOptions, Map<String,String> options)

Method Summary

Modifier and Type	Method	Description
void	applyReadableMetadata(List<String> metadataKeys, org.apache.flink.table.types.DataType producedDataType)
String	asSummaryString()
org.apache.flink.table.connector.source.DynamicTableSource	copy()
boolean	equals(Object o)
org.apache.flink.table.connector.ChangelogMode	getChangelogMode()
org.apache.flink.table.connector.source.ScanTableSource.ScanRuntimeProvider	getScanRuntimeProvider(org.apache.flink.table.connector.source.ScanTableSource.ScanContext scanContext)
int	hashCode()
Map<String,org.apache.flink.table.types.DataType>	listReadableMetadata()

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

supportsMetadataProjection

Field Detail

producedDataType

protected org.apache.flink.table.types.DataType producedDataType

Data type that describes the final output of the source.

metadataKeys

protected List<String> metadataKeys

Metadata that is appended at the end of a physical source row.

Constructor Detail

TiDBTableSource

public TiDBTableSource(org.apache.flink.table.catalog.ResolvedSchema physicalSchema,
                       String database,
                       String tableName,
                       String pdAddresses,
                       String hostMapping,
                       StartupOptions startupOptions,
                       Map<String,String> options)

Method Detail

getChangelogMode

public org.apache.flink.table.connector.ChangelogMode getChangelogMode()

Specified by:

getChangelogMode in interface org.apache.flink.table.connector.source.ScanTableSource

getScanRuntimeProvider

public org.apache.flink.table.connector.source.ScanTableSource.ScanRuntimeProvider getScanRuntimeProvider(org.apache.flink.table.connector.source.ScanTableSource.ScanContext scanContext)

Specified by:

getScanRuntimeProvider in interface org.apache.flink.table.connector.source.ScanTableSource

copy

public org.apache.flink.table.connector.source.DynamicTableSource copy()

Specified by:

copy in interface org.apache.flink.table.connector.source.DynamicTableSource

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

asSummaryString

public String asSummaryString()

Specified by:

asSummaryString in interface org.apache.flink.table.connector.source.DynamicTableSource

listReadableMetadata

public Map<String,org.apache.flink.table.types.DataType> listReadableMetadata()

Specified by:

listReadableMetadata in interface org.apache.flink.table.connector.source.abilities.SupportsReadingMetadata

applyReadableMetadata

public void applyReadableMetadata(List<String> metadataKeys,
                                  org.apache.flink.table.types.DataType producedDataType)

Specified by:

applyReadableMetadata in interface org.apache.flink.table.connector.source.abilities.SupportsReadingMetadata