Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cdc: add description about the tidb extension field #19369

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

cdc: add description about the tidb extension field #19369

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion ticdc/ticdc-canal-json.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,21 @@ TiCDC 会把一个 DDL Event 编码成如下 Canal-JSON 格式：
| mysqlType | object | 当 isDdl 为 false 时，记录每一列数据类型在 MySQL 中的类型表示 |
| data | Object | 当 isDdl 为 false 时，记录每一列的名字及其数据值 |
| old | Object | 仅当该条消息由 Update 类型事件产生时，记录每一列的名字，和 Update 之前的数据值 |
| _tidb | Object | TiDB 扩展字段，仅当 `enable-tidb-extension` 为 true 时才会存在。其中的 `commitTs` 值为造成 Row 变更的事务的 TSO |
| _tidb | Object | TiDB 扩展字段，仅当 `enable-tidb-extension` 为 true 时才会存在。 |


_tidb 即 TiDB 扩展字段中的子字段说明：

| 字段 | 类型 | 说明 |
|:-------------------|:-------|:-------------------------------------------------------------------------|
| commitTs | Number | 产生事件变更的事务提交使用的 TSO。 设置于 DDL 和 DML 事件 |
| watermarkTs | Number | TiCDC 周期性发送的 watermark ts，其类型也是 TSO。设置于 Watermark 事件|
| tableId | Number | 事件所属表的 ID。设置于 DML 事件 |
| partitionId | Number | 事件如果来自于分区表，消息会携带该字段，表示所属分区的 ID。设置于 DML 事件 |
| onlyHandleKey | Bool | 当前事件仅包含 handle key 部分内容。设置于 DML 事件 |
| claimCheckLocation | String | 当前事件含有 claim check location。设置于 DML 事件 |

tableId 和 partitionId 字段从 xxx 版本开始引入，主要目的是为了应对分区表场景下，消费者可以通过 partitionId 得知当前事件所属的表分区，以及关联的分区表。
Comment on lines +88 to +99
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
_tidb 即 TiDB 扩展字段中的子字段说明：
| 字段 | 类型 | 说明 |
|:-------------------|:-------|:-------------------------------------------------------------------------|
| commitTs | Number | 产生事件变更的事务提交使用的 TSO。 设置于 DDL 和 DML 事件 |
| watermarkTs | Number | TiCDC 周期性发送的 watermark ts，其类型也是 TSO。设置于 Watermark 事件|
| tableId | Number | 事件所属表的 ID。设置于 DML 事件 |
| partitionId | Number | 事件如果来自于分区表，消息会携带该字段，表示所属分区的 ID。设置于 DML 事件 |
| onlyHandleKey | Bool | 当前事件仅包含 handle key 部分内容。设置于 DML 事件 |
| claimCheckLocation | String | 当前事件含有 claim check location。设置于 DML 事件 |
tableId 和 partitionId 字段从 xxx 版本开始引入，主要目的是为了应对分区表场景下，消费者可以通过 partitionId 得知当前事件所属的表分区，以及关联的分区表。
_tidb 即 TiDB 扩展字段，其子字段说明如下：
| 字段 | 类型 | 说明 |
|:-------------------|:-------|:-------------------------------------------------------------------------|
| commitTs | Number | 产生事件变更的事务提交使用的 TSO。设置于 DDL 和 DML 事件 |
| watermarkTs | Number | TiCDC 周期性发送的 Watermark Ts，其类型也是 TSO。设置于 Watermark 事件|
| tableId | Number | 事件所属表的 ID。设置于 DML 事件 |
| partitionId | Number | 事件如果来自于分区表，消息会携带该字段，表示所属分区的 ID。设置于 DML 事件 |
| onlyHandleKey | Bool | 当前事件仅包含 handle key 部分内容。设置于 DML 事件 |
| claimCheckLocation | String | 当前事件含有 claim check location。设置于 DML 事件 |
`tableId` 和 `partitionId` 字段从 xxx 版本开始引入，主要目的是为了应对分区表场景下，消费者可以通过 `partitionId` 得知当前事件所属的表分区，以及关联的分区表。


### DML Event

Expand Down
Loading