best practices: add index best practices #21218
Conversation
ti-chi-bot
bot
added
contribution
hfxsd
added
translation/doing
ti-chi-bot
bot
added
the
size/XL
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @hfxsd, 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 new documentation focused on best practices for index management and optimization within the TiDB database. The aim is to provide users with a detailed guide on how to leverage TiDB's features to improve query performance, reduce storage overhead, and streamline database operations through effective index auditing and maintenance.
Highlights
- New Documentation Added: A comprehensive new document,
best-practices/index-best-practices.md, has been added. This document outlines best practices for managing and optimizing indexes in TiDB, covering topics such as identifying unused/inefficient indexes and safely testing index removal. - Table of Contents Update: The main Table of Contents (
TOC.md) has been updated to include a link to the newly added 'Index Best Practices' document under the 'Best Practices' section. - Index Optimization Tools Explained: The new best practices guide details the use of TiDB's built-in observability tools, including
TIDB_INDEX_USAGE,CLUSTER_TIDB_INDEX_USAGE, andschema_unused_indexes, along with the concept of invisible indexes, to help users effectively manage and optimize their database indexes.
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. ↩
hfxsd
added
needs-cherry-pick-release-8.1
There was a problem hiding this comment.
Code Review
The code changes add a new best practices document for index management in TiDB. The document provides guidance on identifying and optimizing indexes, leveraging TiDB's observability tools, and safely testing index removal. The review focuses on ensuring clarity, adherence to the style guide, and providing suggestions for improved readability.
|
|
||
| By leveraging `TIDB_INDEX_USAGE`, you can gain detailed insights into index performance, making it easier to remove unnecessary indexes and optimize query execution. | ||
|
|
||
| ####Handle index usage data efficiently |
There was a problem hiding this comment.
Consider changing the heading to sentence case, as per the style guide (line 32).
Style Guide References
| ####Handle index usage data efficiently | |
| #### Handle index usage data efficiently |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: 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 |
ti-chi-bot
bot
added
the
size/XL
|
/bot-review |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
✅ AI review completed, 1 comments generated. |
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
…into index-best-practices
|
@hfxsd: The following test failed, say
Full PR test history. Your PR dashboard. 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. I understand the commands that are listed here. |
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.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?