描述

此命令顯示 PostgreSQL 規劃器為給定語句生成的執行計劃。執行計劃顯示語句引用的表將如何被掃描——透過普通順序掃描、索引掃描等——如果引用了多個表，將使用什麼連線演算法來整合來自每個輸入表的必需行。

顯示中最關鍵的部分是估計的語句執行成本，這是規劃器對執行該語句所需時間的猜測（以任意的成本單位衡量，但通常表示磁碟頁面讀取）。實際上顯示了兩個數字：返回第一行之前的啟動成本，以及返回所有行的總成本。對於大多數查詢，總成本才是重要的，但在像 EXISTS 中的子查詢這樣的上下文中，規劃器會選擇最小的啟動成本而不是最小的總成本（因為執行器將在獲取一行後停止）。此外，如果您使用 LIMIT 子句限制要返回的行數，規劃器會在端點成本之間進行適當的插值，以估計哪個計劃才是真正最便宜的。

使用 ANALYZE 選項會實際執行該語句，而不僅僅是計劃。然後，執行時間統計資訊將被新增到顯示中，包括每個計劃節點實際花費的總時間（以毫秒為單位）以及它實際返回的總行數。這有助於瞭解規劃器的估計是否接近實際情況。

BEGIN;
EXPLAIN ANALYZE ...;
ROLLBACK;

引數

輸出

命令的結果是對為 statement 選擇的計劃的文字描述，可選擇性地附帶執行統計資訊。第 14.1 節 描述了提供的資訊。

註釋

為了讓 PostgreSQL 查詢規劃器在最佳化查詢時做出合理的決策，查詢中使用的所有表的 pg_statistic 資料應是最新的。通常 autovacuum 守護程序 會自動處理此問題。但是，如果一個表的 DDL 最近有substantial 變化，您可能需要執行手動 ANALYZE，而不是等待 autovacuum 跟上這些 DDL。

為了測量執行計劃中每個節點的執行成本，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.00 loops=1)
   Group Key: foo
   Batches: 1  Memory Usage: 24kB
   Buffers: shared hit=4
   ->  Index Scan using test_pkey on test  (cost=0.29..10.27 rows=99 width=8) (actual time=0.009..0.025 rows=99.00 loops=1)
         Index Cond: ((id > 100) AND (id < 200))
         Index Searches: 1
         Buffers: shared hit=4
 Planning Time: 0.244 ms
 Execution Time: 0.073 ms
(10 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 語句。

在 PostgreSQL 版本 9.0 之前使用了以下語法，並且仍然支援

EXPLAIN [ ANALYZE ] [ VERBOSE ] statement

請注意，在此語法中，選項必須按所示順序精確指定。

另請參閱