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>

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<O extends OffsetContext>

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

AbstractSnapshotChangeEventSource.SnapshotContext<O extends OffsetContext>, AbstractSnapshotChangeEventSource.SnapshottingTask

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

ChangeEventSource.ChangeEventSourceContext

Field Summary

Fields

Modifier and Type	Field	Description
private Map<TableId,SqlServerChangeTable>	changeTables
private SqlServerConnectorConfig	connectorConfig
private SqlServerConnection	jdbcConnection
private static org.slf4j.Logger	LOGGER
private SqlServerDatabaseSchema	sqlServerDatabaseSchema
private static 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, dispatcher, LOG_INTERVAL

Constructor Summary

Constructors

Constructor	Description
SqlServerSnapshotChangeEventSource(SqlServerConnectorConfig connectorConfig, SqlServerConnection jdbcConnection, SqlServerDatabaseSchema schema, EventDispatcher<TableId> dispatcher, Clock clock, SnapshotProgressListener snapshotProgressListener)

Method Summary

Modifier and Type	Method	Description
private String	checkExcludedColumns(TableId tableId)
protected void	complete(AbstractSnapshotChangeEventSource.SnapshotContext<SqlServerOffsetContext> snapshotContext)
protected void	connectionCreated(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<SqlServerOffsetContext> snapshotContext)
protected void	determineSnapshotOffset(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<SqlServerOffsetContext> ctx, SqlServerOffsetContext previousOffset)
protected String	enhanceOverriddenSelect(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<SqlServerOffsetContext> snapshotContext, String overriddenSelect, TableId tableId)
private boolean	filterChangeTableColumns(TableId tableId, String columnName)
protected Set<TableId>	getAllTableIds(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<SqlServerOffsetContext> ctx)
protected SchemaChangeEvent	getCreateTableEvent(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<SqlServerOffsetContext> snapshotContext, Table table)
protected Optional<String>	getSnapshotSelect(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<SqlServerOffsetContext> snapshotContext, TableId tableId)	Generate a valid sqlserver query string for the specified table
protected AbstractSnapshotChangeEventSource.SnapshottingTask	getSnapshottingTask(SqlServerOffsetContext previousOffset)
protected void	lockTablesForSchemaSnapshot(ChangeEventSource.ChangeEventSourceContext sourceContext, RelationalSnapshotChangeEventSource.RelationalSnapshotContext<SqlServerOffsetContext> snapshotContext)
protected AbstractSnapshotChangeEventSource.SnapshotContext<SqlServerOffsetContext>	prepare(ChangeEventSource.ChangeEventSourceContext context)
protected void	readTableStructure(ChangeEventSource.ChangeEventSourceContext sourceContext, RelationalSnapshotChangeEventSource.RelationalSnapshotContext<SqlServerOffsetContext> snapshotContext, SqlServerOffsetContext offsetContext)
protected void	releaseSchemaSnapshotLocks(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<SqlServerOffsetContext> snapshotContext)

Methods inherited from class io.debezium.relational.RelationalSnapshotChangeEventSource

createSchemaChangeEventsForTables, createSnapshotConnection, doExecute, getChangeRecordEmitter, getClock, getColumnValue, lastSnapshotRecord, postSnapshot, readTableStatement, releaseDataSnapshotLocks, rowCountForTable, schema, tryStartingSnapshot

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

delaySnapshotIfNeeded, determineDataCollectionsToBeSnapshotted, execute

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

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

changeTables

private Map<TableId,SqlServerChangeTable> changeTables

Constructor Detail

SqlServerSnapshotChangeEventSource

public SqlServerSnapshotChangeEventSource(SqlServerConnectorConfig connectorConfig,
                                          SqlServerConnection jdbcConnection,
                                          SqlServerDatabaseSchema schema,
                                          EventDispatcher<TableId> dispatcher,
                                          Clock clock,
                                          SnapshotProgressListener snapshotProgressListener)

Method Detail

getSnapshottingTask

protected AbstractSnapshotChangeEventSource.SnapshottingTask getSnapshottingTask(SqlServerOffsetContext previousOffset)

Specified by:

getSnapshottingTask in class AbstractSnapshotChangeEventSource<SqlServerPartition,SqlServerOffsetContext>

prepare

protected AbstractSnapshotChangeEventSource.SnapshotContext<SqlServerOffsetContext> prepare(ChangeEventSource.ChangeEventSourceContext context)
                                                                                     throws Exception

Specified by:

prepare in class AbstractSnapshotChangeEventSource<SqlServerPartition,SqlServerOffsetContext>

Throws:

Exception

connectionCreated

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

Overrides:

connectionCreated in class RelationalSnapshotChangeEventSource<SqlServerPartition,SqlServerOffsetContext>

Throws:

Exception

getAllTableIds

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

Specified by:

getAllTableIds in class RelationalSnapshotChangeEventSource<SqlServerPartition,SqlServerOffsetContext>

Throws:

Exception

lockTablesForSchemaSnapshot

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

Specified by:

lockTablesForSchemaSnapshot in class RelationalSnapshotChangeEventSource<SqlServerPartition,SqlServerOffsetContext>

Throws:

SQLException

InterruptedException

releaseSchemaSnapshotLocks

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

Specified by:

releaseSchemaSnapshotLocks in class RelationalSnapshotChangeEventSource<SqlServerPartition,SqlServerOffsetContext>

Throws:

SQLException

determineSnapshotOffset

protected void determineSnapshotOffset(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<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<SqlServerOffsetContext> snapshotContext,
                                  SqlServerOffsetContext offsetContext)
                           throws SQLException,
                                  InterruptedException

Specified by:

readTableStructure in class RelationalSnapshotChangeEventSource<SqlServerPartition,SqlServerOffsetContext>

Throws:

SQLException

InterruptedException

getCreateTableEvent

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

Specified by:

getCreateTableEvent in class RelationalSnapshotChangeEventSource<SqlServerPartition,SqlServerOffsetContext>

Throws:

SQLException

complete

protected void complete(AbstractSnapshotChangeEventSource.SnapshotContext<SqlServerOffsetContext> snapshotContext)

Overrides:

complete in class AbstractSnapshotChangeEventSource<SqlServerPartition,SqlServerOffsetContext>

getSnapshotSelect

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

Generate a valid sqlserver 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

enhanceOverriddenSelect

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

Overrides:

enhanceOverriddenSelect in class RelationalSnapshotChangeEventSource<SqlServerPartition,SqlServerOffsetContext>

checkExcludedColumns

private String checkExcludedColumns(TableId tableId)

filterChangeTableColumns

private boolean filterChangeTableColumns(TableId tableId,
                                         String columnName)