docs: clarify HYPO_INDEX scope in index advisor (#23304)#23308
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe hypothetical indexes documentation was revised to explain the ChangesHypothetical index documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
|
/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 DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
This is an automated cherry-pick of #23304
What is changed, added or deleted? (Required)
Users who see
HYPO_INDEXwritten in the/*+ ... */syntax might assume that a hypothetical index is a conventional optimizer hint. They might then look forHYPO_INDEXin 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 theHYPO_INDEXhint used to define it.This PR updates
index-advisor.mdfor TiDB Cloud to:HYPO_INDEXhint that defines itHYPO_INDEXtakes effect only inEXPLAINstatements and does not create a physical indexEXPLAINuse case, consistent with the SQL shownThese changes help users understand how
HYPO_INDEXrelates 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.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?
Summary by CodeRabbit
/*+ HYPO_INDEX(...) */syntax inEXPLAINstatements.