Add docs about the cluster_id row in mysql.tidb table (#20280)#22566
Add docs about the cluster_id row in mysql.tidb table (#20280)#22566ti-chi-bot wants to merge 1 commit intopingcap:release-8.5from
cluster_id row in mysql.tidb table (#20280)#22566Conversation
Signed-off-by: Yang Keao <yangkeao@chunibyo.icu>
ti-chi-bot
added
lgtm
size/XS
|
[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, 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 enhances the TiDB documentation by providing a clear description for the 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. Changelog
Activity
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
|
![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 documentation for the cluster_id in the mysql.tidb table. My review focuses on improving the conciseness of the new description, in line with the documentation style guide's principle of avoiding unnecessary words and repetition. I've suggested a small change to make the text more streamlined.
| * `tidb_server_version`: the version information of TiDB when it is initialized. Note that this value is read-only and cannot be modified. | ||
| * `system_tz`: the system time zone of TiDB. | ||
| * `new_collation_enabled`: whether TiDB has enabled the [new framework for collations](/character-set-and-collation.md#new-framework-for-collations). Note that this value is read-only and cannot be modified. | ||
| * `cluster_id`: the unique identifier of the TiDB cluster. Note that this value is read-only and cannot be modified. |
There was a problem hiding this comment.
To improve conciseness, this description can be rephrased. The phrase 'Note that' is generally considered filler, and 'read-only and cannot be modified' is redundant. This change aligns with the repository style guide's principle to avoid unnecessary words and repetition.
| * `cluster_id`: the unique identifier of the TiDB cluster. Note that this value is read-only and cannot be modified. | |
| * `cluster_id`: the unique identifier of the TiDB cluster, which is read-only. |
References
- The style guide advises to avoid unnecessary words and repetition. (link)
There was a problem hiding this comment.
Code Review
This pull request adds documentation for the cluster_id row in the mysql.tidb table. My review focuses on improving the clarity and conciseness of the new documentation in line with the repository's style guide. I've suggested a small wording change to make the description more direct and readable.
| * `tidb_server_version`: the version information of TiDB when it is initialized. Note that this value is read-only and cannot be modified. | ||
| * `system_tz`: the system time zone of TiDB. | ||
| * `new_collation_enabled`: whether TiDB has enabled the [new framework for collations](/character-set-and-collation.md#new-framework-for-collations). Note that this value is read-only and cannot be modified. | ||
| * `cluster_id`: the unique identifier of the TiDB cluster. Note that this value is read-only and cannot be modified. |
There was a problem hiding this comment.
For better readability and conciseness, I suggest rephrasing this to be a single descriptive phrase. This also removes the use of 'Note that', which is often considered filler.
This approach could also be applied to other items in this list that have a similar structure to improve overall consistency.
| * `cluster_id`: the unique identifier of the TiDB cluster. Note that this value is read-only and cannot be modified. | |
| * `cluster_id`: the unique identifier of the TiDB cluster, which is read-only and cannot be modified. |
References
- The repository style guide (line 24) advises against unnecessary words. This suggestion makes the description more concise by removing filler words like 'Note that'. (link)
2 participants
This is an automated cherry-pick of #20280
First-time contributors' checklist
What is changed, added or deleted? (Required)
Add a description about the
cluster_idrow in themysql.tidbtable.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)?
cluster_idrow inmysql.tidbdocs-cn#19831cluster_idto themysql.tidbtable tidb#59511Do your changes match any of the following descriptions?