Update explain and execution summary related docs #19229

yibin87 · 2024-12-09T03:55:48Z

First-time contributors' checklist

I've signed Contributor License Agreement that's required for repo owners to accept my contribution.

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 (in Chinese).

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

This PR is translated from:
Other reference link(s):

Do your changes match any of the following descriptions?

Delete files
Change aliases
Need modification after applied to another branch
Might cause conflicts after applied to another branch

Signed-off-by: yibin <[email protected]>

explain-overview.md

Co-authored-by: xufei <[email protected]>

windtalker

lgtm

ti-chi-bot · 2024-12-10T04:55:39Z

@windtalker: adding LGTM is restricted to approvers and reviewers in OWNERS files.

In response to this:

lgtm

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.

explain-overview.md

sql-statements/sql-statement-explain-analyze.md

sql-statements/sql-statement-explain.md

Co-authored-by: xixirangrang <[email protected]>

ti-chi-bot · 2024-12-11T05:46:08Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from hfxsd, ensuring that each of them provides their approval before proceeding. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

explain-overview.md

qiancai

Rest LGTM

qiancai · 2024-12-12T09:34:34Z

explain-overview.md

+- root task 是指在 TiDB 中执行的计算任务；
+- cop task 是指使用 TiKV 或 TiFlash 中的 Coprocessor 执行的计算任务；
+- batchCop task 是对 TiFlash cop task 的一种优化，可以在一个任务中执行对多个 Region 的查询；
+- mpp task 是指利用 TiFlash 的 [MPP 模式](/explain-mpp.md)执行查询。


Suggested change

- root task 是指在 TiDB 中执行的计算任务；

- cop task 是指使用 TiKV 或 TiFlash 中的 Coprocessor 执行的计算任务；

- batchCop task 是对 TiFlash cop task 的一种优化，可以在一个任务中执行对多个 Region 的查询；

- mpp task 是指利用 TiFlash 的 [MPP 模式](/explain-mpp.md)执行查询。

- root task 是指在 TiDB 中执行的计算任务。

- cop task 是指使用 TiKV 或 TiFlash 中的 Coprocessor 执行的计算任务。

- batchCop task 是对 TiFlash cop task 的一种优化，可以在一个任务中执行对多个 Region 的查询。

- MPP task 是指利用 TiFlash 的 [MPP 模式](/explain-mpp.md)执行查询。

qiancai · 2024-12-12T09:35:47Z

explain-overview.md

+- batchCop task 是对 TiFlash cop task 的一种优化，可以在一个任务中执行对多个 Region 的查询；
+- mpp task 是指利用 TiFlash 的 [MPP 模式](/explain-mpp.md)执行查询。
+
+SQL 优化的目标之一是将计算尽可能地下推到 TiKV 或 TiFlash 中执行。TiKV 中的 Coprocessor 能支持大部分 SQL 内建函数（包括聚合函数和标量函数）、SQL `LIMIT` 操作、索引扫描和表扫描。TiFlash 中的 Coprocessor 与 TiKV 功能类似，但是不支持索引扫描。


Suggested change

SQL 优化的目标之一是将计算尽可能地下推到 TiKV 或 TiFlash 中执行。TiKV 中的 Coprocessor 能支持大部分 SQL 内建函数（包括聚合函数和标量函数）、SQL `LIMIT` 操作、索引扫描和表扫描。TiFlash 中的 Coprocessor 与 TiKV 功能类似，但是不支持索引扫描。

SQL 优化的目标之一是将计算尽可能地下推到 TiKV 或 TiFlash 中执行，以提高查询效率。TiKV 中的 Coprocessor 支持大部分 SQL 内建函数（包括聚合函数和标量函数）、`LIMIT` 操作、索引扫描和表扫描。TiFlash 中的 Coprocessor 与 TiKV 功能类似，但不支持索引扫描。

qiancai · 2024-12-12T09:40:18Z

sql-statements/sql-statement-explain-analyze.md

-| memory  | 算子占用内存空间的大小。 |
-| disk  | 算子占用磁盘空间的大小。 |
+| `actRows`       | 算子实际输出的数据条数。 |
+| `execution info`  | 算子的实际执行信息。`time` 表示从进入算子到离开算子的全部 `wall time`，包括所有子算子操作的全部执行时间。如果该算子被父算子多次调用 (`loops`)，这个时间就是累积的时间。`loops` 是当前算子被父算子调用的次数。`open` 表示算子初始化所需的时间。`close` 表示从算子处理完所有数据到算子结束的时间。其中 `time` 统计的时间是包含 `open` 和 `close` 的时间。当算子存在多并发执行情况时，执行信息中显示的会是各个并发使用的 `wall time` 加总求和的结果，此时 `time`、`open` 和 `close` 会被替换为 `total_time`, `total_open` 和 `total_close`。|


Suggested change

| `execution info` | 算子的实际执行信息。`time` 表示从进入算子到离开算子的全部 `wall time`，包括所有子算子操作的全部执行时间。如果该算子被父算子多次调用 (`loops`)，这个时间就是累积的时间。`loops` 是当前算子被父算子调用的次数。`open` 表示算子初始化所需的时间。`close` 表示从算子处理完所有数据到算子结束的时间。其中 `time` 统计的时间是包含 `open` 和 `close` 的时间。当算子存在多并发执行情况时，执行信息中显示的会是各个并发使用的 `wall time` 加总求和的结果，此时 `time`、`open` 和 `close` 会被替换为 `total_time`, `total_open` 和 `total_close`。|

| `execution info` | 算子的实际执行信息。`time` 表示从进入算子到离开算子的全部 `wall time`，包括所有子算子操作的全部执行时间。如果该算子被父算子多次调用 (`loops`)，这个时间就是累积的时间。`loops` 是当前算子被父算子调用的次数。`open` 表示算子初始化所需的时间。`close` 表示从算子处理完所有数据到算子结束执行的时间。其中 `time` 统计的时间包含 `open` 和 `close` 的时间。当算子存在多并发执行情况时，`execution info` 中显示的是各个并发使用的 `wall time` 求和后的结果，此时 `time`、`open` 和 `close` 会被替换为 `total_time`, `total_open` 和 `total_close`。|

qiancai · 2024-12-12T09:41:37Z

sql-statements/sql-statement-explain-analyze.md

@@ -99,7 +99,7 @@ EXPLAIN ANALYZE SELECT * FROM t1;

 ## 算子执行信息介绍

-`execution info` 信息除了基本的 `time` 和 `loop` 信息外，还包含算子特有的执行信息，主要包含了该算子发送 RPC 请求的耗时信息以及其他步骤的耗时。
+`execution info` 信息除了基本的 `time`, `open`, `close` 和 `loop` 信息外，还包含算子特有的执行信息，主要包含了该算子发送 RPC 请求的耗时信息以及其他步骤的耗时。


Suggested change

`execution info` 信息除了基本的 `time`, `open`, `close` 和 `loop` 信息外，还包含算子特有的执行信息，主要包含了该算子发送 RPC 请求的耗时信息以及其他步骤的耗时。

`execution info` 信息除了基本的 `time`、`open`、`close` 和 `loop` 信息外，还包含算子特有的执行信息，主要包含了该算子发送 RPC 请求的耗时信息以及其他步骤的耗时。

qiancai · 2024-12-12T09:43:13Z

sql-statements/sql-statement-explain-analyze.md

@@ -339,6 +339,18 @@ after key/value request is processed:

 对于 writes 和 batch gets，计算方法相似，只是基础成本不同。

+### tiflash_wait 信息
+
+当查询涉及到 mpp task 时候时，执行时间还受到各类 `tiflash_wait` 时间的影响，示例如下：


Suggested change

当查询涉及到 mpp task 时候时，执行时间还受到各类 `tiflash_wait` 时间的影响，示例如下：

当查询涉及到 MPP task 时，执行时间将受到各类 `tiflash_wait` 时间的影响，示例如下：

qiancai · 2024-12-12T09:56:37Z

sql-statements/sql-statement-explain.md

@@ -52,7 +52,7 @@ ExplainableStmt ::=
 |:----------------|:----------------------------------------------------------------------------------------------------------|
 | id            | 算子的 ID，是算子在整个执行计划中唯一的标识。在 TiDB 2.1 中，ID 会格式化地显示算子的树状结构。数据从孩子结点流向父亲结点，每个算子的父亲结点有且仅有一个。|
 | estRows       | 算子预计将会输出的数据条数，基于统计信息以及算子的执行逻辑估算而来。在 4.0 之前叫 count。 |
-| task          | 算子属于的 task 种类。目前的执行计划分成为两种 task，一种叫 **root** task，在 tidb-server 上执行，一种叫 **cop** task，在 TiKV 或者 TiFlash 上并行执行。当前的执行计划在 task 级别的拓扑关系是一个 root task 后面可以跟许多 cop task，root task 使用 cop task 的输出结果作为输入。cop task 中执行的也即是 TiDB 下推到 TiKV 或者 TiFlash 上的任务，每个 cop task 分散在 TiKV 或者 TiFlash 集群中，由多个进程共同执行。 |
+| task          | 算子属于的 task 种类。目前的执行计划可以分为以下四种 task：**root** task，在 tidb-server 上执行；**cop** task，在 TiKV 或者 TiFlash 上并行执行；**batchCop** task，在 TiFlash 上并行执行；**mpp** task，在 TiFlash 上并行执行。当前的执行计划在 task 级别的拓扑关系是一个 root task 后面可以跟许多其他种类的 task，root task 使用其他种类 task 的输出结果作为输入。其他种类 task 中执行的也即是 TiDB 下推到 TiKV 或者 TiFlash 上的任务，每个 task 分散在 TiKV 或者 TiFlash 集群中，由多个进程共同执行。 |


Suggested change

| task | 算子属于的 task 种类。目前的执行计划可以分为以下四种 task：**root** task，在 tidb-server 上执行；**cop** task，在 TiKV 或者 TiFlash 上并行执行；**batchCop** task，在 TiFlash 上并行执行；**mpp** task，在 TiFlash 上并行执行。当前的执行计划在 task 级别的拓扑关系是一个 root task 后面可以跟许多其他种类的 task，root task 使用其他种类 task 的输出结果作为输入。其他种类 task 中执行的也即是 TiDB 下推到 TiKV 或者 TiFlash 上的任务，每个 task 分散在 TiKV 或者 TiFlash 集群中，由多个进程共同执行。 |

| task | 算子属于的 task 类型。目前的执行计划可以分为以下四种 task：**root** task，在 tidb-server 上执行；**cop** task，在 TiKV 或者 TiFlash 上并行执行；**batchCop** task，在 TiFlash 上并行执行；**mpp** task，在 TiFlash 上并行执行。当前的执行计划在 task 级别的拓扑关系是一个 root task 后面可以跟许多其他类型的 task，root task 使用其他类型 task 的输出结果作为输入。其他类型 task 中执行的也即是 TiDB 下推到 TiKV 或者 TiFlash 上的任务，每个 task 分散在 TiKV 或者 TiFlash 集群中，由多个进程共同执行。 |

ti-chi-bot · 2024-12-12T10:01:07Z

[LGTM Timeline notifier]

Timeline:

2024-12-12 10:01:07.410369548 +0000 UTC m=+519057.499172091: ☑️ agreed by qiancai.

qiancai · 2024-12-12T10:03:48Z

explain-overview.md

@@ -174,9 +174,14 @@ Build 总是先于 Probe 执行，并且 Build 总是出现在 Probe 前面。

 ### Task 简介

-目前 TiDB 的计算任务分为两种不同的 task：cop task 和 root task。Cop task 是指使用 TiKV 中的 Coprocessor 执行的计算任务，root task 是指在 TiDB 中执行的计算任务。
+目前 TiDB 的计算任务分为四种不同的 task：root task, cop task, batchCop task 和 mpp task。


Suggested change

目前 TiDB 的计算任务分为四种不同的 task：root task, cop task, batchCop task 和 mpp task。

目前 TiDB 的计算任务分为四种不同的 task：root task, cop task, batchCop task 和 MPP task。

Update explain and execution summary related docs

aec77c5

Signed-off-by: yibin <[email protected]>

ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Dec 9, 2024

update explain analyze doc

be1791d

Signed-off-by: yibin <[email protected]>

ti-chi-bot bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Dec 9, 2024

yibin87 added 5 commits December 9, 2024 15:05

update several execution info

76774c2

Signed-off-by: yibin <[email protected]>

Little update

5a09b4a

Signed-off-by: yibin <[email protected]>

fix little issue

70b2d8a

Signed-off-by: yibin <[email protected]>

Fix link

55f3c4a

Signed-off-by: yibin <[email protected]>

Fix link

da3208e

Signed-off-by: yibin <[email protected]>

yibin87 requested review from windtalker and songrijie December 10, 2024 02:41

windtalker reviewed Dec 10, 2024

View reviewed changes

explain-overview.md Outdated Show resolved Hide resolved

Update explain-overview.md

718f949

Co-authored-by: xufei <[email protected]>

yibin87 requested a review from windtalker December 10, 2024 04:29

windtalker approved these changes Dec 10, 2024

View reviewed changes

yibin87 requested a review from hfxsd December 10, 2024 06:46

hfxsd self-assigned this Dec 11, 2024

hfxsd added translation/doing This PR’s assignee is translating this PR. and removed missing-translation-status This PR does not have translation status info. labels Dec 11, 2024

hfxsd reviewed Dec 11, 2024

View reviewed changes

Apply suggestions from code review

441376b

Co-authored-by: xixirangrang <[email protected]>

ti-chi-bot bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Dec 11, 2024

yibin87 requested a review from hfxsd December 11, 2024 05:46

yibin87 commented Dec 11, 2024

View reviewed changes

explain-overview.md Outdated Show resolved Hide resolved

explain-overview.md Outdated Show resolved Hide resolved

Update explain-overview.md

5c6e08c

Update explain-overview.md

22d7857

yibin87 mentioned this pull request Dec 11, 2024

Update explain and execution summary related docs pingcap/docs#19651

Open

17 tasks

hfxsd requested a review from qiancai December 12, 2024 02:21

hfxsd 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 Dec 12, 2024

qiancai approved these changes Dec 12, 2024

View reviewed changes

ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Dec 12, 2024

qiancai reviewed Dec 12, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update explain and execution summary related docs #19229

Update explain and execution summary related docs #19229

yibin87 commented Dec 9, 2024 •

edited

Loading

windtalker left a comment

ti-chi-bot bot commented Dec 10, 2024

ti-chi-bot bot commented Dec 11, 2024

qiancai left a comment

qiancai Dec 12, 2024 •

edited

Loading

qiancai Dec 12, 2024

qiancai Dec 12, 2024

qiancai Dec 12, 2024

qiancai Dec 12, 2024

qiancai Dec 12, 2024 •

edited

Loading

ti-chi-bot bot commented Dec 12, 2024

qiancai Dec 12, 2024

	SQL 优化的目标之一是将计算尽可能地下推到 TiKV 或 TiFlash 中执行。TiKV 中的 Coprocessor 能支持大部分 SQL 内建函数（包括聚合函数和标量函数）、SQL `LIMIT` 操作、索引扫描和表扫描。TiFlash 中的 Coprocessor 与 TiKV 功能类似，但是不支持索引扫描。
	SQL 优化的目标之一是将计算尽可能地下推到 TiKV 或 TiFlash 中执行，以提高查询效率。TiKV 中的 Coprocessor 支持大部分 SQL 内建函数（包括聚合函数和标量函数）、`LIMIT` 操作、索引扫描和表扫描。TiFlash 中的 Coprocessor 与 TiKV 功能类似，但不支持索引扫描。

	`execution info` 信息除了基本的 `time`, `open`, `close` 和 `loop` 信息外，还包含算子特有的执行信息，主要包含了该算子发送 RPC 请求的耗时信息以及其他步骤的耗时。
	`execution info` 信息除了基本的 `time`、`open`、`close` 和 `loop` 信息外，还包含算子特有的执行信息，主要包含了该算子发送 RPC 请求的耗时信息以及其他步骤的耗时。

	当查询涉及到 mpp task 时候时，执行时间还受到各类 `tiflash_wait` 时间的影响，示例如下：
	当查询涉及到 MPP task 时，执行时间将受到各类 `tiflash_wait` 时间的影响，示例如下：

	目前 TiDB 的计算任务分为四种不同的 task：root task, cop task, batchCop task 和 mpp task。
	目前 TiDB 的计算任务分为四种不同的 task：root task, cop task, batchCop task 和 MPP task。

Update explain and execution summary related docs #19229

Are you sure you want to change the base?

Update explain and execution summary related docs #19229

Conversation

yibin87 commented Dec 9, 2024 • edited Loading

First-time contributors' checklist

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)?

Do your changes match any of the following descriptions?

windtalker left a comment

Choose a reason for hiding this comment

ti-chi-bot bot commented Dec 10, 2024

ti-chi-bot bot commented Dec 11, 2024

qiancai left a comment

Choose a reason for hiding this comment

qiancai Dec 12, 2024 • edited Loading

Choose a reason for hiding this comment

qiancai Dec 12, 2024

Choose a reason for hiding this comment

qiancai Dec 12, 2024

Choose a reason for hiding this comment

qiancai Dec 12, 2024

Choose a reason for hiding this comment

qiancai Dec 12, 2024

Choose a reason for hiding this comment

qiancai Dec 12, 2024 • edited Loading

Choose a reason for hiding this comment

ti-chi-bot bot commented Dec 12, 2024

[LGTM Timeline notifier]

qiancai Dec 12, 2024

Choose a reason for hiding this comment

yibin87 commented Dec 9, 2024 •

edited

Loading

qiancai Dec 12, 2024 •

edited

Loading

qiancai Dec 12, 2024 •

edited

Loading