postgres.git / summary / log / commit / refs

commit    1e9475694b0ae2cf1204d01d2ef6ad86f3c7cac8
Author:   Michael Paquier <michael@paquier.xyz>
Date:     Sat Oct 23 05:43:03 2021 +0000
First released in: 15.0, 10.19, 11.14, 12.9, 13.5, 14.1

    doc: Describe calculation method of streaming start for pg_receivewal
    
    The documentation was imprecise about the starting LSN used for WAL
    streaming if nothing can be found in the local archive directory
    defined with the pg_receivewal command, so be more talkative on this
    matter.
    
    Extracted from a larger patch by the same author.
    
    Author: Ronan Dunklau, Michael Paquier
    Discussion: https://postgr.es/m/18708360.4lzOvYHigE@aivenronan
    Backpatch-through: 10


 doc/src/sgml/ref/pg_receivewal.sgml | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/doc/src/sgml/ref/pg_receivewal.sgml b/doc/src/sgml/ref/pg_receivewal.sgml
index 45b544cf498..6da8b2be8c0 100644
--- a/doc/src/sgml/ref/pg_receivewal.sgml
+++ b/doc/src/sgml/ref/pg_receivewal.sgml
@@ -75,6 +75,29 @@ PostgreSQL documentation
    one session available for the stream.
   </para>
 
+  <para>
+   The starting point of the write-ahead log streaming is calculated when
+   <application>pg_receivewal</application> starts:
+   <orderedlist>
+    <listitem>
+     <para>
+      First, scan the directory where the WAL segment files are written and
+      find the newest completed segment file, using as starting point the
+      beginning of the next WAL segment file. This is calculated independently
+      on the compression method used to compress each segment.
+     </para>
+    </listitem>
+
+    <listitem>
+     <para>
+      If a starting point cannot be calculated with the previous method,
+      the latest WAL flush location is used as reported by the server from
+      a <literal>IDENTIFY_SYSTEM</literal> command.
+     </para>
+    </listitem>
+   </orderedlist>
+  </para>
+
   <para>
    If the connection is lost, or if it cannot be initially established,
    with a non-fatal error, <application>pg_receivewal</application> will


[parent: 92316a4582a5]