diff --git a/doc/src/sgml/ref/pg_basebackup.sgml b/doc/src/sgml/ref/pg_basebackup.sgml index 1f15a17d0e..ba7d16abf0 100644 --- a/doc/src/sgml/ref/pg_basebackup.sgml +++ b/doc/src/sgml/ref/pg_basebackup.sgml @@ -56,7 +56,7 @@ PostgreSQL documentation and pg_hba.conf must explicitly permit the replication connection. The server must also be configured with set high enough to leave at least - one session available for the backup. + one session available for the backup and one for WAL streaming (if used). @@ -85,10 +85,8 @@ PostgreSQL documentation - There is no guarantee that all WAL files required for the backup are archived - at the end of backup. If you are planning to use the backup for an archive - recovery and want to ensure that all required files are available at that moment, - you need to include them into the backup by using the -x option. + If you are using -X none, there is no guarantee that all + WAL files required for the backup are archived at the end of backup. @@ -284,17 +282,6 @@ PostgreSQL documentation - - - - - - Using this option is equivalent of using -X with - method fetch. - - - - @@ -302,16 +289,26 @@ PostgreSQL documentation Includes the required transaction log files (WAL files) in the backup. This will include all transaction logs generated during - the backup. If this option is specified, it is possible to start - a postmaster directly in the extracted directory without the need - to consult the log archive, thus making this a completely standalone - backup. + the backup. Unless the method none is specified, + it is possible to start a postmaster directly in the extracted + directory without the need to consult the log archive, thus + making this a completely standalone backup. The following methods for collecting the transaction logs are supported: + + n + none + + + Don't include transaction log in the backup. + + + + f fetch @@ -349,6 +346,9 @@ PostgreSQL documentation named pg_wal.tar (if the server is a version earlier than 10, the file will be named pg_xlog.tar). + + This value is the default. + @@ -699,7 +699,7 @@ PostgreSQL documentation To create a backup of a single-tablespace local database and compress this with bzip2: -$ pg_basebackup -D - -Ft | bzip2 > backup.tar.bz2 +$ pg_basebackup -D - -Ft -X fetch | bzip2 > backup.tar.bz2 (This command will fail if there are multiple tablespaces in the database.) diff --git a/src/bin/pg_basebackup/pg_basebackup.c b/src/bin/pg_basebackup/pg_basebackup.c index 6c5c508e39..3f83d87e50 100644 --- a/src/bin/pg_basebackup/pg_basebackup.c +++ b/src/bin/pg_basebackup/pg_basebackup.c @@ -71,8 +71,8 @@ static bool noclean = false; static bool showprogress = false; static int verbose = 0; static int compresslevel = 0; -static bool includewal = false; -static bool streamwal = false; +static bool includewal = true; +static bool streamwal = true; static bool fastcheckpoint = false; static bool writerecoveryconf = false; static bool do_sync = true; @@ -325,8 +325,7 @@ usage(void) printf(_(" -S, --slot=SLOTNAME replication slot to use\n")); printf(_(" -T, --tablespace-mapping=OLDDIR=NEWDIR\n" " relocate tablespace in OLDDIR to NEWDIR\n")); - printf(_(" -x, --xlog include required WAL files in backup (fetch mode)\n")); - printf(_(" -X, --xlog-method=fetch|stream\n" + printf(_(" -X, --xlog-method=none|fetch|stream\n" " include required WAL files with specified method\n")); printf(_(" --xlogdir=XLOGDIR location for the transaction log directory\n")); printf(_(" -z, --gzip compress tar output\n")); @@ -1700,7 +1699,11 @@ BaseBackup(void) */ if (streamwal && !CheckServerVersionForStreaming(conn)) { - /* Error message already written in CheckServerVersionForStreaming() */ + /* + * Error message already written in CheckServerVersionForStreaming(), + * but add a hint about using -X none. + */ + fprintf(stderr, _("HINT: use -X none or -X fetch to disable log streaming\n")); disconnect_and_exit(1); } @@ -2035,7 +2038,6 @@ main(int argc, char **argv) {"write-recovery-conf", no_argument, NULL, 'R'}, {"slot", required_argument, NULL, 'S'}, {"tablespace-mapping", required_argument, NULL, 'T'}, - {"xlog", no_argument, NULL, 'x'}, {"xlog-method", required_argument, NULL, 'X'}, {"gzip", no_argument, NULL, 'z'}, {"compress", required_argument, NULL, 'Z'}, @@ -2078,7 +2080,7 @@ main(int argc, char **argv) atexit(cleanup_directories_atexit); - while ((c = getopt_long(argc, argv, "D:F:r:RT:xX:l:nNzZ:d:c:h:p:U:s:S:wWvP", + while ((c = getopt_long(argc, argv, "D:F:r:RT:X:l:nNzZ:d:c:h:p:U:s:S:wWvP", long_options, &option_index)) != -1) { switch (c) @@ -2111,38 +2113,29 @@ main(int argc, char **argv) case 'T': tablespace_list_append(optarg); break; - case 'x': - if (includewal) - { - fprintf(stderr, - _("%s: cannot specify both --xlog and --xlog-method\n"), - progname); - exit(1); - } - - includewal = true; - streamwal = false; - break; case 'X': - if (includewal) + if (strcmp(optarg, "n") == 0 || + strcmp(optarg, "none") == 0) { - fprintf(stderr, - _("%s: cannot specify both --xlog and --xlog-method\n"), - progname); - exit(1); - } - - includewal = true; - if (strcmp(optarg, "f") == 0 || - strcmp(optarg, "fetch") == 0) + includewal = false; streamwal = false; + } + else if (strcmp(optarg, "f") == 0 || + strcmp(optarg, "fetch") == 0) + { + includewal = true; + streamwal = false; + } else if (strcmp(optarg, "s") == 0 || strcmp(optarg, "stream") == 0) + { + includewal = true; streamwal = true; + } else { fprintf(stderr, - _("%s: invalid xlog-method option \"%s\", must be \"fetch\" or \"stream\"\n"), + _("%s: invalid xlog-method option \"%s\", must be \"fetch\", \"stream\" or \"none\"\n"), progname, optarg); exit(1); } diff --git a/src/bin/pg_basebackup/t/010_pg_basebackup.pl b/src/bin/pg_basebackup/t/010_pg_basebackup.pl index 7811093100..4c6670ce72 100644 --- a/src/bin/pg_basebackup/t/010_pg_basebackup.pl +++ b/src/bin/pg_basebackup/t/010_pg_basebackup.pl @@ -4,7 +4,7 @@ use Cwd; use Config; use PostgresNode; use TestLib; -use Test::More tests => 69; +use Test::More tests => 71; program_help_ok('pg_basebackup'); program_version_ok('pg_basebackup'); @@ -63,7 +63,7 @@ foreach my $filename (qw(backup_label tablespace_map postgresql.auto.conf.tmp)) close FILE; } -$node->command_ok([ 'pg_basebackup', '-D', "$tempdir/backup" ], +$node->command_ok([ 'pg_basebackup', '-D', "$tempdir/backup", '-X', 'none' ], 'pg_basebackup runs'); ok(-f "$tempdir/backup/PG_VERSION", 'backup was created'); @@ -225,6 +225,11 @@ like( qr/^primary_conninfo = '.*port=$port.*'\n/m, 'recovery.conf sets primary_conninfo'); +$node->command_ok([ 'pg_basebackup', '-D', "$tempdir/backupxd" ], + 'pg_basebackup runs in default xlog mode'); +ok(grep(/^[0-9A-F]{24}$/, slurp_dir("$tempdir/backupxd/pg_wal")), + 'WAL files copied'); + $node->command_ok( [ 'pg_basebackup', '-D', "$tempdir/backupxf", '-X', 'fetch' ], 'pg_basebackup -X fetch runs'); diff --git a/src/test/perl/PostgresNode.pm b/src/test/perl/PostgresNode.pm index c1b16ca9e9..f3c38bce0f 100644 --- a/src/test/perl/PostgresNode.pm +++ b/src/test/perl/PostgresNode.pm @@ -484,7 +484,7 @@ sub backup print "# Taking pg_basebackup $backup_name from node \"$name\"\n"; TestLib::system_or_bail('pg_basebackup', '-D', $backup_path, '-p', $port, - '-x', '--no-sync'); + '--no-sync'); print "# Backup finished\n"; }