cockroachdb / cockroachdb/cockroach

Incorrect help output for EXPLAIN

Open
#144,470 1 comment 0 reactions 0 assignees View on GitHub
A-cli-client A-sql-syntax branch-master branch-release-24.1 branch-release-24.3 branch-release-25.1 branch-release-25.2 C-bug
Dominant language
Go
Stars
32.5k
Forks
4.1k
PR merge metrics
PR metrics pending

Description

**Describe the problem**

```
root@127.0.0.1:26257/movr> \h EXPLAIN
Command: EXPLAIN
Description: show the logical plan of a query
Category: miscellaneous
Syntax:
EXPLAIN
EXPLAIN ([PLAN ,] )
EXPLAIN (DISTSQL)
EXPLAIN ANALYZE [(DISTSQL)]
EXPLAIN ANALYZE (PLAN )

Explainable statements:
SELECT, CREATE, DROP, ALTER, INSERT, UPSERT, UPDATE, DELETE,
SHOW, EXPLAIN

Plan options:
TYPES, VERBOSE, OPT

See also:
https://www.cockroachlabs.com/docs/v25.1/explain.html
```

**To Reproduce**

1. `crdb demo --insecure`
2. `\h EXPLAIN`

The correct output should be something like `EXPLAIN ANALYZE (PLAN, VERBOSE) SELECT` (note the missing comma in the above output).

Jira issue: CRDB-49390

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.