docs: fix sync-diff-inspector limitations in migration tools - #21937
doc-claw-bot wants to merge 1 commit into
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
ti-chi-bot
Bot
added
contribution
doc-claw-bot
added
type/bugfix
📝 WalkthroughWalkthroughChangessync-diff-inspector 文档更新
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~2 minutes Change: Other Merge Risk: 🔵 Low · up to The documentation may cause users to overestimate type support and misinterpret narrow JSON or BIT comparison cases. 🚥 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 |
ti-chi-bot
Bot
removed
the
missing-translation-status
![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: 53d25b64-684b-4499-b5e3-70c24ee4c7a1
📒 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.
| | **下游** | TiDB，MySQL | | ||
| | **主要优势** | 提供了修复数据的功能，适用于修复少量不一致的数据。| | ||
| | **使用限制** | <ul><li>对于 MySQL 和 TiDB 之间的数据同步不支持在线校验。</li><li>不支持 JSON、BIT、BINARY、BLOB 等类型的数据。</li></ul> | | ||
| | **使用限制** | <ul><li>对于 MySQL 和 TiDB 之间的数据同步不支持在线校验。</li><li>不同数据类型的支持情况有所不同。JSON、BLOB/VARBINARY 和 BIT 类型受支持；关于 FLOAT/DOUBLE 和排序规则相关注意事项，请参见 <a href="/sync-diff-inspector/sync-diff-inspector-overview.md">sync-diff-inspector 的使用限制</a>。</li></ul> | |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🔎 Supported by static analysis
🏁 Script executed:
sed -n '45,70p' sync-diff-inspector/sync-diff-inspector-overview.md
git diff -- migration-tools.md
rg -n 'BIT|JSON|字符集|排序规则|collation|charset' sync-diff-inspector migration-tools.mdRepository: pingcap/docs-cn
Length of output: 2889
补充 BIT 位宽和 JSON 字符集限制。
使用限制文档仅说明已验证 BIT 位宽为 1、8、16 和 64。当前摘要会让用户误以为所有 BIT 类型均已验证支持。该文档还指出，JSON 字符串值可能因排序规则和字符集差异产生误报。
| | **使用限制** | <ul><li>对于 MySQL 和 TiDB 之间的数据同步不支持在线校验。</li><li>不同数据类型的支持情况有所不同。JSON、BLOB/VARBINARY 和 BIT 类型受支持；关于 FLOAT/DOUBLE 和排序规则相关注意事项，请参见 <a href="/sync-diff-inspector/sync-diff-inspector-overview.md">sync-diff-inspector 的使用限制</a>。</li></ul> | | |
| | **使用限制** | <ul><li>对于 MySQL 和 TiDB 之间的数据同步不支持在线校验。</li><li>不同数据类型的支持情况有所不同。JSON 支持比较，但上下游之间 JSON 字符串值的排序规则和字符集差异可能导致误报数据不一致；BLOB/VARBINARY 支持比较，按二进制数据逐字节进行校验；BIT 支持 MySQL 与 TiDB 之间的数据比较，已验证支持位宽为 1、8、16 和 64 的 BIT 类型。对于非标准位宽或应用层转换场景，请先进行针对性的验证测试；关于 FLOAT/DOUBLE 的注意事项，请参见 <a href="/sync-diff-inspector/sync-diff-inspector-overview.md">sync-diff-inspector 的使用限制</a>。</li></ul> | |
1 participant
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 (in Chinese).
What is the related PR or file link(s)?
AI agent involvement
Do your changes match any of the following descriptions?
Summary by CodeRabbit