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

Class PostgreSQLTableSource

java.lang.Object

org.apache.flink.cdc.connectors.postgres.table.PostgreSQLTableSource

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 PostgreSQLTableSource
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 PostgreSQL source 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

PostgreSQLTableSource(org.apache.flink.table.catalog.ResolvedSchema physicalSchema, int port, String hostname, String database, String schemaName, String tableName, String username, String password, String pluginName, String slotName, DebeziumChangelogMode changelogMode, Properties dbzProperties, boolean enableParallelRead, int splitSize, int splitMetaGroupSize, int fetchSize, java.time.Duration connectTimeout, int connectMaxRetries, int connectionPoolSize, double distributionFactorUpper, double distributionFactorLower, java.time.Duration heartbeatInterval, StartupOptions startupOptions, String chunkKeyColumn, boolean closeIdleReaders, boolean skipSnapshotBackfill, boolean isScanNewlyAddedTableEnabled, int lsnCommitCheckpointsDelay, boolean assignUnboundedChunkFirst, boolean appendOnly, boolean includePartitionedTables, boolean releaseSnapshotMetadataEnabled)

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

PostgreSQLTableSource

public PostgreSQLTableSource(org.apache.flink.table.catalog.ResolvedSchema physicalSchema,
                             int port,
                             String hostname,
                             String database,
                             String schemaName,
                             String tableName,
                             String username,
                             String password,
                             String pluginName,
                             String slotName,
                             DebeziumChangelogMode changelogMode,
                             Properties dbzProperties,
                             boolean enableParallelRead,
                             int splitSize,
                             int splitMetaGroupSize,
                             int fetchSize,
                             java.time.Duration connectTimeout,
                             int connectMaxRetries,
                             int connectionPoolSize,
                             double distributionFactorUpper,
                             double distributionFactorLower,
                             java.time.Duration heartbeatInterval,
                             StartupOptions startupOptions,
                             @Nullable
                             String chunkKeyColumn,
                             boolean closeIdleReaders,
                             boolean skipSnapshotBackfill,
                             boolean isScanNewlyAddedTableEnabled,
                             int lsnCommitCheckpointsDelay,
                             boolean assignUnboundedChunkFirst,
                             boolean appendOnly,
                             boolean includePartitionedTables,
                             boolean releaseSnapshotMetadataEnabled)

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