io.debezium.pipeline.source

Class AbstractSnapshotChangeEventSource

java.lang.Object

io.debezium.pipeline.source.AbstractSnapshotChangeEventSource

All Implemented Interfaces:

ChangeEventSource, SnapshotChangeEventSource

Direct Known Subclasses:

RelationalSnapshotChangeEventSource

public abstract class AbstractSnapshotChangeEventSource
extends Object
implements SnapshotChangeEventSource

An abstract implementation of SnapshotChangeEventSource that all implementations should extend to inherit common functionality.

Author:

Chris Cranford

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractSnapshotChangeEventSource.SnapshotContext Mutable context which is populated in the course of snapshotting
static class	AbstractSnapshotChangeEventSource.SnapshottingTask A configuration describing the task to be performed during snapshotting.

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

ChangeEventSource.ChangeEventSourceContext

Field Summary

Fields

Modifier and Type	Field and Description
private CommonConnectorConfig	connectorConfig
private static org.slf4j.Logger	LOGGER
private OffsetContext	previousOffset
private SnapshotProgressListener	snapshotProgressListener

Constructor Summary

Constructors

Constructor and Description
AbstractSnapshotChangeEventSource(CommonConnectorConfig connectorConfig, OffsetContext previousOffset, SnapshotProgressListener snapshotProgressListener)

Method Summary

Modifier and Type	Method and Description
protected abstract void	complete(AbstractSnapshotChangeEventSource.SnapshotContext snapshotContext) Completes the snapshot, doing any required clean-up (resource disposal etc.).
protected void	delaySnapshotIfNeeded(ChangeEventSource.ChangeEventSourceContext context) Delays snapshot execution as per the CommonConnectorConfig.SNAPSHOT_DELAY_MS parameter.
protected abstract SnapshotResult	doExecute(ChangeEventSource.ChangeEventSourceContext context, AbstractSnapshotChangeEventSource.SnapshotContext snapshotContext, AbstractSnapshotChangeEventSource.SnapshottingTask snapshottingTask) Executes this source.
SnapshotResult	execute(ChangeEventSource.ChangeEventSourceContext context) Executes this source.
protected abstract AbstractSnapshotChangeEventSource.SnapshottingTask	getSnapshottingTask(OffsetContext previousOffset) Returns the snapshotting task based on the previous offset (if available) and the connector's snapshotting mode.
protected abstract AbstractSnapshotChangeEventSource.SnapshotContext	prepare(ChangeEventSource.ChangeEventSourceContext changeEventSourceContext) Prepares the taking of a snapshot and returns an initial AbstractSnapshotChangeEventSource.SnapshotContext.

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 CommonConnectorConfig connectorConfig

previousOffset

private final OffsetContext previousOffset

snapshotProgressListener

private final SnapshotProgressListener snapshotProgressListener

Constructor Detail

AbstractSnapshotChangeEventSource

public AbstractSnapshotChangeEventSource(CommonConnectorConfig connectorConfig,
                                         OffsetContext previousOffset,
                                         SnapshotProgressListener snapshotProgressListener)

Method Detail

execute

public SnapshotResult execute(ChangeEventSource.ChangeEventSourceContext context)
                       throws InterruptedException

Description copied from interface: SnapshotChangeEventSource

Executes this source. Implementations should regularly check via the given context if they should stop. If that's the case, they should abort their processing and perform any clean-up needed, such as rolling back pending transactions, releasing locks etc.

Specified by:

execute in interface SnapshotChangeEventSource

Parameters:

context - contextual information for this source's execution

Returns:

an indicator to the position at which the snapshot was taken

Throws:

InterruptedException - in case the snapshot was aborted before completion

delaySnapshotIfNeeded

protected void delaySnapshotIfNeeded(ChangeEventSource.ChangeEventSourceContext context)
                              throws InterruptedException

Delays snapshot execution as per the CommonConnectorConfig.SNAPSHOT_DELAY_MS parameter.

Throws:

InterruptedException

doExecute

protected abstract SnapshotResult doExecute(ChangeEventSource.ChangeEventSourceContext context,
                                            AbstractSnapshotChangeEventSource.SnapshotContext snapshotContext,
                                            AbstractSnapshotChangeEventSource.SnapshottingTask snapshottingTask)
                                     throws Exception

Executes this source. Implementations should regularly check via the given context if they should stop. If that's the case, they should abort their processing and perform any clean-up needed, such as rolling back pending transactions, releasing locks, etc.

Parameters:

context - contextual information for this source's execution

snapshotContext - mutable context information populated throughout the snapshot process

snapshottingTask - immutable information about what tasks should be performed during snapshot

Returns:

an indicator to the position at which the snapshot was taken

Throws:

Exception

getSnapshottingTask

protected abstract AbstractSnapshotChangeEventSource.SnapshottingTask getSnapshottingTask(OffsetContext previousOffset)

Returns the snapshotting task based on the previous offset (if available) and the connector's snapshotting mode.

prepare

protected abstract AbstractSnapshotChangeEventSource.SnapshotContext prepare(ChangeEventSource.ChangeEventSourceContext changeEventSourceContext)
                                                                      throws Exception

Prepares the taking of a snapshot and returns an initial AbstractSnapshotChangeEventSource.SnapshotContext.

Throws:

Exception

complete

protected abstract void complete(AbstractSnapshotChangeEventSource.SnapshotContext snapshotContext)

Completes the snapshot, doing any required clean-up (resource disposal etc.).

Parameters:

snapshotContext - snapshot context