rdelaage
/
postgresql
mirror of https://git.postgresql.org/git/postgresql.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Mention pg_promote() as a method to trigger promotion in documentation. 

Previously in the "Standby Server Operation" section, pg_ctl promote and
protmote_trigger_file were documented as a method to trigger standby
promotion, but pg_promote() function not.

This commit also adds parentheses into <function>pg_promote</function>
in some docs to make it clearer that a function is being referred to.

Author: Masahiro Ikeda
Reviewed-by: Michael Paquier, Laurenz Albe, Tom Lane, Fujii Masao
Discussion: https://postgr.es/m/de0068417a9f4046bac693cbcc00bdc9@oss.nttdata.com
This commit is contained in:
Fujii Masao 2020-04-21 14:05:43 +09:00
parent f192312dc0
commit 67f82e966b
2 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/src/sgml/config.sgml
View File

@ -4114,7 +4114,7 @@ ANY <replaceable class="parameter">num_sync</replaceable> ( <replaceable class="
Specifies a trigger file whose presence ends recovery in the Specifies a trigger file whose presence ends recovery in the
standby. Even if this value is not set, you can still promote standby. Even if this value is not set, you can still promote
the standby using <command>pg_ctl promote</command> or calling the standby using <command>pg_ctl promote</command> or calling
<function>pg_promote</function>. <function>pg_promote()</function>.
This parameter can only be set in the <filename>postgresql.conf</filename> This parameter can only be set in the <filename>postgresql.conf</filename>
file or on the server command line. file or on the server command line.
</para> </para>

7
doc/src/sgml/high-availability.sgml
View File

@ -644,7 +644,8 @@ protocol to make nodes agree on a serializable transactional order.
<para> <para>
Standby mode is exited and the server switches to normal operation Standby mode is exited and the server switches to normal operation
when <command>pg_ctl promote</command> is run or a trigger file is found when <command>pg_ctl promote</command> is run,
<function>pg_promote()</function> is called, or a trigger file is found
(<varname>promote_trigger_file</varname>). Before failover, (<varname>promote_trigger_file</varname>). Before failover,
any WAL immediately available in the archive or in <filename>pg_wal</filename> will be any WAL immediately available in the archive or in <filename>pg_wal</filename> will be
restored, but no attempt is made to connect to the master. restored, but no attempt is made to connect to the master.
@ -1470,11 +1471,11 @@ synchronous_standby_names = 'ANY 2 (s1, s2, s3)'
<para> <para>
To trigger failover of a log-shipping standby server, run To trigger failover of a log-shipping standby server, run
<command>pg_ctl promote</command>, call <function>pg_promote</function>, <command>pg_ctl promote</command>, call <function>pg_promote()</function>,
or create a trigger file with the file name and path specified by the or create a trigger file with the file name and path specified by the
<varname>promote_trigger_file</varname>. If you're planning to use <varname>promote_trigger_file</varname>. If you're planning to use
<command>pg_ctl promote</command> or to call <command>pg_ctl promote</command> or to call
<function>pg_promote</function> to fail over, <function>pg_promote()</function> to fail over,
<varname>promote_trigger_file</varname> is not required. If you're <varname>promote_trigger_file</varname> is not required. If you're
setting up the reporting servers that are only used to offload read-only setting up the reporting servers that are only used to offload read-only
queries from the primary, not for high availability purposes, you don't queries from the primary, not for high availability purposes, you don't