mirror/postgresql
2
0
Fork 0
mirror of https://git.postgresql.org/git/postgresql.git synced 2024-12-27 08:39:28 +08:00
Code Issues Packages Projects Releases Wiki Activity

Rework documentation of pg_promote

Browse Source 
This clarifies the behavior of how the "wait" flag works, which is
something that the previous version of the documentation failed to do.

Author: Ian Barwick
Discussion: https://postgr.es/m/cbd38450-2295-10a1-1f73-591a692ae0b0@2ndquadrant.com
This commit is contained in:
Michael Paquier 2018-11-19 13:20:22 +09:00
parent 285bd0ac4a
commit 74171f8c12
1 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/src/sgml/func.sgml
View File

@ -19278,14 +19278,16 @@ postgres=# SELECT * FROM pg_walfile_name_offset(pg_stop_backup());
</entry>
<entry><type>boolean</type></entry>
<entry>
Promotes a physical standby server. Returns <literal>true</literal>
if promotion is successful and <literal>false</literal> otherwise.
With <parameter>wait</parameter> set to <literal>true</literal>, the
default, the function waits until promotion is completed or
<parameter>wait_seconds</parameter> seconds have passed, otherwise the
function returns immediately after sending the promotion signal to the
postmaster. This function is restricted to superusers by default, but
other users can be granted EXECUTE to run the function.
Promotes a physical standby server. With <parameter>wait</parameter>
set to <literal>true</literal> (the default), the function waits until
promotion is completed or <parameter>wait_seconds</parameter> seconds
have passed, and returns <literal>true</literal> if promotion is
successful and <literal>false</literal> otherwise.
If <parameter>wait</parameter> is set to <literal>false</literal>, the
function returns <literal>true</literal> immediately after sending
<literal>SIGUSR1</literal> to the postmaster to trigger the promotion.
This function is restricted to superusers by default, but other users
can be granted EXECUTE to run the function.
</entry>
</row>
<row>