Debezium MySQL Connector
Since Camel 3.0
Only consumer is supported
The Debezium MySQL component is wrapper around Debezium using Debezium Engine, which enables Change Data Capture from MySQL database using Debezium without the need for Kafka or Kafka Connect.
Note on handling failures: Per Debezium Embedded Engine documentation, the engines is actively recording source offsets and periodically flushes these offsets to a persistent storage, so when the application is restarted or crashed, the engine will resume from the last recorded offset. Thus, at normal operation, your downstream routes will receive each event exactly once, however in case of an application crash (not having a graceful shutdown), the application will resume from the last recorded offset, which may result in receiving duplicate events immediately after the restart. Therefore, your downstream routes should be tolerant enough of such case and deduplicate events if needed.
Maven users will need to add the following dependency to their pom.xml
for this component.
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-debezium-mysql</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>URI format
debezium-mysql:name[?options]
Note: Due to licensing issues, you will need to add the dependency for mysql-connector-java if you are using MySQL connector, just add the following to your POM file:
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.15</version>
</dependency>Configuring Options
Camel components are configured on two separate levels:
-
component level
-
endpoint level
Configuring Component Options
The component level is the highest level which holds general and common configurations that are inherited by the endpoints. For example a component may have security settings, credentials for authentication, urls for network connection and so forth.
Some components only have a few options, and others may have many. Because components typically have pre configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.
Configuring components can be done with the Component DSL, in a configuration file (application.properties|yaml), or directly with Java code.
Configuring Endpoint Options
Where you find yourself configuring the most is on endpoints, as endpoints often have many options, which allows you to configure what you need the endpoint to do. The options are also categorized into whether the endpoint is used as consumer (from) or as a producer (to), or used for both.
Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL as a type safe way of configuring endpoints.
A good practice when configuring options is to use Property Placeholders, which allows to not hardcode urls, port numbers, sensitive information, and other settings. In other words placeholders allows to externalize the configuration from your code, and gives more flexibility and reuse.
The following two sections lists all the options, firstly for the component followed by the endpoint.
Component Options
The Debezium MySQL Connector component supports 100 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
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. |
Map |
||
Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. 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. |
false |
boolean |
|
Allow pre-configured Configurations to be set. |
MySqlConnectorEmbeddedDebeziumConfiguration |
||
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 |
String |
|
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 |
String |
|
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. |
String |
||
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. |
5000 |
long |
|
Interval at which to try committing offsets. The default is 1 minute. |
60000 |
long |
|
The name of the Java class that is responsible for persistence of connector offsets. |
org.apache.kafka.connect.storage.FileOffsetBackingStore |
String |
|
Path to file where offsets are to be stored. Required when offset.storage is set to the FileOffsetBackingStore. |
String |
||
The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'. |
int |
||
Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore. |
int |
||
The name of the Kafka topic where offsets are to be stored. Required when offset.storage is set to the KafkaOffsetBackingStore. |
String |
||
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. |
true |
boolean |
|
Specify how BIGINT UNSIGNED columns should be represented in change events, including:'precise' 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; 'long' (the default) represents values using Java’s 'long', which may not offer the precision but will be far easier to use in consumers. |
long |
String |
|
Specify how binary (blob, binary, etc.) columns should be represented in change events, including:'bytes' represents binary data as byte array (default)'base64' represents binary data as base64-encoded string’hex' represents binary data as hex-encoded (base16) string. |
bytes |
String |
|
The size of a look-ahead buffer used by the binlog reader to decide whether the transaction in progress is going to be committed or rolled back. Use 0 to disable look-ahead buffering. Defaults to 0 (i.e. buffering is disabled). |
0 |
int |
|
Regular expressions matching columns to exclude from change events (deprecated, use column.exclude.list instead). |
String |
||
Regular expressions matching columns to exclude from change events. |
String |
||
Regular expressions matching columns to include in change events. |
String |
||
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 |
||
Regular expressions matching columns to include in change events (deprecated, use column.include.list instead). |
String |
||
Whether a separate thread should be used to ensure the connection is kept alive. |
true |
boolean |
|
Interval for connection checking if keep alive thread is used, given in milliseconds Defaults to 1 minute (60,000 ms). |
1m |
long |
|
Maximum time to wait after trying to connect to the database before timing out, given in milliseconds. Defaults to 30 seconds (30,000 ms). |
30s |
int |
|
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 |
||
A comma-separated list of regular expressions that match database names to be excluded from monitoring. |
String |
||
The name of the DatabaseHistory class that should be used to store and recover database schema changes. The configuration properties for the history are prefixed with the 'database.history.' string. |
io.debezium.relational.history.FileDatabaseHistory |
String |
|
The path to the file that will be used to record the database history. |
String |
||
A list of host/port pairs that the connector will use for establishing the initial connection to the Kafka cluster for retrieving database schema history previously stored by the connector. This should point to the same Kafka cluster used by the Kafka Connect process. |
String |
||
The number of milliseconds to wait while fetching cluster information using Kafka admin client. |
3s |
long |
|
The number of attempts in a row that no data are returned from Kafka before recover completes. The maximum amount of time to wait after receiving no data is (recovery.attempts) x (recovery.poll.interval.ms). |
100 |
int |
|
The number of milliseconds to wait while polling for persisted data during recovery. |
100ms |
int |
|
The name of the topic for the database schema history. |
String |
||
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 |
boolean |
|
Controls what DDL will Debezium store in database 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 |
boolean |
|
Controls what DDL will Debezium store in database history. By default (false) Debezium will store all incoming DDL statements. If set to true, then only DDL that manipulates a monitored table will be stored (deprecated, use database.history.store.only.captured.tables.ddl instead). |
false |
boolean |
|
Resolvable hostname or IP address of the database server. |
String |
||
The databases for which changes are to be captured. |
String |
||
A semicolon separated list of SQL statements to be executed when a JDBC connection (not binlog reading connection) to the database is established. Note that the connector may establish JDBC connections at its own discretion, so this should typically be used for configuration of session parameters only,but not for executing DML statements. Use doubled semicolon (';;') to use a semicolon as a character and not as a delimiter. |
String |
||
JDBC Driver class name used to connect to the MySQL database server. |
com.mysql.cj.jdbc.Driver |
String |
|
Required Password of the database user to be used when connecting to the database. |
String |
||
Port of the database server. |
3306 |
int |
|
A numeric ID of this database client, which must be unique across all currently-running database processes in the cluster. This connector joins the MySQL database cluster as another server (with this unique ID) so it can read the binlog. By default, a random number is generated between 5400 and 6400. |
long |
||
Only relevant if parallel snapshotting is configured. During parallel snapshotting, multiple (4) connections open to the database client, and they each need their own unique connection ID. This offset is used to generate those IDs from the base configured cluster ID. |
10000 |
long |
|
Required Unique name that identifies the database server and all recorded offsets, and that is used as a prefix for all schemas and topics. Each distinct installation should have a separate namespace and be monitored by at most one Debezium connector. |
String |
||
The location of the key store file. This is optional and can be used for two-way authentication between the client and the MySQL Server. |
String |
||
The password for the key store file. This is optional and only needed if 'database.ssl.keystore' is configured. |
String |
||
Whether to use an encrypted connection to MySQL. Options include’disabled' (the default) to use an unencrypted connection; 'preferred' to establish a secure (encrypted) connection if the server supports secure connections, but fall back to an unencrypted connection otherwise; 'required' to use a secure (encrypted) connection, and fail if one cannot be established; 'verify_ca' like 'required' but additionally verify the server TLS certificate against the configured Certificate Authority (CA) certificates, or fail if no valid matching CA certificates are found; or’verify_identity' like 'verify_ca' but additionally verify that the server certificate matches the host to which the connection is attempted. |
disabled |
String |
|
The location of the trust store file for the server certificate verification. |
String |
||
The password for the trust store file. Used to check the integrity of the truststore, and unlock the truststore. |
String |
||
Name of the database user to be used when connecting to the database. |
String |
||
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. |
String |
||
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 |
String |
|
MySQL allows user to insert year value as either 2-digit or 4-digit. In case of two digit the value is automatically mapped into 1970 - 2069.false - delegates the implicit conversion to the databasetrue - (the default) Debezium makes the conversion. |
true |
boolean |
|
Specify how failures during deserialization of binlog events (i.e. when encountering a corrupted event) should be handled, including:'fail' (the default) an exception indicating the problematic event and its binlog position is raised, causing the connector to be stopped; 'warn' the problematic event and its binlog position will be logged and the event will be skipped;'ignore' the problematic event will be skipped. |
fail |
String |
|
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 |
String |
|
The source UUIDs used to exclude GTID ranges when determine the starting position in the MySQL server’s binlog. |
String |
||
If set to true, we will only produce DML events into Kafka for transactions that were written on mysql servers with UUIDs matching the filters defined by the gtid.source.includes or gtid.source.excludes configuration options, if they are specified. |
true |
boolean |
|
The source UUIDs used to include GTID ranges when determine the starting position in the MySQL server’s binlog. |
String |
||
The query executed with every heartbeat. |
String |
||
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. |
0ms |
int |
|
The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat. |
__debezium-heartbeat |
String |
|
Whether the connector should include the original SQL query that generated the change event. Note: This option requires MySQL be configured with the binlog_rows_query_log_events option set to ON. Query will not be present for events generated from snapshot. WARNING: Enabling this option may expose tables or fields explicitly blacklisted or masked by including the original SQL statement in the change event. For this reason the default value is 'false'. |
false |
boolean |
|
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 history. |
true |
boolean |
|
Whether the connector parse table and column’s comment to metadata object.Note: Enable this option will bring the implications on memory usage. The number and size of ColumnImpl objects is what largely impacts how much memory is consumed by the Debezium connectors, and adding a String to each of them can potentially be quite heavy. The default is 'false'. |
false |
boolean |
|
Specify how binlog events that belong to a table missing from internal schema representation (i.e. internal representation is not consistent with database) should be handled, including:'fail' (the default) an exception indicating the problematic event and its binlog position is raised, causing the connector to be stopped; 'warn' the problematic event and its binlog position will be logged and the event will be skipped;'skip' the problematic event will be skipped. |
fail |
String |
|
Detect schema change during an incremental snapshot and re-select a current chunk to avoid locking DDLs. Note that changes to a primary key are not supported and can cause incorrect results if performed during an incremental snapshot. Another limitation is that if a schema change affects only columns' default values, then the change won’t be detected until the DDL is processed from the binlog stream. This doesn’t affect the snapshot events' values, but the schema of snapshot events may have outdated defaults. |
false |
boolean |
|
The maximum size of chunk for incremental snapshotting. |
1024 |
int |
|
Maximum size of each batch of source records. Defaults to 2048. |
2048 |
int |
|
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 |
int |
|
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 |
long |
|
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. |
String |
||
The number of rows a table must contain to stream results rather than pull all into memory during snapshots. Defaults to 1,000. Use 0 to stream all results and completely avoid checking the size of each table. |
1000 |
int |
|
Time to wait for new change events to appear after receiving no events, given in milliseconds. Defaults to 500 ms. |
500ms |
long |
|
Enables transaction metadata extraction together with event counting. |
false |
boolean |
|
The maximum number of records that should be loaded into memory while streaming. A value of 0 uses the default JDBC fetch size. |
0 |
int |
|
Time to wait before restarting connector after retriable exception occurs. Defaults to 10000ms. |
10s |
long |
|
Whether field names will be sanitized to Avro naming conventions. |
false |
boolean |
|
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 (default)'none' does not apply any adjustment. |
avro |
String |
|
The name of the data collection that is used to send signals/commands to Debezium. Signaling is disabled when not set. |
String |
||
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, no operations will be skipped. |
String |
||
A delay period before a snapshot will begin, given in milliseconds. Defaults to 0 ms. |
0ms |
long |
|
The maximum number of records that should be loaded into memory while performing a snapshot. |
int |
||
this setting must be set to specify a list of tables/collections whose snapshot must be taken on creating or restarting the connector. |
String |
||
Controls how long the connector holds onto the global read lock while it is performing a snapshot. The default is 'minimal', which means the connector holds the global read lock (and thus prevents any updates) for just the initial portion of the snapshot while the database schemas and other metadata are being read. The remaining work in a snapshot involves selecting all rows from each table, and this can be done using the snapshot process' REPEATABLE READ transaction even when the lock is no longer held and other operations are updating the database. However, in some cases it may be desirable to block all writes for the entire duration of the snapshot; in such cases set this property to 'extended'. Using a value of 'none' will prevent the connector from acquiring any table locks during the snapshot process. This mode can only be used in combination with snapshot.mode values of 'schema_only' or 'schema_only_recovery' and is only safe to use if no schema changes are happening while the snapshot is taken. |
minimal |
String |
|
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. |
10s |
long |
|
The maximum number of threads used to perform the snapshot. Defaults to 1. |
1 |
int |
|
The criteria for running a snapshot upon startup of the connector. Options include: 'when_needed' to specify that the connector run a snapshot upon startup whenever it deems it necessary; 'schema_only' to only take a snapshot of the schema (table structures) but no actual data; 'initial' (the default) to specify the connector can run a snapshot only when no offsets are available for the logical server name; 'initial_only' same as 'initial' except the connector should stop after completing the snapshot and before it would normally read the binlog; and’never' to specify the connector should never run a snapshot and that upon first startup the connector should read from the beginning of the binlog. The 'never' mode should be used with care, and only when the binlog is known to contain all history. |
initial |
String |
|
BETA FEATURE: On connector restart, the connector will check if there have been any new tables added to the configuration, and snapshot them. There is presently only two options:'off': Default behavior. Do not snapshot new tables.'parallel': The snapshot of the new tables will occur in parallel to the continued binlog reading of the old tables. When the snapshot completes, an independent binlog reader will begin reading the events for the new tables until it catches up to present time. At this point, both old and new binlog readers will be momentarily halted and new binlog reader will start that will read the binlog for all configured tables. The parallel binlog reader will have a configured server id of 10000 the primary binlog reader’s server id. |
off |
String |
|
This property contains a comma-separated list of fully-qualified tables (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on thespecific 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. |
String |
||
A version of the format of the publicly visible source part in the message. |
v2 |
String |
|
A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring (deprecated, use table.exclude.list instead). |
String |
||
A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring. |
String |
||
Flag specifying whether built-in tables should be ignored. |
true |
boolean |
|
The tables for which changes are to be captured. |
String |
||
The tables for which changes are to be captured (deprecated, use table.include.list instead). |
String |
||
Time, date and timestamps can be represented with different kinds of precisions, including:'adaptive_time_microseconds': the precision of date and timestamp values is based the database column’s precision; 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_time_microseconds |
String |
|
Whether delete operations should be represented by a delete event and a subsquenttombstone 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 |
boolean |
|
The name of the transaction metadata topic. The placeholder $\{database.server.name} can be used for referring to the connector’s logical name; defaults to $\{database.server.name}.transaction. |
${database.server.name}.transaction |
String |
Endpoint Options
The Debezium MySQL Connector endpoint is configured using URI syntax:
debezium-mysql:name
with the following path and query parameters:
Query Parameters (100 parameters)
| Name | Description | Default | Type |
|---|---|---|---|
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. |
Map |
||
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 |
String |
|
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 |
String |
|
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. |
String |
||
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. |
5000 |
long |
|
Interval at which to try committing offsets. The default is 1 minute. |
60000 |
long |
|
The name of the Java class that is responsible for persistence of connector offsets. |
org.apache.kafka.connect.storage.FileOffsetBackingStore |
String |
|
Path to file where offsets are to be stored. Required when offset.storage is set to the FileOffsetBackingStore. |
String |
||
The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'. |
int |
||
Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore. |
int |
||
The name of the Kafka topic where offsets are to be stored. Required when offset.storage is set to the KafkaOffsetBackingStore. |
String |
||
Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. 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. |
false |
boolean |
|
To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. |
ExceptionHandler |
||
Sets the exchange pattern when the consumer creates an exchange. Enum values:
|
ExchangePattern |
||
Specify how BIGINT UNSIGNED columns should be represented in change events, including:'precise' 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; 'long' (the default) represents values using Java’s 'long', which may not offer the precision but will be far easier to use in consumers. |
long |
String |
|
Specify how binary (blob, binary, etc.) columns should be represented in change events, including:'bytes' represents binary data as byte array (default)'base64' represents binary data as base64-encoded string’hex' represents binary data as hex-encoded (base16) string. |
bytes |
String |
|
The size of a look-ahead buffer used by the binlog reader to decide whether the transaction in progress is going to be committed or rolled back. Use 0 to disable look-ahead buffering. Defaults to 0 (i.e. buffering is disabled). |
0 |
int |
|
Regular expressions matching columns to exclude from change events (deprecated, use column.exclude.list instead). |
String |
||
Regular expressions matching columns to exclude from change events. |
String |
||
Regular expressions matching columns to include in change events. |
String |
||
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 |
||
Regular expressions matching columns to include in change events (deprecated, use column.include.list instead). |
String |
||
Whether a separate thread should be used to ensure the connection is kept alive. |
true |
boolean |
|
Interval for connection checking if keep alive thread is used, given in milliseconds Defaults to 1 minute (60,000 ms). |
1m |
long |
|
Maximum time to wait after trying to connect to the database before timing out, given in milliseconds. Defaults to 30 seconds (30,000 ms). |
30s |
int |
|
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 |
||
A comma-separated list of regular expressions that match database names to be excluded from monitoring. |
String |
||
The name of the DatabaseHistory class that should be used to store and recover database schema changes. The configuration properties for the history are prefixed with the 'database.history.' string. |
io.debezium.relational.history.FileDatabaseHistory |
String |
|
The path to the file that will be used to record the database history. |
String |
||
A list of host/port pairs that the connector will use for establishing the initial connection to the Kafka cluster for retrieving database schema history previously stored by the connector. This should point to the same Kafka cluster used by the Kafka Connect process. |
String |
||
The number of milliseconds to wait while fetching cluster information using Kafka admin client. |
3s |
long |
|
The number of attempts in a row that no data are returned from Kafka before recover completes. The maximum amount of time to wait after receiving no data is (recovery.attempts) x (recovery.poll.interval.ms). |
100 |
int |
|
The number of milliseconds to wait while polling for persisted data during recovery. |
100ms |
int |
|
The name of the topic for the database schema history. |
String |
||
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 |
boolean |
|
Controls what DDL will Debezium store in database 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 |
boolean |
|
Controls what DDL will Debezium store in database history. By default (false) Debezium will store all incoming DDL statements. If set to true, then only DDL that manipulates a monitored table will be stored (deprecated, use database.history.store.only.captured.tables.ddl instead). |
false |
boolean |
|
Resolvable hostname or IP address of the database server. |
String |
||
The databases for which changes are to be captured. |
String |
||
A semicolon separated list of SQL statements to be executed when a JDBC connection (not binlog reading connection) to the database is established. Note that the connector may establish JDBC connections at its own discretion, so this should typically be used for configuration of session parameters only,but not for executing DML statements. Use doubled semicolon (';;') to use a semicolon as a character and not as a delimiter. |
String |
||
JDBC Driver class name used to connect to the MySQL database server. |
com.mysql.cj.jdbc.Driver |
String |
|
Required Password of the database user to be used when connecting to the database. |
String |
||
Port of the database server. |
3306 |
int |
|
A numeric ID of this database client, which must be unique across all currently-running database processes in the cluster. This connector joins the MySQL database cluster as another server (with this unique ID) so it can read the binlog. By default, a random number is generated between 5400 and 6400. |
long |
||
Only relevant if parallel snapshotting is configured. During parallel snapshotting, multiple (4) connections open to the database client, and they each need their own unique connection ID. This offset is used to generate those IDs from the base configured cluster ID. |
10000 |
long |
|
Required Unique name that identifies the database server and all recorded offsets, and that is used as a prefix for all schemas and topics. Each distinct installation should have a separate namespace and be monitored by at most one Debezium connector. |
String |
||
The location of the key store file. This is optional and can be used for two-way authentication between the client and the MySQL Server. |
String |
||
The password for the key store file. This is optional and only needed if 'database.ssl.keystore' is configured. |
String |
||
Whether to use an encrypted connection to MySQL. Options include’disabled' (the default) to use an unencrypted connection; 'preferred' to establish a secure (encrypted) connection if the server supports secure connections, but fall back to an unencrypted connection otherwise; 'required' to use a secure (encrypted) connection, and fail if one cannot be established; 'verify_ca' like 'required' but additionally verify the server TLS certificate against the configured Certificate Authority (CA) certificates, or fail if no valid matching CA certificates are found; or’verify_identity' like 'verify_ca' but additionally verify that the server certificate matches the host to which the connection is attempted. |
disabled |
String |
|
The location of the trust store file for the server certificate verification. |
String |
||
The password for the trust store file. Used to check the integrity of the truststore, and unlock the truststore. |
String |
||
Name of the database user to be used when connecting to the database. |
String |
||
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. |
String |
||
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 |
String |
|
MySQL allows user to insert year value as either 2-digit or 4-digit. In case of two digit the value is automatically mapped into 1970 - 2069.false - delegates the implicit conversion to the databasetrue - (the default) Debezium makes the conversion. |
true |
boolean |
|
Specify how failures during deserialization of binlog events (i.e. when encountering a corrupted event) should be handled, including:'fail' (the default) an exception indicating the problematic event and its binlog position is raised, causing the connector to be stopped; 'warn' the problematic event and its binlog position will be logged and the event will be skipped;'ignore' the problematic event will be skipped. |
fail |
String |
|
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 |
String |
|
The source UUIDs used to exclude GTID ranges when determine the starting position in the MySQL server’s binlog. |
String |
||
If set to true, we will only produce DML events into Kafka for transactions that were written on mysql servers with UUIDs matching the filters defined by the gtid.source.includes or gtid.source.excludes configuration options, if they are specified. |
true |
boolean |
|
The source UUIDs used to include GTID ranges when determine the starting position in the MySQL server’s binlog. |
String |
||
The query executed with every heartbeat. |
String |
||
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. |
0ms |
int |
|
The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat. |
__debezium-heartbeat |
String |
|
Whether the connector should include the original SQL query that generated the change event. Note: This option requires MySQL be configured with the binlog_rows_query_log_events option set to ON. Query will not be present for events generated from snapshot. WARNING: Enabling this option may expose tables or fields explicitly blacklisted or masked by including the original SQL statement in the change event. For this reason the default value is 'false'. |
false |
boolean |
|
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 history. |
true |
boolean |
|
Whether the connector parse table and column’s comment to metadata object.Note: Enable this option will bring the implications on memory usage. The number and size of ColumnImpl objects is what largely impacts how much memory is consumed by the Debezium connectors, and adding a String to each of them can potentially be quite heavy. The default is 'false'. |
false |
boolean |
|
Specify how binlog events that belong to a table missing from internal schema representation (i.e. internal representation is not consistent with database) should be handled, including:'fail' (the default) an exception indicating the problematic event and its binlog position is raised, causing the connector to be stopped; 'warn' the problematic event and its binlog position will be logged and the event will be skipped;'skip' the problematic event will be skipped. |
fail |
String |
|
Detect schema change during an incremental snapshot and re-select a current chunk to avoid locking DDLs. Note that changes to a primary key are not supported and can cause incorrect results if performed during an incremental snapshot. Another limitation is that if a schema change affects only columns' default values, then the change won’t be detected until the DDL is processed from the binlog stream. This doesn’t affect the snapshot events' values, but the schema of snapshot events may have outdated defaults. |
false |
boolean |
|
The maximum size of chunk for incremental snapshotting. |
1024 |
int |
|
Maximum size of each batch of source records. Defaults to 2048. |
2048 |
int |
|
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 |
int |
|
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 |
long |
|
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. |
String |
||
The number of rows a table must contain to stream results rather than pull all into memory during snapshots. Defaults to 1,000. Use 0 to stream all results and completely avoid checking the size of each table. |
1000 |
int |
|
Time to wait for new change events to appear after receiving no events, given in milliseconds. Defaults to 500 ms. |
500ms |
long |
|
Enables transaction metadata extraction together with event counting. |
false |
boolean |
|
The maximum number of records that should be loaded into memory while streaming. A value of 0 uses the default JDBC fetch size. |
0 |
int |
|
Time to wait before restarting connector after retriable exception occurs. Defaults to 10000ms. |
10s |
long |
|
Whether field names will be sanitized to Avro naming conventions. |
false |
boolean |
|
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 (default)'none' does not apply any adjustment. |
avro |
String |
|
The name of the data collection that is used to send signals/commands to Debezium. Signaling is disabled when not set. |
String |
||
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, no operations will be skipped. |
String |
||
A delay period before a snapshot will begin, given in milliseconds. Defaults to 0 ms. |
0ms |
long |
|
The maximum number of records that should be loaded into memory while performing a snapshot. |
int |
||
this setting must be set to specify a list of tables/collections whose snapshot must be taken on creating or restarting the connector. |
String |
||
Controls how long the connector holds onto the global read lock while it is performing a snapshot. The default is 'minimal', which means the connector holds the global read lock (and thus prevents any updates) for just the initial portion of the snapshot while the database schemas and other metadata are being read. The remaining work in a snapshot involves selecting all rows from each table, and this can be done using the snapshot process' REPEATABLE READ transaction even when the lock is no longer held and other operations are updating the database. However, in some cases it may be desirable to block all writes for the entire duration of the snapshot; in such cases set this property to 'extended'. Using a value of 'none' will prevent the connector from acquiring any table locks during the snapshot process. This mode can only be used in combination with snapshot.mode values of 'schema_only' or 'schema_only_recovery' and is only safe to use if no schema changes are happening while the snapshot is taken. |
minimal |
String |
|
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. |
10s |
long |
|
The maximum number of threads used to perform the snapshot. Defaults to 1. |
1 |
int |
|
The criteria for running a snapshot upon startup of the connector. Options include: 'when_needed' to specify that the connector run a snapshot upon startup whenever it deems it necessary; 'schema_only' to only take a snapshot of the schema (table structures) but no actual data; 'initial' (the default) to specify the connector can run a snapshot only when no offsets are available for the logical server name; 'initial_only' same as 'initial' except the connector should stop after completing the snapshot and before it would normally read the binlog; and’never' to specify the connector should never run a snapshot and that upon first startup the connector should read from the beginning of the binlog. The 'never' mode should be used with care, and only when the binlog is known to contain all history. |
initial |
String |
|
BETA FEATURE: On connector restart, the connector will check if there have been any new tables added to the configuration, and snapshot them. There is presently only two options:'off': Default behavior. Do not snapshot new tables.'parallel': The snapshot of the new tables will occur in parallel to the continued binlog reading of the old tables. When the snapshot completes, an independent binlog reader will begin reading the events for the new tables until it catches up to present time. At this point, both old and new binlog readers will be momentarily halted and new binlog reader will start that will read the binlog for all configured tables. The parallel binlog reader will have a configured server id of 10000 the primary binlog reader’s server id. |
off |
String |
|
This property contains a comma-separated list of fully-qualified tables (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on thespecific 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. |
String |
||
A version of the format of the publicly visible source part in the message. |
v2 |
String |
|
A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring (deprecated, use table.exclude.list instead). |
String |
||
A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring. |
String |
||
Flag specifying whether built-in tables should be ignored. |
true |
boolean |
|
The tables for which changes are to be captured. |
String |
||
The tables for which changes are to be captured (deprecated, use table.include.list instead). |
String |
||
Time, date and timestamps can be represented with different kinds of precisions, including:'adaptive_time_microseconds': the precision of date and timestamp values is based the database column’s precision; 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_time_microseconds |
String |
|
Whether delete operations should be represented by a delete event and a subsquenttombstone 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 |
boolean |
|
The name of the transaction metadata topic. The placeholder $\{database.server.name} can be used for referring to the connector’s logical name; defaults to $\{database.server.name}.transaction. |
${database.server.name}.transaction |
String |
Message Headers
The Debezium MySQL Connector component supports 7 message header(s), which is/are listed below:
| Name | Description | Default | Type |
|---|---|---|---|
CamelDebeziumSourceMetadata (consumer) Constant: |
The metadata about the source event, for example table name, database name, log position, etc, please refer to the Debezium documentation for more info. |
Map |
|
CamelDebeziumIdentifier (consumer) Constant: |
The identifier of the connector, normally is this format {server-name}.{database-name}.{table-name}. |
String |
|
|
Constant: |
The key of the event, normally is the table Primary Key. |
Struct |
|
CamelDebeziumOperation (consumer) Constant: |
If presents, the type of event operation. Values for the connector are c for create (or insert), u for update, d for delete or r for read (in the case of a initial sync) or in case of a snapshot event. |
String |
|
CamelDebeziumTimestamp (consumer) Constant: |
If presents, the time (using the system clock in the JVM) at which the connector processed the event. |
Long |
|
CamelDebeziumBefore (consumer) Constant: |
If presents, contains the state of the row before the event occurred. |
Struct |
|
CamelDebeziumDdlSQL (consumer) Constant: |
If presents, the ddl sql text of the event. |
String |
Message body
The message body if is not null (in case of tombstones), it contains the state of the row after the event occurred as Struct format or Map format if you use the included Type Converter from Struct to Map (please look below for more explanation).
Samples
Consuming events
Here is a very simple route that you can use in order to listen to Debezium events from MySQL connector.
from("debezium-mysql:dbz-test-1?offsetStorageFileName=/usr/offset-file-1.dat&databaseHostname=localhost&databaseUser=debezium&databasePassword=dbz&databaseServerName=my-app-connector&databaseHistoryFileFilename=/usr/history-file-1.dat")
.log("Event received from Debezium : ${body}")
.log(" with this identifier ${headers.CamelDebeziumIdentifier}")
.log(" with these source metadata ${headers.CamelDebeziumSourceMetadata}")
.log(" the event occured upon this operation '${headers.CamelDebeziumSourceOperation}'")
.log(" on this database '${headers.CamelDebeziumSourceMetadata[db]}' and this table '${headers.CamelDebeziumSourceMetadata[table]}'")
.log(" with the key ${headers.CamelDebeziumKey}")
.log(" the previous value is ${headers.CamelDebeziumBefore}")
.log(" the ddl sql text is ${headers.CamelDebeziumDdlSQL}")By default, the component will emit the events in the body and CamelDebeziumBefore header as Struct data type, the reasoning behind this, is to perceive the schema information in case is needed.
However, the component as well contains a Type Converter that converts
from default output type of Struct to Map in order to leverage Camel’s rich Data Format types which many of them work out of box with Map data type.
To use it, you can either add Map.class type when you access the message e.g: exchange.getIn().getBody(Map.class), or you can convert the body always to Map from the route builder by adding .convertBodyTo(Map.class) to your Camel Route DSL after from statement.
We mentioned above about the schema, which can be used in case you need to perform advance data transformation and the schema is needed for that. If you choose not to convert your body to Map,
you can obtain the schema information as Schema type from Struct like this:
from("debezium-mysql:[name]?[options]])
.process(exchange -> {
final Struct bodyValue = exchange.getIn().getBody(Struct.class);
final Schema schemaValue = bodyValue.schema();
log.info("Body value is :" + bodyValue);
log.info("With Schema : " + schemaValue);
log.info("And fields of :" + schemaValue.fields());
log.info("Field name has `" + schemaValue.field("name").schema() + "` type");
});Important Note: This component is a thin wrapper around Debezium Engine as mentioned, therefore before using this component in production, you need to understand how Debezium works and how configurations can reflect the expected behavior, especially in regards to handling failures.
Spring Boot Auto-Configuration
When using debezium-mysql with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:
<dependency>
<groupId>org.apache.camel.springboot</groupId>
<artifactId>camel-debezium-mysql-starter</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>The component supports 101 options, which are listed below.