Skip to content

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

Merged
ti-chi-bot[bot] merged 4 commits into
pingcap:masterfrom
ti-chi-bot:cherry-pick-21937-to-master
Sep 20, 2026
Merged

ti-chi-bot[bot] merged 4 commits into
pingcap:masterfrom
ti-chi-bot:cherry-pick-21937-to-master

Conversation

@ti-chi-bot

@ti-chi-bot ti-chi-bot commented Sep 20, 2026 •

Copy link
Copy Markdown
Member

This is an automated cherry-pick of #21937

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 的使用限制说明。
    • 概括在线校验、部分数据类型比较,以及无主键或唯一索引表校验与修复等场景的限制,并提供相关文档链接。

@ti-chi-bot ti-chi-bot added contribution This PR is from a community contributor. lgtm size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. type/bugfix This PR fixes a bug. type/cherry-pick-for-master This PR is cherry-picked to master from a source PR. labels Sep 20, 2026
@coderabbitai

coderabbitai Bot commented Sep 20, 2026 •

Copy link
Copy Markdown

Review Change StackReview Change Stack

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: cae642e9-f818-4b05-967f-69a29c74ca23

📥 Commits

Reviewing files that changed from the base of the PR and between 38e0b53 and f9627cb.

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

Included review availability: Your plan provides up to 4 included reviews per hour; 1 remains 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) | ~3 minutes

Change: Other

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed 标题准确概括了本次文档修复,明确指出了 sync-diff-inspector 使用限制的更新,内容简洁且与变更一致。
Description check ✅ Passed 描述包含变更内容、适用版本、关联 PR 和参考链接,并标明了 AI agent 参与情况。必需信息基本完整,且与 TiDB 8.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.

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

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 9be10742-3750-4c18-b7ff-0855d335704a

📥 Commits

Reviewing files that changed from the base of the PR and between 924e58f and 38e0b53.

📒 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
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@qiancai

qiancai commented Sep 20, 2026

Copy link
Copy Markdown
Collaborator

/approve

@ti-chi-bot ti-chi-bot Bot added the approved label Sep 20, 2026
@qiancai qiancai added needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. and removed approved labels Sep 20, 2026
@ti-chi-bot ti-chi-bot Bot added the approved label Sep 20, 2026
@ti-chi-bot

ti-chi-bot Bot commented Sep 20, 2026

Copy link
Copy Markdown

@qiancai: You cannot manually add or delete the cherry pick approval state labels, only I and the tursted members have permission to do so. You can approve it in internal platform.

Details

In response to removing label named approved.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the ti-community-infra/tichi repository.

@qiancai

qiancai commented Sep 20, 2026

Copy link
Copy Markdown
Collaborator

/approve

@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 merged commit e705144 into pingcap:master Sep 20, 2026
11 checks passed
@ti-chi-bot
ti-chi-bot Bot deleted the cherry-pick-21937-to-master branch September 20, 2026 02:19
@ti-chi-bot

Copy link
Copy Markdown
Member Author

In response to a cherrypick label: new pull request created to branch release-8.5: #21943.
But this PR has conflicts, please resolve them!

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-release-8.5 Should cherry pick this PR to release-8.5 branch. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. type/bugfix This PR fixes a bug. type/cherry-pick-for-master This PR is cherry-picked to master from a source PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants