postgres.git / summary / log / commit / refs

commit    1a1e733b623108ebba8a6e6f55235782edb8f4bb
Author:   Michael Paquier <michael@paquier.xyz>
Date:     Thu Jan 22 08:03:21 2026 +0000

    doc: List all the possible values of pg_stat_wal_receiver.status
    
    The possible values of pg_stat_wal_receiver.status have never been
    documented.  Note that the status "stopped" will never show up in this
    view, hence there is no need to document it.
    
    Issue noticed while discussing a patch that aims to add a new status to
    WAL receiver.
    
    Author: Xuneng Zhou <xunengzhou@gmail.com>
    Discussion: https://postgr.es/m/CABPTF7X_Jgmyk1FBVNf3tyAOKqU55LLpLMzWkGtEAb_jQWVN=g@mail.gmail.com


 doc/src/sgml/monitoring.sgml | 33 ++++++++++++++++++++++++++++++++-
 1 file changed, 32 insertions(+), 1 deletion(-)

diff --git a/doc/src/sgml/monitoring.sgml b/doc/src/sgml/monitoring.sgml
index 817fd9f4ca7..88450facebd 100644
--- a/doc/src/sgml/monitoring.sgml
+++ b/doc/src/sgml/monitoring.sgml
@@ -1737,7 +1737,38 @@ description | Waiting for a newly initialized WAL file to reach durable storage
        <structfield>status</structfield> <type>text</type>
       </para>
       <para>
-       Activity status of the WAL receiver process
+       Activity status of the WAL receiver process. Possible values are:
+       <itemizedlist>
+        <listitem>
+         <para>
+          <literal>restarting</literal>: WAL receiver has been asked to
+          restart streaming.
+         </para>
+        </listitem>
+        <listitem>
+         <para>
+          <literal>starting</literal>: WAL receiver process has been launched
+          but is not yet initialized.
+         </para>
+        </listitem>
+        <listitem>
+         <para>
+          <literal>stopping</literal>: WAL receiver has been requested to
+          stop.
+         </para>
+        </listitem>
+        <listitem>
+         <para>
+          <literal>streaming</literal>: WAL receiver is streaming WAL data.
+         </para>
+        </listitem>
+        <listitem>
+         <para>
+          <literal>waiting</literal>: WAL receiver has stopped streaming and
+          is waiting for new instructions from the startup process.
+         </para>
+        </listitem>
+       </itemizedlist>
       </para></entry>
      </row>
 


[parent: 25be5e8a3323]