{"Entry":{"collection":"func","key":"pg-backup-start","name":"pg_backup_start","aliases":[],"metadata":{"changed_in":[],"changes":[{"descriptions_changed":false,"doc_overhaul":false,"from":"14","group_changed":null,"signatures":{"added":[],"removed":[]},"status":"added","to":"15"},{"descriptions_changed":true,"doc_overhaul":false,"from":"18","group_changed":null,"signatures":{"added":[],"removed":[]},"status":"changed","to":"19"}],"content_hash":"d6692eb562eb141f3f7044eee6842b445c988f91e3ccf659a42886a53c375dec","first_version":"15","group":"admin","group_label":"System Administration Functions","groups":["admin"],"imported_at":"2026-09-27T17:57:29.44214+08:00","last_version":"20","name":"pg_backup_start","name_key":"pg_backup_start","position":29012,"present_in":["15","16","17","18","19","20"],"signature":"pg_backup_start ( label text [, fast boolean ] ) → pg_lsn","signature_count":1,"slug":"pg-backup-start","source_rev":"b7bd9cda","summary":"Prepares the server to begin an on-line backup.","summary_zh":""}},"Definition":{"Collection":"func","Key":"pg-backup-start","SourceDatabase":"center","Version":"18","SourceTable":"func","SourceKey":"pg-backup-start","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_backup_start as quickly as possible. This forces an immediate checkpoint which will cause a spike in I/O operations, slowing any concurrently executing queries.","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_backup_start\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.","description_zh":"","description_zh_html":"","doc":{"anchor":"FUNCTIONS-ADMIN-BACKUP-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":"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_backup_start as quickly as possible. This forces an immediate checkpoint which will cause a spike in I/O operations, slowing any concurrently executing queries.","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_backup_start\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.","description_zh":"","description_zh_html":"","examples":[],"html":"\u003ccode class=\"function\"\u003epg_backup_start\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\u003c/span\u003e ] ) → \u003ccode class=\"returnvalue\"\u003epg_lsn\u003c/code\u003e","returns":"pg_lsn","text":"pg_backup_start ( label text [, fast boolean ] ) → pg_lsn","zh_from":""}],"zh_from":""},"ManualEvidence":{"doc":{"anchor":"FUNCTIONS-ADMIN-BACKUP-TABLE","file":"functions-admin.html","slug":"18"}},"MeasuredEvidence":{}},"Text":{"Collection":"func","Key":"pg-backup-start","SourceDatabase":"pgweb","Version":"18","Locale":"zh-Hans","Title":"pg_backup_start","Summary":"准备服务器开始在线备份。唯一必需的参数是用户任意指定的备份标签。（通常是备份转储文件将要保存的名称。）如果可选的第二个参数为true，则尽快执行pg_backup_start。这会强制立即执行检查点，使 I/O 操作量陡增，并降低并发执行的查询的速度。","BodyHTML":"准备服务器开始在线备份。唯一必需的参数是用户任意指定的备份标签。（通常是备份转储文件将要保存的名称。）如果可选的第二个参数为\u003ccode\u003etrue\u003c/code\u003e，则尽快执行\u003ccode\u003epg_backup_start\u003c/code\u003e。这会强制立即执行检查点，使 I/O 操作量陡增，并降低并发执行的查询的速度。\u003cpre\u003epg_backup_start ( label text [, fast boolean ] ) → pg_lsn\u003c/pre\u003e准备服务器开始在线备份。唯一必需的参数是用户任意指定的备份标签。（通常是备份转储文件将要保存的名称。）如果可选的第二个参数为\u003ccode\u003etrue\u003c/code\u003e，则尽快执行\u003ccode\u003epg_backup_start\u003c/code\u003e。这会强制立即执行检查点，使 I/O 操作量陡增，并降低并发执行的查询的速度。","SourceRevision":"1b5ca64c","ContentHash":"296ed3c26d07182f10533c08321efe6c1bb316246593dac941bb999c45c0c1c3","Payload":{"description_zh":"准备服务器开始在线备份。唯一必需的参数是用户任意指定的备份标签。（通常是备份转储文件将要保存的名称。）如果可选的第二个参数为true，则尽快执行pg_backup_start。这会强制立即执行检查点，使 I/O 操作量陡增，并降低并发执行的查询的速度。","description_zh_html":"准备服务器开始在线备份。唯一必需的参数是用户任意指定的备份标签。（通常是备份转储文件将要保存的名称。）如果可选的第二个参数为\u003ccode class=\"literal\"\u003etrue\u003c/code\u003e，则尽快执行\u003ccode class=\"function\"\u003epg_backup_start\u003c/code\u003e。这会强制立即执行检查点，使 I/O 操作量陡增，并降低并发执行的查询的速度。","signatures":[{"description_zh":"准备服务器开始在线备份。唯一必需的参数是用户任意指定的备份标签。（通常是备份转储文件将要保存的名称。）如果可选的第二个参数为true，则尽快执行pg_backup_start。这会强制立即执行检查点，使 I/O 操作量陡增，并降低并发执行的查询的速度。","description_zh_html":"准备服务器开始在线备份。唯一必需的参数是用户任意指定的备份标签。（通常是备份转储文件将要保存的名称。）如果可选的第二个参数为\u003ccode class=\"literal\"\u003etrue\u003c/code\u003e，则尽快执行\u003ccode class=\"function\"\u003epg_backup_start\u003c/code\u003e。这会强制立即执行检查点，使 I/O 操作量陡增，并降低并发执行的查询的速度。","returns":"pg_lsn","text":"pg_backup_start ( label text [, fast boolean ] ) → pg_lsn","zh_from":"doc"}],"zh_from":"doc"}},"RequestedLocale":"zh-Hans","Fallback":false,"Versions":["15","16","17","18","19","20"],"Locales":["en","zh-Hans"],"Signatures":[{"Version":"18","Ordinal":0,"Hash":"ae66adcfd10ce06d75602730ba8b7b43fd611ea2cb5b9a925c76121a51cebe1e","Text":"pg_backup_start ( label text [, fast 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_backup_start as quickly as possible. This forces an immediate checkpoint which will cause a spike in I/O operations, slowing any concurrently executing queries.","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_backup_start\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.","description_zh":"","description_zh_html":"","examples":[],"html":"\u003ccode class=\"function\"\u003epg_backup_start\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\u003c/span\u003e ] ) → \u003ccode class=\"returnvalue\"\u003epg_lsn\u003c/code\u003e","returns":"pg_lsn","text":"pg_backup_start ( label text [, fast boolean ] ) → pg_lsn","zh_from":""}}],"Spellings":null,"SQLState":null,"Evidence":null}
