Skip to content

Conversation

@hawkingrei
Copy link
Member

@hawkingrei hawkingrei commented Oct 21, 2025

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.

  • 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:
  • 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

Signed-off-by: Weizhen Wang <[email protected]>
@ti-chi-bot
Copy link

ti-chi-bot bot commented Oct 21, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign jackysp for approval. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

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

Needs approval from an approver in each of these files:

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

@gemini-code-assist
Copy link

Summary of Changes

Hello @hawkingrei, 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 SQL Plan Management documentation by introducing a dedicated section on 'Binding Usage'. This addition aims to provide users with comprehensive information on how to track and manage the usage of SQL bindings, thereby facilitating better optimization and maintenance of query performance through the identification and handling of unused bindings.

Highlights

  • New Documentation Section: A new section titled 'Binding Usage' has been added to the sql-plan-management.md document.
  • Binding Usage Explanation: The new section explains how 'Binding Usage' helps collect statistics for SQL bindings, aiding in the identification and management of unused bindings to optimize query performance.
  • System Variable: The tidb_enable_binding_usage system variable is introduced, which controls the collection of usage statistics for SQL plan bindings.
  • Usage Query Example: An example SQL query is provided to demonstrate how to retrieve binding usage statistics, specifically the sql_digest and last_used_date from the mysql.bind_info table.
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.

@ti-chi-bot ti-chi-bot bot added the missing-translation-status This PR does not have translation status info. label Oct 21, 2025
@hawkingrei hawkingrei changed the title spm: add binding usage SPM: add binding usage Oct 21, 2025
@ti-chi-bot ti-chi-bot bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Oct 21, 2025
Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request adds a new section on 'Binding Usage' to the SQL Plan Management documentation. The changes are good, but I've suggested a few improvements for clarity, conciseness, and consistency with the documentation style guide. Specifically, I've recommended using sentence case for the heading, rephrasing the descriptive paragraphs to be more direct and use active voice, and formatting the SQL example to use uppercase keywords for consistency.

Comment on lines +483 to +485
Binding Usage helps you collect usage statistics of SQL bindings, which can assist you in identifying and managing unused bindings. You can use these statistics to optimize your binding management strategy, such as removing bindings that are no longer needed or adjusting existing bindings to improve query performance.

You can use the `tidb_enable_binding_usage` system variable to control whether to enable the usage statistics collection for SQL plan bindings. When this variable is set to `ON`, every six hours, the usage of bindinfo will be written into TiKV.

Choose a reason for hiding this comment

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

low

This suggestion improves clarity and conciseness. It also uses active voice as recommended by the style guide1 and clarifies that the usage information is written to the mysql.bind_info table.

Suggested change
Binding Usage helps you collect usage statistics of SQL bindings, which can assist you in identifying and managing unused bindings. You can use these statistics to optimize your binding management strategy, such as removing bindings that are no longer needed or adjusting existing bindings to improve query performance.
You can use the `tidb_enable_binding_usage` system variable to control whether to enable the usage statistics collection for SQL plan bindings. When this variable is set to `ON`, every six hours, the usage of bindinfo will be written into TiKV.
The binding usage feature helps you collect usage statistics for SQL bindings. You can use these statistics to identify and manage unused bindings, for example, by removing bindings that are no longer needed or adjusting existing ones to improve query performance.
You can use the `tidb_enable_binding_usage` system variable to control the collection of usage statistics for SQL plan bindings. When this variable is set to `ON`, TiDB writes the binding usage information to the `mysql.bind_info` table every six hours.

Style Guide References

Footnotes

  1. The style guide recommends avoiding overuse of passive voice.

You can use the `tidb_enable_binding_usage` system variable to control whether to enable the usage statistics collection for SQL plan bindings. When this variable is set to `ON`, every six hours, the usage of bindinfo will be written into TiKV.

```sql
select sql_digest,last_used_date from mysql.bind_info limit 1;

Choose a reason for hiding this comment

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

low

For consistency with other examples in this document, SQL keywords should be in uppercase. Also, this removes an extra space after from.

Suggested change
select sql_digest,last_used_date from mysql.bind_info limit 1;
SELECT sql_digest, last_used_date FROM mysql.bind_info LIMIT 1;

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@qiancai qiancai self-assigned this Oct 21, 2025
@qiancai qiancai added the v9.0-beta.3 This PR/issue applies to TiDB v9.0-beta.3. label Oct 21, 2025
@qiancai qiancai added translation/doing This PR's assignee is translating this PR. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. and removed missing-translation-status This PR does not have translation status info. labels Oct 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. translation/doing This PR's assignee is translating this PR. v9.0-beta.3 This PR/issue applies to TiDB v9.0-beta.3.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants