docs icon indicating copy to clipboard operation
docs copied to clipboard

planner: add tidb_enable_binding_usage

Open hawkingrei opened this issue 2 months ago • 4 comments

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.

  • [x] master (the latest development version)
  • [x] v9.0 (TiDB 9.0 versions)
  • [x] 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

hawkingrei avatar Oct 21 '25 03:10 hawkingrei

Summary of Changes

Hello @hawkingrei, I'm Gemini Code Assist[^1]! 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 :thumbsup: and :thumbsdown: 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.

[^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[bot] avatar Oct 21 '25 03:10 gemini-code-assist[bot]

[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 ask for approval from qiancai. 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

ti-chi-bot[bot] avatar Nov 03 '25 02:11 ti-chi-bot[bot]

/cc @Oreoxmt

Oreoxmt avatar Nov 03 '25 07:11 Oreoxmt

[LGTM Timeline notifier]

Timeline:

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

ti-chi-bot[bot] avatar Nov 03 '25 07:11 ti-chi-bot[bot]