Commit affec9f6 authored by Michael Paquier's avatar Michael Paquier

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
parent 8cee4be6
...@@ -75,6 +75,29 @@ PostgreSQL documentation ...@@ -75,6 +75,29 @@ PostgreSQL documentation
one session available for the stream. one session available for the stream.
</para> </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> <para>
If the connection is lost, or if it cannot be initially established, If the connection is lost, or if it cannot be initially established,
with a non-fatal error, <application>pg_receivewal</application> will with a non-fatal error, <application>pg_receivewal</application> will
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment