git.postgresql.org Git - postgresql.git/commitdiff

git projects / postgresql.git / commitdiff

summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: f192312)

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

author Fujii Masao <fujii@postgresql.org>

2020年4月21日 05:05:43 +0000 (14:05 +0900)

committer Fujii Masao <fujii@postgresql.org>

2020年4月21日 05:05:43 +0000 (14:05 +0900)

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

doc/src/sgml/config.sgml patch | blob | blame | history

doc/src/sgml/high-availability.sgml patch | blob | blame | history

diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml

index a71ca624639422b04282dbf3428669be5a20900c..a14df06292b76800827df16784eec813b8a246c1 100644 (file)

--- a/doc/src/sgml/config.sgml

+++ b/doc/src/sgml/config.sgml

@@ -4114,7 +4114,7 @@ ANY <replaceable class="parameter">num_sync</replaceable> ( <replaceable class="

Specifies a trigger file whose presence ends recovery in the

standby. Even if this value is not set, you can still promote

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>

file or on the server command line.

</para>

diff --git a/doc/src/sgml/high-availability.sgml b/doc/src/sgml/high-availability.sgml

index 4659b9ef5dbc1f7b244fc512070bc60566703b67..52e47379cc712c22530e94ca2e7b61913dc51766 100644 (file)

--- a/doc/src/sgml/high-availability.sgml

+++ b/doc/src/sgml/high-availability.sgml

@@ -644,7 +644,8 @@ protocol to make nodes agree on a serializable transactional order.

<para>

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,

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.

@@ -1470,11 +1471,11 @@ synchronous_standby_names = 'ANY 2 (s1, s2, s3)'

<para>

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

<varname>promote_trigger_file</varname>. If you're planning to use

<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

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

This is the main PostgreSQL git repository.