diff --git a/doc/xml/release.xml b/doc/xml/release.xml index c4575295a..2620c8617 100644 --- a/doc/xml/release.xml +++ b/doc/xml/release.xml @@ -44,6 +44,19 @@

Do not store references for zero-length files when bundling.

+ + + + + + + + + + + +

Use more generic descriptions for pg_start_backup()/pg_stop_backup().

+
diff --git a/src/build/help/help.xml b/src/build/help/help.xml index 85aa32cff..8454cfc69 100644 --- a/src/build/help/help.xml +++ b/src/build/help/help.xml @@ -250,7 +250,7 @@ Database query timeout. -

Sets the timeout, in seconds, for queries against the database. This includes the pg_start_backup() and pg_stop_backup() functions which can each take a substantial amount of time. Because of this the timeout should be kept high unless you know that these functions will return quickly (i.e. if you have set start-fast=y and you know that the database cluster will not generate many WAL segments during the backup).

+

Sets the timeout, in seconds, for queries against the database. This includes the backup start/stop functions which can each take a substantial amount of time. Because of this the timeout should be kept high unless you know that these functions will return quickly (i.e. if you have set start-fast=y and you know that the database cluster will not generate many WAL segments during the backup).

The db-timeout option must be less than the protocol-timeout option.
@@ -1190,7 +1190,7 @@ Force a checkpoint to start backup quickly. -

Forces a checkpoint (by passing y to the fast parameter of pg_start_backup()) so the backup begins immediately. Otherwise the backup will start after the next regular checkpoint.

+

Forces a checkpoint (by passing y to the fast parameter of the backup start function so the backup begins immediately. Otherwise the backup will start after the next regular checkpoint.

y @@ -1870,7 +1870,7 @@ Perform an online backup. -

Specifying --no-online prevents from running pg_start_backup() and pg_stop_backup() on the database cluster. In order for this to work should be shut down and will generate an error if it is not.

+

Specifying --no-online prevents from running the backup start/stop functions on the database cluster. In order for this to work should be shut down and will generate an error if it is not.

The purpose of this option is to allow offline backups. The pg_xlog/pg_wal directory is copied as-is and archive-check is automatically disabled for the backup.

diff --git a/src/command/backup/backup.c b/src/command/backup/backup.c index 5cc8cbb91..ace5cbc8f 100644 --- a/src/command/backup/backup.c +++ b/src/command/backup/backup.c @@ -867,7 +867,7 @@ backupStart(BackupData *backupData) // Start backup LOG_INFO_FMT( - "execute %sexclusive pg_start_backup(): backup begins after the %s checkpoint completes", + "execute %sexclusive backup start: backup begins after the %s checkpoint completes", backupData->version >= PG_VERSION_96 ? "non-" : "", cfgOptionBool(cfgOptStartFast) ? "requested immediate" : "next regular"); @@ -989,7 +989,7 @@ backupFilePut(BackupData *backupData, Manifest *manifest, const String *name, ti manifestFileAdd(manifest, &file); - LOG_DETAIL_FMT("wrote '%s' file returned from pg_stop_backup()", strZ(name)); + LOG_DETAIL_FMT("wrote '%s' file returned from backup stop function", strZ(name)); } MEM_CONTEXT_TEMP_END(); } @@ -1021,7 +1021,7 @@ backupStop(BackupData *backupData, Manifest *manifest) { // Stop the backup LOG_INFO_FMT( - "execute %sexclusive pg_stop_backup() and wait for all WAL segments to archive", + "execute %sexclusive backup stop and wait for all WAL segments to archive", backupData->version >= PG_VERSION_96 ? "non-" : ""); DbBackupStopResult dbBackupStopResult = dbBackupStop(backupData->dbPrimary); diff --git a/src/command/check/common.c b/src/command/check/common.c index b8b0c9515..78e1c35f3 100644 --- a/src/command/check/common.c +++ b/src/command/check/common.c @@ -72,7 +72,7 @@ checkDbConfig(const unsigned int pgVersion, const unsigned int pgIdx, const Db * // Check archive configuration if option is valid for the command and set if (!isStandby && cfgOptionValid(cfgOptArchiveCheck) && cfgOptionBool(cfgOptArchiveCheck)) { - // Error if archive_mode = off since pg_start_backup () will fail + // Error if archive_mode = off since backup start will fail if (strCmpZ(dbArchiveMode(dbObject), "off") == 0) { THROW(ArchiveDisabledError, "archive_mode must be enabled"); diff --git a/test/src/module/command/backupTest.c b/test/src/module/command/backupTest.c index a66123f66..6dfc6b3b3 100644 --- a/test/src/module/command/backupTest.c +++ b/test/src/module/command/backupTest.c @@ -2291,14 +2291,14 @@ testRun(void) TEST_RESULT_VOID(testCmdBackup(), "backup"); TEST_RESULT_LOG( - "P00 INFO: execute exclusive pg_start_backup(): backup begins after the next regular checkpoint completes\n" + "P00 INFO: execute exclusive backup start: backup begins after the next regular checkpoint completes\n" "P00 INFO: backup start archive = 0000000105D944C000000000, lsn = 5d944c0/0\n" "P00 WARN: resumable backup 20191002-070640F of same type exists -- invalid files will be removed then the backup" " will resume\n" "P01 DETAIL: backup file " TEST_PATH "/pg1/global/pg_control (8KB, [PCT]) checksum [SHA1]\n" "P01 DETAIL: backup file " TEST_PATH "/pg1/postgresql.conf (11B, [PCT]) checksum [SHA1]\n" "P01 DETAIL: checksum resumed file " TEST_PATH "/pg1/PG_VERSION (3B, [PCT]) checksum [SHA1]\n" - "P00 INFO: execute exclusive pg_stop_backup() and wait for all WAL segments to archive\n" + "P00 INFO: execute exclusive backup stop and wait for all WAL segments to archive\n" "P00 INFO: backup stop archive = 0000000105D944C000000000, lsn = 5d944c0/800000\n" "P00 INFO: new backup label = 20191002-070640F\n" "P00 INFO: full backup size = [SIZE], file total = 3"); @@ -2432,7 +2432,7 @@ testRun(void) ((Storage *)storageRepoWrite())->pub.interface.feature |= 1 << storageFeaturePathSync; TEST_RESULT_LOG( - "P00 INFO: execute exclusive pg_start_backup(): backup begins after the next regular checkpoint completes\n" + "P00 INFO: execute exclusive backup start: backup begins after the next regular checkpoint completes\n" "P00 INFO: backup start archive = 0000000105D95D3000000000, lsn = 5d95d30/0\n" "P00 INFO: check archive for prior segment 0000000105D95D2F000000FF\n" "P00 WARN: resumable backup 20191003-105320F of same type exists -- invalid files will be removed then the backup" @@ -2460,7 +2460,7 @@ testRun(void) "P01 DETAIL: backup file " TEST_PATH "/pg1/not-in-resume (4B, [PCT]) checksum [SHA1]\n" "P01 DETAIL: backup file " TEST_PATH "/pg1/PG_VERSION (3B, [PCT]) checksum [SHA1]\n" "P01 DETAIL: backup file " TEST_PATH "/pg1/zero-size (0B, [PCT])\n" - "P00 INFO: execute exclusive pg_stop_backup() and wait for all WAL segments to archive\n" + "P00 INFO: execute exclusive backup stop and wait for all WAL segments to archive\n" "P00 INFO: backup stop archive = 0000000105D95D3000000000, lsn = 5d95d30/800000\n" "P00 INFO: check archive for segment(s) 0000000105D95D3000000000:0000000105D95D3000000000\n" "P00 DETAIL: copy segment 0000000105D95D3000000000 to backup\n" @@ -2596,7 +2596,7 @@ testRun(void) TEST_RESULT_LOG( "P00 INFO: last backup label = 20191003-105320F, version = " PROJECT_VERSION "\n" "P00 WARN: diff backup cannot alter compress-type option to 'none', reset to value in 20191003-105320F\n" - "P00 INFO: execute exclusive pg_start_backup(): backup begins after the next regular checkpoint completes\n" + "P00 INFO: execute exclusive backup start: backup begins after the next regular checkpoint completes\n" "P00 INFO: backup start archive = 0000000105D9759000000000, lsn = 5d97590/0\n" "P00 INFO: check archive for prior segment 0000000105D9758F000000FF\n" "P00 WARN: file 'time-mismatch2' has timestamp (1570200100) in the future (relative to copy start 1570200000)," @@ -2620,7 +2620,7 @@ testRun(void) "P01 DETAIL: backup file " TEST_PATH "/pg1/resume-ref (0B, [PCT])\n" "P00 DETAIL: hardlink pg_data/PG_VERSION to 20191003-105320F\n" "P00 DETAIL: hardlink pg_data/postgresql.conf to 20191003-105320F\n" - "P00 INFO: execute exclusive pg_stop_backup() and wait for all WAL segments to archive\n" + "P00 INFO: execute exclusive backup stop and wait for all WAL segments to archive\n" "P00 INFO: backup stop archive = 0000000105D9759000000000, lsn = 5d97590/800000\n" "P00 INFO: check archive for segment(s) 0000000105D9759000000000:0000000105D9759000000000\n" "P00 INFO: new backup label = 20191003-105320F_20191004-144000D\n" @@ -2940,7 +2940,7 @@ testRun(void) ((Storage *)storageRepoWrite())->pub.interface.feature |= 1 << storageFeatureHardLink; TEST_RESULT_LOG( - "P00 INFO: execute non-exclusive pg_start_backup(): backup begins after the next regular checkpoint completes\n" + "P00 INFO: execute non-exclusive backup start: backup begins after the next regular checkpoint completes\n" "P00 INFO: backup start archive = 0000000105DB5DE000000000, lsn = 5db5de0/0\n" "P00 INFO: check archive for segment 0000000105DB5DE000000000\n" "P01 DETAIL: backup file " TEST_PATH "/pg1/base/1/3 (40KB, [PCT]) checksum [SHA1]\n" @@ -2955,10 +2955,10 @@ testRun(void) "P01 DETAIL: backup file " TEST_PATH "/pg1/postgresql.conf (11B, [PCT]) checksum [SHA1]\n" "P01 DETAIL: backup file " TEST_PATH "/pg1/PG_VERSION (2B, [PCT]) checksum [SHA1]\n" "P01 DETAIL: backup file " TEST_PATH "/pg1/pg_tblspc/32768/PG_11_201809051/1/5 (0B, [PCT])\n" - "P00 INFO: execute non-exclusive pg_stop_backup() and wait for all WAL segments to archive\n" + "P00 INFO: execute non-exclusive backup stop and wait for all WAL segments to archive\n" "P00 INFO: backup stop archive = 0000000105DB5DE000000002, lsn = 5db5de0/280000\n" - "P00 DETAIL: wrote 'backup_label' file returned from pg_stop_backup()\n" - "P00 DETAIL: wrote 'tablespace_map' file returned from pg_stop_backup()\n" + "P00 DETAIL: wrote 'backup_label' file returned from backup stop function\n" + "P00 DETAIL: wrote 'tablespace_map' file returned from backup stop function\n" "P00 INFO: check archive for segment(s) 0000000105DB5DE000000000:0000000105DB5DE000000002\n" "P00 DETAIL: copy segment 0000000105DB5DE000000000 to backup\n" "P00 DETAIL: copy segment 0000000105DB5DE000000001 to backup\n" @@ -3070,7 +3070,7 @@ testRun(void) // Check log TEST_RESULT_LOG( "P00 INFO: last backup label = 20191027-181320F, version = " PROJECT_VERSION "\n" - "P00 INFO: execute non-exclusive pg_start_backup(): backup begins after the next regular checkpoint completes\n" + "P00 INFO: execute non-exclusive backup start: backup begins after the next regular checkpoint completes\n" "P00 INFO: backup start archive = 0000000105DB764000000000, lsn = 5db7640/0\n" "P00 INFO: check archive for prior segment 0000000105DB763F00000FFF"); @@ -3105,7 +3105,7 @@ testRun(void) TEST_RESULT_LOG( "P00 INFO: last backup label = 20191027-181320F, version = " PROJECT_VERSION "\n" - "P00 INFO: execute non-exclusive pg_start_backup(): backup begins after the next regular checkpoint completes\n" + "P00 INFO: execute non-exclusive backup start: backup begins after the next regular checkpoint completes\n" "P00 INFO: backup start archive = 0000002C05DB8EB000000000, lsn = 5db8eb0/0\n" "P00 INFO: check archive for segment 0000002C05DB8EB000000000\n" "P00 WARN: a timeline switch has occurred since the 20191027-181320F backup, enabling delta checksum\n" @@ -3118,10 +3118,10 @@ testRun(void) "P00 DETAIL: hardlink pg_data/base/1/1 to 20191027-181320F\n" "P00 DETAIL: hardlink pg_data/postgresql.conf to 20191027-181320F\n" "P00 DETAIL: hardlink pg_tblspc/32768/PG_11_201809051/1/5 to 20191027-181320F\n" - "P00 INFO: execute non-exclusive pg_stop_backup() and wait for all WAL segments to archive\n" + "P00 INFO: execute non-exclusive backup stop and wait for all WAL segments to archive\n" "P00 INFO: backup stop archive = 0000002C05DB8EB000000001, lsn = 5db8eb0/180000\n" - "P00 DETAIL: wrote 'backup_label' file returned from pg_stop_backup()\n" - "P00 DETAIL: wrote 'tablespace_map' file returned from pg_stop_backup()\n" + "P00 DETAIL: wrote 'backup_label' file returned from backup stop function\n" + "P00 DETAIL: wrote 'tablespace_map' file returned from backup stop function\n" "P00 INFO: check archive for segment(s) 0000002C05DB8EB000000000:0000002C05DB8EB000000001\n" "P00 INFO: new backup label = 20191027-181320F_20191030-014640I\n" "P00 INFO: incr backup size = [SIZE], file total = 7"); @@ -3237,7 +3237,7 @@ testRun(void) TEST_RESULT_VOID(testCmdBackup(), "backup"); TEST_RESULT_LOG( - "P00 INFO: execute non-exclusive pg_start_backup(): backup begins after the next regular checkpoint completes\n" + "P00 INFO: execute non-exclusive backup start: backup begins after the next regular checkpoint completes\n" "P00 INFO: backup start archive = 0000000105DB8EB000000000, lsn = 5db8eb0/0\n" "P00 INFO: check archive for segment 0000000105DB8EB000000000\n" "P00 DETAIL: store zero-length file " TEST_PATH "/pg1/zero\n" @@ -3250,10 +3250,10 @@ testRun(void) "P01 DETAIL: backup file " TEST_PATH "/pg1/bigish.dat (bundle 2/0, 8.0KB, [PCT]) checksum [SHA1]\n" "P01 DETAIL: backup file " TEST_PATH "/pg1/base/1/1 (bundle 3/0, 8KB, [PCT]) checksum [SHA1]\n" "P01 DETAIL: backup file " TEST_PATH "/pg1/global/pg_control (bundle 4/0, 8KB, [PCT]) checksum [SHA1]\n" - "P00 INFO: execute non-exclusive pg_stop_backup() and wait for all WAL segments to archive\n" + "P00 INFO: execute non-exclusive backup stop and wait for all WAL segments to archive\n" "P00 INFO: backup stop archive = 0000000105DB8EB000000001, lsn = 5db8eb0/180000\n" - "P00 DETAIL: wrote 'backup_label' file returned from pg_stop_backup()\n" - "P00 DETAIL: wrote 'tablespace_map' file returned from pg_stop_backup()\n" + "P00 DETAIL: wrote 'backup_label' file returned from backup stop function\n" + "P00 DETAIL: wrote 'tablespace_map' file returned from backup stop function\n" "P00 INFO: check archive for segment(s) 0000000105DB8EB000000000:0000000105DB8EB000000001\n" "P00 DETAIL: copy segment 0000000105DB8EB000000000 to backup\n" "P00 DETAIL: copy segment 0000000105DB8EB000000001 to backup\n" @@ -3369,17 +3369,17 @@ testRun(void) TEST_RESULT_LOG( "P00 INFO: last backup label = 20191030-014640F, version = 2.42dev\n" "P00 WARN: diff backup cannot alter 'checksum-page' option to 'false', reset to 'true' from 20191030-014640F\n" - "P00 INFO: execute non-exclusive pg_start_backup(): backup begins after the next regular checkpoint completes\n" + "P00 INFO: execute non-exclusive backup start: backup begins after the next regular checkpoint completes\n" "P00 INFO: backup start archive = 0000000105DBBF8000000000, lsn = 5dbbf80/0\n" "P00 INFO: check archive for segment 0000000105DBBF8000000000\n" "P00 DETAIL: store zero-length file " TEST_PATH "/pg1/zero\n" "P01 DETAIL: backup file " TEST_PATH "/pg1/global/pg_control (bundle 1/0, 8KB, [PCT]) checksum [SHA1]\n" "P01 DETAIL: match file from prior backup " TEST_PATH "/pg1/PG_VERSION (2B, [PCT]) checksum [SHA1]\n" "P00 DETAIL: reference pg_data/PG_VERSION to 20191030-014640F\n" - "P00 INFO: execute non-exclusive pg_stop_backup() and wait for all WAL segments to archive\n" + "P00 INFO: execute non-exclusive backup stop and wait for all WAL segments to archive\n" "P00 INFO: backup stop archive = 0000000105DBBF8000000001, lsn = 5dbbf80/300000\n" - "P00 DETAIL: wrote 'backup_label' file returned from pg_stop_backup()\n" - "P00 DETAIL: wrote 'tablespace_map' file returned from pg_stop_backup()\n" + "P00 DETAIL: wrote 'backup_label' file returned from backup stop function\n" + "P00 DETAIL: wrote 'tablespace_map' file returned from backup stop function\n" "P00 INFO: check archive for segment(s) 0000000105DBBF8000000000:0000000105DBBF8000000001\n" "P00 INFO: new backup label = 20191030-014640F_20191101-092000D\n" "P00 INFO: diff backup size = [SIZE], file total = 5");