-
Notifications
You must be signed in to change notification settings - Fork 657
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
performance tuning: change SQL tuning TOC #3858
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
@SunRunAway,Thanks for your review. The bot only counts LGTMs from Reviewers and higher roles, but you're still welcome to leave your comments.See the corresponding SIG page for more information. Related SIG: docs(slack). |
@lilin90 PTAL |
@zz-jason, @SunRunAway, @kissmydb, @lilin90, PTAL. |
1 similar comment
@zz-jason, @SunRunAway, @kissmydb, @lilin90, PTAL. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@kissmydb What do you think of the changes? PTAL~ Thanks!
+ Understanding the Query Execution Plan | ||
+ [Overview](/explain-overview.md) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Since we don't have multiple topics about query execution plan now, how about keeping one line?
- Is it a must to change the file name from
query-execution-plan.md
toexplain-overview.md
? Because we'll try to avoid changing file names unless it's really necessary, to make it easy to maintain documentation (Let's avoid using too many aliases and try to keep the URL stable if possible).
+ Understanding the Query Execution Plan | |
+ [Overview](/explain-overview.md) | |
+ [Understanding the Query Execution Plan](/explain-overview.md) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Got it. Just to confirm: by "keep it as is", I think you mean keeping your changes, right? And the newly added content in two other PRs will be put under "Understanding the Query Execution Plan"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That is correct. The TOC I proposed to the SQL team is as follows:
Understanding the Query Execution Plan
Overview
Explain Walkthough
Indexes
Joins
Subqueries
Views
Partitions
/merge |
/run-all-tests |
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
cherry pick to release-4.0 in PR #3988 |
Signed-off-by: ti-srebot <ti-srebot@pingcap.com> Co-authored-by: Null not nil <67764674+nullnotnil@users.noreply.github.com>
What is changed, added or deleted? (Required)
This changes the SQL tuning TOC to follow the same structure as in the overview (which I've improved to make clearer - mentioning that SQL is declarative etc).
I am trying to make this change small, with additional content under
SQL Tuning > Understanding the Query Execution Plan
to follow in separate PRs.Which TiDB version(s) do your changes apply to? (Required)
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?