tidb-functions: clarify TIDB_ENCODE_INDEX_KEY parameters (#22325)

[ti-chi-bot]

This is an automated cherry-pick of #22325

First-time contributors' checklist

• I've signed the Contributor License Agreement, which is required for the repository owners to accept my contribution.

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.

• master (the latest development version)
• v9.0 (TiDB 9.0 versions)
• v8.5 (TiDB 8.5 versions)
• v8.1 (TiDB 8.1 versions)
• v7.5 (TiDB 7.5 versions)
• v7.1 (TiDB 7.1 versions)
• v6.5 (TiDB 6.5 versions)
• v6.1 (TiDB 6.1 versions)
• v5.4 (TiDB 5.4 versions)

What is the related PR or file link(s)?

• This PR is translated from:tidb-functions: clarify TIDB_ENCODE_INDEX_KEY parameters docs-cn#21278
• Other reference link(s):

Do your changes match any of the following descriptions?

• Delete files
• Change aliases
• Need modification after applied to another branch
• Might cause conflicts after applied to another branch

[gemini-code-assist]

Summary of Changes

Hello @ti-chi-bot, I'm Gemini Code Assist¹! 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 significantly enhances the documentation for the TIDB_ENCODE_INDEX_KEY and TIDB_ENCODE_RECORD_KEY functions. The updates provide clearer explanations of their syntax, detailed parameter descriptions, and practical examples covering various primary key configurations, aiming to improve user understanding and correct usage of these functions.

Highlights

• TIDB_ENCODE_INDEX_KEY Documentation Enhancement: Comprehensive details have been added for the TIDB_ENCODE_INDEX_KEY function, including its full syntax, detailed descriptions for each parameter (db_name, table_name, index_name, index_columns, handle_columns), and specific examples illustrating its usage with different primary key types (no primary key, NONCLUSTERED, CLUSTERED integer, CLUSTERED composite/common handle).
• TIDB_ENCODE_RECORD_KEY Documentation Enhancement: Expanded documentation has been provided for the TIDB_ENCODE_RECORD_KEY function, detailing its syntax, parameter descriptions, and clarifying the handle_columns based on primary key types by referencing the TIDB_ENCODE_INDEX_KEY section.
• Example Value Correction: The example INSERT and SELECT statements for both TIDB_ENCODE_INDEX_KEY and TIDB_ENCODE_RECORD_KEY have been updated to use 2 instead of 1 for an index column value, ensuring consistency and clarity in the provided examples.

🧠 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 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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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 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

1. 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. ↩

[gemini-code-assist]

Code Review

This pull request significantly improves the documentation for the TIDB_ENCODE_INDEX_KEY and TIDB_ENCODE_RECORD_KEY functions by adding detailed explanations of their parameters and usage. The changes are clear and will be very helpful for users. I've included a couple of minor suggestions to improve stylistic consistency with the rest of the document.

[hfxsd]

/approve

[ti-chi-bot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hfxsd

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [hfxsd]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment