{"Entry":{"collection":"func","key":"pg-promote","name":"pg_promote","aliases":[],"metadata":{"changed_in":[],"changes":[{"descriptions_changed":false,"doc_overhaul":false,"from":"11","group_changed":null,"signatures":{"added":[],"removed":[]},"status":"added","to":"12"},{"descriptions_changed":false,"doc_overhaul":true,"from":"12","group_changed":null,"signatures":{"added":[],"removed":[]},"status":"changed","to":"13"}],"content_hash":"3181974ce031dcb069f50d3d1439132aee3ca6c1a09afd983b3eccd429add3be","first_version":"12","group":"admin","group_label":"System Administration Functions","groups":["admin"],"imported_at":"2026-09-27T17:57:29.600331+08:00","last_version":"20","name":"pg_promote","name_key":"pg_promote","position":29073,"present_in":["12","13","14","15","16","17","18","19","20"],"signature":"pg_promote ( wait boolean DEFAULT true, wait_seconds integer DEFAULT 60 ) → boolean","signature_count":1,"slug":"pg-promote","source_rev":"b7bd9cda","summary":"Promotes a standby server to primary status.","summary_zh":""}},"Definition":{"Collection":"func","Key":"pg-promote","SourceDatabase":"center","Version":"18","SourceTable":"func","SourceKey":"pg-promote","SourceRevision":"b7bd9cda","Facts":{"description":"Promotes a standby server to primary status. 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 a SIGUSR1 signal to the postmaster to trigger promotion.","description_html":"Promotes a standby server to primary status. With \u003cem class=\"parameter\"\u003e\u003ccode\u003ewait\u003c/code\u003e\u003c/em\u003e set to \u003ccode class=\"literal\"\u003etrue\u003c/code\u003e (the default), the function waits until promotion is completed or \u003cem class=\"parameter\"\u003e\u003ccode\u003ewait_seconds\u003c/code\u003e\u003c/em\u003e seconds have passed, and returns \u003ccode class=\"literal\"\u003etrue\u003c/code\u003e if promotion is successful and \u003ccode class=\"literal\"\u003efalse\u003c/code\u003e otherwise. If \u003cem class=\"parameter\"\u003e\u003ccode\u003ewait\u003c/code\u003e\u003c/em\u003e is set to \u003ccode class=\"literal\"\u003efalse\u003c/code\u003e, the function returns \u003ccode class=\"literal\"\u003etrue\u003c/code\u003e immediately after sending a \u003ccode class=\"literal\"\u003eSIGUSR1\u003c/code\u003e signal to the postmaster to trigger promotion.","description_zh":"","description_zh_html":"","doc":{"anchor":"FUNCTIONS-RECOVERY-CONTROL-TABLE","file":"functions-admin.html","slug":"18"},"group":"admin","group_label":"System Administration Functions","lang":"en","layout":"table-new","pages":["functions-admin.html"],"prose_only":false,"signatures":[{"description":"Promotes a standby server to primary status. 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 a SIGUSR1 signal to the postmaster to trigger promotion.","description_html":"Promotes a standby server to primary status. With \u003cem class=\"parameter\"\u003e\u003ccode\u003ewait\u003c/code\u003e\u003c/em\u003e set to \u003ccode class=\"literal\"\u003etrue\u003c/code\u003e (the default), the function waits until promotion is completed or \u003cem class=\"parameter\"\u003e\u003ccode\u003ewait_seconds\u003c/code\u003e\u003c/em\u003e seconds have passed, and returns \u003ccode class=\"literal\"\u003etrue\u003c/code\u003e if promotion is successful and \u003ccode class=\"literal\"\u003efalse\u003c/code\u003e otherwise. If \u003cem class=\"parameter\"\u003e\u003ccode\u003ewait\u003c/code\u003e\u003c/em\u003e is set to \u003ccode class=\"literal\"\u003efalse\u003c/code\u003e, the function returns \u003ccode class=\"literal\"\u003etrue\u003c/code\u003e immediately after sending a \u003ccode class=\"literal\"\u003eSIGUSR1\u003c/code\u003e signal to the postmaster to trigger promotion.","description_zh":"","description_zh_html":"","examples":[],"html":"\u003ccode class=\"function\"\u003epg_promote\u003c/code\u003e ( \u003cem class=\"parameter\"\u003e\u003ccode\u003ewait\u003c/code\u003e\u003c/em\u003e \u003ccode class=\"type\"\u003eboolean\u003c/code\u003e \u003ccode class=\"literal\"\u003eDEFAULT\u003c/code\u003e \u003ccode class=\"literal\"\u003etrue\u003c/code\u003e, \u003cem class=\"parameter\"\u003e\u003ccode\u003ewait_seconds\u003c/code\u003e\u003c/em\u003e \u003ccode class=\"type\"\u003einteger\u003c/code\u003e \u003ccode class=\"literal\"\u003eDEFAULT\u003c/code\u003e \u003ccode class=\"literal\"\u003e60\u003c/code\u003e ) → \u003ccode class=\"returnvalue\"\u003eboolean\u003c/code\u003e","returns":"boolean","text":"pg_promote ( wait boolean DEFAULT true, wait_seconds integer DEFAULT 60 ) → boolean","zh_from":""}],"zh_from":""},"ManualEvidence":{"doc":{"anchor":"FUNCTIONS-RECOVERY-CONTROL-TABLE","file":"functions-admin.html","slug":"18"}},"MeasuredEvidence":{}},"Text":{"Collection":"func","Key":"pg-promote","SourceDatabase":"pgweb","Version":"18","Locale":"zh-Hans","Title":"pg_promote","Summary":"将备库提升为主库状态。当wait设置为true（默认值）时，函数将等待直到提升完成或wait_seconds秒数已过，如果提升成功则返回true，否则返回false。如果wait设置为false，则该函数在向postmaster发送SIGUSR1信号以触发提升后立即返回true。","BodyHTML":"将备库提升为主库状态。当\u003cem\u003e\u003ccode\u003ewait\u003c/code\u003e\u003c/em\u003e设置为\u003ccode\u003etrue\u003c/code\u003e（默认值）时，函数将等待直到提升完成或\u003cem\u003e\u003ccode\u003ewait_seconds\u003c/code\u003e\u003c/em\u003e秒数已过，如果提升成功则返回\u003ccode\u003etrue\u003c/code\u003e，否则返回\u003ccode\u003efalse\u003c/code\u003e。如果\u003cem\u003e\u003ccode\u003ewait\u003c/code\u003e\u003c/em\u003e设置为\u003ccode\u003efalse\u003c/code\u003e，则该函数在向postmaster发送\u003ccode\u003eSIGUSR1\u003c/code\u003e信号以触发提升后立即返回\u003ccode\u003etrue\u003c/code\u003e。\u003cpre\u003epg_promote ( wait boolean DEFAULT true, wait_seconds integer DEFAULT 60 ) → boolean\u003c/pre\u003e将备库提升为主库状态。当\u003cem\u003e\u003ccode\u003ewait\u003c/code\u003e\u003c/em\u003e设置为\u003ccode\u003etrue\u003c/code\u003e（默认值）时，函数将等待直到提升完成或\u003cem\u003e\u003ccode\u003ewait_seconds\u003c/code\u003e\u003c/em\u003e秒数已过，如果提升成功则返回\u003ccode\u003etrue\u003c/code\u003e，否则返回\u003ccode\u003efalse\u003c/code\u003e。如果\u003cem\u003e\u003ccode\u003ewait\u003c/code\u003e\u003c/em\u003e设置为\u003ccode\u003efalse\u003c/code\u003e，则该函数在向postmaster发送\u003ccode\u003eSIGUSR1\u003c/code\u003e信号以触发提升后立即返回\u003ccode\u003etrue\u003c/code\u003e。","SourceRevision":"ca936764","ContentHash":"f671cb39524e05850311732d1f3674c087fde2d855c1fe1f83214ba1ddd667b4","Payload":{"description_zh":"将备库提升为主库状态。当wait设置为true（默认值）时，函数将等待直到提升完成或wait_seconds秒数已过，如果提升成功则返回true，否则返回false。如果wait设置为false，则该函数在向postmaster发送SIGUSR1信号以触发提升后立即返回true。","description_zh_html":"将备库提升为主库状态。当\u003cem class=\"parameter\"\u003e\u003ccode\u003ewait\u003c/code\u003e\u003c/em\u003e设置为\u003ccode class=\"literal\"\u003etrue\u003c/code\u003e（默认值）时，函数将等待直到提升完成或\u003cem class=\"parameter\"\u003e\u003ccode\u003ewait_seconds\u003c/code\u003e\u003c/em\u003e秒数已过，如果提升成功则返回\u003ccode class=\"literal\"\u003etrue\u003c/code\u003e，否则返回\u003ccode class=\"literal\"\u003efalse\u003c/code\u003e。如果\u003cem class=\"parameter\"\u003e\u003ccode\u003ewait\u003c/code\u003e\u003c/em\u003e设置为\u003ccode class=\"literal\"\u003efalse\u003c/code\u003e，则该函数在向postmaster发送\u003ccode class=\"literal\"\u003eSIGUSR1\u003c/code\u003e信号以触发提升后立即返回\u003ccode class=\"literal\"\u003etrue\u003c/code\u003e。","signatures":[{"description_zh":"将备库提升为主库状态。当wait设置为true（默认值）时，函数将等待直到提升完成或wait_seconds秒数已过，如果提升成功则返回true，否则返回false。如果wait设置为false，则该函数在向postmaster发送SIGUSR1信号以触发提升后立即返回true。","description_zh_html":"将备库提升为主库状态。当\u003cem class=\"parameter\"\u003e\u003ccode\u003ewait\u003c/code\u003e\u003c/em\u003e设置为\u003ccode class=\"literal\"\u003etrue\u003c/code\u003e（默认值）时，函数将等待直到提升完成或\u003cem class=\"parameter\"\u003e\u003ccode\u003ewait_seconds\u003c/code\u003e\u003c/em\u003e秒数已过，如果提升成功则返回\u003ccode class=\"literal\"\u003etrue\u003c/code\u003e，否则返回\u003ccode class=\"literal\"\u003efalse\u003c/code\u003e。如果\u003cem class=\"parameter\"\u003e\u003ccode\u003ewait\u003c/code\u003e\u003c/em\u003e设置为\u003ccode class=\"literal\"\u003efalse\u003c/code\u003e，则该函数在向postmaster发送\u003ccode class=\"literal\"\u003eSIGUSR1\u003c/code\u003e信号以触发提升后立即返回\u003ccode class=\"literal\"\u003etrue\u003c/code\u003e。","returns":"boolean","text":"pg_promote ( wait boolean DEFAULT true, wait_seconds integer DEFAULT 60 ) → boolean","zh_from":"doc"}],"zh_from":"doc"}},"RequestedLocale":"zh-Hans","Fallback":false,"Versions":["12","13","14","15","16","17","18","19","20"],"Locales":["en","zh-Hans"],"Signatures":[{"Version":"18","Ordinal":0,"Hash":"da00d84c2cec3b1734ca524482d1944a6a6386869b30fb5e5015268f8dbad687","Text":"pg_promote ( wait boolean DEFAULT true, wait_seconds integer DEFAULT 60 ) → boolean","Returns":"boolean","Payload":{"description":"Promotes a standby server to primary status. 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 a SIGUSR1 signal to the postmaster to trigger promotion.","description_html":"Promotes a standby server to primary status. With \u003cem class=\"parameter\"\u003e\u003ccode\u003ewait\u003c/code\u003e\u003c/em\u003e set to \u003ccode class=\"literal\"\u003etrue\u003c/code\u003e (the default), the function waits until promotion is completed or \u003cem class=\"parameter\"\u003e\u003ccode\u003ewait_seconds\u003c/code\u003e\u003c/em\u003e seconds have passed, and returns \u003ccode class=\"literal\"\u003etrue\u003c/code\u003e if promotion is successful and \u003ccode class=\"literal\"\u003efalse\u003c/code\u003e otherwise. If \u003cem class=\"parameter\"\u003e\u003ccode\u003ewait\u003c/code\u003e\u003c/em\u003e is set to \u003ccode class=\"literal\"\u003efalse\u003c/code\u003e, the function returns \u003ccode class=\"literal\"\u003etrue\u003c/code\u003e immediately after sending a \u003ccode class=\"literal\"\u003eSIGUSR1\u003c/code\u003e signal to the postmaster to trigger promotion.","description_zh":"","description_zh_html":"","examples":[],"html":"\u003ccode class=\"function\"\u003epg_promote\u003c/code\u003e ( \u003cem class=\"parameter\"\u003e\u003ccode\u003ewait\u003c/code\u003e\u003c/em\u003e \u003ccode class=\"type\"\u003eboolean\u003c/code\u003e \u003ccode class=\"literal\"\u003eDEFAULT\u003c/code\u003e \u003ccode class=\"literal\"\u003etrue\u003c/code\u003e, \u003cem class=\"parameter\"\u003e\u003ccode\u003ewait_seconds\u003c/code\u003e\u003c/em\u003e \u003ccode class=\"type\"\u003einteger\u003c/code\u003e \u003ccode class=\"literal\"\u003eDEFAULT\u003c/code\u003e \u003ccode class=\"literal\"\u003e60\u003c/code\u003e ) → \u003ccode class=\"returnvalue\"\u003eboolean\u003c/code\u003e","returns":"boolean","text":"pg_promote ( wait boolean DEFAULT true, wait_seconds integer DEFAULT 60 ) → boolean","zh_from":""}}],"Spellings":null,"SQLState":null,"Evidence":null}