Skip to content

planner: add tidb_enable_binding_usage#21946

Merged
ti-chi-bot[bot] merged 7 commits into
pingcap:masterfrom
hawkingrei:bindinfo_usage
May 11, 2026
Merged

planner: add tidb_enable_binding_usage#21946
ti-chi-bot[bot] merged 7 commits into
pingcap:masterfrom
hawkingrei:bindinfo_usage

Conversation

@hawkingrei
Copy link
Copy Markdown
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 <wangweizhen@pingcap.com>
@gemini-code-assist
Copy link
Copy Markdown
Contributor

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 introduces the documentation for a new system variable, tidb_enable_binding_usage, which allows users to manage the collection of usage statistics for SQL plan bindings within the TiDB system. This addition provides clarity on how binding usage information is recorded and controlled, enhancing the system's observability and configurability regarding query optimization.

Highlights

  • New System Variable Documentation: Documentation for a new system variable, tidb_enable_binding_usage, has been added to the system-variables.md file.
  • Purpose of tidb_enable_binding_usage: This new variable controls whether the usage statistics collection for SQL plan bindings is enabled. When active, bindinfo usage is written to TiKV every six hours.
  • Variable Properties: The tidb_enable_binding_usage variable is a Boolean type, has a GLOBAL scope, persists to the cluster, and defaults to ON. It is introduced in v9.0.0.
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 *: add tidb_enable_binding_usage planner: add tidb_enable_binding_usage Oct 21, 2025
@ti-chi-bot ti-chi-bot Bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Oct 21, 2025
Copy link
Copy Markdown
Contributor

@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 documentation for the new system variable tidb_enable_binding_usage. The documentation is clear and follows the established format. I have one minor suggestion to rephrase the description for better clarity and to align with the style guide's preference for active voice and present tense.

Comment thread system-variables.md Outdated
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@qiancai qiancai added v9.0-beta.3 This PR/issue applies to TiDB v9.0-beta.3. 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
@qiancai qiancai self-assigned this Oct 21, 2025
Comment thread system-variables.md Outdated
@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Nov 3, 2025
Comment thread system-variables.md
Comment thread system-variables.md Outdated
@qiancai qiancai mentioned this pull request Nov 3, 2025
14 tasks
@qiancai qiancai added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed translation/doing This PR's assignee is translating this PR. labels Nov 3, 2025
@Oreoxmt
Copy link
Copy Markdown
Collaborator

Oreoxmt commented Nov 3, 2025

/cc @Oreoxmt

@ti-chi-bot ti-chi-bot Bot requested a review from Oreoxmt November 3, 2025 07:31
@ti-chi-bot ti-chi-bot Bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Nov 3, 2025
@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot Bot commented Nov 3, 2025

[LGTM Timeline notifier]

Timeline:

  • 2025-11-03 02:54:28.587770985 +0000 UTC m=+65918.030800865: ☑️ agreed by qiancai.
  • 2025-11-03 07:33:29.003006326 +0000 UTC m=+82658.446036195: ☑️ agreed by Oreoxmt.

Comment thread system-variables.md Outdated
Comment thread system-variables.md Outdated
@qiancai qiancai removed the needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. label Dec 30, 2025
@qiancai
Copy link
Copy Markdown
Collaborator

qiancai commented Dec 30, 2025

Removed the needs-cherry-pick-release-8.5 label as the code change of this PR is not planned for v8.5.x

@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot Bot commented May 11, 2026

@qw4990: adding LGTM is restricted to approvers and reviewers in OWNERS files.

Details

In response to this:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@qiancai
Copy link
Copy Markdown
Collaborator

qiancai commented May 11, 2026

/approve

@ti-chi-bot ti-chi-bot Bot added the approved label May 11, 2026
@qiancai qiancai closed this May 11, 2026
@qiancai qiancai reopened this May 11, 2026
@qiancai
Copy link
Copy Markdown
Collaborator

qiancai commented May 11, 2026

/approve

@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot Bot commented May 11, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiancai

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:

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

@ti-chi-bot ti-chi-bot Bot merged commit d580659 into pingcap:master May 11, 2026
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved lgtm size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a 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.

4 participants