Conversation
Signed-off-by: Jianjun Liao <[email protected]>
|
[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 |
Summary of ChangesHello @Leavrth, 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 updates the documentation for TiDB's Backup & Restore (BR) feature. It provides crucial information regarding a new parameter designed to enhance the handling of system table data with differing case-sensitivity and collation settings during the restoration process, particularly for scenarios involving older cluster versions. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe 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
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 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
|
ti-chi-bot
bot
added
missing-translation-status
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds a note about the new --sys-check-collation parameter in BR. My review focuses on improving the clarity, grammar, and style of the new documentation content to align with the repository's style guide. I've suggested a revision to make the text easier to understand and more consistent with the documentation's writing principles, such as using active voice, present tense, and proper formatting for parameters.
| > | ||
| > Known issue: Starting from version v7.2.0, some system table fields in newly created clusters are case-insensitive. However, for clusters that are **upgraded online** from versions earlier than v7.2.0 to v7.2.0 or later, the corresponding system table fields remain case-sensitive. Backup and restore operations involving system tables between these two types of clusters might fail. For more details, see [Issue #43717](https://github.com/pingcap/tidb/issues/43717). | ||
| > | ||
| > Starting from version 8.5.5, if the system table data of the source cluster version does not have case-sensitivity conflicts (for example, simultaneous records of test.t1 and test.T1), you can specify the BR parameter --sys-check-collation during restoration. BR will then check the compatibility of the data across different collations. If compatible, backups from older versions can be successfully restored; otherwise, BR will return an error. |
There was a problem hiding this comment.
To improve clarity and align with the documentation style guide, I suggest a few changes:
- Use backticks for the parameter name
--sys-check-collation. - Use present tense and active voice for better readability (for example, "BR then checks" and "you can successfully restore").
- Use "restore" instead of "restoration" for consistency.
- Clarify the example for case-sensitivity conflicts.
- Use
v8.5.5for versioning consistency.
| > Starting from version 8.5.5, if the system table data of the source cluster version does not have case-sensitivity conflicts (for example, simultaneous records of test.t1 and test.T1), you can specify the BR parameter --sys-check-collation during restoration. BR will then check the compatibility of the data across different collations. If compatible, backups from older versions can be successfully restored; otherwise, BR will return an error. | |
| > Starting from v8.5.5, if the system table data in the source cluster has no case-sensitivity conflicts (for example, no simultaneous records of `test.t1` and `test.T1`), you can specify the `--sys-check-collation` parameter during restore. BR then checks the data compatibility across different collations. If the data is compatible, you can successfully restore backups from older versions. Otherwise, BR returns an error. |
References
- The documentation style guide prefers using the second person ('you'), present tense, and active voice. It also requires command names and options to be enclosed in backticks for proper formatting. (link)
1 participant
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.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?