文档首页/ 数据仓库服务 GaussDB(DWS)/ SQL语法参考/ SQL语法参考(8.1.3.x)/ DML语法/ EXPLAIN
更新时间：2024-11-27 GMT+08:00
查看PDF
分享

EXPLAIN

功能描述

显示SQL语句的执行计划。

执行计划将显示SQL语句所引用的表采用的扫描方式，如：简单的顺序扫描、索引扫描等。如果引用了多个表，执行计划还会显示使用的JOIN算法。

执行计划的最关键部分是语句的预计执行开销，即计划生成器估算执行该语句将花费多长的时间。

若指定了ANALYZE选项，则该语句会被执行，然后根据实际的运行结果显示统计数据，包括每个计划节点内时间总开销（毫秒为单位）和实际返回的总行数。这对于判断计划生成器是否接近现实非常有用。

注意事项

在指定ANALYZE选项时，语句会被执行。如果用户使用EXPLAIN分析INSERT，UPDATE，DELETE，CREATE TABLE AS或EXECUTE语句，但不改动数据（执行这些语句会影响数据），可使用以下所示的方法：

1
2
3
 
START TRANSACTION;
EXPLAIN ANALYZE ...;
ROLLBACK;

语法格式

  • 显示SQL语句的执行计划，支持多种选项，对选项顺序无要求： 
    1
    		 
    EXPLAIN [ (  option  [, ...] )  ] statement;

    其中选项option子句的语法为：

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
    		 
    ANALYZE [ boolean ] |
    ANALYSE [ boolean ] |
    VERBOSE [ boolean ] |
    COSTS [ boolean ] |
    CPU [ boolean ] |
    DETAIL [ boolean ] |
    NODES [ boolean ] |
    NUM_NODES [ boolean ] |
    BUFFERS [ boolean ] |
    TIMING [ boolean ] |
    PLAN [ boolean ] |
    FORMAT { TEXT | XML | JSON | YAML }
  • 显示SQL语句的执行计划，且要按顺序给出选项： 
    1
    		 
    EXPLAIN  { [  { ANALYZE  | ANALYSE  }  ] [ VERBOSE  ]  | PERFORMANCE  } statement;
  • 显示复现SQL语句的执行计划所需的信息，通常用于定位问题。STATS选项必须单独使用： 
    1
    		 
    EXPLAIN ( STATS [ boolean ] ) statement;

参数说明

  • statement

    指定要分析的SQL语句。

  • ANALYZE boolean | ANALYSE boolean

    显示实际运行时间和其他统计数据。

    取值范围：

    • TRUE（缺省值）：显示实际运行时间和其他统计数据。
    • FALSE：不显示。
  • VERBOSE boolean

    显示有关计划的额外信息。

    取值范围：

    • TRUE（缺省值）：显示额外信息。
    • FALSE：不显示。
  • COSTS boolean

    包括每个规划节点的估计总成本，以及估计的行数和每行的宽度。

    取值范围：

    • TRUE（缺省值）：显示估计总成本和宽度。
    • FALSE：不显示。
  • CPU boolean

    打印CPU的使用情况的信息。

    取值范围：

    • TRUE（缺省值）：显示CPU的使用情况。
    • FALSE：不显示。
  • DETAIL boolean

    打印DN上的信息。

    取值范围：

    • TRUE（缺省值）：打印DN的信息。
    • FALSE：不打印。
  • NODES boolean

    打印query执行的节点信息。

    取值范围：

    • TRUE（缺省值）：打印执行的节点的信息。
    • FALSE：不打印。
  • NUM_NODES boolean

    打印执行中的节点的个数信息。

    取值范围：

    • TRUE（缺省值）：打印DN个数的信息。
    • FALSE：不打印。
  • BUFFERS boolean

    包括缓冲区的使用情况的信息。

    取值范围：

    • TRUE：显示缓冲区的使用情况。
    • FALSE（缺省值）：不显示。
  • TIMING boolean

    包括实际的启动时间和花费在输出节点上的时间信息。

    取值范围：

    • TRUE（缺省值）：显示启动时间和花费在输出节点上的时间信息。
    • FALSE：不显示。
  • PLAN

    是否将执行计划存储在plan_table中。当该选项开启时，会将执行计划存储在PLAN_TABLE中，不打印到当前屏幕，因此该选项为on时，不能与其他选项同时使用。

    取值范围：

    • ON（缺省值）：将执行计划存储在plan_table中，不打印到当前屏幕。执行成功返回EXPLAIN SUCCESS。
    • OFF：不存储执行计划，将执行计划打印到当前屏幕。
  • FORMAT

    指定输出格式。

    取值范围：TEXT，XML，JSON和YAML。

    默认值：TEXT

  • PERFORMANCE

    使用此选项时，即打印执行中的所有相关信息。

  • STATS boolean

    打印复现SQL语句的执行计划所需的信息，包括对象定义、统计信息、配置参数等，通常用于定位问题。

    取值范围：

    • TRUE（缺省值）：显示复现SQL语句的执行计划所需的信息。
    • FALSE：不显示。

示例

创建一个表customer_address_p1：

1
 
CREATE TABLE customer_address_p1 AS TABLE customer_address;

修改explain_perf_mode为normal：

1
 
SET explain_perf_mode=normal;

显示表简单查询的执行计划：

1
 
EXPLAIN SELECT * FROM customer_address_p1;

以JSON格式输出的执行计划（explain_perf_mode为normal时）：

1
 
EXPLAIN(FORMAT JSON) SELECT * FROM customer_address_p1;

如果有一个索引，当使用一个带索引WHERE条件的查询，可能会显示一个不同的计划：

1
 
EXPLAIN SELECT * FROM customer_address_p1 WHERE ca_address_sk=10000;

以YAML格式输出的执行计划（explain_perf_mode为normal时）：

1
 
EXPLAIN(FORMAT YAML) SELECT * FROM customer_address_p1 WHERE ca_address_sk=10000;

禁止开销估计的执行计划：

1
 
EXPLAIN(COSTS FALSE)SELECT * FROM customer_address_p1 WHERE ca_address_sk=10000;

带有聚集函数查询的执行计划：

1
 
EXPLAIN SELECT SUM(ca_address_sk) FROM customer_address_p1 WHERE ca_address_sk<10000;

删除表customer_address_p1：

1
 
DROP TABLE customer_address_p1;

相关链接

ANALYZE | ANALYSE

父主题： DML语法