Package io.debezium.connector.sqlserver

Class SqlServerSnapshotChangeEventSource

java.lang.Object

io.debezium.pipeline.source.AbstractSnapshotChangeEventSource<P,O>

io.debezium.relational.RelationalSnapshotChangeEventSource<SqlServerPartition,SqlServerOffsetContext>

io.debezium.connector.sqlserver.SqlServerSnapshotChangeEventSource

All Implemented Interfaces:

ChangeEventSource, SnapshotChangeEventSource<SqlServerPartition,SqlServerOffsetContext>, AutoCloseable

public class SqlServerSnapshotChangeEventSource
extends RelationalSnapshotChangeEventSource<SqlServerPartition,SqlServerOffsetContext>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	SqlServerSnapshotChangeEventSource.SqlServerSnapshotContext	Mutable context which is populated in the course of snapshotting.

Nested classes/interfaces inherited from class io.debezium.relational.RelationalSnapshotChangeEventSource

RelationalSnapshotChangeEventSource.RelationalSnapshotContext<P extends Partition,O extends OffsetContext>

Nested classes/interfaces inherited from class io.debezium.pipeline.source.AbstractSnapshotChangeEventSource

AbstractSnapshotChangeEventSource.SnapshotContext<P extends Partition,O extends OffsetContext>

Nested classes/interfaces inherited from interface io.debezium.pipeline.source.spi.ChangeEventSource

ChangeEventSource.ChangeEventSourceContext

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<SqlServerPartition,Map<TableId,SqlServerChangeTable>>	changeTablesByPartition
private final SqlServerConnectorConfig	connectorConfig
private final SqlServerConnection	jdbcConnection
private static final org.slf4j.Logger	LOGGER
private final SqlServerDatabaseSchema	sqlServerDatabaseSchema
private static final int	TRANSACTION_SNAPSHOT	Code 4096 corresponds to SNAPSHOT isolation level, which is not a part of the standard but SQL Server specific.

Fields inherited from class io.debezium.relational.RelationalSnapshotChangeEventSource

clock, connectionPool, dispatcher, MATCH_ALL_PATTERN, SELECT_ALL_PATTERN, snapshotterService

Fields inherited from class io.debezium.pipeline.source.AbstractSnapshotChangeEventSource

LOG_INTERVAL, notificationService

Constructor Summary

Constructors

Constructor

Description

SqlServerSnapshotChangeEventSource(SqlServerConnectorConfig connectorConfig, MainConnectionProvidingConnectionFactory<SqlServerConnection> connectionFactory, SqlServerDatabaseSchema schema, EventDispatcher<SqlServerPartition,TableId> dispatcher, Clock clock, SnapshotProgressListener<SqlServerPartition> snapshotProgressListener, NotificationService<SqlServerPartition,SqlServerOffsetContext> notificationService, SnapshotterService snapshotterService)

Method Summary

Modifier and Type	Method	Description
protected void	aborted(AbstractSnapshotChangeEventSource.SnapshotContext<SqlServerPartition,SqlServerOffsetContext> snapshotContext)
protected boolean	additionalColumnFilter(SqlServerPartition partition, TableId tableId, String columnName)
private void	close(AbstractSnapshotChangeEventSource.SnapshotContext<SqlServerPartition,SqlServerOffsetContext> snapshotContext)
protected void	completed(AbstractSnapshotChangeEventSource.SnapshotContext<SqlServerPartition,SqlServerOffsetContext> snapshotContext)
protected void	connectionCreated(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<SqlServerPartition,SqlServerOffsetContext> snapshotContext)
protected SqlServerOffsetContext	copyOffset(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<SqlServerPartition,SqlServerOffsetContext> snapshotContext)
protected void	determineSnapshotOffset(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<SqlServerPartition,SqlServerOffsetContext> ctx, SqlServerOffsetContext previousOffset)
protected String	enhanceOverriddenSelect(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<SqlServerPartition,SqlServerOffsetContext> snapshotContext, String overriddenSelect, TableId tableId)
private boolean	filterChangeTableColumns(SqlServerPartition partition, TableId tableId, String columnName)
protected Set<TableId>	getAllTableIds(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<SqlServerPartition,SqlServerOffsetContext> ctx)
protected SchemaChangeEvent	getCreateTableEvent(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<SqlServerPartition,SqlServerOffsetContext> snapshotContext, Table table)
protected Optional<String>	getSnapshotSelect(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<SqlServerPartition,SqlServerOffsetContext> snapshotContext, TableId tableId, List<String> columns)	Generate a valid SQL Server query string for the specified table
protected Collection<TableId>	getTablesForSchemaChange(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<SqlServerPartition,SqlServerOffsetContext> snapshotContext)
protected void	lockTablesForSchemaSnapshot(ChangeEventSource.ChangeEventSourceContext sourceContext, RelationalSnapshotChangeEventSource.RelationalSnapshotContext<SqlServerPartition,SqlServerOffsetContext> snapshotContext)
protected AbstractSnapshotChangeEventSource.SnapshotContext<SqlServerPartition,SqlServerOffsetContext>	prepare(SqlServerPartition partition, boolean onDemand)
private String	quoteTableName(TableId tableId)
protected void	readTableStructure(ChangeEventSource.ChangeEventSourceContext sourceContext, RelationalSnapshotChangeEventSource.RelationalSnapshotContext<SqlServerPartition,SqlServerOffsetContext> snapshotContext, SqlServerOffsetContext offsetContext, SnapshottingTask snapshottingTask)
protected void	releaseSchemaSnapshotLocks(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<SqlServerPartition,SqlServerOffsetContext> snapshotContext)

Methods inherited from class io.debezium.relational.RelationalSnapshotChangeEventSource

connectionPoolConnectionCreated, createDataEventsForTableCallable, createSchemaChangeEventsForTables, createSnapshotConnection, doCreateDataEventsForTable, doExecute, getBlockingSnapshottingTask, getChangeRecordEmitter, getClock, getPreparedColumnNames, getSignalDataCollectionPattern, getSnapshotConnectionFirstSelect, getSnapshotSelectOverridesByTable, getSnapshotSourceTimestamp, getSnapshottingTask, lastSnapshotRecord, postSnapshot, preSnapshot, readTableStatement, releaseDataSnapshotLocks, resultSetForDataEvents, rowCountForTable, tryStartingSnapshot

Methods inherited from class io.debezium.pipeline.source.AbstractSnapshotChangeEventSource

close, delaySnapshotIfNeeded, determineDataCollectionsToBeSnapshotted, execute, getDataCollectionPattern, getOffsets

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

TRANSACTION_SNAPSHOT

private static final int TRANSACTION_SNAPSHOT

Code 4096 corresponds to SNAPSHOT isolation level, which is not a part of the standard but SQL Server specific.

See Also:

• Constant Field Values

connectorConfig

private final SqlServerConnectorConfig connectorConfig

jdbcConnection

private final SqlServerConnection jdbcConnection

sqlServerDatabaseSchema

private final SqlServerDatabaseSchema sqlServerDatabaseSchema

changeTablesByPartition

private final Map<SqlServerPartition,Map<TableId,SqlServerChangeTable>> changeTablesByPartition

Constructor Details

SqlServerSnapshotChangeEventSource

public SqlServerSnapshotChangeEventSource(SqlServerConnectorConfig connectorConfig,
 MainConnectionProvidingConnectionFactory<SqlServerConnection> connectionFactory,
 SqlServerDatabaseSchema schema,
 EventDispatcher<SqlServerPartition,TableId> dispatcher,
 Clock clock,
 SnapshotProgressListener<SqlServerPartition> snapshotProgressListener,
 NotificationService<SqlServerPartition,SqlServerOffsetContext> notificationService,
 SnapshotterService snapshotterService)

Method Details

prepare

protected AbstractSnapshotChangeEventSource.SnapshotContext<SqlServerPartition,SqlServerOffsetContext> prepare(SqlServerPartition partition,
 boolean onDemand)

Specified by:

prepare in class AbstractSnapshotChangeEventSource<SqlServerPartition,SqlServerOffsetContext>

connectionCreated

protected void connectionCreated(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<SqlServerPartition,SqlServerOffsetContext> snapshotContext)
                          throws Exception

Overrides:

connectionCreated in class RelationalSnapshotChangeEventSource<SqlServerPartition,SqlServerOffsetContext>

Throws:

Exception

getAllTableIds

protected Set<TableId> getAllTableIds(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<SqlServerPartition,SqlServerOffsetContext> ctx)
                               throws Exception

Specified by:

getAllTableIds in class RelationalSnapshotChangeEventSource<SqlServerPartition,SqlServerOffsetContext>

Throws:

Exception

lockTablesForSchemaSnapshot

protected void lockTablesForSchemaSnapshot(ChangeEventSource.ChangeEventSourceContext sourceContext,
 RelationalSnapshotChangeEventSource.RelationalSnapshotContext<SqlServerPartition,SqlServerOffsetContext> snapshotContext)
                                    throws SQLException,
InterruptedException

Specified by:

lockTablesForSchemaSnapshot in class RelationalSnapshotChangeEventSource<SqlServerPartition,SqlServerOffsetContext>

Throws:

SQLException

InterruptedException

releaseSchemaSnapshotLocks

protected void releaseSchemaSnapshotLocks(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<SqlServerPartition,SqlServerOffsetContext> snapshotContext)
                                   throws SQLException

Specified by:

releaseSchemaSnapshotLocks in class RelationalSnapshotChangeEventSource<SqlServerPartition,SqlServerOffsetContext>

Throws:

SQLException

determineSnapshotOffset

protected void determineSnapshotOffset(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<SqlServerPartition,SqlServerOffsetContext> ctx,
 SqlServerOffsetContext previousOffset)
                                throws Exception

Specified by:

determineSnapshotOffset in class RelationalSnapshotChangeEventSource<SqlServerPartition,SqlServerOffsetContext>

Throws:

Exception

readTableStructure

protected void readTableStructure(ChangeEventSource.ChangeEventSourceContext sourceContext,
 RelationalSnapshotChangeEventSource.RelationalSnapshotContext<SqlServerPartition,SqlServerOffsetContext> snapshotContext,
 SqlServerOffsetContext offsetContext,
 SnapshottingTask snapshottingTask)
                           throws SQLException,
InterruptedException

Specified by:

readTableStructure in class RelationalSnapshotChangeEventSource<SqlServerPartition,SqlServerOffsetContext>

Throws:

SQLException

InterruptedException

getTablesForSchemaChange

protected Collection<TableId> getTablesForSchemaChange(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<SqlServerPartition,SqlServerOffsetContext> snapshotContext)

Overrides:

getTablesForSchemaChange in class RelationalSnapshotChangeEventSource<SqlServerPartition,SqlServerOffsetContext>

getCreateTableEvent

protected SchemaChangeEvent getCreateTableEvent(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<SqlServerPartition,SqlServerOffsetContext> snapshotContext,
 Table table)
                                         throws SQLException

Specified by:

getCreateTableEvent in class RelationalSnapshotChangeEventSource<SqlServerPartition,SqlServerOffsetContext>

Throws:

SQLException

completed

protected void completed(AbstractSnapshotChangeEventSource.SnapshotContext<SqlServerPartition,SqlServerOffsetContext> snapshotContext)

Overrides:

completed in class AbstractSnapshotChangeEventSource<SqlServerPartition,SqlServerOffsetContext>

aborted

protected void aborted(AbstractSnapshotChangeEventSource.SnapshotContext<SqlServerPartition,SqlServerOffsetContext> snapshotContext)

Overrides:

aborted in class AbstractSnapshotChangeEventSource<SqlServerPartition,SqlServerOffsetContext>

close

private void close(AbstractSnapshotChangeEventSource.SnapshotContext<SqlServerPartition,SqlServerOffsetContext> snapshotContext)

getSnapshotSelect

protected Optional<String> getSnapshotSelect(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<SqlServerPartition,SqlServerOffsetContext> snapshotContext,
 TableId tableId,
 List<String> columns)

Generate a valid SQL Server query string for the specified table

Specified by:

getSnapshotSelect in class RelationalSnapshotChangeEventSource<SqlServerPartition,SqlServerOffsetContext>

Parameters:

tableId - the table to generate a query for

Returns:

a valid query string

quoteTableName

private String quoteTableName(TableId tableId)

enhanceOverriddenSelect

protected String enhanceOverriddenSelect(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<SqlServerPartition,SqlServerOffsetContext> snapshotContext,
 String overriddenSelect,
 TableId tableId)

Overrides:

enhanceOverriddenSelect in class RelationalSnapshotChangeEventSource<SqlServerPartition,SqlServerOffsetContext>

additionalColumnFilter

protected boolean additionalColumnFilter(SqlServerPartition partition,
 TableId tableId,
 String columnName)

Overrides:

additionalColumnFilter in class RelationalSnapshotChangeEventSource<SqlServerPartition,SqlServerOffsetContext>

filterChangeTableColumns

private boolean filterChangeTableColumns(SqlServerPartition partition,
 TableId tableId,
 String columnName)

copyOffset

protected SqlServerOffsetContext copyOffset(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<SqlServerPartition,SqlServerOffsetContext> snapshotContext)

Specified by:

copyOffset in class RelationalSnapshotChangeEventSource<SqlServerPartition,SqlServerOffsetContext>