Skip to content

docs: clarify TiCDC index DDL ordering (#23336) - #23419

Merged
ti-chi-bot[bot] merged 3 commits into
pingcap:release-8.5from
ti-chi-bot:cherry-pick-23336-to-release-8.5
Aug 3, 2026
Merged

docs: clarify TiCDC index DDL ordering (#23336)#23419
ti-chi-bot[bot] merged 3 commits into
pingcap:release-8.5from
ti-chi-bot:cherry-pick-23336-to-release-8.5

Conversation

@ti-chi-bot

@ti-chi-bot ti-chi-bot commented Aug 3, 2026

Copy link
Copy Markdown
Member

This is an automated cherry-pick of #23336

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

  • Documentation
    • Clarified that ADD INDEX and CREATE INDEX statements are executed asynchronously downstream and return before completion.
    • Updated execution-order guidance to note that most DDL statements are serialized, with TiDB-specific exceptions documented.
    • Added a reference to detailed asynchronous DDL behavior.

@ti-chi-bot ti-chi-bot added contribution This PR is from a community contributor. lgtm size/S Denotes a PR that changes 10-29 lines, ignoring generated files. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR. labels Aug 3, 2026
@coderabbitai

coderabbitai Bot commented Aug 3, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The TiCDC documentation now clarifies that most DDL statements usually execute serially, while ADD INDEX and CREATE INDEX run asynchronously on downstream TiDB clusters.

Changes

TiCDC index DDL documentation

Layer / File(s) Summary
Execution order and asynchronous index DDLs
ticdc/ticdc-faq.md, ticdc/ticdc-ddl.md
The documentation clarifies usual DDL ordering and states that TiCDC returns before downstream TiDB completes ADD INDEX or CREATE INDEX.

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

Possibly related PRs

  • pingcap/docs#23336: Makes the same TiCDC documentation updates for asynchronous index DDL handling and execution ordering.

Suggested labels: type/enhancement, area/ticdc, translation/from-docs-cn

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the main change: clarifying TiCDC index DDL ordering.
Description check ✅ Passed The description explains the changes, affected version, references, AI involvement, and applicable checklist items.
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.

@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 Plus

Run ID: 9c482e56-51dc-4a7f-9313-e535626ab236

📥 Commits

Reviewing files that changed from the base of the PR and between 9c03d3a and 11a03f1.

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

Comment thread ticdc/ticdc-faq.md
@qiancai

qiancai commented Aug 3, 2026

Copy link
Copy Markdown
Collaborator

/approve

@ti-chi-bot

ti-chi-bot Bot commented Aug 3, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiancai

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

The pull request process is described 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 the approved label Aug 3, 2026
@ti-chi-bot
ti-chi-bot Bot merged commit 362a8fa into pingcap:release-8.5 Aug 3, 2026
12 checks passed
@ti-chi-bot
ti-chi-bot Bot deleted the cherry-pick-23336-to-release-8.5 branch August 3, 2026 15:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved contribution This PR is from a community contributor. lgtm size/S Denotes a PR that changes 10-29 lines, ignoring generated files. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants