Commit 5ba40b62 authored by Michael Paquier's avatar Michael Paquier

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
parent f942dfb9
...@@ -3571,51 +3571,53 @@ SELECT pg_stat_get_backend_pid(s.backendid) AS pid, ...@@ -3571,51 +3571,53 @@ SELECT pg_stat_get_backend_pid(s.backendid) AS pid,
<entry><structfield>sample_blks_total</structfield></entry> <entry><structfield>sample_blks_total</structfield></entry>
<entry><type>bigint</type></entry> <entry><type>bigint</type></entry>
<entry> <entry>
Total number of heap blocks that will be sampled. Total number of heap blocks that will be sampled.
</entry> </entry>
</row> </row>
<row> <row>
<entry><structfield>sample_blks_scanned</structfield></entry> <entry><structfield>sample_blks_scanned</structfield></entry>
<entry><type>bigint</type></entry> <entry><type>bigint</type></entry>
<entry> <entry>
Number of heap blocks scanned. Number of heap blocks scanned.
</entry> </entry>
</row> </row>
<row> <row>
<entry><structfield>ext_stats_total</structfield></entry> <entry><structfield>ext_stats_total</structfield></entry>
<entry><type>bigint</type></entry> <entry><type>bigint</type></entry>
<entry> <entry>
Number of extended statistics. Number of extended statistics.
</entry> </entry>
</row> </row>
<row> <row>
<entry><structfield>ext_stats_computed</structfield></entry> <entry><structfield>ext_stats_computed</structfield></entry>
<entry><type>bigint</type></entry> <entry><type>bigint</type></entry>
<entry> <entry>
Number of computed extended statistics computed. This counter only advances when Number of extended statistics computed. This counter only advances
the phase is <literal>computing extended statistics</literal>. when the phase is <literal>computing extended statistics</literal>.
</entry> </entry>
</row> </row>
<row> <row>
<entry><structfield>child_tables_total</structfield></entry> <entry><structfield>child_tables_total</structfield></entry>
<entry><type>bigint</type></entry> <entry><type>bigint</type></entry>
<entry> <entry>
Number of child tables. Number of child tables.
</entry> </entry>
</row> </row>
<row> <row>
<entry><structfield>child_tables_done</structfield></entry> <entry><structfield>child_tables_done</structfield></entry>
<entry><type>bigint</type></entry> <entry><type>bigint</type></entry>
<entry> <entry>
Number of child tables scanned. This counter only advances when the phase Number of child tables scanned. This counter only advances when the
is <literal>acquiring inherited sample rows</literal>. phase is <literal>acquiring inherited sample rows</literal>.
</entry> </entry>
</row> </row>
<row> <row>
<entry><structfield>current_child_table_relid</structfield></entry> <entry><structfield>current_child_table_relid</structfield></entry>
<entry><type>oid</type></entry> <entry><type>oid</type></entry>
<entry>OID of the child table currently being scanned. This field is only valid when <entry>
the phase is <literal>computing extended statistics</literal>. OID of the child table currently being scanned. This field is
only valid when the phase is
<literal>acquiring inherited sample rows</literal>.
</entry> </entry>
</row> </row>
</tbody> </tbody>
...@@ -3626,58 +3628,58 @@ SELECT pg_stat_get_backend_pid(s.backendid) AS pid, ...@@ -3626,58 +3628,58 @@ SELECT pg_stat_get_backend_pid(s.backendid) AS pid,
<title>ANALYZE phases</title> <title>ANALYZE phases</title>
<tgroup cols="2"> <tgroup cols="2">
<thead> <thead>
<row> <row>
<entry>Phase</entry> <entry>Phase</entry>
<entry>Description</entry> <entry>Description</entry>
</row> </row>
</thead> </thead>
<tbody> <tbody>
<row> <row>
<entry><literal>initializing</literal></entry> <entry><literal>initializing</literal></entry>
<entry> <entry>
The command is preparing to begin scanning the heap. This phase is The command is preparing to begin scanning the heap. This phase is
expected to be very brief. expected to be very brief.
</entry> </entry>
</row> </row>
<row> <row>
<entry><literal>acquiring sample rows</literal></entry> <entry><literal>acquiring sample rows</literal></entry>
<entry> <entry>
The command is currently scanning the table given by The command is currently scanning the table given by
<structfield>current_relid</structfield> to obtain sample rows. <structfield>relid</structfield> to obtain sample rows.
</entry> </entry>
</row> </row>
<row> <row>
<entry><literal>acquiring inherited sample rows</literal></entry> <entry><literal>acquiring inherited sample rows</literal></entry>
<entry> <entry>
The command is currently scanning child tables to obtain sample rows. Columns The command is currently scanning child tables to obtain sample rows.
<structfield>child_tables_total</structfield>, Columns <structfield>child_tables_total</structfield>,
<structfield>child_tables_done</structfield>, and <structfield>child_tables_done</structfield>, and
<structfield>current_child_table_relid</structfield> contain the progress <structfield>current_child_table_relid</structfield> contain the
information for this phase. progress information for this phase.
</entry> </entry>
</row> </row>
<row> <row>
<entry><literal>computing statistics</literal></entry> <entry><literal>computing statistics</literal></entry>
<entry> <entry>
The command is computing statistics from the samples rows obtained during The command is computing statistics from the sample rows obtained
the table scan. during the table scan.
</entry> </entry>
</row> </row>
<row> <row>
<entry><literal>computing extended statistics</literal></entry> <entry><literal>computing extended statistics</literal></entry>
<entry> <entry>
The command is computing extended statistics from the samples rows obtained The command is computing extended statistics from the sample rows
durring the table scan. obtained during the table scan.
</entry> </entry>
</row> </row>
<row> <row>
<entry><literal>finalizing analyze</literal></entry> <entry><literal>finalizing analyze</literal></entry>
<entry> <entry>
The command is updating pg_class. When this phase is completed, The command is updating pg_class. When this phase is completed,
<command>ANALYZE</command> will end. <command>ANALYZE</command> will end.
</entry> </entry>
</row> </row>
</tbody> </tbody>
</tgroup> </tgroup>
</table> </table>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment