Skip to content

Add tidb index usage limitation for valid stats (#20833) #20912

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

ti-chi-bot
Copy link
Member

This is an automated cherry-pick of #20833

First-time contributors' checklist

What is changed, added or deleted? (Required)

Add a limitation to the tidb usage limitation. The description is aligned with the "index-advisor.md":

The data in INFORMATION_SCHEMA.CLUSTER_TIDB_INDEX_USAGE might be delayed by up to five minutes, and the usage data is reset whenever a TiDB node restarts. Additionally, index usage is only recorded if the table has valid statistics.

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.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 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)?

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

@ti-chi-bot ti-chi-bot added lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR. labels May 6, 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.

Hello @ti-chi-bot, 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!

Summary of Changes

This pull request adds a limitation to the tidb index usage, clarifying that index usage is only recorded if the table has valid statistics. This change aligns the documentation with the behavior described in index-advisor.md. The changes affect the information-schema-tidb-index-usage.md file and are being applied to multiple versions of TiDB (master, v9.0, v8.5, and v8.1).

Highlights

  • Documentation Update: Adds a note to the information-schema-tidb-index-usage.md file stating that index usage is only recorded if the table has valid statistics.
  • Consistency: Ensures the documentation aligns with the actual behavior of TiDB and the description in index-advisor.md.

Changelog

  • information-schema/information-schema-tidb-index-usage.md
    • Added a statement clarifying that index usage is only recorded for tables with valid statistics (line 104).
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

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 issue 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 is currently in preview and 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 to provide feedback.

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.

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

The pull request adds a limitation to the tidb usage limitation, aligning the description with the "index-advisor.md". The change seems straightforward and necessary for clarity.

Merge Readiness

The pull request appears to be well-written and addresses a clear need for documentation accuracy. There are no critical or high severity issues. I am unable to approve the pull request, and recommend that the author seek additional review and approval before merging.

@qiancai
Copy link
Collaborator

qiancai commented May 8, 2025

/approve

Copy link

ti-chi-bot bot commented May 8, 2025

[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

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 added the approved label May 8, 2025
@ti-chi-bot ti-chi-bot bot merged commit cbc978e into pingcap:release-8.5 May 8, 2025
8 of 9 checks passed
breezewish added a commit that referenced this pull request May 8, 2025
…fts-1

* commit 'c3ec7513da16bfb6c84af93213c0006040dbd867':
  ticdc: add [[filter.event-filters]] to the toml example (#20921) (#20925)
  Add tidb index usage limitation for valid stats (#20833) (#20912)
  tidb-cloud: update LOAD DATA INFILE description (#20917) (#20918)
  Update pad attribute where needed (#20823) (#20910)
  Add restriction for IMPORT INTO regarding empty (#20562) (#20908)
  tikv: recorrect the settings of some configs and supplement missing annotations for several configs. (#20871) (#20899)
  planner: add doc for `tidb_ignore_inlist_plan_digest`. (#20870) (#20890)
  JDBC URL: update the letter case for defaultFetchSize (#20884) (#20887)
  fix(pd): add missing configuration items for PD (#20883) (#20894)
  hardware-and-software-requirements: update Kylin Euler to Kylin (#20874) (#20881)
  add FAQs about collation for JDBC connections (#20848) (#20869)
  pd configuration: add dashboard.disable-custom-prom-addr (#20853) (#20857)
  releases: add one br entry to v8.1.2 (#20861) (#20864)
  toc: add TiDB release support policy (#19119) (#20859)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants