EXPLAIN
功能描述
EXPLAIN 和 DESCRIBE 互为同义词，可以用于查看指定表结构，或查看指定 SQL 的执行计划。
查看表格结构的语法说明请参考 DESCRIBE 语法，以下内容仅介绍查看执行计划部分。
执行计划将显示SQL语句所引用的表会采用什么样的扫描方式，如：简单的顺序扫描、索引扫描等。如果引用了多个表，执行计划还会显示用到的JOIN算法。
执行计划的最关键的部分是语句的预计执行开销，这是计划生成器估算执行该语句将花费多长的时间。
若指定了ANALYZE选项，则该语句会被执行，然后根据实际的运行结果显示统计数据，包括每个计划节点内时间总开销（毫秒为单位）和实际返回的总行数。这对于判断计划生成器的估计是否接近现实非常有用。
注意事项
在指定ANALYZE选项时，语句会被执行。如果用户想使用EXPLAIN分析INSERT、UPDATE、DELETE、CREATE TABLE AS或EXECUTE语句，而不想改动数据（执行这些语句会影响数据），请使用如下方法。
START TRANSACTION; EXPLAIN ANALYZE ...; ROLLBACK;由于参数DETAIL、NODES、NUM_NODES是分布式模式下的功能，在单机模式中是被禁止使用的。假如使用，会产生如下错误。
openGauss=# create table student(id int, name char(20)); CREATE TABLE openGauss=# explain (nodes true) insert into student values(5,'a'),(6,'b'); ERROR: unrecognized EXPLAIN option "nodes" openGauss=# explain (num_nodes true) insert into student values(5,'a'),(6,'b'); ERROR: unrecognized EXPLAIN option "num_nodes"
语法格式
显示SQL语句的执行计划，支持多种选项，对选项顺序无要求。
{EXPLAIN | DESCRIBE | DESC} [ ( option [, ...] ) ] statement;或
{EXPLAIN | DESCRIBE | DESC} [FORMAT = format_name] statement;或
{EXPLAIN | DESCRIBE | DESC} [EXTENDED] statement;其中 {EXPLAIN | DESCRIBE | DESC} 表示使用 DESCRIBE、DESC 和 EXPLAIN 效果是等价的。
选项option子句的语法为：
ANALYZE [ 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语句的执行计划，且要按顺序给出选项。
{EXPLAIN | DESCRIBE | DESC} { [ { ANALYZE } ] [ (VERBOSE) ] | PERFORMANCE } statement;
参数说明
statement
指定要分析的SQL语句。
ANALYZE boolean
显示实际运行时间和其他统计数据。
取值范围：
- TRUE（缺省值）：显示实际运行时间和其他统计数据。
- FALSE：不显示。
VERBOSE boolean
显示有关计划的额外信息。
取值范围：
- TRUE（缺省值）：显示额外信息。
- FALSE：不显示。
COSTS boolean
包括每个规划节点的估计总成本，以及估计的行数和每行的宽度。
取值范围：
- TRUE（缺省值）：显示估计总成本和宽度。
- FALSE：不显示。
CPU boolean
打印CPU的使用情况的信息。
取值范围：
- TRUE（缺省值）：显示CPU的使用情况。
- FALSE：不显示。
DETAIL boolean（不可用）
打印数据库节点上的信息。
取值范围：
- TRUE（缺省值）：打印数据库节点的信息。
- FALSE：不打印。
NODES boolean（不可用）
打印query执行的节点信息。
取值范围：
- TRUE（缺省值）：打印执行的节点的信息。
- FALSE：不打印。
NUM_NODES boolean（不可用）
打印执行中的节点的个数信息。
取值范围：
- TRUE（缺省值）：打印数据库节点个数的信息。
- 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
使用此选项时，即打印执行中的所有相关信息。
format_name
指定输出格式。
取值范围：TRADITIONAL 、JSON 或 TREE。
默认值：TRADITIONAL
EXTENDED
可选，无区别。
示例
-- 1、首先创建一个兼容性为 B 模式的数据库，并切换
openGauss=# create database openGauss with dbcompatibility 'B';
CREATE DATABASE
openGauss=# \c openGauss
Non-SSL connection (SSL connection is recommended when requiring high-security)
You are now connected to database "opengauss" as user "omm".
-- 2、在新的数据库上创建一个表
opengauss=# create table test_t(c1 int, c2 varchar(30));
CREATE TABLE
-- 3、查看 SQL 的执行计划
opengauss=# explain select * from test_t;
QUERY PLAN
----------------------------------------------------------
Seq Scan on test_t (cost=0.00..17.29 rows=729 width=82)
(1 row)
-- 4、在查看计划时可以指定输出格式
-- 注意：只有当 explain_perf_mode 为 normal 时，才支持 json 格式
openGauss=# SET explain_perf_mode=normal;
SET
opengauss=# explain (format json) select * from test_t;
QUERY PLAN
----------------------------------
[ +
{ +
"Plan": { +
"Node Type": "Seq Scan", +
"Relation Name": "test_t",+
"Alias": "test_t", +
"Startup Cost": 0.00, +
"Total Cost": 17.29, +
"Plan Rows": 729, +
"Plan Width": 82 +
} +
} +
]
(1 row)
opengauss=# explain format=json select * from test_t;
QUERY PLAN
----------------------------------
[ +
{ +
"Plan": { +
"Node Type": "Seq Scan", +
"Relation Name": "test_t",+
"Alias": "test_t", +
"Startup Cost": 0.00, +
"Total Cost": 17.29, +
"Plan Rows": 729, +
"Plan Width": 82 +
} +
} +
]
(1 row)
-- 5、如果一个查询中的 where 子句的列有索引，在条件不一样或数据量等不一样时，可能会显示不同的执行计划
opengauss=# create index idx_test_t_c1 on test_t(c1);
CREATE INDEX
opengauss=# insert into test_t values(generate_series(1, 200), 'hello openGauss');
INSERT 0 200
opengauss=# explain select c1, c2 from test_t where c1=100;
QUERY PLAN
----------------------------------------------------------------------------
Bitmap Heap Scan on test_t (cost=4.28..12.74 rows=4 width=82)
Recheck Cond: (c1 = 100)
-> Bitmap Index Scan on idx_test_t_c1 (cost=0.00..4.28 rows=4 width=0)
Index Cond: (c1 = 100)
(4 rows)
-- 6、可以通过 costs 选项，指定是否显示开销
opengauss=# explain (costs false) select * from test_t where c1=100;
QUERY PLAN
------------------------------------------
Bitmap Heap Scan on test_t
Recheck Cond: (c1 = 100)
-> Bitmap Index Scan on idx_test_t_c1
Index Cond: (c1 = 100)
(4 rows)
-- 7、在兼容性为 B 的数据库下，explain 和 desc（describe）是等价的，还可以用来查看表结构信息
opengauss=# explain test_t;
Field | Type | Null | Key | Default | Extra
-------+-----------------------+------+-----+---------+-------
c1 | integer | YES | MUL | NULL |
c2 | character varying(30) | YES | | NULL |
(2 rows)