8000 doc: Add backlinks to progress reporting documentation · postgrespro/postgres@8a8f4d8 · GitHub
[go: up one dir, main page]
Skip to content

Commit 8a8f4d8

Browse files
mi 8000 chaelpqmichaelpq
committed
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
1 parent 5bca69a commit 8a8f4d8

File tree

7 files changed

+53
-0
lines changed

7 files changed

+53
-0
lines changed

‎doc/src/sgml/ref/analyze.sgml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -273,6 +273,12 @@ ANALYZE [ VERBOSE ] [ <replaceable class="parameter">table_and_columns</replacea
273273
will not record new statistics for that table. Any existing statistics
274274
will be retained.
275275
</para>
276+
277+
<para>
278+
Each backend running <command>ANALYZE</command> will report its progress
279+
in the <structname>pg_stat_progress_analyze</structname> view. See
280+
<xref linkend="analyze-progress-reporting"/> for details.
281+
</para>
276282
</refsect1>
277283

278284
<refsect1>
@@ -291,6 +297,7 @@ ANALYZE [ VERBOSE ] [ <replaceable class="parameter">table_and_columns</replacea
291297
<member><xref linkend="app-vacuumdb"/></member>
292298
<member><xref linkend="runtime-config-resource-vacuum-cost"/></member>
293299
<member><xref linkend="autovacuum"/></member>
300+
<member><xref linkend="analyze-progress-reporting"/></member>
294301
</simplelist>
295302
</refsect1>
296303
</refentry>

‎doc/src/sgml/ref/cluster.sgml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,11 @@ CLUSTER [VERBOSE]
192192
are periodically reclustered.
193193
</para>
194194

195+
<para>
196+
Each backend running <command>CLUSTER</command> will report its progress
197+
in the <structname>pg_stat_progress_cluster</structname> view. See
198+
<xref linkend="cluster-progress-reporting"/> for details.
199+
</para>
195200
</refsect1>
196201

197202
<refsect1>
@@ -242,6 +247,7 @@ CLUSTER <replaceable class="parameter">index_name</replaceable> ON <replaceable
242247

243248
<simplelist type="inline">
244249
<member><xref linkend="app-clusterdb"/></member>
250+
<member><xref linkend="cluster-progress-reporting"/></member>
245251
</simplelist>
246252
</refsect1>
247253
</refentry>

‎doc/src/sgml/ref/copy.sgml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,12 @@ COPY { <replaceable class="parameter">table_name</replaceable> [ ( <replaceable
8282
specified, data is transmitted via the connection between the
8383
client and the server.
8484
</para>
85+
86+
<para>
87+
Each backend running <command>COPY</command> will report its progress
88+
in the <structname>pg_stat_progress_copy</structname> view. See
89+
<xref linkend="copy-progress-reporting"/> for details.
90+
</para>
8591
</refsect1>
8692

8793
<refsect1>
@@ -1052,4 +1058,12 @@ COPY [ BINARY ] <replaceable class="parameter">table_name</replaceable>
10521058
[ WITH NULL AS '<replaceable class="parameter">null_string</replaceable>' ]
10531059
</synopsis></para>
10541060
</refsect1>
1061+
1062+
<refsect1>
1063+
<title>See Also</title>
1064+
1065+
<simplelist type="inline">
1066+
<member><xref linkend="copy-progress-reporting"/></member>
1067+
</simplelist>
1068+
</refsect1>
10551069
</refentry>

‎doc/src/sgml/ref/create_index.sgml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -867,6 +867,12 @@ Indexes:
867867
will interpret it as <literal>USING gist</literal>, to simplify conversion
868868
of old databases to GiST.
869869
</para>
870+
871+
<para>
872+
Each backend running <command>CREATE INDEX</command> will report its
873+
progress in the <structname>pg_stat_progress_create_index</structname>
874+
view. See <xref linkend="create-index-progress-reporting"/> for details.
875+
</para>
870876
</refsect1>
871877

872878
<refsect1>
@@ -980,6 +986,7 @@ CREATE INDEX CONCURRENTLY sales_quantity_index ON sales_table (quantity);
980986
<member><xref linkend="sql-alterindex"/></member>
981987
<member><xref linkend="sql-dropindex"/></member>
982988
<member><xref linkend="sql-reindex"/></member>
989+
<member><xref linkend="create-index-progress-reporting"/></member>
983990
</simplelist>
984991
</refsect1>
985992
</refentry>

‎doc/src/sgml/ref/pg_basebackup.sgml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -904,6 +904,7 @@ PostgreSQL documentation
904904

905905
<simplelist type="inline">
906906
<member><xref linkend="app-pgdump"/></member>
907+
<member><xref linkend="basebackup-progress-reporting"/></member>
907908
</simplelist>
908909
</refsect1>
909910

‎doc/src/sgml/ref/reindex.sgml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -495,6 +495,12 @@ Indexes:
495495
is reindexed concurrently, those indexes will be skipped. (It is possible
496496
to reindex such indexes without the <command>CONCURRENTLY</command> option.)
497497
</para>
498+
499+
<para>
500+
Each backend running <command>REINDEX</command> will report its progress
501+
in the <structname>pg_stat_progress_create_index</structname> view. See
502+
<xref linkend="create-index-progress-reporting"/> for details.
503+
</para>
498504
</refsect2>
499505
</refsect1>
500506

@@ -553,6 +559,7 @@ REINDEX TABLE CONCURRENTLY my_broken_table;
553559
<member><xref linkend="sql-createindex"/></member>
554560
<member><xref linkend="sql-dropindex"/></member>
555561
<member><xref linkend="app-reindexdb"/></member>
562+
<member><xref linkend="create-index-progress-reporting"/></member>
556563
</simplelist>
557564
</refsect1>
558565
</refentry>

‎doc/src/sgml/ref/vacuum.sgml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -393,6 +393,15 @@ VACUUM [ FULL ] [ FREEZE ] [ VERBOSE ] [ ANALYZE ] [ <replaceable class="paramet
393393
information about automatic and manual vacuuming, see
394394
<xref linkend="routine-vacuuming"/>.
395395
</para>
396+
<para>
397+
Each backend running <command>VACUUM</command> without the
398+
<literal>FULL</literal> option will report its progress in the
399+
<structname>pg_stat_progress_vacuum</structname> view. Backends running
400+
<command>VACUUM FULL</command> will instead report their progress in the
401+
<structname>pg_stat_progress_cluster</structname> view. See
402+
<xref linkend="vacuum-progress-reporting"/> and
403+
<xref linkend="cluster-progress-reporting"/> for details.
404+
</para>
396405
</refsect1>
397406

398407
<refsect1>
@@ -422,6 +431,8 @@ VACUUM (VERBOSE, ANALYZE) onek;
422431
<member><xref linkend="app-vacuumdb"/></member>
423432
<member><xref linkend="runtime-config-resource-vacuum-cost"/></member>
424433
<member><xref linkend="autovacuum"/></member>
434+
<member><xref linkend="vacuum-progress-reporting"/></member>
435+
<member><xref linkend="cluster-progress-reporting"/></member>
425436
</simplelist>
426437
</refsect1>
427438
</refentry>

0 commit comments

Comments
 (0)
0