docs: fix sync-diff-inspector limitations in migration tools - #23887
ti-chi-bot[bot] merged 3 commits into
Conversation
ti-chi-bot
Bot
added
contribution
ti-chi-bot
Bot
added
the
size/XS
doc-claw-bot
added
type/bugfix
ti-chi-bot
Bot
removed
the
missing-translation-status
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository: pingcap/docs/.coderabbit.yaml Review profile: ASSERTIVE Plan: Advanced Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review. 📝 WalkthroughWalkthroughThe sync-diff-inspector limitation entry now describes restrictions for online checks, data-type comparisons, and tables without a primary key or unique index. It links to the restrictions documentation. ChangesSync-diff-inspector documentation
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~2 minutes Change: Other Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
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
📒 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.
| - **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). |
There was a problem hiding this comment.
🎯 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.mdRepository: 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
| - 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). |
|
/approve |
[LGTM Timeline notifier]Timeline:
|
|
[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 DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
In response to a cherrypick label: new pull request created to branch |
3 participants
What is changed, added or deleted? (Required)
This PR updates the
sync-diff-inspectorrow inmigration-tools.mdonrelease-8.5to match the detailed stable documentation.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.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?
Summary by CodeRabbit