add FAQs about collation for JDBC connections (#20848) #20867
Conversation
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Aolin <[email protected]>
Co-authored-by: Aolin <[email protected]>
Co-authored-by: Aolin <[email protected]>
ti-chi-bot
added
area/develop
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @ti-chi-bot, 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!
Summary of Changes
This pull request adds FAQs about collation for JDBC connections. It addresses how collation is handled when connectionCollation is not configured in the JDBC URL, how to handle collation changes after upgrading TiDB, and the differences between utf8mb4_bin and utf8mb4_0900_ai_ci collations. The changes include adding notes about collation to the JDBC connection documentation and adding a new section to the SQL FAQ and Upgrade FAQ.
Highlights
- JDBC Collation FAQs: Adds a new section to the SQL FAQ addressing collation in JDBC connections, including scenarios where
connectionCollationis not configured. - Upgrade Considerations: Adds a FAQ to the Upgrade FAQ about potential collation changes in JDBC connections after upgrading to v7.4 or later and how to maintain the
utf8mb4_bincollation. - JDBC Documentation Update: Updates the JDBC connection documentation to include a note about collation behavior starting from TiDB v7.4 when
connectionCollationis not configured.
Changelog
Click here to see the changelog
- develop/dev-guide-sample-application-java-jdbc.md
- Adds a note about collation behavior in JDBC connections starting from TiDB v7.4, advising users to check the collation used when
connectionCollationis not configured. - Adds a note about collation for both tidb and tidb-cloud platforms.
- Adds a note about collation behavior in JDBC connections starting from TiDB v7.4, advising users to check the collation used when
- faq/sql-faq.md
- Adds a new section with FAQs about collation in JDBC connections.
- Explains how collation is determined when
connectionCollationis not configured, covering different Connector/J versions and TiDB versions. - Provides guidance on handling collation changes after upgrading TiDB, including configuring the
connectionCollationparameter in the JDBC URL. - Details the differences between
utf8mb4_binandutf8mb4_0900_ai_cicollations with examples.
- faq/upgrade-faq.md
- Adds a FAQ about potential collation changes in JDBC connections after upgrading to v7.4 or later.
- Advises users to configure
connectionCollation=utf8mb4_binin the JDBC URL to maintain theutf8mb4_bincollation after upgrading.
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
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request adds FAQs about collation for JDBC connections. The changes look good and provide helpful information to users. However, I have a few suggestions to improve clarity and adherence to the style guide.
Summary of Findings
- Sentence case for headings: Headings should use sentence case. This applies to the new headings added in
faq/sql-faq.mdandfaq/upgrade-faq.md.[^1] - Markdown style: Blank lines: Ensure there is a blank line before and after headings and lists in
faq/sql-faq.md.[^2] - Consistent terminology: Ensure consistent terminology is used throughout the documentation. For example, use either 'character set' or 'charset' consistently.
Merge Readiness
The pull request is almost ready for merging. Please address the minor issues related to sentence case for headings and markdown style. Once these are fixed, the pull request will be ready to be merged. I am unable to directly approve this pull request, and users should have others review and approve this code before merging.
|
/approve |
|
/approve |
|
[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
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
This is an automated cherry-pick of #20848
First-time contributors' checklist
What is changed, added or deleted? (Required)
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)?
Do your changes match any of the following descriptions?