diff options
| author | Michael Paquier <michael@paquier.xyz> | 2018-11-19 13:20:22 +0900 |
|---|---|---|
| committer | Michael Paquier <michael@paquier.xyz> | 2018-11-19 13:20:22 +0900 |
| commit | 74171f8c12e68408f1fa895fdee36fdc8b0a9f79 (patch) | |
| tree | d50cafec21d8cd81822c563252cb506b4f0208a2 /doc/src | |
| parent | 285bd0ac4a7c0538d544c40aa725682e11cb71a9 (diff) | |
| download | postgresql-74171f8c12e68408f1fa895fdee36fdc8b0a9f79.tar.gz postgresql-74171f8c12e68408f1fa895fdee36fdc8b0a9f79.zip | |
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
Diffstat (limited to 'doc/src')
| -rw-r--r-- | doc/src/sgml/func.sgml | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index edeb3fd07bd..d7302617423 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -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> |