Skip to content

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

Open
doc-claw-bot wants to merge 1 commit into
pingcap:release-8.5from
doc-claw-bot:docs/sync-diff-migration-tools-8.5
Open

doc-claw-bot wants to merge 1 commit 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.

  • 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 sync-diff-inspector data type guidance.
    • Clarified support for JSON, BLOB/VARBINARY, and BIT types.
    • Directed users to the restrictions documentation for FLOAT/DOUBLE and collation considerations.

@ti-chi-bot ti-chi-bot Bot added the contribution This PR is from a community contributor. label Sep 16, 2026
@ti-chi-bot

ti-chi-bot Bot commented Sep 16, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign kissmydb for approval. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found 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 missing-translation-status This PR does not have translation status info. label Sep 16, 2026
@ti-chi-bot ti-chi-bot Bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Sep 16, 2026
@doc-claw-bot doc-claw-bot added type/bugfix This PR fixes a bug. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. needs-cherry-pick-master Should cherry pick this PR to master branch. labels Sep 16, 2026
@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 commented Sep 16, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

📝 Walkthrough

Walkthrough

The sync-diff-inspector documentation now lists JSON, BLOB/VARBINARY, and BIT as supported. It also directs readers to the restrictions documentation for FLOAT/DOUBLE and collation considerations.

Changes

Sync-diff-inspector documentation

Layer / File(s) Summary
Update data-type limitations
migration-tools.md
The limitation statement now documents support for JSON, BLOB/VARBINARY, and BIT. It links FLOAT/DOUBLE and collation guidance to the restrictions page.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: 🔵 Low · up to 4751f

Readers may rely on unsupported BIT widths or mistake JSON false positives for real differences. Clarify the limitations before merging.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the documentation fix for sync-diff-inspector limitations.
Description check ✅ Passed The description explains the documentation changes, identifies the affected TiDB version, and provides relevant reference links. The omitted optional first-time contributor and AI involvement 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 PR with unit tests

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: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 0f92ea01-72db-4677-a80f-dbea32741298

📥 Commits

Reviewing files that changed from the base of the PR and between 6acba5d and 4751f97.

📒 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
- **Limitation**:
- Online check is not supported for data migration between MySQL and TiDB.
- JSON, BIT, BINARY, BLOB and other types of data are not supported.
- Data type support varies by type. JSON, BLOB/VARBINARY, and BIT are supported. For FLOAT/DOUBLE and collation-related considerations, see [Restrictions of sync-diff-inspector](/sync-diff-inspector/sync-diff-inspector-overview.md).

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

🔎 Supported by static analysis

🏁 Script executed:

sed -n '72,95p' migration-tools.md
sed -n '45,70p' sync-diff-inspector/sync-diff-inspector-overview.md
sed -n '310,335p' sync-diff-inspector/sync-diff-inspector-overview.md

Repository: pingcap/docs

Length of output: 7736


Document the restrictions for JSON and BIT.

The linked restrictions document qualifies the current support claim: JSON string comparisons can produce false positives when collations or character sets differ, and BIT is validated only for MySQL-to-TiDB comparisons with widths 1, 8, 16, and 64. The current summary does not expose these limits.

Suggested replacement
Suggested change
- Data type support varies by type. JSON, BLOB/VARBINARY, and BIT are supported. For FLOAT/DOUBLE and collation-related considerations, see [Restrictions of sync-diff-inspector](/sync-diff-inspector/sync-diff-inspector-overview.md).
- Data type support varies by type. JSON is supported, but collation and character set differences for JSON string values can cause false positives. BLOB/VARBINARY are supported and compared byte-for-byte. BIT is supported for MySQL to TiDB comparisons for widths 1, 8, 16, and 64. For FLOAT/DOUBLE and additional collation considerations, see [Restrictions of sync-diff-inspector](/sync-diff-inspector/sync-diff-inspector-overview.md).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

contribution This PR is from a community contributor. 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/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. type/bugfix This PR fixes a bug.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant