database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-07-28 23:42:10 +03:00
Code Activity

Improve recovery target settings documentation.

Browse Source 
Commit 815d71dee hadn't bothered to update the documentation to match the
behavioral change, and a lot of other text in this section was badly in
need of copy-editing.
This commit is contained in:
Tom Lane
2014-12-13 13:46:46 -05:00
parent 9ccae6360d
commit 5fc34ba880
1 changed files with 14 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
doc/src/sgml/recovery-config.sgml
View File

@ -152,16 +152,18 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"' # Windows
<sect1 id="recovery-target-settings"> <sect1 id="recovery-target-settings">
<title>Recovery Target Settings</title> <title>Recovery Target Settings</title>
<para> <para>
By default, recovery will recover to the end of the WAL log. The By default, recovery will recover to the end of the WAL log. The
following parameters can be used to specify an earlier stopping point. following parameters can be used to specify an earlier stopping point.
At most one of <varname>recovery_target</>, At most one of <varname>recovery_target</>,
<varname>recovery_target_name</>, <varname>recovery_target_time</>, or <varname>recovery_target_name</>, <varname>recovery_target_time</>, or
<varname>recovery_target_xid</> can be specified. <varname>recovery_target_xid</> can be used; if more than one of these
is specified in the configuration file, the last entry will be used.
</para> </para>
<variablelist>
<varlistentry id="recovery-target" xreflabel="recovery_target_name"> <variablelist>
<varlistentry id="recovery-target" xreflabel="recovery_target">
<term><varname>recovery_target</varname><literal> = 'immediate'</literal> <term><varname>recovery_target</varname><literal> = 'immediate'</literal>
<indexterm> <indexterm>
<primary><varname>recovery_target</> recovery parameter</primary> <primary><varname>recovery_target</> recovery parameter</primary>
@ -189,8 +191,8 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"' # Windows
</term> </term>
<listitem> <listitem>
<para> <para>
This parameter specifies the named restore point, created with This parameter specifies the named restore point (created with
<function>pg_create_restore_point()</> to which recovery will proceed. <function>pg_create_restore_point()</>) to which recovery will proceed.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -231,13 +233,13 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"' # Windows
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
<para> <para>
The following options further specify the recovery target, and affect The following options further specify the recovery target, and affect
what happens when the target is reached: what happens when the target is reached:
</para> </para>
<variablelist> <variablelist>
<varlistentry id="recovery-target-inclusive" <varlistentry id="recovery-target-inclusive"
xreflabel="recovery_target_inclusive"> xreflabel="recovery_target_inclusive">
<term><varname>recovery_target_inclusive</varname> (<type>boolean</type>) <term><varname>recovery_target_inclusive</varname> (<type>boolean</type>)
@ -247,12 +249,12 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"' # Windows
</term> </term>
<listitem> <listitem>
<para> <para>
Specifies whether we stop just after the specified recovery target Specifies whether to stop just after the specified recovery target
(<literal>true</literal>), or just before the recovery target (<literal>true</literal>), or just before the recovery target
(<literal>false</literal>). (<literal>false</literal>).
Applies to both <xref linkend="recovery-target-time"> Applies when either <xref linkend="recovery-target-time">
and <xref linkend="recovery-target-xid">, whichever one is or <xref linkend="recovery-target-xid"> is specified.
specified for this recovery. This indicates whether transactions This setting controls whether transactions
having exactly the target commit time or ID, respectively, will having exactly the target commit time or ID, respectively, will
be included in the recovery. Default is <literal>true</>. be included in the recovery. Default is <literal>true</>.
</para> </para>
@ -294,10 +296,10 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"' # Windows
This is intended to allow queries to be executed against the This is intended to allow queries to be executed against the
database to check if this recovery target is the most desirable database to check if this recovery target is the most desirable
point for recovery. The paused state can be resumed by using point for recovery. The paused state can be resumed by using
<function>pg_xlog_replay_resume()</> (See <function>pg_xlog_replay_resume()</> (see
<xref linkend="functions-recovery-control-table">), which then <xref linkend="functions-recovery-control-table">), which then
causes recovery to end. If this recovery target is not the causes recovery to end. If this recovery target is not the
desired stopping point, then shutdown the server, change the desired stopping point, then shut down the server, change the
recovery target settings to a later target and restart to recovery target settings to a later target and restart to
continue recovery. continue recovery.
</para> </para>