Skip to content

docs: clarify TiCDC index DDL ordering#23336

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#23336
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

  • Documentation
    • Clarified TiCDC’s execution order for DDL vs. DML replication as a three-step flow anchored to the DDL commit timestamp.
    • Documented that replication pauses for tables affected by DDL until the DDL commit completes.
    • Added TiDB-specific note that ADD INDEX and CREATE INDEX run asynchronously, allowing subsequent DML to proceed without waiting for completion.

@ti-chi-bot ti-chi-bot Bot added the contribution This PR is from a community contributor. label Jul 22, 2026
@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 jackysp 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 Jul 22, 2026
@doc-claw-bot doc-claw-bot added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed missing-translation-status This PR does not have translation status info. labels 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

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 0d169711-4a0e-4e4b-beea-03391d5c386c

📥 Commits

Reviewing files that changed from the base of the PR and between 348fac6 and a58a942.

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

📝 Walkthrough

Walkthrough

TiCDC documentation now explains DML and DDL replication ordering, including commit timestamp handling and TiDB-specific asynchronous execution of ADD INDEX and CREATE INDEX.

Changes

TiCDC ordering documentation

Layer / File(s) Summary
Ordering and asynchronous index DDL
ticdc/ticdc-faq.md, ticdc/ticdc-ddl.md
The FAQ describes blocking affected-table DML through the DDL commitTS and resuming afterward; the DDL guide clarifies that TiDB index DDL statements execute asynchronously as exceptions to ordered replication.

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

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title matches the main change by highlighting TiCDC index DDL ordering clarification.
Description check ✅ Passed The description follows the template with the required change summary, version, links, AI involvement, and checklist sections.
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
@doc-claw-bot doc-claw-bot 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/S Denotes a PR that changes 10-29 lines, ignoring generated files. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants