{"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","derived_content_hash":"857891bd95128d8d01ecb6dedcb9c3b9507a98063042e7d6a346605774619e78","documentation_refresh":{"batch":"20261113","original_source_rev":"wiki-repair-20261023:3e12543ed0b4d9fe060884db6c987613af5c3079188874faf03de5f47abb31cb","versions":{"14":"14.25","15":"15.20","16":"16.16","17":"17.12","18":"18.7","19":"19rc2"}},"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"],"repair_provenance":{"original_source_revision":"b7bd9cda","receipt_sha256":"b2f63249537156432ea860e5bec7837cdc90526896a1d72bf3bf6de0a2f28192","repair":"wiki-repair-20261023"},"signature":"pg_promote ( wait boolean DEFAULT true, wait_seconds integer DEFAULT 60 ) → boolean","signature_count":1,"slug":"pg-promote","source_rev":"wiki-repair-20261023:3e12543ed0b4d9fe060884db6c987613af5c3079188874faf03de5f47abb31cb","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":"wiki-repair-20261023:3e12543ed0b4d9fe060884db6c987613af5c3079188874faf03de5f47abb31cb","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":"将备库提升为主库状态。当 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。","doc":{"anchor":"FUNCTIONS-RECOVERY-CONTROL-TABLE","file":"functions-admin.html","sha256":"885561d57facd49c33b44a50e320a002197d700d118784cc87d6410efadbd1f6","slug":"18"},"documentation_revision":{"inputs":[{"file":"functions-admin.html","kind":"same-version-reviewed-manual","locale":"en","sha256":"885561d57facd49c33b44a50e320a002197d700d118784cc87d6410efadbd1f6","version":"18.7"},{"file":"functions-admin.html","kind":"same-version-reviewed-manual","locale":"zh-Hans","sha256":"830e894d29fec30b7c350c915fcaed4a63b24d57f2c96150bf25fa07fb43849c","version":"18.7"}],"release":"18.7","runtime_remeasured":false,"source_revision":"pgdoc:b9f0e7232f60f380d642ac9b99226606c254b552"},"group":"admin","group_label":"系统管理函数","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":"将备库提升为主库状态。当 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。","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":"same-version-manual"}],"translation_provenance":{"inputs":[{"kind":"current-pgdoc-translation","path":"/Users/vonng/pgsty/pgdoc/zh/18/html/functions-admin.html","sha256":"b4fab9daceb7883fd75b32b6eb5398f2bbbfbbed5c83d1b2bf99cc8d842cdaf7"}],"kind":"same-version-pgdoc","locale":"zh-Hans","source_revision":"b1b500221dbe5437cfca004d6b04d3f6e422765d","version":"18"},"zh_from":"same-version-manual"},"ManualEvidence":{"doc":{"anchor":"FUNCTIONS-RECOVERY-CONTROL-TABLE","file":"functions-admin.html","sha256":"885561d57facd49c33b44a50e320a002197d700d118784cc87d6410efadbd1f6","slug":"18"}},"MeasuredEvidence":{}},"Text":{"Collection":"func","Key":"pg-promote","SourceDatabase":"center","Version":"18","Locale":"en","Title":"pg_promote","Summary":"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.","BodyHTML":"Promotes a standby server to primary status. With \u003cem\u003e\u003ccode\u003ewait\u003c/code\u003e\u003c/em\u003e set to \u003ccode\u003etrue\u003c/code\u003e (the default), the function waits until promotion is completed or \u003cem\u003e\u003ccode\u003ewait_seconds\u003c/code\u003e\u003c/em\u003e seconds have passed, and returns \u003ccode\u003etrue\u003c/code\u003e if promotion is successful and \u003ccode\u003efalse\u003c/code\u003e otherwise. If \u003cem\u003e\u003ccode\u003ewait\u003c/code\u003e\u003c/em\u003e is set to \u003ccode\u003efalse\u003c/code\u003e, the function returns \u003ccode\u003etrue\u003c/code\u003e immediately after sending a \u003ccode\u003eSIGUSR1\u003c/code\u003e signal to the postmaster to trigger promotion.","SourceRevision":"wiki-repair-20261023:3e12543ed0b4d9fe060884db6c987613af5c3079188874faf03de5f47abb31cb","ContentHash":"fcf052fc695489f059d9a7e4b82e8af4c7375a07ab4c616f93efdc2594f29235","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.","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":"将备库提升为主库状态。当 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。","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":"same-version-manual"}]}},"RequestedLocale":"en","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":"将备库提升为主库状态。当 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。","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":"same-version-manual"}}],"Spellings":null,"SQLState":null,"Evidence":null}