# EXPLAIN
#### 功能描述
显示SQL语句的执行计划。主要包括：
- 显示SQL语句所引用的表的扫描方式，如简单的顺序扫描或索引扫描等。
- 如果SQL语句中引用了多个表，执行计划还会显示多表之间的JOIN方式。
 
#### 注意事项
- 执行计划的最主要指标是SQL语句的预计执行开销，这是计划生成器估算执行该语句所需时间的度量。
- 如果指定了ANALYZE选项，该SQL语句将被执行，并根据实际运行结果显示统计数据。统计数据用于作为判断计划生成器的估计值是否接近实际值的依据，主要包括每个计划节点的时间总开销（以毫秒为单位）和实际返回的总行数。
- 在指定ANALYZE选项时，语句会被执行。如果用户想使用EXPLAIN分析INSERT，UPDATE，DELETE，CREATE TABLE AS或EXECUTE语句，而不想改动数据（执行这些语句会影响数据），请使用如下方法。
  ```
  START TRANSACTION;
  EXPLAIN ANALYZE ...;
  ROLLBACK;
  ```
  
 
- 当使用EXPLAIN查看执行计划时，审计日志记录的审计类型由分析的具体SQL决定。
#### 语法格式
- 显示SQL语句的执行计划，支持多种选项，对选项顺序无要求。
  ```
  EXPLAIN [ ( option [, ...] ) ] statement;
  ```
  ![](https://support.huaweicloud.com/distributed-ref-v10-gaussdb/figure/zh-cn_image_0000002764469228.png "点击放大")
  其中选项option子句的语法为。
  ```
  {
      ANALYZE [ boolean ] |
      ANALYSE [ boolean ] |
      VERBOSE [ boolean ] |
      COSTS [ boolean ] |
      CPU [ boolean ] |
      DETAIL [ boolean ] |
      NODES [ boolean ] |
      NUM_NODES [ boolean ] |
      BUFFERS [ boolean ] |
      TIMING [ boolean ] |
      PLAN [ boolean ] |
      BLOCKNAME [ boolean ] |
      FORMAT { TEXT | XML | JSON | YAML } |
      METADATA [ boolean ] |
      TABLES [ boolean ]
  }
  ```
  ![](https://support.huaweicloud.com/distributed-ref-v10-gaussdb/figure/zh-cn_image_0000002793788037.png)
  
- 显示SQL语句的执行计划，且要按顺序给出选项。
  ```
  EXPLAIN { [ ANALYZE | ANALYSE ] [ VERBOSE ] | PERFORMANCE } statement;
  ```
  ![](https://support.huaweicloud.com/distributed-ref-v10-gaussdb/figure/zh-cn_image_0000002793707841.png "点击放大")
  
 
#### 参数说明
- **statement**
  指定要分析的SQL语句。
  
- **ANALYZE boolean \| ANALYSE boolean**
  显示实际运行时间和其他统计数据。当两个参数同时使用时，在option中排在后面的一个生效。
  取值范围：
  - TRUE（缺省值）：显示实际运行时间和其他统计数据。
  
  - FALSE：不显示。
   
- **VERBOSE boolean**
  显示有关计划的额外信息。
  取值范围：
  - TRUE（缺省值）：显示额外信息。
  
  - FALSE：不显示。
   
- **COSTS boolean**
  包括每个规划节点的估计总成本，以及估计的行数和每行的宽度。
  取值范围：
  - TRUE（缺省值）：显示估计总成本和宽度。
  
  - FALSE：不显示。
   
- **CPU boolean**
  打印CPU的使用情况的信息。需要结合ANALYZE或ANALYSE选项一起使用。
  取值范围：
  - TRUE（缺省值）：显示CPU的使用情况。
  
  - FALSE：不显示。
   
- **DETAIL boolean**
  打印DN上的信息。需要结合ANALYZE或ANALYSE选项一起使用。
  取值范围：
  - TRUE（缺省值）：打印DN的信息。
  
  - FALSE：不打印。
   
- **NODES boolean**
  打印query执行的节点信息。
  取值范围：
  - TRUE（缺省值）：打印执行的节点的信息。
  
  - FALSE：不打印。
   
- **NUM_NODES boolean**
  打印执行中的节点的个数信息。
  取值范围：
  - TRUE（缺省值）：打印DN个数的信息。
  
  - FALSE：不打印。
   
- **BUFFERS boolean**
  包括缓冲区的使用情况的信息。需要结合ANALYZE或ANALYSE选项一起使用。
  取值范围：
  - TRUE：显示缓冲区的使用情况。
  
  - FALSE（缺省值）：不显示。
   
- **TIMING boolean**
  包括实际的启动时间和花费在输出节点上的时间信息。需要结合ANALYZE或ANALYSE选项一起使用。
  取值范围：
  - TRUE（缺省值）：显示启动时间和花费在输出节点上的时间信息。
  
  - FALSE：不显示。
   
- **PLAN** **boolean**
  是否将执行计划存储在plan_table中。当该选项开启时，会将执行计划存储在plan_table中，不打印到当前屏幕，因此该选项为on时，不能与其他选项同时使用。
  取值范围：
  - TRUE（缺省值）：将执行计划存储在plan_table中，不打印到当前屏幕。执行成功返回EXPLAIN SUCCESS。
  
  - FALSE：不存储执行计划，将执行计划打印到当前屏幕。
   
- **BLOCKNAME** **boolean**
  是否显示计划的每个操作所处于的查询块。当该选项开启时，会将每个操作所处于的查询块的名字输出在Query Block列上，方便用户获取查询块名字，并使用Hint修改执行计划：
  - TRUE（缺省值）：显示计划时，将每个操作所处于的查询块的名字输出在新增列Query Block列上。该选项需要在pretty模式下使用。请参见《SQL调优指南》中"使用Plan Hint进行调优 \> 指定Hint所处的查询块Queryblock"章节。
  
  - FALSE：不对计划显示产生影响。
   
- **FORMAT**
  指定输出格式。
  取值范围：TEXT，XML，JSON和YAML。
  默认值：TEXT。
  
- **PERFORMANCE**
  使用此选项时，即打印执行中的所有相关信息。下述为部分信息描述：
  - ex c/r：代表平均每行使用cpu周期数，等于（ex cyc）/（ex row）。
  
  - ex row：执行行数。
  
  - ex cyc：代表使用的cpu周期数。
  
  - inc cyc：代表包含子节点使用的总cpu周期数。
  
  - shared hit：代表算子的share buffer命中情况。
  
  - loops：算子循环执行次数。
  
  - total_calls：生成元素总数。
  
  - remote query poll time stream gather：算子用于侦听各DN数据到达CN的网络poll时间。
  
  - deserialize time：反序列化所需时间。
  
  - estimated time：估计时间。
  
  - Network Poll Time：分布式stream网络通信时，表示libcomm接收侧等待数据耗时。
  
  - Stream Send time：分布式stream网络通信时，表示libcomm或libpq发送数据耗时。
  
  - OS Kernel Send time：分布式stream网络通信时，表示操作系统层发送数据耗时，大于0才会显示。
  
  - Wait Quota time：分布式stream网络通信时，表示libcomm等待对端发送quota流控大小耗时，大于0才会显示。
  
  - Data Serialize time：分布式stream网络通信时，表示数据序列化时间 。
  
  - Data Copy time：分布式stream网络通信时，表示数据复制时间，大于0才会显示。
   

- **METADATA** **boolean**
  是否显示语句元数据内容。当不指定boolean时，默认为TRUE。该部分内容仅在语句使用stream类型计划时展示，下述为输出信息描述：
  - 概要对象定义，涵盖对象包括语句中所引用的表、索引、视图、函数、操作符。
  
  - 概要统计信息，分为表级和列级两部分，其公共字段包括：
    - nspname：模式名，对应pg_namespace.nspname。
    
    - relname：表名，对应表或索引的pg_class.relname。
    
    - partname：分区名，对应分区的pg_partition.relname。
    
    - subpartname：子分区名，对应子分区的pg_partition.relname。
    
    
    其他表级统计信息的字段包括：
    - reltuples：统计的表总行数，对应pg_class/pg_partition.reltuples。
    
    - relpages：统计的表总页数，对应pg_class/pg_partition.relpages。
    
    - analyze_time：该表或索引上次触发ANANLYZE的时间戳，对应pg_stat_get_last_analyze_time/gs_stat_get_partition_last_analyze_time的返回值。
    
    - rows_changed：自上次执行ANALYZE后该表或索引的变更行数，对应pg_stat_get_tuples_changed/pg_stat_get_partition_tuples_changed的返回值。
    
    - rows_inserted：自上次执行ANALYZE后该表或索引的插入行数，该值为空。
    
    
    其他列级统计信息（包括单列与多列）的字段包括：
    - colnames：列名，单列对应pg_stats.attname，多列对应pg_ext_stats.attname中列号所代表的列名集合。
    
    - nullfrac：空值率，对应pg_stats/pg_ext_stats.nullfrac。
    
    - avgwidth：平均行宽，对应pg_stats/pg_ext_stats.avgwidth。
    
    - distinct：不同值的数量，对应pg_stats/pg_ext_stats.n_distinct。
    
    - dndistinct：DN上不同值的数量，对应pg_stats/pg_ext_stats.n_dndistinct。
    
    - mcvs_top5：高频值，对应pg_stats/pg_ext_stats.most_common_vals，只取频率最高的5个。
    
    - mcfs_top5：高频值的频率，与mcvs_top5一一对应，对应pg_stats/pg_ext_stats.most_common_freqs。
    
    - hist_qrtl：直方图桶值，单列对应pg_stats.histogram_bounds，只取四分位边界上的5个值，多列为空。
    
    - correlation：相关性，单列对应pg_stats.correlation，多列为0。
     
  
  - 在Query Others中，包含以下内容：
    - current time：当前时间戳，用于与上述analyze_time进行对比。
    
    - use_hints: Yes, \<string\>：如果语句有Hint生效，则打印该提示，并列出生效的Hint。
     
  
  
  取值范围：
  - TRUE（默认值）：显示语句元信息，该选项需要在pretty模式下使用。
  
  - FALSE：不显示。
    
- **TABLES** **boolean**
  是否显示SQL语句所依赖的表对象信息，包括表与物化视图。当不指定boolean时，默认为TRUE。该部分内容仅在语句使用stream类型计划时展示。
  - TRUE（默认值）：显示语句所依赖的表对象信息，该选项需要在pretty模式下使用。
  
  - FALSE：不显示。
   
 
#### 示例1
```
--创建SCHEMA。
gaussdb=# CREATE SCHEMA tpcds;
--创建表tpcds.customer_address。
gaussdb=# CREATE TABLE tpcds.customer_address
(
ca_address_sk         INTEGER           NOT NULL,
ca_address_id         CHARACTER(16)     NOT NULL
);
 
--向表中插入多条记录。
gaussdb=# INSERT INTO tpcds.customer_address VALUES (5000, 'AAAAAAAABAAAAAAA'),(10000, 'AAAAAAAACAAAAAAA');
--创建一个表tpcds.customer_address_p1。
gaussdb=# CREATE TABLE tpcds.customer_address_p1 AS TABLE tpcds.customer_address;
--修改explain_perf_mode为normal。
gaussdb=# SET explain_perf_mode=normal;
--显示表简单查询的执行计划。
gaussdb=# EXPLAIN SELECT * FROM tpcds.customer_address_p1;
QUERY PLAN
--------------------------------------------------
Data Node Scan  (cost=0.00..0.00 rows=0 width=0)
Node/s: All datanodes
(2 rows)
--使用ANALYZE选项,在输出中增加运行时间统计。
gaussdb=# EXPLAIN ANALYZE SELECT * FROM tpcds.customer_address_p1;
                                         QUERY PLAN                                         
--------------------------------------------------------------------------------------------
 Data Node Scan  (cost=0.00..0.00 rows=0 width=0) (actual time=1.754..3.218 rows=2 loops=1)
   Node/s: All datanodes
 Total runtime: 3.272 ms
(3 rows)
--使用ANALYZE选项和CPU选项，输出CPU的使用信息。
gaussdb=# EXPLAIN (ANALYZE,CPU)SELECT * FROM tpcds.customer_address_p1;
                                            QUERY PLAN                                            
--------------------------------------------------------------------------------------------------
 Data Node Scan  (cost=0.00..0.00 rows=0 width=0) (actual time=1.996..2.214 rows=2 loops=1)
   Node/s: All datanodes
   (CPU: ex c/r=25694795469106248, ex row=2, ex cyc=51389590938212496, inc cyc=51389590938212496)
 Total runtime: 2.251 ms
(4 rows)
--以JSON格式输出的执行计划（explain_perf_mode为normal时）。
gaussdb=# EXPLAIN(FORMAT JSON) SELECT * FROM tpcds.customer_address_p1;
              QUERY PLAN              
--------------------------------------
 [                                   +
   {                                 +
     "Plan": {                       +
       "Node Type": "Data Node Scan",+
       "Startup Cost": 0.00,         +
       "Total Cost": 0.00,           +
       "Plan Rows": 0,               +
       "Plan Width": 0,              +
       "Node/s": "All datanodes"     +
     }                               +
   }                                 +
 ]
(1 row)
--以YAML格式输出的执行计划（explain_perf_mode为normal时）。
gaussdb=# EXPLAIN(FORMAT YAML) SELECT * FROM tpcds.customer_address_p1 WHERE ca_address_sk=10000;
           QUERY PLAN            
---------------------------------
 - Plan:                        +
     Node Type: "Data Node Scan"+
     Startup Cost: 0.00         +
     Total Cost: 0.00           +
     Plan Rows: 0               +
     Plan Width: 0              +
     Node/s: "dn_6005_6006"
(1 row)
--禁止开销估计的执行计划。
gaussdb=# EXPLAIN(COSTS FALSE)SELECT * FROM tpcds.customer_address_p1 WHERE ca_address_sk=10000;
       QUERY PLAN       
------------------------
 Data Node Scan
   Node/s: dn_6005_6006
(2 rows)
--带有聚集函数查询的执行计划。
gaussdb=# EXPLAIN SELECT SUM(ca_address_sk) FROM tpcds.customer_address_p1 WHERE ca_address_sk<10000;
                                      QUERY PLAN                                       
---------------------------------------------------------------------------------------
 Aggregate  (cost=18.19..14.32 rows=1 width=4)
   ->  Streaming (type: GATHER)  (cost=18.19..14.32 rows=3 width=4)
         Node/s: All datanodes
         ->  Aggregate  (cost=14.19..14.20 rows=3 width=4)
               ->  Seq Scan on customer_address_p1  (cost=0.00..14.18 rows=10 width=4)
                     Filter: (ca_address_sk < 10000)
(6 rows)
--删除表tpcds.customer_address_p1。
gaussdb=# DROP TABLE tpcds.customer_address_p1;
--删除表tpcds.customer_address。
gaussdb=# DROP TABLE tpcds.customer_address;
--删除SCHEMA。
gaussdb=# DROP SCHEMA tpcds CASCADE;
```
#### 示例2
```
# 展示SQL语句元信息。
# 使用gsql连接数据库。
[omm@localhost ~]$ gsql -d postgres -p 8000 -r
-- 设置explain_perf_mode。
gaussdb=# SET explain_perf_mode = pretty;
-- 关闭多列统计信息贝叶斯网络，以收集普通的多列MCV统计信息。
gaussdb=# SET enable_ai_stats = off;
-- 关闭自动参数化，避免语句跳过解析。
gaussdb=# SET cursor_sharing = off;
-- 创建SCHEMA，并默认使用该SCHEMA。
gaussdb=# CREATE SCHEMA em;
gaussdb=# SET search_path = em;
-- 创建表em.t1。
gaussdb=# CREATE TABLE em.t1 (
    c1 integer
) DISTRIBUTE BY HASH (c1) PARTITION BY RANGE (c1) (
    PARTITION p1 VALUES LESS THAN (1000),
    PARTITION p2 VALUES LESS THAN (MAXVALUE)
);
-- 在em.t1上增加索引。
gaussdb=# CREATE INDEX em.idx_t1_c1 ON em.t1(c1) LOCAL;
-- 插入多条记录。
gaussdb=# INSERT INTO em.t1 SELECT (s % 2000)::int FROM pg_catalog.generate_series(1, 100000) s;
-- ANALYZE em.t1。
gaussdb=# ANALYZE em.t1 WITH ALL COMPLETE;
-- 创建表em.t2。
gaussdb=# CREATE TABLE em.t2 (c1 integer, c2 integer) WITH (storage_type=ASTORE) DISTRIBUTE BY HASH (c1);
-- 插入多条记录。
gaussdb=# INSERT INTO em.t2 SELECT (s % 6)::int, (s % 3)::int FROM pg_catalog.generate_series(1, 24) s;
-- ANALYZE em.t2。
gaussdb=# ANALYZE em.t2;
-- ANALYZE em.t2的c1列和c2列。
gaussdb=# ANALYZE em.t2((c1,c2));
-- 创建物化视图em.mv。
gaussdb=# CREATE MATERIALIZED VIEW em.mv AS SELECT c1 FROM t2 WHERE c1 = 2 AND c2 = 2;
NOTICE:  The 'DISTRIBUTE BY' clause is not specified. Using 'c1' as the distribution column by default.
HINT:  Please use 'DISTRIBUTE BY' clause to specify suitable data distribution column.
-- ANALYZE物化视图。
gaussdb=# ANALYZE em.mv;
-- 使用METADATA选项，输出语句涉及的元信息。
gaussdb=# EXPLAIN (METADATA ON) SELECT t.c1, v.c1 FROM em.t1 t, em.mv v WHERE t.c1 < 500 AND v.c1=2;
 id |                           operation                           | E-rows | E-width | E-costs 
----+---------------------------------------------------------------+--------+---------+---------
  1 | ->  Streaming (type: GATHER)                                  | 100584 |       8 | 4764.48
  2 |    ->  Nested Loop (3,4)                                      | 100584 |       8 | 573.48
  3 |       ->  Partitioned Index Only Scan using idx_t1_c1 on t1 t |  25146 |       4 | 150.24
  4 |       ->  Materialize                                         |     12 |       4 | 4.15
  5 |          ->  Streaming(type: BROADCAST)                       |     12 |       4 | 4.13
  6 |             ->  Seq Scan on mv v                              |      4 |       4 | 3.05
(6 rows)
       Predicate Information (identified by plan id)       
-----------------------------------------------------------
   3 --Partitioned Index Only Scan using idx_t1_c1 on t1 t
         Index Cond: (c1 < 500)
         Selected Partitions:  1
   6 --Seq Scan on mv v
         Filter: (c1 = 2)
(5 rows)
                                                                                                                         Object Definition                                                                                                                  
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-------
 CREATE TABLE em.t1 (c1 integer) WITH (orientation=row, compression=no, storage_type=USTORE, segment=off) DISTRIBUTE BY HASH(c1) TO GROUP group1 PARTITION BY RANGE (c1) (PARTITION p1 VALUES LESS THAN (1000) TABLESPACE pg_default) /*Number of partitions
: 2*/;
 CREATE INDEX em.idx_t1_c1 ON em.t1 USING ubtree (c1) LOCAL WITH (storage_type=USTORE) TABLESPACE pg_default;
 CREATE TABLE em.t2 (c1 integer, c2 integer) WITH (orientation=row, storage_type=astore, compression=no) DISTRIBUTE BY HASH(c1) TO GROUP group1;
 CREATE MATERIALIZED VIEW em.mv AS SELECT t2.c1 FROM t2 WHERE ((t2.c1 = 2) AND (t2.c2 = 2));
(4 rows)
 nspname |  relname  | partname  | subpartname | reltuples | relpages |         analyze_time          | rows_changed | rows_inserted 
---------+-----------+-----------+-------------+-----------+----------+-------------------------------+--------------+---------------
 em      | t1        |           |             | 100000    | 384      | 2026-07-06 11:12:08.316871+08 | 0            | 
 em      | t1        | p1        |             | 50000     | 192      | 2026-07-06 11:12:08.61814+08  | 0            | 
 em      | idx_t1_c1 |           |             | 100000    | 58       |                               | 0            | 
 em      | idx_t1_c1 | p1_c1_idx |             | 100000    | 58       |                               | 0            | 
 em      | t2        |           |             | 48        | 3        | 2026-07-06 11:15:38.374133+08 | 0            | 
 em      | mv        |           |             | 4         | 3        | 2026-07-06 11:15:45.16283+08  | 0            | 
(6 rows)
 nspname | relname | partname | subpartname | colnames | nullfrac | avgwidth | distinct | dndistinct |         mcvs_top5         |                     mcfs_top5                      |       hist_qrtl        | correlation 
---------+---------+----------+-------------+----------+----------+----------+----------+------------+---------------------------+----------------------------------------------------+------------------------+-------------
 em      | t1      |          |             | c1       | 0        | 4        | 2000     | 667        | {358,132,188,267,613}     | {.001,.000833333,.000833333,.000833333,.000833333} | {0,513,1016,1516,1999} | .715956
 em      | t1      | p1       |             | c1       | 0        | 4        | 1000     | 667        | {594,996,7,454,591}       | {.00133333,.00133333,.0013,.0013,.0013}            | {0,250,497,749,999}    | .0195734
 em      | t2      |          |             | c1       | 0        | 4        | -.125    | -.125      | {0,1,2,3,4}               | {.166667,.166667,.166667,.166667,.166667}          |                        | .462875
 em      | t2      |          |             | c2       | 0        | 4        | 3        | 1          | {0,1,2}                   | {.333333,.333333,.333333}                          |                        | .865393
 em      | t2      |          |             | {c1,c2}  | 0        | 8        | -.125    | -.125      | {{0,1,2,3,4},{0,1,2,0,1}} | {.166667,.166667,.166667,.166667,.166667}          |                        | 0
 em      | mv      |          |             | c1       | 0        | 4        | -.25     | 1          | {2}                       | {1}                                                |                        | 1
(6 rows)
          ====== Query Others =====          
---------------------------------------------
 current time: 2026-07-06 11:15:52.968669+08
(1 row)
-- 使用TABLES选项，打印SQL语句所依赖的表对象信息列表。
gaussdb=# EXPLAIN (TABLES) SELECT t.c1, v.c1 FROM em.t1 t, em.mv v WHERE t.c1 < 500 AND v.c1=2;
 id |                           operation                           | E-rows | E-width | E-costs 
----+---------------------------------------------------------------+--------+---------+---------
  1 | ->  Streaming (type: GATHER)                                  | 100584 |       8 | 4764.48
  2 |    ->  Nested Loop (3,4)                                      | 100584 |       8 | 573.48
  3 |       ->  Partitioned Index Only Scan using idx_t1_c1 on t1 t |  25146 |       4 | 150.24
  4 |       ->  Materialize                                         |     12 |       4 | 4.15
  5 |          ->  Streaming(type: BROADCAST)                       |     12 |       4 | 4.13
  6 |             ->  Seq Scan on mv v                              |      4 |       4 | 3.05
(6 rows)
       Predicate Information (identified by plan id)       
-----------------------------------------------------------
   3 --Partitioned Index Only Scan using idx_t1_c1 on t1 t
         Index Cond: (c1 < 500)
         Selected Partitions:  1
   6 --Seq Scan on mv v
         Filter: (c1 = 2)
(5 rows)
            Tables Referenced             
------------------------------------------
 ('em', 't1'), ('em', 't2'), ('em', 'mv')
(1 row)
-- 清理创建对象。
gaussdb=# DROP SCHEMA em CASCADE;
gaussdb=# \q
```
#### 相关链接
[ANALYZE \| ANALYSE](https://support.huaweicloud.com/distributed-ref-v10-gaussdb/gaussdb-08-0221.html)
