Add new Index advisor user doc #19867
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ti-chi-bot
bot
added
missing-translation-status
Oreoxmt
added
translation/doing
ti-chi-bot
bot
removed
the
missing-translation-status
Oreoxmt
added
the
do-not-merge/hold
|
@qw4990 Could you please invite a tech reviewer? Thanks! |
Oreoxmt
added
the
needs-cherry-pick-release-8.5
Oreoxmt
reviewed
Jan 2, 2025
songrijie
reviewed
Jan 7, 2025
songrijie
reviewed
Jan 7, 2025
songrijie
reviewed
Jan 7, 2025
songrijie
reviewed
Jan 7, 2025
index-advisor.md
Outdated
| mysql> CREATE TABLE t(a int, b int, c int); | ||
| mysql> RECOMMEND INDEX RUN for "select a, b from t where a=1 and b=1"; | ||
| +----------+-------+------------+---------------+------------+----------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+---------------------------------+ | ||
| | database | table | index_name | index_columns | index_size | reason | top_impacted_query | create_index_statement | |
There was a problem hiding this comment.
- If "index_size" is not exact value, better to rename it with "est_index_size".
- It's recommended to append meaningful string as suffix of index name, so that we are able to understand it's from index advisor. Name conflict can be avoid as well. For example "idx_..._<trailing 8 chars in plan digest>
There was a problem hiding this comment.
index_size is the maximum number of columns an index can have. May be we can rename to reflect that, say "max_index_columns".
There was a problem hiding this comment.
The first suggestion has been accepted, but for the second one, it's hard to associate the Index with a specific plan and use the plan digest as the index name since there might be multiple queries affected by this Index.
songrijie
reviewed
Jan 7, 2025
songrijie
reviewed
Jan 7, 2025
songrijie
reviewed
Jan 7, 2025
songrijie
reviewed
Jan 7, 2025
songrijie
reviewed
Jan 7, 2025
songrijie
reviewed
Jan 7, 2025
songrijie
reviewed
Jan 7, 2025
songrijie
reviewed
Jan 7, 2025
songrijie
reviewed
Jan 7, 2025
qw4990
commented
Feb 20, 2025
qw4990
commented
Feb 20, 2025
qw4990
commented
Feb 20, 2025
Co-authored-by: Grace Cai <[email protected]>
ti-chi-bot
bot
added
lgtm
and removed
needs-1-more-lgtm
Co-authored-by: Grace Cai <[email protected]>
Co-authored-by: Grace Cai <[email protected]>
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Oreoxmt The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
/unhold |
ti-chi-bot
bot
removed
the
do-not-merge/hold
ti-chi-bot
pushed a commit
to ti-chi-bot/docs
that referenced
this pull request
Feb 20, 2025
|
In response to a cherrypick label: new pull request created to branch |
16 tasks
16 tasks
Oreoxmt
added
translation/done
16 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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?