io.debezium.connector.oracle.logminer

Class TransactionalBuffer

java.lang.Object

io.debezium.connector.oracle.logminer.TransactionalBuffer

All Implemented Interfaces:

AutoCloseable

@NotThreadSafe
public final class TransactionalBuffer
extends Object
implements AutoCloseable

Buffer that stores transactions and related callbacks that will be executed when a transaction commits or discarded when a transaction has been rolled back.

Author:

Andrey Pustovetov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TransactionalBuffer.CommitCallback Callback is designed to execute when transaction commits.
private static class	TransactionalBuffer.Transaction

Field Summary

Fields

Modifier and Type	Field and Description
private Set<String>	abandonedTransactionIds
private ErrorHandler	errorHandler
private Scn	lastCommittedScn
private static org.slf4j.Logger	LOGGER
private TransactionalBufferMetrics	metrics
private Set<String>	rolledBackTransactionIds
private Map<String,TransactionalBuffer.Transaction>	transactions

Constructor Summary

Constructors

Constructor and Description
TransactionalBuffer(OracleTaskContext taskContext, ErrorHandler errorHandler) Constructor to create a new instance.

Method Summary

Modifier and Type	Method and Description
(package private) void	abandonLongTransactions(Long thresholdScn, OracleOffsetContext offsetContext) If for some reason the connector got restarted, the offset will point to the beginning of the oldest captured transaction.
private Scn	calculateSmallestScn()
void	close()
private void	commit(ChangeEventSource.ChangeEventSourceContext context, OracleOffsetContext offsetContext, Instant start, List<TransactionalBuffer.CommitCallback> commitCallbacks, Timestamp timestamp, Scn smallestScn, Scn scn, EventDispatcher<?> dispatcher)
(package private) boolean	commit(String transactionId, Scn scn, OracleOffsetContext offsetContext, Timestamp timestamp, ChangeEventSource.ChangeEventSourceContext context, String debugMessage, EventDispatcher dispatcher) Commits a transaction by looking up the transaction in the buffer and if exists, all registered callbacks will be executed in chronological order, emitting events for each followed by a transaction commit event.
(package private) TransactionalBufferMetrics	getMetrics()
(package private) Set<String>	getRolledBackTransactionIds()
(package private) boolean	isEmpty() Returns true if buffer is empty, otherwise false.
(package private) boolean	isTransactionRegistered(String txId)
(package private) void	registerCommitCallback(String transactionId, Scn scn, Instant changeTime, TransactionalBuffer.CommitCallback callback) Registers callback to execute when transaction commits.
(package private) boolean	rollback(String transactionId, String debugMessage) Clears registered callbacks for given transaction identifier.
(package private) void	setDatabaseTimeDifference(long difference) Set the database time difference.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final org.slf4j.Logger LOGGER

transactions

private final Map<String,TransactionalBuffer.Transaction> transactions

errorHandler

private final ErrorHandler errorHandler

abandonedTransactionIds

private final Set<String> abandonedTransactionIds

rolledBackTransactionIds

private final Set<String> rolledBackTransactionIds

metrics

private final TransactionalBufferMetrics metrics

lastCommittedScn

private Scn lastCommittedScn

Constructor Detail

TransactionalBuffer

TransactionalBuffer(OracleTaskContext taskContext,
                    ErrorHandler errorHandler)

Constructor to create a new instance.

Parameters:

taskContext - the task context

errorHandler - the connector error handler

Method Detail

getMetrics

TransactionalBufferMetrics getMetrics()

Returns:

the transactional buffer's metrics

getRolledBackTransactionIds

Set<String> getRolledBackTransactionIds()

Returns:

rolled back transactions

registerCommitCallback

void registerCommitCallback(String transactionId,
                            Scn scn,
                            Instant changeTime,
                            TransactionalBuffer.CommitCallback callback)

Registers callback to execute when transaction commits.

Parameters:

transactionId - transaction identifier

scn - SCN

changeTime - time of DML parsing completion

callback - callback to execute when transaction commits

commit

boolean commit(String transactionId,
               Scn scn,
               OracleOffsetContext offsetContext,
               Timestamp timestamp,
               ChangeEventSource.ChangeEventSourceContext context,
               String debugMessage,
               EventDispatcher dispatcher)

Commits a transaction by looking up the transaction in the buffer and if exists, all registered callbacks will be executed in chronological order, emitting events for each followed by a transaction commit event.

Parameters:

transactionId - transaction identifier

scn - SCN of the commit.

offsetContext - Oracle offset

timestamp - commit timestamp

context - context to check that source is running

debugMessage - message

dispatcher - event dispatcher

Returns:

true if committed transaction is in the buffer, was not processed yet and processed now

commit

private void commit(ChangeEventSource.ChangeEventSourceContext context,
                    OracleOffsetContext offsetContext,
                    Instant start,
                    List<TransactionalBuffer.CommitCallback> commitCallbacks,
                    Timestamp timestamp,
                    Scn smallestScn,
                    Scn scn,
                    EventDispatcher<?> dispatcher)

rollback

boolean rollback(String transactionId,
                 String debugMessage)

Clears registered callbacks for given transaction identifier.

Parameters:

transactionId - transaction id

debugMessage - message

Returns:

true if the rollback is for a transaction in the buffer

abandonLongTransactions

void abandonLongTransactions(Long thresholdScn,
                             OracleOffsetContext offsetContext)

If for some reason the connector got restarted, the offset will point to the beginning of the oldest captured transaction. If that transaction was lasted for a long time, let say > 4 hours, the offset might be not accessible after restart, Hence we have to address these cases manually.

In case of an abandonment, all DMLs/Commits/Rollbacks for this transaction will be ignored

Parameters:

thresholdScn - the smallest SVN of any transaction to keep in the buffer. All others will be removed.

offsetContext - the offset context

isTransactionRegistered

boolean isTransactionRegistered(String txId)

calculateSmallestScn

private Scn calculateSmallestScn()

isEmpty

boolean isEmpty()

Returns true if buffer is empty, otherwise false.

Returns:

true if buffer is empty, otherwise false

setDatabaseTimeDifference

void setDatabaseTimeDifference(long difference)

Set the database time difference.

Parameters:

difference - the time difference in milliseconds

toString

public String toString()

Overrides:

toString in class Object

close

public void close()

Specified by:

close in interface AutoCloseable