Package io.debezium.pipeline.source.spi

Interface ChangeEventSourceFactory<P extends Partition,O extends OffsetContext>

public interface ChangeEventSourceFactory<P extends Partition,O extends OffsetContext>

A factory for creating ChangeEventSources specific to one database.

Author:

Gunnar Morling

Method Summary

Modifier and Type	Method	Description
default Optional<IncrementalSnapshotChangeEventSource<P,? extends DataCollectionId>>	getIncrementalSnapshotChangeEventSource(O offsetContext, SnapshotProgressListener<P> snapshotProgressListener, DataChangeEventListener<P> dataChangeEventListener)	Returns and incremental snapshot change event source that can run in parallel with streaming and read and send data collection content in chunk.
SnapshotChangeEventSource<P,O>	getSnapshotChangeEventSource(SnapshotProgressListener<P> snapshotProgressListener)	Returns a snapshot change event source that may emit change events for schema and/or data changes.
StreamingChangeEventSource<P,O>	getStreamingChangeEventSource()	Returns a streaming change event source that starts streaming at the given offset.

Method Detail

getSnapshotChangeEventSource

SnapshotChangeEventSource<P,O> getSnapshotChangeEventSource(SnapshotProgressListener<P> snapshotProgressListener)

Returns a snapshot change event source that may emit change events for schema and/or data changes. Depending on the snapshot mode, a given source may decide to do nothing at all if a previous offset is given. In this case it should return that given offset context from its StreamingChangeEventSource.execute(ChangeEventSource.ChangeEventSourceContext, Partition, io.debezium.pipeline.spi.OffsetContext) method.

Parameters:

snapshotProgressListener - A listener called for changes in the state of snapshot. May be null.

Returns:

A snapshot change event source

getStreamingChangeEventSource

StreamingChangeEventSource<P,O> getStreamingChangeEventSource()

Returns a streaming change event source that starts streaming at the given offset.

getIncrementalSnapshotChangeEventSource

default Optional<IncrementalSnapshotChangeEventSource<P,? extends DataCollectionId>> getIncrementalSnapshotChangeEventSource(O offsetContext,
                                                                                                                                   SnapshotProgressListener<P> snapshotProgressListener,
                                                                                                                                   DataChangeEventListener<P> dataChangeEventListener)

Returns and incremental snapshot change event source that can run in parallel with streaming and read and send data collection content in chunk.

Parameters:

offsetContext - A context representing a restored offset from an earlier run of this connector. May be null.

snapshotProgressListener - A listener called for changes in the state of snapshot. May be null.

Returns:

An incremental snapshot change event source