planner: support JSON format explain #12102

fzzf678 · 2022-11-24T02:04:55Z

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):
*: support JSON format output in explain statement tidb#39253

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

ti-chi-bot · 2022-11-24T02:04:56Z

[REVIEW NOTIFICATION]

This pull request has been approved by:

qiancai
ran-huang

To complete the pull request process, please ask the reviewers in the list to review by filling /cc @reviewer in the comment.
After your PR has acquired the required number of LGTMs, you can assign this pull request to the committer in the list by filling /assign @committer in the comment to help you merge this pull request.

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

Reviewer can indicate their review by submitting an approval review.
Reviewer can cancel approval by submitting a request changes review.

sql-statements/sql-statement-explain.md

ran-huang · 2022-11-30T07:25:34Z

sql-statements/sql-statement-explain.md

@@ -185,12 +185,13 @@ EXPLAIN DELETE FROM t1 WHERE c1=3;

 在 `EXPLAIN` 中使用 `FORMAT = "xxx"` 语法可以指定输出的内容和格式。


建议把这里的几种格式示例写成 tab 形式， @fzzf678 你觉得呢？可以的话我先这样改

Co-authored-by: Ran <huangran.alex@gmail.com>

fzzf678 · 2022-11-30T12:42:14Z

@ran-huang some line changed, PTAL again.

ran-huang

rest LGTM

ran-huang · 2022-11-30T13:48:08Z

sql-statements/sql-statement-explain.md


 ## MySQL 兼容性

 * `EXPLAIN` 的格式和 TiDB 中潜在的执行计划都与 MySQL 有很大不同。
-* TiDB 不支持 `FORMAT=TREE` 选项。
+* TiDB 不支持 `FORMAT=JSON` 或 `FORMAT=TREE` 选项。


这里要说明一下吗，如果需要输出为 JSON 请使用 tidb_json

tidb_json 和Mysql的 JSON 输出字段还不一样，FORMAT=JSON 打算后面给兼容MySQL时候用

Signed-off-by: Ran <huangran.alex@gmail.com>

sql-statements/sql-statement-explain.md

Co-authored-by: Grace Cai <qqzczy@126.com>

qiancai

LGTM

ran-huang · 2022-12-02T06:42:54Z

/merge

ti-chi-bot · 2022-12-02T06:42:57Z

This pull request has been accepted and is ready to merge.

Commit hash: 73c7eb6

sql-statements/sql-statement-explain.md

Co-authored-by: Grace Cai <qqzczy@126.com>

qiancai

LGTM

ran-huang · 2022-12-06T06:40:25Z

/merge

ti-chi-bot · 2022-12-06T06:40:28Z

This pull request has been accepted and is ready to merge.

Commit hash: 9edd526

Update sql-statement-explain.md

0d34557

ti-chi-bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 24, 2022

ti-chi-bot requested a review from TomShawn November 24, 2022 02:05

ti-chi-bot added missing-translation-status This PR does not have translation status info. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Nov 24, 2022

fzzf678 added 2 commits November 24, 2022 10:21

Update sql-statement-explain.md

72cc7c7

Update sql-statement-explain.md

61876f9

ran-huang requested review from ran-huang and removed request for TomShawn November 25, 2022 06:30

ran-huang added area/planner Indicates that the Issue or PR belongs to the area of SQL planner or optimizer. v6.5 This PR/issue applies to TiDB v6.5. labels Nov 25, 2022

qiancai added the translation/doing This PR’s assignee is translating this PR. label Nov 25, 2022

ti-chi-bot removed the missing-translation-status This PR does not have translation status info. label Nov 25, 2022

qiancai assigned ran-huang Nov 25, 2022

update

f701f7f

ti-chi-bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Nov 25, 2022

fzzf678 marked this pull request as ready for review November 29, 2022 02:31

ti-chi-bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 29, 2022

fzzf678 added 2 commits November 29, 2022 18:04

Update sql-statement-explain.md

2e28ace

Update sql-statement-explain.md

bc82788

ran-huang reviewed Nov 30, 2022

View reviewed changes

fzzf678 and others added 4 commits November 30, 2022 20:14

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

d6cc063

Co-authored-by: Ran <huangran.alex@gmail.com>

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

5e1f942

Co-authored-by: Ran <huangran.alex@gmail.com>

Update sql-statement-explain.md

a939ced

Update sql-statement-explain.md

7f42906

ran-huang reviewed Nov 30, 2022

View reviewed changes

use simple tab

ed07516

Signed-off-by: Ran <huangran.alex@gmail.com>

qiancai reviewed Dec 1, 2022

View reviewed changes

fzzf678 and others added 4 commits December 1, 2022 16:04

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

c430bd9

Co-authored-by: Grace Cai <qqzczy@126.com>

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

125f87e

Co-authored-by: Grace Cai <qqzczy@126.com>

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

59448b1

Co-authored-by: Grace Cai <qqzczy@126.com>

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

73c7eb6

Co-authored-by: Grace Cai <qqzczy@126.com>

ran-huang approved these changes Dec 1, 2022

View reviewed changes

ti-chi-bot added the status/LGT1 Indicates that a PR has LGTM 1. label Dec 1, 2022

chrysan approved these changes Dec 1, 2022

View reviewed changes

ran-huang requested a review from qiancai December 2, 2022 03:09

qiancai approved these changes Dec 2, 2022

View reviewed changes

ti-chi-bot added status/LGT2 Indicates that a PR has LGTM 2. and removed status/LGT1 Indicates that a PR has LGTM 1. labels Dec 2, 2022

ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Dec 2, 2022

Update sql-statement-explain.md

eaab424

ti-chi-bot removed the status/can-merge Indicates a PR has been approved by a committer. label Dec 5, 2022

ran-huang removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Dec 5, 2022

ran-huang requested a review from qiancai December 5, 2022 10:01

qiancai reviewed Dec 5, 2022

View reviewed changes

sql-statements/sql-statement-explain.md Outdated Show resolved Hide resolved

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

9edd526

Co-authored-by: Grace Cai <qqzczy@126.com>

ran-huang requested a review from qiancai December 6, 2022 04:52

qiancai approved these changes Dec 6, 2022

View reviewed changes

ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Dec 6, 2022

ti-chi-bot merged commit 6593a9c into pingcap:master Dec 6, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

planner: support JSON format explain #12102

planner: support JSON format explain #12102

fzzf678 commented Nov 24, 2022

ti-chi-bot commented Nov 24, 2022 •

edited

ran-huang Nov 30, 2022

ran-huang Nov 30, 2022

fzzf678 commented Nov 30, 2022

ran-huang left a comment

ran-huang Nov 30, 2022

fzzf678 Dec 1, 2022

qiancai left a comment

ran-huang commented Dec 2, 2022

ti-chi-bot commented Dec 2, 2022

qiancai left a comment

ran-huang commented Dec 6, 2022

ti-chi-bot commented Dec 6, 2022

		@@ -185,12 +185,13 @@ EXPLAIN DELETE FROM t1 WHERE c1=3;

		在 `EXPLAIN` 中使用 `FORMAT = "xxx"` 语法可以指定输出的内容和格式。

planner: support JSON format explain #12102

planner: support JSON format explain #12102

Conversation

fzzf678 commented Nov 24, 2022

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?

ti-chi-bot commented Nov 24, 2022 • edited

ran-huang Nov 30, 2022

Choose a reason for hiding this comment

ran-huang Nov 30, 2022

Choose a reason for hiding this comment

fzzf678 commented Nov 30, 2022

ran-huang left a comment

Choose a reason for hiding this comment

ran-huang Nov 30, 2022

Choose a reason for hiding this comment

fzzf678 Dec 1, 2022

Choose a reason for hiding this comment

qiancai left a comment

Choose a reason for hiding this comment

ran-huang commented Dec 2, 2022

ti-chi-bot commented Dec 2, 2022

qiancai left a comment

Choose a reason for hiding this comment

ran-huang commented Dec 6, 2022

ti-chi-bot commented Dec 6, 2022

ti-chi-bot commented Nov 24, 2022 •

edited