Index

A B C D E G H I J K L M N O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

additionalData - Variable in record class io.debezium.engine.DebeziumEngine.Signal

The field for the additionalData record component.

additionalData() - Method in record class io.debezium.engine.DebeziumEngine.Signal

Returns the value of the additionalData record component.

always() - Static method in interface io.debezium.engine.spi.OffsetCommitPolicy

AlwaysCommitOffsetPolicy() - Constructor for class io.debezium.engine.spi.OffsetCommitPolicy.AlwaysCommitOffsetPolicy

and(OffsetCommitPolicy) - Method in interface io.debezium.engine.spi.OffsetCommitPolicy

Obtain a new OffsetCommitPolicy that will commit offsets if both this policy AND the other requests it.

augment(I, S, R) - Method in interface io.debezium.spi.topic.TopicNamingStrategy.TopicValueAugment

Augment value to the struct.

augment(S) - Method in interface io.debezium.spi.topic.TopicNamingStrategy.TopicSchemaAugment

Augment field to schema.

Avro - Class in io.debezium.engine.format

A SerializationFormat defining the Avro format serialized as byte[].

Avro() - Constructor for class io.debezium.engine.format.Avro

B

Binary - Class in io.debezium.engine.format

A SerializationFormat defining the binary format serialized as byte[].

Binary() - Constructor for class io.debezium.engine.format.Binary

build() - Method in interface io.debezium.engine.DebeziumEngine.Builder

Build a new connector with the information previously supplied to this builder.

builder(ChangeEventFormat<V>) - Method in interface io.debezium.engine.DebeziumEngine.BuilderFactory

Prescribe the output format used by the DebeziumEngine.

builder(KeyValueChangeEventFormat<K, V>) - Method in interface io.debezium.engine.DebeziumEngine.BuilderFactory

Prescribe the output format used by the DebeziumEngine.

builder(KeyValueHeaderChangeEventFormat<K, V, H>) - Method in interface io.debezium.engine.DebeziumEngine.BuilderFactory

Prescribe the output and header formats to be used by the DebeziumEngine.

buildOffsets() - Method in interface io.debezium.engine.DebeziumEngine.RecordCommitter

Builds a new instance of an object implementing the DebeziumEngine.Offsets contract.

C

ChangeEvent<K,V> - Interface in io.debezium.engine

A data change event with key, value, and headers.

ChangeEventFormat<V> - Interface in io.debezium.engine.format

Describes a change event output format comprising just of a single value.

charsetName() - Method in interface io.debezium.spi.converter.RelationalColumn

Get the character set associated with the column.

CloudEvents - Class in io.debezium.engine.format

A SerializationFormat defining the CloudEvents format serialized as String.

CloudEvents() - Constructor for class io.debezium.engine.format.CloudEvents

Configurable - Interface in io.debezium.spi.common

A contract that defines a configurable interface

configure(Map<String, ?>) - Method in interface io.debezium.spi.common.Configurable

Connector properties are passed to let you configure your implementation.

configure(Properties) - Method in interface io.debezium.spi.converter.CustomConverter

configure(Properties) - Method in interface io.debezium.spi.topic.TopicNamingStrategy

connectorStarted() - Method in interface io.debezium.engine.DebeziumEngine.ConnectorCallback

Called after a connector has been successfully started by the engine; i.e.

connectorStopped() - Method in interface io.debezium.engine.DebeziumEngine.ConnectorCallback

Called after a connector has been successfully stopped by the engine; i.e.

convert(Object) - Method in interface io.debezium.spi.converter.CustomConverter.Converter

ConvertedField - Interface in io.debezium.spi.converter

An the base interface for a converted field that provides naming characteristics.

converterFor(F, CustomConverter.ConverterRegistration<S>) - Method in interface io.debezium.spi.converter.CustomConverter

Allows to register a custom value and schema converter for a given field-

create(ChangeEventFormat<V>) - Static method in interface io.debezium.engine.DebeziumEngine

Obtain a new DebeziumEngine.Builder instance that can be used to construct runnable DebeziumEngine instances.

create(KeyValueChangeEventFormat<K, V>) - Static method in interface io.debezium.engine.DebeziumEngine

create(KeyValueHeaderChangeEventFormat<K, V, H>) - Static method in interface io.debezium.engine.DebeziumEngine

create(KeyValueHeaderChangeEventFormat<K, V, H>, String) - Static method in interface io.debezium.engine.DebeziumEngine

create(Class<? extends SerializationFormat<K>>, Class<? extends SerializationFormat<V>>) - Static method in interface io.debezium.engine.DebeziumEngine

Obtain a new DebeziumEngine.Builder instance that can be used to construct runnable DebeziumEngine instances.

create(Class<? extends SerializationFormat<K>>, Class<? extends SerializationFormat<V>>, Class<? extends SerializationFormat<H>>) - Static method in interface io.debezium.engine.DebeziumEngine

Obtain a new DebeziumEngine.Builder instance that can be used to construct runnable DebeziumEngine instances.

create(Class<? extends SerializationFormat<K>>, Class<? extends SerializationFormat<V>>, Class<? extends SerializationFormat<H>>, String) - Static method in interface io.debezium.engine.DebeziumEngine

create(Class<? extends SerializationFormat<T>>) - Static method in interface io.debezium.engine.DebeziumEngine

Obtain a new DebeziumEngine.Builder instance that can be used to construct runnable DebeziumEngine instances.

CustomConverter<S,F> - Interface in io.debezium.spi.converter

An interface that allows the user to customize how a value will be converted for a given field.

CustomConverter.Converter - Interface in io.debezium.spi.converter

A conversion converting data from one type to another.

CustomConverter.ConverterRegistration<S> - Interface in io.debezium.spi.converter

Callback for registering a converter.

D

data - Variable in record class io.debezium.engine.DebeziumEngine.Signal

The field for the data record component.

data() - Method in record class io.debezium.engine.DebeziumEngine.Signal

Returns the value of the data record component.

databaseParts() - Method in interface io.debezium.spi.schema.DataCollectionId

Get a database list including database, table name.

dataChangeTopic(I) - Method in interface io.debezium.spi.topic.TopicNamingStrategy

dataCollection() - Method in interface io.debezium.spi.converter.ConvertedField

DataCollectionId - Interface in io.debezium.spi.schema

Common contract for all identifiers of data collections (RDBMS tables, MongoDB collections etc.)

DebeziumEngine<R> - Interface in io.debezium.engine

A mechanism for running a single Kafka Connect

invalid reference

SourceConnector

within an application's process.

DebeziumEngine.Builder<R> - Interface in io.debezium.engine

A builder to set up and create DebeziumEngine instances.

DebeziumEngine.BuilderFactory - Interface in io.debezium.engine

Internal contract between the API and implementation, for bootstrapping the latter.

DebeziumEngine.ChangeConsumer<R> - Interface in io.debezium.engine

A contract invoked by the embedded engine when it has received a batch of change records to be processed.

DebeziumEngine.CompletionCallback - Interface in io.debezium.engine

A callback function to be notified when the connector completes.

DebeziumEngine.ConnectorCallback - Interface in io.debezium.engine

Callback function which informs users about the various stages a connector goes through during startup

DebeziumEngine.Offsets - Interface in io.debezium.engine

Contract that should be passed to DebeziumEngine.RecordCommitter.markProcessed(Object, Offsets) for marking a record as processed with updated offsets.

DebeziumEngine.RecordCommitter<R> - Interface in io.debezium.engine

Contract passed to DebeziumEngine.ChangeConsumers, allowing them to commit single records as they have been processed and to signal that offsets may be flushed eventually.

DebeziumEngine.Signal - Record Class in io.debezium.engine

A record representing signal sent to the engine via DebeziumEngine.Signaler.

DebeziumEngine.Signaler - Interface in io.debezium.engine

Signaler defines the contract for sending signals to connector tasks.

DEFAULT_COMMIT_OFFSET_INTERVAL - Static variable in class io.debezium.engine.spi.OffsetCommitPolicy.PeriodicCommitOffsetPolicy

defaultValue() - Method in interface io.debezium.spi.converter.RelationalColumn

Get the default value of the column

destination() - Method in interface io.debezium.engine.ChangeEvent

determineBuilderFactory() - Static method in interface io.debezium.engine.DebeziumEngine

determineBuilderFactory(String) - Static method in interface io.debezium.engine.DebeziumEngine

E

equals(Object) - Method in record class io.debezium.engine.DebeziumEngine.Signal

Indicates whether some other object is "equal to" this one.

G

getHeaderFormat() - Method in interface io.debezium.engine.format.KeyValueHeaderChangeEventFormat

getKey() - Method in interface io.debezium.engine.Header

Key of a header.

getKeyFormat() - Method in interface io.debezium.engine.format.KeyValueChangeEventFormat

getSignaler() - Method in interface io.debezium.engine.DebeziumEngine

getValue() - Method in interface io.debezium.engine.Header

Value of a header.

getValueFormat() - Method in interface io.debezium.engine.format.ChangeEventFormat

getValueFormat() - Method in interface io.debezium.engine.format.KeyValueChangeEventFormat

H

handle(boolean, String, Throwable) - Method in interface io.debezium.engine.DebeziumEngine.CompletionCallback

Handle the completion of the embedded connector engine.

handleBatch(List<R>, DebeziumEngine.RecordCommitter<R>) - Method in interface io.debezium.engine.DebeziumEngine.ChangeConsumer

Handles a batch of records, calling the DebeziumEngine.RecordCommitter.markProcessed(Object) for each record and DebeziumEngine.RecordCommitter.markBatchFinished() when this batch is finished.

hasDefaultValue() - Method in interface io.debezium.spi.converter.RelationalColumn

Determine whether this column's has a default value

hashCode() - Method in record class io.debezium.engine.DebeziumEngine.Signal

Returns a hash code value for this object.

Header<T> - Interface in io.debezium.engine

Represents a header that contains a key and a value.

headers() - Method in interface io.debezium.engine.ChangeEvent

heartbeatTopic() - Method in interface io.debezium.spi.topic.TopicNamingStrategy

I

id - Variable in record class io.debezium.engine.DebeziumEngine.Signal

The field for the id record component.

id() - Method in record class io.debezium.engine.DebeziumEngine.Signal

Returns the value of the id record component.

identifier() - Method in interface io.debezium.spi.schema.DataCollectionId

Get the fully qualified identifier of the data collection.

Incubating - Annotation Interface in io.debezium.common.annotation

Marks the annotated element as incubating.

io.debezium.common.annotation - package io.debezium.common.annotation

io.debezium.engine - package io.debezium.engine

io.debezium.engine.format - package io.debezium.engine.format

io.debezium.engine.spi - package io.debezium.engine.spi

io.debezium.spi.common - package io.debezium.spi.common

io.debezium.spi.converter - package io.debezium.spi.converter

io.debezium.spi.schema - package io.debezium.spi.schema

io.debezium.spi.snapshot - package io.debezium.spi.snapshot

io.debezium.spi.topic - package io.debezium.spi.topic

isOptional() - Method in interface io.debezium.spi.converter.RelationalColumn

Determine whether this column is optional.

isValidFirstCharacter(char) - Method in interface io.debezium.spi.common.ReplacementFunction

Determine if the supplied character is a valid first character for Avro fullnames.

isValidNonFirstCharacter(char) - Method in interface io.debezium.spi.common.ReplacementFunction

Determine if the supplied character is a valid non-first character for Avro fullnames.

J

jdbcType() - Method in interface io.debezium.spi.converter.RelationalColumn

Get the JDBC type for this column

Json - Class in io.debezium.engine.format

A SerializationFormat defining the JSON format serialized as String.

Json() - Constructor for class io.debezium.engine.format.Json

JsonByteArray - Class in io.debezium.engine.format

A SerializationFormat defining the JSON format serialized as byte[].

JsonByteArray() - Constructor for class io.debezium.engine.format.JsonByteArray

K

key() - Method in interface io.debezium.engine.ChangeEvent

keySchemaAugment() - Method in interface io.debezium.spi.topic.TopicNamingStrategy

keyValueAugment() - Method in interface io.debezium.spi.topic.TopicNamingStrategy

KeyValueChangeEventFormat<K,V> - Interface in io.debezium.engine.format

Describes a change event output format comprising a key and a value.

KeyValueHeaderChangeEventFormat<K,V,H> - Interface in io.debezium.engine.format

Describes a change event output format comprising a key, value, and a header.

L

length() - Method in interface io.debezium.spi.converter.RelationalColumn

Get the maximum length of this column's values.

M

markBatchFinished() - Method in interface io.debezium.engine.DebeziumEngine.RecordCommitter

Marks a batch as finished, this may result in committing offsets/flushing data.

markProcessed(R) - Method in interface io.debezium.engine.DebeziumEngine.RecordCommitter

Marks a single record as processed, must be called for each record.

markProcessed(R, DebeziumEngine.Offsets) - Method in interface io.debezium.engine.DebeziumEngine.RecordCommitter

Marks a record with updated source offsets as processed.

MAX_NAME_LENGTH - Static variable in interface io.debezium.spi.topic.TopicNamingStrategy

minimumTime - Variable in class io.debezium.engine.spi.OffsetCommitPolicy.PeriodicCommitOffsetPolicy

N

name() - Method in interface io.debezium.spi.converter.ConvertedField

name() - Method in interface io.debezium.spi.snapshot.Snapshotter

nativeType() - Method in interface io.debezium.spi.converter.RelationalColumn

Get the database native type for this column

NO_SCHEMA_OP - Static variable in interface io.debezium.spi.topic.TopicNamingStrategy

NO_VALUE_OP - Static variable in interface io.debezium.spi.topic.TopicNamingStrategy

notifying(DebeziumEngine.ChangeConsumer<R>) - Method in interface io.debezium.engine.DebeziumEngine.Builder

Pass a custom ChangeConsumer override the default implementation, this allows for more complex handling of records for batch and async handling

notifying(Consumer<R>) - Method in interface io.debezium.engine.DebeziumEngine.Builder

Call the specified function for every

invalid reference

data change event

read from the source database.

O

of(Class<K>, Class<V>) - Static method in interface io.debezium.engine.format.KeyValueChangeEventFormat

Creates a change event format representing key and value using separate objects.

of(Class<K>, Class<V>, Class<H>) - Static method in interface io.debezium.engine.format.KeyValueHeaderChangeEventFormat

of(Class<V>) - Static method in interface io.debezium.engine.format.ChangeEventFormat

Creates a change event format representing key and value in a single object.

OFFSET_FLUSH_INTERVAL_MS_PROP - Static variable in interface io.debezium.engine.DebeziumEngine

OffsetCommitPolicy - Interface in io.debezium.engine.spi

The policy that defines when the offsets should be committed to offset storage.

OffsetCommitPolicy.AlwaysCommitOffsetPolicy - Class in io.debezium.engine.spi

An OffsetCommitPolicy that will commit offsets as frequently as possible.

OffsetCommitPolicy.PeriodicCommitOffsetPolicy - Class in io.debezium.engine.spi

An OffsetCommitPolicy that will commit offsets no more than the specified time period.

or(OffsetCommitPolicy) - Method in interface io.debezium.engine.spi.OffsetCommitPolicy

Obtain a new OffsetCommitPolicy that will commit offsets if this policy OR the other requests it.

P

partition() - Method in interface io.debezium.engine.ChangeEvent

parts() - Method in interface io.debezium.spi.schema.DataCollectionId

Get all elements of the data collection.

performCommit(long, Duration) - Method in class io.debezium.engine.spi.OffsetCommitPolicy.AlwaysCommitOffsetPolicy

performCommit(long, Duration) - Method in interface io.debezium.engine.spi.OffsetCommitPolicy

Determine if a commit of the offsets should be performed.

performCommit(long, Duration) - Method in class io.debezium.engine.spi.OffsetCommitPolicy.PeriodicCommitOffsetPolicy

periodic(Properties) - Static method in interface io.debezium.engine.spi.OffsetCommitPolicy

PeriodicCommitOffsetPolicy(Properties) - Constructor for class io.debezium.engine.spi.OffsetCommitPolicy.PeriodicCommitOffsetPolicy

pollingStarted() - Method in interface io.debezium.engine.DebeziumEngine.ConnectorCallback

Called after all the tasks have been successfully started and engine has moved to polling phase, but before actual polling is started.

pollingStopped() - Method in interface io.debezium.engine.DebeziumEngine.ConnectorCallback

Called after all the tasks have successfully exited from the polling loop, i.e. the callback is not called when any of the tasks has thrown exception during polling or was interrupted abruptly.

Protobuf - Class in io.debezium.engine.format

A SerializationFormat defining the Protobuf format serialized as byte[].

Protobuf() - Constructor for class io.debezium.engine.format.Protobuf

R

record() - Method in interface io.debezium.engine.RecordChangeEvent

RecordChangeEvent<V> - Interface in io.debezium.engine

A data change event described as a single object.

recordSchemaPrefix(I) - Method in interface io.debezium.spi.topic.TopicNamingStrategy

register(S, CustomConverter.Converter) - Method in interface io.debezium.spi.converter.CustomConverter.ConverterRegistration

Registers the given schema and converter for the current field.

RelationalColumn - Interface in io.debezium.spi.converter

A definition of a converted relational column.

replace(char) - Method in interface io.debezium.spi.common.ReplacementFunction

Determine the replacement string for the invalid character.

REPLACEMENT_CHAR - Static variable in interface io.debezium.spi.common.ReplacementFunction

ReplacementFunction - Interface in io.debezium.spi.common

Function used to determine the replacement for a character that is not valid per Avro rules.

S

sanitizedTopicName(String) - Method in interface io.debezium.spi.topic.TopicNamingStrategy

Sanitize the given character whether is a legal character of a Kafka topic name.

scale() - Method in interface io.debezium.spi.converter.RelationalColumn

Get the scale of the column.

schemaChangeTopic() - Method in interface io.debezium.spi.topic.TopicNamingStrategy

schemaParts() - Method in interface io.debezium.spi.schema.DataCollectionId

Get a schema list including schema, table name.

SerializationFormat<T> - Interface in io.debezium.engine.format

The logical description of the output format used by the given instance of DebeziumEngine.

serialVersionUID - Static variable in exception class io.debezium.engine.StopEngineException

set(String, Object) - Method in interface io.debezium.engine.DebeziumEngine.Offsets

Associates a key with a specific value, overwrites the value if the key is already present.

shouldSnapshotData(boolean, boolean) - Method in interface io.debezium.spi.snapshot.Snapshotter

shouldSnapshotOnDataError() - Method in interface io.debezium.spi.snapshot.Snapshotter

shouldSnapshotOnSchemaError() - Method in interface io.debezium.spi.snapshot.Snapshotter

shouldSnapshotSchema(boolean, boolean) - Method in interface io.debezium.spi.snapshot.Snapshotter

shouldStream() - Method in interface io.debezium.spi.snapshot.Snapshotter

shouldStreamEventsStartingFromSnapshot() - Method in interface io.debezium.spi.snapshot.Snapshotter

signal(DebeziumEngine.Signal) - Method in interface io.debezium.engine.DebeziumEngine.Signaler

Send a signal to the connector.

Signal(String, String, String, Map<String, Object>) - Constructor for record class io.debezium.engine.DebeziumEngine.Signal

Creates an instance of a Signal record class.

SimpleString - Class in io.debezium.engine.format

A SerializationFormat defining the string format serialized as String

SimpleString() - Constructor for class io.debezium.engine.format.SimpleString

snapshotAborted() - Method in interface io.debezium.spi.snapshot.Snapshotter

Lifecycle hook called after the snapshot phase is aborted.

snapshotCompleted() - Method in interface io.debezium.spi.snapshot.Snapshotter

Lifecycle hook called after the snapshot phase is successful.

Snapshotter - Interface in io.debezium.spi.snapshot

Snapshotter is used to determine the following details about the snapshot process:

StopEngineException - Exception Class in io.debezium.engine

An exception that is used to tell the engine to process the last source record and to then stop.

StopEngineException(String) - Constructor for exception class io.debezium.engine.StopEngineException

supportsTombstoneEvents() - Method in interface io.debezium.engine.DebeziumEngine.ChangeConsumer

Controls whether the change consumer supports processing of tombstone events.

T

taskStarted() - Method in interface io.debezium.engine.DebeziumEngine.ConnectorCallback

Called after a connector task has been successfully started by the engine; i.e.

taskStopped() - Method in interface io.debezium.engine.DebeziumEngine.ConnectorCallback

Called after a connector task has been successfully stopped by the engine; i.e.

TopicNamingStrategy<I> - Interface in io.debezium.spi.topic

An interface that defines the topic naming strategy, including DataChange, SchemaChange, Transaction, Heartbeat events etc.

TopicNamingStrategy.TopicSchemaAugment<S> - Interface in io.debezium.spi.topic

An interface that augments the field to topic key/value schema.

TopicNamingStrategy.TopicValueAugment<I,S,R> - Interface in io.debezium.spi.topic

An interface that augments the field's value to topic key/value.

toString() - Method in record class io.debezium.engine.DebeziumEngine.Signal

Returns a string representation of this record class.

transactionTopic() - Method in interface io.debezium.spi.topic.TopicNamingStrategy

type - Variable in record class io.debezium.engine.DebeziumEngine.Signal

The field for the type record component.

type() - Method in record class io.debezium.engine.DebeziumEngine.Signal

Returns the value of the type record component.

typeExpression() - Method in interface io.debezium.spi.converter.RelationalColumn

Get the database-specific complete expression defining the column's data type, including dimensions, length, precision, character sets, constraints, etc.

typeName() - Method in interface io.debezium.spi.converter.RelationalColumn

Get the database-specific name of the column's data type.

U

UNDERSCORE_REPLACEMENT - Static variable in interface io.debezium.spi.common.ReplacementFunction

using(DebeziumEngine.CompletionCallback) - Method in interface io.debezium.engine.DebeziumEngine.Builder

When the engine's Runnable.run() method completes, call the supplied function with the results.

using(DebeziumEngine.ConnectorCallback) - Method in interface io.debezium.engine.DebeziumEngine.Builder

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)

using(OffsetCommitPolicy) - Method in interface io.debezium.engine.DebeziumEngine.Builder

During the engine's Runnable.run() method, decide when the offsets should be committed into the

invalid reference

OffsetBackingStore

.

using(ClassLoader) - Method in interface io.debezium.engine.DebeziumEngine.Builder

Use the specified class loader to find all necessary classes.

using(Clock) - Method in interface io.debezium.engine.DebeziumEngine.Builder

Use the specified clock when needing to determine the current time.

using(Properties) - Method in interface io.debezium.engine.DebeziumEngine.Builder

Use the specified configuration for the connector.

V

value() - Method in interface io.debezium.engine.ChangeEvent

A B C D E G H I J K L M N O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form