Package io.debezium.connector.sqlserver

Class SqlServerConnection

java.lang.Object

io.debezium.jdbc.JdbcConnection

io.debezium.connector.sqlserver.SqlServerConnection

All Implemented Interfaces:

AutoCloseable

public class SqlServerConnection
extends JdbcConnection

JdbcConnection extension to be used with Microsoft SQL Server

Author:

Horia Chiorean (hchiorea@redhat.com), Jiri Pechanec

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SqlServerConnection.CdcEnabledTable

Nested classes/interfaces inherited from class io.debezium.jdbc.JdbcConnection

JdbcConnection.BlockingMultiResultSetConsumer, JdbcConnection.BlockingResultSetConsumer, JdbcConnection.CallPreparer, JdbcConnection.ConnectionFactory, JdbcConnection.LogPositionValidator, JdbcConnection.MultiResultSetConsumer, JdbcConnection.Operations, JdbcConnection.ParameterResultSetConsumer, JdbcConnection.ResultSetConsumer, JdbcConnection.ResultSetExtractor<T extends Object>, JdbcConnection.ResultSetMapper<T extends Object>, JdbcConnection.StatementFactory, JdbcConnection.StatementPreparer

Field Summary

Fields

Modifier and Type	Field	Description
private static final Field	AGENT_STATUS_QUERY
private static final String	CLOSING_QUOTING_CHARACTER
private final SqlServerConnectorConfig	config
private static final String	DATABASE_NAME_PLACEHOLDER
private final SqlServerDefaultValueConverter	defaultValueConverter
private static final String	GET_ALL_CHANGES_FOR_TABLE_FROM_DIRECT
private static final String	GET_ALL_CHANGES_FOR_TABLE_FROM_FUNCTION
private static final String	GET_ALL_CHANGES_FOR_TABLE_ORDER_BY
private static final String	GET_ALL_CHANGES_FOR_TABLE_SELECT
private static final String	GET_CAPTURED_COLUMNS	Queries the list of captured column names and their change table identifiers in the given database.
private static final String	GET_CHANGE_TABLES	Queries the list of capture instances in the given database.
private static final String	GET_DATABASE_NAME
private static final String	GET_MAX_LSN
private static final String	GET_MAX_TRANSACTION_LSN
private static final String	GET_MIN_LSN
private static final String	GET_NEW_CHANGE_TABLES
private static final String	GET_NTH_TRANSACTION_LSN_FROM_BEGINNING
private static final String	GET_NTH_TRANSACTION_LSN_FROM_LAST
private final String	getAllChangesForTable
private static final String	INCREMENT_LSN
static final String	INSTANCE_NAME
private static final String	LOCK_TABLE
private static final org.slf4j.Logger	LOGGER
protected static final String	LSN_TIMESTAMP_SELECT_STATEMENT
private static final String	OPENING_QUOTING_CHARACTER
private boolean	optionRecompile
private final int	queryFetchSize
private static final String	STATEMENTS_PLACEHOLDER
private static final String	URL_PATTERN
private final boolean	useSingleDatabase

Fields inherited from class io.debezium.jdbc.JdbcConnection

logPositionValidator

Constructor Summary

Constructors

Constructor	Description
SqlServerConnection(SqlServerConnectorConfig config, SqlServerValueConverters valueConverters, Set<Envelope.Operation> skippedOperations, boolean useSingleDatabase)	Creates a new connection using the supplied configuration.
SqlServerConnection(SqlServerConnectorConfig config, SqlServerValueConverters valueConverters, Set<Envelope.Operation> skippedOperations, boolean useSingleDatabase, boolean optionRecompile)	Creates a new connection using the supplied configuration.

Method Summary

Modifier and Type	Method	Description
private String	buildGetAllChangesForTableQuery(SqlServerConnectorConfig.DataQueryMode dataQueryMode, Set<Envelope.Operation> skippedOperations)
String	buildSelectWithRowLimits(TableId tableId, int limit, String projection, Optional<String> condition, Optional<String> additionalCondition, String orderBy)
private String	cdcNameForTable(TableId tableId)
boolean	checkIfConnectedUserHasAccessToCDCTable(String databaseName)	Check if the user with which connection object is created has access to CDC table.
Connection	connection(boolean executeOnConnect)
String	connectionString()	Returns a JDBC connection string for the current configuration.
private static JdbcConnection.ConnectionFactory	createConnectionFactory(SqlServerJdbcConfiguration config, boolean useSingleDatabase)
protected static String	createUrlPattern(SqlServerJdbcConfiguration config, boolean useSingleDatabase)
void	getChangesForTables(String databaseName, SqlServerChangeTable[] changeTables, Lsn intervalFromLsn, Lsn intervalToLsn, JdbcConnection.BlockingMultiResultSetConsumer consumer)	Provides all changes recorder by the SQL Server CDC capture process for a set of tables.
List<SqlServerChangeTable>	getChangeTables(String databaseName)
List<SqlServerChangeTable>	getChangeTables(String databaseName, Lsn toLsn)
Object	getColumnValue(ResultSet rs, int columnIndex, Column column, Table table)
Optional<Instant>	getCurrentTimestamp()
SqlServerDefaultValueConverter	getDefaultValueConverter()
private Lsn	getFromLsn(String databaseName, SqlServerChangeTable changeTable, Lsn intervalFromLsn)
Lsn	getMaxLsn(String databaseName)
Lsn	getMaxTransactionLsn(String databaseName)
Lsn	getMinLsn(String databaseName, String changeTableName)
String	getNameOfChangeTable(String captureName)
List<SqlServerChangeTable>	getNewChangeTables(String databaseName, Lsn fromLsn, Lsn toLsn)
Lsn	getNthTransactionLsnFromBeginning(String databaseName, int maxOffset)
Lsn	getNthTransactionLsnFromLast(String databaseName, Lsn lastLsn, int maxOffset)
Table	getTableSchemaFromTable(String databaseName, SqlServerChangeTable changeTable)
private boolean	hasSkippedOperations(Set<Envelope.Operation> skippedOperations)
Lsn	incrementLsn(String databaseName, Lsn lsn)	Obtain the next available position in the database log.
boolean	isAgentRunning(String databaseName)
protected boolean	isTableUniqueIndexIncluded(String indexName, String columnName)
void	lockTable(TableId tableId)	Creates an exclusive lock for a given table.
Optional<Boolean>	nullsSortLast()
String	quotedTableIdString(TableId tableId)
private String	replaceDatabaseNamePlaceholder(String sql, String databaseName)
String	retrieveRealDatabaseName(String databaseName)	Retrieve the name of the database in the original case as it's defined on the server.
<T> T	singleOptionalValue(String query, JdbcConnection.ResultSetExtractor<T> extractor)
boolean	validateLogPosition(OffsetContext offset, CommonConnectorConfig config)

Methods inherited from class io.debezium.jdbc.JdbcConnection

call, chunkQueryBuilder, close, commit, config, connect, connection, connectionString, createTableId, database, escapeEscapeSequence, execute, execute, executeWithoutCommitting, getAttributeDetails, getColumnsDetails, getQualifiedTableName, isConnected, isLogPositionAvailable, isNullable, isTableType, isValid, loadKeyStore, overrideColumn, parseSqlStatementString, patternBasedFactory, patternBasedFactory, prepareQuery, prepareQuery, prepareQuery, prepareQuery, prepareQuery, prepareQueryAndMap, prepareQueryWithBlockingConsumer, prepareUpdate, print, print, query, query, queryAndMap, queryAndMap, querySingleValue, queryWithBlockingConsumer, quotedColumnIdString, readAllCatalogNames, readAllSchemaNames, readAllTableNames, readPrimaryKeyNames, readPrimaryKeyOrUniqueIndexNames, readSchema, readTableColumn, readTableNames, readTablePreparedStatement, readTableStatement, readTableUniqueIndices, reselectColumns, reselectColumns, resolveCatalogName, resolveJdbcType, resolveNativeType, rollback, rowToArray, setAutoCommit, setQueryColumnValue, singleResultMapper, supportedTableTypes, tableTypes, username

Methods inherited from class java.lang.Object

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

Field Details

INSTANCE_NAME

public static final String INSTANCE_NAME

See Also:

• Constant Field Values

GET_DATABASE_NAME

private static final String GET_DATABASE_NAME

See Also:

• Constant Field Values

LOGGER

private static final org.slf4j.Logger LOGGER

STATEMENTS_PLACEHOLDER

private static final String STATEMENTS_PLACEHOLDER

See Also:

• Constant Field Values

DATABASE_NAME_PLACEHOLDER

private static final String DATABASE_NAME_PLACEHOLDER

See Also:

• Constant Field Values

GET_MAX_LSN

private static final String GET_MAX_LSN

See Also:

• Constant Field Values

GET_MAX_TRANSACTION_LSN

private static final String GET_MAX_TRANSACTION_LSN

See Also:

• Constant Field Values

GET_NTH_TRANSACTION_LSN_FROM_BEGINNING

private static final String GET_NTH_TRANSACTION_LSN_FROM_BEGINNING

See Also:

• Constant Field Values

GET_NTH_TRANSACTION_LSN_FROM_LAST

private static final String GET_NTH_TRANSACTION_LSN_FROM_LAST

See Also:

• Constant Field Values

GET_MIN_LSN

private static final String GET_MIN_LSN

See Also:

• Constant Field Values

LOCK_TABLE

private static final String LOCK_TABLE

See Also:

• Constant Field Values

INCREMENT_LSN

private static final String INCREMENT_LSN

See Also:

• Constant Field Values

LSN_TIMESTAMP_SELECT_STATEMENT

protected static final String LSN_TIMESTAMP_SELECT_STATEMENT

See Also:

• Constant Field Values

GET_ALL_CHANGES_FOR_TABLE_SELECT

private static final String GET_ALL_CHANGES_FOR_TABLE_SELECT

See Also:

• Constant Field Values

GET_ALL_CHANGES_FOR_TABLE_FROM_FUNCTION

private static final String GET_ALL_CHANGES_FOR_TABLE_FROM_FUNCTION

See Also:

• Constant Field Values

GET_ALL_CHANGES_FOR_TABLE_FROM_DIRECT

private static final String GET_ALL_CHANGES_FOR_TABLE_FROM_DIRECT

See Also:

• Constant Field Values

GET_ALL_CHANGES_FOR_TABLE_ORDER_BY

private static final String GET_ALL_CHANGES_FOR_TABLE_ORDER_BY

See Also:

• Constant Field Values

GET_CAPTURED_COLUMNS

private static final String GET_CAPTURED_COLUMNS

Queries the list of captured column names and their change table identifiers in the given database.

See Also:

• Constant Field Values

GET_CHANGE_TABLES

private static final String GET_CHANGE_TABLES

Queries the list of capture instances in the given database. If two or more capture instances with the same start LSN are available for a given source table, only the newest one will be returned. We use a query instead of sys.sp_cdc_help_change_data_capture because: 1. The stored procedure doesn't allow filtering capture instances by start LSN. 2. There is no way to use the result returned by a stored procedure in a query.

See Also:

• Constant Field Values

GET_NEW_CHANGE_TABLES

private static final String GET_NEW_CHANGE_TABLES

See Also:

• Constant Field Values

OPENING_QUOTING_CHARACTER

private static final String OPENING_QUOTING_CHARACTER

See Also:

• Constant Field Values

CLOSING_QUOTING_CHARACTER

private static final String CLOSING_QUOTING_CHARACTER

See Also:

• Constant Field Values

URL_PATTERN

private static final String URL_PATTERN

config

private final SqlServerConnectorConfig config

useSingleDatabase

private final boolean useSingleDatabase

getAllChangesForTable

private final String getAllChangesForTable

queryFetchSize

private final int queryFetchSize

defaultValueConverter

private final SqlServerDefaultValueConverter defaultValueConverter

optionRecompile

private boolean optionRecompile

AGENT_STATUS_QUERY

private static final Field AGENT_STATUS_QUERY

Constructor Details

SqlServerConnection

public SqlServerConnection(SqlServerConnectorConfig config,
 SqlServerValueConverters valueConverters,
 Set<Envelope.Operation> skippedOperations,
 boolean useSingleDatabase)

Creates a new connection using the supplied configuration.

Parameters:

config - Configuration instance, may not be null.

valueConverters - SqlServerValueConverters instance

skippedOperations - a set of Envelope.Operation to skip in streaming

SqlServerConnection

public SqlServerConnection(SqlServerConnectorConfig config,
 SqlServerValueConverters valueConverters,
 Set<Envelope.Operation> skippedOperations,
 boolean useSingleDatabase,
 boolean optionRecompile)

Creates a new connection using the supplied configuration.

Parameters:

config - Configuration instance, may not be null.

valueConverters - SqlServerValueConverters instance

skippedOperations - a set of Envelope.Operation to skip in streaming

optionRecompile - Includes query option RECOMPILE on incremental snapshots

Method Details

buildGetAllChangesForTableQuery

private String buildGetAllChangesForTableQuery(SqlServerConnectorConfig.DataQueryMode dataQueryMode,
 Set<Envelope.Operation> skippedOperations)

hasSkippedOperations

private boolean hasSkippedOperations(Set<Envelope.Operation> skippedOperations)

createConnectionFactory

private static JdbcConnection.ConnectionFactory createConnectionFactory(SqlServerJdbcConfiguration config,
 boolean useSingleDatabase)

createUrlPattern

@VisibleForTesting
protected static String createUrlPattern(SqlServerJdbcConfiguration config,
 boolean useSingleDatabase)

connectionString

public String connectionString()

Returns a JDBC connection string for the current configuration.

Returns:

a String where the variables in urlPattern are replaced with values from the configuration

connection

public Connection connection(boolean executeOnConnect)
                      throws SQLException

Overrides:

connection in class JdbcConnection

Throws:

SQLException

getMaxLsn

public Lsn getMaxLsn(String databaseName)
              throws SQLException

Returns:

the current largest log sequence number

Throws:

SQLException

getNthTransactionLsnFromBeginning

public Lsn getNthTransactionLsnFromBeginning(String databaseName,
 int maxOffset)
                                      throws SQLException

Returns:

the log sequence number of the most recent transaction that isn't further than maxOffset from the beginning.

Throws:

SQLException

getNthTransactionLsnFromLast

public Lsn getNthTransactionLsnFromLast(String databaseName,
 Lsn lastLsn,
 int maxOffset)
                                 throws SQLException

Returns:

the log sequence number of the most recent transaction that isn't further than maxOffset from lastLsn.

Throws:

SQLException

getMaxTransactionLsn

public Lsn getMaxTransactionLsn(String databaseName)
                         throws SQLException

Returns:

the log sequence number of the most recent transaction.

Throws:

SQLException

getMinLsn

public Lsn getMinLsn(String databaseName,
 String changeTableName)
              throws SQLException

Returns:

the smallest log sequence number of table

Throws:

SQLException

getChangesForTables

public void getChangesForTables(String databaseName,
 SqlServerChangeTable[] changeTables,
 Lsn intervalFromLsn,
 Lsn intervalToLsn,
 JdbcConnection.BlockingMultiResultSetConsumer consumer)
                         throws SQLException,
InterruptedException

Provides all changes recorder by the SQL Server CDC capture process for a set of tables.

Parameters:

databaseName - - the name of the database to query

changeTables - - the requested tables to obtain changes for

intervalFromLsn - - closed lower bound of interval of changes to be provided

intervalToLsn - - closed upper bound of interval of changes to be provided

consumer - - the change processor

Throws:

SQLException

InterruptedException

getFromLsn

private Lsn getFromLsn(String databaseName,
 SqlServerChangeTable changeTable,
 Lsn intervalFromLsn)
                throws SQLException

Throws:

SQLException

incrementLsn

public Lsn incrementLsn(String databaseName,
 Lsn lsn)
                 throws SQLException

Obtain the next available position in the database log.

Parameters:

databaseName - - the name of the database that the LSN belongs to

lsn - - LSN of the current position

Returns:

LSN of the next position in the database

Throws:

SQLException

checkIfConnectedUserHasAccessToCDCTable

public boolean checkIfConnectedUserHasAccessToCDCTable(String databaseName)
                                                throws SQLException

Check if the user with which connection object is created has access to CDC table.

Returns:

boolean indicating the presence/absence of access

Throws:

SQLException

lockTable

public void lockTable(TableId tableId)
               throws SQLException

Creates an exclusive lock for a given table.

Parameters:

tableId - to be locked

Throws:

SQLException

cdcNameForTable

private String cdcNameForTable(TableId tableId)

getChangeTables

public List<SqlServerChangeTable> getChangeTables(String databaseName)
                                           throws SQLException

Throws:

SQLException

getChangeTables

public List<SqlServerChangeTable> getChangeTables(String databaseName,
 Lsn toLsn)
                                           throws SQLException

Throws:

SQLException

getNewChangeTables

public List<SqlServerChangeTable> getNewChangeTables(String databaseName,
 Lsn fromLsn,
 Lsn toLsn)
                                              throws SQLException

Throws:

SQLException

getTableSchemaFromTable

public Table getTableSchemaFromTable(String databaseName,
 SqlServerChangeTable changeTable)
                              throws SQLException

Throws:

SQLException

getNameOfChangeTable

public String getNameOfChangeTable(String captureName)

retrieveRealDatabaseName

public String retrieveRealDatabaseName(String databaseName)

Retrieve the name of the database in the original case as it's defined on the server. Although SQL Server supports case-insensitive collations, the connector uses the database name to build the produced records' source info and, subsequently, the keys of its committed offset messages. This value must remain the same during the lifetime of the connector regardless of the case used in the connector configuration.

isTableUniqueIndexIncluded

protected boolean isTableUniqueIndexIncluded(String indexName,
 String columnName)

Overrides:

isTableUniqueIndexIncluded in class JdbcConnection

getColumnValue

public Object getColumnValue(ResultSet rs,
 int columnIndex,
 Column column,
 Table table)
                      throws SQLException

Overrides:

getColumnValue in class JdbcConnection

Throws:

SQLException

buildSelectWithRowLimits

public String buildSelectWithRowLimits(TableId tableId,
 int limit,
 String projection,
 Optional<String> condition,
 Optional<String> additionalCondition,
 String orderBy)

Overrides:

buildSelectWithRowLimits in class JdbcConnection

nullsSortLast

public Optional<Boolean> nullsSortLast()

Overrides:

nullsSortLast in class JdbcConnection

quotedTableIdString

public String quotedTableIdString(TableId tableId)

Overrides:

quotedTableIdString in class JdbcConnection

replaceDatabaseNamePlaceholder

private String replaceDatabaseNamePlaceholder(String sql,
 String databaseName)

getDefaultValueConverter

public SqlServerDefaultValueConverter getDefaultValueConverter()

isAgentRunning

public boolean isAgentRunning(String databaseName)
                       throws SQLException

Throws:

SQLException

getCurrentTimestamp

public Optional<Instant> getCurrentTimestamp()
                                      throws SQLException

Overrides:

getCurrentTimestamp in class JdbcConnection

Throws:

SQLException

validateLogPosition

public boolean validateLogPosition(OffsetContext offset,
 CommonConnectorConfig config)

singleOptionalValue

public <T> T singleOptionalValue(String query,
 JdbcConnection.ResultSetExtractor<T> extractor)
                          throws SQLException

Throws:

SQLException