Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 1e94756

Browse files
committed
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
1 parent 92316a4 commit 1e94756

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

doc/src/sgml/ref/pg_receivewal.sgml

+23
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,29 @@ PostgreSQL documentation
7575
one session available for the stream.
7676
</para>
7777

78+
<para>
79+
The starting point of the write-ahead log streaming is calculated when
80+
<application>pg_receivewal</application> starts:
81+
<orderedlist>
82+
<listitem>
83+
<para>
84+
First, scan the directory where the WAL segment files are written and
85+
find the newest completed segment file, using as starting point the
86+
beginning of the next WAL segment file. This is calculated independently
87+
on the compression method used to compress each segment.
88+
</para>
89+
</listitem>
90+
91+
<listitem>
92+
<para>
93+
If a starting point cannot be calculated with the previous method,
94+
the latest WAL flush location is used as reported by the server from
95+
a <literal>IDENTIFY_SYSTEM</literal> command.
96+
</para>
97+
</listitem>
98+
</orderedlist>
99+
</para>
100+
78101
<para>
79102
If the connection is lost, or if it cannot be initially established,
80103
with a non-fatal error, <application>pg_receivewal</application> will

0 commit comments

Comments
 (0)