Skip to content

docs: clarify TiCDC index DDL ordering#21829

Open
doc-claw-bot wants to merge 3 commits into
pingcap:masterfrom
doc-claw-bot:docs/ticdc-ddl-order-clarification
Open

docs: clarify TiCDC index DDL ordering#21829
doc-claw-bot wants to merge 3 commits into
pingcap:masterfrom
doc-claw-bot:docs/ticdc-ddl-order-clarification

Conversation

@doc-claw-bot

@doc-claw-bot doc-claw-bot commented Jul 22, 2026

Copy link
Copy Markdown
Collaborator

First-time contributors' checklist

What is changed, added or deleted? (Required)

  • Clarify in the TiCDC FAQ that the general DML/DDL execution order has an exception for ADD INDEX and CREATE INDEX when the downstream is TiDB.
  • Update the TiCDC DDL page to explicitly call out these two DDLs as exceptions so the FAQ and DDL pages stay consistent.

Which TiDB version(s) do your changes apply to? (Required)

  • 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)?

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 DDL 异步执行说明:在章节中更突出“TiDB 下 ADD INDEX / CREATE INDEX 属于例外”,说明 TiCDC 会在下游同步后立即返回,不等待 DDL 完成以避免阻塞后续 DML。
    • 调整 DML 与 DDL 执行顺序说明:在 如何理解 DML 和 DDL 之间的执行顺序? 中补充 TiDB 场景下 ADD INDEX / CREATE INDEX 的异步例外,并补充相关参考链接。

@ti-chi-bot

ti-chi-bot Bot commented Jul 22, 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 icemap 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 contribution This PR is from a community contributor. missing-translation-status This PR does not have translation status info. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jul 22, 2026
@doc-claw-bot doc-claw-bot added the translation/from-docs This PR is translated from a PR in pingcap/docs. label Jul 22, 2026
@ti-chi-bot ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. label Jul 22, 2026
@coderabbitai

coderabbitai Bot commented Jul 22, 2026

Copy link
Copy Markdown

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

TiCDC 文档更新了 TiDB 下游 ADD INDEXCREATE INDEX 的异步执行规则,并补充其作为默认 DML、DDL 执行顺序例外的说明及参考链接。

Changes

TiCDC 索引 DDL 执行顺序说明

Layer / File(s) Summary
索引 DDL 异步规则说明
ticdc/ticdc-ddl.md, ticdc/ticdc-faq.md
更新 TiDB 下游 ADD INDEXCREATE INDEX 的异步执行说明,并补充其作为 DML、DDL 默认顺序例外的参考链接。

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

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed 标题准确概括了本次对 TiCDC 索引 DDL 顺序说明的文档澄清。
Description check ✅ Passed 描述包含模板要求的变更说明、适用版本、相关链接和 AI 参与信息,内容基本完整。
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
✨ 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.

Comment thread ticdc/ticdc-ddl.md Outdated
Comment thread ticdc/ticdc-faq.md Outdated
Comment thread ticdc/ticdc-ddl.md Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: d65ebad6-357f-45b7-b7fc-37c111bb56ac

📥 Commits

Reviewing files that changed from the base of the PR and between 79e082d and ac81ac2.

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

Comment thread ticdc/ticdc-ddl.md
@qiancai qiancai added needs-cherry-pick-release-7.5 Should cherry pick this PR to release-7.5 branch. needs-cherry-pick-release-8.1 Should cherry pick this PR to release-8.1 branch. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. labels Jul 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

contribution This PR is from a community contributor. needs-cherry-pick-release-7.5 Should cherry pick this PR to release-7.5 branch. needs-cherry-pick-release-8.1 Should cherry pick this PR to release-8.1 branch. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. translation/from-docs This PR is translated from a PR in pingcap/docs.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants