Skip to content

Add docs about the cluster_id row in mysql.tidb table (#20280) #22566

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.

Sign up for GitHub

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
ti-chi-bot wants to merge 1 commit into
base: release-8.5
Choose a base branch
from
Open

Add docs about the cluster_id row in mysql.tidb table (#20280) #22566

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions mysql-schema/mysql-schema.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ These system tables contain grant information about user accounts and their priv
* `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.
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Mar 16, 2026

Choose a reason for hiding this comment

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

low

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.

Suggested change
* `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
  1. The style guide advises to avoid unnecessary words and repetition. (link)

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Mar 16, 2026

Choose a reason for hiding this comment

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

low

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.

Suggested change
* `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
  1. 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)


## Server-side help system tables

Expand Down
Loading