Commit 74171f8c authored by Michael Paquier's avatar Michael Paquier

Rework documentation of pg_promote

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
parent 285bd0ac
......@@ -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>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment