doc: Fix obsolete description about pg_basebackup.
authorFujii Masao <fujii@postgresql.org>
Fri, 23 Apr 2021 06:45:46 +0000 (15:45 +0900)
committerFujii Masao <fujii@postgresql.org>
Fri, 23 Apr 2021 06:45:46 +0000 (15:45 +0900)
commiteaec48b3c54eec222d64468b57af80ee4ddf76a9
tree26cfdc09c8df85286b034c816c2c02a55b71f97b
parent7776a23a4bdeb7215e4f8ddea5989cb143becc12
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
doc/src/sgml/ref/pg_basebackup.sgml