Add tidb index usage limitation for valid stats (#20833) #20911
Conversation
Signed-off-by: Yang Keao <[email protected]>
ti-chi-bot
added
lgtm
needs-1-more-lgtm
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
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 documentation, 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.CLUSTER_TIDB_INDEX_USAGEdocumentation 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 information provided 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.
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
-
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. ↩
There was a problem hiding this comment.
Code Review
The pull request adds a limitation to the tidb usage limitation, aligning the description with the "index-advisor.md". The added limitation states that index usage is only recorded if the table has valid statistics. Overall, the change is straightforward and improves the documentation by providing a more complete description of the TIDB_INDEX_USAGE table.
Merge Readiness
The pull request is well-scoped and the changes are clear. There are no identified issues that would block merging. I am unable to approve this pull request, and recommend that others review and approve this code before merging.
|
/approve |
|
[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 |
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":
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.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?