tidb-functions: clarify TIDB_ENCODE_INDEX_KEY parameters
#22325
Conversation
ti-chi-bot
bot
added
contribution
Summary of ChangesHello @hfxsd, 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 improving the clarity and completeness of the documentation 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. 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
the
size/M
hfxsd
added
translation/from-docs-cn
ti-chi-bot
bot
added
the
size/M
![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 significantly clarifies the parameters for the TIDB_ENCODE_INDEX_KEY and TIDB_ENCODE_RECORD_KEY functions, which is a great improvement for the documentation. My review includes a few minor suggestions to enhance readability and consistency, such as using consistent list formatting and making descriptions more concise.
| `<db_name>`: the name of the database that contains the target table. | ||
| `<table_name>`: the name of the table that contains the target table. For a partitioned table, you can specify the partition name in `table_name`, for example, `'t(p0)'`. | ||
| `<handle_columns>...`: the handle (row key) value for the corresponding row. The exact composition of the handle depends on the primary key type of the table, such as whether it is CLUSTERED, whether it uses a common handle, or whether it uses the hidden column `_tidb_rowid`. For more information, see the `handle_columns...` section in [`TIDB_ENCODE_INDEX_KEY()`](#tidb_encode_index_key). |
There was a problem hiding this comment.
To improve clarity and maintain consistency with the TIDB_ENCODE_INDEX_KEY section, I suggest the following changes:
- Use a bulleted list for the parameters.
- Capitalize the first letter of each description.
- Make the descriptions more concise by removing redundant phrases.
| `<db_name>`: the name of the database that contains the target table. | |
| `<table_name>`: the name of the table that contains the target table. For a partitioned table, you can specify the partition name in `table_name`, for example, `'t(p0)'`. | |
| `<handle_columns>...`: the handle (row key) value for the corresponding row. The exact composition of the handle depends on the primary key type of the table, such as whether it is CLUSTERED, whether it uses a common handle, or whether it uses the hidden column `_tidb_rowid`. For more information, see the `handle_columns...` section in [`TIDB_ENCODE_INDEX_KEY()`](#tidb_encode_index_key). | |
| * `<db_name>`: The name of the database. | |
| * `<table_name>`: The name of the table. For a partitioned table, you can specify the partition name in `table_name`, for example, `'t(p0)'`. | |
| * `<handle_columns>...`: The handle (row key) value for the corresponding row. The exact composition of the handle depends on the primary key type of the table, such as whether it is CLUSTERED, whether it uses a common handle, or whether it uses the hidden column `_tidb_rowid`. For more information, see the `handle_columns...` section in [`TIDB_ENCODE_INDEX_KEY()`](#tidb_encode_index_key). |
References
- The documentation should be clear, simple, and avoid unnecessary words. Using a consistent list format improves readability. (link)
|
[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 |
| | TIDB_ENCODE_INDEX_KEY('test', 't', 'idx', 1, 1) | | ||
| | TIDB_ENCODE_INDEX_KEY('test', 't', 'idx', 2, 1) | | ||
| +----------------------------------------------------------------------------+ | ||
| | 74800000000000007f5f698000000000000001038000000000000001038000000000000001 | |
There was a problem hiding this comment.
It is better to keep consistent with Chinese documents here.
2 participants
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)?
TIDB_ENCODE_INDEX_KEYparameters docs-cn#21278Do your changes match any of the following descriptions?