Skip to content

docs(dm): fix stale event-filter and binlog-schema examples (#22020) - #22021

Merged
ti-chi-bot[bot] merged 4 commits into
pingcap:release-8.1from
ti-chi-bot:cherry-pick-22020-to-release-8.1
Oct 30, 2026
Merged

ti-chi-bot[bot] merged 4 commits into
pingcap:release-8.1from
ti-chi-bot:cherry-pick-22020-to-release-8.1

Conversation

@ti-chi-bot

@ti-chi-bot ti-chi-bot commented Oct 30, 2026 •

Copy link
Copy Markdown
Member

This is an automated cherry-pick of #22020

What is changed, added or deleted? (Required)

  • Fix the DM shard-merge example so the DDL-only event filter no longer includes the delete DML event.
  • Update the Chinese binlog-schema update example to match the current positional-argument syntax.
  • Clarify how to handle SQL statements that TiDB does not support or that DM cannot parse, including the partition-filter example and global-filter warning.

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

  • master (the latest development version)
  • 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)

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 when to use global SQL filtering for partition operations, which procedure statements DM skips automatically, and the risks of broad SQL pattern matching.
    • Updated DDL filter guidance to list TRUNCATE TABLE and DROP TABLE as ignored events.
    • Corrected a binlog-schema update example to use positional arguments and updated its table and schema file names.

@ti-chi-bot ti-chi-bot added area/dm contribution This PR is from a community contributor. lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. ONCALL Relates to documentation oncall. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. type/bugfix This PR fixes a bug. type/cherry-pick-for-release-8.1 This PR is cherry-picked to release-8.1 from a source PR. labels Oct 30, 2026
@coderabbitai

coderabbitai Bot commented Oct 30, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: b9be0634-89cb-4a22-a350-1cf1a9320691
Commits

Reviewing files that changed from the base of the PR and between 9b784dd and e3db526.

Files selected for processing: 3
  • filter-binlog-event.md
  • migrate-small-mysql-shards-to-tidb.md
  • migrate-with-more-columns-downstream.md

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

Walkthrough

The documentation updates clarify SQL and DDL filtering guidance and revise a binlog-schema update command example. They affect three migration and replication guides.

Changes: DM documentation updates

Layer / File(s) Summary
SQL and DDL filter guidance
filter-binlog-event.md, migrate-small-mysql-shards-to-tidb.md
The docs state that DM skips specified procedure statements, explain when a global rule can filter partition-related ALTER TABLE statements, and warn about regex matches. The DDL filter example no longer lists delete; it retains truncate table and drop table.
Binlog-schema command example
migrate-with-more-columns-downstream.md
The example uses positional database, table, and schema-file arguments instead of -d and -t. It changes the example table and schema filenames to messages and log.messages.sql.

Priority: Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Possibly related PRs

  • pingcap/docs-cn#22020: This master-branch change updates the same three files with the same documentation changes.

Suggested reviewers: qiancai

Merge Risk: Minimal · up to e3db5

The documentation updates are ready to merge with no identified correctness or operational risk.

Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title clearly summarizes the documentation fixes for event filtering and binlog-schema examples.
Description check Passed The description covers the required changes, affected versions, related references, AI involvement, and repository checklist items. It is complete and relevant.
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
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.
Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (3 skipped: 3 unsupported.)

Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

A rabbit reads the filters twice,
Then checks the partition advice.
The schema names line up just right,
The command hops into the night.
Three pages rest beneath the moon,
While carrots wait for review soon.

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

@qiancai

qiancai commented Oct 30, 2026

Copy link
Copy Markdown
Collaborator

/approve

@ti-chi-bot

ti-chi-bot Bot commented Oct 30, 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 Oct 30, 2026
@ti-chi-bot
ti-chi-bot Bot merged commit d039c26 into pingcap:release-8.1 Oct 30, 2026
8 checks passed
@ti-chi-bot
ti-chi-bot Bot deleted the cherry-pick-22020-to-release-8.1 branch October 30, 2026 12:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved area/dm contribution This PR is from a community contributor. lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. ONCALL Relates to documentation oncall. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. type/bugfix This PR fixes a bug. type/cherry-pick-for-release-8.1 This PR is cherry-picked to release-8.1 from a source PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants