cdc: add description about the tidb extension field #19369
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ti-chi-bot
bot
added
missing-translation-status
hfxsd
reviewed
Dec 25, 2024
hfxsd
added
translation/doing
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
hfxsd
added
do-not-merge/hold
|
@3AceShowHand: The following test failed, say
Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
hfxsd
reviewed
Jan 6, 2025
|
|
||
| | 字段 | 类型 | 说明 | | ||
| |:-------------------|:-------|:-------------------------------------------------------------------------| | ||
| | commitTs | Number | 产生事件变更的事务提交使用的 TSO。设置于 DDL 和 DML 事件 | |
There was a problem hiding this comment.
Suggested change
| | commitTs | Number | 产生事件变更的事务提交使用的 TSO。设置于 DDL 和 DML 事件 | | |
| | commitTs | Number | 提交产生事件变更的事务使用的 TSO。用于 DDL 和 DML 事件。 | |
hfxsd
reviewed
Jan 6, 2025
| @@ -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 时才会存在。 | | |||
|
|
|||
hfxsd
reviewed
Jan 6, 2025
Comment on lines
+93
to
+97
| | 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 事件 | |
There was a problem hiding this comment.
Suggested change
| | 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 事件 | | |
| | 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 事件。 | |
hfxsd
reviewed
Jan 6, 2025
| | onlyHandleKey | Bool | 当前事件仅包含 handle key 部分内容。设置于 DML 事件 | | ||
| | claimCheckLocation | String | 当前事件含有 claim check location。设置于 DML 事件 | | ||
|
|
||
| `tableId` 和 `partitionId` 字段从 xxx 版本开始引入，主要目的是为了应对分区表场景下，消费者可以通过 `partitionId` 得知当前事件所属的表分区，以及关联的分区表。 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
First-time contributors' checklist
What is changed, added or deleted? (Required)
Which TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
For details, see tips for choosing the affected versions (in Chinese).
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?