sync-diff-inspector: clarify data type support and improve collation guidance

[alastori]

What is changed, added or deleted? (Required)

This PR updates the sync-diff-inspector documentation to fix misleading language about data type support and add empirically-validated guidance to prevent false-positive validation failures.

Key changes:

1. Clarified data type support: Added explicit documentation that JSON, BLOB/VARBINARY, and BIT types are supported, correcting misleading comments suggesting they are not.

2. Improved collation guidance: Enhanced the collation warning with specific examples (MySQL 8.0 utf8mb4_0900_ai_ci vs TiDB utf8mb4_bin) and actionable recommendations to avoid false positives.

3. Documented known false-positive patterns: Added list of scenarios that produce false differences (collation mismatches in VARCHAR/TEXT/JSON, auto-populated TIMESTAMP columns).

4. Added TIMESTAMP handling guidance: Provided concrete approaches for handling auto-populated timestamp columns during validation.

All changes are based on comprehensive empirical validation testing using MySQL 8.0 → TiDB v8.5.4.

Which TiDB version(s) do your changes apply to? (Required)

• master (the latest development version)
• v9.0 (TiDB 9.0 versions)
• v8.5 (TiDB 8.5 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)

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

• This PR addresses documentation accuracy issues identified through empirical validation
• Related to sync-diff-inspector tool: https://github.com/pingcap/tiflow/tree/master/sync_diff_inspector

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

[ti-chi-bot]

[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 hfxsd 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:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[gemini-code-assist]

Summary of Changes

Hello @alastori, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly updates the sync-diff-inspector documentation to improve its accuracy and utility. Based on comprehensive empirical validation, the changes clarify which data types are supported and offer detailed guidance on how to avoid common false-positive validation failures, particularly those arising from collation differences and auto-populated timestamp columns. The aim is to provide users with more precise information and practical solutions for robust data comparison between MySQL and TiDB.

Highlights

• Clarified Data Type Support: Explicitly documented support for JSON, BLOB/VARBINARY, and BIT types, correcting previous misleading statements in the documentation.
• Improved Collation Guidance: Enhanced the documentation with specific examples of collation mismatches (e.g., MySQL 8.0 utf8mb4_0900_ai_ci vs TiDB utf8mb4_bin) and actionable recommendations to prevent false-positive validation failures.
• Documented False-Positive Patterns: Added a list of common scenarios that lead to false differences, such as collation mismatches in VARCHAR/TEXT/JSON columns and auto-populated TIMESTAMP columns.
• TIMESTAMP Handling Guidance: Provided concrete approaches for handling auto-populated timestamp columns during data validation to ensure accuracy.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request significantly improves the sync-diff-inspector documentation by clarifying data type support and providing detailed guidance on handling collations to prevent false positives. The changes are accurate, well-researched, and add a lot of value for users. I've provided a couple of minor suggestions to enhance readability and ensure consistency with the documentation style guide. Overall, this is an excellent contribution.

[alastori]

PTAL @Frank945946 @joechenrh

[ti-chi-bot]

@Frank945946: adding LGTM is restricted to approvers and reviewers in OWNERS files.

Details

In response to this:

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 kubernetes-sigs/prow repository.

[ti-chi-bot]

@joechenrh: adding LGTM is restricted to approvers and reviewers in OWNERS files.

Details

In response to this:

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 kubernetes-sigs/prow repository.