Package io.debezium.relational
Class RelationalDatabaseConnectorConfig
java.lang.Object
io.debezium.config.CommonConnectorConfig
io.debezium.relational.RelationalDatabaseConnectorConfig
- Direct Known Subclasses:
HistorizedRelationalDatabaseConnectorConfig
Configuration options shared across the relational CDC connectors.
- Author:
- Gunnar Morling
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
The set of predefined DecimalHandlingMode options or aliases.Nested classes/interfaces inherited from class io.debezium.config.CommonConnectorConfig
CommonConnectorConfig.BinaryHandlingMode, CommonConnectorConfig.EventProcessingFailureHandlingMode, CommonConnectorConfig.SchemaNameAdjustmentMode, CommonConnectorConfig.Version
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Field
Deprecated.static final Field
A comma-separated list of regular expressions that match fully-qualified names of columns to be excluded from monitoring and change messages.static final Field
A comma-separated list of regular expressions that match fully-qualified names of columns to be excluded from monitoring and change messages.static final String
static final Field
Deprecated.static final String
private final Tables.ColumnNameFilter
protected static final ConfigDefinition
static final Field
Deprecated.protected static final String
static final Field
A comma-separated list of regular expressions that match database names to be excluded from monitoring.protected static final String
static final Field
A comma-separated list of regular expressions that match database names to be monitored.static final String
protected static final String
static final Field
static final Field
Deprecated.static final String
protected static final String
static final Field
static final long
static final String
private final String
static final Field
static final Field
static final Field
private final JdbcConfiguration
private final Key.KeyMapper
static final Field
static final Field
static final Field
static final Field
static final Field
static final Field
static final Field
static final Field
Deprecated.static final Field
A comma-separated list of regular expressions that match schema names to be excluded from monitoring.protected static final String
static final Field
A comma-separated list of regular expressions that match schema names to be monitored.static final String
protected static final String
static final Field
Deprecated.static final String
static final Field
protected static final Pattern
static final Field
static final Field
static final Field
static final Field
Deprecated.protected static final String
static final Field
A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring.protected static final String
static final Field
static final Field
A comma-separated list of regular expressions that match the fully-qualified names of tables to be monitored.static final String
protected static final String
static final Field
Deprecated.static final String
protected static final String
private final RelationalTableFilters
private final Selectors.TableIdToStringMapper
private final TemporalPrecisionMode
static final Field
static final Field
static final Field
static final Field
Fields inherited from class io.debezium.config.CommonConnectorConfig
BINARY_HANDLING_MODE, CUSTOM_CONVERTERS, CUSTOM_RETRIABLE_EXCEPTION, DATABASE_CONFIG_PREFIX, 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, SKIPPED_OPERATIONS, 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
ModifierConstructorDescriptionprotected
RelationalDatabaseConnectorConfig
(Configuration config, String logicalName, Tables.TableFilter systemTablesFilter, Selectors.TableIdToStringMapper tableIdMapper, int defaultSnapshotFetchSize, ColumnFilterMode columnFilterMode) -
Method Summary
Modifier and TypeMethodDescriptionReturns the Decimal mode Enum fordecimal.handling.mode
configuration.Returns a "raw" configuration object exposing all the database driver related settings, without the "database." prefix.Returns any SELECT overrides, if present.Returns the temporal precision mode mode Enum fortime.precision.mode
configuration.byte[]
boolean
boolean
private static int
validateColumnBlacklist
(Configuration config, Field field, Field.ValidationOutput problems) private static int
validateColumnExcludeList
(Configuration config, Field field, Field.ValidationOutput problems) private static int
validateDatabaseBlacklist
(Configuration config, Field field, Field.ValidationOutput problems) private static int
validateDatabaseExcludeList
(Configuration config, Field field, Field.ValidationOutput problems) private static int
validateMessageKeyColumnsField
(Configuration config, Field field, Field.ValidationOutput problems) private static int
validateSchemaBlacklist
(Configuration config, Field field, Field.ValidationOutput problems) private static int
validateSchemaExcludeList
(Configuration config, Field field, Field.ValidationOutput problems) private static int
validateServerName
(Configuration config, Field field, Field.ValidationOutput problems) private static int
validateTableBlacklist
(Configuration config, Field field, Field.ValidationOutput problems) private static int
validateTableExcludeList
(Configuration config, Field field, Field.ValidationOutput problems) Methods inherited from class io.debezium.config.CommonConnectorConfig
binaryHandlingMode, customConverterRegistry, customRetriableException, getConfig, getConnectorName, getContextName, getDataCollectionsToBeSnapshotted, getEventProcessingFailureHandlingMode, getHeartbeatInterval, getHeartbeatTopicsPrefix, getIncrementalSnashotChunkSize, getLogicalName, getMaxBatchSize, getMaxQueueSize, getMaxQueueSizeInBytes, getPollInterval, getQueryFetchSize, getRetriableRestartWait, getSanitizeFieldNames, getSignalingDataCollectionId, getSkippedOperations, getSnapshotDelay, getSnapshotFetchSize, getSnapshotMaxThreads, getSourceInfoStructMaker, getSourceInfoStructMaker, getTaskId, getTransactionTopic, isEmitTombstoneOnDelete, isIncrementalSnapshotSchemaChangesEnabled, isSignalDataCollection, legacyGetDataCollectionsToBeSnapshotted, parseSignallingMessage, schemaNameAdjustmentMode, shouldProvideTransactionMetadata, supportsOperationFiltering, supportsSchemaChangesDuringIncrementalSnapshot, validate, validateAndRecord, validateServerNameIsDifferentFromHistoryTopicName, validateSkippedOperation
-
Field Details
-
SCHEMA_INCLUDE_LIST_NAME
- See Also:
-
SCHEMA_EXCLUDE_LIST_NAME
- See Also:
-
DATABASE_WHITELIST_NAME
- See Also:
-
DATABASE_INCLUDE_LIST_NAME
- See Also:
-
DATABASE_BLACKLIST_NAME
- See Also:
-
DATABASE_EXCLUDE_LIST_NAME
- See Also:
-
TABLE_BLACKLIST_NAME
- See Also:
-
TABLE_EXCLUDE_LIST_NAME
- See Also:
-
TABLE_WHITELIST_NAME
- See Also:
-
TABLE_INCLUDE_LIST_NAME
- See Also:
-
SERVER_NAME_PATTERN
-
TABLE_INCLUDE_LIST_ALREADY_SPECIFIED_ERROR_MSG
- See Also:
-
TABLE_WHITELIST_ALREADY_SPECIFIED_ERROR_MSG
- See Also:
-
COLUMN_INCLUDE_LIST_ALREADY_SPECIFIED_ERROR_MSG
- See Also:
-
COLUMN_WHITELIST_ALREADY_SPECIFIED_ERROR_MSG
- See Also:
-
SCHEMA_INCLUDE_LIST_ALREADY_SPECIFIED_ERROR_MSG
- See Also:
-
SCHEMA_WHITELIST_ALREADY_SPECIFIED_ERROR_MSG
- See Also:
-
DATABASE_INCLUDE_LIST_ALREADY_SPECIFIED_ERROR_MSG
- See Also:
-
DATABASE_WHITELIST_ALREADY_SPECIFIED_ERROR_MSG
- See Also:
-
DEFAULT_SNAPSHOT_LOCK_TIMEOUT_MILLIS
public static final long DEFAULT_SNAPSHOT_LOCK_TIMEOUT_MILLIS -
DEFAULT_UNAVAILABLE_VALUE_PLACEHOLDER
- See Also:
-
HOSTNAME
-
PORT
-
USER
-
PASSWORD
-
DATABASE_NAME
-
SERVER_NAME
-
TABLE_INCLUDE_LIST
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<databaseName>.<tableName>
or<databaseName>.<schemaName>.<tableName>
. Must not be used withTABLE_EXCLUDE_LIST
, and superseded by database inclusions/exclusions. -
TABLE_WHITELIST
Deprecated.Old, backwards-compatible "whitelist" property. -
TABLE_EXCLUDE_LIST
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<databaseName>.<tableName>
or<databaseName>.<schemaName>.<tableName>
. Must not be used withTABLE_INCLUDE_LIST
. -
TABLE_BLACKLIST
Deprecated.Old, backwards-compatible "blacklist" property. -
TABLE_IGNORE_BUILTIN
-
COLUMN_EXCLUDE_LIST
A comma-separated list of regular expressions that match fully-qualified names of columns to be excluded from monitoring and change messages. The exact form of fully qualified names for columns might vary between connector types. For instance, they could be of the form<databaseName>.<tableName>.<columnName>
or<schemaName>.<tableName>.<columnName>
or<databaseName>.<schemaName>.<tableName>.<columnName>
. -
COLUMN_BLACKLIST
Deprecated.Old, backwards-compatible "blacklist" property. -
COLUMN_INCLUDE_LIST
A comma-separated list of regular expressions that match fully-qualified names of columns to be excluded from monitoring and change messages. The exact form of fully qualified names for columns might vary between connector types. For instance, they could be of the form<databaseName>.<tableName>.<columnName>
or<schemaName>.<tableName>.<columnName>
or<databaseName>.<schemaName>.<tableName>.<columnName>
. -
COLUMN_WHITELIST
Deprecated.Old, backwards-compatible "whitelist" property. -
MSG_KEY_COLUMNS
-
DECIMAL_HANDLING_MODE
-
SNAPSHOT_SELECT_STATEMENT_OVERRIDES_BY_TABLE
-
SCHEMA_INCLUDE_LIST
A comma-separated list of regular expressions that match schema names to be monitored. Must not be used withSCHEMA_EXCLUDE_LIST
. -
SCHEMA_WHITELIST
Deprecated.Old, backwards-compatible "whitelist" property. -
SCHEMA_EXCLUDE_LIST
A comma-separated list of regular expressions that match schema names to be excluded from monitoring. Must not be used withSCHEMA_INCLUDE_LIST
. -
SCHEMA_BLACKLIST
Deprecated.Old, backwards-compatible "blacklist" property. -
DATABASE_INCLUDE_LIST
A comma-separated list of regular expressions that match database names to be monitored. Must not be used withDATABASE_BLACKLIST
. -
DATABASE_WHITELIST
Deprecated. -
DATABASE_EXCLUDE_LIST
A comma-separated list of regular expressions that match database names to be excluded from monitoring. Must not be used withDATABASE_INCLUDE_LIST
. -
DATABASE_BLACKLIST
Deprecated. -
TIME_PRECISION_MODE
-
SNAPSHOT_LOCK_TIMEOUT_MS
-
INCLUDE_SCHEMA_CHANGES
-
INCLUDE_SCHEMA_COMMENTS
-
MASK_COLUMN_WITH_HASH
-
MASK_COLUMN
-
TRUNCATE_COLUMN
-
PROPAGATE_COLUMN_SOURCE_TYPE
-
PROPAGATE_DATATYPE_SOURCE_TYPE
-
SNAPSHOT_FULL_COLUMN_SCAN_FORCE
-
UNAVAILABLE_VALUE_PLACEHOLDER
-
CONFIG_DEFINITION
-
tableFilters
-
columnFilter
-
temporalPrecisionMode
-
keyMapper
-
tableIdMapper
-
jdbcConfig
-
heartbeatActionQuery
-
-
Constructor Details
-
RelationalDatabaseConnectorConfig
protected RelationalDatabaseConnectorConfig(Configuration config, String logicalName, Tables.TableFilter systemTablesFilter, Selectors.TableIdToStringMapper tableIdMapper, int defaultSnapshotFetchSize, ColumnFilterMode columnFilterMode)
-
-
Method Details
-
getTableFilters
-
getDecimalMode
Returns the Decimal mode Enum fordecimal.handling.mode
configuration. This defaults toprecise
if nothing is provided. -
getTemporalPrecisionMode
Returns the temporal precision mode mode Enum fortime.precision.mode
configuration. This defaults toadaptive
if nothing is provided. -
getKeyMapper
-
getJdbcConfig
Returns a "raw" configuration object exposing all the database driver related settings, without the "database." prefix. Typically used for passing through driver settings. -
getHeartbeatActionQuery
-
snapshotLockTimeout
-
schemaExcludeList
-
schemaIncludeList
-
tableExcludeList
-
tableIncludeList
-
getColumnFilter
-
isFullColummnScanRequired
-
validateColumnBlacklist
private static int validateColumnBlacklist(Configuration config, Field field, Field.ValidationOutput problems) -
validateColumnExcludeList
private static int validateColumnExcludeList(Configuration config, Field field, Field.ValidationOutput problems) -
isSchemaChangesHistoryEnabled
public boolean isSchemaChangesHistoryEnabled()- Overrides:
isSchemaChangesHistoryEnabled
in classCommonConnectorConfig
- Returns:
- true if the connector should emit messages about schema changes into a public facing topic.
-
isSchemaCommentsHistoryEnabled
public boolean isSchemaCommentsHistoryEnabled()- Overrides:
isSchemaCommentsHistoryEnabled
in classCommonConnectorConfig
- Returns:
- true if the connector should emit messages which include table and column comments.
-
getTableIdMapper
-
validateTableBlacklist
private static int validateTableBlacklist(Configuration config, Field field, Field.ValidationOutput problems) -
validateTableExcludeList
private static int validateTableExcludeList(Configuration config, Field field, Field.ValidationOutput problems) -
getSnapshotSelectOverridesByTable
Returns any SELECT overrides, if present. -
validateSchemaBlacklist
private static int validateSchemaBlacklist(Configuration config, Field field, Field.ValidationOutput problems) -
validateSchemaExcludeList
private static int validateSchemaExcludeList(Configuration config, Field field, Field.ValidationOutput problems) -
validateDatabaseExcludeList
private static int validateDatabaseExcludeList(Configuration config, Field field, Field.ValidationOutput problems) -
validateDatabaseBlacklist
private static int validateDatabaseBlacklist(Configuration config, Field field, Field.ValidationOutput problems) -
validateMessageKeyColumnsField
private static int validateMessageKeyColumnsField(Configuration config, Field field, Field.ValidationOutput problems) -
validateServerName
private static int validateServerName(Configuration config, Field field, Field.ValidationOutput problems)
-