Package org.apache.flink.cdc.connectors.postgres.source.config

Class PostgresSourceConfig

java.lang.Object

org.apache.flink.cdc.connectors.base.config.BaseSourceConfig

org.apache.flink.cdc.connectors.base.config.JdbcSourceConfig

org.apache.flink.cdc.connectors.postgres.source.config.PostgresSourceConfig

All Implemented Interfaces:

Serializable, SourceConfig

public class PostgresSourceConfig
extends JdbcSourceConfig

The configuration for Postgres CDC source.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.cdc.connectors.base.config.SourceConfig

SourceConfig.Factory<C extends SourceConfig>

Field Summary

Fields inherited from class org.apache.flink.cdc.connectors.base.config.JdbcSourceConfig

chunkKeyColumn, connectionPoolSize, connectMaxRetries, connectTimeout, databaseList, driverClassName, fetchSize, hostname, password, port, schemaList, serverTimeZone, tableList, username

Fields inherited from class org.apache.flink.cdc.connectors.base.config.BaseSourceConfig

assignUnboundedChunkFirst, closeIdleReaders, dbzConfiguration, dbzProperties, distributionFactorLower, distributionFactorUpper, includeSchemaChanges, isScanNewlyAddedTableEnabled, releaseSnapshotMetadataEnabled, skipSnapshotBackfill, splitMetaGroupSize, splitSize, startupOptions

Constructor Summary

Constructors

Constructor

Description

PostgresSourceConfig(int subtaskId, StartupOptions startupOptions, List<String> databaseList, List<String> schemaList, List<String> tableList, int splitSize, int splitMetaGroupSize, double distributionFactorUpper, double distributionFactorLower, boolean includeSchemaChanges, boolean closeIdleReaders, Properties dbzProperties, io.debezium.config.Configuration dbzConfiguration, String driverClassName, String hostname, int port, String username, String password, int fetchSize, String serverTimeZone, java.time.Duration connectTimeout, int connectMaxRetries, int connectionPoolSize, String chunkKeyColumn, boolean skipSnapshotBackfill, boolean isScanNewlyAddedTableEnabled, int lsnCommitCheckpointsDelay, boolean assignUnboundedChunkFirst, boolean includePartitionedTables, boolean includeDatabaseInTableId, List<String> logicalMessagePrefixes, boolean releaseSnapshotMetadataEnabled)

Method Summary

Modifier and Type	Method	Description
io.debezium.connector.postgresql.PostgresConnectorConfig	getDbzConnectorConfig()
String	getJdbcUrl()	Returns the JDBC URL for config unique key.
List<String>	getLogicalMessagePrefixes()	Returns the prefixes for Postgres logical decoding messages.
int	getLsnCommitCheckpointsDelay()	Returns lsnCommitCheckpointsDelay value.
String	getSlotNameForBackfillTask()	Returns the slot name for backfill task.
int	getSubtaskId()	Returns subtaskId value.
boolean	includePartitionedTables()	Returns includePartitionedTables value.
boolean	isIncludeDatabaseInTableId()	Returns whether to include database in the generated Table ID.

Methods inherited from class org.apache.flink.cdc.connectors.base.config.JdbcSourceConfig

getChunkKeyColumn, getConnectionPoolSize, getConnectMaxRetries, getConnectTimeout, getDatabaseList, getDriverClassName, getFetchSize, getHostname, getPassword, getPort, getServerTimeZone, getTableFilters, getTableList, getUsername, isScanNewlyAddedTableEnabled

Methods inherited from class org.apache.flink.cdc.connectors.base.config.BaseSourceConfig

getDbzConfiguration, getDbzProperties, getDistributionFactorLower, getDistributionFactorUpper, getSplitMetaGroupSize, getSplitSize, getStartupOptions, isAssignUnboundedChunkFirst, isCloseIdleReaders, isIncludeSchemaChanges, isReleaseSnapshotMetadataEnabled, isSkipSnapshotBackfill

Methods inherited from class java.lang.Object

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

Constructor Detail

PostgresSourceConfig

public PostgresSourceConfig(int subtaskId,
                            StartupOptions startupOptions,
                            List<String> databaseList,
                            List<String> schemaList,
                            List<String> tableList,
                            int splitSize,
                            int splitMetaGroupSize,
                            double distributionFactorUpper,
                            double distributionFactorLower,
                            boolean includeSchemaChanges,
                            boolean closeIdleReaders,
                            Properties dbzProperties,
                            io.debezium.config.Configuration dbzConfiguration,
                            String driverClassName,
                            String hostname,
                            int port,
                            String username,
                            String password,
                            int fetchSize,
                            String serverTimeZone,
                            java.time.Duration connectTimeout,
                            int connectMaxRetries,
                            int connectionPoolSize,
                            @Nullable
                            String chunkKeyColumn,
                            boolean skipSnapshotBackfill,
                            boolean isScanNewlyAddedTableEnabled,
                            int lsnCommitCheckpointsDelay,
                            boolean assignUnboundedChunkFirst,
                            boolean includePartitionedTables,
                            boolean includeDatabaseInTableId,
                            List<String> logicalMessagePrefixes,
                            boolean releaseSnapshotMetadataEnabled)

Method Detail

getSubtaskId

public int getSubtaskId()

Returns subtaskId value.

Returns:

subtask id

getLsnCommitCheckpointsDelay

public int getLsnCommitCheckpointsDelay()

Returns lsnCommitCheckpointsDelay value.

Returns:

lsn commit checkpoint delay

includePartitionedTables

public boolean includePartitionedTables()

Returns includePartitionedTables value.

Returns:

include partitioned table

getSlotNameForBackfillTask

public String getSlotNameForBackfillTask()

Returns the slot name for backfill task.

Returns:

backfill task slot name

getJdbcUrl

public String getJdbcUrl()

Returns the JDBC URL for config unique key.

getDbzConnectorConfig

public io.debezium.connector.postgresql.PostgresConnectorConfig getDbzConnectorConfig()

Specified by:

getDbzConnectorConfig in class JdbcSourceConfig

isIncludeDatabaseInTableId

public boolean isIncludeDatabaseInTableId()

Returns whether to include database in the generated Table ID.

getLogicalMessagePrefixes

public List<String> getLogicalMessagePrefixes()

Returns the prefixes for Postgres logical decoding messages.