docs: clarify HYPO_INDEX scope in index advisor#23304
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ 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 |
|
@qw4990: adding LGTM is restricted to approvers and reviewers in OWNERS files. DetailsIn 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. |
|
[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. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
[LGTM Timeline notifier]Timeline:
|
06a937d to
8babfe9
Compare
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?