NotificationsYou must be signed in to change notification settings
Fork6
Star31

Commit74171f8

committed

Rework documentation of pg_promote

This clarifies the behavior of how the "wait" flag works, which issomething that the previous version of the documentation failed to do.Author: Ian BarwickDiscussion:https://postgr.es/m/cbd38450-2295-10a1-1f73-591a692ae0b0@2ndquadrant.com

1 parent285bd0a commit74171f8Copy full SHA for 74171f8

File tree

1 file changed

+10

-8

lines changed

doc/src/sgml
- func.sgml

1 file changed

+10

-8

lines changed

`‎doc/src/sgml/func.sgml`

Lines changed: 10 additions & 8 deletions

Original file line number	Diff line number	Diff line change
`@@ -19278,14 +19278,16 @@ postgres=# SELECT * FROM pg_walfile_name_offset(pg_stop_backup());`
`19278`	`19278`	`</entry>`
`19279`	`19279`	`<entry><type>boolean</type></entry>`
`19280`	`19280`	`<entry>`
`19281`		`- Promotes a physical standby server. Returns <literal>true</literal>`
`19282`		`- if promotion is successful and <literal>false</literal> otherwise.`
`19283`		`- With <parameter>wait</parameter> set to <literal>true</literal>, the`
`19284`		`- default, the function waits until promotion is completed or`
`19285`		`- <parameter>wait_seconds</parameter> seconds have passed, otherwise the`
`19286`		`- function returns immediately after sending the promotion signal to the`
`19287`		`- postmaster. This function is restricted to superusers by default, but`
`19288`		`- other users can be granted EXECUTE to run the function.`
	`19281`	`+ Promotes a physical standby server. With <parameter>wait</parameter>`
	`19282`	`+ set to <literal>true</literal> (the default), the function waits until`
	`19283`	`+ promotion is completed or <parameter>wait_seconds</parameter> seconds`
	`19284`	`+ have passed, and returns <literal>true</literal> if promotion is`
	`19285`	`+ successful and <literal>false</literal> otherwise.`
	`19286`	`+ If <parameter>wait</parameter> is set to <literal>false</literal>, the`
	`19287`	`+ function returns <literal>true</literal> immediately after sending`
	`19288`	`+ <literal>SIGUSR1</literal> to the postmaster to trigger the promotion.`
	`19289`	`+ This function is restricted to superusers by default, but other users`
	`19290`	`+ can be granted EXECUTE to run the function.`
`19289`	`19291`	`</entry>`
`19290`	`19292`	`</row>`
`19291`	`19293`	`<row>`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit74171f8

File tree

1 file changed

1 file changed

`‎doc/src/sgml/func.sgml`

0 commit comments