Package io.debezium.connector.sqlserver

Class SqlServerConnectorConfig

java.lang.Object

io.debezium.config.CommonConnectorConfig

io.debezium.relational.RelationalDatabaseConnectorConfig

io.debezium.relational.HistorizedRelationalDatabaseConnectorConfig

io.debezium.connector.sqlserver.SqlServerConnectorConfig

public class SqlServerConnectorConfig
extends HistorizedRelationalDatabaseConnectorConfig

The list of configuration options for SQL Server connector

Author:

Jiri Pechanec

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SqlServerConnectorConfig.SnapshotIsolationMode	The set of predefined snapshot isolation mode options.
static enum	SqlServerConnectorConfig.SnapshotMode	The set of predefined SnapshotMode options or aliases.
private static class	SqlServerConnectorConfig.SystemTablesPredicate

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 String	APPLICATION_INTENT_KEY
private static final ConfigDefinition	CONFIG_DEFINITION
static final Field	DATABASE_NAME
static final Field	DATABASE_NAMES
private final List<String>	databaseNames
protected static final int	DEFAULT_MAX_TRANSACTIONS_PER_ITERATION
protected static final int	DEFAULT_PORT
static final Field	INCREMENTAL_SNAPSHOT_OPTION_RECOMPILE
static final Field	INSTANCE
private final String	instanceName
private static final org.slf4j.Logger	LOGGER
static final Field	MAX_LSN_OPTIMIZATION
static final Field	MAX_TRANSACTIONS_PER_ITERATION
static final String	MAX_TRANSACTIONS_PER_ITERATION_CONFIG_NAME
private final int	maxTransactionsPerIteration
private final boolean	multiPartitionMode
private final boolean	optionRecompile
static final Field	PORT
private static final String	READ_ONLY_INTENT
private final boolean	readOnlyDatabaseConnection
static final Field	SERVER_NAME
static final Field	SERVER_TIMEZONE	Deprecated. The connector will determine the database server timezone offset automatically.
static final Field	SNAPSHOT_ISOLATION_MODE
static final Field	SNAPSHOT_MODE
private final SqlServerConnectorConfig.SnapshotIsolationMode	snapshotIsolationMode
private final SqlServerConnectorConfig.SnapshotMode	snapshotMode
static final Field	SOURCE_TIMESTAMP_MODE
static final String	SOURCE_TIMESTAMP_MODE_CONFIG_NAME
private final SourceTimestampMode	sourceTimestampMode
static final Field	USER

Fields inherited from class io.debezium.relational.HistorizedRelationalDatabaseConnectorConfig

DATABASE_HISTORY, DEFAULT_SNAPSHOT_FETCH_SIZE

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_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_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, UNAVAILABLE_VALUE_PLACEHOLDER

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

Constructors

Constructor	Description
SqlServerConnectorConfig(Configuration config)

Method Summary

Modifier and Type	Method	Description
static org.apache.kafka.common.config.ConfigDef	configDef()
String	getConnectorName()
String	getContextName()
List<String>	getDatabaseNames()
protected HistoryRecordComparator	getHistoryRecordComparator()
String	getInstanceName()
int	getMaxTransactionsPerIteration()
boolean	getOptionRecompile()
SqlServerConnectorConfig.SnapshotIsolationMode	getSnapshotIsolationMode()
SqlServerConnectorConfig.SnapshotMode	getSnapshotMode()
protected SourceInfoStructMaker<? extends AbstractSourceInfo>	getSourceInfoStructMaker(CommonConnectorConfig.Version version)
SourceTimestampMode	getSourceTimestampMode()
boolean	isMultiPartitionModeEnabled()
boolean	isReadOnlyDatabaseConnection()
boolean	supportsOperationFiltering()
protected boolean	supportsSchemaChangesDuringIncrementalSnapshot()
private static int	validateDatabaseName(Configuration config, Field field, Field.ValidationOutput problems)
private static int	validateDatabaseNames(Configuration config, Field field, Field.ValidationOutput problems)

Methods inherited from class io.debezium.relational.HistorizedRelationalDatabaseConnectorConfig

getDatabaseHistory, useCatalogBeforeSchema

Methods inherited from class io.debezium.relational.RelationalDatabaseConnectorConfig

getColumnFilter, getDecimalMode, getHeartbeatActionQuery, getJdbcConfig, getKeyMapper, getSnapshotSelectOverridesByTable, getTableFilters, getTableIdMapper, getTemporalPrecisionMode, getUnavailableValuePlaceholder, 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, getSkippedOperations, getSnapshotDelay, getSnapshotFetchSize, getSnapshotMaxThreads, getSourceInfoStructMaker, getTaskId, getTransactionTopic, isEmitTombstoneOnDelete, isIncrementalSnapshotSchemaChangesEnabled, isSignalDataCollection, legacyGetDataCollectionsToBeSnapshotted, parseSignallingMessage, schemaNameAdjustmentMode, shouldProvideTransactionMetadata, 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

SOURCE_TIMESTAMP_MODE_CONFIG_NAME

public static final String SOURCE_TIMESTAMP_MODE_CONFIG_NAME

See Also:

• Constant Field Values

MAX_TRANSACTIONS_PER_ITERATION_CONFIG_NAME

public static final String MAX_TRANSACTIONS_PER_ITERATION_CONFIG_NAME

See Also:

• Constant Field Values

DEFAULT_PORT

protected static final int DEFAULT_PORT

See Also:

• Constant Field Values

DEFAULT_MAX_TRANSACTIONS_PER_ITERATION

protected static final int DEFAULT_MAX_TRANSACTIONS_PER_ITERATION

See Also:

• Constant Field Values

READ_ONLY_INTENT

private static final String READ_ONLY_INTENT

See Also:

• Constant Field Values

APPLICATION_INTENT_KEY

private static final String APPLICATION_INTENT_KEY

See Also:

• Constant Field Values

USER

public static final Field USER

PORT

public static final Field PORT

SERVER_NAME

public static final Field SERVER_NAME

INSTANCE

public static final Field INSTANCE

DATABASE_NAME

public static final Field DATABASE_NAME

DATABASE_NAMES

public static final Field DATABASE_NAMES

SERVER_TIMEZONE

@Deprecated
public static final Field SERVER_TIMEZONE

Deprecated.

The connector will determine the database server timezone offset automatically.

MAX_LSN_OPTIMIZATION

public static final Field MAX_LSN_OPTIMIZATION

MAX_TRANSACTIONS_PER_ITERATION

public static final Field MAX_TRANSACTIONS_PER_ITERATION

SOURCE_TIMESTAMP_MODE

public static final Field SOURCE_TIMESTAMP_MODE

SNAPSHOT_MODE

public static final Field SNAPSHOT_MODE

SNAPSHOT_ISOLATION_MODE

public static final Field SNAPSHOT_ISOLATION_MODE

INCREMENTAL_SNAPSHOT_OPTION_RECOMPILE

public static final Field INCREMENTAL_SNAPSHOT_OPTION_RECOMPILE

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.

databaseNames

private final List<String> databaseNames

instanceName

private final String instanceName

snapshotMode

private final SqlServerConnectorConfig.SnapshotMode snapshotMode

snapshotIsolationMode

private final SqlServerConnectorConfig.SnapshotIsolationMode snapshotIsolationMode

sourceTimestampMode

private final SourceTimestampMode sourceTimestampMode

readOnlyDatabaseConnection

private final boolean readOnlyDatabaseConnection

maxTransactionsPerIteration

private final int maxTransactionsPerIteration

multiPartitionMode

private final boolean multiPartitionMode

optionRecompile

private final boolean optionRecompile

Constructor Details

SqlServerConnectorConfig

public SqlServerConnectorConfig(Configuration config)

Method Details

configDef

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

getDatabaseNames

public List<String> getDatabaseNames()

getInstanceName

public String getInstanceName()

isMultiPartitionModeEnabled

public boolean isMultiPartitionModeEnabled()

getSnapshotIsolationMode

public SqlServerConnectorConfig.SnapshotIsolationMode getSnapshotIsolationMode()

getSnapshotMode

public SqlServerConnectorConfig.SnapshotMode getSnapshotMode()

getSourceTimestampMode

public SourceTimestampMode getSourceTimestampMode()

isReadOnlyDatabaseConnection

public boolean isReadOnlyDatabaseConnection()

getMaxTransactionsPerIteration

public int getMaxTransactionsPerIteration()

getOptionRecompile

public boolean getOptionRecompile()

supportsOperationFiltering

public boolean supportsOperationFiltering()

Overrides:

supportsOperationFiltering in class CommonConnectorConfig

supportsSchemaChangesDuringIncrementalSnapshot

protected boolean supportsSchemaChangesDuringIncrementalSnapshot()

Overrides:

supportsSchemaChangesDuringIncrementalSnapshot in class CommonConnectorConfig

getSourceInfoStructMaker

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

Specified by:

getSourceInfoStructMaker in class CommonConnectorConfig

getHistoryRecordComparator

protected HistoryRecordComparator getHistoryRecordComparator()

Specified by:

getHistoryRecordComparator in class HistorizedRelationalDatabaseConnectorConfig

getContextName

public String getContextName()

Specified by:

getContextName in class CommonConnectorConfig

getConnectorName

public String getConnectorName()

Specified by:

getConnectorName in class CommonConnectorConfig

validateDatabaseName

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

validateDatabaseNames

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