io.debezium.pipeline.source.spi

Interface StreamingChangeEventSource

All Superinterfaces:

ChangeEventSource

public interface StreamingChangeEventSource
extends ChangeEventSource

A change event source that emits events from a DB log, such as MySQL's binlog or similar.

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
default void	commitOffset(Map<String,?> offset) Commits the given offset with the source database.
void	execute(ChangeEventSource.ChangeEventSourceContext context) Executes this source.

Method Detail

execute

void 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

Throws:

InterruptedException - in case the snapshot was aborted before completion

commitOffset

default void commitOffset(Map<String,?> offset)

Commits the given offset with the source database. Used by some connectors like Postgres and Oracle to indicate how far the source TX log can be discarded.