EXPLAIN
Returns a formatted description of the Vertica optimizer's plan for executing the specified statement.
Syntax
EXPLAIN [/*+ ALLNODES */] [explain-options] sql-statement
Parameters
/*+
ALLNODES
*/
- Specifies to create a query plan that assumes all nodes are active, not valid with
LOCAL
option. explain-options
- One or more
EXPLAIN
options, specified in the order shown:[ LOCAL ] [ VERBOSE ] [ JSON ] [ ANNOTATED ]
-
LOCAL
: On a multi-node database, shows the local query plans assigned to each node, which together comprise the total (global) query plan. If you omit this option, Vertica shows only the global query plan. Local query plans are shown only in DOT language source, which can be rendered in Graphviz.This option is incompatible with the hint
/*+ALL NODES*/
. If you specify both,EXPLAIN
returns with an error. -
VERBOSE
: Increases the level of detail in the rendered query plan. -
JSON
: Renders the query plan in JSON format. This option is compatible only withVERBOSE
. -
ANNOTATED
: Embeds optimizer hints that encapsulate the query plan for this query. Vertica uses these hints to create directed queries. For more information, see Directed queries. This option is compatible withLOCAL
andVERBOSE
.
-
sql-statement
- A query or DML statement—for example,
SELECT
,INSERT
,UPDATE
,COPY
, andMERGE
.
Privileges
The same privileges required by the specified statement.
Requirements
The following requirements apply to EXPLAIN
's ability to produce useful information:
-
Reasonably representative statistics of your data must be available. See Collecting Statistics for details.
-
EXPLAIN
produces useful output only if projections are available for the queried tables. -
Qualifier options must be specified in the order shown earlier, otherwise
EXPLAIN
returns with an error. If an option is incompatible with any preceding options,EXPLAIN
ignores them.
Examples
See Viewing query plans.