From: Robert Haas <rhaas@postgresql.org>
Date: Thu, 17 Mar 2011 18:02:41 +0000 (-0400)
Subject: Add pause_at_recovery_target to recovery.conf.sample; improve docs.
X-Git-Tag: REL9_1_ALPHA5~70
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=84abea76f60c5fd1c008b8ddf250b4bc89e288fc;p=postgresql

Add pause_at_recovery_target to recovery.conf.sample; improve docs.

Fujii Masao, but with the proposed behavior change reverted, and the
rest adjusted accordingly.
---

diff --git a/doc/src/sgml/recovery-config.sgml b/doc/src/sgml/recovery-config.sgml
index e9e95acb8d..7f515dc011 100644
--- a/doc/src/sgml/recovery-config.sgml
+++ b/doc/src/sgml/recovery-config.sgml
@@ -261,7 +261,7 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"'  # Windows
       <listitem>
        <para>
         Specifies whether recovery should pause when the recovery target
-        is reached. The default is true, if a recovery target is set.
+        is reached. The default is true.
         This is intended to allow queries to be executed against the
         database to check if this recovery target is the most desirable
         point for recovery. The paused state can be resumed by using
@@ -272,6 +272,10 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"'  # Windows
         recovery target settings to a later target and restart to
         continue recovery.
        </para>
+       <para>
+        This setting has no effect if <xref linkend="guc-hot-standby"> is not
+        enabled, or if no recovery target is set.
+       </para>
       </listitem>
      </varlistentry>
 
diff --git a/src/backend/access/transam/recovery.conf.sample b/src/backend/access/transam/recovery.conf.sample
index 0243b51fdf..229c749f17 100644
--- a/src/backend/access/transam/recovery.conf.sample
+++ b/src/backend/access/transam/recovery.conf.sample
@@ -87,6 +87,14 @@
 #
 #recovery_target_timeline = 'latest'
 #
+#
+# If pause_at_recovery_target is enabled, recovery will pause when
+# the recovery target is reached. The pause state will continue until
+# pg_xlog_replay_resume() is called. This setting has no effect if
+# hot standby is not enabled, or if no recovery target is set.
+#
+#pause_at_recovery_target = true
+#
 #---------------------------------------------------------------------------
 # STANDBY SERVER PARAMETERS
 #---------------------------------------------------------------------------