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

diff --git a/doc/src/sgml/ref/analyze.sgml b/doc/src/sgml/ref/analyze.sgml
index 7d816c87c6030155512edcbcf1423d0a4162cc34..c8fcebc1612e47e782b8b21473f8439e3fc87a97 100644 (file)
--- a/doc/src/sgml/ref/analyze.sgml
+++ b/doc/src/sgml/ref/analyze.sgml
@@ -273,6 +273,12 @@ ANALYZE [ VERBOSE ] [ table_and_columns
     will not record new statistics for that table.  Any existing statistics
     will be retained.
   
+
+  
+    Each backend running ANALYZE will report its progress
+    in the pg_stat_progress_analyze view. See
+     for details.
+  
  
 
  
@@ -291,6 +297,7 @@ ANALYZE [ VERBOSE ] [ table_and_columns
    
    
    
+   
   
  
 

diff --git a/doc/src/sgml/ref/cluster.sgml b/doc/src/sgml/ref/cluster.sgml
index 5dd21a0189f4cfa144a8a6a7f599dfa45673b961..0d9720fd8e6c78226f97a1b55b07db58ededcb70 100644 (file)
--- a/doc/src/sgml/ref/cluster.sgml
+++ b/doc/src/sgml/ref/cluster.sgml
@@ -192,6 +192,11 @@ CLUSTER [VERBOSE]
     are periodically reclustered.
    
 
+  
+    Each backend running CLUSTER will report its progress
+    in the pg_stat_progress_cluster view. See
+     for details.
+  
  
 
  
@@ -242,6 +247,7 @@ CLUSTER index_name ON 
 
   
    
+   
   
  
 

diff --git a/doc/src/sgml/ref/copy.sgml b/doc/src/sgml/ref/copy.sgml
index 0fca6583af63ece1760f472e7a1c4b6bacb9d637..aea2eb8386ad6a948ad4d8d774f7ccf290a0cdf8 100644 (file)
--- a/doc/src/sgml/ref/copy.sgml
+++ b/doc/src/sgml/ref/copy.sgml
@@ -82,6 +82,12 @@ COPY { table_name [ ( 
    specified, data is transmitted via the connection between the
    client and the server.
   
+
+  
+    Each backend running COPY will report its progress
+    in the pg_stat_progress_copy view. See
+     for details.
+  
  
 
  
@@ -1052,4 +1058,12 @@ COPY [ BINARY ] table_name
     [ WITH NULL AS 'null_string' ]
 
  
+
+ 
+  See Also
+
+  
+   
+  
+ 
 

diff --git a/doc/src/sgml/ref/create_index.sgml b/doc/src/sgml/ref/create_index.sgml
index 965dcf472cacc4775c1cb691c5afc7c83f6e3619..51b4d579399d1b1b983c1eb74892b496c5be452d 100644 (file)
--- a/doc/src/sgml/ref/create_index.sgml
+++ b/doc/src/sgml/ref/create_index.sgml
@@ -867,6 +867,12 @@ Indexes:
    will interpret it as USING gist, to simplify conversion
    of old databases to GiST.
   
+
+  
+    Each backend running CREATE INDEX will report its
+    progress in the pg_stat_progress_create_index
+    view. See  for details.
+  
  
 
  
@@ -980,6 +986,7 @@ CREATE INDEX CONCURRENTLY sales_quantity_index ON sales_table (quantity);
    
    
    
+   
   
  
 

diff --git a/doc/src/sgml/ref/pg_basebackup.sgml b/doc/src/sgml/ref/pg_basebackup.sgml
index 5754ad5aa6bd4f5571821d36aeb1663706c6652d..14cc88a85229527ee731e9f9ba2290f15c8de405 100644 (file)
--- a/doc/src/sgml/ref/pg_basebackup.sgml
+++ b/doc/src/sgml/ref/pg_basebackup.sgml
@@ -904,6 +904,7 @@ PostgreSQL documentation
 
   
    
+   
   
  
 

diff --git a/doc/src/sgml/ref/reindex.sgml b/doc/src/sgml/ref/reindex.sgml
index b22d39eba929e38080b954687c658f2e65524122..ff4dba8c3631b48e52d12e8bc630fcfe527ab998 100644 (file)
--- a/doc/src/sgml/ref/reindex.sgml
+++ b/doc/src/sgml/ref/reindex.sgml
@@ -495,6 +495,12 @@ Indexes:
     is reindexed concurrently, those indexes will be skipped.  (It is possible
     to reindex such indexes without the CONCURRENTLY option.)
    
+
+  
+    Each backend running REINDEX will report its progress
+    in the pg_stat_progress_create_index view. See
+     for details.
+  
   
  
 
@@ -553,6 +559,7 @@ REINDEX TABLE CONCURRENTLY my_broken_table;
    
    
    
+   
   
  
 

diff --git a/doc/src/sgml/ref/vacuum.sgml b/doc/src/sgml/ref/vacuum.sgml
index 4bb624979bdf46aeef5119e2705ecc518716de7c..bb1c0f8fb6f1c27271f37565386ad67fd68b7c57 100644 (file)
--- a/doc/src/sgml/ref/vacuum.sgml
+++ b/doc/src/sgml/ref/vacuum.sgml
@@ -393,6 +393,15 @@ VACUUM [ FULL ] [ FREEZE ] [ VERBOSE ] [ ANALYZE ] [ 
     information about automatic and manual vacuuming, see
     .
    
+   
+    Each backend running VACUUM without the
+    FULL option will report its progress in the
+    pg_stat_progress_vacuum view. Backends running
+    VACUUM FULL will instead report their progress in the
+    pg_stat_progress_cluster view. See 
+     and
+     for details.
+   
  
 
  
@@ -422,6 +431,8 @@ VACUUM (VERBOSE, ANALYZE) onek;
    
    
    
+   
+