Debezium DB2 Connector

camel.component.debezium-db2.additional-properties

Additional properties for debezium components in case they can’t be set directly on the camel configurations (e.g: setting Kafka Connect properties needed by Debezium engine, for example setting KafkaOffsetBackingStore), the properties have to be prefixed with additionalProperties.. E.g: additionalProperties.transactional.id=12345&additionalProperties.schema.registry.url=http://localhost:8811/avro. This is a multi-value option with prefix: additionalProperties.

Object>

camel.component.debezium-db2.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

Boolean

camel.component.debezium-db2.bridge-error-handler

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.

Boolean

camel.component.debezium-db2.cdc-change-tables-schema

The name of the schema where CDC change tables are located; defaults to 'ASNCDC'

String

camel.component.debezium-db2.cdc-control-schema

The name of the schema where CDC control structures are located; defaults to 'ASNCDC'

String

camel.component.debezium-db2.column-exclude-list

Regular expressions matching columns to exclude from change events

String

camel.component.debezium-db2.column-include-list

Regular expressions matching columns to include in change events

String

camel.component.debezium-db2.column-propagate-source-type

A comma-separated list of regular expressions matching fully-qualified names of columns that adds the columns original type and original length as parameters to the corresponding field schemas in the emitted change records.

String

camel.component.debezium-db2.configuration

Allow pre-configured Configurations to be set. The option is a org.apache.camel.component.debezium.db2.configuration.Db2ConnectorEmbeddedDebeziumConfiguration type.

Db2ConnectorEmbeddedDebeziumConfiguration

camel.component.debezium-db2.connection-validation-timeout-ms

The maximum time in milliseconds to wait for connection validation to complete. Defaults to 60 seconds. The option is a long type.

Long

camel.component.debezium-db2.converters

Optional list of custom converters that would be used instead of default ones. The converters are defined using '.type' config option and configured using options '.'

String

camel.component.debezium-db2.custom-metric-tags

The custom metric tags will accept key-value pairs to customize the MBean object name which should be appended the end of regular name, each key would represent a tag for the MBean object name, and the corresponding value would be the value of that tag the key is. For example: k1=v1,k2=v2

String

camel.component.debezium-db2.custom-sanitize-pattern

Regular expression identifying configuration keys whose values should be masked. When set, this custom pattern replaces Debeziums default password masking pattern.

.*basic.auth.user.info

.*registry.auth.client-secret

.*credentials.json$

camel.component.debezium-db2.database-dbname

The name of the database from which the connector should capture changes

camel.component.debezium-db2.database-hostname

Resolvable hostname or IP address of the database server.

camel.component.debezium-db2.database-password

Password of the database user to be used when connecting to the database.

camel.component.debezium-db2.database-port

Port of the database server.

50000

camel.component.debezium-db2.database-user

Name of the database user to be used when connecting to the database.

camel.component.debezium-db2.datatype-propagate-source-type

A comma-separated list of regular expressions matching the database-specific data type names that adds the data type’s original type and original length as parameters to the corresponding field schemas in the emitted change records.

camel.component.debezium-db2.db2-platform

Informs connector which Db2 implementation platform it is connected to. The default is 'LUW', which means Windows, UNIX, Linux. Using a value of 'Z' ensures that the Db2 for z/OS specific SQL statements are used.

LUW

camel.component.debezium-db2.decimal-handling-mode

Specify how DECIMAL and NUMERIC columns should be represented in change events, including: 'precise' (the default) uses java.math.BigDecimal to represent values, which are encoded in the change events using a binary representation and Kafka Connect’s 'org.apache.kafka.connect.data.Decimal' type; 'string' uses string to represent values; 'double' represents values using Java’s 'double', which may not offer the precision but will be far easier to use in consumers.

precise

camel.component.debezium-db2.enabled

Whether to enable auto configuration of the debezium-db2 component. This is enabled by default.

camel.component.debezium-db2.errors-max-retries

The maximum number of retries on connection errors before failing (-1 = no limit, 0 = disabled, 0 = num of retries).

-1

camel.component.debezium-db2.event-processing-failure-handling-mode

Specify how failures during processing of events (i.e. when encountering a corrupted event) should be handled, including: 'fail' (the default) an exception indicating the problematic event and its position is raised, causing the connector to be stopped; 'warn' the problematic event and its position will be logged and the event will be skipped; 'ignore' the problematic event will be skipped.

fail

camel.component.debezium-db2.executor-shutdown-timeout-ms

The maximum time in milliseconds to wait for task executor to shut down. The option is a long type.

4000

camel.component.debezium-db2.extended-headers-enabled

Enable/Disable Debezium context headers that provides essential metadata for tracking and identifying the source of CDC events in downstream processing systems.

true

camel.component.debezium-db2.guardrail-collections-limit-action

Specify the action to take when a guardrail collections limit is exceeded: 'warn' (the default) logs a warning message and continues processing; 'fail' stops the connector with an error.

warn

camel.component.debezium-db2.guardrail-collections-max

The maximum number of collections or tables that can be captured by the connector. When this limit is exceeded, the action specified by 'guardrail.collections.limit.action' will be taken. Set to 0 to disable this guardrail.

0

camel.component.debezium-db2.heartbeat-interval-ms

Length of an interval in milli-seconds in in which the connector periodically sends heartbeat messages to a heartbeat topic. Use 0 to disable heartbeat messages. Disabled by default. The option is a int type.

0

camel.component.debezium-db2.heartbeat-topics-prefix

The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat.

__debezium-heartbeat

camel.component.debezium-db2.include-schema-changes

Whether the connector should publish changes in the database schema to a Kafka topic with the same name as the database server ID. Each schema change will be recorded using a key that contains the database name and whose value include logical description of the new schema and optionally the DDL statement(s). The default is 'true'. This is independent of how the connector internally records database schema history.

true

camel.component.debezium-db2.incremental-snapshot-chunk-size

The maximum size of chunk (number of documents/rows) for incremental snapshotting

1024

camel.component.debezium-db2.incremental-snapshot-watermarking-strategy

Specify the strategy used for watermarking during an incremental snapshot: 'insert_insert' both open and close signal is written into signal data collection (default); 'insert_delete' only open signal is written on signal data collection, the close will delete the relative open signal;

INSERT_INSERT

camel.component.debezium-db2.internal-key-converter

The Converter class that should be used to serialize and deserialize key data for offsets. The default is JSON converter.

org.apache.kafka.connect.json.JsonConverter

camel.component.debezium-db2.internal-value-converter

The Converter class that should be used to serialize and deserialize value data for offsets. The default is JSON converter.

org.apache.kafka.connect.json.JsonConverter

camel.component.debezium-db2.max-batch-size

Maximum size of each batch of source records. Defaults to 2048.

2048

camel.component.debezium-db2.max-queue-size

Maximum size of the queue for change events read from the database log but not yet recorded or forwarded. Defaults to 8192, and should always be larger than the maximum batch size.

8192

camel.component.debezium-db2.max-queue-size-in-bytes

Maximum size of the queue in bytes for change events read from the database log but not yet recorded or forwarded. Defaults to 0. Mean the feature is not enabled

0

camel.component.debezium-db2.message-key-columns

A semicolon-separated list of expressions that match fully-qualified tables and column(s) to be used as message key. Each expression must match the pattern ':', where the table names could be defined as (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on the specific connector, and the key columns are a comma-separated list of columns representing the custom key. For any table without an explicit key configuration the table’s primary key column(s) will be used as message key. Example: dbserver1.inventory.orderlines:orderId,orderLineId;dbserver1.inventory.orders:id

camel.component.debezium-db2.notification-enabled-channels

List of notification channels names that are enabled.

camel.component.debezium-db2.notification-sink-topic-name

The name of the topic for the notifications. This is required in case 'sink' is in the list of enabled channels

camel.component.debezium-db2.offset-commit-policy

The name of the Java class of the commit policy. It defines when offsets commit has to be triggered based on the number of events processed and the time elapsed since the last commit. This class must implement the interface 'OffsetCommitPolicy'. The default is a periodic commit policy based upon time intervals.

camel.component.debezium-db2.offset-commit-timeout-ms

Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt. The default is 5 seconds. The option is a long type.

5000

camel.component.debezium-db2.offset-flush-interval-ms

Interval at which to try committing offsets. The default is 1 minute. The option is a long type.

60000

camel.component.debezium-db2.offset-storage

The name of the Java class that is responsible for persistence of connector offsets.

org.apache.kafka.connect.storage.FileOffsetBackingStore

camel.component.debezium-db2.offset-storage-file-name

Path to file where offsets are to be stored. Required when offset.storage is set to the FileOffsetBackingStore.

camel.component.debezium-db2.offset-storage-partitions

The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'.

camel.component.debezium-db2.offset-storage-replication-factor

Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore

camel.component.debezium-db2.offset-storage-topic

The name of the Kafka topic where offsets are to be stored. Required when offset.storage is set to the KafkaOffsetBackingStore.

camel.component.debezium-db2.openlineage-integration-config-file-path

Path to OpenLineage file configuration. See https://openlineage.io/docs/client/java/configuration

./openlineage.yml

camel.component.debezium-db2.openlineage-integration-dataset-kafka-bootstrap-servers

The Kafka bootstrap server address used as input/output namespace/

camel.component.debezium-db2.openlineage-integration-enabled

Enable Debezium to emit data lineage metadata through OpenLineage API

false

camel.component.debezium-db2.openlineage-integration-job-description

The job’s description emitted by Debezium

Debezium change data capture job

camel.component.debezium-db2.openlineage-integration-job-namespace

The job’s namespace emitted by Debezium

camel.component.debezium-db2.openlineage-integration-job-owners

The job’s owners emitted by Debezium. A comma-separated list of key-value pairs.For example: k1=v1,k2=v2

camel.component.debezium-db2.openlineage-integration-job-tags

The job’s tags emitted by Debezium. A comma-separated list of key-value pairs.For example: k1=v1,k2=v2

camel.component.debezium-db2.poll-interval-ms

Time to wait for new change events to appear after receiving no events, given in milliseconds. Defaults to 500 ms. The option is a long type.

500

camel.component.debezium-db2.post-processors

Optional list of post processors. The processors are defined using '.type' config option and configured using options ''

camel.component.debezium-db2.provide-transaction-metadata

Enables transaction metadata extraction together with event counting

false

camel.component.debezium-db2.query-fetch-size

The maximum number of records that should be loaded into memory while streaming. A value of '0' uses the default JDBC fetch size. The default value is '10000'.

10000

camel.component.debezium-db2.retriable-restart-connector-wait-ms

Time to wait before restarting connector after retriable exception occurs. Defaults to 10000ms. The option is a long type.

10000

camel.component.debezium-db2.schema-history-internal

The name of the SchemaHistory class that should be used to store and recover database schema changes. The configuration properties for the history are prefixed with the 'schema.history.internal.' string.

io.debezium.storage.kafka.history.KafkaSchemaHistory

camel.component.debezium-db2.schema-history-internal-file-filename

The path to the file that will be used to record the database schema history

camel.component.debezium-db2.schema-history-internal-skip-unparseable-ddl

Controls the action Debezium will take when it meets a DDL statement in binlog, that it cannot parse.By default the connector will stop operating but by changing the setting it can ignore the statements which it cannot parse. If skipping is enabled then Debezium can miss metadata changes.

false

camel.component.debezium-db2.schema-history-internal-store-only-captured-databases-ddl

Controls what DDL will Debezium store in database schema history. By default (false) Debezium will store all incoming DDL statements. If set to true, then only DDL that manipulates a table from captured schema/database will be stored.

false

camel.component.debezium-db2.schema-history-internal-store-only-captured-tables-ddl

Controls what DDL will Debezium store in database schema history. By default (false) Debezium will store all incoming DDL statements. If set to true, then only DDL that manipulates a captured table will be stored.

false

camel.component.debezium-db2.schema-name-adjustment-mode

Specify how schema names should be adjusted for compatibility with the message converter used by the connector, including: 'avro' replaces the characters that cannot be used in the Avro type name with underscore; 'avro_unicode' replaces the underscore or characters that cannot be used in the Avro type name with corresponding unicode like _uxxxx. Note: _ is an escape sequence like backslash in Java;'none' does not apply any adjustment (default)

none

camel.component.debezium-db2.signal-data-collection

The name of the data collection that is used to send signals/commands to Debezium. For multi-partition mode connectors, multiple signal data collections can be specified as a comma-separated list. Signaling is disabled when not set.

camel.component.debezium-db2.signal-enabled-channels

List of channels names that are enabled. Source channel is enabled by default

source

camel.component.debezium-db2.signal-poll-interval-ms

Interval for looking for new signals in registered channels, given in milliseconds. Defaults to 5 seconds. The option is a long type.

5000

camel.component.debezium-db2.skipped-operations

The comma-separated list of operations to skip during streaming, defined as: 'c' for inserts/create; 'u' for updates; 'd' for deletes, 't' for truncates, and 'none' to indicate nothing skipped. By default, only truncate operations will be skipped.

t

camel.component.debezium-db2.snapshot-delay-ms

A delay period before a snapshot will begin, given in milliseconds. Defaults to 0 ms. The option is a long type.

0

camel.component.debezium-db2.snapshot-fetch-size

The maximum number of records that should be loaded into memory while performing a snapshot.

camel.component.debezium-db2.snapshot-include-collection-list

This setting must be set to specify a list of tables/collections whose snapshot must be taken on creating or restarting the connector.

camel.component.debezium-db2.snapshot-lock-timeout-ms

The maximum number of millis to wait for table locks at the beginning of a snapshot. If locks cannot be acquired in this time frame, the snapshot will be aborted. Defaults to 10 seconds. The option is a long type.

10000

camel.component.debezium-db2.snapshot-max-threads-multiplier

The factor used to scale the number of snapshot chunks per table. The default behavior is to take 'row_count/snapshot.max.threads' to compute the number of rows per chunks. This may not be ideal for larger tables, and using the multiplier, the formula is adjusted to increase the number of chunks by using 'row_count/(snapshot.max.threads snapshot.max.threads.multiplier).

1

camel.component.debezium-db2.snapshot-mode

The criteria for running a snapshot upon startup of the connector. Options include: 'initial' (the default) to specify the connector should run a snapshot only when no offsets are available for the logical server name; 'schema_only' to specify the connector should run a snapshot of the schema when no offsets are available for the logical server name.

initial

camel.component.debezium-db2.snapshot-mode-configuration-based-snapshot-data

When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not.

false

camel.component.debezium-db2.snapshot-mode-configuration-based-snapshot-on-data-error

When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not in case of error.

false

camel.component.debezium-db2.snapshot-mode-configuration-based-snapshot-on-schema-error

When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not in case of error.

false

camel.component.debezium-db2.snapshot-mode-configuration-based-snapshot-schema

When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not.

false

camel.component.debezium-db2.snapshot-mode-configuration-based-start-stream

When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the stream should start or not after snapshot.

false

camel.component.debezium-db2.snapshot-mode-custom-name

When 'snapshot.mode' is set as custom, this setting must be set to specify a the name of the custom implementation provided in the 'name()' method. The implementations must implement the 'Snapshotter' interface and is called on each app boot to determine whether to do a snapshot.

camel.component.debezium-db2.snapshot-select-statement-overrides

This property contains a comma-separated list of fully-qualified tables (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on the specific connectors. Select statements for the individual tables are specified in further configuration properties, one for each table, identified by the id 'snapshot.select.statement.overrides.DB_NAME.TABLE_NAME' or 'snapshot.select.statement.overrides.SCHEMA_NAME.TABLE_NAME', respectively. The value of those properties is the select statement to use when retrieving data from the specific table during snapshotting. A possible use case for large append-only tables is setting a specific point where to start (resume) snapshotting, in case a previous snapshotting was interrupted.

camel.component.debezium-db2.snapshot-tables-order-by-row-count

Controls the order in which tables are processed in the initial snapshot. A descending value will order the tables by row count descending. A ascending value will order the tables by row count ascending. A value of disabled (the default) will disable ordering by row count.

disabled

camel.component.debezium-db2.sourceinfo-struct-maker

The name of the SourceInfoStructMaker class that returns SourceInfo schema and struct.

io.debezium.connector.db2.Db2SourceInfoStructMaker

camel.component.debezium-db2.streaming-delay-ms

A delay period after the snapshot is completed and the streaming begins, given in milliseconds. Defaults to 0 ms. The option is a long type.

0

camel.component.debezium-db2.table-exclude-list

A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring

camel.component.debezium-db2.table-ignore-builtin

Flag specifying whether built-in tables should be ignored.

true

camel.component.debezium-db2.table-include-list

The tables for which changes are to be captured

camel.component.debezium-db2.time-precision-mode

Time, date, and timestamps can be represented with different kinds of precisions, including: 'adaptive' (the default) bases the precision of time, date, and timestamp values on the database column’s precision; 'adaptive_time_microseconds' like 'adaptive' mode, but TIME fields always use microseconds precision; 'connect' always represents time, date, and timestamp values using Kafka Connect’s built-in representations for Time, Date, and Timestamp, which uses millisecond precision regardless of the database columns' precision.

adaptive

camel.component.debezium-db2.tombstones-on-delete

Whether delete operations should be represented by a delete event and a subsequent tombstone event (true) or only by a delete event (false). Emitting the tombstone event (the default behavior) allows Kafka to completely delete all events pertaining to the given key once the source record got deleted.

false

camel.component.debezium-db2.topic-naming-strategy

The name of the TopicNamingStrategy class that should be used to determine the topic name for data change, schema change, transaction, heartbeat event etc.

io.debezium.schema.SchemaTopicNamingStrategy

camel.component.debezium-db2.topic-prefix

Topic prefix that identifies and provides a namespace for the particular database server/cluster is capturing changes. The topic prefix should be unique across all other connectors, since it is used as a prefix for all Kafka topic names that receive events emitted by this connector. Only alphanumeric characters, hyphens, dots and underscores must be accepted.

camel.component.debezium-db2.transaction-metadata-factory