描述

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

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

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

BEGIN;
EXPLAIN ANALYZE ...;
ROLLBACK;

参数

输出

命令的结果是为 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 中给定的特定参数值的“自定义”计划。我们可能还希望查看参数化查询的通用计划，这可以使用 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 语句。

以下语法在 PostgreSQL 9.0 版本之前使用，并且仍然受支持

EXPLAIN [ ANALYZE ] [ VERBOSE ] statement

请注意，在此语法中，选项必须完全按照所示顺序指定。

另请参阅