Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 67f82e9

Browse files
committed
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
1 parent f192312 commit 67f82e9

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

doc/src/sgml/config.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4114,7 +4114,7 @@ ANY <replaceable class="parameter">num_sync</replaceable> ( <replaceable class="
41144114
Specifies a trigger file whose presence ends recovery in the
41154115
standby. Even if this value is not set, you can still promote
41164116
the standby using <command>pg_ctl promote</command> or calling
4117-
<function>pg_promote</function>.
4117+
<function>pg_promote()</function>.
41184118
This parameter can only be set in the <filename>postgresql.conf</filename>
41194119
file or on the server command line.
41204120
</para>

doc/src/sgml/high-availability.sgml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -644,7 +644,8 @@ protocol to make nodes agree on a serializable transactional order.
644644

645645
<para>
646646
Standby mode is exited and the server switches to normal operation
647-
when <command>pg_ctl promote</command> is run or a trigger file is found
647+
when <command>pg_ctl promote</command> is run,
648+
<function>pg_promote()</function> is called, or a trigger file is found
648649
(<varname>promote_trigger_file</varname>). Before failover,
649650
any WAL immediately available in the archive or in <filename>pg_wal</filename> will be
650651
restored, but no attempt is made to connect to the master.
@@ -1470,11 +1471,11 @@ synchronous_standby_names = 'ANY 2 (s1, s2, s3)'
14701471

14711472
<para>
14721473
To trigger failover of a log-shipping standby server, run
1473-
<command>pg_ctl promote</command>, call <function>pg_promote</function>,
1474+
<command>pg_ctl promote</command>, call <function>pg_promote()</function>,
14741475
or create a trigger file with the file name and path specified by the
14751476
<varname>promote_trigger_file</varname>. If you're planning to use
14761477
<command>pg_ctl promote</command> or to call
1477-
<function>pg_promote</function> to fail over,
1478+
<function>pg_promote()</function> to fail over,
14781479
<varname>promote_trigger_file</varname> is not required. If you're
14791480
setting up the reporting servers that are only used to offload read-only
14801481
queries from the primary, not for high availability purposes, you don't

0 commit comments

Comments
 (0)