io.debezium.pipeline.source.spi

Interface SnapshotChangeEventSource

All Superinterfaces:

ChangeEventSource

All Known Implementing Classes:

HistorizedRelationalSnapshotChangeEventSource

public interface SnapshotChangeEventSource
extends ChangeEventSource

A change event source that emits events for taking a consistent snapshot of the captured tables, which may include schema and data information.

Author:

Gunnar Morling

Nested Class Summary

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

ChangeEventSource.ChangeEventSourceContext

Method Summary

Modifier and Type	Method and Description
SnapshotResult	execute(ChangeEventSource.ChangeEventSourceContext context) Executes this source.

Method Detail

execute

SnapshotResult execute(ChangeEventSource.ChangeEventSourceContext context)
                throws InterruptedException

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

Returns:

an indicator to the position at which the snapshot was taken

Throws:

InterruptedException - in case the snapshot was aborted before completion