doc: Add backlinks to progress reporting documentation

Previously, the only place where progress reports were mentioned is in
the section for monitoring dedicated to its catalogs.  This makes the
progress reporting more discoverable, by adding links from the pages of
the commands supporting progress reports to their related catalog
views.

Author: Matthias van de Meent
Reviewed-by: Justin Pryzby, Bharath Rupireddy, Josef Šimánek, Tomas
Vondra
Discussion: https://postgr.es/m/CAEze2WiOcgdH4aQA8NtZq-4dgvnJzp8PohdeKchPkhMY-jWZXA@mail.gmail.com
This commit is contained in:
Michael Paquier 2021-03-05 14:58:16 +09:00
parent 5bca69a76b
commit 8a8f4d8ede
7 changed files with 53 additions and 0 deletions

View File

@ -273,6 +273,12 @@ ANALYZE [ VERBOSE ] [ <replaceable class="parameter">table_and_columns</replacea
will not record new statistics for that table. Any existing statistics
will be retained.
</para>
<para>
Each backend running <command>ANALYZE</command> will report its progress
in the <structname>pg_stat_progress_analyze</structname> view. See
<xref linkend="analyze-progress-reporting"/> for details.
</para>
</refsect1>
<refsect1>
@ -291,6 +297,7 @@ ANALYZE [ VERBOSE ] [ <replaceable class="parameter">table_and_columns</replacea
<member><xref linkend="app-vacuumdb"/></member>
<member><xref linkend="runtime-config-resource-vacuum-cost"/></member>
<member><xref linkend="autovacuum"/></member>
<member><xref linkend="analyze-progress-reporting"/></member>
</simplelist>
</refsect1>
</refentry>

View File

@ -192,6 +192,11 @@ CLUSTER [VERBOSE]
are periodically reclustered.
</para>
<para>
Each backend running <command>CLUSTER</command> will report its progress
in the <structname>pg_stat_progress_cluster</structname> view. See
<xref linkend="cluster-progress-reporting"/> for details.
</para>
</refsect1>
<refsect1>
@ -242,6 +247,7 @@ CLUSTER <replaceable class="parameter">index_name</replaceable> ON <replaceable
<simplelist type="inline">
<member><xref linkend="app-clusterdb"/></member>
<member><xref linkend="cluster-progress-reporting"/></member>
</simplelist>
</refsect1>
</refentry>

View File

@ -82,6 +82,12 @@ COPY { <replaceable class="parameter">table_name</replaceable> [ ( <replaceable
specified, data is transmitted via the connection between the
client and the server.
</para>
<para>
Each backend running <command>COPY</command> will report its progress
in the <structname>pg_stat_progress_copy</structname> view. See
<xref linkend="copy-progress-reporting"/> for details.
</para>
</refsect1>
<refsect1>
@ -1052,4 +1058,12 @@ COPY [ BINARY ] <replaceable class="parameter">table_name</replaceable>
[ WITH NULL AS '<replaceable class="parameter">null_string</replaceable>' ]
</synopsis></para>
</refsect1>
<refsect1>
<title>See Also</title>
<simplelist type="inline">
<member><xref linkend="copy-progress-reporting"/></member>
</simplelist>
</refsect1>
</refentry>

View File

@ -867,6 +867,12 @@ Indexes:
will interpret it as <literal>USING gist</literal>, to simplify conversion
of old databases to GiST.
</para>
<para>
Each backend running <command>CREATE INDEX</command> will report its
progress in the <structname>pg_stat_progress_create_index</structname>
view. See <xref linkend="create-index-progress-reporting"/> for details.
</para>
</refsect1>
<refsect1>
@ -980,6 +986,7 @@ CREATE INDEX CONCURRENTLY sales_quantity_index ON sales_table (quantity);
<member><xref linkend="sql-alterindex"/></member>
<member><xref linkend="sql-dropindex"/></member>
<member><xref linkend="sql-reindex"/></member>
<member><xref linkend="create-index-progress-reporting"/></member>
</simplelist>
</refsect1>
</refentry>

View File

@ -904,6 +904,7 @@ PostgreSQL documentation
<simplelist type="inline">
<member><xref linkend="app-pgdump"/></member>
<member><xref linkend="basebackup-progress-reporting"/></member>
</simplelist>
</refsect1>

View File

@ -495,6 +495,12 @@ Indexes:
is reindexed concurrently, those indexes will be skipped. (It is possible
to reindex such indexes without the <command>CONCURRENTLY</command> option.)
</para>
<para>
Each backend running <command>REINDEX</command> will report its progress
in the <structname>pg_stat_progress_create_index</structname> view. See
<xref linkend="create-index-progress-reporting"/> for details.
</para>
</refsect2>
</refsect1>
@ -553,6 +559,7 @@ REINDEX TABLE CONCURRENTLY my_broken_table;
<member><xref linkend="sql-createindex"/></member>
<member><xref linkend="sql-dropindex"/></member>
<member><xref linkend="app-reindexdb"/></member>
<member><xref linkend="create-index-progress-reporting"/></member>
</simplelist>
</refsect1>
</refentry>

View File

@ -393,6 +393,15 @@ VACUUM [ FULL ] [ FREEZE ] [ VERBOSE ] [ ANALYZE ] [ <replaceable class="paramet
information about automatic and manual vacuuming, see
<xref linkend="routine-vacuuming"/>.
</para>
<para>
Each backend running <command>VACUUM</command> without the
<literal>FULL</literal> option will report its progress in the
<structname>pg_stat_progress_vacuum</structname> view. Backends running
<command>VACUUM FULL</command> will instead report their progress in the
<structname>pg_stat_progress_cluster</structname> view. See
<xref linkend="vacuum-progress-reporting"/> and
<xref linkend="cluster-progress-reporting"/> for details.
</para>
</refsect1>
<refsect1>
@ -422,6 +431,8 @@ VACUUM (VERBOSE, ANALYZE) onek;
<member><xref linkend="app-vacuumdb"/></member>
<member><xref linkend="runtime-config-resource-vacuum-cost"/></member>
<member><xref linkend="autovacuum"/></member>
<member><xref linkend="vacuum-progress-reporting"/></member>
<member><xref linkend="cluster-progress-reporting"/></member>
</simplelist>
</refsect1>
</refentry>