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 and Description
static class	SqlServerConnectorConfig.SnapshotIsolationMode The set of predefined snapshot isolation mode options.
static class	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.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.
private static String	APPLICATION_INTENT_KEY
private Tables.ColumnNameFilter	columnFilter
private static ConfigDefinition	CONFIG_DEFINITION
private String	databaseName
protected static int	DEFAULT_PORT
static Field	INSTANCE
private String	instanceName
private static org.slf4j.Logger	LOGGER
static Field	MAX_LSN_OPTIMIZATION
static Field	PORT
private static String	READ_ONLY_INTENT
private boolean	readOnlyDatabaseConnection
static Field	SERVER_NAME
static Field	SERVER_TIMEZONE
private boolean	skipLowActivityLsnsEnabled
static Field	SNAPSHOT_ISOLATION_MODE
static Field	SNAPSHOT_MODE
private SqlServerConnectorConfig.SnapshotIsolationMode	snapshotIsolationMode
private SqlServerConnectorConfig.SnapshotMode	snapshotMode
static Field	SOURCE_TIMESTAMP_MODE
static String	SOURCE_TIMESTAMP_MODE_CONFIG_NAME
private SourceTimestampMode	sourceTimestampMode

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, DATABASE_NAME, DECIMAL_HANDLING_MODE, DEFAULT_SNAPSHOT_LOCK_TIMEOUT_MILLIS, HOSTNAME, INCLUDE_SCHEMA_CHANGES, 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, 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_NAME, TIME_PRECISION_MODE, TRUNCATE_COLUMN, USER

Fields inherited from class io.debezium.config.CommonConnectorConfig

BINARY_HANDLING_MODE, CUSTOM_CONVERTERS, 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, 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, SKIPPED_OPERATIONS, SNAPSHOT_DELAY_MS, SNAPSHOT_FETCH_SIZE, SNAPSHOT_MAX_THREADS, SNAPSHOT_MODE_TABLES, SOURCE_STRUCT_MAKER_VERSION, TOMBSTONES_ON_DELETE

Constructor Summary

Constructors

Constructor and Description
SqlServerConnectorConfig(Configuration config)

Method Summary

Modifier and Type	Method and Description
static org.apache.kafka.common.config.ConfigDef	configDef()
private static Tables.ColumnNameFilter	getColumnExcludeNameFilter(String excludedColumnPatterns)
Tables.ColumnNameFilter	getColumnFilter()
private static Tables.ColumnNameFilter	getColumnIncludeNameFilter(String excludedColumnPatterns)
String	getConnectorName()
String	getContextName()
String	getDatabaseName()
protected HistoryRecordComparator	getHistoryRecordComparator()
String	getInstanceName()
SqlServerConnectorConfig.SnapshotIsolationMode	getSnapshotIsolationMode()
SqlServerConnectorConfig.SnapshotMode	getSnapshotMode()
protected SourceInfoStructMaker<? extends AbstractSourceInfo>	getSourceInfoStructMaker(CommonConnectorConfig.Version version)
SourceTimestampMode	getSourceTimestampMode()
boolean	isReadOnlyDatabaseConnection()
boolean	isSkipLowActivityLsnsEnabled()
Configuration	jdbcConfig()

Methods inherited from class io.debezium.relational.HistorizedRelationalDatabaseConnectorConfig

getDatabaseHistory

Methods inherited from class io.debezium.relational.RelationalDatabaseConnectorConfig

columnExcludeList, columnIncludeList, getDecimalMode, getKeyMapper, getSnapshotSelectOverridesByTable, getTableFilters, getTableIdMapper, getTemporalPrecisionMode, isSchemaChangesHistoryEnabled, schemaExcludeList, schemaIncludeList, snapshotLockTimeout, tableExcludeList, tableIncludeList

Methods inherited from class io.debezium.config.CommonConnectorConfig

binaryHandlingMode, customConverterRegistry, getConfig, getDataCollectionsToBeSnapshotted, getEventProcessingFailureHandlingMode, getHeartbeatTopicsPrefix, getLogicalName, getMaxBatchSize, getMaxQueueSize, getMaxQueueSizeInBytes, getPollInterval, getQueryFetchSize, getRetriableRestartWait, getSanitizeFieldNames, getSkippedOps, getSnapshotDelay, getSnapshotFetchSize, getSnapshotMaxThreads, getSourceInfoStructMaker, isEmitTombstoneOnDelete, shouldProvideTransactionMetadata, validate, validateAndRecord, validateServerNameIsDifferentFromHistoryTopicName

Methods inherited from class java.lang.Object

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

Field Detail

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

DEFAULT_PORT

protected static final int DEFAULT_PORT

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

PORT

public static final Field PORT

SERVER_NAME

public static final Field SERVER_NAME

INSTANCE

public static final Field INSTANCE

SERVER_TIMEZONE

public static final Field SERVER_TIMEZONE

MAX_LSN_OPTIMIZATION

public static final Field MAX_LSN_OPTIMIZATION

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

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.

databaseName

private final String databaseName

instanceName

private final String instanceName

snapshotMode

private final SqlServerConnectorConfig.SnapshotMode snapshotMode

snapshotIsolationMode

private final SqlServerConnectorConfig.SnapshotIsolationMode snapshotIsolationMode

sourceTimestampMode

private final SourceTimestampMode sourceTimestampMode

columnFilter

private final Tables.ColumnNameFilter columnFilter

readOnlyDatabaseConnection

private final boolean readOnlyDatabaseConnection

skipLowActivityLsnsEnabled

private final boolean skipLowActivityLsnsEnabled

Constructor Detail

SqlServerConnectorConfig

public SqlServerConnectorConfig(Configuration config)

Method Detail

configDef

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

getColumnExcludeNameFilter

private static Tables.ColumnNameFilter getColumnExcludeNameFilter(String excludedColumnPatterns)

getColumnIncludeNameFilter

private static Tables.ColumnNameFilter getColumnIncludeNameFilter(String excludedColumnPatterns)

jdbcConfig

public Configuration jdbcConfig()

getDatabaseName

public String getDatabaseName()

getInstanceName

public String getInstanceName()

getSnapshotIsolationMode

public SqlServerConnectorConfig.SnapshotIsolationMode getSnapshotIsolationMode()

getSnapshotMode

public SqlServerConnectorConfig.SnapshotMode getSnapshotMode()

getSourceTimestampMode

public SourceTimestampMode getSourceTimestampMode()

getColumnFilter

public Tables.ColumnNameFilter getColumnFilter()

isReadOnlyDatabaseConnection

public boolean isReadOnlyDatabaseConnection()

isSkipLowActivityLsnsEnabled

public boolean isSkipLowActivityLsnsEnabled()

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