Skip to content

docs: fix sync-diff-inspector limitations in migration tools - #21937

Merged
ti-chi-bot[bot] merged 3 commits into
pingcap:release-8.5from
doc-claw-bot:docs/sync-diff-migration-tools-8.5
Sep 20, 2026
Merged

ti-chi-bot[bot] merged 3 commits into
pingcap:release-8.5from
doc-claw-bot:docs/sync-diff-migration-tools-8.5

Conversation

@doc-claw-bot

@doc-claw-bot doc-claw-bot commented Sep 16, 2026 •

Copy link
Copy Markdown
Collaborator

What is changed, added or deleted? (Required)

This PR updates the sync-diff-inspector row in migration-tools.md on release-8.5 to match the detailed stable documentation.

  • Remove the incorrect statement that JSON, BIT, BINARY, and BLOB data are unsupported.
  • Clarify that JSON, BLOB/VARBINARY, and BIT are supported.
  • Point readers to the detailed restrictions page for FLOAT/DOUBLE and collation-related considerations.

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

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions (in Chinese).

  • 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

  • 文档
    • 更新 sync-diff-inspector 使用限制说明。
    • 概述其在 MySQL/TiDB 在线校验、部分数据类型比较,以及无主键或唯一索引表校验和修复场景中的限制。
    • 新增详细限制文档链接,帮助用户更准确地了解适用范围。

@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 Sep 16, 2026
@doc-claw-bot doc-claw-bot added type/bugfix This PR fixes a bug. translation/from-docs This PR is translated from a PR in pingcap/docs. needs-cherry-pick-master Should cherry pick this PR to master branch. labels Sep 16, 2026
@coderabbitai

coderabbitai Bot commented Sep 16, 2026 •

Copy link
Copy Markdown

Review Change StackReview 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: Repository: pingcap/docs-cn/.coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 96f445e6-8acf-4fb2-9d24-902351a1bee1

📥 Commits

Reviewing files that changed from the base of the PR and between 66dbf96 and b9960d0.

📒 Files selected for processing (1)
  • migration-tools.md

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


📝 Walkthrough

Walkthrough

文档更新了 sync-diff-inspector 的使用限制说明。内容覆盖在线校验、部分数据类型比较,以及无主键或唯一索引表的校验和修复场景,并链接至详细限制文档。

Changes

sync-diff-inspector 文档更新

Layer / File(s) Summary
更新使用限制说明
migration-tools.md
将原有的数据类型不支持说明改为概述在线校验、部分数据类型比较,以及无主键或唯一索引表的校验和修复限制,并添加详细限制文档链接。

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: qiancai

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed 标题准确概括了文档中修正 sync-diff-inspector 限制说明的主要变更,内容简洁且具体。
Description check ✅ Passed 描述已说明变更内容、适用版本、相关链接、AI 参与情况及变更类型。必填部分基本完整,并明确变更针对 TiDB v8.5。
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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 a new PR

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 removed the missing-translation-status This PR does not have translation status info. label Sep 16, 2026

@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: Advanced

Run ID: 53d25b64-684b-4499-b5e3-70c24ee4c7a1

📥 Commits

Reviewing files that changed from the base of the PR and between 25a2849 and 4c7175d.

📒 Files selected for processing (1)
  • migration-tools.md

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

Comment thread migration-tools.md Outdated
Comment thread migration-tools.md Outdated
Comment thread migration-tools.md Outdated
@qiancai

qiancai commented Sep 20, 2026

Copy link
Copy Markdown
Collaborator

/approve

@qiancai qiancai added the lgtm label Sep 20, 2026
@ti-chi-bot

ti-chi-bot Bot commented Sep 20, 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 Sep 20, 2026
@ti-chi-bot
ti-chi-bot Bot merged commit 02182ab into pingcap:release-8.5 Sep 20, 2026
11 checks passed
@ti-chi-bot

Copy link
Copy Markdown
Member

In response to a cherrypick label: new pull request created to branch master: #21942.

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 needs-cherry-pick-master Should cherry pick this PR to master 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. type/bugfix This PR fixes a bug.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants