io.debezium.connector.postgresql

Class PostgresConnectorConfig

java.lang.Object

io.debezium.connector.postgresql.PostgresConnectorConfig

public class PostgresConnectorConfig
extends Object

The configuration properties for the PostgresConnector

Author:

Horia Chiorean

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PostgresConnectorConfig.SecureConnectionMode The set of predefined SecureConnectionMode options or aliases.
static class	PostgresConnectorConfig.SnapshotMode The set of predefined SnapshotMode options or aliases.
static class	PostgresConnectorConfig.TemporalPrecisionMode The set of predefined TemporalPrecisionMode options or aliases.
static class	PostgresConnectorConfig.TopicSelectionStrategy The set of configuration options for how events are placed on Kafka topics

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	adaptiveTimePrecision
static Field.Set	ALL_FIELDS The set of Fields defined as part of this configuration.
static Field	COLUMN_BLACKLIST A comma-separated list of regular expressions that match fully-qualified names of columns to be excluded from monitoring and change messages.
private Configuration	config
protected static String	DATABASE_CONFIG_PREFIX
static Field	DATABASE_NAME
protected static int	DEFAULT_MAX_BATCH_SIZE
protected static int	DEFAULT_MAX_QUEUE_SIZE
protected static long	DEFAULT_POLL_INTERVAL_MILLIS
protected static int	DEFAULT_PORT
protected static int	DEFAULT_ROWS_FETCH_SIZE
protected static long	DEFAULT_SNAPSHOT_LOCK_TIMEOUT_MILLIS
static Field	DROP_SLOT_ON_STOP
static Field	HOSTNAME
static Field	INCLUDE_SCHEMA_CHANGES
static Field	MAX_BATCH_SIZE
static Field	MAX_QUEUE_SIZE
static Field	PASSWORD
static Field	PLUGIN_NAME
static Field	POLL_INTERVAL_MS
static Field	PORT
static Field	ROWS_FETCH_SIZE
static Field	SCHEMA_BLACKLIST A comma-separated list of regular expressions that match schema names to be excluded from monitoring.
static Field	SCHEMA_WHITELIST A comma-separated list of regular expressions that match schema names to be monitored.
static Field	SERVER_NAME
private String	serverName
static Field	SLOT_NAME
static Field	SNAPSHOT_LOCK_TIMEOUT_MS
static Field	SNAPSHOT_MODE
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	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	TIME_PRECISION_MODE
static Field	TOPIC_SELECTION_STRATEGY
static Field	USER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PostgresConnectorConfig(Configuration config)

Method Summary

Modifier and Type	Method and Description
protected boolean	adaptiveTimePrecision()
protected boolean	alwaysTakeSnapshot()
protected String	columnBlacklist()
protected static org.apache.kafka.common.config.ConfigDef	configDef()
protected String	databaseName()
protected boolean	dropSlotOnStop()
protected String	hostname()
protected boolean	initialOnlySnapshot()
protected Configuration	jdbcConfig()
protected int	maxBatchSize()
protected int	maxQueueSize()
protected String	pluginName()
protected long	pollIntervalMs()
protected int	port()
protected int	rowsFetchSize()
protected String	schemaBlacklist()
protected String	schemaWhitelist()
protected String	serverName()
protected String	slotName()
protected long	snapshotLockTimeoutMillis()
protected boolean	snapshotNeverAllowed()
protected Integer	statusUpdateIntervalMillis()
protected String	tableBlacklist()
protected String	tableWhitelist()
protected PostgresConnectorConfig.TopicSelectionStrategy	topicSelectionStrategy()
protected Map<String,org.apache.kafka.common.config.ConfigValue>	validate()
protected boolean	validateAndRecord(Consumer<String> errorConsumer)
private static int	validateMaxQueueSize(Configuration config, Field field, Field.ValidationOutput problems)
private static int	validateSchemaBlacklist(Configuration config, Field field, Field.ValidationOutput problems)
private static int	validateTableBlacklist(Configuration config, Field field, Field.ValidationOutput problems)

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_MAX_BATCH_SIZE

protected static final int DEFAULT_MAX_BATCH_SIZE

See Also:

Constant Field Values

DEFAULT_MAX_QUEUE_SIZE

protected static final int DEFAULT_MAX_QUEUE_SIZE

See Also:

Constant Field Values

DEFAULT_ROWS_FETCH_SIZE

protected static final int DEFAULT_ROWS_FETCH_SIZE

See Also:

Constant Field Values

DEFAULT_POLL_INTERVAL_MILLIS

protected static final long DEFAULT_POLL_INTERVAL_MILLIS

See Also:

Constant Field Values

DEFAULT_SNAPSHOT_LOCK_TIMEOUT_MILLIS

protected static final long DEFAULT_SNAPSHOT_LOCK_TIMEOUT_MILLIS

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

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

SERVER_NAME

public static final Field SERVER_NAME

TOPIC_SELECTION_STRATEGY

public static final Field TOPIC_SELECTION_STRATEGY

MAX_QUEUE_SIZE

public static final Field MAX_QUEUE_SIZE

MAX_BATCH_SIZE

public static final Field MAX_BATCH_SIZE

ROWS_FETCH_SIZE

public static final Field ROWS_FETCH_SIZE

POLL_INTERVAL_MS

public static final Field POLL_INTERVAL_MS

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

SCHEMA_WHITELIST

public static final Field SCHEMA_WHITELIST

A comma-separated list of regular expressions that match schema names to be monitored. May not be used with SCHEMA_BLACKLIST.

SCHEMA_BLACKLIST

public static final Field SCHEMA_BLACKLIST

A comma-separated list of regular expressions that match schema names to be excluded from monitoring. May not be used with SCHEMA_WHITELIST.

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.

COLUMN_BLACKLIST

public static final Field COLUMN_BLACKLIST

A comma-separated list of regular expressions that match fully-qualified names of columns to be excluded from monitoring and change messages. Fully-qualified names for columns are of the form <schemaName>.<tableName>.<columnName>.

INCLUDE_SCHEMA_CHANGES

public static final Field INCLUDE_SCHEMA_CHANGES

SNAPSHOT_MODE

public static final Field SNAPSHOT_MODE

SNAPSHOT_LOCK_TIMEOUT_MS

public static final Field SNAPSHOT_LOCK_TIMEOUT_MS

TIME_PRECISION_MODE

public static final Field TIME_PRECISION_MODE

STATUS_UPDATE_INTERVAL_MS

public static final Field STATUS_UPDATE_INTERVAL_MS

ALL_FIELDS

public static Field.Set ALL_FIELDS

The set of Fields defined as part of this configuration.

config

private final Configuration config

serverName

private final String serverName

adaptiveTimePrecision

private final boolean adaptiveTimePrecision

snapshotMode

private final PostgresConnectorConfig.SnapshotMode snapshotMode

Constructor Detail

PostgresConnectorConfig

protected PostgresConnectorConfig(Configuration config)

Method Detail

hostname

protected String hostname()

port

protected int port()

databaseName

protected String databaseName()

pluginName

protected String pluginName()

slotName

protected String slotName()

dropSlotOnStop

protected boolean dropSlotOnStop()

statusUpdateIntervalMillis

protected Integer statusUpdateIntervalMillis()

maxQueueSize

protected int maxQueueSize()

maxBatchSize

protected int maxBatchSize()

pollIntervalMs

protected long pollIntervalMs()

adaptiveTimePrecision

protected boolean adaptiveTimePrecision()

jdbcConfig

protected Configuration jdbcConfig()

serverName

protected String serverName()

topicSelectionStrategy

protected PostgresConnectorConfig.TopicSelectionStrategy topicSelectionStrategy()

validate

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

validateAndRecord

protected boolean validateAndRecord(Consumer<String> errorConsumer)

schemaBlacklist

protected String schemaBlacklist()

schemaWhitelist

protected String schemaWhitelist()

tableBlacklist

protected String tableBlacklist()

tableWhitelist

protected String tableWhitelist()

columnBlacklist

protected String columnBlacklist()

rowsFetchSize

protected int rowsFetchSize()

snapshotLockTimeoutMillis

protected long snapshotLockTimeoutMillis()

snapshotNeverAllowed

protected boolean snapshotNeverAllowed()

alwaysTakeSnapshot

protected boolean alwaysTakeSnapshot()

initialOnlySnapshot

protected boolean initialOnlySnapshot()

configDef

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

validateMaxQueueSize

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

validateSchemaBlacklist

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

validateTableBlacklist

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