Skip to content

docs: clarify HYPO_INDEX scope in index advisor#23304

Open
doc-claw-bot wants to merge 1 commit into
pingcap:release-8.5from
doc-claw-bot:docs/clarify-hypo-index-hint
Open

docs: clarify HYPO_INDEX scope in index advisor#23304
doc-claw-bot wants to merge 1 commit into
pingcap:release-8.5from
doc-claw-bot:docs/clarify-hypo-index-hint

Conversation

@doc-claw-bot

@doc-claw-bot doc-claw-bot commented Jul 17, 2026

Copy link
Copy Markdown
Collaborator

What is changed, added or deleted? (Required)

Users who see HYPO_INDEX written in the /*+ ... */ syntax might assume that a hypothetical index is a conventional optimizer hint. They might then look for HYPO_INDEX in the Optimizer Hints reference and be unsure why it is not listed there. The existing Index Advisor description does not clearly distinguish the hypothetical index being evaluated from the HYPO_INDEX hint used to define it.

This PR updates index-advisor.md for TiDB Cloud to:

  • distinguish a hypothetical index from the special-purpose HYPO_INDEX hint that defines it
  • clarify that HYPO_INDEX takes effect only in EXPLAIN statements and does not create a physical index
  • introduce the example as an EXPLAIN use case, consistent with the SQL shown

These changes help users understand how HYPO_INDEX relates to optimizer hints and when to use it to evaluate an index design before creating a real index.

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)
  • v8.5 (TiDB 8.5 versions)
  • v8.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 versions)
  • v8.2 (TiDB 8.2 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)
  • v5.3 (TiDB 5.3 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 Bot added contribution This PR is from a community contributor. missing-translation-status This PR does not have translation status info. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jul 17, 2026
@coderabbitai

coderabbitai Bot commented Jul 17, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 5225d914-4d99-4963-8eae-b62ef52660bd

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@doc-claw-bot doc-claw-bot added type/bugfix This PR fixes a bug. area/tidb-cloud This PR relates to the area of TiDB Cloud. translation/no-need No need to translate this PR. and removed missing-translation-status This PR does not have translation status info. labels Jul 17, 2026
@qiancai qiancai self-assigned this Jul 17, 2026
@ti-chi-bot

ti-chi-bot Bot commented Jul 17, 2026

Copy link
Copy Markdown

@qw4990: adding LGTM is restricted to approvers and reviewers in OWNERS files.

Details

In response to this:

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.

@qiancai qiancai added the needs-cherry-pick-master Should cherry pick this PR to master branch. label Jul 17, 2026
@ti-chi-bot

ti-chi-bot Bot commented Jul 17, 2026

Copy link
Copy Markdown

[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.

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 size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jul 17, 2026
@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Jul 17, 2026
@ti-chi-bot

ti-chi-bot Bot commented Jul 17, 2026

Copy link
Copy Markdown

[LGTM Timeline notifier]

Timeline:

  • 2026-07-17 10:18:15.081539439 +0000 UTC m=+968081.117634485: ☑️ agreed by dveeden.

Comment thread index-advisor.md
@doc-claw-bot
doc-claw-bot force-pushed the docs/clarify-hypo-index-hint branch from 06a937d to 8babfe9 Compare July 17, 2026 13:15
@ti-chi-bot ti-chi-bot Bot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jul 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/tidb-cloud This PR relates to the area of TiDB Cloud. contribution This PR is from a community contributor. needs-1-more-lgtm Indicates a PR needs 1 more LGTM. needs-cherry-pick-master Should cherry pick this PR to master branch. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. translation/no-need No need to translate this PR. type/bugfix This PR fixes a bug.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants