Skip to content

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

Merged
ti-chi-bot[bot] merged 4 commits into
pingcap:masterfrom
doc-claw-bot:docs/dm-feedback-20261030-zh
Oct 30, 2026
Merged

ti-chi-bot[bot] merged 4 commits into
pingcap:masterfrom
doc-claw-bot:docs/dm-feedback-20261030-zh

Conversation

@doc-claw-bot

@doc-claw-bot doc-claw-bot commented Oct 30, 2026 •

Copy link
Copy Markdown
Collaborator

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

  • 文档
    • 更新 SQL 过滤说明:DM 会自动跳过 CREATE PROCEDURE、DROP PROCEDURE 和 ALTER PROCEDURE;DM 与 TiDB 均支持的分区操作无需配置过滤规则。对于导致解析错误且无需同步的分区语句,可配置全局忽略规则,并注意谨慎使用。
    • 更新迁移指南:过滤规则不再忽略 delete 事件,仍忽略 truncate table 和 drop table。
    • 更新 binlog-schema update 示例,改用位置参数传入数据库名、表名和 schema 文件。

@ti-chi-bot ti-chi-bot Bot added the contribution This PR is from a community contributor. label Oct 30, 2026
@doc-claw-bot doc-claw-bot added translation/from-docs This PR is translated from a PR in pingcap/docs. type/bugfix This PR fixes a bug. area/dm labels Oct 30, 2026
@ti-chi-bot ti-chi-bot Bot added missing-translation-status This PR does not have translation status info. area/develop This PR relates to the area of TiDB App development. and removed missing-translation-status This PR does not have translation status info. labels Oct 30, 2026
@coderabbitai

coderabbitai Bot commented Oct 30, 2026 •

Copy link
Copy Markdown

Review in 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

本次更新 DM 文档中的过滤规则说明和配置示例,并调整 binlog-schema update 命令示例的参数写法。

Changes: 过滤规则说明

Layer / File(s) Summary
Binlog 事件过滤说明
filter-binlog-event.md
文档说明 DM 自动跳过 CREATE PROCEDURE、DROP PROCEDURE 和 ALTER PROCEDURE。DM 与 TiDB 均支持的分区操作无需配置过滤规则。若 DM 解析含 ADD PARTITION 或 DROP PARTITION 的 ALTER TABLE 时出错,且无需同步该变更,示例使用全局规则忽略语句。
分片迁移过滤规则
migrate-small-mysql-shards-to-tidb.md
过滤规则说明改为针对部分不兼容的 DDL 事件。sale-filter-rule 不再忽略 delete,仍忽略 truncate table 和 drop table。

Schema 更新命令示例

Layer / File(s) Summary
命令参数示例
migrate-with-more-columns-downstream.md
binlog-schema update 示例改用位置参数传入数据库名、表名和 schema 文件。

Priority: Normal

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

Change: Other

Suggested reviewers: qiancai

Merge Risk: Moderate · previous review 9c763

A global filter may skip valid schema changes, and conflicting procedure guidance may lead users to configure ineffective filters; resolve these before merging.

Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed 标题准确概括了本次文档更新,涵盖事件过滤规则和 binlog-schema 示例修正,简洁且明确。
Description check Passed 描述包含变更内容、适用版本、相关链接、AI agent 信息和变更类型检查项。内容与 PR 目标一致,满足模板要求。
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. (1 skipped: 1 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

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

@ti-chi-bot ti-chi-bot Bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Oct 30, 2026
@pingcap-cla-assistant

pingcap-cla-assistant Bot commented Oct 30, 2026 •

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@doc-claw-bot
doc-claw-bot force-pushed the docs/dm-feedback-20261030-zh branch from eade597 to 7c93b79 Compare October 30, 2026 09:55
@doc-claw-bot doc-claw-bot removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. area/develop This PR relates to the area of TiDB App development. labels Oct 30, 2026
@ti-chi-bot ti-chi-bot Bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Oct 30, 2026
Comment thread filter-binlog-event.md Resolved

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

Reviewing files that changed from the base of the PR and between 9f466f0 and 7c93b79.

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.

Comment thread filter-binlog-event.md Resolved
Comment thread filter-binlog-event.md Resolved
@qiancai

qiancai commented Oct 30, 2026

Copy link
Copy Markdown
Collaborator

“dm/dm-manage-schema.md" is not included in this PR because it is already correct and up to date as pingcap/docs#24598

Comment thread filter-binlog-event.md Resolved

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

Caution

Some comments are outside the diff and can’t be posted inline due to GitHub limitations.

⚠️ Outside diff range comments (1)

Minor · 同步存储过程过滤说明。 · filter-binlog-event.md:101

filter-binlog-event.md:101
Minor · Functional Correctness · Quick win

同步存储过程过滤说明。

filter-binlog-event.md 说明无需为 CREATE PROCEDURE、DROP PROCEDURE 和 ALTER PROCEDURE 配置过滤规则,但 dm/dm-binlog-event-filter.md 仍建议过滤 CREATE PROCEDURE 和 DROP PROCEDURE,且未覆盖 ALTER PROCEDURE。请删除或改写 dm/dm-binlog-event-filter.md 中的旧示例;如果两个文档面向不同版本,请明确版本范围。


Review info
Run configuration
Commits

Reviewing files that changed from the base of the PR and between 39e6096 and 9c7638d.

Files selected for processing: 1
  • filter-binlog-event.md

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

@ti-chi-bot ti-chi-bot Bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Oct 30, 2026
@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Oct 30, 2026
@ti-chi-bot

ti-chi-bot Bot commented Oct 30, 2026

Copy link
Copy Markdown

[LGTM Timeline notifier]

Timeline:

  • 2026-10-30 10:30:08.062672054 +0000 UTC m=+230532.687822306: ☑️ agreed by qiancai.

@qiancai qiancai added the needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. label Oct 30, 2026
@qiancai qiancai added needs-cherry-pick-release-8.1 Should cherry pick this PR to release-8.1 branch. ONCALL Relates to documentation oncall. labels Oct 30, 2026
@qiancai

qiancai commented Oct 30, 2026

Copy link
Copy Markdown
Collaborator

/approve

@qiancai qiancai added the lgtm label Oct 30, 2026
@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 04459f5 into pingcap:master Oct 30, 2026
11 checks passed
@ti-chi-bot

Copy link
Copy Markdown
Member

In response to a cherrypick label: new pull request created to branch release-8.1: #22021.

@ti-chi-bot

Copy link
Copy Markdown
Member

In response to a cherrypick label: new pull request created to branch release-8.5: #22022.

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. 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. ONCALL Relates to documentation oncall. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. translation/from-docs This PR is translated from a PR in pingcap/docs. type/bugfix This PR fixes a bug.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants