Add note in pg_stat_statements documentation about planning statistics.

The added note explains that the numbers of planning and execution in
the statement are not always expected to match because their statistics are
updated at their respective end phase, and only for successful operations.

Author: Pascal Legrand, Julien Rouhaud, tweaked a bit by Fujii Masao
Discussion: https://postgr.es/m/1585857868967-0.post@n3.nabble.com

diff --git a/doc/src/sgml/pgstatstatements.sgml b/doc/src/sgml/pgstatstatements.sgml
index 3d2610864972b5de11e6f88967c9b3cf0f32b28f..5a962feb39d6be00111eccc5c4a8356559c0ed4a 100644 (file)
--- a/doc/src/sgml/pgstatstatements.sgml
+++ b/doc/src/sgml/pgstatstatements.sgml
@@ -129,7 +129,7 @@
       <entry><structfield>calls</structfield></entry>
       <entry><type>bigint</type></entry>
       <entry></entry>
-      <entry>Number of times executed</entry>
+      <entry>Number of times the statement was executed</entry>
      </row>
 
      <row>
@@ -398,6 +398,16 @@
    reducing <varname>pg_stat_statements.max</varname> to prevent
    recurrences.
   </para>
+
+  <para>
+   <structfield>plans</structfield> and <structfield>calls</structfield> aren't
+   always expected to match because planning and execution statistics are
+   updated at their respective end phase, and only for successful operations.
+   For example, if a statement is successfully planned but fails during
+   the execution phase, only its planning statistics will be updated.
+   If planning is skipped because a cached plan is used, only its execution
+   statistics will be updated.
+  </para>
  </sect2>
 
  <sect2>