Package io.debezium.connector.postgresql

Class PostgresConnectorConfig

java.lang.Object

io.debezium.config.CommonConnectorConfig

io.debezium.relational.RelationalDatabaseConnectorConfig

io.debezium.connector.postgresql.PostgresConnectorConfig

public class PostgresConnectorConfig
extends RelationalDatabaseConnectorConfig

The configuration properties for the PostgresConnector

Author:

Horia Chiorean

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PostgresConnectorConfig.AutoCreateMode
static enum	PostgresConnectorConfig.HStoreHandlingMode	The set of predefined HStoreHandlingMode options or aliases
static enum	PostgresConnectorConfig.IntervalHandlingMode	Defines modes of representation of interval datatype
static enum	PostgresConnectorConfig.LogicalDecoder
static enum	PostgresConnectorConfig.SchemaRefreshMode	The set of predefined SchemaRefreshMode options or aliases.
static enum	PostgresConnectorConfig.SecureConnectionMode	The set of predefined SecureConnectionMode options or aliases.
static enum	PostgresConnectorConfig.SnapshotMode	The set of predefined Snapshotter options or aliases.
private static class	PostgresConnectorConfig.SystemTablesPredicate
static enum	PostgresConnectorConfig.TruncateHandlingMode	Deprecated. use skipped operations instead.

Nested classes/interfaces inherited from class io.debezium.relational.RelationalDatabaseConnectorConfig

RelationalDatabaseConnectorConfig.DecimalHandlingMode

Nested classes/interfaces inherited from class io.debezium.config.CommonConnectorConfig

CommonConnectorConfig.BinaryHandlingMode, CommonConnectorConfig.EventProcessingFailureHandlingMode, CommonConnectorConfig.SchemaNameAdjustmentMode, CommonConnectorConfig.Version

Field Summary

Fields

Modifier and Type	Field	Description
static Field.Set	ALL_FIELDS	The set of Fields defined as part of this configuration.
private static final ConfigDefinition	CONFIG_DEFINITION
protected static final String	DATABASE_CONFIG_PREFIX
protected static final int	DEFAULT_MAX_RETRIES
protected static final int	DEFAULT_PORT
protected static final int	DEFAULT_SNAPSHOT_FETCH_SIZE
static final Field	DROP_SLOT_ON_STOP
static final Field	HSTORE_HANDLING_MODE
private final PostgresConnectorConfig.HStoreHandlingMode	hStoreHandlingMode
static final Field	INCLUDE_UNKNOWN_DATATYPES
static final Field	INTERVAL_HANDLING_MODE
private final PostgresConnectorConfig.IntervalHandlingMode	intervalHandlingMode
private static final org.slf4j.Logger	LOGGER
static final Field	LOGICAL_DECODING_MESSAGE_PREFIX_EXCLUDE_LIST	A comma-separated list of regular expressions that match the prefix of logical decoding messages to be excluded from monitoring.
static final Field	LOGICAL_DECODING_MESSAGE_PREFIX_INCLUDE_LIST	A comma-separated list of regular expressions that match the prefix of logical decoding messages to be monitored.
private final LogicalDecodingMessageFilter	logicalDecodingMessageFilter
static final Field	MAX_RETRIES
static final Field	MONEY_FRACTION_DIGITS
static final Field	ON_CONNECT_STATEMENTS
static final Field	PLUGIN_NAME
static final Field	PORT
static final Field	PUBLICATION_AUTOCREATE_MODE
static final Field	PUBLICATION_NAME
static final Field	RETRY_DELAY_MS
static final Field	SCHEMA_REFRESH_MODE
private final PostgresConnectorConfig.SchemaRefreshMode	schemaRefreshMode
static final Field	SKIPPED_OPERATIONS
static final Field	SLOT_NAME
static final Field	SNAPSHOT_MODE
static final Field	SNAPSHOT_MODE_CLASS
private final PostgresConnectorConfig.SnapshotMode	snapshotMode
static final Field	SSL_CLIENT_CERT
static final Field	SSL_CLIENT_KEY
static final Field	SSL_CLIENT_KEY_PASSWORD
static final Field	SSL_MODE
static final Field	SSL_ROOT_CERT
static final Field	SSL_SOCKET_FACTORY
static final Field	STATUS_UPDATE_INTERVAL_MS
static final Field	STREAM_PARAMS
static final Field	TCP_KEEPALIVE
static final Field	TOASTED_VALUE_PLACEHOLDER	Deprecated.
static final Field	TRUNCATE_HANDLING_MODE	Deprecated. use skipped operations instead
private final PostgresConnectorConfig.TruncateHandlingMode	truncateHandlingMode
static final Field	UNAVAILABLE_VALUE_PLACEHOLDER
static final Field	XMIN_FETCH_INTERVAL

Fields inherited from class io.debezium.relational.RelationalDatabaseConnectorConfig

COLUMN_BLACKLIST, COLUMN_EXCLUDE_LIST, COLUMN_INCLUDE_LIST, COLUMN_INCLUDE_LIST_ALREADY_SPECIFIED_ERROR_MSG, COLUMN_WHITELIST, COLUMN_WHITELIST_ALREADY_SPECIFIED_ERROR_MSG, DATABASE_BLACKLIST, DATABASE_BLACKLIST_NAME, DATABASE_EXCLUDE_LIST, DATABASE_EXCLUDE_LIST_NAME, DATABASE_INCLUDE_LIST, DATABASE_INCLUDE_LIST_ALREADY_SPECIFIED_ERROR_MSG, DATABASE_INCLUDE_LIST_NAME, DATABASE_NAME, DATABASE_WHITELIST, DATABASE_WHITELIST_ALREADY_SPECIFIED_ERROR_MSG, DATABASE_WHITELIST_NAME, DECIMAL_HANDLING_MODE, DEFAULT_SNAPSHOT_LOCK_TIMEOUT_MILLIS, DEFAULT_UNAVAILABLE_VALUE_PLACEHOLDER, HOSTNAME, INCLUDE_SCHEMA_CHANGES, INCLUDE_SCHEMA_COMMENTS, MASK_COLUMN, MASK_COLUMN_WITH_HASH, MSG_KEY_COLUMNS, PASSWORD, PROPAGATE_COLUMN_SOURCE_TYPE, PROPAGATE_DATATYPE_SOURCE_TYPE, SCHEMA_BLACKLIST, SCHEMA_EXCLUDE_LIST, SCHEMA_EXCLUDE_LIST_NAME, SCHEMA_INCLUDE_LIST, SCHEMA_INCLUDE_LIST_ALREADY_SPECIFIED_ERROR_MSG, SCHEMA_INCLUDE_LIST_NAME, SCHEMA_WHITELIST, SCHEMA_WHITELIST_ALREADY_SPECIFIED_ERROR_MSG, SERVER_NAME, SERVER_NAME_PATTERN, SNAPSHOT_FULL_COLUMN_SCAN_FORCE, SNAPSHOT_LOCK_TIMEOUT_MS, SNAPSHOT_SELECT_STATEMENT_OVERRIDES_BY_TABLE, TABLE_BLACKLIST, TABLE_BLACKLIST_NAME, TABLE_EXCLUDE_LIST, TABLE_EXCLUDE_LIST_NAME, TABLE_IGNORE_BUILTIN, TABLE_INCLUDE_LIST, TABLE_INCLUDE_LIST_ALREADY_SPECIFIED_ERROR_MSG, TABLE_INCLUDE_LIST_NAME, TABLE_WHITELIST, TABLE_WHITELIST_ALREADY_SPECIFIED_ERROR_MSG, TABLE_WHITELIST_NAME, TIME_PRECISION_MODE, TRUNCATE_COLUMN, USER

Fields inherited from class io.debezium.config.CommonConnectorConfig

BINARY_HANDLING_MODE, CUSTOM_CONVERTERS, CUSTOM_RETRIABLE_EXCEPTION, DEFAULT_MAX_BATCH_SIZE, DEFAULT_MAX_QUEUE_SIZE, DEFAULT_MAX_QUEUE_SIZE_IN_BYTES, DEFAULT_POLL_INTERVAL_MILLIS, DEFAULT_QUERY_FETCH_SIZE, DEFAULT_RETRIABLE_RESTART_WAIT, EVENT_PROCESSING_FAILURE_HANDLING_MODE, INCREMENTAL_SNAPSHOT_ALLOW_SCHEMA_CHANGES, INCREMENTAL_SNAPSHOT_CHUNK_SIZE, MAX_BATCH_SIZE, MAX_QUEUE_SIZE, MAX_QUEUE_SIZE_IN_BYTES, POLL_INTERVAL_MS, PROVIDE_TRANSACTION_METADATA, QUERY_FETCH_SIZE, RETRIABLE_RESTART_WAIT, SANITIZE_FIELD_NAMES, SCHEMA_NAME_ADJUSTMENT_MODE, SIGNAL_DATA_COLLECTION, SNAPSHOT_DELAY_MS, SNAPSHOT_FETCH_SIZE, SNAPSHOT_MAX_THREADS, SNAPSHOT_MODE_TABLES, SOURCE_STRUCT_MAKER_VERSION, TASK_ID, TOMBSTONES_ON_DELETE, TRANSACTION_TOPIC

Constructor Summary

Constructors

Constructor	Description
PostgresConnectorConfig(Configuration config)

Method Summary

Modifier and Type	Method	Description
static org.apache.kafka.common.config.ConfigDef	configDef()
String	databaseName()
protected boolean	dropSlotOnStop()
String	getConnectorName()
String	getContextName()
LogicalDecodingMessageFilter	getMessageFilter()
EnumSet<Envelope.Operation>	getSkippedOperations()
protected Snapshotter	getSnapshotter()
protected SourceInfoStructMaker<? extends AbstractSourceInfo>	getSourceInfoStructMaker(CommonConnectorConfig.Version version)
byte[]	getUnavailableValuePlaceholder()
protected String	hostname()
protected PostgresConnectorConfig.HStoreHandlingMode	hStoreHandlingMode()
protected boolean	includeUnknownDatatypes()
protected PostgresConnectorConfig.IntervalHandlingMode	intervalHandlingMode()
int	maxRetries()
protected int	moneyFractionDigits()
protected PostgresConnectorConfig.LogicalDecoder	plugin()
protected int	port()
protected PostgresConnectorConfig.AutoCreateMode	publicationAutocreateMode()
String	publicationName()
Duration	retryDelay()
protected boolean	skipRefreshSchemaOnMissingToastableData()
protected String	slotName()
protected Duration	statusUpdateInterval()
protected String	streamParams()
Map<String,org.apache.kafka.common.config.ConfigValue>	validate()
private static int	validateLogicalDecodingMessageExcludeList(Configuration config, Field field, Field.ValidationOutput problems)
private static int	validatePluginName(Configuration config, Field field, Field.ValidationOutput problems)
private static int	validateReplicationSlotName(Configuration config, Field field, Field.ValidationOutput problems)
private static int	validateSkippedOperations(Configuration config, Field field, Field.ValidationOutput problems)
private static int	validateToastedValuePlaceholder(Configuration config, Field field, Field.ValidationOutput problems)
private static int	validateTruncateHandlingMode(Configuration config, Field field, Field.ValidationOutput problems)
protected Duration	xminFetchInterval()

Methods inherited from class io.debezium.relational.RelationalDatabaseConnectorConfig

getColumnFilter, getDecimalMode, getHeartbeatActionQuery, getJdbcConfig, getKeyMapper, getSnapshotSelectOverridesByTable, getTableFilters, getTableIdMapper, getTemporalPrecisionMode, isFullColummnScanRequired, isSchemaChangesHistoryEnabled, isSchemaCommentsHistoryEnabled, schemaExcludeList, schemaIncludeList, snapshotLockTimeout, tableExcludeList, tableIncludeList

Methods inherited from class io.debezium.config.CommonConnectorConfig

binaryHandlingMode, customConverterRegistry, customRetriableException, getConfig, getDataCollectionsToBeSnapshotted, getEventProcessingFailureHandlingMode, getHeartbeatInterval, getHeartbeatTopicsPrefix, getIncrementalSnashotChunkSize, getLogicalName, getMaxBatchSize, getMaxQueueSize, getMaxQueueSizeInBytes, getPollInterval, getQueryFetchSize, getRetriableRestartWait, getSanitizeFieldNames, getSignalingDataCollectionId, getSnapshotDelay, getSnapshotFetchSize, getSnapshotMaxThreads, getSourceInfoStructMaker, getTaskId, getTransactionTopic, isEmitTombstoneOnDelete, isIncrementalSnapshotSchemaChangesEnabled, isSignalDataCollection, legacyGetDataCollectionsToBeSnapshotted, parseSignallingMessage, schemaNameAdjustmentMode, shouldProvideTransactionMetadata, supportsOperationFiltering, supportsSchemaChangesDuringIncrementalSnapshot, validate, validateAndRecord, validateServerNameIsDifferentFromHistoryTopicName, validateSkippedOperation

Methods inherited from class java.lang.Object

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

Field Details

LOGGER

private static final org.slf4j.Logger LOGGER

DATABASE_CONFIG_PREFIX

protected static final String DATABASE_CONFIG_PREFIX

See Also:

• Constant Field Values

DEFAULT_PORT

protected static final int DEFAULT_PORT

See Also:

• Constant Field Values

DEFAULT_SNAPSHOT_FETCH_SIZE

protected static final int DEFAULT_SNAPSHOT_FETCH_SIZE

See Also:

• Constant Field Values

DEFAULT_MAX_RETRIES

protected static final int DEFAULT_MAX_RETRIES

See Also:

• Constant Field Values

PORT

public static final Field PORT

PLUGIN_NAME

public static final Field PLUGIN_NAME

SLOT_NAME

public static final Field SLOT_NAME

DROP_SLOT_ON_STOP

public static final Field DROP_SLOT_ON_STOP

PUBLICATION_NAME

public static final Field PUBLICATION_NAME

PUBLICATION_AUTOCREATE_MODE

public static final Field PUBLICATION_AUTOCREATE_MODE

STREAM_PARAMS

public static final Field STREAM_PARAMS

MAX_RETRIES

public static final Field MAX_RETRIES

RETRY_DELAY_MS

public static final Field RETRY_DELAY_MS

ON_CONNECT_STATEMENTS

public static final Field ON_CONNECT_STATEMENTS

SSL_MODE

public static final Field SSL_MODE

SSL_CLIENT_CERT

public static final Field SSL_CLIENT_CERT

SSL_CLIENT_KEY

public static final Field SSL_CLIENT_KEY

SSL_CLIENT_KEY_PASSWORD

public static final Field SSL_CLIENT_KEY_PASSWORD

SSL_ROOT_CERT

public static final Field SSL_ROOT_CERT

SSL_SOCKET_FACTORY

public static final Field SSL_SOCKET_FACTORY

SNAPSHOT_MODE

public static final Field SNAPSHOT_MODE

SNAPSHOT_MODE_CLASS

public static final Field SNAPSHOT_MODE_CLASS

LOGICAL_DECODING_MESSAGE_PREFIX_EXCLUDE_LIST

public static final Field LOGICAL_DECODING_MESSAGE_PREFIX_EXCLUDE_LIST

A comma-separated list of regular expressions that match the prefix of logical decoding messages to be excluded from monitoring. Must not be used with LOGICAL_DECODING_MESSAGE_PREFIX_INCLUDE_LIST

LOGICAL_DECODING_MESSAGE_PREFIX_INCLUDE_LIST

public static final Field LOGICAL_DECODING_MESSAGE_PREFIX_INCLUDE_LIST

A comma-separated list of regular expressions that match the prefix of logical decoding messages to be monitored. Must not be used with LOGICAL_DECODING_MESSAGE_PREFIX_EXCLUDE_LIST

TRUNCATE_HANDLING_MODE

@Deprecated
public static final Field TRUNCATE_HANDLING_MODE

Deprecated.

use skipped operations instead

HSTORE_HANDLING_MODE

public static final Field HSTORE_HANDLING_MODE

INTERVAL_HANDLING_MODE

public static final Field INTERVAL_HANDLING_MODE

STATUS_UPDATE_INTERVAL_MS

public static final Field STATUS_UPDATE_INTERVAL_MS

TCP_KEEPALIVE

public static final Field TCP_KEEPALIVE

INCLUDE_UNKNOWN_DATATYPES

public static final Field INCLUDE_UNKNOWN_DATATYPES

SCHEMA_REFRESH_MODE

public static final Field SCHEMA_REFRESH_MODE

XMIN_FETCH_INTERVAL

public static final Field XMIN_FETCH_INTERVAL

TOASTED_VALUE_PLACEHOLDER

@Deprecated
public static final Field TOASTED_VALUE_PLACEHOLDER

Deprecated.

UNAVAILABLE_VALUE_PLACEHOLDER

public static final Field UNAVAILABLE_VALUE_PLACEHOLDER

MONEY_FRACTION_DIGITS

public static final Field MONEY_FRACTION_DIGITS

SKIPPED_OPERATIONS

public static final Field SKIPPED_OPERATIONS

truncateHandlingMode

private final PostgresConnectorConfig.TruncateHandlingMode truncateHandlingMode

logicalDecodingMessageFilter

private final LogicalDecodingMessageFilter logicalDecodingMessageFilter

hStoreHandlingMode

private final PostgresConnectorConfig.HStoreHandlingMode hStoreHandlingMode

intervalHandlingMode

private final PostgresConnectorConfig.IntervalHandlingMode intervalHandlingMode

snapshotMode

private final PostgresConnectorConfig.SnapshotMode snapshotMode

schemaRefreshMode

private final PostgresConnectorConfig.SchemaRefreshMode schemaRefreshMode

CONFIG_DEFINITION

private static final ConfigDefinition CONFIG_DEFINITION

ALL_FIELDS

public static Field.Set ALL_FIELDS

The set of Fields defined as part of this configuration.

Constructor Details

PostgresConnectorConfig

public PostgresConnectorConfig(Configuration config)

Method Details

hostname

protected String hostname()

port

protected int port()

databaseName

public String databaseName()

plugin

protected PostgresConnectorConfig.LogicalDecoder plugin()

slotName

protected String slotName()

dropSlotOnStop

protected boolean dropSlotOnStop()

publicationName

public String publicationName()

getSkippedOperations

public EnumSet<Envelope.Operation> getSkippedOperations()

Overrides:

getSkippedOperations in class CommonConnectorConfig

publicationAutocreateMode

protected PostgresConnectorConfig.AutoCreateMode publicationAutocreateMode()

streamParams

protected String streamParams()

maxRetries

public int maxRetries()

retryDelay

public Duration retryDelay()

statusUpdateInterval

protected Duration statusUpdateInterval()

getMessageFilter

public LogicalDecodingMessageFilter getMessageFilter()

hStoreHandlingMode

protected PostgresConnectorConfig.HStoreHandlingMode hStoreHandlingMode()

intervalHandlingMode

protected PostgresConnectorConfig.IntervalHandlingMode intervalHandlingMode()

includeUnknownDatatypes

protected boolean includeUnknownDatatypes()

validate

public Map<String,org.apache.kafka.common.config.ConfigValue> validate()

getSnapshotter

protected Snapshotter getSnapshotter()

skipRefreshSchemaOnMissingToastableData

protected boolean skipRefreshSchemaOnMissingToastableData()

xminFetchInterval

protected Duration xminFetchInterval()

getUnavailableValuePlaceholder

public byte[] getUnavailableValuePlaceholder()

Overrides:

getUnavailableValuePlaceholder in class RelationalDatabaseConnectorConfig

moneyFractionDigits

protected int moneyFractionDigits()

getSourceInfoStructMaker

protected SourceInfoStructMaker<? extends AbstractSourceInfo> getSourceInfoStructMaker(CommonConnectorConfig.Version version)

Specified by:

getSourceInfoStructMaker in class CommonConnectorConfig

configDef

public static org.apache.kafka.common.config.ConfigDef configDef()

validateReplicationSlotName

private static int validateReplicationSlotName(Configuration config,
 Field field,
 Field.ValidationOutput problems)

validateTruncateHandlingMode

private static int validateTruncateHandlingMode(Configuration config,
 Field field,
 Field.ValidationOutput problems)

validateSkippedOperations

private static int validateSkippedOperations(Configuration config,
 Field field,
 Field.ValidationOutput problems)

validateToastedValuePlaceholder

private static int validateToastedValuePlaceholder(Configuration config,
 Field field,
 Field.ValidationOutput problems)

validatePluginName

private static int validatePluginName(Configuration config,
 Field field,
 Field.ValidationOutput problems)

validateLogicalDecodingMessageExcludeList

private static int validateLogicalDecodingMessageExcludeList(Configuration config,
 Field field,
 Field.ValidationOutput problems)

getContextName

public String getContextName()

Specified by:

getContextName in class CommonConnectorConfig

getConnectorName

public String getConnectorName()

Specified by:

getConnectorName in class CommonConnectorConfig