Package io.debezium.engine

Interface DebeziumEngine.Builder<R>

  • Enclosing interface:
    DebeziumEngine<R>
    public static interface DebeziumEngine.Builder<R>
    A builder to set up and create DebeziumEngine instances.

    • Method Detail

      • notifying

        DebeziumEngine.Builder<R> notifying​(Consumer<R> consumer)
        Call the specified function for every data change event read from the source database. This method must be called with a non-null consumer.
        Parameters:
        consumer - the consumer function
        Returns:
        this builder object so methods can be chained together; never null

      • notifying

        DebeziumEngine.Builder<R> notifying​(DebeziumEngine.ChangeConsumer<R> handler)
        Pass a custom ChangeConsumer override the default implementation, this allows for more complex handling of records for batch and async handling
        Parameters:
        handler - the consumer function
        Returns:
        this builder object so methods can be chained together; never null

      • using

        DebeziumEngine.Builder<R> using​(Properties config)
        Use the specified configuration for the connector. The configuration is assumed to already be valid.
        Parameters:
        config - the configuration
        Returns:
        this builder object so methods can be chained together; never null

      • using

        DebeziumEngine.Builder<R> using​(ClassLoader classLoader)
        Use the specified class loader to find all necessary classes. Passing null or not calling this method results in the connector using this class's class loader.
        Parameters:
        classLoader - the class loader
        Returns:
        this builder object so methods can be chained together; never null

      • using

        DebeziumEngine.Builder<R> using​(Clock clock)
        Use the specified clock when needing to determine the current time. Passing null or not calling this method results in the connector using the system clock.
        Parameters:
        clock - the clock
        Returns:
        this builder object so methods can be chained together; never null

      • using

        DebeziumEngine.Builder<R> using​(DebeziumEngine.CompletionCallback completionCallback)
        When the engine's Runnable.run() method completes, call the supplied function with the results.
        Parameters:
        completionCallback - the callback function; may be null if errors should be written to the log
        Returns:
        this builder object so methods can be chained together; never null

      • using

        DebeziumEngine.Builder<R> using​(DebeziumEngine.ConnectorCallback connectorCallback)
        During the engine's Runnable.run() method, call the supplied the supplied function at different stages according to the completion state of each component running within the engine (connectors, tasks etc)
        Parameters:
        connectorCallback - the callback function; may be null
        Returns:
        this builder object so methods can be chained together; never null

      • using

        DebeziumEngine.Builder<R> using​(OffsetCommitPolicy policy)
        During the engine's Runnable.run() method, decide when the offsets should be committed into the OffsetBackingStore.
        Parameters:
        policy -
        Returns:
        this builder object so methods can be chained together; never null