Package io.debezium.connector.oracle

Class OracleSnapshotChangeEventSource

java.lang.Object

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

io.debezium.relational.RelationalSnapshotChangeEventSource<OraclePartition,OracleOffsetContext>

io.debezium.connector.oracle.OracleSnapshotChangeEventSource

All Implemented Interfaces:

ChangeEventSource, SnapshotChangeEventSource<OraclePartition,OracleOffsetContext>

public class OracleSnapshotChangeEventSource
extends RelationalSnapshotChangeEventSource<OraclePartition,OracleOffsetContext>

A StreamingChangeEventSource for Oracle.

Author:

Gunnar Morling

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	OracleSnapshotChangeEventSource.OracleSnapshotContext	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>, 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 OracleConnectorConfig	connectorConfig
private OracleDatabaseSchema	databaseSchema
private OracleConnection	jdbcConnection
private static org.slf4j.Logger	LOGGER

Fields inherited from class io.debezium.relational.RelationalSnapshotChangeEventSource

clock, dispatcher, SELECT_ALL_PATTERN

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

LOG_INTERVAL

Constructor Summary

Constructors

Constructor	Description
OracleSnapshotChangeEventSource(OracleConnectorConfig connectorConfig, OracleConnection jdbcConnection, OracleDatabaseSchema schema, EventDispatcher<OraclePartition,TableId> dispatcher, Clock clock, SnapshotProgressListener<OraclePartition> snapshotProgressListener)

Method Summary

Modifier and Type	Method	Description
private boolean	areSameTimestamp(Scn scn1, Scn scn2)	Whether the two SCNs represent the same timestamp or not (resolution is only 3 seconds).
protected void	complete(AbstractSnapshotChangeEventSource.SnapshotContext<OraclePartition,OracleOffsetContext> snapshotContext)
protected void	determineSnapshotOffset(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<OraclePartition,OracleOffsetContext> ctx, OracleOffsetContext previousOffset)
protected String	enhanceOverriddenSelect(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<OraclePartition,OracleOffsetContext> snapshotContext, String overriddenSelect, TableId tableId)
protected Set<TableId>	getAllTableIds(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<OraclePartition,OracleOffsetContext> ctx)
protected SchemaChangeEvent	getCreateTableEvent(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<OraclePartition,OracleOffsetContext> snapshotContext, Table table)
private Optional<Scn>	getLatestTableDdlScn(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<OraclePartition,OracleOffsetContext> ctx)	Returns the SCN of the latest DDL change to the captured tables.
private Map<String,Scn>	getSnapshotPendingTransactions(Scn snapshotSCN)	Returns a map of transaction id to start SCN for all ongoing transactions before snapshotSCN.
protected Optional<String>	getSnapshotSelect(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<OraclePartition,OracleOffsetContext> snapshotContext, TableId tableId, List<String> columns)	Generate a valid Oracle query string for the specified table and columns
protected AbstractSnapshotChangeEventSource.SnapshottingTask	getSnapshottingTask(OraclePartition partition, OracleOffsetContext previousOffset)
protected void	lockTablesForSchemaSnapshot(ChangeEventSource.ChangeEventSourceContext sourceContext, RelationalSnapshotChangeEventSource.RelationalSnapshotContext<OraclePartition,OracleOffsetContext> snapshotContext)
protected AbstractSnapshotChangeEventSource.SnapshotContext<OraclePartition,OracleOffsetContext>	prepare(OraclePartition partition)
private static String	quote(TableId tableId)
protected void	readTableStructure(ChangeEventSource.ChangeEventSourceContext sourceContext, RelationalSnapshotChangeEventSource.RelationalSnapshotContext<OraclePartition,OracleOffsetContext> snapshotContext, OracleOffsetContext offsetContext)
protected void	releaseSchemaSnapshotLocks(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<OraclePartition,OracleOffsetContext> snapshotContext)

Methods inherited from class io.debezium.relational.RelationalSnapshotChangeEventSource

additionalColumnFilter, connectionCreated, createSchemaChangeEventsForTables, createSnapshotConnection, doExecute, getChangeRecordEmitter, getClock, getColumnValue, getPreparedColumnNames, 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

connectorConfig

private final OracleConnectorConfig connectorConfig

jdbcConnection

private final OracleConnection jdbcConnection

databaseSchema

private final OracleDatabaseSchema databaseSchema

Constructor Detail

OracleSnapshotChangeEventSource

public OracleSnapshotChangeEventSource(OracleConnectorConfig connectorConfig,
                                       OracleConnection jdbcConnection,
                                       OracleDatabaseSchema schema,
                                       EventDispatcher<OraclePartition,TableId> dispatcher,
                                       Clock clock,
                                       SnapshotProgressListener<OraclePartition> snapshotProgressListener)

Method Detail

getSnapshottingTask

protected AbstractSnapshotChangeEventSource.SnapshottingTask getSnapshottingTask(OraclePartition partition,
                                                                                 OracleOffsetContext previousOffset)

Specified by:

getSnapshottingTask in class AbstractSnapshotChangeEventSource<OraclePartition,OracleOffsetContext>

prepare

protected AbstractSnapshotChangeEventSource.SnapshotContext<OraclePartition,OracleOffsetContext> prepare(OraclePartition partition)
                                                                                                        throws Exception

Specified by:

prepare in class AbstractSnapshotChangeEventSource<OraclePartition,OracleOffsetContext>

Throws:

Exception

getAllTableIds

protected Set<TableId> getAllTableIds(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<OraclePartition,OracleOffsetContext> ctx)
                               throws Exception

Specified by:

getAllTableIds in class RelationalSnapshotChangeEventSource<OraclePartition,OracleOffsetContext>

Throws:

Exception

lockTablesForSchemaSnapshot

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

Specified by:

lockTablesForSchemaSnapshot in class RelationalSnapshotChangeEventSource<OraclePartition,OracleOffsetContext>

Throws:

SQLException

InterruptedException

releaseSchemaSnapshotLocks

protected void releaseSchemaSnapshotLocks(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<OraclePartition,OracleOffsetContext> snapshotContext)
                                   throws SQLException

Specified by:

releaseSchemaSnapshotLocks in class RelationalSnapshotChangeEventSource<OraclePartition,OracleOffsetContext>

Throws:

SQLException

determineSnapshotOffset

protected void determineSnapshotOffset(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<OraclePartition,OracleOffsetContext> ctx,
                                       OracleOffsetContext previousOffset)
                                throws Exception

Specified by:

determineSnapshotOffset in class RelationalSnapshotChangeEventSource<OraclePartition,OracleOffsetContext>

Throws:

Exception

areSameTimestamp

private boolean areSameTimestamp(Scn scn1,
                                 Scn scn2)
                          throws SQLException

Whether the two SCNs represent the same timestamp or not (resolution is only 3 seconds).

Throws:

SQLException

getLatestTableDdlScn

private Optional<Scn> getLatestTableDdlScn(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<OraclePartition,OracleOffsetContext> ctx)
                                    throws SQLException

Returns the SCN of the latest DDL change to the captured tables. The result will be empty if there's no table to capture as per the configuration.

Throws:

SQLException

getSnapshotPendingTransactions

private Map<String,Scn> getSnapshotPendingTransactions(Scn snapshotSCN)
                                                      throws SQLException

Returns a map of transaction id to start SCN for all ongoing transactions before snapshotSCN.

Throws:

SQLException

readTableStructure

protected void readTableStructure(ChangeEventSource.ChangeEventSourceContext sourceContext,
                                  RelationalSnapshotChangeEventSource.RelationalSnapshotContext<OraclePartition,OracleOffsetContext> snapshotContext,
                                  OracleOffsetContext offsetContext)
                           throws SQLException,
                                  InterruptedException

Specified by:

readTableStructure in class RelationalSnapshotChangeEventSource<OraclePartition,OracleOffsetContext>

Throws:

SQLException

InterruptedException

enhanceOverriddenSelect

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

Overrides:

enhanceOverriddenSelect in class RelationalSnapshotChangeEventSource<OraclePartition,OracleOffsetContext>

getCreateTableEvent

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

Specified by:

getCreateTableEvent in class RelationalSnapshotChangeEventSource<OraclePartition,OracleOffsetContext>

Throws:

SQLException

getSnapshotSelect

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

Generate a valid Oracle query string for the specified table and columns

Specified by:

getSnapshotSelect in class RelationalSnapshotChangeEventSource<OraclePartition,OracleOffsetContext>

Parameters:

tableId - the table to generate a query for

Returns:

a valid query string

complete

protected void complete(AbstractSnapshotChangeEventSource.SnapshotContext<OraclePartition,OracleOffsetContext> snapshotContext)

Overrides:

complete in class AbstractSnapshotChangeEventSource<OraclePartition,OracleOffsetContext>

quote

private static String quote(TableId tableId)