some comments rewording in recovery.conf.sample about SR

Started by Jehan-Guillaume (ioguix) de Rorthaisabout 15 years ago4 messages

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hello Hackers,

I believe comments in the recovery.conf.sample are somehow confusing
about standby and SR:

# Edit this file to provide the parameters that PostgreSQL needs to
# perform an archive recovery of a database, or to act as a log-streaming
# replication standby.

It seems incomplete. It doesn't recover OR act as a log-streaming
replication standby. It can behave as a standby node without SR as well.

# When standby_mode is enabled, the PostgreSQL server will work as
# a standby. It tries to connect to the primary according to the
# connection settings primary_conninfo, and receives XLOG records
# continuously.

This one is quite unclear as well. We might think that once we are in
standby_mode we will be in SR. Again, we can use the standby_mode
without primary_conninfo. This parameter only allows to keep the cluster
in recovery, it doesn't imply to set up the SR.

# By default, a standby server keeps streaming XLOG records from the
# primary indefinitely.

Same story...

Please, find in attachment a proposal of rewording.

Comments ?

Regards,
- --
Jehan-Guillaume (ioguix) de Rorthais
www.dalibo.org

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.10 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iEYEARECAAYFAk0nBWAACgkQxWGfaAgowiJRlACfcXwFiGr1LlYuAPjwnOLIvoHl
SEAAoJbtNqG4bk1+htYKd9KALKCv/wCt
=q/x/
-----END PGP SIGNATURE-----

In reply to: Jehan-Guillaume (ioguix) de Rorthais (#1)
1 attachment(s)
Re: some comments rewording in recovery.conf.sample about SR

Obviously...

PFA

Le 07/01/2011 13:22, Jehan-Guillaume (ioguix) de Rorthais a écrit :

Show quoted text

Hello Hackers,

I believe comments in the recovery.conf.sample are somehow confusing
about standby and SR:

# Edit this file to provide the parameters that PostgreSQL needs to
# perform an archive recovery of a database, or to act as a log-streaming
# replication standby.

It seems incomplete. It doesn't recover OR act as a log-streaming
replication standby. It can behave as a standby node without SR as well.

# When standby_mode is enabled, the PostgreSQL server will work as
# a standby. It tries to connect to the primary according to the
# connection settings primary_conninfo, and receives XLOG records
# continuously.

This one is quite unclear as well. We might think that once we are in
standby_mode we will be in SR. Again, we can use the standby_mode
without primary_conninfo. This parameter only allows to keep the cluster
in recovery, it doesn't imply to set up the SR.

# By default, a standby server keeps streaming XLOG records from the
# primary indefinitely.

Same story...

Please, find in attachment a proposal of rewording.

Comments ?

Regards,

Attachments:

fix_recovery_conf_sample_comments_about_SR-1.patchtext/x-patch; name=fix_recovery_conf_sample_comments_about_SR-1.patchDownload
diff --git a/src/backend/access/transam/recovery.conf.sample b/src/backend/access/transam/recovery.conf.sample
index 146ad03..9a68fb0 100644
--- a/src/backend/access/transam/recovery.conf.sample
+++ b/src/backend/access/transam/recovery.conf.sample
@@ -3,8 +3,8 @@
 # -------------------------------
 #
 # Edit this file to provide the parameters that PostgreSQL needs to
-# perform an archive recovery of a database, or to act as a log-streaming
-# replication standby.
+# perform an archive recovery of a database, or to act as a log replication
+# standby, optionnaly streamed.
 #
 # If "recovery.conf" is present in the PostgreSQL data directory, it is
 # read on postmaster startup.  After successful recovery, it is renamed
@@ -88,21 +88,29 @@
 # STANDBY SERVER PARAMETERS
 #---------------------------------------------------------------------------
 #
-# When standby_mode is enabled, the PostgreSQL server will work as
-# a standby. It tries to connect to the primary according to the
-# connection settings primary_conninfo, and receives XLOG records
-# continuously.
+# standby_mode
+#
+# When standby_mode is enabled, the PostgreSQL server will work as a
+# standby. It will keep waiting for the next XLOG records, either using the
+# restore_command and/or primary_conninfo depending on their setting, and
+# never start as a primary server by itself.
 #
 #standby_mode = off
 #
+# primary_conninfo
+#
+# When primary_conninfo is set, the PostgreSQL server tries to connect to
+# the primary using this connection string and receives XLOG records
+# continuously.
+#
 #primary_conninfo = ''		# e.g. 'host=localhost port=5432'
 #
 #
-# By default, a standby server keeps streaming XLOG records from the
-# primary indefinitely. If you want to stop streaming and finish recovery,
+# By default, a standby server keeps restoring XLOG records from the primary
+# indefinitely. If you want to stop the standby mode, finish recovery and
 # opening up the system in read/write mode, specify path to a trigger file.
-# Server will poll the trigger file path periodically and stop streaming
-# when it's found.
+# Server will poll the trigger file path periodically and start as a primary
+# server when it's found.
 #
 #trigger_file = ''
 #
#3Robert Haas
robertmhaas@gmail.com
In reply to: Jehan-Guillaume (ioguix) de Rorthais (#2)
Re: some comments rewording in recovery.conf.sample about SR

On Fri, Jan 7, 2011 at 7:23 AM, Jehan-Guillaume (ioguix) de Rorthais
<ioguix@free.fr> wrote:

PFA

Committed, with some additional wordsmithing.

--
Robert Haas
EnterpriseDB: http://www.enterprisedb.com
The Enterprise PostgreSQL Company

In reply to: Robert Haas (#3)
Re: some comments rewording in recovery.conf.sample about SR

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Le 07/01/2011 16:58, Robert Haas a �crit :

On Fri, Jan 7, 2011 at 7:23 AM, Jehan-Guillaume (ioguix) de Rorthais
<ioguix@free.fr> wrote:

PFA

Committed, with some additional wordsmithing.

Thank you !
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.10 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iEYEARECAAYFAk0nS6sACgkQxWGfaAgowiL8ewCeNmThauDgdrJzp6npSSRCFroC
q0cAn2gnjSYH6g4Oodvre6trADT01RON
=6aSt
-----END PGP SIGNATURE-----