sql: update `explain` results #2548

LittleFall · 2020-03-24T07:25:54Z

What is changed, added or deleted? (Required)

Update statement of EXPLAIN with tidb-in-action.

Update explain result with current result.

Which TiDB version(s) do your changes apply to? (Required)

master

What is the related PR or file link(s)?

CLAassistant · 2020-03-24T07:25:59Z

All committers have signed the CLA.

TomShawn · 2020-03-24T07:29:26Z

@LittleFall Please sign the CLA and involve a technical review, thanks!

zz-jason

要在这个 PR 中把整个阅读执行计划部分都用《TiDB in Action》中的内容更新一下吗？对了，explain for connection 部分也需要介绍，最好也在《TiDB in Action》中把这部分内容加上。

…ll-patch-2

LittleFall · 2020-03-24T08:50:06Z

要在这个 PR 中把整个阅读执行计划部分都用《TiDB in Action》中的内容更新一下吗？对了，explain for connection 部分也需要介绍，最好也在《TiDB in Action》中把这部分内容加上。

整合了一下，PTAL

zz-jason

The content in reference/performance/understanding-the-query-execution-plan.md is too long. We'd better to split it into several small sections.

Maybe we can organize the content like this:

file 1: EXPLAIN Basics, covered in https://pingcap.com/docs-cn/stable/reference/sql/statements/explain/#explain
file 2: EXPLAIN FOR Connection, covered in https://pingcap.com/docs-cn/stable/reference/sql/statements/explain-analyze/
file 3: EXPLAIN ANALYZE Extension, not covered in https://pingcap.com/docs-cn/stable/reference/sql/statements/explain/, this doc need to be updated.
file 4: How to read the output of `EXPLAIN`, should be covered in this file
file 5: How to read the output of `EXPLAIN ANALYZE`, maybe we can use another file to cover this topic.

…ll-patch-2

LittleFall · 2020-03-30T07:02:39Z

The content in reference/performance/understanding-the-query-execution-plan.md is too long. We'd better to split it into several small sections.

Maybe we can organize the content like this:

file 1: EXPLAIN Basics, covered in https://pingcap.com/docs-cn/stable/reference/sql/statements/explain/#explain
file 2: EXPLAIN FOR Connection, covered in https://pingcap.com/docs-cn/stable/reference/sql/statements/explain-analyze/
file 3: EXPLAIN ANALYZE Extension, not covered in https://pingcap.com/docs-cn/stable/reference/sql/statements/explain/, this doc need to be updated.
file 4: How to read the output of `EXPLAIN`, should be covered in this file
file 5: How to read the output of `EXPLAIN ANALYZE`, maybe we can use another file to cover this topic.

有几个问题

因为 understanding-the-query-execution-plan.md 中把算子信息都介绍过了，file5 中实际没什么可写的了。
还有是不是 EXPLAIN FOR Connection 写在 explain.md 中比写在 explain-analyze.md 中要好一些？

调整了一下这些文件的结构，可能会比较清晰并且最长的文件看起来短一点。

explain.md:

语法图
EXPLAIN 输出格式
示例
MySQL 兼容性
EXPLAIN FOR CONNECTION

explain-analyze.md:

语法图
EXPLAIN ANALYZE 输出格式
示例
MySQL 兼容性

understanding-the-query-execution-plan.md

使用 EXPLAIN 来优化 SQL 语句
如何阅读算子的执行顺序
算子的共有信息
算子的独特信息
优化实例

PTAL

zz-jason · 2020-03-30T07:10:59Z

@LittleFall 可以，这种格式会合理很多。我们需要尽量确保每个独立的文档阅读时间不超过 10 分钟。

reference/performance/understanding-the-query-execution-plan.md

sre-bot · 2020-04-19T10:13:54Z

@zz-jason, @winoros, @lzmhhh123, @ran-huang, PTAL.

ran-huang

Rest LGTM

reference/sql/statements/explain.md

Co-Authored-By: Ran <huangran@pingcap.com>

sre-bot · 2020-04-22T09:10:48Z

@zz-jason, @winoros, @lzmhhh123, @ran-huang, PTAL.

sre-bot · 2020-04-22T09:34:47Z

@LittleFall, please update your pull request.

zz-jason

LGTM

zz-jason · 2020-04-22T12:09:00Z

@LittleFall please resolve the code conflict, thanks.

* Modify explain result. * Update with tidb-in-action. * Reorder statements. * Fix multi \n bug. * Apply suggestions from code review Co-Authored-By: Ran <huangran@pingcap.com> * Refine some typo. * Refine article structure. * Remove useless "`". * Update reference/sql/statements/explain.md Co-Authored-By: Ran <huangran@pingcap.com> Co-authored-by: Ran <huangran@pingcap.com>

sre-bot · 2020-04-22T12:16:08Z

cherry pick to release-4.0 in PR #2865

toutdesuite · 2020-05-15T08:25:14Z

reference/performance/understanding-the-query-execution-plan.md

+> **注意：**
+>
+> 目前 TiDB 的 IndexMerge 特性在 4.0 RC 版本中默认关闭，同时 4.0 中的 IndexMerge 目前支持的场景仅限于析取范式（or 连接的表达式），对合取范式（and 连接的表达式）将在之后的版本中支持。
+> 开启 IndexMerge 特性，可通过在客户端中设置 session 或者 global 变量完成：`set @@tidb_enable_index_merge = 1;`


@LittleFall 这里“目前...中支持”要与“开启 IndexMerge 特性这一句中间空一行，不然两行实际在显示时显示为一行~

学习了，我之后一块改一下

* Modify explain result. * Update with tidb-in-action. * Reorder statements. * Fix multi \n bug. * Apply suggestions from code review Co-Authored-By: Ran <huangran@pingcap.com> * Refine some typo. * Refine article structure. * Remove useless "`". * Update reference/sql/statements/explain.md Co-Authored-By: Ran <huangran@pingcap.com> Co-authored-by: Ran <huangran@pingcap.com>

Modify explain result.

615b296

TomShawn changed the title ~~Update explain result.~~ sql: update explain results Mar 24, 2020

Merge branch 'master' into littlefall-patch-2

cb48324

TomShawn requested review from zz-jason and lzmhhh123 March 24, 2020 07:31

LittleFall added the translation/welcome Waits for a contributor to translate this PR and create a PR to the pingcap/docs-cn repository. label Mar 24, 2020

zz-jason reviewed Mar 24, 2020

View reviewed changes

TomShawn added size/large Changes of a large size. translation/doing This PR’s assignee is translating this PR. and removed translation/welcome Waits for a contributor to translate this PR and create a PR to the pingcap/docs-cn repository. labels Mar 24, 2020

TomShawn assigned toutdesuite Mar 24, 2020

LittleFall added 2 commits March 24, 2020 16:45

Update with tidb-in-action.

f0f05ff

Merge remote-tracking branch 'qizhi/littlefall-patch-2' into littlefa…

84dbd55

…ll-patch-2

Merge branch 'master' into littlefall-patch-2

89be795

zz-jason reviewed Mar 25, 2020

View reviewed changes

LittleFall and others added 6 commits March 26, 2020 15:28

Merge branch 'master' into littlefall-patch-2

c5d0190

Merge remote-tracking branch 'pingcap/master' into littlefall-patch-2

4c2d6bd

Merge branch 'master' into littlefall-patch-2

c407ba6

Merge remote-tracking branch 'qizhi/littlefall-patch-2' into littlefa…

1bc1864

…ll-patch-2

Reorder statements.

e8bd1df

Fix multi \n bug.

34ab0ff

zz-jason requested a review from winoros March 30, 2020 07:11

Merge branch 'master' into littlefall-patch-2

6c8b993

winoros reviewed Apr 3, 2020

View reviewed changes

yikeke added the needs-cherry-pick-4.0 label Apr 4, 2020

LittleFall added 2 commits April 16, 2020 21:02

Merge branch 'master' into littlefall-patch-2

80c3c9f

Merge branch 'master' into littlefall-patch-2

ddef7d1

LittleFall closed this Apr 17, 2020

LittleFall reopened this Apr 17, 2020

Merge branch 'master' into littlefall-patch-2

1f7f670

ran-huang added status/PTAL This PR is ready for reviewing. and removed status/require-change Needs the author to address comments. labels Apr 17, 2020

ran-huang reviewed Apr 20, 2020

View reviewed changes

reference/sql/statements/explain.md Outdated Show resolved Hide resolved

LittleFall and others added 2 commits April 20, 2020 17:33

Merge branch 'master' into littlefall-patch-2

0c99012

Update reference/sql/statements/explain.md

d46cb56

Co-Authored-By: Ran <huangran@pingcap.com>

zz-jason approved these changes Apr 22, 2020

View reviewed changes

zz-jason added status/require-change Needs the author to address comments. and removed status/PTAL This PR is ready for reviewing. labels Apr 22, 2020

Merge branch 'master' into littlefall-patch-2

418158f

LittleFall merged commit 4173557 into pingcap:master Apr 22, 2020

sre-bot mentioned this pull request Apr 22, 2020

sql: update explain results (#2548) #2865

Merged

sre-bot added a commit that referenced this pull request Apr 23, 2020

sql: update explain results (#2548) (#2865)

555d414

toutdesuite mentioned this pull request May 15, 2020

sql: update explain results pingcap/docs#2580

Merged

5 tasks

toutdesuite added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed translation/doing This PR’s assignee is translating this PR. labels May 15, 2020

toutdesuite reviewed May 15, 2020

View reviewed changes

LittleFall deleted the littlefall-patch-2 branch May 15, 2020 08:27

ti-srebot mentioned this pull request Jul 20, 2020

sql: update explain results (#2580) pingcap/docs#3339

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

sql: update `explain` results #2548

sql: update `explain` results #2548

LittleFall commented Mar 24, 2020

CLAassistant commented Mar 24, 2020 •

edited

Loading

TomShawn commented Mar 24, 2020

zz-jason left a comment

LittleFall commented Mar 24, 2020

zz-jason left a comment •

edited

Loading

LittleFall commented Mar 30, 2020

zz-jason commented Mar 30, 2020

sre-bot commented Apr 19, 2020

ran-huang left a comment

sre-bot commented Apr 22, 2020

sre-bot commented Apr 22, 2020

zz-jason left a comment

zz-jason commented Apr 22, 2020

sre-bot commented Apr 22, 2020

toutdesuite May 15, 2020

LittleFall May 15, 2020

sql: update explain results #2548

sql: update explain results #2548

Conversation

LittleFall commented Mar 24, 2020

What is changed, added or deleted? (Required)

Which TiDB version(s) do your changes apply to? (Required)

What is the related PR or file link(s)?

CLAassistant commented Mar 24, 2020 • edited Loading

TomShawn commented Mar 24, 2020

zz-jason left a comment

Choose a reason for hiding this comment

LittleFall commented Mar 24, 2020

zz-jason left a comment • edited Loading

Choose a reason for hiding this comment

LittleFall commented Mar 30, 2020

zz-jason commented Mar 30, 2020

sre-bot commented Apr 19, 2020

ran-huang left a comment

Choose a reason for hiding this comment

sre-bot commented Apr 22, 2020

sre-bot commented Apr 22, 2020

zz-jason left a comment

Choose a reason for hiding this comment

zz-jason commented Apr 22, 2020

sre-bot commented Apr 22, 2020

toutdesuite May 15, 2020

Choose a reason for hiding this comment

LittleFall May 15, 2020

Choose a reason for hiding this comment

sql: update `explain` results #2548

sql: update `explain` results #2548

CLAassistant commented Mar 24, 2020 •

edited

Loading

zz-jason left a comment •

edited

Loading