Skip to content

best practices: add index best practices (#21218)#21824

Merged
ti-chi-bot[bot] merged 1 commit intopingcap:release-8.5from
ti-chi-bot:cherry-pick-21218-to-release-8.5
Sep 23, 2025
Merged

best practices: add index best practices (#21218)#21824
ti-chi-bot[bot] merged 1 commit intopingcap:release-8.5from
ti-chi-bot:cherry-pick-21218-to-release-8.5

Conversation

@ti-chi-bot
Copy link
Copy Markdown
Member

This is an automated cherry-pick of #21218

What is changed, added or deleted? (Required)

This PR converts this blog post TiDB Index Optimization: Detect and Remove Unused Indexes for Better Performance into a best practice page in documentation.

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 area/best-practices Adds or updates TiDB best practices. lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/XL Denotes a PR that changes 500-999 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 Sep 23, 2025
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

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!

This pull request integrates a detailed guide on index management best practices into the TiDB documentation. It provides users with essential knowledge and tools to effectively identify, evaluate, and optimize database indexes, ultimately leading to improved query performance, reduced storage costs, and streamlined database operations. The guide emphasizes a data-driven approach using TiDB's built-in observability features.

Highlights

  • New Documentation Page: A new best practices page has been added, focusing on index management and optimization in TiDB.
  • Index Optimization Tools: The document introduces and explains the use of INFORMATION_SCHEMA.TIDB_INDEX_USAGE, sys.schema_unused_indexes, and invisible indexes for tracking, identifying, and safely testing index removal.
  • Comprehensive Best Practices: Five key best practices for index optimization are outlined, covering monitoring, validation, consolidation, DML impact, and regular testing.
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

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.

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 successfully converts a blog post into a comprehensive best practices document on index management. The new page is well-structured and informative. My review provides several suggestions to improve clarity, grammatical accuracy, and consistency with the documentation style guide, including corrections to heading case, terminology, and phrasing.

@hfxsd
Copy link
Copy Markdown
Collaborator

hfxsd commented Sep 23, 2025

/approve

@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot bot commented Sep 23, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hfxsd

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 added the approved label Sep 23, 2025
@ti-chi-bot ti-chi-bot bot merged commit 3bd884f into pingcap:release-8.5 Sep 23, 2025
8 of 9 checks passed
@ti-chi-bot ti-chi-bot bot deleted the cherry-pick-21218-to-release-8.5 branch September 23, 2025 06:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved area/best-practices Adds or updates TiDB best practices. lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/XL Denotes a PR that changes 500-999 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.

2 participants