From 15a8010ed691f190aad19c0a205f4a17868591e9 Mon Sep 17 00:00:00 2001 From: Peter Eisentraut Date: Tue, 26 Sep 2017 11:58:22 -0400 Subject: Sort pg_basebackup options better The --slot option somehow ended up under options controlling the output, and some other options were in a nonsensical place or were not moved after recent renamings, so tidy all that up a bit. --- doc/src/sgml/ref/pg_basebackup.sgml | 100 ++++++++++++++++++------------------ 1 file changed, 50 insertions(+), 50 deletions(-) (limited to 'doc/src') diff --git a/doc/src/sgml/ref/pg_basebackup.sgml b/doc/src/sgml/ref/pg_basebackup.sgml index 2454d35af39..b7aa128f7f7 100644 --- a/doc/src/sgml/ref/pg_basebackup.sgml +++ b/doc/src/sgml/ref/pg_basebackup.sgml @@ -226,48 +226,6 @@ PostgreSQL documentation - - - - - - This option can only be used together with -X - stream. It causes the WAL streaming to use the specified - replication slot. If the base backup is intended to be used as a - streaming replication standby using replication slots, it should then - use the same replication slot name - in recovery.conf. That way, it is ensured that - the server does not remove any necessary WAL data in the time between - the end of the base backup and the start of streaming replication. - - - If this option is not specified and the server supports temporary - replication slots (version 10 and later), then a temporary replication - slot is automatically used for WAL streaming. - - - - - - - - - This option prevents the creation of a temporary replication slot - during the backup even if it's supported by the server. - - - Temporary replication slots are created by default if no slot name - is given with the option when using log streaming. - - - The main purpose of this option is to allow taking a base backup when - the server is out of free replication slots. Using replication slots - is almost always preferred, because it prevents needed WAL from being - removed by the server during the backup. - - - - @@ -453,6 +411,21 @@ PostgreSQL documentation + + + + + + By default, pg_basebackup will wait for all files + to be written safely to disk. This option causes + pg_basebackup to return without waiting, which is + faster, but means that a subsequent operating system crash can leave + the base backup corrupt. Generally, this option is useful for testing + but should not be used when creating a production installation. + + + + @@ -476,16 +449,43 @@ PostgreSQL documentation - - + + - By default, pg_basebackup will wait for all files - to be written safely to disk. This option causes - pg_basebackup to return without waiting, which is - faster, but means that a subsequent operating system crash can leave - the base backup corrupt. Generally, this option is useful for testing - but should not be used when creating a production installation. + This option can only be used together with -X + stream. It causes the WAL streaming to use the specified + replication slot. If the base backup is intended to be used as a + streaming replication standby using replication slots, it should then + use the same replication slot name + in recovery.conf. That way, it is ensured that + the server does not remove any necessary WAL data in the time between + the end of the base backup and the start of streaming replication. + + + If this option is not specified and the server supports temporary + replication slots (version 10 and later), then a temporary replication + slot is automatically used for WAL streaming. + + + + + + + + + This option prevents the creation of a temporary replication slot + during the backup even if it's supported by the server. + + + Temporary replication slots are created by default if no slot name + is given with the option when using log streaming. + + + The main purpose of this option is to allow taking a base backup when + the server is out of free replication slots. Using replication slots + is almost always preferred, because it prevents needed WAL from being + removed by the server during the backup. -- cgit v1.2.3