pgsql: doc: Fix obsolete description about pg_basebackup. - Mailing list pgsql-committers

From Fujii Masao
Subject pgsql: doc: Fix obsolete description about pg_basebackup.
Date
Msg-id E1lZpcm-0001Gk-Dj@gemulon.postgresql.org
Whole thread Raw
List pgsql-committers
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 52f8a59dd9. 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

Branch
------
REL_10_STABLE

Details
-------
https://git.postgresql.org/pg/commitdiff/d59964999d15be29fcd97544e66780fc5c9f17a9

Modified Files
--------------
doc/src/sgml/ref/pg_basebackup.sgml | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)


pgsql-committers by date:

Previous
From: Peter Eisentraut
Date:
Subject: pgsql: Fix incorrect format placeholder
Next
From: Fujii Masao
Date:
Subject: pgsql: doc: Fix obsolete description about pg_basebackup.