{"Entry":{"collection":"func","key":"pg-start-backup","name":"pg_start_backup","aliases":[],"metadata":{"changed_in":["8.1","8.4","9.4","9.6"],"changes":[{"descriptions_changed":false,"doc_overhaul":false,"from":"7.4","group_changed":null,"signatures":{"added":[],"removed":[]},"status":"added","to":"8.0"},{"descriptions_changed":false,"doc_overhaul":false,"from":"8.0","group_changed":null,"signatures":{"added":["pg_start_backup ( label text ) → text"],"removed":["pg_start_backup ( label_text ) → text"]},"status":"changed","to":"8.1"},{"descriptions_changed":true,"doc_overhaul":false,"from":"8.3","group_changed":null,"signatures":{"added":["pg_start_backup ( label text [, fast boolean ] ) → text"],"removed":["pg_start_backup ( label text ) → text"]},"status":"changed","to":"8.4"},{"descriptions_changed":true,"doc_overhaul":false,"from":"9.0","group_changed":null,"signatures":{"added":[],"removed":[]},"status":"changed","to":"9.1"},{"descriptions_changed":false,"doc_overhaul":false,"from":"9.3","group_changed":null,"signatures":{"added":["pg_start_backup ( label text [, fast boolean ] ) → pg_lsn"],"removed":["pg_start_backup ( label text [, fast boolean ] ) → text"]},"status":"changed","to":"9.4"},{"descriptions_changed":true,"doc_overhaul":false,"from":"9.5","group_changed":null,"signatures":{"added":["pg_start_backup ( label text [, fast boolean [, exclusive boolean ]] ) → pg_lsn"],"removed":["pg_start_backup ( label text [, fast boolean ] ) → pg_lsn"]},"status":"changed","to":"9.6"},{"descriptions_changed":false,"doc_overhaul":true,"from":"12","group_changed":null,"signatures":{"added":[],"removed":[]},"status":"changed","to":"13"},{"descriptions_changed":false,"doc_overhaul":false,"from":"14","group_changed":null,"signatures":{"added":[],"removed":[]},"status":"removed","to":"15"}],"content_hash":"3f9fe1888da86f79b5e6f615ec108fdc3db92b330d0d0486fcf3bf54c04e446a","first_version":"8.0","group":"admin","group_label":"System Administration Functions","groups":["admin"],"imported_at":"2026-09-27T17:57:29.66521+08:00","last_version":"14","name":"pg_start_backup","name_key":"pg_start_backup","position":29099,"present_in":["8.0","8.1","8.2","8.3","8.4","9.0","9.1","9.2","9.3","9.4","9.5","9.6","10","11","12","13","14"],"signature":"pg_start_backup ( label text [, fast boolean [, exclusive boolean ]] ) → pg_lsn","signature_count":1,"slug":"pg-start-backup","source_rev":"b7bd9cda","summary":"Prepares the server to begin an on-line backup.","summary_zh":""}},"Definition":{"Collection":"func","Key":"pg-start-backup","SourceDatabase":"center","Version":"14","SourceTable":"func","SourceKey":"pg-start-backup","SourceRevision":"b7bd9cda","Facts":{"description":"Prepares the server to begin an on-line backup. The only required parameter is an arbitrary user-defined label for the backup. (Typically this would be the name under which the backup dump file will be stored.) If the optional second parameter is given as true, it specifies executing pg_start_backup as quickly as possible. This forces an immediate checkpoint which will cause a spike in I/O operations, slowing any concurrently executing queries. The optional third parameter specifies whether to perform an exclusive or non-exclusive backup (default is exclusive).","description_html":"Prepares the server to begin an on-line backup. The only required parameter is an arbitrary user-defined label for the backup. (Typically this would be the name under which the backup dump file will be stored.) If the optional second parameter is given as \u003ccode class=\"literal\"\u003etrue\u003c/code\u003e, it specifies executing \u003ccode class=\"function\"\u003epg_start_backup\u003c/code\u003e as quickly as possible. This forces an immediate checkpoint which will cause a spike in I/O operations, slowing any concurrently executing queries. The optional third parameter specifies whether to perform an exclusive or non-exclusive backup (default is exclusive).","description_zh":"","description_zh_html":"","doc":{"anchor":"FUNCTIONS-ADMIN-BACKUP-TABLE","file":"functions-admin.html","slug":"14"},"group":"admin","group_label":"System Administration Functions","lang":"en","layout":"table-new","pages":["functions-admin.html"],"prose_only":false,"signatures":[{"description":"Prepares the server to begin an on-line backup. The only required parameter is an arbitrary user-defined label for the backup. (Typically this would be the name under which the backup dump file will be stored.) If the optional second parameter is given as true, it specifies executing pg_start_backup as quickly as possible. This forces an immediate checkpoint which will cause a spike in I/O operations, slowing any concurrently executing queries. The optional third parameter specifies whether to perform an exclusive or non-exclusive backup (default is exclusive).","description_html":"Prepares the server to begin an on-line backup. The only required parameter is an arbitrary user-defined label for the backup. (Typically this would be the name under which the backup dump file will be stored.) If the optional second parameter is given as \u003ccode class=\"literal\"\u003etrue\u003c/code\u003e, it specifies executing \u003ccode class=\"function\"\u003epg_start_backup\u003c/code\u003e as quickly as possible. This forces an immediate checkpoint which will cause a spike in I/O operations, slowing any concurrently executing queries. The optional third parameter specifies whether to perform an exclusive or non-exclusive backup (default is exclusive).","description_zh":"","description_zh_html":"","examples":[],"html":"\u003ccode class=\"function\"\u003epg_start_backup\u003c/code\u003e ( \u003cem class=\"parameter\"\u003e\u003ccode\u003elabel\u003c/code\u003e\u003c/em\u003e \u003ccode class=\"type\"\u003etext\u003c/code\u003e [\u003cspan class=\"optional\"\u003e, \u003cem class=\"parameter\"\u003e\u003ccode\u003efast\u003c/code\u003e\u003c/em\u003e \u003ccode class=\"type\"\u003eboolean\u003c/code\u003e [\u003cspan class=\"optional\"\u003e, \u003cem class=\"parameter\"\u003e\u003ccode\u003eexclusive\u003c/code\u003e\u003c/em\u003e \u003ccode class=\"type\"\u003eboolean\u003c/code\u003e\u003c/span\u003e ]\u003c/span\u003e] ) → \u003ccode class=\"returnvalue\"\u003epg_lsn\u003c/code\u003e","returns":"pg_lsn","text":"pg_start_backup ( label text [, fast boolean [, exclusive boolean ]] ) → pg_lsn","zh_from":""}],"zh_from":""},"ManualEvidence":{"doc":{"anchor":"FUNCTIONS-ADMIN-BACKUP-TABLE","file":"functions-admin.html","slug":"14"}},"MeasuredEvidence":{}},"Text":{"Collection":"func","Key":"pg-start-backup","SourceDatabase":"pgweb","Version":"14","Locale":"zh-Hans","Title":"pg_start_backup","Summary":"准备服务器开始在线备份。唯一必需的参数是用户任意指定的备份标签。（通常是备份转储文件将要保存的名称。）如果可选的第二个参数为true，则尽快执行pg_start_backup。这会强制立即执行检查点，使 I/O 操作量陡增，并降低并发执行的查询的速度。可选的第三个参数指定执行排他备份还是非排他备份（默认为排他备份）。","BodyHTML":"准备服务器开始在线备份。唯一必需的参数是用户任意指定的备份标签。（通常是备份转储文件将要保存的名称。）如果可选的第二个参数为\u003ccode\u003etrue\u003c/code\u003e，则尽快执行\u003ccode\u003epg_start_backup\u003c/code\u003e。这会强制立即执行检查点，使 I/O 操作量陡增，并降低并发执行的查询的速度。可选的第三个参数指定执行排他备份还是非排他备份（默认为排他备份）。\u003cpre\u003epg_start_backup ( label text [, fast boolean [, exclusive boolean ]] ) → pg_lsn\u003c/pre\u003e准备服务器开始在线备份。唯一必需的参数是用户任意指定的备份标签。（通常是备份转储文件将要保存的名称。）如果可选的第二个参数为\u003ccode\u003etrue\u003c/code\u003e，则尽快执行\u003ccode\u003epg_start_backup\u003c/code\u003e。这会强制立即执行检查点，使 I/O 操作量陡增，并降低并发执行的查询的速度。可选的第三个参数指定执行排他备份还是非排他备份（默认为排他备份）。","SourceRevision":"ca936764","ContentHash":"0ab6540038e8d263134bacd4bcbf324317280c12af83b211704afb94f341a59c","Payload":{"description_zh":"准备服务器开始在线备份。唯一必需的参数是用户任意指定的备份标签。（通常是备份转储文件将要保存的名称。）如果可选的第二个参数为true，则尽快执行pg_start_backup。这会强制立即执行检查点，使 I/O 操作量陡增，并降低并发执行的查询的速度。可选的第三个参数指定执行排他备份还是非排他备份（默认为排他备份）。","description_zh_html":"准备服务器开始在线备份。唯一必需的参数是用户任意指定的备份标签。（通常是备份转储文件将要保存的名称。）如果可选的第二个参数为\u003ccode class=\"literal\"\u003etrue\u003c/code\u003e，则尽快执行\u003ccode class=\"function\"\u003epg_start_backup\u003c/code\u003e。这会强制立即执行检查点，使 I/O 操作量陡增，并降低并发执行的查询的速度。可选的第三个参数指定执行排他备份还是非排他备份（默认为排他备份）。","signatures":[{"description_zh":"准备服务器开始在线备份。唯一必需的参数是用户任意指定的备份标签。（通常是备份转储文件将要保存的名称。）如果可选的第二个参数为true，则尽快执行pg_start_backup。这会强制立即执行检查点，使 I/O 操作量陡增，并降低并发执行的查询的速度。可选的第三个参数指定执行排他备份还是非排他备份（默认为排他备份）。","description_zh_html":"准备服务器开始在线备份。唯一必需的参数是用户任意指定的备份标签。（通常是备份转储文件将要保存的名称。）如果可选的第二个参数为\u003ccode class=\"literal\"\u003etrue\u003c/code\u003e，则尽快执行\u003ccode class=\"function\"\u003epg_start_backup\u003c/code\u003e。这会强制立即执行检查点，使 I/O 操作量陡增，并降低并发执行的查询的速度。可选的第三个参数指定执行排他备份还是非排他备份（默认为排他备份）。","returns":"pg_lsn","text":"pg_start_backup ( label text [, fast boolean [, exclusive boolean ]] ) → pg_lsn","zh_from":"doc"}],"zh_from":"doc"}},"RequestedLocale":"zh-Hans","Fallback":false,"Versions":["10","11","12","13","14","8.0","8.1","8.2","8.3","8.4","9.0","9.1","9.2","9.3","9.4","9.5","9.6"],"Locales":["en","zh-Hans"],"Signatures":[{"Version":"14","Ordinal":0,"Hash":"e08c08889fe1bccb904049c3b7b1e119ab6c36051318a4219d2517320366c64c","Text":"pg_start_backup ( label text [, fast boolean [, exclusive boolean ]] ) → pg_lsn","Returns":"pg_lsn","Payload":{"description":"Prepares the server to begin an on-line backup. The only required parameter is an arbitrary user-defined label for the backup. (Typically this would be the name under which the backup dump file will be stored.) If the optional second parameter is given as true, it specifies executing pg_start_backup as quickly as possible. This forces an immediate checkpoint which will cause a spike in I/O operations, slowing any concurrently executing queries. The optional third parameter specifies whether to perform an exclusive or non-exclusive backup (default is exclusive).","description_html":"Prepares the server to begin an on-line backup. The only required parameter is an arbitrary user-defined label for the backup. (Typically this would be the name under which the backup dump file will be stored.) If the optional second parameter is given as \u003ccode class=\"literal\"\u003etrue\u003c/code\u003e, it specifies executing \u003ccode class=\"function\"\u003epg_start_backup\u003c/code\u003e as quickly as possible. This forces an immediate checkpoint which will cause a spike in I/O operations, slowing any concurrently executing queries. The optional third parameter specifies whether to perform an exclusive or non-exclusive backup (default is exclusive).","description_zh":"","description_zh_html":"","examples":[],"html":"\u003ccode class=\"function\"\u003epg_start_backup\u003c/code\u003e ( \u003cem class=\"parameter\"\u003e\u003ccode\u003elabel\u003c/code\u003e\u003c/em\u003e \u003ccode class=\"type\"\u003etext\u003c/code\u003e [\u003cspan class=\"optional\"\u003e, \u003cem class=\"parameter\"\u003e\u003ccode\u003efast\u003c/code\u003e\u003c/em\u003e \u003ccode class=\"type\"\u003eboolean\u003c/code\u003e [\u003cspan class=\"optional\"\u003e, \u003cem class=\"parameter\"\u003e\u003ccode\u003eexclusive\u003c/code\u003e\u003c/em\u003e \u003ccode class=\"type\"\u003eboolean\u003c/code\u003e\u003c/span\u003e ]\u003c/span\u003e] ) → \u003ccode class=\"returnvalue\"\u003epg_lsn\u003c/code\u003e","returns":"pg_lsn","text":"pg_start_backup ( label text [, fast boolean [, exclusive boolean ]] ) → pg_lsn","zh_from":""}}],"Spellings":null,"SQLState":null,"Evidence":null}