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.

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

Conversation

3AceShowHand
Copy link
Contributor

@3AceShowHand 3AceShowHand commented Dec 24, 2024

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).

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 versions)
  • v8.2 (TiDB 8.2 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)
  • v5.3 (TiDB 5.3 versions)

What is the related PR or file link(s)?

  • This PR is translated from:
  • Other reference link(s):

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

Copy link

ti-chi-bot bot commented Dec 24, 2024

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign lance6716 for approval. For more information see the Code Review Process.

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ti-chi-bot ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Dec 24, 2024
@3AceShowHand 3AceShowHand requested a review from hfxsd December 24, 2024 09:52
Copy link

ti-chi-bot bot commented Dec 24, 2024

@3AceShowHand: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-verify a93e8df link true /test pull-verify

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.

Comment on lines +88 to +99
_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 得知当前事件所属的表分区,以及关联的分区表。
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` 得知当前事件所属的表分区,以及关联的分区表。

@hfxsd hfxsd self-assigned this Dec 25, 2024
@hfxsd hfxsd added translation/doing This PR’s assignee is translating this PR. and removed missing-translation-status This PR does not have translation status info. labels Dec 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/S Denotes a PR that changes 10-29 lines, ignoring generated files. translation/doing This PR’s assignee is translating this PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants