Package io.debezium.pipeline

Class CommonOffsetContext<T extends BaseSourceInfo>

java.lang.Object

io.debezium.pipeline.CommonOffsetContext<T>

All Implemented Interfaces:

OffsetContext

public abstract class CommonOffsetContext<T extends BaseSourceInfo>
extends Object
implements OffsetContext

Nested Class Summary

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

OffsetContext.Loader<O extends OffsetContext>

Field Summary

Fields

Modifier and Type	Field	Description
protected SnapshotType	snapshot	Indicates the type of in progress snapshot (INITIAL, BLOCKING, INCREMENTAL).
static final String	SNAPSHOT_COMPLETED_KEY
protected boolean	snapshotCompleted	Whether an initial/blocking snapshot has been completed or not.
protected final T	sourceInfo

Constructor Summary

Constructors

Constructor	Description
CommonOffsetContext(T sourceInfo)
CommonOffsetContext(T sourceInfo, boolean snapshotCompleted)

Method Summary

Modifier and Type	Method	Description
Optional<SnapshotType>	getSnapshot()
org.apache.kafka.connect.data.Struct	getSourceInfo()
void	incrementalSnapshotEvents()	Signals that the streaming of a batch of incremental snapshot events will begin, which should reflect in an updated offset state.
boolean	isInitialSnapshotRunning()	Whether this offset indicates that an (uncompleted) snapshot is currently running or not.
void	markSnapshotRecord(SnapshotRecord record)	Mark the position of the record in the snapshot.
void	postSnapshotCompletion()	Signals that a snapshot has been completed, which should reflect in an updated offset state.
void	preSnapshotCompletion()	Signals that a snapshot will complete, which should reflect in an updated offset state.
void	preSnapshotStart(boolean onDemand)	Signals that a snapshot will begin, which should reflect in an updated offset state.
void	setSnapshot(SnapshotType snapshotType)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.debezium.pipeline.spi.OffsetContext

event, getIncrementalSnapshotContext, getOffset, getSourceInfoSchema, getTransactionContext

Field Details

SNAPSHOT_COMPLETED_KEY

public static final String SNAPSHOT_COMPLETED_KEY

See Also:

• Constant Field Values

sourceInfo

protected final T extends BaseSourceInfo sourceInfo

snapshot

protected SnapshotType snapshot

Indicates the type of in progress snapshot (INITIAL, BLOCKING, INCREMENTAL). In case of an INITIAL or BLOCKING snapshot it will be used in conjunction with snapshotCompleted to define if it is running or not.

The following table lists the possible status:

Status	snapshot	snapshotCompleted
incomplete initial snapshot	initial	false
completed initial snapshot	null	true
incomplete blocking snapshot	blocking	false
completed blocking snapshot	null	true
running incremental snapshot	incremental	true
completed incremental snapshot	null	true

snapshotCompleted

protected boolean snapshotCompleted

Whether an initial/blocking snapshot has been completed or not.

Constructor Details

CommonOffsetContext

public CommonOffsetContext(T sourceInfo)

CommonOffsetContext

public CommonOffsetContext(T sourceInfo,
 boolean snapshotCompleted)

Method Details

getSourceInfo

public org.apache.kafka.connect.data.Struct getSourceInfo()

Specified by:

getSourceInfo in interface OffsetContext

markSnapshotRecord

public void markSnapshotRecord(SnapshotRecord record)

Description copied from interface: OffsetContext

Mark the position of the record in the snapshot.

Specified by:

markSnapshotRecord in interface OffsetContext

isInitialSnapshotRunning

public boolean isInitialSnapshotRunning()

Description copied from interface: OffsetContext

Whether this offset indicates that an (uncompleted) snapshot is currently running or not.

Specified by:

isInitialSnapshotRunning in interface OffsetContext

Returns:

preSnapshotStart

public void preSnapshotStart(boolean onDemand)

Description copied from interface: OffsetContext

Signals that a snapshot will begin, which should reflect in an updated offset state.

Specified by:

preSnapshotStart in interface OffsetContext

Parameters:

onDemand - indicates whether the snapshot is initial or blocking

preSnapshotCompletion

public void preSnapshotCompletion()

Description copied from interface: OffsetContext

Signals that a snapshot will complete, which should reflect in an updated offset state.

Specified by:

preSnapshotCompletion in interface OffsetContext

postSnapshotCompletion

public void postSnapshotCompletion()

Description copied from interface: OffsetContext

Signals that a snapshot has been completed, which should reflect in an updated offset state.

Specified by:

postSnapshotCompletion in interface OffsetContext

incrementalSnapshotEvents

public void incrementalSnapshotEvents()

Description copied from interface: OffsetContext

Signals that the streaming of a batch of incremental snapshot events will begin, which should reflect in an updated offset state.

Specified by:

incrementalSnapshotEvents in interface OffsetContext

getSnapshot

public Optional<SnapshotType> getSnapshot()

setSnapshot

public void setSnapshot(SnapshotType snapshotType)