Skip to content
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

Add missing explain formats #15601

Merged
merged 4 commits into from
Dec 21, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions sql-statements/sql-statement-explain.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,10 +192,12 @@ To specify the format of the `EXPLAIN` output, you can use the `FORMAT = xxx` sy
| FORMAT | Description |
| ------ | ------ |
| Not specified | If the format is not specified, `EXPLAIN` uses the default format `row`. |
| `row` | The `EXPLAIN` statement outputs results in a tabular format. See [Understand the Query Execution Plan](/explain-overview.md) for more information. |
| `brief` | The operator IDs in the output of the `EXPLAIN` statement are simplified, compared with those when `FORMAT` is left unspecified. |
| `dot` | The `EXPLAIN` statement outputs DOT execution plans, which can be used to generate PNG files through a `dot` program (in the `graphviz` package). |
| `tidb_json` | The `EXPLAIN` statement outputs execution plans in JSON and stores the operator information in a JSON array. |
| `brief` | The operator IDs in the output of the `EXPLAIN` statement are simplified, compared with those when `FORMAT` is left unspecified. |
| `dot` | The `EXPLAIN` statement outputs DOT execution plans, which can be used to generate PNG files through a `dot` program (in the `graphviz` package). |
| `row` | The `EXPLAIN` statement outputs results in a tabular format. See [Understand the Query Execution Plan](/explain-overview.md) for more information. |
| `tidb_json` | The `EXPLAIN` statement outputs execution plans in JSON and stores the operator information in a JSON array. |
| `verbose` | The `EXPLAIN` statement outputs in the `row` format, but an `estCost` column is added for the estimated cost of the query. See [SQL Plan Management](/sql-plan-management.md) for how this can be used. |
dveeden marked this conversation as resolved.
Show resolved Hide resolved
| `plan_cache` | The `EXPLAIN` statement outputs in the `row` format, but adds [Plan Cache](/sql-non-prepared-plan-cache.md) information as a warning. |
dveeden marked this conversation as resolved.
Show resolved Hide resolved

<SimpleTab>

Expand Down
Loading