diff options
| author | Fujii Masao <fujii@postgresql.org> | 2020-04-21 14:05:43 +0900 |
|---|---|---|
| committer | Fujii Masao <fujii@postgresql.org> | 2020-04-21 14:05:43 +0900 |
| commit | 67f82e966b524fc0eb44024976c5178612a77fc8 (patch) | |
| tree | da87b283942700c563d64de4fb6100a76e29cc8a /doc/src | |
| parent | f192312dc07601c5abb2e04126b434c70f7c8e50 (diff) | |
| download | postgresql-67f82e966b524fc0eb44024976c5178612a77fc8.tar.gz postgresql-67f82e966b524fc0eb44024976c5178612a77fc8.zip | |
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
Diffstat (limited to 'doc/src')
| -rw-r--r-- | doc/src/sgml/config.sgml | 2 | ||||
| -rw-r--r-- | doc/src/sgml/high-availability.sgml | 7 |
2 files changed, 5 insertions, 4 deletions
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml index a71ca624639..a14df06292b 100644 --- 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 4659b9ef5db..52e47379cc7 100644 --- 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 |