TiCDC Debezium Protocol

Debezium 是一个用于捕获数据库变更的工具。它会将捕获的数据库变更的每一条记录转化为一个被称为“事件” (event) 的消息，并将这些事件发送到 Kafka 中。从 v8.0.0 起，TiCDC 支持将 TiDB 的变更以 Debezium 的格式直接传输到 Kafka，为之前使用 Debezium 的 MySQL 集成的用户简化了从 MySQL 数据库迁移的过程。

使用 Debezium 消息格式

当使用 Kafka 作为下游 Sink 时，你可以将 sink-uri 的 protocol 字段指定为 debezium，TiCDC 将以 Event 为基本单位封装构造 Debezium 消息，向下游发送 TiDB 的数据变更事件。

目前，Debezium 协议只支持 Row Changed Event，会直接忽略 DDL Event 和 WATERMARK Event。Row Changed Event 代表一行的数据变化，在行发生变更时该 Event 被发出，包含该行在变更前后的相关信息。WATERMARK Event 用于标记一个表的同步进度，所有早于 watermark 的事件都已经发送给下游。

使用 Debezium 消息格式时的配置样例如下所示：

  1. cdc cli changefeed create --server=http://127.0.0.1:8300 --changefeed-id="kafka-debezium" --sink-uri="kafka://127.0.0.1:9092/topic-name?kafka-version=2.4.0&protocol=debezium"

Debezium 输出格式中包含当前行的 Schema 信息，以便下游消费者更好地理解当前行的数据结构。对于不需要输出 Schema 信息的场景，也可以通过在 changefeed 的配置文件或者 sink-uri 中将 debezium-disable-schema 参数设置为 true 来关闭 Schema 信息的输出。

此外，Debezium 原有格式中并不包含 TiDB 专有的 CommitTS 事务唯一标识等重要字段。为了保证数据的完整性，TiCDC 在 Debezium 格式中增加了 CommitTs 和 ClusterID 两个字段，用于标识 TiDB 数据变更的相关信息。

Message 格式定义

下面将介绍 Debezium 格式输出的 DML Event 的格式定义。

DML Event

TiCDC 会把一个 DML Event 编码成如下格式：

  1. {
  2.     "payload":{
  3.         "ts_ms":1707103832957,
  4.         "transaction":null,
  5.         "op":"c",
  6.         "before":null,
  7.         "after":{
  8.             "a":4,
  9.             "b":2
  10.         },
  11.         "source":{
  12.             "version":"2.4.0.Final",
  13.             "connector":"TiCDC",
  14.             "name":"default",
  15.             "ts_ms":1707103832263,
  16.             "snapshot":"false",
  17.             "db":"test",
  18.             "table":"t2",
  19.             "server_id":0,
  20.             "gtid":null,
  21.             "file":"",
  22.             "pos":0,
  23.             "row":0,
  24.             "thread":0,
  25.             "query":null,
  26.             "commit_ts":447507027004751877,
  27.             "cluster_id":"default"
  28.         }
  29.     },
  30.     "schema":{
  31.         "type":"struct",
  32.         "optional":false,
  33.         "name":"default.test.t2.Envelope",
  34.         "version":1,
  35.         "fields":{
  36.             {
  37.                 "type":"struct",
  38.                 "optional":true,
  39.                 "name":"default.test.t2.Value",
  40.                 "field":"before",
  41.                 "fields":[
  42.                     {
  43.                         "type":"int32",
  44.                         "optional":false,
  45.                         "field":"a"
  46.                     },
  47.                     {
  48.                         "type":"int32",
  49.                         "optional":true,
  50.                         "field":"b"
  51.                     }
  52.                 ]
  53.             },
  54.             {
  55.                 "type":"struct",
  56.                 "optional":true,
  57.                 "name":"default.test.t2.Value",
  58.                 "field":"after",
  59.                 "fields":[
  60.                     {
  61.                         "type":"int32",
  62.                         "optional":false,
  63.                         "field":"a"
  64.                     },
  65.                     {
  66.                         "type":"int32",
  67.                         "optional":true,
  68.                         "field":"b"
  69.                     }
  70.                 ]
  71.             },
  72.             {
  73.                 "type":"string",
  74.                 "optional":false,
  75.                 "field":"op"
  76.             },
  77.             ...
  78.         }
  79.     }
  80. }

以上 JSON 数据的重点字段解释如下：

字段类型说明
payload.op字符串变更事件类型。“c” 表示这是一个 INSERT 事件，“u” 表示这是一个 UPDATE 事件，“d” 表示这是一个 DELETE 事件
payload.ts_ms数值TiCDC 生成这条信息的时间戳（毫秒级别）
payload.beforeJSON这条事件语句变更前的数据值，对于 “c” 事件，before 字段的值为 null
payload.afterJSON这条事件语句变更后的数据值，对于 “d” 事件，after 字段的值为 null
payload.source.commit_ts数值TiCDC 生成这条信息时的 CommitTs 标识
payload.source.db字符串事件发生的数据库的名称
payload.source.table字符串事件发生的数据表的名称
schema.fieldsJSONpayload 中各个字段的类型信息，包括对应行数据变更前后 schema 的信息等

数据类型映射

TiCDC Debezium 消息中的数据格式映射基本遵循 Debezium 的数据类型映射规则，与 Debezium Connector for MySQL 原生消息大体一致。但是对于部分数据类型，TiCDC Debezium 的处理方式与 Debezium Connector Message 存在一定差异，具体如下：

  • 目前 TiDB 不支持空间数据类型，包括 GEOMETRY、LINESTRING、POLYGON、MULTIPOINT、MULTILINESTRING、MULTIPOLYGON、GEOMETRYCOLLECTION。

  • 对于 String-likes 的数据类型，包括 Varchar、String、VarString、TinyBlob、MediumBlob、BLOB、LongBlob 等，当该列具有 BINARY 标志时，TiCDC 会将其按照 Base64 编码后以 String 类型表示；当该列没有 BINARY 标志时，TiCDC 则直接将其编码为 String 类型。而原生的 Debezium Connector 会根据 binary.handling.mode 以不同的编码方式进行编码。

  • 对于 Decimal 数据类型，包括 DECIMAL 和 NUMERIC，TiCDC 均会使用 float64 类型来表示。而原生的 Debezium Connector 会根据数据类型的不同精度采用 float32 或者 float64 的方式进行编码。