Skip to content

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

Merged
ti-chi-bot[bot] merged 2 commits into
pingcap:release-8.5from
ti-chi-bot:cherry-pick-23903-to-release-8.5
Sep 20, 2026
Merged

ti-chi-bot[bot] merged 2 commits into
pingcap:release-8.5from
ti-chi-bot:cherry-pick-23903-to-release-8.5

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 #23903

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
    • Clarified sync-diff-inspector limitations for online data migration checks between MySQL and TiDB.
    • Clarified limitations when comparing certain data types and repairing inconsistent data in tables without a primary key or unique index.

Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>
@ti-chi-bot ti-chi-bot added contribution This PR is from a community contributor. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. 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. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR. labels Sep 20, 2026
@ti-chi-bot ti-chi-bot self-assigned this Sep 20, 2026
@ti-chi-bot

Copy link
Copy Markdown
Member Author

@ti-chi-bot This PR has conflicts, I have hold it.
Please resolve them or ask others to resolve them, then comment /unhold to remove the hold label.

@ti-chi-bot

ti-chi-bot Bot commented Sep 20, 2026

Copy link
Copy Markdown

@ti-chi-bot: ## If you want to know how to resolve it, please read the guide in TiDB Dev Guide.

Details

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.

@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: 5a4b3b02-11b8-43e6-ab42-7a25c5fe58cd

📥 Commits

Reviewing files that changed from the base of the PR and between d021768 and 742c71c.

📒 Files selected for processing (1)
  • migration-tools.md
💤 Files with no reviewable changes (1)
  • migration-tools.md

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


📝 Walkthrough

Walkthrough

The sync-diff-inspector limitation bullet in the migration tools documentation was reworded to state its online-check and data-repair limitations more precisely.

Changes

Migration tools documentation

Layer / File(s) Summary
Sync-diff-inspector limitation text
migration-tools.md
The limitation bullet now states that online checks for MySQL-to-TiDB migration are unsupported. It also describes limitations for comparing certain data types and repairing inconsistent data in tables without a primary key or unique index.

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 to sync-diff-inspector limitations in the migration tools overview. The issue references add noise but do not obscure the main change.
Description check ✅ Passed The description explains the documentation change, identifies the affected TiDB version, and provides related PR and reference links. It omits the optional first-time contributor and AI-agent sections…
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/.coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: c6cb9c2b-3ac6-4830-a8b5-15cf7df08698

📥 Commits

Reviewing files that changed from the base of the PR and between 743161b and d021768.

📒 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
@qiancai qiancai removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 20, 2026
@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 added the approved label Sep 20, 2026
@ti-chi-bot
ti-chi-bot Bot merged commit 884aa5a into pingcap:release-8.5 Sep 20, 2026
12 checks passed
@ti-chi-bot
ti-chi-bot Bot deleted the cherry-pick-23903-to-release-8.5 branch September 20, 2026 07:50
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. 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. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants