EXPLAIN

EXPLAIN — 显示语句的执行计划

语法

EXPLAIN [ ( option [, ...] ) ] statement
EXPLAIN [ ANALYZE ] [ VERBOSE ] statement

where option can be one of:

    ANALYZE [ boolean ]
    VERBOSE [ boolean ]
    COSTS [ boolean ]
    SETTINGS [ boolean ]
    GENERIC_PLAN [ boolean ]
    BUFFERS [ boolean ]
    WAL [ boolean ]
    TIMING [ boolean ]
    SUMMARY [ boolean ]
    FORMAT { TEXT | XML | JSON | YAML }

描述

此命令显示PostgreSQL规划器为提供的语句生成的执行计划。执行计划显示语句引用的表将如何被扫描（通过普通顺序扫描、索引扫描等），如果引用了多张表，将使用什么连接算法将每个输入表中所需的行组合在一起。

显示中最关键的部分是估计的语句执行成本，这是计划程序对运行语句所需时间（以任意成本单位衡量，但传统上表示磁盘页面获取）的猜测。实际上显示了两个数字：第一行返回之前的启动成本，以及返回所有行的总成本。对于大多数查询，总成本才是重要的，但在EXISTS中的子查询等上下文中，计划程序将选择最小的启动成本，而不是最小的总成本（因为执行程序无论如何都会在获取一行后停止）。此外，如果你使用LIMIT子句限制要返回的行数，计划程序会在端点成本之间进行适当的插值，以估计哪个计划实际上是最便宜的。

ANALYZE选项会导致实际执行语句，而不仅仅是计划。然后，实际运行时间统计信息将添加到显示中，包括在每个计划节点内花费的总经过时间（以毫秒为单位）以及实际返回的行总数。这对于查看计划程序的估计是否接近实际情况很有用。

重要

请记住，当使用ANALYZE选项时，实际上会执行该语句。虽然EXPLAIN会丢弃SELECT将返回的任何输出，但该语句的其他副作用将照常发生。如果你希望对INSERT、UPDATE、DELETE、MERGE、CREATE TABLE AS或EXECUTE语句使用EXPLAIN ANALYZE，而不让该命令影响你的数据，请使用此方法

BEGIN;
EXPLAIN ANALYZE ...;
ROLLBACK;

只能按该顺序指定ANALYZE和VERBOSE选项，并且只能在不使用括号包围选项列表的情况下指定。在PostgreSQL9.0 之前，未加括号的语法是唯一受支持的语法。预计所有新选项都将仅在加括号的语法中受支持。

参数

ANALYZE: 执行命令并显示实际运行时间和其他统计信息。此参数默认为 FALSE。
VERBOSE: 显示有关计划的其他信息。具体来说，包括计划树中每个节点的输出列列表、模式限定表和函数名称，始终使用其范围表别名标记表达式中的变量，并始终打印显示统计信息的每个触发器的名称。如果已计算查询标识符，也将显示该标识符，有关更多详细信息，请参阅 compute_query_id。此参数的默认值为 FALSE。
COSTS: 包括有关每个计划节点的估计启动成本和总成本的信息，以及估计的行数和每行的估计宽度。此参数的默认值为 TRUE。
SETTINGS: 包括有关配置参数的信息。具体来说，包括影响查询计划且值与内置默认值不同的选项。此参数的默认值为 FALSE。
GENERIC_PLAN: 允许语句包含参数占位符，例如 $1，并生成不依赖于这些参数值的通用计划。有关通用计划和支持参数的语句类型的详细信息，请参阅 PREPARE。此参数不能与 ANALYZE 一起使用。它的默认值为 FALSE。
BUFFERS: 包括有关缓冲区使用情况的信息。具体来说，包括命中、读取、弄脏和写入的共享块数，命中、读取、弄脏和写入的本地块数，读取和写入的临时块数，以及在启用 track_io_timing 时花费在读取和写入数据文件块和临时文件块上的时间（以毫秒为单位）。命中表示避免了读取，因为在需要时已在缓存中找到了该块。共享块包含来自常规表和索引的数据；本地块包含来自临时表和索引的数据；而临时块包含在排序、哈希、物化计划节点和类似情况下使用的短期工作数据。弄脏的块数表示此查询更改的先前未修改的块数；而写入的块数表示查询处理期间此后端从缓存中驱逐的先前弄脏的块数。上层节点显示的块数包括其所有子节点使用的块数。在文本格式中，仅打印非零值。此参数的默认值为 FALSE。
WAL: 包含有关 WAL 记录生成的信息。具体来说，包括记录数、全页图像 (fpi) 数和以字节为单位生成的 WAL 量。在文本格式中，仅打印非零值。仅当 ANALYZE 也启用时，才可以使用此参数。其默认值为 FALSE。
TIMING: 在输出中包含实际启动时间和在每个节点中花费的时间。在某些系统上，重复读取系统时钟的开销可能会显著降低查询速度，因此当仅需要实际行数而不是确切时间时，将此参数设置为 FALSE 可能很有用。即使使用此选项关闭了节点级计时，也会始终测量整个语句的运行时间。仅当 ANALYZE 也启用时，才可以使用此参数。其默认值为 TRUE。
SUMMARY: 在查询计划后包含摘要信息（例如，总计时信息）。当使用 ANALYZE 时，默认情况下会包含摘要信息，但其他情况下不会默认包含，但可以使用此选项启用。在 EXPLAIN EXECUTE 中的计划时间包括从缓存中获取计划所需的时间以及重新计划所需的时间（如果需要）。
FORMAT: 指定输出格式，可以是 TEXT、XML、JSON 或 YAML。非文本输出包含与文本输出格式相同的信息，但程序更容易解析。此参数的默认值为 TEXT。
boolean: 指定是否应打开或关闭所选选项。您可以编写 TRUE、ON 或 1 以启用该选项，以及 FALSE、OFF 或 0 以禁用该选项。boolean 值也可以省略，在这种情况下，假定为 TRUE。
statement: 任何 SELECT、INSERT、UPDATE、DELETE、MERGE、VALUES、EXECUTE、DECLARE、CREATE TABLE AS 或 CREATE MATERIALIZED VIEW AS 语句，您希望查看其执行计划。

输出

该命令的结果是对为*statement*选择的计划的文本描述，可以选择使用执行统计信息进行注释。第 14.1 节描述了提供的信息。

注释

为了让PostgreSQL查询计划器在优化查询时做出合理明智的决策，所有用于查询的表的pg_statistic数据都应是最新的。通常，自动清理守护进程会自动处理此事。但是，如果某个表的内容最近发生了重大更改，则可能需要执行手动ANALYZE，而不是等待自动清理赶上这些更改。

为了衡量执行计划中每个节点的运行时成本，EXPLAIN ANALYZE的当前实现向查询执行中添加了分析开销。因此，在查询上运行EXPLAIN ANALYZE有时可能比正常执行查询花费的时间长得多。开销量取决于查询的性质以及所使用的平台。最坏的情况发生在本身每次执行所需时间极少的计划节点上，以及在获取时间相对较慢的操作系统调用上。

示例

若要显示对具有单个integer列和 10000 行的表的简单查询的计划

EXPLAIN SELECT * FROM foo;

                       QUERY PLAN
---------------------------------------------------------
 Seq Scan on foo  (cost=0.00..155.00 rows=10000 width=4)
(1 row)

这是具有 JSON 输出格式的相同查询

EXPLAIN (FORMAT JSON) SELECT * FROM foo;
           QUERY PLAN
--------------------------------
 [                             +
   {                           +
     "Plan": {                 +
       "Node Type": "Seq Scan",+
       "Relation Name": "foo", +
       "Alias": "foo",         +
       "Startup Cost": 0.00,   +
       "Total Cost": 155.00,   +
       "Plan Rows": 10000,     +
       "Plan Width": 4         +
     }                         +
   }                           +
 ]
(1 row)

如果存在索引，并且我们使用具有可索引WHERE条件的查询，EXPLAIN可能会显示不同的计划

EXPLAIN SELECT * FROM foo WHERE i = 4;

                         QUERY PLAN
--------------------------------------------------------------
 Index Scan using fi on foo  (cost=0.00..5.98 rows=1 width=4)
   Index Cond: (i = 4)
(2 rows)

这是相同的查询，但采用 YAML 格式

EXPLAIN (FORMAT YAML) SELECT * FROM foo WHERE i='4';
          QUERY PLAN
-------------------------------
 - Plan:                      +
     Node Type: "Index Scan"  +
     Scan Direction: "Forward"+
     Index Name: "fi"         +
     Relation Name: "foo"     +
     Alias: "foo"             +
     Startup Cost: 0.00       +
     Total Cost: 5.98         +
     Plan Rows: 1             +
     Plan Width: 4            +
     Index Cond: "(i = 4)"
(1 row)

XML 格式留给读者练习。

这是具有抑制的成本估算的相同计划

EXPLAIN (COSTS FALSE) SELECT * FROM foo WHERE i = 4;

        QUERY PLAN
----------------------------
 Index Scan using fi on foo
   Index Cond: (i = 4)
(2 rows)

这是使用聚合函数进行查询的查询计划示例

EXPLAIN SELECT sum(i) FROM foo WHERE i < 10;

                             QUERY PLAN
---------------------------------------------------------------------
 Aggregate  (cost=23.93..23.93 rows=1 width=4)
   ->  Index Scan using fi on foo  (cost=0.00..23.92 rows=6 width=4)
         Index Cond: (i < 10)
(3 rows)

这是使用EXPLAIN EXECUTE显示已准备查询的执行计划的示例

PREPARE query(int, int) AS SELECT sum(bar) FROM test
    WHERE id > $1 AND id < $2
    GROUP BY foo;

EXPLAIN ANALYZE EXECUTE query(100, 200);

                                                       QUERY PLAN
-------------------------------------------------------------------------------------------------------------------------
 HashAggregate  (cost=10.77..10.87 rows=10 width=12) (actual time=0.043..0.044 rows=10 loops=1)
   Group Key: foo
   Batches: 1  Memory Usage: 24kB
   ->  Index Scan using test_pkey on test  (cost=0.29..10.27 rows=99 width=8) (actual time=0.009..0.025 rows=99 loops=1)
         Index Cond: ((id > 100) AND (id < 200))
 Planning Time: 0.244 ms
 Execution Time: 0.073 ms
(7 rows)

当然，此处显示的具体数字取决于所涉及表的实际内容。还要注意，由于计划器的改进，数字，甚至所选查询策略，可能会在PostgreSQL版本之间有所不同。此外，ANALYZE命令使用随机抽样来估算数据统计信息；因此，即使表中数据的实际分布没有改变，在重新运行ANALYZE之后，成本估算也可能发生变化。

请注意，上一个示例显示了EXECUTE中给定的特定参数值的一个“custom”计划。我们可能还希望看到参数化查询的通用计划，这可以通过GENERIC_PLAN来完成

EXPLAIN (GENERIC_PLAN)
  SELECT sum(bar) FROM test
    WHERE id > $1 AND id < $2
    GROUP BY foo;

                                  QUERY PLAN
-------------------------------------------------------------------------------
 HashAggregate  (cost=26.79..26.89 rows=10 width=12)
   Group Key: foo
   ->  Index Scan using test_pkey on test  (cost=0.29..24.29 rows=500 width=8)
         Index Cond: ((id > $1) AND (id < $2))
(4 rows)

在这种情况下，解析器正确地推断出$1和$2应与id具有相同的数据类型，因此，PREPARE中缺少参数类型信息并不是问题。在其他情况下，可能需要为参数符号显式指定类型，可以通过转换来完成，例如

EXPLAIN (GENERIC_PLAN)
  SELECT sum(bar) FROM test
    WHERE id > $1::integer AND id < $2::integer
    GROUP BY foo;

兼容性

SQL 标准中未定义EXPLAIN语句。

另请参阅

ANALYZE

EXPLAIN ​

语法 ​

描述 ​

重要 ​

参数 ​

输出 ​

注释 ​

示例 ​

兼容性 ​

另请参阅 ​

EXPLAIN

语法

描述

重要

参数

输出

注释

示例

兼容性

另请参阅