12.5. 从 Debezium 更改事件中提取源记录 after 状态
Debezium 连接器会发出数据更改信息,以表示它们从源数据库捕获的每个操作。连接器发送到 Apache Kafka 的消息具有复杂的结构,它错误地代表原始数据库事件的详情。
虽然这种复杂的消息格式准确详细介绍了系统中发生的更改的信息,但该格式可能不适用于一些下游用户。Kafka 生态系统的其他部分可能需要格式的信息,以便字段名称和值以简化的扁平化结构显示。
要简化 Debezium 连接器生成的事件记录的格式,您可以使用 Debezium 事件扁平化单个消息转换(SMT)。配置转换以支持需要 Kafka 记录的用户,其格式比连接器生成的默认格式要简单。根据您的具体用例,您可以将 SMT 应用到 Debezium 连接器,或应用到消耗 Debezium 连接器生成的消息的接收器连接器。要启用 Apache Kafka 以其原始格式保留 Debezium 更改事件信息,请为接收器连接器配置 SMT。
事件扁平化转换是一个 Kafka Connect SMT。
本章中的信息描述了 Debezium SQL 的数据库连接器的扁平化单个消息转换(SMT)。有关 Debezium MongoDB 连接器等同的 SMT 的详情,请参考 MongoDB New Document Extraction。
以下主题提供详情:
12.5.1. Debezium 更改事件结构的描述
Debezium 生成具有复杂结构的数据更改事件。每个事件由三个部分组成:
元数据,包括但不限于:
- 更改数据的操作类型。
- 源信息,如数据库名称和发生更改的表。
- 标识更改的时间戳。
- 可选的事务信息。
- 更改前的行数据
- 更改后的行数据
以下示例显示了 UPDATE
更改事件的消息结构的一部分:
{ "op": "u", "source": { ... }, "ts_ms" : "...", "before" : { "field1" : "oldvalue1", "field2" : "oldvalue2" }, "after" : { "field1" : "newvalue1", "field2" : "newvalue2" } }
有关连接器更改事件结构的更多信息,请参阅连接器的文档。
事件扁平化 SMT 处理上例中的信息后,它简化了消息格式,如下例所示:
{ "field1" : "newvalue1", "field2" : "newvalue2" }
12.5.2. Debezium 事件扁平化转换的行为
事件扁平化 SMT 从 Kafka 记录中的 Debezium 更改事件中提取 after
字段。SMT 仅将原始更改事件替换为其 after
字段来创建简单的 Kafka 记录。
您可以为 Debezium 连接器或消耗 Debezium 连接器发送的消息配置事件扁平化 SMT。为接收器连接器配置事件扁平化的优点是,存储在 Apache Kafka 中的记录包含整个 Debezium 更改事件。将 SMT 应用到源或接收器连接器的决定取决于您的特定用例。
您可以配置转换以执行以下操作之一:
- 将更改事件的元数据添加到简化的 Kafka 记录中。默认行为是 SMT 不会添加元数据。
-
在流中为
DELETE
操作保留包含更改事件的 Kafka 记录。默认行为是 SMT 丢弃DELETE
操作更改事件的 Kafka 记录,因为大多数用户还无法处理它们。
数据库 DELETE
操作会导致 Debezium 生成两个 Kafka 记录:
-
包含
"op": "d"、
前
行数据和一些其他字段的记录。 -
具有与已删除行相同的键和
null
值的 tombstone 记录。此记录是 Apache Kafka 的标记。这表示 日志压缩 可以删除所有具有此键的记录。
您可以将事件扁平化配置为执行以下操作之一,而不是丢弃包含 before
行数据的记录:
-
将记录保留在流中,并将它编辑为只有
"value": "null"
字段。 -
将记录保留在流中,并将它编辑为
value
字段,其中包含在before
字段中带有添加的"__deleted": "true"
条目的 key/value 对。
同样,您可以配置事件扁平化 SMT,而不是丢弃 tombstone 记录,以将 tombstone 记录保留在流中。
12.5.3. 配置 Debezium 事件扁平化转换
通过在连接器配置中添加 SMT 配置详情,在 Kafka Connect 源或接收器连接器中配置 Debezium 事件扁平化 SMT。例如,要获取转换的默认行为,请将其添加到连接器配置中,而不指定任何选项,如下例所示:
transforms=unwrap,... transforms.unwrap.type=io.debezium.transforms.ExtractNewRecordState
与任何 Kafka Connect 连接器配置一样,您可以按照您希望 Kafka Connect 应用 SMT 的顺序将 converts =
设置为多个、以逗号分隔的 SMT 别名。
以下 .properties
示例设置了几个事件扁平化 SMT 选项:
transforms=unwrap,... transforms.unwrap.type=io.debezium.transforms.ExtractNewRecordState transforms.unwrap.drop.tombstones=false transforms.unwrap.delete.handling.mode=rewrite transforms.unwrap.add.fields=table,lsn
drop.tombstones=false
-
在事件流中为
DELETE
操作保留 tombstone 记录。 delete.handling.mode=rewrite
对于
DELETE
操作,通过扁平化更改事件中的value
字段来编辑 Kafka 记录。value
字段直接包含before
字段中的键/值对。SMT 添加__deleted
并将其设置为true
,例如:"value": { "pk": 2, "cola": null, "__deleted": "true" }
add.fields=table,lsn
-
在简化的 Kafka 记录中添加
表和
lsn
字段的更改事件元数据。
自定义配置
连接器可能会发出多种类型的事件信息(心跳消息、tombstone 消息或元数据消息有关事务或模式更改)。要将转换应用到事件子集,您可以定义一个 SMT predicate 语句,用于选择性地将转换应用到 特定事件。
12.5.4. 在 Kafka 记录中添加 Debezium 元数据的示例
您可以配置事件扁平化 SMT,将原始更改事件元数据添加到简化的 Kafka 记录中。例如,您可能希望简化的记录的标头或值包含以下任意一种:
- 进行更改的操作类型
- 更改的数据库或表的名称
- 特定于连接器的字段,如 Postgres LSN 字段
要在简化的 Kafka 记录的标头中添加元数据,请指定 add.headers
选项。要在简化的 Kafka 记录的值中添加元数据,请指定 add.fields
选项。每个选项都使用以逗号分隔的更改事件字段名称列表。不要指定空格。当有重复的字段名称时,要为其中一个字段添加元数据,请指定 struct 和字段。例如:
transforms=unwrap,... transforms.unwrap.type=io.debezium.transforms.ExtractNewRecordState transforms.unwrap.add.fields=op,table,lsn,source.ts_ms transforms.unwrap.add.headers=db transforms.unwrap.delete.handling.mode=rewrite
使用这个配置,简化的 Kafka 记录将包含以下内容:
{ ... "__op" : "c", "__table": "MY_TABLE", "__lsn": "123456789", "__source_ts_ms" : "123456789", ... }
另外,简化的 Kafka 记录会有一个 __db
标头。
在简化的 Kafka 记录中,SMT 使用双下划线为 metadata 字段名称添加前缀。当您指定 struct 时,F SMT 也会在 struct 名称和字段名称之间插入下划线。
要在用于 DELETE
操作的简化 Kafka 记录中添加元数据,还必须配置 delete.handling.mode=rewrite
。
12.5.5. 用于有选择地应用事件扁平化转换的选项
除了 Debezium 连接器在发生数据库更改时发出的更改事件消息外,连接器还会发出其他类型的消息,包括心跳消息以及有关架构更改和事务的元数据消息。由于这些消息的结构与 SMT 旨在处理的更改事件消息的结构不同,因此最好将连接器配置为有选择地应用 SMT,以便它只处理预期的数据更改消息。
有关如何有选择地应用 SMT 的更多信息,请参阅为转换配置 SMT predicate。
12.5.6. 配置 Debezium 事件扁平化转换的选项
下表描述了您可以指定配置事件扁平化 SMT 的选项。
选项 | 默认 | 描述 |
---|---|---|
|
Debezium 为每个 | |
|
Debezium 为每个 | |
要使用行数据来确定要将记录路由到的主题,请将此选项设置为 | ||
__ (double-underscore) | 将此可选字符串设置为为字段添加前缀。 | |
没有默认值 |
将这个选项设置为用逗号分开的列表,没有空格,将元数据字段添加到简化的 Kafka 记录的值中。当有重复的字段名称时,要为其中一个字段添加元数据,请指定 struct 和字段,如 | |
__ (double-underscore) | 将此可选字符串设置为标头前缀。 | |
没有默认值 |
将这个选项设置为用逗号分开的列表,没有空格,将元数据字段添加到简化的 Kafka 记录的标头中。当有重复的字段名称时,要为其中一个字段添加元数据,请指定 struct 和字段,如 |