You are viewing documentation for an unreleased version of Debezium.
If you want to view the latest stable version of this page, please gohere．

Debezium connector for MySQL

MySQL has a binary log (binlog) that records all operations in the order in which they are committed to the database. This includes changes to table schemas as well as changes to the data in tables. MySQL uses the binlog for replication and recovery.

的Debezium MySQL connector reads the binlog, produces change events for row-levelINSERT,UPDATE, andDELETEoperations, and emits the change events to Kafka topics. Client applications read those Kafka topics.

As MySQL is typically set up to purge binlogs after a specified period of time, the MySQL connector performs an initialconsistent snapshotof each of your databases. The MySQL connector reads the binlog from the point at which the snapshot was made.

For information about the MySQL Database versions that are compatible with this connector, see theDebezium release overview．

How the connector works

An overview of the MySQL topologies that the connector supports is useful for planning your application. To optimally configure and run a Debezium MySQL connector, it is helpful to understand how the connector tracks the structure of tables, exposes schema changes, performs snapshots, and determines Kafka topic names.

的Debezium MySQL connector has yet to be tested with MariaDB, but multiple reports from the community indicate successful usage of the connector with this database. Official support for MariaDB is planned for a future Debezium version.

Supported MySQL topologies

的Debezium MySQL connector supports the following MySQL topologies:

Standalone

When a single MySQL server is used, the server must have the binlog enabled (and optionally GTIDs enabled) so the Debezium MySQL connector can monitor the server. This is often acceptable, since the binary log can also be used as an incrementalbackup．In this case, the MySQL connector always connects to and follows this standalone MySQL server instance.

Primary and replica

的Debezium MySQL connector can follow one of the primary servers or one of the replicas (if that replica has its binlog enabled), but the connector sees changes in only the cluster that is visible to that server. Generally, this is not a problem except for the multi-primary topologies.

的connector records its position in the server’s binlog, which is different on each server in the cluster. Therefore, the connector must follow just one MySQL server instance. If that server fails, that server must be restarted or recovered before the connector can continue.

High available clusters

A variety ofhigh availability解决方案为MySQL,他们使它significantly easier to tolerate and almost immediately recover from problems and failures. Most HA MySQL clusters use GTIDs so that replicas are able to keep track of all changes on any of the primary servers.

Multi-primary

Network Database (NDB) cluster replicationuses one or more MySQL replica nodes that each replicate from multiple primary servers. This is a powerful way to aggregate the replication of multiple MySQL clusters. This topology requires the use of GTIDs.

A Debezium MySQL connector can use these multi-primary MySQL replicas as sources, and can fail over to different multi-primary MySQL replicas as long as the new replica is caught up to the old replica. That is, the new replica has all transactions that were seen on the first replica. This works even if the connector is using only a subset of databases and/or tables, as the connector can be configured to include or exclude specific GTID sources when attempting to reconnect to a new multi-primary MySQL replica and find the correct position in the binlog.

Hosted

的re is support for the Debezium MySQL connector to use hosted options such as Amazon RDS and Amazon Aurora.

Because these hosted options do not allow a global read lock, table-level locks are used to create theconsistent snapshot．

Schema history topic

When a database client queries a database, the client uses the database’s current schema. However, the database schema can be changed at any time, which means that the connector must be able to identify what the schema was at the time each insert, update, or delete operation was recorded. Also, a connector cannot just use the current schema because the connector might be processing events that are relatively old that were recorded before the tables' schemas were changed.

To ensure correct processing of changes that occur after a schema change, MySQL includes in the binlog not only the row-level changes to the data, but also the DDL statements that are applied to the database. As the connector reads the binlog and comes across these DDL statements, it parses them and updates an in-memory representation of each table’s schema. The connector uses this schema representation to identify the structure of the tables at the time of each insert, update, or delete operation and to produce the appropriate change event. In a separate database schema history Kafka topic, the connector records all DDL statements along with the position in the binlog where each DDL statement appeared.

When the connector restarts after having crashed or been stopped gracefully, the connector starts reading the binlog from a specific position, that is, from a specific point in time. The connector rebuilds the table structures that existed at this point in time by reading the database schema history Kafka topic and parsing all DDL statements up to the point in the binlog where the connector is starting.

This database schema history topic is for connector use only. The connector can optionallyemit schema change events to a different topic that is intended for consumer applications．

When the MySQL connector captures changes in a table to which a schema change tool such asgh-ostorpt-online-schema-changeis applied, there are helper tables created during the migration process. The connector needs to be configured to capture change to these helper tables. If consumers do not need the records generated for helper tables, then a single message transform can be applied to filter them out.

Seedefault names for topicsthat receive Debezium event records.

Schema change topic

You can configure a Debezium MySQL connector to produce schema change events that describe schema changes that are applied to captured tables in the database. The connector writes schema change events to a Kafka topic named, wheretopicPrefixis the namespace specified in thetopic.prefix连接器配置属性。Messages that the connector sends to the schema change topic contain a payload, and, optionally, also contain the schema of the change event message.

的payload of a schema change event message includes the following elements:

ddl

Provides the SQLCREATE,ALTER, orDROPstatement that results in the schema change.

databaseName

的名称database to which the DDL statements are applied. The value ofdatabaseNameserves as the message key.

pos

的position in the binlog where the statements appear.

tableChanges

A structured representation of the entire table schema after the schema change. ThetableChangesfield contains an array that includes entries for each column of the table. Because the structured representation presents data in JSON or Avro format, consumers can easily read messages without first processing them through a DDL parser.

For a table that is in capture mode, the connector not only stores the history of schema changes in the schema change topic, but also in an internal database schema history topic. The internal database schema history topic is for connector use only and it is not intended for direct use by consuming applications. Ensure that applications that require notifications about schema changes consume that information only from the schema change topic.

Never partition the database schema history topic. For the database schema history topic to function correctly, it must maintain a consistent, global order of the event records that the connector emits to it.

确保主题不是partit之间的分裂ions, set the partition count for the topic by using one of the following methods:

  • If you create the database schema history topic manually, specify a partition count of1．

  • If you use the Apache Kafka broker to create the database schema history topic automatically, the topic is created, set the value of theKafkanum.partitionsconfiguration option to1．

的format of the messages that a connector emits to its schema change topic is in an incubating state and is subject to change without notice.
Example: Message emitted to the MySQL connector schema change topic

的following example shows a typical schema change message in JSON format. The message contains a logical representation of the table schema.

{ "schema": { }, "payload": { "source": {(1)"version": "2.2.0.Alpha2", "connector": "mysql", "name": "mysql", "ts_ms": 1651535750218,(2)"snapshot": "false", "db": "inventory", "sequence": null, "table": "customers", "server_id": 223344, "gtid": null, "file": "mysql-bin.000003", "pos": 570, "row": 0, "thread": null, "query": null }, "databaseName": "inventory",(3)“schemaName”:空,“ddl”:“ALTER TABLE的客户ADD middle_name varchar(255) AFTER first_name",(4)"tableChanges": [(5){ "type": "ALTER",(6)"id": "\"inventory\".\"customers\"",(7)"table": {(8)"defaultCharsetName": "utf8mb4", "primaryKeyColumnNames": [(9)"id" ], "columns": [(10){ "name": "id", "jdbcType": 4, "nativeType": null, "typeName": "INT", "typeExpression": "INT", "charsetName": null, "length": null, "scale": null, "position": 1, "optional": false, "autoIncremented": true, "generated": true }, { "name": "first_name", "jdbcType": 12, "nativeType": null, "typeName": "VARCHAR", "typeExpression": "VARCHAR", "charsetName": "utf8mb4", "length": 255, "scale": null, "position": 2, "optional": false, "autoIncremented": false, "generated": false }, { "name": "middle_name", "jdbcType": 12, "nativeType": null, "typeName": "VARCHAR", "typeExpression": "VARCHAR", "charsetName": "utf8mb4", "length": 255, "scale": null, "position": 3, "optional": true, "autoIncremented": false, "generated": false }, { "name": "last_name", "jdbcType": 12, "nativeType": null, "typeName": "VARCHAR", "typeExpression": "VARCHAR", "charsetName": "utf8mb4", "length": 255, "scale": null, "position": 4, "optional": false, "autoIncremented": false, "generated": false }, { "name": "email", "jdbcType": 12, "nativeType": null, "typeName": "VARCHAR", "typeExpression": "VARCHAR", "charsetName": "utf8mb4", "length": 255, "scale": null, "position": 5, "optional": false, "autoIncremented": false, "generated": false } ], "attributes": [(11){ "customAttribute": "attributeValue" } ] } } ] } }
Table 1. Descriptions of fields in messages emitted to the schema change topic
Item Field name Description

1

source

的sourcefield is structured exactly as standard data change events that the connector writes to table-specific topics. This field is useful to correlate events on different topics.

2

ts_ms

Optional field that displays the time at which the connector processed the event. The time is based on the system clock in the JVM running the Kafka Connect task.

In the source object, ts_ms indicates the time that the change was made in the database. By comparing the value for payload.source.ts_ms with the value for payload.ts_ms, you can determine the lag between the source database update and Debezium.

3

databaseName
schemaName

Identifies the database and the schema that contains the change. The value of thedatabaseNamefield is used as the message key for the record.

4

ddl

This field contains the DDL that is responsible for the schema change. Theddlfield can contain multiple DDL statements. Each statement applies to the database in thedatabaseNamefield. Multiple DDL statements appear in the order in which they were applied to the database.

Clients can submit multiple DDL statements that apply to multiple databases. If MySQL applies them atomically, the connector takes the DDL statements in order, groups them by database, and creates a schema change event for each group. If MySQL applies them individually, the connector creates a separate schema change event for each statement.

5

tableChanges

An array of one or more items that contain the schema changes generated by a DDL command.

6

type

Describes the kind of change. The value is one of the following:

CREATE

Table created.

ALTER

Table modified.

DROP

Table deleted.

7

id

Full identifier of the table that was created, altered, or dropped. In the case of a table rename, this identifier is a concatenation of,table names.

8

table

代表resents table metadata after the applied change.

9

primaryKeyColumnNames

List of columns that compose the table’s primary key.

10

columns

Metadata for each column in the changed table.

11

attributes

Custom attribute metadata for each table change.

See also:schema history topic．

Snapshots

When a Debezium MySQL connector is first started, it performs an initialconsistent snapshotof your database. The following flow describes how the connector creates this snapshot. This flow is for the default snapshot mode, which isinitial．For information about other snapshot modes, see theMySQL connectorsnapshot.modeconfiguration property．

Table 2. Workflow for performing an initial snapshot with a global read lock
Step Action

1

Grabs a global read lock that blockswritesby other database clients.

的snapshot itself does not prevent other clients from applying DDL that might interfere with the connector’s attempt to read the binlog position and table schemas. The connector keeps the global read lock while it reads the binlog position, and releases the lock as described in a later step.

2

Starts a transaction withrepeatable read semanticsto ensure that all subsequent reads within the transaction are done against theconsistent snapshot．

3

Reads the current binlog position.

4

Reads the schema of the databases and tables for which the connector is configured to capture changes.

5

Releases the global read lock. Other database clients can now write to the database.

6

If applicable, writes the DDL changes to the schema change topic, including all necessaryDROP…andCREATE…DDL statements.

7

Scans the database tables. For each row, the connector emitsCREATEevents to the relevant table-specific Kafka topics.

8

Commits the transaction.

9

Records the completed snapshot in the connector offsets.
Connector restarts

If the connector fails, stops, or is rebalanced while performing theinitial snapshot, then after the connector restarts, it performs a new snapshot. After thatintial snapshotis completed, the Debezium MySQL connector restarts from the same position in the binlog so it does not miss any updates.

If the connector stops for long enough, MySQL could purge old binlog files and the connector’s position would be lost. If the position is lost, the connector reverts to theinitial snapshot它的起始位置。troubl的更多提示eshooting the Debezium MySQL connector, seebehavior when things go wrong．

Global read locks not allowed

Some environments do not allow global read locks. If the Debezium MySQL connector detects that global read locks are not permitted, the connector uses table-level locks instead and performs a snapshot with this method. This requires the database user for the Debezium connector to haveLOCK TABLES特权。

Table 3. Workflow for performing an initial snapshot with table-level locks
Step Action

1

Obtains table-level locks.

2

Starts a transaction withrepeatable read semanticsto ensure that all subsequent reads within the transaction are done against theconsistent snapshot．

3

Reads and filters the names of the databases and tables.

4

Reads the current binlog position.

5

Reads the schema of the databases and tables for which the connector is configured to capture changes.

6

If applicable, writes the DDL changes to the schema change topic, including all necessaryDROP…andCREATE…DDL statements.

7

Scans the database tables. For each row, the connector emitsCREATEevents to the relevant table-specific Kafka topics.

8

Commits the transaction.

9

Releases the table-level locks.

10

Records the completed snapshot in the connector offsets.

Ad hoc snapshots

By default, a connector runs an initial snapshot operation only after it starts for the first time. Following this initial snapshot, under normal circumstances, the connector does not repeat the snapshot process. Any future change event data that the connector captures comes in through the streaming process only.

然而,在某些情况下的数据ector obtained during the initial snapshot might become stale, lost, or incomplete. To provide a mechanism for recapturing table data, Debezium includes an option to perform ad hoc snapshots. The following changes in a database might be cause for performing an ad hoc snapshot:

  • 的connector configuration is modified to capture a different set of tables.

  • Kafka topics are deleted and must be rebuilt.

  • Data corruption occurs due to a configuration error or some other problem.

You can re-run a snapshot for a table for which you previously captured a snapshot by initiating a so-calledad-hoc snapshot．Ad hoc snapshots require the use ofsignaling tables．You initiate an ad hoc snapshot by sending a signal request to the Debezium signaling table.

When you initiate an ad hoc snapshot of an existing table, the connector appends content to the topic that already exists for the table. If a previously existing topic was removed, Debezium can create a topic automatically ifautomatic topic creationis enabled.

Ad hoc snapshot signals specify the tables to include in the snapshot. The snapshot can capture the entire contents of the database, or capture only a subset of the tables in the database. Also, the snapshot can capture a subset of the contents of the table(s) in the database.

You specify the tables to capture by sending anexecute-snapshotmessage to the signaling table. Set the type of theexecute-snapshotsignal toincremental, and provide the names of the tables to include in the snapshot, as described in the following table:

Table 4. Example of an ad hocexecute-snapshotsignal record
Field Default Value

type

incremental

Specifies the type of snapshot that you want to run.
Setting the type is optional. Currently, you can request onlyincrementalsnapshots.

data-collections

N/A

An array that contains regular expressions matching the fully-qualified names of the table to be snapshotted.
名字的格式是一样的signal.data.collectionconfiguration option.

additional-condition

N/A

An optional string, which specifies a condition based on the column(s) of the table(s), to capture a subset of the contents of the table(s).
Triggering an ad hoc snapshot

You initiate an ad hoc snapshot by adding an entry with theexecute-snapshotsignal type to the signaling table. After the connector processes the message, it begins the snapshot operation. The snapshot process reads the first and last primary key values and uses those values as the start and end point for each table. Based on the number of entries in the table, and the configured chunk size, Debezium divides the table into chunks, and proceeds to snapshot each chunk, in succession, one at a time.

Currently, theexecute-snapshotaction type triggersincremental snapshotsonly. For more information, seeIncremental snapshots．

Incremental snapshots

To provide flexibility in managing snapshots, Debezium includes a supplementary snapshot mechanism, known asincremental snapshotting．Incremental snapshots rely on the Debezium mechanism forsending signals to a Debezium connector．Incremental snapshots are based on theDDD-3design document.

In an incremental snapshot, instead of capturing the full state of a database all at once, as in an initial snapshot, Debezium captures each table in phases, in a series of configurable chunks. You can specify the tables that you want the snapshot to capture and thesize of each chunk．的chunk size determines the number of rows that the snapshot collects during each fetch operation on the database. The default chunk size for incremental snapshots is 1 KB.

As an incremental snapshot proceeds, Debezium uses watermarks to track its progress, maintaining a record of each table row that it captures. This phased approach to capturing data provides the following advantages over the standard initial snapshot process:

  • You can run incremental snapshots in parallel with streamed data capture, instead of postponing streaming until the snapshot completes. The connector continues to capture near real-time events from the change log throughout the snapshot process, and neither operation blocks the other.

  • If the progress of an incremental snapshot is interrupted, you can resume it without losing any data. After the process resumes, the snapshot begins at the point where it stopped, rather than recapturing the table from the beginning.

  • You can run an incremental snapshot on demand at any time, and repeat the process as needed to adapt to database updates. For example, you might re-run a snapshot after you modify the connector configuration to add a table to itstable.include.listproperty.

Incremental snapshot process

When you run an incremental snapshot, Debezium sorts each table by primary key and then splits the table into chunks based on theconfigured chunk size．Working chunk by chunk, it then captures each table row in a chunk. For each row that it captures, the snapshot emits aREADevent. That event represents the value of the row when the snapshot for the chunk began.

As a snapshot proceeds, it’s likely that other processes continue to access the database, potentially modifying table records. To reflect such changes,INSERT,UPDATE, orDELETEoperations are committed to the transaction log as per usual. Similarly, the ongoing Debezium streaming process continues to detect these change events and emits corresponding change event records to Kafka.

How Debezium resolves collisions among records with the same primary key

In some cases, theUPDATEorDELETEevents that the streaming process emits are received out of sequence. That is, the streaming process might emit an event that modifies a table row before the snapshot captures the chunk that contains theREADevent for that row. When the snapshot eventually emits the correspondingREADevent for the row, its value is already superseded. To ensure that incremental snapshot events that arrive out of sequence are processed in the correct logical order, Debezium employs a buffering scheme for resolving collisions. Only after collisions between the snapshot events and the streamed events are resolved does Debezium emit an event record to Kafka.

Snapshot window

To assist in resolving collisions between late-arrivingREADevents and streamed events that modify the same table row, Debezium employs a so-calledsnapshot window．的snapshot windows demarcates the interval during which an incremental snapshot captures data for a specified table chunk. Before the snapshot window for a chunk opens, Debezium follows its usual behavior and emits events from the transaction log directly downstream to the target Kafka topic. But from the moment that the snapshot for a particular chunk opens, until it closes, Debezium performs a de-duplication step to resolve collisions between events that have the same primary key..

For each data collection, the Debezium emits two types of events, and stores the records for them both in a single destination Kafka topic. The snapshot records that it captures directly from a table are emitted asREADoperations. Meanwhile, as users continue to update records in the data collection, and the transaction log is updated to reflect each commit, Debezium emitsUPDATEorDELETEoperations for each change.

As the snapshot window opens, and Debezium begins processing a snapshot chunk, it delivers snapshot records to a memory buffer. During the snapshot windows, the primary keys of theREADevents in the buffer are compared to the primary keys of the incoming streamed events. If no match is found, the streamed event record is sent directly to Kafka. If Debezium detects a match, it discards the bufferedREADevent, and writes the streamed record to the destination topic, because the streamed event logically supersede the static snapshot event. After the snapshot window for the chunk closes, the buffer contains onlyREADevents for which no related transaction log events exist. Debezium emits these remainingREADevents to the table’s Kafka topic.

的connector repeats the process for each snapshot chunk.

Triggering an incremental snapshot

Currently, the only way to initiate an incremental snapshot is to send anad hoc snapshot signalto the signaling table on the source database. You submit a signal to the signaling table as SQLINSERTqueries.

After Debezium detects the change in the signaling table, it reads the signal, and runs the requested snapshot operation.

的query that you submit specifies the tables to include in the snapshot, and, optionally, specifies the kind of snapshot operation. Currently, the only valid option for snapshots operations is the default value,incremental．

To specify the tables to include in the snapshot, provide adata-collections数组列出常规的表或数组expressions used to match tables, for example,
{"data-collections": ["public.MyFirstTable", "public.MySecondTable"]}

的data-collectionsarray for an incremental snapshot signal has no default value. If thedata-collectionsarray is empty, Debezium detects that no action is required and does not perform a snapshot.

If the name of a table that you want to include in a snapshot contains a dot (．) in the name of the database, schema, or table, to add the table to thedata-collectionsarray, you must escape each part of the name in double quotes.

For example, to include a table that exists in thepublicschema and that has the nameMy.Table, use the following format:"public"."My.Table"．
Prerequisites
Procedure

  1. Send a SQL query to add the ad hoc incremental snapshot request to the signaling table:

    INSERT INTO(id, type, data) VALUES ('','', '{"data-collections": ["",""],"type":"","additional-condition":""}');

    For example,

    INSERT INTO myschema.debezium_signal (id, type, data)(1)values ('ad-hoc-1',(2)'execute-snapshot',(3)'{"data-collections": ["schema1.table1", "schema2.table2"],(4)"type":"incremental"},(5)"additional-condition":"color=blue"}');(6)

    的values of theid,type, anddataparameters in the command correspond to thefields of the signaling table．

    的following table describes the parameters in the example:

    Table 5. Descriptions of fields in a SQL command for sending an incremental snapshot signal to the signaling table
    Item Value Description

    1

    myschema.debezium_signal

    Specifies the fully-qualified name of the signaling table on the source database.

    2

    ad-hoc-1

    的idparameter specifies an arbitrary string that is assigned as theididentifier for the signal request.
    Use this string to identify logging messages to entries in the signaling table. Debezium does not use this string. Rather, during the snapshot, Debezium generates its ownidstring as a watermarking signal.

    3

    execute-snapshot

    Specifiestypeparameter specifies the operation that the signal is intended to trigger.

    4

    data-collections

    A required component of thedatafield of a signal that specifies an array of table names or regular expressions to match table names to include in the snapshot.
    的array lists regular expressions which match tables by their fully-qualified names, using the same format as you use to specify the name of the connector’s signaling table in thesignal.data.collectionconfiguration property.

    5

    incremental

    An optionaltypecomponent of thedatafield of a signal that specifies the kind of snapshot operation to run.
    Currently, the only valid option is the default value,incremental．
    If you do not specify a value, the connector runs an incremental snapshot.

    6

    additional-condition

    An optional string, which specifies a condition based on the column(s) of the table(s), to capture a subset of the contents of the tables. For more information about theadditional-conditionparameter, seeAd hoc incremental snapshots withadditional-condition．
Ad hoc incremental snapshots withadditional-condition

If you want a snapshot to include only a subset of the content in a table, you can modify the signal request by appending anadditional-conditionparameter to the snapshot signal.

的SQL query for a typical snapshot takes the following form:

SELECT * FROM．...

By adding anadditional-conditionparameter, you append aWHEREcondition to the SQL query, as in the following example:

SELECT * FROMWHERE．...

的following example shows a SQL query to send an ad hoc incremental snapshot request with an additional condition to the signaling table:

INSERT INTO(id, type, data) VALUES ('','', '{"data-collections": ["",""],"type":"","additional-condition":""}');

For example, suppose you have aproductstable that contains the following columns:

  • id(primary key)

  • color

  • quantity

If you want an incremental snapshot of theproductstable to include only the data items wherecolor=blue, you can use the following SQL statement to trigger the snapshot:

INSERT INTO myschema.debezium_signal (id, type, data) VALUES('ad-hoc-1', 'execute-snapshot', '{"data-collections": ["schema1.products"],"type":"incremental", "additional-condition":"color=blue"}');

的additional-conditionparameter also enables you to pass conditions that are based on more than on column. For example, using theproductstable from the previous example, you can submit a query that triggers an incremental snapshot that includes the data of only those items for whichcolor=blueandquantity>10:

INSERT INTO myschema.debezium_signal (id, type, data) VALUES('ad-hoc-1', 'execute-snapshot', '{"data-collections": ["schema1.products"],"type":"incremental", "additional-condition":"color=blue AND quantity>10"}');

的following example, shows the JSON for an incremental snapshot event that is captured by a connector.

Example: Incremental snapshot event message
{ "before":null, "after": { "pk":"1", "value":"New data" }, "source": { ... "snapshot":"incremental"(1)}, "op":"r",(2)"ts_ms":"1620393591654", "transaction":null }
Item Field name Description

1

snapshot

Specifies the type of snapshot operation to run.
Currently, the only valid option is the default value,incremental．
Specifying atypevalue in the SQL query that you submit to the signaling table is optional.
If you do not specify a value, the connector runs an incremental snapshot.

2

op

Specifies the event type.
的value for snapshot events isr, signifying aREADoperation.

Stopping an incremental snapshot

You can also stop an incremental snapshot by sending a signal to the table on the source database. You submit a stop snapshot signal to the table by sending a SQLINSERTquery. After Debezium detects the change in the signaling table, it reads the signal, and stops the incremental snapshot operation if it’s in progress.

的query that you submit specifies the snapshot operation ofincremental, and, optionally, the tables of the current running snapshot to be removed.

Prerequisites
Procedure

  1. Send a SQL query to stop the ad hoc incremental snapshot to the signaling table:

    INSERT INTO(id, type, data) values ('', 'stop-snapshot', '{"data-collections": ["",""],"type":"incremental"}');

    For example,

    INSERT INTO myschema.debezium_signal (id, type, data)(1)values ('ad-hoc-1',(2)'stop-snapshot',(3)'{"data-collections": ["schema1.table1", "schema2.table2"],(4)"type":"incremental"}');(5)

    的values of theid,type, anddataparameters in the signal command correspond to thefields of the signaling table．

    的following table describes the parameters in the example:

    Table 6. Descriptions of fields in a SQL command for sending a stop incremental snapshot signal to the signaling table
    Item Value Description

    1

    myschema.debezium_signal

    Specifies the fully-qualified name of the signaling table on the source database.

    2

    ad-hoc-1

    的idparameter specifies an arbitrary string that is assigned as theididentifier for the signal request.
    Use this string to identify logging messages to entries in the signaling table. Debezium does not use this string.

    3

    stop-snapshot

    Specifiestypeparameter specifies the operation that the signal is intended to trigger.

    4

    data-collections

    An optional component of thedatafield of a signal that specifies an array of table names or regular expressions to match table names to remove from the snapshot.
    的array lists regular expressions which match tables by their fully-qualified names, using the same format as you use to specify the name of the connector’s signaling table in thesignal.data.collectionconfiguration property. If this component of thedatafield is omitted, the signal stops the entire incremental snapshot that is in progress.

    5

    incremental

    A required component of thedatafield of a signal that specifies the kind of snapshot operation that is to be stopped.
    Currently, the only valid option isincremental．
    If you do not specify atypevalue, the signal fails to stop the incremental snapshot.

Read-only incremental snapshots

MySQL连接器允许运行的增量snapshots with a read-only connection to the database. To run an incremental snapshot with read-only access, the connector uses the executed global transaction IDs (GTID) set as high and low watermarks. The state of a chunk’s window is updated by comparing the GTIDs of binary log (binlog) events or the server’s heartbeats against low and high watermarks.

To switch to a read-only implementation, set the value of theread.onlyproperty totrue．

Prerequisites

  • Enable MySQL GTIDs．

  • If the connector reads from a multi-threaded replica (that is, a replica for which the value ofreplica_parallel_workersis greater than0) you must set one of the following options:

    • replica_preserve_commit_order=ON

    • slave_preserve_commit_order=ON

Ad hoc read-only incremental snapshots

When the MySQL connection is read-only, thesignaling tablemechanism can also run a snapshot by sending a message to the Kafka topic that is specified in thesignal.kafka.topicproperty.

的key of the Kafka message must match the value of thetopic.prefixconnector configuration option.

的value is a JSON object withtypeanddatafields.

的signal type isexecute-snapshotand thedatafield must have the following fields:

Table 7. Execute snapshot data fields
Field Default Value

type

incremental

的type of the snapshot to be executed. Currently onlyincrementalis supported.
See the next section for more details.

data-collections

N/A

An array of comma-separated regular expressions that match fully-qualified names of tables to be snapshotted.
的format of the names is the same as forsignal.data.collectionconfiguration option.

additional-condition

N/A

An optional string, which specifies a condition based on the column(s) of the table(s), to capture a subset of the contents of the table(s).

An example of the execute-snapshot Kafka message:

Key = `test_connector` Value = `{"type":"execute-snapshot","data": {"data-collections": ["schema1.table1", "schema1.table2"], "type": "INCREMENTAL"}}`

Ad hoc read-only incremental snapshots with additional-condition

  • additional-conditionis used to select a subset of a table’s content.

  • To give an analogy howadditional-conditionis used:

    • For a snapshot, the SQL query executed behind the scenes is something like:

      SELECT * FROM….

    • For a snapshot with aadditional-condition, theadditional-conditionis appended to the SQL query, something like:

      SELECT * FROMWHERE….

  • Suppose there is aproductstable with columnsid(primary key),colorandbrand．

    To snapshot just the content of theproductstable wherecolor=blue

    Key = `test_connector` Value = `{"type":"execute-snapshot","data": {"data-collections": ["schema1.products"], "type": "INCREMENTAL", "additional-condition":"color=blue"}}`

  • additional-conditioncan be used to pass condition based on multiple columns. Using the sameproductstable, to snapshot content of theproductstable wherecolor=blueandbrand=foo

    Key = `test_connector` Value = `{"type":"execute-snapshot","data": {"data-collections": ["schema1.products"], "type": "INCREMENTAL", "additional-condition":"color=blue AND brand=foo"}}`

Stopping an Ad hoc read-only incremental snapshot

When the MySQL connection is read-only, thesignaling tablemechanism can also stop a snapshot by sending a message to the Kafka topic that is specified in thesignal.kafka.topicproperty.

的key of the Kafka message must match the value of thetopic.prefixconnector configuration option.

的value is a JSON object withtypeanddatafields.

的signal type isstop-snapshotand thedatafield must have the following fields:

Table 8. Execute snapshot data fields
Field Default Value

type

incremental

的type of the snapshot to be executed. Currently onlyincrementalis supported.
See the next section for more details.

data-collections

N/A

An optional array of comma-separated regular expressions that match fully-qualified names of tables to be snapshotted.
的format of the names is the same as forsignal.data.collectionconfiguration option.

的一个例子stop-snapshot卡夫卡的信息:

Key = `test_connector` Value = `{"type":"stop-snapshot","data": {"data-collections": ["schema1.table1", "schema1.table2"], "type": "INCREMENTAL"}}`

快照事件的操作类型

MySQL连接器放出快照事件READoperations("op" : "r")．If you prefer that the connector emits snapshot events asCREATE(c) events, configure the DebeziumReadToInsertEventsingle message transform (SMT) to modify the event type.

的following example shows how to configure the SMT:

Example: Using theReadToInsertEventSMT to change the type of snapshot events
transforms=snapshotasinsert,... transforms.snapshotasinsert.type=io.debezium.connector.mysql.transforms.ReadToInsertEvent

Topic names

By default, the MySQL connector writes change events for all of theINSERT,UPDATE, andDELETEoperations that occur in a table to a single Apache Kafka topic that is specific to that table.

的connector uses the following convention to name change event topics:

topicPrefix.databaseName.tableName

Suppose thatfulfillmentis the topic prefix,inventoryis the database name, and the database contains tables namedorders,customers, andproducts．的Debezium MySQL connector emits events to three Kafka topics, one for each table in the database:

fulfillment.inventory.orders fulfillment.inventory.customers fulfillment.inventory.products

的following list provides definitions for the components of the default name:

topicPrefix

的topic prefix as specified by thetopic.prefix连接器配置属性。

schemaName

的名称schema in which the operation occurred.

tableName

的名称table in which the operation occurred.

的connector applies similar naming conventions to label its internal database schema history topics,schema change topics, and事务metadata topics．

If the default topic name do not meet your requirements, you can configure custom topic names. To configure custom topic names, you specify regular expressions in the logical topic routing SMT. For more information about using the logical topic routing SMT to customize topic naming, seeTopic routing．

Transaction metadata

Debezium can generate events that represent transaction boundaries and that enrich data change event messages.

Limits on when Debezium receives transaction metadata

Debezium registers and receives metadata only for transactions that occur after you deploy the connector. Metadata for transactions that occur before you deploy the connector is not available.

Debezium generates transaction boundary events for theBEGINandENDdelimiters in every transaction. Transaction boundary events contain the following fields:

status

BEGINorEND．

id

String representation of the unique transaction identifier.

ts_ms

办理的时间ion boundary event (BEGINorENDevent) at the data source. If the data source does not provide Debezium with the event time, then the field instead represents the time at which Debezium processes the event.

event_count(forENDevents)

Total number of events emitted by the transaction.

data_collections(forENDevents)

An array of pairs ofdata_collectionandevent_countelements that indicates the number of events that the connector emits for changes that originate from a data collection.

Example
{ "status": "BEGIN", "id": "0e4d5dcd-a33b-11ea-80f1-02010a22a99e:10", "ts_ms": 1486500577125, "event_count": null, "data_collections": null } { "status": "END", "id": "0e4d5dcd-a33b-11ea-80f1-02010a22a99e:10", "ts_ms": 1486500577691, "event_count": 2, "data_collections": [ { "data_collection": "s1.a", "event_count": 1 }, { "data_collection": "s2.a", "event_count": 1 } ] }

Unless overridden via thetopic.transactionoption, the connector emits transaction events to the．事务topic.

Change data event enrichment

When transaction metadata is enabled the data messageEnvelopeis enriched with a new事务field. This field provides information about every event in the form of a composite of fields:

id

String representation of unique transaction identifier.

total_order

的absolute position of the event among all events generated by the transaction.

data_collection_order

的per-data collection position of the event among all events that were emitted by the transaction.

Following is an example of a message:

{ "before": null, "after": { "pk": "2", "aa": "1" }, "source": { ... }, "op": "c", "ts_ms": "1580390884335", "transaction": { "id": "0e4d5dcd-a33b-11ea-80f1-02010a22a99e:10", "total_order": "1", "data_collection_order": "1" } }

For systems which don’t have GTID enabled, the transaction identifier is constructed using the combination of binlog filename and binlog position. For example, if the binlog filename and position corresponding to the transaction BEGIN event are mysql-bin.000002 and 1913 respectively then the Debezium constructed transaction identifier would befile=mysql-bin.000002,pos=1913．

Data change events

的Debezium MySQL connector generates a data change event for each row-levelINSERT,UPDATE, andDELETEoperation. Each event contains a key and a value. The structure of the key and the value depends on the table that was changed.

Debezium and Kafka Connect are designed aroundcontinuous streams of event messages．然而,这些事件青稞酒的结构e over time, which can be difficult for consumers to handle. To address this, each event contains the schema for its content or, if you are using a schema registry, a schema ID that a consumer can use to obtain the schema from the registry. This makes each event self-contained.

下面的骨架JSON显示了基本的四个parts of a change event. However, how you configure the Kafka Connect converter that you choose to use in your application determines the representation of these four parts in change events. Aschemafield is in a change event only when you configure the converter to produce it. Likewise, the event key and event payload are in a change event only if you configure a converter to produce it. If you use the JSON converter and you configure it to produce all four basic change event parts, change events have this structure:

{ "schema": {(1)．.. }, "payload": {(2)．.. }, "schema": {(3)．.. }, "payload": {(4)．.. }, }
Table 9. Overview of change event basic content
Item Field name Description

1

schema

的firstschemafield is part of the event key. It specifies a Kafka Connect schema that describes what is in the event key’spayloadportion. In other words, the firstschemafield describes the structure of the primary key, or the unique key if the table does not have a primary key, for the table that was changed.

It is possible to override the table’s primary key by setting themessage.key.columnsconnector configuration property．In this case, the first schema field describes the structure of the key identified by that property.

2

payload

的firstpayloadfield is part of the event key. It has the structure described by the previousschemafield and it contains the key for the row that was changed.

3

schema

的secondschemafield is part of the event value. It specifies the Kafka Connect schema that describes what is in the event value’spayloadportion. In other words, the secondschemadescribes the structure of the row that was changed. Typically, this schema contains nested schemas.

4

payload

的secondpayloadfield is part of the event value. It has the structure described by the previousschemafield and it contains the actual data for the row that was changed.

By default, the connector streams change event records to topics with names that are the same as the event’s originating table. Seetopic names．

的MySQL connector ensures that all Kafka Connect schema names adhere to theAvro schema name format．This means that the logical server name must start with a Latin letter or an underscore, that is, a-z, A-Z, or _. Each remaining character in the logical server name and each character in the database and table names must be a Latin letter, a digit, or an underscore, that is, a-z, A-Z, 0-9, or _. If there is an invalid character it is replaced with an underscore character.

This can lead to unexpected conflicts if the logical server name, a database name, or a table name contains invalid characters, and the only characters that distinguish names from one another are invalid and thus replaced with underscores.

Change event keys

A change event’s key contains the schema for the changed table’s key and the changed row’s actual key. Both the schema and its corresponding payload contain a field for each column in the changed table’sPRIMARY KEY(or unique constraint) at the time the connector created the event.

Consider the followingcustomerstable, which is followed by an example of a change event key for this table.

CREATE TABLE customers ( id INTEGER NOT NULL AUTO_INCREMENT PRIMARY KEY, first_name VARCHAR(255) NOT NULL, last_name VARCHAR(255) NOT NULL, email VARCHAR(255) NOT NULL UNIQUE KEY ) AUTO_INCREMENT=1001;

Every change event that captures a change to thecustomerstable has the same event key schema. For as long as thecustomerstable has the previous definition, every change event that captures a change to thecustomerstable has the following key structure. In JSON, it looks like this:

{ "schema": {(1)"type": "struct", "name": "mysql-server-1.inventory.customers.Key",(2)"optional": false,(3)"fields": [(4){ "field": "id", "type": "int32", "optional": false } ] }, "payload": {(5)"id": 1001 } }
Table 10. Description of change event key
Item Field name Description

1

schema

的schema portion of the key specifies a Kafka Connect schema that describes what is in the key’spayloadportion.

2

mysql-server-1.inventory.customers.Key

Name of the schema that defines the structure of the key’s payload. This schema describes the structure of the primary key for the table that was changed. Key schema names have the formatconnector-name．database-name．table-name．Key．In this example:

  • mysql-server-1is the name of the connector that generated this event.

  • inventoryis the database that contains the table that was changed.

  • customersis the table that was updated.

3

optional

Indicates whether the event key must contain a value in itspayloadfield. In this example, a value in the key’s payload is required. A value in the key’s payload field is optional when a table does not have a primary key.

4

fields

Specifies each field that is expected in thepayload, including each field’s name, type, and whether it is required.

5

payload

Contains the key for the row for which this change event was generated. In this example, the key, contains a singleidfield whose value is1001．

Change event values

的value in a change event is a bit more complicated than the key. Like the key, the value has aschemasection and apayloadsection. Theschemasection contains the schema that describes theEnvelopestructure of thepayloadsection, including its nested fields. Change events for operations that create, update or delete data all have a value payload with an envelope structure.

Consider the same sample table that was used to show an example of a change event key:

CREATE TABLE customers ( id INTEGER NOT NULL AUTO_INCREMENT PRIMARY KEY, first_name VARCHAR(255) NOT NULL, last_name VARCHAR(255) NOT NULL, email VARCHAR(255) NOT NULL UNIQUE KEY ) AUTO_INCREMENT=1001;

的value portion of a change event for a change to this table is described for:

createevents

的following example shows the value portion of a change event that the connector generates for an operation that creates data in thecustomerstable:

{ "schema": {(1)"type": "struct", "fields": [ { "type": "struct", "fields": [ { "type": "int32", "optional": false, "field": "id" }, { "type": "string", "optional": false, "field": "first_name" }, { "type": "string", "optional": false, "field": "last_name" }, { "type": "string", "optional": false, "field": "email" } ], "optional": true, "name": "mysql-server-1.inventory.customers.Value",(2)“字段”:“之前”},{“类型”:“结构”、“字段”:[ { "type": "int32", "optional": false, "field": "id" }, { "type": "string", "optional": false, "field": "first_name" }, { "type": "string", "optional": false, "field": "last_name" }, { "type": "string", "optional": false, "field": "email" } ], "optional": true, "name": "mysql-server-1.inventory.customers.Value", "field": "after" }, { "type": "struct", "fields": [ { "type": "string", "optional": false, "field": "version" }, { "type": "string", "optional": false, "field": "connector" }, { "type": "string", "optional": false, "field": "name" }, { "type": "int64", "optional": false, "field": "ts_ms" }, { "type": "boolean", "optional": true, "default": false, "field": "snapshot" }, { "type": "string", "optional": false, "field": "db" }, { "type": "string", "optional": true, "field": "table" }, { "type": "int64", "optional": false, "field": "server_id" }, { "type": "string", "optional": true, "field": "gtid" }, { "type": "string", "optional": false, "field": "file" }, { "type": "int64", "optional": false, "field": "pos" }, { "type": "int32", "optional": false, "field": "row" }, { "type": "int64", "optional": true, "field": "thread" }, { "type": "string", "optional": true, "field": "query" } ], "optional": false, "name": "io.debezium.connector.mysql.Source",(3)"field": "source" }, { "type": "string", "optional": false, "field": "op" }, { "type": "int64", "optional": true, "field": "ts_ms" } ], "optional": false, "name": "mysql-server-1.inventory.customers.Envelope"(4)}, "payload": {(5)"op": "c",(6)"ts_ms": 1465491411815,(7)"before": null,(8)"after": {(9)"id": 1004, "first_name": "Anne", "last_name": "Kretchmar", "email": "annek@noanswer.org" }, "source": {(10)"version": "2.2.0.Alpha2", "connector": "mysql", "name": "mysql-server-1", "ts_ms": 0, "snapshot": false, "db": "inventory", "table": "customers", "server_id": 0, "gtid": null, "file": "mysql-bin.000003", "pos": 154, "row": 0, "thread": 7, "query": "INSERT INTO customers (first_name, last_name, email) VALUES ('Anne', 'Kretchmar', 'annek@noanswer.org')" } } }
Table 11. Descriptions ofcreateevent value fields
Item Field name Description

1

schema

的value’s schema, which describes the structure of the value’s payload. A change event’s value schema is the same in every change event that the connector generates for a particular table.

2

name

In theschemasection, eachnamefield specifies the schema for a field in the value’s payload.

mysql-server-1.inventory.customers.Valueis the schema for the payload’sbeforeandafterfields. This schema is specific to thecustomerstable.

Names of schemas forbeforeandafterfields are of the formlogicalName．tableName．Value, which ensures that the schema name is unique in the database. This means that when using theAvro converter, the resulting Avro schema for each table in each logical source has its own evolution and history.

3

name

io.debezium.connector.mysql.Sourceis the schema for the payload’ssourcefield. This schema is specific to the MySQL connector. The connector uses it for all events that it generates.

4

name

mysql-server-1.inventory.customers.Envelopeis the schema for the overall structure of the payload, wheremysql-server-1is the connector name,inventoryis the database, andcustomersis the table.

5

payload

的value’s actual data. This is the information that the change event is providing.

It may appear that the JSON representations of the events are much larger than the rows they describe. This is because the JSON representation must include the schema and the payload portions of the message. However, by using theAvro converter, you can significantly decrease the size of the messages that the connector streams to Kafka topics.

6

op

Mandatory string that describes the type of operation that caused the connector to generate the event. In this example,cindicates that the operation created a row. Valid values are:

  • c= create

  • u= update

  • d= delete

  • r= read (applies to only snapshots)

7

ts_ms

Optional field that displays the time at which the connector processed the event. The time is based on the system clock in the JVM running the Kafka Connect task.

In thesourceobject,ts_msindicates the time that the change was made in the database. By comparing the value forpayload.source.ts_mswith the value forpayload.ts_ms, you can determine the lag between the source database update and Debezium.

8

before

An optional field that specifies the state of the row before the event occurred. When theopfield iscfor create, as it is in this example, thebeforefield isnullsince this change event is for new content.

9

after

An optional field that specifies the state of the row after the event occurred. In this example, theafterfield contains the values of the new row’sid,first_name,last_name, andemailcolumns.

10

source

Mandatory field that describes the source metadata for the event. This field contains information that you can use to compare this event with other events, with regard to the origin of the events, the order in which the events occurred, and whether events were part of the same transaction. The source metadata includes:

  • Debezium version

  • Connector name

  • binlog name where the event was recorded

  • binlog position

  • Row within the event

  • If the event was part of a snapshot

  • Name of the database and table that contain the new row

  • ID of the MySQL thread that created the event (non-snapshot only)

  • MySQL server ID (if available)

  • Timestamp for when the change was made in the database

If thebinlog_rows_query_log_eventsMySQL configuration option is enabled and the connector configurationinclude.queryproperty is enabled, thesourcefield also provides thequeryfield, which contains the original SQL statement that caused the change event.

updateevents

的value of a change event for an update in the samplecustomerstable has the same schema as acreateevent for that table. Likewise, the event value’s payload has the same structure. However, the event value payload contains different values in anupdateevent. Here is an example of a change event value in an event that the connector generates for an update in thecustomerstable:

{ "schema": { ... }, "payload": { "before": {(1)"id": 1004, "first_name": "Anne", "last_name": "Kretchmar", "email": "annek@noanswer.org" }, "after": {(2)"id": 1004, "first_name": "Anne Marie", "last_name": "Kretchmar", "email": "annek@noanswer.org" }, "source": {(3)"version": "2.2.0.Alpha2", "name": "mysql-server-1", "connector": "mysql", "name": "mysql-server-1", "ts_ms": 1465581029100, "snapshot": false, "db": "inventory", "table": "customers", "server_id": 223344, "gtid": null, "file": "mysql-bin.000003", "pos": 484, "row": 0, "thread": 7, "query": "UPDATE customers SET first_name='Anne Marie' WHERE id=1004" }, "op": "u",(4)"ts_ms": 1465581029523(5)} }
Table 12. Descriptions ofupdateevent value fields
Item Field name Description

1

before

An optional field that specifies the state of the row before the event occurred. In anupdateevent value, thebeforefield contains a field for each table column and the value that was in that column before the database commit. In this example, thefirst_namevalue isAnne.

2

after

An optional field that specifies the state of the row after the event occurred. You can compare thebeforeandafterstructures to determine what the update to this row was. In the example, thefirst_namevalue is nowAnne Marie．

3

source

Mandatory field that describes the source metadata for the event. Thesourcefield structure has the same fields as in acreateevent, but some values are different, for example, the sampleupdateevent is from a different position in the binlog. The source metadata includes:

  • Debezium version

  • Connector name

  • binlog name where the event was recorded

  • binlog position

  • Row within the event

  • If the event was part of a snapshot

  • Name of the database and table that contain the updated row

  • ID of the MySQL thread that created the event (non-snapshot only)

  • MySQL server ID (if available)

  • Timestamp for when the change was made in the database

If thebinlog_rows_query_log_eventsMySQL configuration option is enabled and the connector configurationinclude.queryproperty is enabled, thesourcefield also provides thequeryfield, which contains the original SQL statement that caused the change event.

4

op

Mandatory string that describes the type of operation. In anupdateevent value, theopfield value isu, signifying that this row changed because of an update.

5

ts_ms

Optional field that displays the time at which the connector processed the event. The time is based on the system clock in the JVM running the Kafka Connect task.

In thesourceobject,ts_msindicates the time that the change was made in the database. By comparing the value forpayload.source.ts_mswith the value forpayload.ts_ms, you can determine the lag between the source database update and Debezium.

Updating the columns for a row’s primary/unique key changes the value of the row’s key. When a key changes, Debezium outputsthreeevents: aDELETEevent and atombstone eventwith the old key for the row, followed by an event with the new key for the row. Details are in the next section.

Primary key updates

AnUPDATEoperation that changes a row’s primary key field(s) is known as a primary key change. For a primary key change, in place of anUPDATEevent record, the connector emits aDELETEevent record for the old key and aCREATEevent record for the new (updated) key. These events have the usual structure and content, and in addition, each one has a message header related to the primary key change:

  • 的DELETEevent record has__debezium.newkeyas a message header. The value of this header is the new primary key for the updated row.

  • 的CREATEevent record has__debezium.oldkeyas a message header. The value of this header is the previous (old) primary key that the updated row had.

deleteevents

的value in adeletechange event has the sameschemaportion ascreateandupdateevents for the same table. Thepayloadportion in adeleteevent for the samplecustomerstable looks like this:

{ "schema": { ... }, "payload": { "before": {(1)"id": 1004, "first_name": "Anne Marie", "last_name": "Kretchmar", "email": "annek@noanswer.org" }, "after": null,(2)"source": {(3)"version": "2.2.0.Alpha2", "connector": "mysql", "name": "mysql-server-1", "ts_ms": 1465581902300, "snapshot": false, "db": "inventory", "table": "customers", "server_id": 223344, "gtid": null, "file": "mysql-bin.000003", "pos": 805, "row": 0, "thread": 7, "query": "DELETE FROM customers WHERE id=1004" }, "op": "d",(4)"ts_ms": 1465581902461(5)} }
Table 13. Descriptions ofdeleteevent value fields
Item Field name Description

1

before

Optional field that specifies the state of the row before the event occurred. In adeleteevent value, thebeforefield contains the values that were in the row before it was deleted with the database commit.

2

after

Optional field that specifies the state of the row after the event occurred. In adeleteevent value, theafterfield isnull, signifying that the row no longer exists.

3

source

Mandatory field that describes the source metadata for the event. In adeleteevent value, thesourcefield structure is the same as forcreateandupdateevents for the same table. Manysourcefield values are also the same. In adeleteevent value, thets_msandposfield values, as well as other values, might have changed. But thesourcefield in adeleteevent value provides the same metadata:

  • Debezium version

  • Connector name

  • binlog name where the event was recorded

  • binlog position

  • Row within the event

  • If the event was part of a snapshot

  • Name of the database and table that contain the updated row

  • ID of the MySQL thread that created the event (non-snapshot only)

  • MySQL server ID (if available)

  • Timestamp for when the change was made in the database

If thebinlog_rows_query_log_eventsMySQL configuration option is enabled and the connector configurationinclude.queryproperty is enabled, thesourcefield also provides thequeryfield, which contains the original SQL statement that caused the change event.

4

op

Mandatory string that describes the type of operation. Theopfield value isd, signifying that this row was deleted.

5

ts_ms

Optional field that displays the time at which the connector processed the event. The time is based on the system clock in the JVM running the Kafka Connect task.

In thesourceobject,ts_msindicates the time that the change was made in the database. By comparing the value forpayload.source.ts_mswith the value forpayload.ts_ms, you can determine the lag between the source database update and Debezium.

Adeletechange event record provides a consumer with the information it needs to process the removal of this row. The old values are included because some consumers might require them in order to properly handle the removal.

MySQL connector events are designed to work withKafka log compaction．Log compaction enables removal of some older messages as long as at least the most recent message for every key is kept. This lets Kafka reclaim storage space while ensuring that the topic contains a complete data set and can be used for reloading key-based state.

Tombstone events

When a row is deleted, thedeleteevent value still works with log compaction, because Kafka can remove all earlier messages that have that same key. However, for Kafka to remove all messages that have that same key, the message value must benull．To make this possible, after Debezium’s MySQL connector emits adeleteevent, the connector emits a special tombstone event that has the same key but anullvalue.

truncateevents

Atruncatechange event signals that a table has been truncated. The message key isnullin this case, the message value looks like this:

{ "schema": { ... }, "payload": { "source": {(1)"version": "2.2.0.Alpha2", "name": "mysql-server-1", "connector": "mysql", "name": "mysql-server-1", "ts_ms": 1465581029100, "snapshot": false, "db": "inventory", "table": "customers", "server_id": 223344, "gtid": null, "file": "mysql-bin.000003", "pos": 484, "row": 0, "thread": 7, "query": "UPDATE customers SET first_name='Anne Marie' WHERE id=1004" }, "op": "t",(2)"ts_ms": 1465581029523(3)} }
Table 14. Descriptions oftruncateevent value fields
Item Field name Description

1

source

Mandatory field that describes the source metadata for the event. In atruncateevent value, thesourcefield structure is the same as forcreate,update, anddeleteevents for the same table, provides this metadata:

  • Debezium version

  • Connector type and name

  • Binlog name where the event was recorded

  • Binlog position

  • Row within the event

  • If the event was part of a snapshot

  • Name of the database and table

  • 截断的MySQL线程IDevent (non-snapshot only)

  • MySQL server ID (if available)

  • Timestamp for when the change was made in the database

2

op

Mandatory string that describes the type of operation. Theopfield value ist, signifying that this table was truncated.

3

ts_ms

Optional field that displays the time at which the connector processed the event. The time is based on the system clock in the JVM running the Kafka Connect task.

+ In thesourceobject,ts_msindicates the time that the change was made in the database. By comparing the value forpayload.source.ts_mswith the value forpayload.ts_ms, you can determine the lag between the source database update and Debezium.

In case a singleTRUNCATEstatement applies to multiple tables, onetruncatechange event record for each truncated table will be emitted.

Note that sincetruncateevents represent a change made to an entire table and don’t have a message key, unless you’re working with topics with a single partition, there are no ordering guarantees for the change events pertaining to a table (create,update, etc.) andtruncateevents for that table. For instance a consumer may receive anupdateevent only after atruncateevent for that table, when those events are read from different partitions.

Data type mappings

的Debezium MySQL connector represents changes to rows with events that are structured like the table in which the row exists. The event contains a field for each column value. The MySQL data type of that column dictates how Debezium represents the value in the event.

Columns that store strings are defined in MySQL with a character set and collation. The MySQL connector uses the column’s character set when reading the binary representation of the column values in the binlog events.

的connector can map MySQL data types to bothliteralandsemantictypes.

  • Literal type: how the value is represented using Kafka Connect schema types.

  • Semantic type: how the Kafka Connect schema captures the meaning of the field (schema name).

If the default data type conversions do not meet your needs, you cancreate a custom converterfor the connector.

Basic types

的following table shows how the connector maps basic MySQL data types.

Table 15. Descriptions of basic type mappings
MySQL type Literal type Semantic type

BOOLEAN, BOOL

BOOLEAN

n/a

BIT(1)

BOOLEAN

n/a

BIT(>1)

BYTES

io.debezium.data.Bits
的lengthschema parameter contains an integer that represents the number of bits. Thebyte[]contains the bits inlittle-endianform and is sized to contain the specified number of bits. For example, wherenis bits:
numBytes = n/8 + (n%8== 0 ? 0 : 1)

TINYINT

INT16

n/a

SMALLINT[(M)]

INT16

n/a

MEDIUMINT[(M)]

INT32

n/a

INT, INTEGER[(M)]

INT32

n/a

BIGINT[(M)]

INT64

n/a

REAL[(M,D)]

FLOAT32

n/a

FLOAT[(P)]

FLOAT32orFLOAT64

的precision is used only to determine storage size. A precisionPfrom 0 to 23 results in a 4-byte single-precisionFLOAT32column. A precisionPfrom 24 to 53 results in an 8-byte double-precisionFLOAT64column.

FLOAT(M,D)

FLOAT64

As of MySQL 8.0.17, the nonstandard FLOAT(M,D) and DOUBLE(M,D) syntax is deprecated, and should expect support for it be removed in a future version of MySQL, setFLOAT64as default.

DOUBLE[(M,D)]

FLOAT64

n/a

CHAR(M)]

STRING

n/a

VARCHAR(M)]

STRING

n/a

BINARY(M)]

BYTESorSTRING

n/a
Either the raw bytes (the default), a base64-encoded String, or a base64-url-safe-encoded String, or a hex-encoded String, based on thebinary.handling.modeconnector configuration property setting.

VARBINARY(M)]

BYTESorSTRING

n/a
Either the raw bytes (the default), a base64-encoded String, or a base64-url-safe-encoded String, or a hex-encoded String, based on thebinary.handling.modeconnector configuration property setting.

TINYBLOB

BYTESorSTRING

n/a
Either the raw bytes (the default), a base64-encoded String, or a base64-url-safe-encoded String, or a hex-encoded String, based on thebinary.handling.modeconnector configuration property setting.

TINYTEXT

STRING

n/a

BLOB

BYTESorSTRING

n/a
Either the raw bytes (the default), a base64-encoded String, or a base64-url-safe-encoded String, or a hex-encoded String, based on thebinary.handling.modeconnector configuration property setting.
Only values with a size of up to 2GB are supported. It is recommended to externalize large column values, using the claim check pattern.

TEXT

STRING

n/a
Only values with a size of up to 2GB are supported. It is recommended to externalize large column values, using the claim check pattern.

MEDIUMBLOB

BYTESorSTRING

n/a
Either the raw bytes (the default), a base64-encoded String, or a base64-url-safe-encoded String, or a hex-encoded String, based on thebinary.handling.modeconnector configuration property setting.

MEDIUMTEXT

STRING

n/a

LONGBLOB

BYTESorSTRING

n/a
Either the raw bytes (the default), a base64-encoded String, or a base64-url-safe-encoded String, or a hex-encoded String, based on thebinary.handling.modeconnector configuration property setting.
Only values with a size of up to 2GB are supported. It is recommended to externalize large column values, using the claim check pattern.

LONGTEXT

STRING

n/a
Only values with a size of up to 2GB are supported. It is recommended to externalize large column values, using the claim check pattern.

JSON

STRING

io.debezium.data.Json
Contains the string representation of aJSONdocument, array, or scalar.

ENUM

STRING

io.debezium.data.Enum
的allowedschema parameter contains the comma-separated list of allowed values.

SET

STRING

io.debezium.data.EnumSet
的allowedschema parameter contains the comma-separated list of allowed values.

YEAR[(2|4)]

INT32

io.debezium.time.Year

TIMESTAMP[(M)]

STRING

io.debezium.time.ZonedTimestamp
InISO 8601format with microsecond precision. MySQL allowsMto be in the range of0-6．

Temporal types

Excluding theTIMESTAMPdata type, MySQL temporal types depend on the value of thetime.precision.mode连接器配置属性。ForTIMESTAMPcolumns whose default value is specified asCURRENT_TIMESTAMPorNOW, the value1970-01-01 00:00:00is used as the default value in the Kafka Connect schema.

MySQL allows zero-values forDATE,DATETIME, andTIMESTAMPcolumns because zero-values are sometimes preferred over null values. The MySQL connector represents zero-values as null values when the column definition allows null values, or as the epoch day when the column does not allow null values.

Temporal values without time zones

的DATETIMEtype represents a local date and time such as "2018-01-13 09:48:27". As you can see, there is no time zone information. Such columns are converted into epoch milliseconds or microseconds based on the column’s precision by using UTC. TheTIMESTAMPtype represents a timestamp without time zone information. It is converted by MySQL from the server (or session’s) current time zone into UTC when writing and from UTC into the server (or session’s) current time zone when reading back the value. For example:

  • DATETIMEwith a value of2018-06-20 06:37:03becomes1529476623000．

  • TIMESTAMPwith a value of2018-06-20 06:37:03becomes2018-06-20T13:37:03Z．

Such columns are converted into an equivalentio.debezium.time.ZonedTimestampin UTC based on the server (or session’s) current time zone. The time zone will be queried from the server by default. If this fails, it must be specified explicitly by the databaseconnectionTimeZoneMySQL configuration option. For example, if the database’s time zone (either globally or configured for the connector by means of theconnectionTimeZoneoption) is "America/Los_Angeles", the TIMESTAMP value "2018-06-20 06:37:03" is represented by aZonedTimestampwith the value "2018-06-20T13:37:03Z".

的time zone of the JVM running Kafka Connect and Debezium does not affect these conversions.

More details about properties related to temporal values are in the documentation forMySQL connector configuration properties．

time.precision.mode=adaptive_time_microseconds(default)

的MySQL connector determines the literal type and semantic type based on the column’s data type definition so that events represent exactly the values in the database. All time fields are in microseconds. Only positiveTIMEfield values in the range of00:00:00.000000to23:59:59.999999can be captured correctly.

Table 16. Mappings whentime.precision.mode=adaptive_time_microseconds
MySQL type Literal type Semantic type

DATE

INT32

io.debezium.time.Date
代表resents the number of days since the epoch.

TIME[(M)]

INT64

io.debezium.time.MicroTime
代表resents the time value in microseconds and does not include time zone information. MySQL allowsMto be in the range of0-6．

DATETIME, DATETIME(0), DATETIME(1), DATETIME(2), DATETIME(3)

INT64

io.debezium.time.Timestamp
代表resents the number of milliseconds past the epoch and does not include time zone information.

DATETIME(4), DATETIME(5), DATETIME(6)

INT64

io.debezium.time.MicroTimestamp
代表resents the number of microseconds past the epoch and does not include time zone information.
time.precision.mode =连接

卡夫卡连接定义的MySQL连接器使用日志ical types. This approach is less precise than the default approach and the events could be less precise if the database column has afractional second precisionvalue of greater than3．Values in only the range of00:00:00.000to23:59:59.999can be handled. Settime.precision.mode =连接only if you can ensure that theTIMEvalues in your tables never exceed the supported ranges. Theconnectsetting is expected to be removed in a future version of Debezium.

Table 17. Mappings whentime.precision.mode =连接
MySQL type Literal type Semantic type

DATE

INT32

org.apache.kafka.connect.data.Date
代表resents the number of days since the epoch.

TIME[(M)]

INT64

org.apache.kafka.connect.data.Time
代表resents the time value in microseconds since midnight and does not include time zone information.

DATETIME[(M)]

INT64

org.apache.kafka.connect.data.Timestamp
代表resents the number of milliseconds since the epoch, and does not include time zone information.

Decimal types

Debezium connectors handle decimals according to the setting of thedecimal.handling.modeconnector configuration property．

decimal.handling.mode=precise
Table 18. Mappings whendecimal.handling.mode=precise
MySQL type Literal type Semantic type

NUMERIC[(M[,D])]

BYTES

org.apache.kafka.connect.data.Decimal
的scaleschema parameter contains an integer that represents how many digits the decimal point shifted.

DECIMAL[(M[,D])]

BYTES

org.apache.kafka.connect.data.Decimal
的scaleschema parameter contains an integer that represents how many digits the decimal point shifted.
decimal.handling.mode=double
Table 19. Mappings whendecimal.handling.mode=double
MySQL type Literal type Semantic type

NUMERIC[(M[,D])]

FLOAT64

n/a

DECIMAL[(M[,D])]

FLOAT64

n/a
decimal.handling.mode=string
Table 20. Mappings whendecimal.handling.mode=string
MySQL type Literal type Semantic type

NUMERIC[(M[,D])]

STRING

n/a

DECIMAL[(M[,D])]

STRING

n/a

Boolean values

MySQL handles theBOOLEANvalue internally in a specific way. TheBOOLEANcolumn is internally mapped to theTINYINT(1)data type. When the table is created during streaming then it uses properBOOLEANmapping as Debezium receives the original DDL. During snapshots, Debezium executesSHOW CREATE TABLEto obtain table definitions that returnTINYINT(1)for bothBOOLEANandTINYINT(1)columns. Debezium then has no way to obtain the original type mapping and so maps toTINYINT(1)．

To enable you to convert source columns to Boolean data types, Debezium provides aTinyIntOneToBooleanConvertercustom converterthat you can use in one of the following ways:

  • Map allTINYINT(1)orTINYINT(1) UNSIGNEDcolumns toBOOLEANtypes.

  • Enumerate a subset of columns by using a comma-separated list of regular expressions.
    To use this type of conversion, you must set theconvertersconfiguration property with theselectorparameter, as shown in the following example:

    converters=boolean boolean.type=io.debezium.connector.mysql.converters.TinyIntOneToBooleanConverter boolean.selector=db1.table1.*, db1.table2.column1

  • NOTE: MySQL8 not showing the length oftinyint unsignedtype when snapshot executesSHOW CREATE TABLE, which means this converter doesn’t work. The new optionlength.checkercan solve this issue, the default value istrue．Disable thelength.checkerand specify the columns that need to be converted toselectorproperty instead of converting all columns based on type, as shown in the following example:

    converters=boolean boolean.type=io.debezium.connector.mysql.converters.TinyIntOneToBooleanConverter boolean.length.checker=false boolean.selector=db1.table1.*, db1.table2.column1

Spatial types

Currently, the Debezium MySQL connector supports the following spatial data types.

Table 21. Description of spatial type mappings
MySQL type Literal type Semantic type

GEOMETRY,
LINESTRING,
POLYGON,
MULTIPOINT,
MULTILINESTRING,
MULTIPOLYGON,
GEOMETRYCOLLECTION

STRUCT

io.debezium.data.geometry.Geometry
Contains a structure with two fields:

  • srid (INT32: spatial reference system ID that defines the type of geometry object stored in the structure

  • wkb (BYTES): binary representation of the geometry object encoded in the Well-Known-Binary (wkb) format. See theOpen Geospatial Consortiumfor more details.

Setting up MySQL

Some MySQL setup tasks are required before you can install and run a Debezium connector.

Creating a user

A Debezium MySQL connector requires a MySQL user account. This MySQL user must have appropriate permissions on all databases for which the Debezium MySQL connector captures changes.

Prerequisites

  • A MySQL server.

  • Basic knowledge of SQL commands.

Procedure

  1. Create the MySQL user:

    mysql> CREATE USER 'user'@'localhost' IDENTIFIED BY 'password';

  2. Grant the required permissions to the user:

    mysql> GRANT SELECT, RELOAD, SHOW DATABASES, REPLICATION SLAVE, REPLICATION CLIENT ON *.* TO 'user' IDENTIFIED BY 'password';

    的table below describes the permissions.

    If using a hosted option such as Amazon RDS or Amazon Aurora that does not allow a global read lock, table-level locks are used to create theconsistent snapshot．In this case, you need to also grantLOCK TABLESpermissions to the user that you create. Seesnapshotsfor more details.

  3. Finalize the user’s permissions:

    mysql> FLUSH PRIVILEGES;
Table 22. Descriptions of user permissions
Keyword Description

SELECT

Enables the connector to select rows from tables in databases. This is used only when performing a snapshot.

RELOAD

Enables the connector the use of theFLUSHstatement to clear or reload internal caches, flush tables, or acquire locks. This is used only when performing a snapshot.

SHOW DATABASES

Enables the connector to see database names by issuing theSHOW DATABASEstatement. This is used only when performing a snapshot.

REPLICATION SLAVE

Enables the connector to connect to and read the MySQL server binlog.

REPLICATION CLIENT

Enables the connector the use of the following statements:

  • SHOW MASTER STATUS

  • SHOW SLAVE STATUS

  • SHOW BINARY LOGS

的connector always requires this.

ON

Identifies the database to which the permissions apply.

TO 'user'

Specifies the user to grant the permissions to.

IDENTIFIED BY 'password'

Specifies the user’s MySQL password.

Enabling the binlog

你必须enable binary logging for MySQL replication. The binary logs record transaction updates for replication tools to propagate changes.

Prerequisites

  • A MySQL server.

  • Appropriate MySQL user privileges.

Procedure

  1. Check whether thelog-binoption is already on:

    // for MySql 5.x mysql> SELECT variable_value as "BINARY LOGGING STATUS (log-bin) ::" FROM information_schema.global_variables WHERE variable_name='log_bin'; // for MySql 8.x mysql> SELECT variable_value as "BINARY LOGGING STATUS (log-bin) ::" FROM performance_schema.global_variables WHERE variable_name='log_bin';

  2. If it isOFF, configure your MySQL server configuration file with the following properties, which are described in the table below:

    server-id = 223344 # Querying variable is called server_id, e.g. SELECT variable_value FROM information_schema.global_variables WHERE variable_name='server_id'; log_bin = mysql-bin binlog_format = ROW binlog_row_image = FULL expire_logs_days = 10

  3. Confirm your changes by checking the binlog status once more:

    // for MySql 5.x mysql> SELECT variable_value as "BINARY LOGGING STATUS (log-bin) ::" FROM information_schema.global_variables WHERE variable_name='log_bin'; // for MySql 8.x mysql> SELECT variable_value as "BINARY LOGGING STATUS (log-bin) ::" FROM performance_schema.global_variables WHERE variable_name='log_bin';
Table 23. Descriptions of MySQL binlog configuration properties
Property Description

server-id

的value for theserver-idmust be unique for each server and replication client in the MySQL cluster. During MySQL connector set up, Debezium assigns a unique server ID to the connector.

log_bin

的value oflog_binis the base name of the sequence of binlog files.

binlog_format

的binlog-formatmust be set toROWorrow．

binlog_row_image

的binlog_row_imagemust be set toFULLorfull．

expire_logs_days

This is the number of days for automatic binlog file removal. The default is0, which means no automatic removal. Set the value to match the needs of your environment. SeeMySQL purges binlog files．

Enabling GTIDs

Global transaction identifiers (GTIDs) uniquely identify transactions that occur on a server within a cluster. Though not required for a Debezium MySQL connector, using GTIDs simplifies replication and enables you to more easily confirm if primary and replica servers are consistent.

GTIDs are available in MySQL 5.6.5 and later. See theMySQL documentationfor more details.

Prerequisites

  • A MySQL server.

  • Basic knowledge of SQL commands.

  • Access to the MySQL configuration file.

Procedure

  1. Enablegtid_mode:

    mysql> gtid_mode=ON

  2. Enableenforce_gtid_consistency:

    mysql> enforce_gtid_consistency=ON

  3. Confirm the changes:

    mysql> show global variables like '%GTID%';
Result
+--------------------------+-------+ | Variable_name | Value | +--------------------------+-------+ | enforce_gtid_consistency | ON | | gtid_mode | ON | +--------------------------+-------+
Table 24. Descriptions of GTID options
Option Description

gtid_mode

Boolean that specifies whether GTID mode of the MySQL server is enabled or not.

  • ON= enabled

  • OFF= disabled

enforce_gtid_consistency

Boolean that specifies whether the server enforces GTID consistency by allowing the execution of statements that can be logged in a transactionally safe manner. Required when using GTIDs.

  • ON= enabled

  • OFF= disabled

Configuring session timeouts

When an initial consistent snapshot is made for large databases, your established connection could timeout while the tables are being read. You can prevent this behavior by configuringinteractive_timeoutandwait_timeoutin your MySQL configuration file.

Prerequisites

  • A MySQL server.

  • Basic knowledge of SQL commands.

  • Access to the MySQL configuration file.

Procedure

  1. Configureinteractive_timeout:

    mysql> interactive_timeout=

  2. Configurewait_timeout:

    mysql> wait_timeout=
Table 25. Descriptions of MySQL session timeout options
Option Description

interactive_timeout

的number of seconds the server waits for activity on an interactive connection before closing it. SeeMySQL’s documentationfor more details.

wait_timeout

的number of seconds the server waits for activity on a non-interactive connection before closing it. SeeMySQL’s documentationfor more details.

Enabling query log events

You might want to see the originalSQLstatement for each binlog event. Enabling thebinlog_rows_query_log_eventsoption in the MySQL configuration file allows you to do this.

This option is available in MySQL 5.6 and later.

Prerequisites

  • A MySQL server.

  • Basic knowledge of SQL commands.

  • Access to the MySQL configuration file.

Procedure

  • Enablebinlog_rows_query_log_events:

    mysql> binlog_rows_query_log_events=ON

    binlog_rows_query_log_eventsis set to a value that enables/disables support for including the originalSQLstatement in the binlog entry.

    • ON= enabled

    • OFF= disabled

Validating binlog row value options

Checkbinlog_row_value_optionsvariable, and make sure that value isnotset toPARTIAL_JSON, since in such case connector might fail to consumeUPDATEevents.

Prerequisites

  • A MySQL server.

  • Basic knowledge of SQL commands.

  • Access to the MySQL configuration file.

Procedure

  1. Check current variable value

    mysql> show global variables where variable_name = 'binlog_row_value_options';

  2. Result

    +--------------------------+-------+ | Variable_name | Value | +--------------------------+-------+ | binlog_row_value_options | | +--------------------------+-------+

  3. In case value isPARTIAL_JSON, unset this variable by:

    mysql> set @@global.binlog_row_value_options="" ;

Deployment

To deploy a Debezium MySQL connector, you install the Debezium MySQL connector archive, configure the connector, and start the connector by adding its configuration to Kafka Connect.

Prerequisites
Procedure

  1. Download the DebeziumMySQL connector plug-in．

  2. Extract the files into your Kafka Connect environment.

  3. Add the directory with the JAR files toKafka Connect’splugin.path．

  4. Configure the connectorandadd the configuration to your Kafka Connect cluster.

  5. Restart your Kafka Connect process to pick up the new JAR files.

If you are working with immutable containers, seeDebezium’s Container imagesfor Apache Zookeeper, Apache Kafka, MySQL, and Kafka Connect with the MySQL connector already installed and ready to run.

You can alsorun Debezium on Kubernetes and OpenShift．

MySQL connector configuration example

Following is an example of the configuration for a connector instance that captures data from a MySQL server on port 3306 at 192.168.99.100, which we logically namefullfillment．Typically, you configure the Debezium MySQL connector in a JSON file by setting the configuration properties that are available for the connector.

You can choose to produce events for a subset of the schemas and tables in a database. Optionally, you can ignore, mask, or truncate columns that contain sensitive data, that are larger than a specified size, or that you do not need.

{ "name": "inventory-connector",(1)"config": { "connector.class": "io.debezium.connector.mysql.MySqlConnector",(2)"database.hostname": "192.168.99.100",(3)"database.port": "3306",(4)"database.user": "debezium-user",(5)"database.password": "debezium-user-pw",(6)"database.server.id": "184054",(7)"topic.prefix": "fullfillment",(8)"database.include.list": "inventory",(9)"schema.history.internal.kafka.bootstrap.servers": "kafka:9092",(10)"schema.history.internal.kafka.topic": "schemahistory.fullfillment",(11)"include.schema.changes": "true"(12)} }
1 Connector’s name when registered with the Kafka Connect service.
2 Connector’s class name.
3 MySQL server address.
4 MySQL server port number.
5 MySQL user with the appropriate privileges.
6 MySQL user’s password.
7 Unique ID of the connector.
8 Topic prefix for the MySQL server or cluster.
9 List of databases hosted by the specified server.
10 List of Kafka brokers that the connector uses to write and recover DDL statements to the database schema history topic.
11 Name of the database schema history topic. This topic is for internal use only and should not be used by consumers.
12 Flag that specifies if the connector should generate events for DDL changes and emit them to thefulfillmentschema change topic for use by consumers.

For the complete list of the configuration properties that you can set for the Debezium MySQL connector, seeMySQL connector configuration properties．

You can send this configuration with aPOSTcommand to a running Kafka Connect service. The service records the configuration and starts one connector task that performs the following actions:

  • Connects to the MySQL database.

  • Reads change-data tables for tables in capture mode.

  • Streams change event records to Kafka topics.

Adding connector configuration

To start running a MySQL connector, configure a connector configuration, and add the configuration to your Kafka Connect cluster.

Prerequisites
Procedure

  1. Create a configuration for the MySQL connector.

  2. Use theKafka Connect REST APIto add that connector configuration to your Kafka Connect cluster.

Results

After the connector starts, itperforms a consistent snapshotof the MySQL databases that the connector is configured for. The connector then starts generating data change events for row-level operations and streaming change event records to Kafka topics.

Connector properties

的Debezium MySQL connector has numerous configuration properties that you can use to achieve the right connector behavior for your application. Many properties have default values. Information about the properties is organized as follows:

的following configuration properties arerequiredunless a default value is available.

Required Debezium MySQL connector configuration properties

Property Default Description

name

No default

Unique name for the connector. Attempting to register again with the same name fails. This property is required by all Kafka Connect connectors.

connector.class

No default

的名称Java class for the connector. Always specifyio.debezium.connector.mysql.MySqlConnectorfor the MySQL connector.

tasks.max

1

的maximum number of tasks that should be created for this connector. The MySQL connector always uses a single task and therefore does not use this value, so the default is always acceptable.

database.hostname

No default

IP address or host name of the MySQL database server.

database.port

3306

Integer port number of the MySQL database server.

database.user

No default

Name of the MySQL user to use when connecting to the MySQL database server.

database.password

No default

Password to use when connecting to the MySQL database server.

topic.prefix

No default

Topic prefix that provides a namespace for the particular MySQL database server/cluster in which Debezium 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 used in the database server logical name.

Do not change the value of this property. If you change the name value, after a restart, instead of continuing to emit events to the original topics, the connector emits subsequent events to topics whose names are based on the new value. The connector is also unable to recover its database schema history topic.

database.server.id

No default

A numeric ID of this database client, which must be unique across all currently-running database processes in the MySQL cluster. This connector joins the MySQL database cluster as another server (with this unique ID) so it can read the binlog.

database.include.list

empty string

一个可选,以逗号分隔的正则表达ssions that match the names of the databases for which to capture changes. The connector does not capture changes in any database whose name is not indatabase.include.list．By default, the connector captures changes in all databases.

To match the name of a database, Debezium applies the regular expression that you specify as ananchoredregular expression. That is, the specified expression is matched against the entire name string of the database; it does not match substrings that might be present in a database name.
If you include this property in the configuration, do not also set thedatabase.exclude.listproperty.

database.exclude.list

empty string

一个可选,以逗号分隔的正则表达ssions that match the names of databases for which you do not want to capture changes. The connector captures changes in any database whose name is not in thedatabase.exclude.list．

To match the name of a database, Debezium applies the regular expression that you specify as ananchoredregular expression. That is, the specified expression is matched against the entire name string of the database; it does not match substrings that might be present in a database name.
If you include this property in the configuration, do not also set thedatabase.include.listproperty.

table.include.list

empty string

一个可选,以逗号分隔的正则表达ssions that match fully-qualified table identifiers of tables whose changes you want to capture. The connector does not capture changes in any table that is not included intable.include.list．Each identifier is of the formdatabaseName．tableName．默认情况下,电动汽车连接器捕捉变化ery non-system table in each database whose changes are being captured.

To match the name of a table, Debezium applies the regular expression that you specify as ananchoredregular expression. That is, the specified expression is matched against the entire name string of the table; it does not match substrings that might be present in a table name.
If you include this property in the configuration, do not also set thetable.exclude.listproperty.

table.exclude.list

empty string

一个可选,以逗号分隔的正则表达ssions that match fully-qualified table identifiers for tables whose changes you do not want to capture. The connector captures changes in any table that is not included intable.exclude.list．Each identifier is of the formdatabaseName．tableName．

To match the name of a column, Debezium applies the regular expression that you specify as ananchoredregular expression. That is, the specified expression is matched against the entire name string of the table; it does not match substrings that might be present in a table name.
If you include this property in the configuration, do not also set thetable.include.listproperty.

column.exclude.list

empty string

一个可选,以逗号分隔的正则表达ssions that match the fully-qualified names of columns to exclude from change event record values. Fully-qualified names for columns are of the formdatabaseName．tableName．columnName．

To match the name of a column, Debezium applies the regular expression that you specify as ananchoredregular expression. That is, the specified expression is matched against the entire name string of the column; it does not match substrings that might be present in a column name. If you include this property in the configuration, do not also set thecolumn.include.listproperty.

column.include.list

empty string

一个可选,以逗号分隔的正则表达ssions that match the fully-qualified names of columns to include in change event record values. Fully-qualified names for columns are of the formdatabaseName．tableName．columnName．

To match the name of a column, Debezium applies the regular expression that you specify as ananchoredregular expression. That is, the specified expression is matched against the entire name string of the column; it does not match substrings that might be present in a column name.
If you include this property in the configuration, do not set thecolumn.exclude.listproperty.

column.truncate.to.length．chars

n/a

一个可选,以逗号分隔的正则表达ssions that match the fully-qualified names of character-based columns. Set this property if you want to truncate the data in a set of columns when it exceeds the number of characters specified by thelengthin the property name. Setlengthto a positive integer value, for example,column.truncate.to.20.chars．

的fully-qualified name of a column observes the following format:databaseName．tableName．columnName．To match the name of a column, Debezium applies the regular expression that you specify as ananchoredregular expression. That is, the specified expression is matched against the entire name string of the column; the expression does not match substrings that might be present in a column name.

You can specify multiple properties with different lengths in a single configuration.

column.mask.with.length．chars

n/a

一个可选,以逗号分隔的正则表达ssions that match the fully-qualified names of character-based columns. Set this property if you want the connector to mask the values for a set of columns, for example, if they contain sensitive data. Setlengthto a positive integer to replace data in the specified columns with the number of asterisk (*) characters specified by thelengthin the property name. Setlengthto0(zero) to replace data in the specified columns with an empty string.

的fully-qualified name of a column observes the following format:databaseName．tableName．columnName．To match the name of a column, Debezium applies the regular expression that you specify as ananchoredregular expression. That is, the specified expression is matched against the entire name string of the column; the expression does not match substrings that might be present in a column name.

You can specify multiple properties with different lengths in a single configuration.

column.mask.hash.hashAlgorithm．with.salt.salt;column.mask.hash.v2.hashAlgorithm．with.salt.salt

n/a

一个可选,以逗号分隔的正则表达ssions that match the fully-qualified names of character-based columns. Fully-qualified names for columns are of the form．．．
To match the name of a column Debezium applies the regular expression that you specify as ananchoredregular expression. That is, the specified expression is matched against the entire name string of the column; the expression does not match substrings that might be present in a column name. In the resulting change event record, the values for the specified columns are replaced with pseudonyms.

A pseudonym consists of the hashed value that results from applying the specifiedhashAlgorithmandsalt．Based on the hash function that is used, referential integrity is maintained, while column values are replaced with pseudonyms. Supported hash functions are described in theMessageDigest sectionof the Java Cryptography Architecture Standard Algorithm Name Documentation.

In the following example,CzQMA0cB5Kis a randomly selected salt.

column.mask.hash.sha with.salt.czq——256.MA0cB5K = inventory.orders.customerName, inventory.shipment.customerName

If necessary, the pseudonym is automatically shortened to the length of the column. The connector configuration can include multiple properties that specify different hash algorithms and salts.

Depending on thehashAlgorithmused, thesaltselected, and the actual data set, the resulting data set might not be completely masked.

Hashing strategy version 2 should be used to ensure fidelity if the value is being hashed in different places or systems.

column.propagate.source.type

n/a

一个可选,以逗号分隔的正则表达ssions that match the fully-qualified names of columns for which you want the connector to emit extra parameters that represent column metadata. When this property is set, the connector adds the following fields to the schema of event records:

  • __debezium.source.column.type

  • __debezium.source.column.length

  • __debezium.source.column.scale

的se parameters propagate a column’s original type name and length (for variable-width types), respectively.
Enabling the connector to emit this extra data can assist in properly sizing specific numeric or character-based columns in sink databases.

的fully-qualified name of a column observes one of the following formats:databaseName．tableName．columnName, ordatabaseName．schemaName．tableName．columnName．
To match the name of a column, Debezium applies the regular expression that you specify as ananchoredregular expression. That is, the specified expression is matched against the entire name string of the column; the expression does not match substrings that might be present in a column name.

datatype.propagate.source.type

n/a

一个可选,以逗号分隔的正则表达ssions that specify the fully-qualified names of data types that are defined for columns in a database. When this property is set, for columns with matching data types, the connector emits event records that include the following extra fields in their schema:

  • __debezium.source.column.type

  • __debezium.source.column.length

  • __debezium.source.column.scale

的se parameters propagate a column’s original type name and length (for variable-width types), respectively.
Enabling the connector to emit this extra data can assist in properly sizing specific numeric or character-based columns in sink databases.

的fully-qualified name of a column observes one of the following formats:databaseName．tableName．typeName, ordatabaseName．schemaName．tableName．typeName．
To match the name of a data type, Debezium applies the regular expression that you specify as ananchoredregular expression. That is, the specified expression is matched against the entire name string of the data type; the expression does not match substrings that might be present in a type name.

For the list of MySQL-specific data type names, see theMySQL data type mappings．

time.precision.mode

adaptive_time_microseconds

Time, date, and timestamps can be represented with different kinds of precision, including:

adaptive_time_microseconds(the default) captures the date, datetime and timestamp values exactly as in the database using either millisecond, microsecond, or nanosecond precision values based on the database column’s type, with the exception of TIME type fields, which are always captured as microseconds.

adaptive(deprecated) captures the time and timestamp values exactly as in the database using either millisecond, microsecond, or nanosecond precision values based on the database column’s type.

connectalways represents time and timestamp values using Kafka Connect’s built-in representations for Time, Date, and Timestamp, which use millisecond precision regardless of the database columns' precision.

decimal.handling.mode

precise

Specifies how the connector should handle values forDECIMALandNUMERICcolumns:

precise(the default) represents them precisely usingjava.math.BigDecimalvalues represented in change events in a binary form.

doublerepresents them usingdoublevalues, which may result in a loss of precision but is easier to use.

stringencodes values as formatted strings, which is easy to consume but semantic information about the real type is lost.

bigint.unsigned.handling.mode

long

Specifies how BIGINT UNSIGNED columns should be represented in change events. Possible settings are:

longrepresents values by using Java’slong, which might not offer the precision but which is easy to use in consumers.longis usually the preferred setting.

preciseusesjava.math.BigDecimalto represent values, which are encoded in the change events by using a binary representation and Kafka Connect’sorg.apache.kafka.connect.data.Decimaltype. Use this setting when working with values larger than 2^63, because these values cannot be conveyed by usinglong．

include.schema.changes

true

布尔值,用于指定是否连接器should publish changes in the database schema to a Kafka topic with the same name as the database server ID. Each schema change is recorded by using a key that contains the database name and whose value includes the DDL statement(s). This is independent of how the connector internally records database schema history.

include.schema.comments

false

布尔值,用于指定是否连接器should parse and publish table and column comments on metadata objects. Enabling this option will bring the implications on memory usage. The number and size of logical schema objects is what largely impacts how much memory is consumed by the Debezium connectors, and adding potentially large string data to each of them can potentially be quite expensive.

include.query

false

布尔值,用于指定是否连接器should include the original SQL query that generated the change event.

If you set this option totruethen you must also configure MySQL with thebinlog_rows_query_log_eventsoption set toON．Wheninclude.queryistrue,查询不存在的事件系统网络体系结构(sna)pshot process generates.

Settinginclude.querytotruemight expose tables or fields that are explicitly excluded or masked by including the original SQL statement in the change event. For this reason, the default setting isfalse．

event.deserialization.failure.handling.mode

fail

Specifies how the connector should react to exceptions during deserialization of binlog events.

failpropagates the exception, which indicates the problematic event and its binlog offset, and causes the connector to stop.

warnlogs the problematic event and its binlog offset and then skips the event.

ignorepasses over the problematic event and does not log anything.

inconsistent.schema.handling.mode

fail

Specifies how the connector should react to binlog events that relate to tables that are not present in internal schema representation. That is, the internal representation is not consistent with the database.

failthrows an exception that indicates the problematic event and its binlog offset, and causes the connector to stop.

warnlogs the problematic event and its binlog offset and skips the event.

skippasses over the problematic event and does not log anything.

max.batch.size

2048

Positive integer value that specifies the maximum size of each batch of events that should be processed during each iteration of this connector. Defaults to 2048.

max.queue.size

8192

Positive integer value that specifies the maximum number of records that the blocking queue can hold. When Debezium reads events streamed from the database, it places the events in the blocking queue before it writes them to Kafka. The blocking queue can provide backpressure for reading change events from the database in cases where the connector ingests messages faster than it can write them to Kafka, or when Kafka becomes unavailable. Events that are held in the queue are disregarded when the connector periodically records offsets. Always set the value ofmax.queue.sizeto be larger than the value ofmax.batch.size．

max.queue.size.in.bytes

0

A long integer value that specifies the maximum volume of the blocking queue in bytes. By default, volume limits are not specified for the blocking queue. To specify the number of bytes that the queue can consume, set this property to a positive long value.
Ifmax.queue.sizeis also set, writing to the queue is blocked when the size of the queue reaches the limit specified by either property. For example, if you setmax.queue.size=1000, andmax.queue.size.in.bytes=5000, writing to the queue is blocked after the queue contains 1000 records, or after the volume of the records in the queue reaches 5000 bytes.

poll.interval.ms

500

Positive integer value that specifies the number of milliseconds the connector should wait for new change events to appear before it starts processing a batch of events. Defaults to 500 milliseconds, or 0.5 second.

connect.timeout.ms

30000

A positive integer value that specifies the maximum time in milliseconds this connector should wait after trying to connect to the MySQL database server before timing out. Defaults to 30 seconds.

gtid.source.includes

No default

一个以逗号分隔的正则表达式match source UUIDs in the GTID set used that the connector uses to find the binlog position on the MySQL server. When this property is set, the connector uses only the GTID ranges that have source UUIDs that match one of the specifiedincludepatterns.

To match the value of a GTID, Debezium applies the regular expression that you specify as ananchoredregular expression. That is, the specified expression is matched against the entire UUID string; it does not match substrings that might be present in the UUID.
If you include this property in the configuration, do not also set thegtid.source.excludesproperty.

gtid.source.excludes

No default

一个以逗号分隔的正则表达式match source UUIDs in the GTID set that the connector uses to find the binlog position on the MySQL server. When this property is set, the connector uses only the GTID ranges that have source UUIDs that do not match any of the specifiedexcludepatterns.

To match the value of a GTID, Debezium applies the regular expression that you specify as ananchoredregular expression. That is, the specified expression is matched against the entire UUID string; it does not match substrings that might be present in the UUID.
If you include this property in the configuration, do not also set thegtid.source.includesproperty.

tombstones.on.delete

true

Controls whether adeleteevent is followed by a tombstone event.

true- a delete operation is represented by adeleteevent and a subsequent tombstone event.

false- only adeleteevent is emitted.

After a source record is deleted, emitting a tombstone event (the default behavior) allows Kafka to completely delete all events that pertain to the key of the deleted row in caselog compactionis enabled for the topic.

message.key.columns

n/a

A list of expressions that specify the columns that the connector uses to form custom message keys for change event records that it publishes to the Kafka topics for specified tables.

By default, Debezium uses the primary key column of a table as the message key for records that it emits. In place of the default, or to specify a key for tables that lack a primary key, you can configure custom message keys based on one or more columns.

To establish a custom message key for a table, list the table, followed by the columns to use as the message key. Each list entry takes the following format:

:,

To base a table key on multiple column names, insert commas between the column names.

Each fully-qualified table name is a regular expression in the following format:

．

的property can include entries for multiple tables. Use a semicolon to separate table entries in the list.

的following example sets the message key for the tablesinventory.customersandpurchase.orders:

inventory.customers:pk1,pk2;(.*).purchaseorders:pk3,pk4

For the tableinventory.customer, the columnspk1andpk2are specified as the message key. For thepurchaseorderstables in any database, the columnspk3andpk4server as the message key.

的re is no limit to the number of columns that you use to create custom message keys. However, it’s best to use the minimum number that are required to specify a unique key.

binary.handling.mode

bytes

Specifies how binary columns, for example,blob,binary,varbinary, should be represented in change events. Possible settings:

bytesrepresents binary data as a byte array.

base64represents binary data as a base64-encoded String.

base64-url-saferepresents binary data as a base64-url-safe-encoded String.

hexrepresents binary data as a hex-encoded (base16) String.

schema.name.adjustment.mode

none

Specifies how schema names should be adjusted for compatibility with the message converter used by the connector. Possible settings:

  • nonedoes not apply any adjustment.

  • avroreplaces the characters that cannot be used in the Avro type name with underscore.

  • avro_unicodereplaces 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

field.name.adjustment.mode

none

Specifies how field names should be adjusted for compatibility with the message converter used by the connector. Possible settings:

  • nonedoes not apply any adjustment.

  • avroreplaces the characters that cannot be used in the Avro type name with underscore.

  • avro_unicodereplaces 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

SeeAvro namingfor more details.

Advanced MySQL connector configuration properties

的following table describesadvanced MySQL connector properties．的default values for these properties rarely need to be changed. Therefore, you do not need to specify them in the connector configuration.

Table 26. Descriptions of MySQL connector advanced configuration properties
Property Default Description

connect.keep.alive

true

A Boolean value that specifies whether a separate thread should be used to ensure that the connection to the MySQL server/cluster is kept alive.

converters

No default

Enumerates a comma-separated list of the symbolic names of thecustom converterinstances that the connector can use.
For example,boolean．
This property is required to enable the connector to use a custom converter.

For each converter that you configure for a connector, you must also add a．typeproperty, which specifies the fully-qualifed name of the class that implements the converter interface. The．typeproperty uses the following format:

．type

For example,

boolean.type: io.debezium.connector.mysql.converters.TinyIntOneToBooleanConverter

If you want to further control the behavior of a configured converter, you can add one or more configuration parameters to pass values to the converter. To associate these additional configuration parameter with a converter, prefix the paraemeter name with the symbolic name of the converter.

For example, to define aselectorparameter that specifies the subset of columns that thebooleanconverter processes, add the following property:

boolean.selector=db1.table1.*, db1.table2.column1

table.ignore.builtin

true

A Boolean value that specifies whether built-in system tables should be ignored. This applies regardless of the table include and exclude lists. By default, system tables are excluded from having their changes captured, and no events are generated when changes are made to any system tables.

database.ssl.mode

disabled

Specifies whether to use an encrypted connection. Possible settings are:

disabledspecifies the use of an unencrypted connection.

preferredestablishes an encrypted connection if the server supports secure connections. If the server does not support secure connections, falls back to an unencrypted connection.

requiredestablishes an encrypted connection or fails if one cannot be made for any reason.

verify_cabehaves likerequiredbut additionally it verifies the server TLS certificate against the configured Certificate Authority (CA) certificates and fails if the server TLS certificate does not match any valid CA certificates.

verify_identitybehaves likeverify_cabut additionally verifies that the server certificate matches the host of the remote connection.

binlog.buffer.size

0

的size of a look-ahead buffer used by the binlog reader. The default setting of0disables buffering.

Under specific conditions, it is possible that the MySQL binlog contains uncommitted data finished by aROLLBACKstatement. Typical examples are using savepoints or mixing temporary and regular table changes in a single transaction.

When a beginning of a transaction is detected then Debezium tries to roll forward the binlog position and find eitherCOMMITorROLLBACKso it can determine whether to stream the changes from the transaction. The size of the binlog buffer defines the maximum number of changes in the transaction that Debezium can buffer while searching for transaction boundaries. If the size of the transaction is larger than the buffer then Debezium must rewind and re-read the events that have not fit into the buffer while streaming.

NOTE: This feature is incubating. Feedback is encouraged. It is expected that this feature is not completely polished.

snapshot.mode

initial

Specifies the criteria for running a snapshot when the connector starts. Possible settings are:

initial- the connector runs a snapshot only when no offsets have been recorded for the logical server name.

initial_only- the connector runs a snapshot only when no offsets have been recorded for the logical server name and then stops; i.e. it will not read change events from the binlog.

when_needed- the connector runs a snapshot upon startup whenever it deems it necessary. That is, when no offsets are available, or when a previously recorded offset specifies a binlog location or GTID that is not available in the server.

never- the connector never uses snapshots. Upon first startup with a logical server name, the connector reads from the beginning of the binlog. Configure this behavior with care. It is valid only when the binlog is guaranteed to contain the entire history of the database.

schema_only- the connector runs a snapshot of the schemas and not the data. This setting is useful when you do not need the topics to contain a consistent snapshot of the data but need them to have only the changes since the connector was started.

schema_only_recovery- this is a recovery setting for a connector that has already been capturing changes. When you restart the connector, this setting enables recovery of a corrupted or lost database schema history topic. You might set it periodically to "clean up" a database schema history topic that has been growing unexpectedly. Database schema history topics require infinite retention.

snapshot.locking.mode

minimal

Controls whether and how long the connector holds the global MySQL read lock, which prevents any updates to the database, while the connector is performing a snapshot. Possible settings are:

minimal- the connector holds the global read lock for only the initial portion of the snapshot during which the connector reads the database schemas and other metadata. The remaining work in a snapshot involves selecting all rows from each table. The connector can do this in a consistent fashion by using a REPEATABLE READ transaction. This is the case even when the global read lock is no longer held and other MySQL clients are updating the database.

minimal_percona- the connector holdsthe global backup lockfor only the initial portion of the snapshot during which the connector reads the database schemas and other metadata. The remaining work in a snapshot involves selecting all rows from each table. The connector can do this in a consistent fashion by using a REPEATABLE READ transaction. This is the case even when the global backup lock is no longer held and other MySQL clients are updating the database. This mode does not flush tables to disk, is not blocked by long-running reads, and is available only in Percona Server.

extended- blocks all writes for the duration of the snapshot. Use this setting if there are clients that are submitting operations that MySQL excludes from REPEATABLE READ semantics.

none- prevents the connector from acquiring any table locks during the snapshot. While this setting is allowed with all snapshot modes, it is safe to use if andonlyif no schema changes are happening while the snapshot is running. For tables defined with MyISAM engine, the tables would still be locked despite this property being set as MyISAM acquires a table lock. This behavior is unlike InnoDB engine, which acquires row level locks.

snapshot.include.collection.list

All tables specified intable.include.list

一个可选,以逗号分隔的正则表达ssions that match the fully-qualified names (.) of the tables to include in a snapshot. The specified items must be named in the connector’stable.include.listproperty. This property takes effect only if the connector’ssnapshot.modeproperty is set to a value other thannever．
This property does not affect the behavior of incremental snapshots.

To match the name of a table, Debezium applies the regular expression that you specify as ananchoredregular expression. That is, the specified expression is matched against the entire name string of the table; it does not match substrings that might be present in a table name.

snapshot.select.statement.overrides

No default

Specifies the table rows to include in a snapshot. Use the property if you want a snapshot to include only a subset of the rows in a table. This property affects snapshots only. It does not apply to events that the connector reads from the log.

的property contains a comma-separated list of fully-qualified table names in the form.．For example,

"snapshot.select.statement.overrides": "inventory.products,customers.orders"

For each table in the list, add a further configuration property that specifies theSELECTstatement for the connector to run on the table when it takes a snapshot. The specifiedSELECTstatement determines the subset of table rows to include in the snapshot. Use the following format to specify the name of thisSELECTstatement property:

snapshot.select.statement.overrides.．．For example,snapshot.select.statement.overrides.customers.orders．

Example:

From acustomers.orderstable that includes the soft-delete column,delete_flag, add the following properties if you want a snapshot to include only those records that are not soft-deleted:

"snapshot.select.statement.overrides": "customer.orders", "snapshot.select.statement.overrides.customer.orders": "SELECT * FROM [customers].[orders] WHERE delete_flag = 0 ORDER BY id DESC"

In the resulting snapshot, the connector includes only the records for whichdelete_flag = 0．

min.row.count.to.stream.results

1000

During a snapshot, the connector queries each table for which the connector is configured to capture changes. The connector uses each query result to produce a read event that contains data for all rows in that table. This property determines whether the MySQL connector puts results for a table into memory, which is fast but requires large amounts of memory, or streams the results, which can be slower but work for very large tables. The setting of this property specifies the minimum number of rows a table must contain before the connector streams results.

To skip all table size checks and always stream all results during a snapshot, set this property to0．

heartbeat.interval.ms

0

Controls how frequently the connector sends heartbeat messages to a Kafka topic. The default behavior is that the connector does not send heartbeat messages.

Heartbeat messages are useful for monitoring whether the connector is receiving change events from the database. Heartbeat messages might help decrease the number of change events that need to be re-sent when a connector restarts. To send heartbeat messages, set this property to a positive integer, which indicates the number of milliseconds between heartbeat messages.

heartbeat.action.query

No default

Specifies a query that the connector executes on the source database when the connector sends a heartbeat message.

For example, this can be used to periodically capture the state of the executed GTID set in the source database.

INSERT INTO gtid_history_table (select * from mysql.gtid_executed)

database.initial.statements

No default

A semicolon separated list of SQL statements to be executed when a JDBC connection, not the connection that is reading the transaction log, to the database is established. To specify a semicolon as a character in a SQL statement and not as a delimiter, use two semicolons, (;;).

的connector might establish JDBC connections at its own discretion, so this property is ony for configuring session parameters. It is not for executing DML statements.

snapshot.delay.ms

No default

一个在terval in milliseconds that the connector should wait before performing a snapshot when the connector starts. If you are starting multiple connectors in a cluster, this property is useful for avoiding snapshot interruptions, which might cause re-balancing of connectors.

snapshot.fetch.size

No default

During a snapshot, the connector reads table content in batches of rows. This property specifies the maximum number of rows in a batch.

snapshot.lock.timeout.ms

10000

Positive integer that specifies the maximum amount of time (in milliseconds) to wait to obtain table locks when performing a snapshot. If the connector cannot acquire table locks in this time interval, the snapshot fails. Seehow MySQL connectors perform database snapshots．

enable.time.adjuster

true

Boolean value that indicates whether the connector converts a 2-digit year specification to 4 digits. Set tofalsewhen conversion is fully delegated to the database.

MySQL allows users to insert year values with either 2-digits or 4-digits. For 2-digit values, the value gets mapped to a year in the range 1970 - 2069. The default behavior is that the connector does the conversion.

source.struct.version

v2

Schema version for thesourceblock in Debezium events. Debezium 0.10 introduced a few breaking changes to the structure of thesourceblock in order to unify the exposed structure across all the connectors.

By setting this option tov1, the structure used in earlier versions can be produced. However, this setting is not recommended and is planned for removal in a future Debezium version.

skipped.operations

t

A comma-separated list of operation types that will be skipped during streaming. The operations include:cfor inserts/create,ufor updates,dfor deletes,tfor truncates, andnoneto not skip any operations. By default, truncate operations are skipped.

signal.data.collection

No default value

Fully-qualified name of the data collection that is used to sendsignalsto the connector.
Use the following format to specify the collection name:
．

incremental.snapshot.allow.schema.changes

false

Allow schema changes during an incremental snapshot. When enabled the connector will 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.

incremental.snapshot.chunk.size

1024

的maximum number of rows that the connector fetches and reads into memory during an incremental snapshot chunk. Increasing the chunk size provides greater efficiency, because the snapshot runs fewer snapshot queries of a greater size. However, larger chunk sizes also require more memory to buffer the snapshot data. Adjust the chunk size to a value that provides the best performance in your environment.

read.only

false

Switch to alternative incremental snapshot watermarks implementation to avoid writes to signal data collection

provide.transaction.metadata

false

Determines whether the connector generates events with transaction boundaries and enriches change event envelopes with transaction metadata. Specifytrueif you want the connector to do this. SeeTransaction metadatafor details.

event.processing.failure.handling.mode

fail

Specify how failures during processing of events (i.e. when encountering a corrupted event) should be handled. By default,failmode raises an exception indicating the problematic event and its position, causing the connector to be stopped.warnmode does not raise the exception, instead the problematic event and its position will be logged and the event will be skipped.ignoremode ignores the problematic event completely with no logging.

topic.naming.strategy

io.debezium.schema.DefaultTopicNamingStrategy

的名称TopicNamingStrategy class that should be used to determine the topic name for data change, schema change, transaction, heartbeat event etc., defaults toDefaultTopicNamingStrategy．

topic.delimiter

．

Specify the delimiter for topic name, defaults to．．

topic.cache.size

10000

的size used for holding the topic names in bounded concurrent hash map. This cache will help to determine the topic name corresponding to a given data collection.

topic.heartbeat.prefix

__debezium-heartbeat

Controls the name of the topic to which the connector sends heartbeat messages. The topic name has this pattern:

topic.heartbeat.prefix．topic.prefix

For example, if the topic prefix isfulfillment, the default topic name is__debezium-heartbeat.fulfillment．

topic.transaction

事务

Controls the name of the topic to which the connector sends transaction metadata messages. The topic name has this pattern:

topic.prefix．topic.transaction

For example, if the topic prefix isfulfillment, the default topic name isfulfillment.transaction．

Debezium connector database schema history configuration properties

Debezium provides a set ofschema.history.internal.*properties that control how the connector interacts with the schema history topic.

的following table describes theschema.history.internalproperties for configuring the Debezium connector.

Table 27. Connector database schema history configuration properties
Property Default Description

schema.history.internal.kafka.topic

No default

的full name of the Kafka topic where the connector stores the database schema history.

schema.history.internal.kafka.bootstrap.servers

No default

A list of host/port pairs that the connector uses for establishing an initial connection to the Kafka cluster. This connection is used for retrieving the database schema history previously stored by the connector, and for writing each DDL statement read from the source database. Each pair should point to the same Kafka cluster used by the Kafka Connect process.

schema.history.internal.kafka.recovery.poll.interval.ms

100

一个整数值,它指定的最大数量of milliseconds the connector should wait during startup/recovery while polling for persisted data. The default is 100ms.

schema.history.internal.kafka.query.timeout.ms

3000

一个整数值,它指定的最大数量of milliseconds the connector should wait while fetching cluster information using Kafka admin client.

schema.history.internal.kafka.create.timeout.ms

30000

一个整数值,它指定的最大数量of milliseconds the connector should wait while create kafka history topic using Kafka admin client.

schema.history.internal.kafka.recovery.attempts

100

的maximum number of times that the connector should try to read persisted history data before the connector recovery fails with an error. The maximum amount of time to wait after receiving no data isrecovery.attempts×recovery.poll.interval.ms．

schema.history.internal.skip.unparseable.ddl

false

A Boolean value that specifies whether the connector should ignore malformed or unknown database statements or stop processing so a human can fix the issue. The safe default isfalse．Skipping should be used only with care as it can lead to data loss or mangling when the binlog is being processed.

schema.history.internal.store.only.captured.tables.ddl

false

A Boolean value that specifies whether the connector should record all DDL statements

truerecords only those DDL statements that are relevant to tables whose changes are being captured by Debezium. Set totruewith care because missing data might become necessary if you change which tables have their changes captured.

的safe default isfalse．
Pass-through database schema history properties for configuring producer and consumer clients


Debezium relies on a Kafka producer to write schema changes to database schema history topics. Similarly, it relies on a Kafka consumer to read from database schema history topics when a connector starts. You define the configuration for the Kafka producer and consumer clients by assigning values to a set of pass-through configuration properties that begin with theschema.history.internal.producer.*andschema.history.internal.consumer.*prefixes. The pass-through producer and consumer database schema history properties control a range of behaviors, such as how these clients secure connections with the Kafka broker, as shown in the following example:

schema.history.internal.producer.security.protocol=SSL schema.history.internal.producer.ssl.keystore.location=/var/private/ssl/kafka.server.keystore.jks schema.history.internal.producer.ssl.keystore.password=test1234 schema.history.internal.producer.ssl.truststore.location=/var/private/ssl/kafka.server.truststore.jks schema.history.internal.producer.ssl.truststore.password=test1234 schema.history.internal.producer.ssl.key.password=test1234 schema.history.internal.consumer.security.protocol=SSL schema.history.internal.consumer.ssl.keystore.location=/var/private/ssl/kafka.server.keystore.jks schema.history.internal.consumer.ssl.keystore.password=test1234 schema.history.internal.consumer.ssl.truststore.location=/var/private/ssl/kafka.server.truststore.jks schema.history.internal.consumer.ssl.truststore.password=test1234 schema.history.internal.consumer.ssl.key.password=test1234

Debezium strips the prefix from the property name before it passes the property to the Kafka client.

See the Kafka documentation for more details aboutKafka producer configuration propertiesandKafka consumer configuration properties．

Debezium connector Kafka signals configuration properties

When the MySQL connector is configured as read-only, the alternative for the signaling table is the signals Kafka topic.

Debezium provides a set ofsignal.*properties that control how the connector interacts with the Kafka signals topic.

的following table describes thesignalproperties.

Table 28. Kafka signals configuration properties
Property Default Description

signal.kafka.topic

No default

的名称Kafka topic that the connector monitors for ad hoc signals.

signal.kafka.bootstrap.servers

No default

A list of host/port pairs that the connector uses for establishing an initial connection to the Kafka cluster. Each pair should point to the same Kafka cluster used by the Kafka Connect process.

signal.kafka.poll.timeout.ms

100

一个整数值,它指定的最大数量of milliseconds the connector should wait when polling signals. The default is 100ms.

Debezium connector pass-through signals Kafka consumer client configuration properties

的Debezium connector provides for pass-through configuration of the signals Kafka consumer. Pass-through signals properties begin with the prefixsignals.consumer.*．For example, the connector passes properties such assignal.consumer.security.protocol=SSLto the Kafka consumer.

As is the case with thepass-through properties for database schema history clients, Debezium strips the prefixes from the properties before it passes them to the Kafka signals consumer.

Debezium connector pass-through database driver configuration properties

的Debezium connector provides for pass-through configuration of the database driver. Pass-through database properties begin with the prefixdriver.*．For example, the connector passes properties such asdriver.foobar=falseto the JDBC URL.

As is the case with thepass-through properties for database schema history clients, Debezium strips the prefixes from the properties before it passes them to the database driver.

Monitoring

的Debezium MySQL connector provides three types of metrics that are in addition to the built-in support for JMX metrics that Zookeeper, Kafka, and Kafka Connect provide.

  • Snapshot metricsprovide information about connector operation while performing a snapshot.

  • Streaming metricsprovide information about connector operation when the connector is reading the binlog.

  • Schema history metricsprovide information about the status of the connector’s schema history.

Debezium monitoring documentationprovides details for how to expose these metrics by using JMX.

Snapshot metrics

的MBeanisdebezium.mysql:type=connector-metrics,context=snapshot,server=．

Snapshot metrics are not exposed unless a snapshot operation is active, or if a snapshot has occurred since the last connector start.

的following table lists the shapshot metrics that are available.

Attributes Type Description

LastEvent

string

的last snapshot event that the connector has read.

MilliSecondsSinceLastEvent

long

的number of milliseconds since the connector has read and processed the most recent event.

TotalNumberOfEventsSeen

long

的total number of events that this connector has seen since last started or reset.

NumberOfEventsFiltered

long

的number of events that have been filtered by include/exclude list filtering rules configured on the connector.

CapturedTables

string[]

的list of tables that are captured by the connector.

QueueTotalCapacity

int

的length the queue used to pass events between the snapshotter and the main Kafka Connect loop.

QueueRemainingCapacity

int

的free capacity of the queue used to pass events between the snapshotter and the main Kafka Connect loop.

TotalTableCount

int

的total number of tables that are being included in the snapshot.

RemainingTableCount

int

的number of tables that the snapshot has yet to copy.

SnapshotRunning

boolean

Whether the snapshot was started.

SnapshotPaused

boolean

Whether the snapshot was paused.

SnapshotAborted

boolean

Whether the snapshot was aborted.

SnapshotCompleted

boolean

Whether the snapshot completed.

SnapshotDurationInSeconds

long

的total number of seconds that the snapshot has taken so far, even if not complete. Includes also time when snapshot was paused.

SnapshotPausedDurationInSeconds

long

的total number of seconds that the snapshot was paused. If the snapshot was paused several times, the paused time adds up.

RowsScanned

Map

Map containing the number of rows scanned for each table in the snapshot. Tables are incrementally added to the Map during processing. Updates every 10,000 rows scanned and upon completing a table.

MaxQueueSizeInBytes

long

的maximum buffer of the queue in bytes. This metric is available ifmax.queue.size.in.bytesis set to a positive long value.

CurrentQueueSizeInBytes

long

的current volume, in bytes, of records in the queue.

的connector also provides the following additional snapshot metrics when an incremental snapshot is executed:

Attributes Type Description

ChunkId

string

的identifier of the current snapshot chunk.

ChunkFrom

string

的lower bound of the primary key set defining the current chunk.

ChunkTo

string

的upper bound of the primary key set defining the current chunk.

TableFrom

string

的lower bound of the primary key set of the currently snapshotted table.

TableTo

string

的upper bound of the primary key set of the currently snapshotted table.

的Debezium MySQL connector also provides theHoldingGlobalLockcustom snapshot metric. This metric is set to a Boolean value that indicates whether the connector currently holds a global or table write lock.

Streaming metrics

Transaction-related attributes are available only if binlog event buffering is enabled. Seebinlog.buffer.sizein the advanced connector configuration properties for more details.

的MBeanisdebezium.mysql:type=connector-metrics,context=streaming,server=．

的following table lists the streaming metrics that are available.

Attributes Type Description

LastEvent

string

的last streaming event that the connector has read.

MilliSecondsSinceLastEvent

long

的number of milliseconds since the connector has read and processed the most recent event.

TotalNumberOfEventsSeen

long

的total number of events that this connector has seen since the last start or metrics reset.

TotalNumberOfCreateEventsSeen

long

的total number of create events that this connector has seen since the last start or metrics reset.

TotalNumberOfUpdateEventsSeen

long

的total number of update events that this connector has seen since the last start or metrics reset.

TotalNumberOfDeleteEventsSeen

long

的total number of delete events that this connector has seen since the last start or metrics reset.

NumberOfEventsFiltered

long

的number of events that have been filtered by include/exclude list filtering rules configured on the connector.

CapturedTables

string[]

的list of tables that are captured by the connector.

QueueTotalCapacity

int

的length the queue used to pass events between the streamer and the main Kafka Connect loop.

QueueRemainingCapacity

int

的free capacity of the queue used to pass events between the streamer and the main Kafka Connect loop.

Connected

boolean

Flag that denotes whether the connector is currently connected to the database server.

MilliSecondsBehindSource

long

的number of milliseconds between the last change event’s timestamp and the connector processing it. The values will incoporate any differences between the clocks on the machines where the database server and the connector are running.

NumberOfCommittedTransactions

long

的number of processed transactions that were committed.

SourceEventPosition

Map

的coordinates of the last received event.

LastTransactionId

string

Transaction identifier of the last processed transaction.

MaxQueueSizeInBytes

long

的maximum buffer of the queue in bytes. This metric is available ifmax.queue.size.in.bytesis set to a positive long value.

CurrentQueueSizeInBytes

long

的current volume, in bytes, of records in the queue.

的Debezium MySQL connector also provides the following additional streaming metrics:

Table 29. Descriptions of additional streaming metrics
Attribute Type Description

BinlogFilename

string

的名称binlog file that the connector has most recently read.

BinlogPosition

long

的most recent position (in bytes) within the binlog that the connector has read.

IsGtidModeEnabled

boolean

Flag that denotes whether the connector is currently tracking GTIDs from MySQL server.

GtidSet

string

的string representation of the most recent GTID set processed by the connector when reading the binlog.

NumberOfSkippedEvents

long

的number of events that have been skipped by the MySQL connector. Typically events are skipped due to a malformed or unparseable event from MySQL’s binlog.

NumberOfDisconnects

long

的number of disconnects by the MySQL connector.

NumberOfRolledBackTransactions

long

的number of processed transactions that were rolled back and not streamed.

NumberOfNotWellFormedTransactions

long

的number of transactions that have not conformed to the expected protocol ofBEGIN+COMMIT/ROLLBACK．This value should be0under normal conditions.

NumberOfLargeTransactions

long

的number of transactions that have not fit into the look-ahead buffer. For optimal performance, this value should be significantly smaller thanNumberOfCommittedTransactionsandNumberOfRolledBackTransactions．

Schema history metrics

的MBeanisdebezium.mysql:type=connector-metrics,context=schema-history,server=．

的following table lists the schema history metrics that are available.

Attributes Type Description

Status

string

One ofSTOPPED,RECOVERING(recovering history from the storage),RUNNINGdescribing the state of the database schema history.

RecoveryStartTime

long

的time in epoch seconds at what recovery has started.

ChangesRecovered

long

的number of changes that were read during recovery phase.

ChangesApplied

long

the total number of schema changes applied during recovery and runtime.

MilliSecondsSinceLastRecoveredChange

long

的number of milliseconds that elapsed since the last change was recovered from the history store.

MilliSecondsSinceLastAppliedChange

long

的number of milliseconds that elapsed since the last change was applied.

LastRecoveredChange

string

的string representation of the last change recovered from the history store.

LastAppliedChange

string

的string representation of the last applied change.

Behavior when things go wrong

Debezium is a distributed system that captures all changes in multiple upstream databases; it never misses or loses an event. When the system is operating normally or being managed carefully then Debezium providesexactly oncedelivery of every change event record.

If a fault does happen then the system does not lose any events. However, while it is recovering from the fault, it might repeat some change events. In these abnormal situations, Debezium, like Kafka, providesat least oncedelivery of change events.

的rest of this section describes how Debezium handles various kinds of faults and problems.

Configuration and startup errors

In the following situations, the connector fails when trying to start, reports an error or exception in the log, and stops running:

  • 的connector’s configuration is invalid.

  • 的connector cannot successfully connect to the MySQL server by using the specified connection parameters.

  • 的connector is attempting to restart at a position in the binlog for which MySQL no longer has the history available.

In these cases, the error message has details about the problem and possibly a suggested workaround. After you correct the configuration or address the MySQL problem, restart the connector.

MySQL becomes unavailable

If your MySQL server becomes unavailable, the Debezium MySQL connector fails with an error and the connector stops. When the server is available again, restart the connector.

However, if GTIDs are enabled for a highly available MySQL cluster, you can restart the connector immediately. It will connect to a different MySQL server in the cluster, find the location in the server’s binlog that represents the last transaction, and begin reading the new server’s binlog from that specific location.

If GTIDs are not enabled, the connector records the binlog position of only the MySQL server to which it was connected. To restart from the correct binlog position, you must reconnect to that specific server.

Kafka Connect stops gracefully

When Kafka Connect stops gracefully, there is a short delay while the Debezium MySQL connector tasks are stopped and restarted on new Kafka Connect processes.

Kafka Connect process crashes

If Kafka Connect crashes, the process stops and any Debezium MySQL connector tasks terminate without their most recently-processed offsets being recorded. In distributed mode, Kafka Connect restarts the connector tasks on other processes. However, the MySQL connector resumes from the last offset recorded by the earlier processes. This means that the replacement tasks might generate some of the same events processed prior to the crash, creating duplicate events.

Each change event message includes source-specific information that you can use to identify duplicate events, for example:

  • Event origin

  • MySQL server’s event time

  • 的binlog file name and position

  • GTIDs (if used)

Kafka becomes unavailable

的Kafka Connect framework records Debezium change events in Kafka by using the Kafka producer API. If the Kafka brokers become unavailable, the Debezium MySQL connector pauses until the connection is reestablished and the connector resumes where it left off.

MySQL purges binlog files

If the Debezium MySQL connector stops for too long, the MySQL server purges older binlog files and the connector’s last position may be lost. When the connector is restarted, the MySQL server no longer has the starting point and the connector performs another initial snapshot. If the snapshot is disabled, the connector fails with an error.

Seesnapshotsfor details about how MySQL connectors perform initial snapshots.