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

Commit 0ecc880

Browse files
committed
doc: Fix obsolete description about pg_basebackup.
Previously it was documented that if using "-X none" option there was no guarantee that all required WAL files were archived at the end of pg_basebackup when taking a backup from the standby. But this limitation was removed by commit 52f8a59. Now, even when taking a backup from the standby, pg_basebackup can wait for all required WAL files to be archived. Therefore this commit removes such obsolete description from the docs. Also this commit adds new description about the limitation when taking a backup from the standby, into the docs. The limitation is that pg_basebackup cannot force the standbfy to switch to a new WAL file at the end of backup, which may cause pg_basebackup to wait a long time for the last required WAL file to be switched and archived, especially when write activity on the primary is low. Back-patch to v10 where the issue was introduced. Reported-by: Kyotaro Horiguchi Author: Kyotaro Horiguchi, Fujii Masao Reviewed-by: Kyotaro Horiguchi, Fujii Masao Discussion: https://postgr.es/m/20210420.133235.1342729068750553399.horikyota.ntt@gmail.com
1 parent 05ce4bf commit 0ecc880

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

doc/src/sgml/ref/pg_basebackup.sgml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,14 @@ PostgreSQL documentation
8585
</listitem>
8686
<listitem>
8787
<para>
88-
If you are using <literal>-X none</literal>, there is no guarantee that all
89-
WAL files required for the backup are archived at the end of backup.
88+
<application>pg_basebackup</application> cannot force the standby
89+
to switch to a new WAL file at the end of backup.
90+
When you are using <literal>-X none</literal>, if write activity on
91+
the primary is low, <application>pg_basebackup</application> may
92+
need to wait a long time for the last WAL file required for the backup
93+
to be switched and archived. In this case, it may be useful to run
94+
<function>pg_switch_wal</function> on the primary in order to
95+
trigger an immediate WAL file switch.
9096
</para>
9197
</listitem>
9298
<listitem>

0 commit comments

Comments
 (0)