From c6518d28cbc9e18f5445163a756692333529519d Mon Sep 17 00:00:00 2001 From: Michael Paquier Date: Thu, 6 Jan 2022 13:53:46 +0900 Subject: [PATCH v3 2/2] Rework the option set of pg_basebackup --- src/bin/pg_basebackup/pg_basebackup.c | 82 +++++++++++++++----- src/bin/pg_basebackup/t/010_pg_basebackup.pl | 19 ++++- doc/src/sgml/ref/pg_basebackup.sgml | 22 +++++- 3 files changed, 95 insertions(+), 28 deletions(-) diff --git a/src/bin/pg_basebackup/pg_basebackup.c b/src/bin/pg_basebackup/pg_basebackup.c index 17ff0132d9..7f29200832 100644 --- a/src/bin/pg_basebackup/pg_basebackup.c +++ b/src/bin/pg_basebackup/pg_basebackup.c @@ -113,6 +113,7 @@ static bool showprogress = false; static bool estimatesize = true; static int verbose = 0; static int compresslevel = 0; +static WalCompressionMethod compression_method = COMPRESSION_NONE; static IncludeWal includewal = STREAM_WAL; static bool fastcheckpoint = false; static bool writerecoveryconf = false; @@ -359,7 +360,9 @@ usage(void) printf(_(" -X, --wal-method=none|fetch|stream\n" " include required WAL files with specified method\n")); printf(_(" -z, --gzip compress tar output\n")); - printf(_(" -Z, --compress=0-9 compress tar output with given compression level\n")); + printf(_(" -Z, --compress=1-9 compress tar output with given compression level\n")); + printf(_(" --compression-method=METHOD\n" + " method to compress data\n")); printf(_("\nGeneral options:\n")); printf(_(" -c, --checkpoint=fast|spread\n" " set fast or spread checkpointing\n")); @@ -524,8 +527,7 @@ LogStreamerMain(logstreamer_param *param) stream.do_sync); else stream.walmethod = CreateWalTarMethod(param->xlog, - (compresslevel > 0) ? - COMPRESSION_GZIP : COMPRESSION_NONE, + compression_method, compresslevel, stream.do_sync); @@ -976,7 +978,7 @@ CreateBackupStreamer(char *archive_name, char *spclocation, bool is_recovery_guc_supported, bool expect_unterminated_tarfile) { - bbstreamer *streamer; + bbstreamer *streamer = NULL; bbstreamer *manifest_inject_streamer = NULL; bool inject_manifest; bool must_parse_archive; @@ -1035,19 +1037,22 @@ CreateBackupStreamer(char *archive_name, char *spclocation, archive_file = NULL; } + if (compression_method == COMPRESSION_NONE) + streamer = bbstreamer_plain_writer_new(archive_filename, + archive_file); #ifdef HAVE_LIBZ - if (compresslevel != 0) + else if (compression_method == COMPRESSION_GZIP) { strlcat(archive_filename, ".gz", sizeof(archive_filename)); streamer = bbstreamer_gzip_writer_new(archive_filename, archive_file, compresslevel); } - else #endif - streamer = bbstreamer_plain_writer_new(archive_filename, - archive_file); - + else + { + Assert(false); /* not reachable */ + } /* * If we need to parse the archive for whatever reason, then we'll @@ -1766,6 +1771,7 @@ main(int argc, char **argv) {"no-manifest", no_argument, NULL, 5}, {"manifest-force-encode", no_argument, NULL, 6}, {"manifest-checksums", required_argument, NULL, 7}, + {"compression-method", required_argument, NULL, 8}, {NULL, 0, NULL, 0} }; int c; @@ -1873,14 +1879,10 @@ main(int argc, char **argv) do_sync = false; break; case 'z': -#ifdef HAVE_LIBZ - compresslevel = Z_DEFAULT_COMPRESSION; -#else - compresslevel = 1; /* will be rejected below */ -#endif + compression_method = COMPRESSION_GZIP; break; case 'Z': - if (!option_parse_int(optarg, "-Z/--compress", 0, 9, + if (!option_parse_int(optarg, "-Z/--compress", 1, 9, &compresslevel)) exit(1); break; @@ -1942,6 +1944,18 @@ main(int argc, char **argv) case 7: manifest_checksums = pg_strdup(optarg); break; + case 8: + if (pg_strcasecmp(optarg, "gzip") == 0) + compression_method = COMPRESSION_GZIP; + else if (pg_strcasecmp(optarg, "none") == 0) + compression_method = COMPRESSION_NONE; + else + { + pg_log_error("invalid value \"%s\" for option %s", + optarg, "--compression-method"); + exit(1); + } + break; default: /* @@ -1979,7 +1993,7 @@ main(int argc, char **argv) /* * Mutually exclusive arguments */ - if (format == 'p' && compresslevel != 0) + if (format == 'p' && compression_method != COMPRESSION_NONE) { pg_log_error("only tar mode backups can be compressed"); fprintf(stderr, _("Try \"%s --help\" for more information.\n"), @@ -2057,13 +2071,39 @@ main(int argc, char **argv) } } -#ifndef HAVE_LIBZ - if (compresslevel != 0) + /* + * Compression-related options. + */ + switch (compression_method) { - pg_log_error("this build does not support compression"); - exit(1); - } + case COMPRESSION_NONE: + if (compresslevel != 0) + { + pg_log_error("cannot use --compress with --compression-method=%s", + "none"); + fprintf(stderr, _("Try \"%s --help\" for more information.\n"), + progname); + exit(1); + } + break; + case COMPRESSION_GZIP: +#ifdef HAVE_LIBZ + if (compresslevel == 0) + { + pg_log_info("no value specified for --compress, switching to default"); + compresslevel = Z_DEFAULT_COMPRESSION; + } +#else + pg_log_error("this build does not support compression with %s", + "gzip"); + exit(1); #endif + break; + case COMPRESSION_LZ4: + /* option not supported */ + Assert(false); + break; + } if (showprogress && !estimatesize) { diff --git a/src/bin/pg_basebackup/t/010_pg_basebackup.pl b/src/bin/pg_basebackup/t/010_pg_basebackup.pl index 192781e0a2..e5fec5f813 100644 --- a/src/bin/pg_basebackup/t/010_pg_basebackup.pl +++ b/src/bin/pg_basebackup/t/010_pg_basebackup.pl @@ -10,7 +10,7 @@ use File::Path qw(rmtree); use Fcntl qw(:seek); use PostgreSQL::Test::Cluster; use PostgreSQL::Test::Utils; -use Test::More tests => 113; +use Test::More tests => 115; program_help_ok('pg_basebackup'); program_version_ok('pg_basebackup'); @@ -31,6 +31,17 @@ my $pgdata = $node->data_dir; $node->command_fails(['pg_basebackup'], 'pg_basebackup needs target directory specified'); +# Sanity checks for options +$node->command_fails_like( + [ + 'pg_basebackup', '-D', + "$tempdir/backup", '--compression-method', + 'none', '--compress', + '1' + ], + qr/\Qpg_basebackup: error: cannot use --compress with --compression-method=none/, + 'failure if --compress specified with --compression-method=none'); + # Some Windows ANSI code pages may reject this filename, in which case we # quietly proceed without this bit of test coverage. if (open my $badchars, '>>', "$tempdir/pgdata/FOO\xe0\xe0\xe0BAR") @@ -636,10 +647,10 @@ SKIP: $node->command_ok( [ 'pg_basebackup', '-D', - "$tempdir/backup_gzip", '--compress', '1', - '--no-sync', '--format', 't' + "$tempdir/backup_gzip", '--compression-method', + 'gzip', '--compress', '1', '--no-sync', '--format', 't' ], - 'pg_basebackup with --compress'); + 'pg_basebackup with --compress and --compression-method=gzip'); # Verify that the stored files are generated with their expected # names. diff --git a/doc/src/sgml/ref/pg_basebackup.sgml b/doc/src/sgml/ref/pg_basebackup.sgml index 9e6807b457..9cbec844c8 100644 --- a/doc/src/sgml/ref/pg_basebackup.sgml +++ b/doc/src/sgml/ref/pg_basebackup.sgml @@ -372,9 +372,9 @@ PostgreSQL documentation Enables gzip compression of tar file output, and specifies the - compression level (0 through 9, 0 being no compression and 9 being best - compression). Compression is only available when using the tar - format, and the suffix .gz will + compression level (1 through 9, 1 being worst compression and 9 + being best compression). Compression is only available when using + the tar format, and the suffix .gz will automatically be added to all tar filenames. @@ -567,6 +567,22 @@ PostgreSQL documentation + + + + + Enables compression of backup data using the specified method. + Supported values gzip and none, + the default. + + + + The suffix .gz will automatically be added to + all filenames when using gzip. + + + + -- 2.34.1