From 5ba40b62318e4d941497333b72d589420a48d82f Mon Sep 17 00:00:00 2001
From: Michael Paquier <michael@paquier.xyz>
Date: Thu, 23 Jan 2020 17:01:46 +0900
Subject: [PATCH] Doc: Fix and tweak documentation for ANALYZE reporting
The docs had some typos and grammar mistakes, and its indentation was
inconsistent.
Author: Amit Langote, Justin Pryzby
Discussion: https://postgr.es/m/20200116151930.GM26045@telsasoft.com
---
doc/src/sgml/monitoring.sgml | 106 ++++++++++++++++++-----------------
1 file changed, 54 insertions(+), 52 deletions(-)
diff --git a/doc/src/sgml/monitoring.sgml b/doc/src/sgml/monitoring.sgml
index 0bfd6151c47..8839699079f 100644
--- a/doc/src/sgml/monitoring.sgml
+++ b/doc/src/sgml/monitoring.sgml
@@ -3571,51 +3571,53 @@ SELECT pg_stat_get_backend_pid(s.backendid) AS pid,
<entry><structfield>sample_blks_total</structfield></entry>
<entry><type>bigint</type></entry>
<entry>
- Total number of heap blocks that will be sampled.
+ Total number of heap blocks that will be sampled.
</entry>
</row>
<row>
<entry><structfield>sample_blks_scanned</structfield></entry>
<entry><type>bigint</type></entry>
<entry>
- Number of heap blocks scanned.
+ Number of heap blocks scanned.
</entry>
</row>
<row>
<entry><structfield>ext_stats_total</structfield></entry>
<entry><type>bigint</type></entry>
<entry>
- Number of extended statistics.
+ Number of extended statistics.
</entry>
</row>
<row>
<entry><structfield>ext_stats_computed</structfield></entry>
<entry><type>bigint</type></entry>
<entry>
- Number of computed extended statistics computed. This counter only advances when
- the phase is <literal>computing extended statistics</literal>.
+ Number of extended statistics computed. This counter only advances
+ when the phase is <literal>computing extended statistics</literal>.
</entry>
</row>
<row>
<entry><structfield>child_tables_total</structfield></entry>
<entry><type>bigint</type></entry>
<entry>
- Number of child tables.
+ Number of child tables.
</entry>
</row>
<row>
<entry><structfield>child_tables_done</structfield></entry>
<entry><type>bigint</type></entry>
<entry>
- Number of child tables scanned. This counter only advances when the phase
- is <literal>acquiring inherited sample rows</literal>.
+ Number of child tables scanned. This counter only advances when the
+ phase is <literal>acquiring inherited sample rows</literal>.
</entry>
</row>
<row>
<entry><structfield>current_child_table_relid</structfield></entry>
<entry><type>oid</type></entry>
- <entry>OID of the child table currently being scanned. This field is only valid when
- the phase is <literal>computing extended statistics</literal>.
+ <entry>
+ OID of the child table currently being scanned. This field is
+ only valid when the phase is
+ <literal>acquiring inherited sample rows</literal>.
</entry>
</row>
</tbody>
@@ -3626,58 +3628,58 @@ SELECT pg_stat_get_backend_pid(s.backendid) AS pid,
<title>ANALYZE phases</title>
<tgroup cols="2">
<thead>
- <row>
+ <row>
<entry>Phase</entry>
<entry>Description</entry>
</row>
</thead>
- <tbody>
- <row>
- <entry><literal>initializing</literal></entry>
- <entry>
+ <tbody>
+ <row>
+ <entry><literal>initializing</literal></entry>
+ <entry>
The command is preparing to begin scanning the heap. This phase is
expected to be very brief.
- </entry>
- </row>
- <row>
- <entry><literal>acquiring sample rows</literal></entry>
- <entry>
+ </entry>
+ </row>
+ <row>
+ <entry><literal>acquiring sample rows</literal></entry>
+ <entry>
The command is currently scanning the table given by
- <structfield>current_relid</structfield> to obtain sample rows.
- </entry>
- </row>
- <row>
- <entry><literal>acquiring inherited sample rows</literal></entry>
- <entry>
- The command is currently scanning child tables to obtain sample rows. Columns
- <structfield>child_tables_total</structfield>,
+ <structfield>relid</structfield> to obtain sample rows.
+ </entry>
+ </row>
+ <row>
+ <entry><literal>acquiring inherited sample rows</literal></entry>
+ <entry>
+ The command is currently scanning child tables to obtain sample rows.
+ Columns <structfield>child_tables_total</structfield>,
<structfield>child_tables_done</structfield>, and
- <structfield>current_child_table_relid</structfield> contain the progress
- information for this phase.
- </entry>
- </row>
- <row>
- <entry><literal>computing statistics</literal></entry>
- <entry>
- The command is computing statistics from the samples rows obtained during
- the table scan.
- </entry>
- </row>
- <row>
- <entry><literal>computing extended statistics</literal></entry>
- <entry>
- The command is computing extended statistics from the samples rows obtained
- durring the table scan.
- </entry>
- </row>
- <row>
- <entry><literal>finalizing analyze</literal></entry>
- <entry>
+ <structfield>current_child_table_relid</structfield> contain the
+ progress information for this phase.
+ </entry>
+ </row>
+ <row>
+ <entry><literal>computing statistics</literal></entry>
+ <entry>
+ The command is computing statistics from the sample rows obtained
+ during the table scan.
+ </entry>
+ </row>
+ <row>
+ <entry><literal>computing extended statistics</literal></entry>
+ <entry>
+ The command is computing extended statistics from the sample rows
+ obtained during the table scan.
+ </entry>
+ </row>
+ <row>
+ <entry><literal>finalizing analyze</literal></entry>
+ <entry>
The command is updating pg_class. When this phase is completed,
<command>ANALYZE</command> will end.
- </entry>
- </row>
- </tbody>
+ </entry>
+ </row>
+ </tbody>
</tgroup>
</table>
--
GitLab