Skip to content

charset: update deal with invalid utf8 characters #21422

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

Oreoxmt
Copy link
Collaborator

@Oreoxmt Oreoxmt commented Jul 18, 2025

What is changed, added or deleted? (Required)

pingcap/tidb#61972 changed the behaviour of deal with invalid utf8 characters, we should update related docs.

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).

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

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

@Oreoxmt Oreoxmt requested a review from Defined2014 July 18, 2025 03:57
@Oreoxmt Oreoxmt self-assigned this Jul 18, 2025
@Oreoxmt Oreoxmt added translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. for-release This PR relates to a TiDB release but does not have a tracked feature. v9.0-beta.2 This PR/issue applies to TiDB v9.0-beta.2. labels Jul 18, 2025
Copy link

ti-chi-bot bot commented Jul 18, 2025

[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 ask for approval from oreoxmt. 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.

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 size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jul 18, 2025
Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Summary of Changes

Hello @Oreoxmt, I'm Gemini Code Assist1! 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 focuses on enhancing the TiDB documentation by providing clear and detailed information on how the database system processes and compares strings that contain invalid UTF-8 characters. This update is crucial for users to understand the expected behavior when dealing with character encoding issues, especially in the context of different collation settings, and aligns the documentation with recent core product changes.

Highlights

  • Documentation Update: This pull request updates the character-set-and-collation.md documentation to reflect recent changes in how TiDB handles invalid UTF-8 characters during string comparisons.
  • Invalid UTF-8 Character Handling: The documentation now clarifies TiDB's behavior when encountering invalid UTF-8 bytes within SQL comparison statements, such as SELECT * FROM tWHEREid > 'a" + string([]byte{0xff}) + "a';.
  • Collation-Specific Behavior: The updated content details how the handling of invalid UTF-8 characters varies based on the collation used:
  • Non-binary collations (e.g., utf8mb4_general_ci): Strings are truncated at the invalid byte.
  • gbk_bin and gb18030_bin: Invalid bytes are replaced with ?.
  • Other binary collations (e.g., utf8_bin): Invalid bytes are treated as ordinary bytes and compared based on their binary values.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

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 issue 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 is currently in preview and 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 to provide feedback.

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.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the documentation to explain how TiDB handles invalid UTF-8 characters during comparisons, which is a helpful clarification. I've suggested a couple of minor improvements to enhance clarity and adhere to the documentation style guide. Specifically, I've recommended using a standard SQL syntax for the code example to avoid confusion and a small formatting fix for consistency. My review was guided by the principles of clarity, technical accuracy, and consistent formatting as outlined in the provided style guide.

Copy link
Collaborator

@qiancai qiancai left a comment

Choose a reason for hiding this comment

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

Rest LGTM

Copy link

ti-chi-bot bot commented Jul 18, 2025

[LGTM Timeline notifier]

Timeline:

  • 2025-07-18 08:22:36.762396483 +0000 UTC m=+2852009.485575465: ☑️ agreed by qiancai.

@ti-chi-bot ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Jul 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
for-release This PR relates to a TiDB release but does not have a tracked feature. needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. v9.0-beta.2 This PR/issue applies to TiDB v9.0-beta.2.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants