Skip to content

cdc: add more usage caution about the table route - #21932

Open
3AceShowHand wants to merge 1 commit into
pingcap:masterfrom
3AceShowHand:table-route-usage-caution
Open

3AceShowHand wants to merge 1 commit into
pingcap:masterfrom
3AceShowHand:table-route-usage-caution

Conversation

@3AceShowHand

@3AceShowHand 3AceShowHand commented Sep 15, 2026

Copy link
Copy Markdown
Contributor

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.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)

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

  • Related code change PR links (if applicable):
  • This PR is translated from:
  • Other reference link(s):

AI agent involvement

  • The changes in this PR were primarily made by an AI agent on behalf of the PR author.

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

Summary by CodeRabbit

  • 文档
    • 更新 TiCDC 表路由文档,明确分库场景下 DML、表级 DDL 与库级 DDL 的处理规则。
    • 补充被事件过滤的 DDL、默认目标库冲突检查及删库改写行为说明。
    • 扩展合库配置示例,新增事件过滤规则与删除目标库风险警告。

@ti-chi-bot

ti-chi-bot Bot commented Sep 15, 2026

Copy link
Copy Markdown

[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 csuzhangxc for approval. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found here.

Details 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 Sep 15, 2026
@coderabbitai

coderabbitai Bot commented Sep 15, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 6b684eb8-cdd2-41d6-b306-32e9eb23b3b5

📥 Commits

Reviewing files that changed from the base of the PR and between 924e58f and e31e55d.

📒 Files selected for processing (1)
  • ticdc/ticdc-table-routing.md

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.


📝 Walkthrough

Walkthrough

更新 TiCDC 表路由文档,明确分库对 DML、表级 DDL 和库级 DDL 的处理方式,并补充合库场景的事件过滤配置与删库风险。

Changes

表路由规则与风险说明

Layer / File(s) Summary
分库与合库路由说明
ticdc/ticdc-table-routing.md
明确分库仅适用于 DML 和表级 DDL。说明库级 DDL 不会拆分为多个目标库操作,被过滤的 DDL 仍参与路由处理。补充默认目标库和 DROP DATABASE sales 的示例。合库示例新增 sales.*crm.*finance.* 的事件过滤配置,并警告未过滤的删库事件会删除整个目标库。

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to e31e5

The documentation-only change adds supported routing cautions and filtering guidance without an identified current risk to users or deployments.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning 描述包含贡献者协议、目标版本和其他模板章节,但必填的“ What is changed, added, or deleted? ”章节为空,未说明具体修改内容和原因。 补充变更内容和修改原因。请说明 TiCDC 表路由文档新增了哪些分库、合库及库级 DDL 使用注意事项,并说明这些变更适用的场景。
✅ Passed checks (4 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed 标题与变更内容相关,明确说明为表路由新增使用注意事项。表述简洁,能够概括主要变更。
  • Fix all pre-merge checks with AI
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

missing-translation-status This PR does not have translation status info. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant