Skip to content

docs: fix sync-diff-inspector limitations in migration tools (#23887) - #23903

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

ti-chi-bot[bot] merged 4 commits into
pingcap:masterfrom
ti-chi-bot:cherry-pick-23887-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 #23887

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.

  • 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)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)
  • v5.3 (TiDB 5.3 versions)

What is the related PR or file link(s)?

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
    • Updated the migration tools overview to consolidate sync-diff-inspector limitations into a single reference to the detailed restrictions section.

@ti-chi-bot ti-chi-bot added contribution This PR is from a community contributor. lgtm needs-1-more-lgtm Indicates a PR needs 1 more 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/.coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: aca2c4c7-d278-4d89-85dc-786eaeb51e77

📥 Commits

Reviewing files that changed from the base of the PR and between 2ed75b5 and 1a6a416.

📒 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

The sync-diff-inspector entry in migration-tools.md replaces two restriction bullets with one bullet that links to the detailed restrictions documentation.

Changes

Sync-diff-inspector restrictions

Layer / File(s) Summary
Consolidate restriction guidance
migration-tools.md
The entry now covers online-check, data-type comparison, and inconsistent-data repair limitations. It links to the “Restrictions of sync-diff-inspector” section.

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 The title clearly identifies the documentation change and the affected sync-diff-inspector limitations entry.
Description check ✅ Passed The description explains the change, identifies the affected v8.5 version, and provides related references. The optional first-time contributor and AI agent sections are omitted, but the required sect…
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.

Comment thread migration-tools.md Outdated
@qiancai

qiancai commented Sep 20, 2026

Copy link
Copy Markdown
Collaborator

/approve

@qiancai qiancai added the needs-cherry-pick-master Should cherry pick this PR to master branch. 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 564eda0 into pingcap:master Sep 20, 2026
12 checks passed
@ti-chi-bot

Copy link
Copy Markdown
Member Author

In response to a cherrypick label: base branch (master) needs to differ from target branch (master).

@ti-chi-bot
ti-chi-bot Bot deleted the cherry-pick-23887-to-master branch September 20, 2026 02:22
@qiancai qiancai added needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. and removed needs-cherry-pick-master Should cherry pick this PR to master branch. labels Sep 20, 2026
@ti-chi-bot

Copy link
Copy Markdown
Member Author

In response to a cherrypick label: new pull request created to branch release-8.5: #23906.
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-1-more-lgtm Indicates a PR needs 1 more 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