From 74171f8c12e68408f1fa895fdee36fdc8b0a9f79 Mon Sep 17 00:00:00 2001 From: Michael Paquier Date: Mon, 19 Nov 2018 13:20:22 +0900 Subject: [PATCH] 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 --- doc/src/sgml/func.sgml | 18 ++++++++++-------- 1 file 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()); boolean - Promotes a physical standby server. Returns true - if promotion is successful and false otherwise. - With wait set to true, the - default, the function waits until promotion is completed or - wait_seconds 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 wait + set to true (the default), the function waits until + promotion is completed or wait_seconds seconds + have passed, and returns true if promotion is + successful and false otherwise. + If wait is set to false, the + function returns true immediately after sending + SIGUSR1 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. -- 2.30.2