EXPLAIN

功能描述

显示SQL语句的执行计划。

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

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

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

注意事项

  • 在指定ANALYZE选项时，语句会被执行。如果用户想使用EXPLAIN分析INSERT、UPDATE、DELETE、CREATE TABLE AS或EXECUTE语句，而不想改动数据（执行这些语句会影响数据），请使用如下方法。

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

  • 由于参数DETAIL、NODES、NUM_NODES是分布式模式下的功能，在单机模式中是被禁止使用的。假如使用，会产生如下错误。

    1. openGauss=# create table student(id int, name char(20));
    2. CREATE TABLE
    3. openGauss=# explain (nodes true) insert into student values(5,'a'),(6,'b');
    4. ERROR:  unrecognized EXPLAIN option "nodes"
    5. openGauss=# explain (num_nodes true) insert into student values(5,'a'),(6,'b');
    6. ERROR:  unrecognized EXPLAIN option "num_nodes"

语法格式

  • 显示SQL语句的执行计划，支持多种选项，对选项顺序无要求。

    1. EXPLAIN [ (  option  [, ...] )  ] statement;

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

    1. ANALYZE [ boolean ] |
    2.     ANALYSE [ boolean ] |
    3.     VERBOSE [ boolean ] |
    4.     COSTS [ boolean ] |
    5.     CPU [ boolean ] |
    6.     DETAIL [ boolean ] |(不可用)
    7.     NODES [ boolean ] |(不可用)
    8.     NUM_NODES [ boolean ] |(不可用)
    9.     BUFFERS [ boolean ] |
    10.     TIMING [ boolean ] |
    11.     PLAN [ boolean ] |
    12.     FORMAT { TEXT | XML | JSON | YAML }

  • 显示SQL语句的执行计划，且要按顺序给出选项。

    1. EXPLAIN  { [  { ANALYZE  | ANALYSE  }  ] [ VERBOSE  ]  | PERFORMANCE  } 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（不可用）

    打印数据库节点上的信息。

    取值范围：

    • 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

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

示例

  1. -- 1、创建一个表
  2. openGauss=# create table test_t(c1 int, c2 varchar(30));
  3. CREATE TABLE
  5. -- 2、查看 SQL 的执行计划
  6. openGauss=# explain select * from test_t;
  7.                         QUERY PLAN
  8. ----------------------------------------------------------
  9.  Seq Scan on test_t  (cost=0.00..17.29 rows=729 width=82)
  10. (1 row)
  12. -- 3、在查看计划时可以指定输出格式
  13. -- 注意：只有当 explain_perf_mode 为 normal 时，才支持 json 格式
  14. openGauss=# SET explain_perf_mode=normal;
  15. SET
  16. openGauss=# explain (format json) select * from test_t;
  17.             QUERY PLAN
  18. ----------------------------------
  19.  [                               +
  20.    {                             +
  21.      "Plan": {                   +
  22.        "Node Type": "Seq Scan",  +
  23.        "Relation Name": "test_t",+
  24.        "Alias": "test_t",        +
  25.        "Startup Cost": 0.00,     +
  26.        "Total Cost": 17.29,      +
  27.        "Plan Rows": 729,         +
  28.        "Plan Width": 82          +
  29.      }                           +
  30.    }                             +
  31.  ]
  32. (1 row)
  34. -- 4、如果一个查询中的 where 子句的列有索引，在条件或数据等不一样时，可能会显示不同的执行计划
  35. openGauss=# create index idx_test_t_c1 on test_t(c1);
  36. CREATE INDEX
  37. openGauss=# insert into test_t values(generate_series(1, 200), 'hello openGauss');
  38. INSERT 0 200
  39. openGauss=# explain select c1, c2 from test_t where c1=100;
  40.                                  QUERY PLAN
  41. ----------------------------------------------------------------------------
  42.  Bitmap Heap Scan on test_t  (cost=4.28..12.74 rows=4 width=82)
  43.    Recheck Cond: (c1 = 100)
  44.    ->  Bitmap Index Scan on idx_test_t_c1  (cost=0.00..4.28 rows=4 width=0)
  45.          Index Cond: (c1 = 100)
  46. (4 rows)
  48. -- 5、可以通过 costs 选项，指定是否显示开销
  49. openGauss=# explain (costs false) select * from test_t where c1=100;
  50.                 QUERY PLAN
  51. ------------------------------------------
  52.  Bitmap Heap Scan on test_t
  53.    Recheck Cond: (c1 = 100)
  54.    ->  Bitmap Index Scan on idx_test_t_c1
  55.          Index Cond: (c1 = 100)
  56. (4 rows)

相关链接

ANALYZE | ANALYSE