From a630ac5c2016e523a1c29df117b7c1a563a7f6f8 Mon Sep 17 00:00:00 2001
From: =?utf8?q?=C3=81lvaro=20Herrera?= <alvherre@kurilemu.de>
Date: Thu, 12 Mar 2026 19:19:23 +0100
Subject: [PATCH] Document the 'command' column of pg_stat_progress_repack
MIME-Version: 1.0
Content-Type: text/plain; charset=utf8
Content-Transfer-Encoding: 8bit

Commit ac58465e0618 added and documented a new progress-report view for
REPACK, but neglected to list the 'command' column in the docs.  This is
my (Álvaro's) fail, as I added the column in v23 of the patch and forgot
to document it.

In passing, add a note in the docs for pg_stat_progress_cluster that it
might contain rows for sessions running REPACK, though mapping the
command name to either the older commands; and that it is for backwards-
compatibility only.  (Maybe we should just remove this older view.)

Author: Noriyoshi Shinoda <noriyoshi.shinoda@hpe.com>
Discussion: https://postgr.es/m/LV8PR84MB37870F0F35EF2E8CB99768CBEE47A@LV8PR84MB3787.NAMPRD84.PROD.OUTLOOK.COM
Discussion: https://postgr.es/m/202510101352.vvp4p3p2dblu@alvherre.pgsql
---
 doc/src/sgml/monitoring.sgml | 28 ++++++++++++++++++++++------
 1 file changed, 22 insertions(+), 6 deletions(-)

diff --git a/doc/src/sgml/monitoring.sgml b/doc/src/sgml/monitoring.sgml
index cc014564c97..3bf6d6d54df 100644
--- a/doc/src/sgml/monitoring.sgml
+++ b/doc/src/sgml/monitoring.sgml
@@ -407,7 +407,7 @@ postgres   27093  0.0  0.0  30096  2752 ?        Ss   11:34   0:00 postgres: ser
 
      <row>
       <entry><structname>pg_stat_progress_cluster</structname><indexterm><primary>pg_stat_progress_cluster</primary></indexterm></entry>
-      <entry>One row for each backend running
+      <entry>One row for each backend running <command>REPACK</command>,
        <command>CLUSTER</command> or <command>VACUUM FULL</command>, showing current progress.
        See <xref linkend="cluster-progress-reporting"/>.
       </entry>
@@ -415,8 +415,8 @@ postgres   27093  0.0  0.0  30096  2752 ?        Ss   11:34   0:00 postgres: ser
 
      <row>
       <entry><structname>pg_stat_progress_repack</structname><indexterm><primary>pg_stat_progress_repack</primary></indexterm></entry>
-      <entry>One row for each backend running
-       <command>REPACK</command>, showing current progress.  See
+      <entry>One row for each backend running <command>REPACK</command>,
+       <command>CLUSTER</command> or <command>VACUUM FULL</command>, showing current progress.
        <xref linkend="repack-progress-reporting"/>.
       </entry>
      </row>
@@ -6075,8 +6075,10 @@ FROM pg_stat_get_backend_idset() AS backendid;
   </indexterm>
 
   <para>
-   Whenever <command>CLUSTER</command> or <command>VACUUM FULL</command> is
-   running, the <structname>pg_stat_progress_cluster</structname> view will
+   Whenever <command>REPACK</command>, <command>CLUSTER</command> or
+   <command>VACUUM FULL</command> is running,
+   the backwards-compatibility <structname>pg_stat_progress_cluster</structname>
+   view will
    contain a row for each backend that is currently running either command.
    The tables below describe the information that will be reported and
    provide information about how to interpret it.
@@ -6138,7 +6140,11 @@ FROM pg_stat_get_backend_idset() AS backendid;
        <structfield>command</structfield> <type>text</type>
       </para>
       <para>
-       The command that is running. Either <literal>CLUSTER</literal> or <literal>VACUUM FULL</literal>.
+       The command that is running. Either <command>CLUSTER</command> or
+       <command>VACUUM FULL</command>.
+       Because this view exists for backwards-compatibility purposes only,
+       it will translate any <command>REPACK</command> command into one of
+       these other two.
       </para></entry>
      </row>
 
@@ -6805,6 +6811,16 @@ FROM pg_stat_get_backend_idset() AS backendid;
       </para></entry>
      </row>
 
+     <row>
+      <entry role="catalog_table_entry"><para role="column_definition">
+       <structfield>command</structfield> <type>text</type>
+      </para>
+      <para>
+       The command that is running. Either <command>REPACK</command> or
+       <command>VACUUM FULL</command>, or <command>CLUSTER</command>.
+      </para></entry>
+     </row>
+
      <row>
       <entry role="catalog_table_entry"><para role="column_definition">
        <structfield>phase</structfield> <type>text</type>
-- 
2.39.5