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 and Description
static class	PostgresConnectorConfig.HStoreHandlingMode The set of predefined HStoreHandlingMode options or aliases
static class	PostgresConnectorConfig.LogicalDecoder
static class	PostgresConnectorConfig.SchemaRefreshMode The set of predefined SchemaRefreshMode options or aliases.
static class	PostgresConnectorConfig.SecureConnectionMode The set of predefined SecureConnectionMode options or aliases.
static class	PostgresConnectorConfig.SnapshotMode The set of predefined Snapshotter options or aliases.
private static class	PostgresConnectorConfig.SystemTablesPredicate

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

RelationalDatabaseConnectorConfig.DecimalHandlingMode

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

CommonConnectorConfig.Version

Field Summary

Fields

Modifier and Type	Field and Description
static Field.Set	ALL_FIELDS The set of Fields defined as part of this configuration.
protected static String	DATABASE_CONFIG_PREFIX
static Field	DATABASE_NAME
protected static int	DEFAULT_MAX_RETRIES
protected static int	DEFAULT_PORT
protected static Duration	DEFAULT_RETRY_DELAY
protected static int	DEFAULT_SNAPSHOT_FETCH_SIZE
protected static long	DEFAULT_SNAPSHOT_LOCK_TIMEOUT_MILLIS
static Field	DROP_SLOT_ON_STOP
static Field	HOSTNAME
static Field	HSTORE_HANDLING_MODE
private PostgresConnectorConfig.HStoreHandlingMode	hStoreHandlingMode
static Field	INCLUDE_SCHEMA_CHANGES
static Field	INCLUDE_UNKNOWN_DATATYPES
static Field	MAX_RETRIES
static Field	ON_CONNECT_STATEMENTS
static Field	PASSWORD
static Field	PLUGIN_NAME
static Field	PORT
static Field	PUBLICATION_NAME
static Field	RETRY_DELAY_MS
static Field	SCHEMA_REFRESH_MODE
private PostgresConnectorConfig.SchemaRefreshMode	schemaRefreshMode
static Field	SLOT_NAME
static Field	SNAPSHOT_LOCK_TIMEOUT_MS
static Field	SNAPSHOT_MODE
static Field	SNAPSHOT_MODE_CLASS
private PostgresConnectorConfig.SnapshotMode	snapshotMode
static Field	SSL_CLIENT_CERT
static Field	SSL_CLIENT_KEY
static Field	SSL_CLIENT_KEY_PASSWORD
static Field	SSL_MODE
static Field	SSL_ROOT_CERT
static Field	SSL_SOCKET_FACTORY
static Field	STATUS_UPDATE_INTERVAL_MS
static Field	STREAM_PARAMS
static Field	TABLE_BLACKLIST A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring.
static Field	TABLE_WHITELIST A comma-separated list of regular expressions that match the fully-qualified names of tables to be monitored.
private static String	TABLE_WHITELIST_NAME
static Field	TCP_KEEPALIVE
static Field	TOASTED_VALUE_PLACEHOLDER
static Field	USER
static Field	XMIN_FETCH_INTERVAL

Fields inherited from class io.debezium.relational.RelationalDatabaseConnectorConfig

COLUMN_BLACKLIST, DECIMAL_HANDLING_MODE, MSG_KEY_COLUMNS, SCHEMA_BLACKLIST, SCHEMA_WHITELIST, SERVER_NAME, SNAPSHOT_SELECT_STATEMENT_OVERRIDES_BY_TABLE, TABLE_IGNORE_BUILTIN, TIME_PRECISION_MODE

Fields inherited from class io.debezium.config.CommonConnectorConfig

DEFAULT_MAX_BATCH_SIZE, DEFAULT_MAX_QUEUE_SIZE, DEFAULT_POLL_INTERVAL_MILLIS, MAX_BATCH_SIZE, MAX_QUEUE_SIZE, POLL_INTERVAL_MS, SANITIZE_FIELD_NAMES, SNAPSHOT_DELAY_MS, SNAPSHOT_FETCH_SIZE, SOURCE_STRUCT_MAKER_VERSION, TOMBSTONES_ON_DELETE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PostgresConnectorConfig(Configuration config)

Method Summary

Modifier and Type	Method and Description
protected String	columnBlacklist()
protected static org.apache.kafka.common.config.ConfigDef	configDef()
protected String	databaseName()
protected boolean	dropSlotOnStop()
String	getContextName()
protected Snapshotter	getSnapshotter()
protected SourceInfoStructMaker<? extends AbstractSourceInfo>	getSourceInfoStructMaker(CommonConnectorConfig.Version version)
protected String	hostname()
protected PostgresConnectorConfig.HStoreHandlingMode	hStoreHandlingMode()
protected boolean	includeUnknownDatatypes()
Configuration	jdbcConfig()
protected int	maxRetries()
protected PostgresConnectorConfig.LogicalDecoder	plugin()
protected int	port()
protected String	publicationName()
protected Duration	retryDelay()
protected String	schemaBlacklist()
protected String	schemaWhitelist()
protected boolean	skipRefreshSchemaOnMissingToastableData()
protected String	slotName()
protected Duration	snapshotLockTimeout()
protected Duration	statusUpdateInterval()
protected String	streamParams()
protected String	tableBlacklist()
protected String	tableWhitelist()
protected byte[]	toastedValuePlaceholder()
protected Map<String,org.apache.kafka.common.config.ConfigValue>	validate()
private static int	validateTableBlacklist(Configuration config, Field field, Field.ValidationOutput problems)
protected Duration	xminFetchInterval()

Methods inherited from class io.debezium.relational.RelationalDatabaseConnectorConfig

getDecimalMode, getKeyMapper, getSnapshotSelectOverridesByTable, getTableFilters, getTemporalPrecisionMode

Methods inherited from class io.debezium.config.CommonConnectorConfig

getConfig, getHeartbeatTopicsPrefix, getLogicalName, getMaxBatchSize, getMaxQueueSize, getPollInterval, getSanitizeFieldNames, getSnapshotDelay, getSnapshotFetchSize, getSourceInfoStructMaker, isEmitTombstoneOnDelete, validateServerNameIsDifferentFromHistoryTopicName

Methods inherited from class java.lang.Object

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

Field Detail

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_SNAPSHOT_LOCK_TIMEOUT_MILLIS

protected static final long DEFAULT_SNAPSHOT_LOCK_TIMEOUT_MILLIS

DEFAULT_MAX_RETRIES

protected static final int DEFAULT_MAX_RETRIES

See Also:

Constant Field Values

DEFAULT_RETRY_DELAY

protected static final Duration DEFAULT_RETRY_DELAY

TABLE_WHITELIST_NAME

private static final String TABLE_WHITELIST_NAME

See Also:

Constant Field Values

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

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

HOSTNAME

public static final Field HOSTNAME

PORT

public static final Field PORT

USER

public static final Field USER

PASSWORD

public static final Field PASSWORD

DATABASE_NAME

public static final Field DATABASE_NAME

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

TABLE_WHITELIST

public static final Field TABLE_WHITELIST

A comma-separated list of regular expressions that match the fully-qualified names of tables to be monitored. Fully-qualified names for tables are of the form <schemaName>.<tableName> or <databaseName>.<schemaName>.<tableName>. May not be used with TABLE_BLACKLIST, and superseded by schema inclusions/exclusions.

TABLE_BLACKLIST

public static final Field TABLE_BLACKLIST

A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring. Fully-qualified names for tables are of the form <schemaName>.<tableName> or <databaseName>.<schemaName>.<tableName>. May not be used with TABLE_WHITELIST.

INCLUDE_SCHEMA_CHANGES

public static final Field INCLUDE_SCHEMA_CHANGES

SNAPSHOT_MODE

public static final Field SNAPSHOT_MODE

SNAPSHOT_MODE_CLASS

public static final Field SNAPSHOT_MODE_CLASS

SNAPSHOT_LOCK_TIMEOUT_MS

public static final Field SNAPSHOT_LOCK_TIMEOUT_MS

HSTORE_HANDLING_MODE

public static final Field HSTORE_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

public static final Field TOASTED_VALUE_PLACEHOLDER

ALL_FIELDS

public static Field.Set ALL_FIELDS

The set of Fields defined as part of this configuration.

hStoreHandlingMode

private final PostgresConnectorConfig.HStoreHandlingMode hStoreHandlingMode

snapshotMode

private final PostgresConnectorConfig.SnapshotMode snapshotMode

schemaRefreshMode

private final PostgresConnectorConfig.SchemaRefreshMode schemaRefreshMode

Constructor Detail

PostgresConnectorConfig

protected PostgresConnectorConfig(Configuration config)

Method Detail

hostname

protected String hostname()

port

protected int port()

databaseName

protected String databaseName()

plugin

protected PostgresConnectorConfig.LogicalDecoder plugin()

slotName

protected String slotName()

dropSlotOnStop

protected boolean dropSlotOnStop()

publicationName

protected String publicationName()

streamParams

protected String streamParams()

maxRetries

protected int maxRetries()

retryDelay

protected Duration retryDelay()

statusUpdateInterval

protected Duration statusUpdateInterval()

hStoreHandlingMode

protected PostgresConnectorConfig.HStoreHandlingMode hStoreHandlingMode()

includeUnknownDatatypes

protected boolean includeUnknownDatatypes()

jdbcConfig

public Configuration jdbcConfig()

validate

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

schemaBlacklist

protected String schemaBlacklist()

schemaWhitelist

protected String schemaWhitelist()

tableBlacklist

protected String tableBlacklist()

tableWhitelist

protected String tableWhitelist()

columnBlacklist

protected String columnBlacklist()

snapshotLockTimeout

protected Duration snapshotLockTimeout()

getSnapshotter

protected Snapshotter getSnapshotter()

skipRefreshSchemaOnMissingToastableData

protected boolean skipRefreshSchemaOnMissingToastableData()

xminFetchInterval

protected Duration xminFetchInterval()

toastedValuePlaceholder

protected byte[] toastedValuePlaceholder()

getSourceInfoStructMaker

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

Specified by:

getSourceInfoStructMaker in class CommonConnectorConfig

configDef

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

validateTableBlacklist

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

getContextName

public String getContextName()

Specified by:

getContextName in class CommonConnectorConfig