From bc18451be43867723959f20f7192007342964393 Mon Sep 17 00:00:00 2001 From: Mahendra Singh Thalor Date: Tue, 11 Mar 2025 19:29:15 +0530 Subject: [PATCH 2/2] pg_dumpall with directory|tar|custom format and restore it by pg_restore new option to pg_dumpall: -F, --format=d|t|c|p output file format ( plain text (default)) Ex:1 ./pg_dumpall --format=directory --file=dumpDirName Ex:2 ./pg_dumpall --format=tar --file=dumpDirName Ex:3 ./pg_dumpall --format=custom --file=dumpDirName Ex:4 ./pg_dumpall --format=plain --file=dumpDirName dumps are as: global.dat ::: global sql commands in simple plain format map.dat. ::: dboid dbname ---entries for all databases in simple text form databases. ::: subdir dboid1 -> toc.dat and data files in archive format subdir dboid2. -> toc.dat and data files in archive format etc --------------------------------------------------------------------------- NOTE: if needed, restore single db by particular subdir Ex: ./pg_restore --format=directory -d postgres dumpDirName/databases/5 -- here, 5 is the dboid of postgres db -- to get dboid, refer dbname in map.file -------------------------------------------------------------------------- new options to pg_restore: -g, --globals-only restore only global objects, no databases --exclude-database=PATTERN exclude database whose name matches pattern When we give -g/--globals-only option, then only restore globals, no db restoring. Design: When --format=d|t|c is specified and there is no toc.dat in main directory, then check for global.dat to restore all databases. If global.dat file is exist in directory, then first restore all globals from global.dat and then restore all databases one by one from map.dat list (if exist) for --exclude-database=PATTERN for pg_restore as of now, SELECT 1 WHERE XXX OPERATOR(pg_catalog.~) '^(PATTERN)$' COLLATE pg_catalog.default if no db connection, then PATTERN=NAME matching only for each database, we are cleaning on_exit_nicely_index list. at the end of restore, we are giving warning with total number of errors (including global.dat, and each database errors) and for each database, we are printing warning with dbname and total errors. thread: https://www.postgresql.org/message-id/flat/CAKYtNAp9vOtydXL3_pnGJ%2BTetZtN%3DFYSnZSMCqXceU3mkHPxPg%40mail.gmail.com#066433cb5ae007cbe35fefddf796d52f --- doc/src/sgml/ref/pg_dumpall.sgml | 80 ++- doc/src/sgml/ref/pg_restore.sgml | 41 +- src/bin/pg_dump/meson.build | 3 +- src/bin/pg_dump/parallel.c | 11 +- src/bin/pg_dump/pg_backup.h | 2 +- src/bin/pg_dump/pg_backup_archiver.c | 20 +- src/bin/pg_dump/pg_backup_archiver.h | 3 +- src/bin/pg_dump/pg_backup_tar.c | 2 +- src/bin/pg_dump/pg_backup_utils.c | 22 +- src/bin/pg_dump/pg_backup_utils.h | 3 +- src/bin/pg_dump/pg_dump.c | 2 +- src/bin/pg_dump/pg_dumpall.c | 280 +++++++-- src/bin/pg_dump/pg_restore.c | 847 ++++++++++++++++++++++++++- src/bin/pg_dump/t/001_basic.pl | 9 + src/tools/pgindent/typedefs.list | 2 + 15 files changed, 1248 insertions(+), 79 deletions(-) mode change 100644 => 100755 src/bin/pg_dump/t/001_basic.pl diff --git a/doc/src/sgml/ref/pg_dumpall.sgml b/doc/src/sgml/ref/pg_dumpall.sgml index c2fa5be9519..c36802e06fd 100644 --- a/doc/src/sgml/ref/pg_dumpall.sgml +++ b/doc/src/sgml/ref/pg_dumpall.sgml @@ -16,7 +16,7 @@ PostgreSQL documentation pg_dumpall - extract a PostgreSQL database cluster into a script file + extract a PostgreSQL database cluster based on specified dump format @@ -121,7 +121,83 @@ PostgreSQL documentation Send output to the specified file. If this is omitted, the standard output is used. - + Note: This option can be omitted only when is plain + + + + + + + + + + Specify format of dump files. If we want to dump all the databases, + then pass this as non-plain so that dump of all databases can be taken + in separate subdirectory in archive format. + by default, this is plain format. + + If non-plain mode is passed, then global.dat (global sql commands) and + map.dat(dboid and dbnames list of all the databases) files will be created. + Apart from these files, one subdirectory with databases name will be created. + Under this databases subdirectory, there will be files with dboid name for each + database and if is directory, then toc.dat and other + dump files will be under dboid subdirectory. + + + + d + directory + + + Output a directory-format archive suitable for input into pg_restore. Under dboid + subdirectory, this will create a directory with one file for each table and large + object being dumped, plus a so-called Table of Contents file describing the dumped + objects in a machine-readable format that pg_restore can read. A directory format + archive can be manipulated with standard Unix tools; for example, files in an + uncompressed archive can be compressed with the gzip, lz4, or zstd tools. This + format is compressed by default using gzip and also supports parallel dumps. + + + + + + p + plain + + + Output a plain-text SQL script file (the default). + + + + + + c + custom + + + Output a custom-format archive suitable for input into pg_restore. Together with the + directory output format, this is the most flexible output format in that it allows manual + selection and reordering of archived items during restore. This format is also + compressed by default. + + + + + + t + tar + + + Output a tar-format archive suitable for input into pg_restore. The tar format is + compatible with the directory format: extracting a tar-format archive produces a valid + directory-format archive. However, the tar format does not support compression. Also, + when using tar format the relative order of table data items cannot be changed during restore. + + + + + + diff --git a/doc/src/sgml/ref/pg_restore.sgml b/doc/src/sgml/ref/pg_restore.sgml index 199ea3345f3..46bdbc092c3 100644 --- a/doc/src/sgml/ref/pg_restore.sgml +++ b/doc/src/sgml/ref/pg_restore.sgml @@ -18,8 +18,9 @@ PostgreSQL documentation pg_restore - restore a PostgreSQL database from an - archive file created by pg_dump + restore PostgreSQL database from an + archive file created by pg_dump or + pg_dumpall @@ -37,9 +38,10 @@ PostgreSQL documentation Description - pg_restore is a utility for restoring a + pg_restore is a utility for restoring PostgreSQL database from an archive - created by in one of the non-plain-text + created by or + in one of the non-plain-text formats. It will issue the commands necessary to reconstruct the database to the state it was in at the time it was saved. The archive files also allow pg_restore to @@ -140,6 +142,8 @@ PostgreSQL documentation commands that mention this database. Access privileges for the database itself are also restored, unless is specified. + is required when restoring multiple databases + from dump of pg_dumpall. @@ -166,6 +170,25 @@ PostgreSQL documentation + + + + + Do not restore databases whose name matches + pattern. + Multiple patterns can be excluded by writing multiple + switches. The + pattern parameter is + interpreted as a pattern according to the same rules used by + psql's \d + commands (see ), + so multiple databases can also be excluded by writing wildcard + characters in the pattern. When using wildcards, be careful to + quote the pattern if needed to prevent shell wildcard expansion. + + + + @@ -315,6 +338,16 @@ PostgreSQL documentation + + + + + + Restore only global objects (roles and tablespaces), no databases. + + + + diff --git a/src/bin/pg_dump/meson.build b/src/bin/pg_dump/meson.build index d5f805fb511..dc1ed410838 100644 --- a/src/bin/pg_dump/meson.build +++ b/src/bin/pg_dump/meson.build @@ -16,6 +16,7 @@ pg_dump_common_sources = files( 'pg_backup_null.c', 'pg_backup_tar.c', 'pg_backup_utils.c', + 'connectdb.c', ) pg_dump_common = static_library('libpgdump_common', @@ -30,7 +31,6 @@ pg_dump_sources = files( 'common.c', 'pg_dump.c', 'pg_dump_sort.c', - 'connectdb.c', ) if host_system == 'windows' @@ -70,6 +70,7 @@ bin_targets += pg_dumpall pg_restore_sources = files( 'pg_restore.c', + 'connectdb.c', ) if host_system == 'windows' diff --git a/src/bin/pg_dump/parallel.c b/src/bin/pg_dump/parallel.c index 086adcdc502..a36d2a5bf84 100644 --- a/src/bin/pg_dump/parallel.c +++ b/src/bin/pg_dump/parallel.c @@ -326,11 +326,18 @@ getThreadLocalPQExpBuffer(void) * pg_dump and pg_restore call this to register the cleanup handler * as soon as they've created the ArchiveHandle. */ -void +int on_exit_close_archive(Archive *AHX) { shutdown_info.AHX = AHX; - on_exit_nicely(archive_close_connection, &shutdown_info); + return on_exit_nicely(archive_close_connection, &shutdown_info); +} + +void +replace_on_exit_close_archive(Archive *AHX, int idx) +{ + shutdown_info.AHX = AHX; + set_on_exit_nicely_entry(archive_close_connection, &shutdown_info, idx); } /* diff --git a/src/bin/pg_dump/pg_backup.h b/src/bin/pg_dump/pg_backup.h index 731cb2d19fb..41ee305850a 100644 --- a/src/bin/pg_dump/pg_backup.h +++ b/src/bin/pg_dump/pg_backup.h @@ -309,7 +309,7 @@ extern void SetArchiveOptions(Archive *AH, DumpOptions *dopt, RestoreOptions *ro extern void ProcessArchiveRestoreOptions(Archive *AHX); -extern void RestoreArchive(Archive *AHX); +extern void RestoreArchive(Archive *AHX, bool append_data); /* Open an existing archive */ extern Archive *OpenArchive(const char *FileSpec, const ArchiveFormat fmt); diff --git a/src/bin/pg_dump/pg_backup_archiver.c b/src/bin/pg_dump/pg_backup_archiver.c index 12f3f39e39b..ad2a62a2c9c 100644 --- a/src/bin/pg_dump/pg_backup_archiver.c +++ b/src/bin/pg_dump/pg_backup_archiver.c @@ -85,7 +85,7 @@ static int RestoringToDB(ArchiveHandle *AH); static void dump_lo_buf(ArchiveHandle *AH); static void dumpTimestamp(ArchiveHandle *AH, const char *msg, time_t tim); static void SetOutput(ArchiveHandle *AH, const char *filename, - const pg_compress_specification compression_spec); + const pg_compress_specification compression_spec, bool append_data); static CompressFileHandle *SaveOutput(ArchiveHandle *AH); static void RestoreOutput(ArchiveHandle *AH, CompressFileHandle *savedOutput); @@ -336,9 +336,14 @@ ProcessArchiveRestoreOptions(Archive *AHX) StrictNamesCheck(ropt); } -/* Public */ +/* + * RestoreArchive + * + * If append_data is set, then append data into file as we are restoring dump + * of multiple databases which was taken by pg_dumpall. + */ void -RestoreArchive(Archive *AHX) +RestoreArchive(Archive *AHX, bool append_data) { ArchiveHandle *AH = (ArchiveHandle *) AHX; RestoreOptions *ropt = AH->public.ropt; @@ -455,7 +460,7 @@ RestoreArchive(Archive *AHX) */ sav = SaveOutput(AH); if (ropt->filename || ropt->compression_spec.algorithm != PG_COMPRESSION_NONE) - SetOutput(AH, ropt->filename, ropt->compression_spec); + SetOutput(AH, ropt->filename, ropt->compression_spec, append_data); ahprintf(AH, "--\n-- PostgreSQL database dump\n--\n\n"); @@ -1291,7 +1296,7 @@ PrintTOCSummary(Archive *AHX) sav = SaveOutput(AH); if (ropt->filename) - SetOutput(AH, ropt->filename, out_compression_spec); + SetOutput(AH, ropt->filename, out_compression_spec, false); if (strftime(stamp_str, sizeof(stamp_str), PGDUMP_STRFTIME_FMT, localtime(&AH->createDate)) == 0) @@ -1670,7 +1675,8 @@ archprintf(Archive *AH, const char *fmt,...) static void SetOutput(ArchiveHandle *AH, const char *filename, - const pg_compress_specification compression_spec) + const pg_compress_specification compression_spec, + bool append_data) { CompressFileHandle *CFH; const char *mode; @@ -1690,7 +1696,7 @@ SetOutput(ArchiveHandle *AH, const char *filename, else fn = fileno(stdout); - if (AH->mode == archModeAppend) + if (append_data || AH->mode == archModeAppend) mode = PG_BINARY_A; else mode = PG_BINARY_W; diff --git a/src/bin/pg_dump/pg_backup_archiver.h b/src/bin/pg_dump/pg_backup_archiver.h index a2064f471ed..ae433132435 100644 --- a/src/bin/pg_dump/pg_backup_archiver.h +++ b/src/bin/pg_dump/pg_backup_archiver.h @@ -385,7 +385,8 @@ struct _tocEntry }; extern int parallel_restore(ArchiveHandle *AH, TocEntry *te); -extern void on_exit_close_archive(Archive *AHX); +extern int on_exit_close_archive(Archive *AHX); +extern void replace_on_exit_close_archive(Archive *AHX, int idx); extern void warn_or_exit_horribly(ArchiveHandle *AH, const char *fmt,...) pg_attribute_printf(2, 3); diff --git a/src/bin/pg_dump/pg_backup_tar.c b/src/bin/pg_dump/pg_backup_tar.c index b5ba3b46dd9..d94d0de2a5d 100644 --- a/src/bin/pg_dump/pg_backup_tar.c +++ b/src/bin/pg_dump/pg_backup_tar.c @@ -826,7 +826,7 @@ _CloseArchive(ArchiveHandle *AH) savVerbose = AH->public.verbose; AH->public.verbose = 0; - RestoreArchive((Archive *) AH); + RestoreArchive((Archive *) AH, false); SetArchiveOptions((Archive *) AH, savDopt, savRopt); diff --git a/src/bin/pg_dump/pg_backup_utils.c b/src/bin/pg_dump/pg_backup_utils.c index 79aec5f5158..59ece2999a8 100644 --- a/src/bin/pg_dump/pg_backup_utils.c +++ b/src/bin/pg_dump/pg_backup_utils.c @@ -61,14 +61,26 @@ set_dump_section(const char *arg, int *dumpSections) /* Register a callback to be run when exit_nicely is invoked. */ -void +int on_exit_nicely(on_exit_nicely_callback function, void *arg) { - if (on_exit_nicely_index >= MAX_ON_EXIT_NICELY) - pg_fatal("out of on_exit_nicely slots"); - on_exit_nicely_list[on_exit_nicely_index].function = function; - on_exit_nicely_list[on_exit_nicely_index].arg = arg; + set_on_exit_nicely_entry(function, arg, on_exit_nicely_index); on_exit_nicely_index++; + + return (on_exit_nicely_index - 1); +} + +void +set_on_exit_nicely_entry(on_exit_nicely_callback function, void *arg, int i) +{ + if (i >= MAX_ON_EXIT_NICELY) + pg_fatal("out of on_exit_nicely slots"); + + if (i > on_exit_nicely_index) + pg_fatal("no entry exists on %d index into on_exit_nicely slots", i); + + on_exit_nicely_list[i].function = function; + on_exit_nicely_list[i].arg = arg; } /* diff --git a/src/bin/pg_dump/pg_backup_utils.h b/src/bin/pg_dump/pg_backup_utils.h index 38551944513..57f3197f103 100644 --- a/src/bin/pg_dump/pg_backup_utils.h +++ b/src/bin/pg_dump/pg_backup_utils.h @@ -28,7 +28,8 @@ typedef void (*on_exit_nicely_callback) (int code, void *arg); extern const char *progname; extern void set_dump_section(const char *arg, int *dumpSections); -extern void on_exit_nicely(on_exit_nicely_callback function, void *arg); +extern int on_exit_nicely(on_exit_nicely_callback function, void *arg); +extern void set_on_exit_nicely_entry(on_exit_nicely_callback function, void *arg, int idx); extern void exit_nicely(int code) pg_attribute_noreturn(); /* In pg_dump, we modify pg_fatal to call exit_nicely instead of exit */ diff --git a/src/bin/pg_dump/pg_dump.c b/src/bin/pg_dump/pg_dump.c index 6bb54c1a2b4..5b6d4364eb3 100644 --- a/src/bin/pg_dump/pg_dump.c +++ b/src/bin/pg_dump/pg_dump.c @@ -1186,7 +1186,7 @@ main(int argc, char **argv) * right now. */ if (plainText) - RestoreArchive(fout); + RestoreArchive(fout, false); CloseArchive(fout); diff --git a/src/bin/pg_dump/pg_dumpall.c b/src/bin/pg_dump/pg_dumpall.c index e7e492afa28..ee7c62da09d 100644 --- a/src/bin/pg_dump/pg_dumpall.c +++ b/src/bin/pg_dump/pg_dumpall.c @@ -15,6 +15,7 @@ #include "postgres_fe.h" +#include #include #include @@ -64,9 +65,10 @@ static void dropTablespaces(PGconn *conn); static void dumpTablespaces(PGconn *conn); static void dropDBs(PGconn *conn); static void dumpUserConfig(PGconn *conn, const char *username); -static void dumpDatabases(PGconn *conn); +static void dumpDatabases(PGconn *conn, ArchiveFormat archDumpFormat); static void dumpTimestamp(const char *msg); -static int runPgDump(const char *dbname, const char *create_opts); +static int runPgDump(const char *dbname, const char *create_opts, + char *dbfile, ArchiveFormat archDumpFormat); static void buildShSecLabels(PGconn *conn, const char *catalog_name, Oid objectId, const char *objtype, const char *objname, @@ -75,6 +77,8 @@ static void executeCommand(PGconn *conn, const char *query); static void expand_dbname_patterns(PGconn *conn, SimpleStringList *patterns, SimpleStringList *names); static void read_dumpall_filters(const char *filename, SimpleStringList *pattern); +static void create_or_open_dir(const char *dirname); +static ArchiveFormat parseDumpFormat(const char *format); static char pg_dump_bin[MAXPGPATH]; const char *progname; @@ -104,7 +108,7 @@ static int no_subscriptions = 0; static int no_toast_compression = 0; static int no_unlogged_table_data = 0; static int no_role_passwords = 0; -static int server_version; +static int server_version; static int load_via_partition_root = 0; static int on_conflict_do_nothing = 0; static int statistics_only = 0; @@ -143,6 +147,7 @@ main(int argc, char *argv[]) {"password", no_argument, NULL, 'W'}, {"no-privileges", no_argument, NULL, 'x'}, {"no-acl", no_argument, NULL, 'x'}, + {"format", required_argument, NULL, 'F'}, /* * the following options don't have an equivalent short option letter @@ -188,6 +193,8 @@ main(int argc, char *argv[]) char *pgdb = NULL; char *use_role = NULL; const char *dumpencoding = NULL; + ArchiveFormat archDumpFormat = archNull; + const char *formatName = "p"; trivalue prompt_password = TRI_DEFAULT; bool data_only = false; bool globals_only = false; @@ -237,7 +244,7 @@ main(int argc, char *argv[]) pgdumpopts = createPQExpBuffer(); - while ((c = getopt_long(argc, argv, "acd:E:f:gh:l:Op:rsS:tU:vwWx", long_options, &optindex)) != -1) + while ((c = getopt_long(argc, argv, "acd:E:f:F:gh:l:Op:rsS:tU:vwWx", long_options, &optindex)) != -1) { switch (c) { @@ -265,7 +272,9 @@ main(int argc, char *argv[]) appendPQExpBufferStr(pgdumpopts, " -f "); appendShellString(pgdumpopts, filename); break; - + case 'F': + formatName = pg_strdup(optarg); + break; case 'g': globals_only = true; break; @@ -414,6 +423,21 @@ main(int argc, char *argv[]) exit_nicely(1); } + /* Get format for dump. */ + archDumpFormat = parseDumpFormat(formatName); + + /* + * If non-plain format is specified then we must provide the + * file name to create one main directory. + */ + if (archDumpFormat != archNull && + (!filename || strcmp(filename, "") == 0)) + { + pg_log_error("options -F/--format=d|c|t requires option -f/--file with non-empty string"); + pg_log_error_hint("Try \"%s --help\" for more information.", progname); + exit_nicely(1); + } + /* * If password values are not required in the dump, switch to using * pg_roles which is equally useful, just more likely to have unrestricted @@ -468,6 +492,33 @@ main(int argc, char *argv[]) if (statistics_only) appendPQExpBufferStr(pgdumpopts, " --statistics-only"); + /* + * Open the output file if required, otherwise use stdout. If required, + * then create new directory and global.dat file. + */ + if (archDumpFormat != archNull) + { + char toc_path[MAXPGPATH]; + + /* Create new directory or accept the empty existing directory. */ + create_or_open_dir(filename); + + snprintf(toc_path, MAXPGPATH, "%s/global.dat", filename); + + OPF = fopen(toc_path, PG_BINARY_W); + if (!OPF) + pg_fatal("could not open global.dat file: %s", strerror(errno)); + } + else if (filename) + { + OPF = fopen(filename, PG_BINARY_W); + if (!OPF) + pg_fatal("could not open output file \"%s\": %m", + filename); + } + else + OPF = stdout; + /* * If there was a database specified on the command line, use that, * otherwise try to connect to database "postgres", and failing that @@ -507,19 +558,6 @@ main(int argc, char *argv[]) expand_dbname_patterns(conn, &database_exclude_patterns, &database_exclude_names); - /* - * Open the output file if required, otherwise use stdout - */ - if (filename) - { - OPF = fopen(filename, PG_BINARY_W); - if (!OPF) - pg_fatal("could not open output file \"%s\": %m", - filename); - } - else - OPF = stdout; - /* * Set the client encoding if requested. */ @@ -619,7 +657,7 @@ main(int argc, char *argv[]) } if (!globals_only && !roles_only && !tablespaces_only) - dumpDatabases(conn); + dumpDatabases(conn, archDumpFormat); PQfinish(conn); @@ -632,7 +670,7 @@ main(int argc, char *argv[]) fclose(OPF); /* sync the resulting file, errors are not fatal */ - if (dosync) + if (dosync && (archDumpFormat == archNull)) (void) fsync_fname(filename, false); } @@ -643,12 +681,14 @@ main(int argc, char *argv[]) static void help(void) { - printf(_("%s extracts a PostgreSQL database cluster into an SQL script file.\n\n"), progname); + printf(_("%s extracts a PostgreSQL database cluster based on specified dump format.\n\n"), progname); printf(_("Usage:\n")); printf(_(" %s [OPTION]...\n"), progname); printf(_("\nGeneral options:\n")); printf(_(" -f, --file=FILENAME output file name\n")); + printf(_(" -F, --format=c|d|t|p output file format (custom, directory, tar,\n" + " plain text (default))\n")); printf(_(" -v, --verbose verbose mode\n")); printf(_(" -V, --version output version information, then exit\n")); printf(_(" --lock-wait-timeout=TIMEOUT fail after waiting TIMEOUT for a table lock\n")); @@ -1551,10 +1591,13 @@ expand_dbname_patterns(PGconn *conn, * Dump contents of databases. */ static void -dumpDatabases(PGconn *conn) +dumpDatabases(PGconn *conn, ArchiveFormat archDumpFormat) { PGresult *res; int i; + char db_subdir[MAXPGPATH]; + char dbfilepath[MAXPGPATH]; + FILE *map_file = NULL; /* * Skip databases marked not datallowconn, since we'd be unable to connect @@ -1568,7 +1611,7 @@ dumpDatabases(PGconn *conn) * doesn't have some failure mode with --clean. */ res = executeQuery(conn, - "SELECT datname " + "SELECT datname, oid " "FROM pg_database d " "WHERE datallowconn AND datconnlimit != -2 " "ORDER BY (datname <> 'template1'), datname"); @@ -1576,9 +1619,33 @@ dumpDatabases(PGconn *conn) if (PQntuples(res) > 0) fprintf(OPF, "--\n-- Databases\n--\n\n"); + /* + * If directory/tar/custom format is specified then create a subdirectory + * under the main directory and each database dump file subdirectory will + * be created under the subdirectory in archive mode as per single db pg_dump. + */ + if (archDumpFormat != archNull) + { + char map_file_path[MAXPGPATH]; + + snprintf(db_subdir, MAXPGPATH, "%s/databases", filename); + + /* Create a subdirectory with 'databases' name under main directory. */ + if (mkdir(db_subdir, 0755) != 0) + pg_fatal("could not create subdirectory \"%s\": %m", db_subdir); + + snprintf(map_file_path, MAXPGPATH, "%s/map.dat", filename); + + /* Create a map file (to store dboid and dbname) */ + map_file = fopen(map_file_path, PG_BINARY_W); + if (!map_file) + pg_fatal("could not open map file: %s", strerror(errno)); + } + for (i = 0; i < PQntuples(res); i++) { char *dbname = PQgetvalue(res, i, 0); + char *oid = PQgetvalue(res, i, 1); const char *create_opts; int ret; @@ -1593,6 +1660,18 @@ dumpDatabases(PGconn *conn) continue; } + /* + * If this is non-plain dump format, then append dboid and dbname to + * the map.dat file. + */ + if (archDumpFormat != archNull) + { + snprintf(dbfilepath, MAXPGPATH, "\"%s\"/\"%s\"", db_subdir, oid); + + /* Put one line entry for dboid and dbname in map file. */ + fprintf(map_file, "%s %s\n", oid, pg_strdup(dbname)); + } + pg_log_info("dumping database \"%s\"", dbname); fprintf(OPF, "--\n-- Database \"%s\" dump\n--\n\n", dbname); @@ -1611,9 +1690,17 @@ dumpDatabases(PGconn *conn) create_opts = "--clean --create"; else { - create_opts = ""; /* Since pg_dump won't emit a \connect command, we must */ - fprintf(OPF, "\\connect %s\n\n", dbname); + if (archDumpFormat == archNull) + { + create_opts = ""; + fprintf(OPF, "\\connect %s\n\n", dbname); + } + else + { + /* Dumping all databases so add --create option. */ + create_opts = "--create"; + } } } else @@ -1622,19 +1709,30 @@ dumpDatabases(PGconn *conn) if (filename) fclose(OPF); - ret = runPgDump(dbname, create_opts); + ret = runPgDump(dbname, create_opts, dbfilepath, archDumpFormat); if (ret != 0) pg_fatal("pg_dump failed on database \"%s\", exiting", dbname); if (filename) { - OPF = fopen(filename, PG_BINARY_A); + char toc_path[MAXPGPATH]; + + if (archDumpFormat != archNull) + snprintf(toc_path, MAXPGPATH, "%s/global.dat", filename); + else + snprintf(toc_path, MAXPGPATH, "%s", filename); + + OPF = fopen(toc_path, PG_BINARY_A); if (!OPF) pg_fatal("could not re-open the output file \"%s\": %m", - filename); + toc_path); } } + /* Close map file */ + if (archDumpFormat != archNull) + fclose(map_file); + PQclear(res); } @@ -1644,7 +1742,8 @@ dumpDatabases(PGconn *conn) * Run pg_dump on dbname, with specified options. */ static int -runPgDump(const char *dbname, const char *create_opts) +runPgDump(const char *dbname, const char *create_opts, char *dbfile, + ArchiveFormat archDumpFormat) { PQExpBufferData connstrbuf; PQExpBufferData cmd; @@ -1653,17 +1752,36 @@ runPgDump(const char *dbname, const char *create_opts) initPQExpBuffer(&connstrbuf); initPQExpBuffer(&cmd); - printfPQExpBuffer(&cmd, "\"%s\" %s %s", pg_dump_bin, - pgdumpopts->data, create_opts); - /* - * If we have a filename, use the undocumented plain-append pg_dump - * format. + * If this is non-plain format dump, then append file name and dump + * format to the pg_dump command to get archive dump. */ - if (filename) - appendPQExpBufferStr(&cmd, " -Fa "); + if (archDumpFormat != archNull) + { + printfPQExpBuffer(&cmd, "\"%s\" -f %s %s", pg_dump_bin, + dbfile, create_opts); + + if (archDumpFormat == archDirectory) + appendPQExpBufferStr(&cmd, " --format=directory "); + else if (archDumpFormat == archCustom) + appendPQExpBufferStr(&cmd, " --format=custom "); + else if (archDumpFormat == archTar) + appendPQExpBufferStr(&cmd, " --format=tar "); + } else - appendPQExpBufferStr(&cmd, " -Fp "); + { + printfPQExpBuffer(&cmd, "\"%s\" %s %s", pg_dump_bin, + pgdumpopts->data, create_opts); + + /* + * If we have a filename, use the undocumented plain-append pg_dump + * format. + */ + if (filename) + appendPQExpBufferStr(&cmd, " -Fa "); + else + appendPQExpBufferStr(&cmd, " -Fp "); + } /* * Append the database name to the already-constructed stem of connection @@ -1808,3 +1926,91 @@ read_dumpall_filters(const char *filename, SimpleStringList *pattern) filter_free(&fstate); } + +/* + * create_or_open_dir + * + * This will create a new directory with given name. If there is already same + * empty directory exist, then use it. + */ +static void +create_or_open_dir(const char *dirname) +{ + struct stat st; + bool is_empty = false; + + /* we accept an empty existing directory */ + if (stat(dirname, &st) == 0 && S_ISDIR(st.st_mode)) + { + DIR *dir = opendir(dirname); + + if (dir) + { + struct dirent *d; + + is_empty = true; + + while (errno = 0, (d = readdir(dir))) + { + if (strcmp(d->d_name, ".") != 0 && strcmp(d->d_name, "..") != 0) + { + is_empty = false; + break; + } + } + + if (errno) + pg_fatal("could not read directory \"%s\": %m", + dirname); + + if (closedir(dir)) + pg_fatal("could not close directory \"%s\": %m", + dirname); + } + + if(!is_empty) + { + pg_log_error("directory \"%s\" exists but is not empty", dirname); + pg_log_error_hint("If you want to dump data on this directory, either remove or empty " + "this directory \"%s\" or run %s " + "with an argument other than \"%s\".", + dirname, progname, dirname); + exit_nicely(1); + } + } + else if (mkdir(dirname, 0700) < 0) + pg_fatal("could not create directory \"%s\": %m", dirname); +} + +/* + * parseDumpFormat + * + * This will validate dump formats. + */ +static ArchiveFormat +parseDumpFormat(const char *format) +{ + ArchiveFormat archDumpFormat; + + if (pg_strcasecmp(format, "c") == 0) + archDumpFormat = archCustom; + else if (pg_strcasecmp(format, "custom") == 0) + archDumpFormat = archCustom; + else if (pg_strcasecmp(format, "d") == 0) + archDumpFormat = archDirectory; + else if (pg_strcasecmp(format, "directory") == 0) + archDumpFormat = archDirectory; + else if (pg_strcasecmp(format, "p") == 0) + archDumpFormat = archNull; + else if (pg_strcasecmp(format, "plain") == 0) + archDumpFormat = archNull; + else if (pg_strcasecmp(format, "t") == 0) + archDumpFormat = archTar; + else if (pg_strcasecmp(format, "tar") == 0) + archDumpFormat = archTar; + else + pg_fatal("unrecognized archive format \"%s\"; please specify \"c\", \"d\", \"p\", or \"t\"", + format); + + return archDumpFormat; +} diff --git a/src/bin/pg_dump/pg_restore.c b/src/bin/pg_dump/pg_restore.c index 13e4dc507e0..9b802e7a6bd 100644 --- a/src/bin/pg_dump/pg_restore.c +++ b/src/bin/pg_dump/pg_restore.c @@ -2,7 +2,7 @@ * * pg_restore.c * pg_restore is an utility extracting postgres database definitions - * from a backup archive created by pg_dump using the archiver + * from a backup archive created by pg_dump/pg_dumpall using the archiver * interface. * * pg_restore will read the backup archive and @@ -41,30 +41,77 @@ #include "postgres_fe.h" #include +#include #ifdef HAVE_TERMIOS_H #include #endif +#include "common/connect.h" +#include "compress_io.h" +#include "common/string.h" +#include "connectdb.h" #include "fe_utils/option_utils.h" +#include "fe_utils/string_utils.h" #include "filter.h" #include "getopt_long.h" #include "parallel.h" +#include "pg_backup_archiver.h" #include "pg_backup_utils.h" +typedef struct SimpleDatabaseOidListCell +{ + struct SimpleDatabaseOidListCell *next; + Oid db_oid; + const char *db_name; +} SimpleDatabaseOidListCell; + +typedef struct SimpleDatabaseOidList +{ + SimpleDatabaseOidListCell *head; + SimpleDatabaseOidListCell *tail; +} SimpleDatabaseOidList; + static void usage(const char *progname); static void read_restore_filters(const char *filename, RestoreOptions *opts); +static bool IsFileExistsInDirectory(const char *dir, const char *filename); +static int restoreOneDatabase(const char *inputFileSpec, RestoreOptions *opts, + int numWorkers, bool append_data, int num); +static int ReadOneStatement(StringInfo inBuf, FILE *pfile); +static int restoreAllDatabases(PGconn *conn, const char *dumpdirpath, + SimpleStringList db_exclude_patterns, RestoreOptions *opts, int numWorkers); +static int process_global_sql_commands(PGconn *conn, const char *dumpdirpath, + const char *outfile); +static void copy_or_print_global_file(const char *outfile, FILE *pfile); +static int get_dbnames_list_to_restore(PGconn *conn, + SimpleDatabaseOidList *dbname_oid_list, + SimpleStringList db_exclude_patterns); +static int get_dbname_oid_list_from_mfile(const char *dumpdirpath, + SimpleDatabaseOidList *dbname_oid_list); +static void simple_db_oid_list_append(SimpleDatabaseOidList *list, Oid db_oid, + const char *dbname); +static void simple_string_full_list_delete(SimpleStringList *list); +static void simple_db_oid_full_list_delete(SimpleDatabaseOidList *list); +static void simple_db_oid_list_delete(SimpleDatabaseOidList *list, + SimpleDatabaseOidListCell *cell, + SimpleDatabaseOidListCell *prev); +static void simple_db_oid_list_append(SimpleDatabaseOidList *list, + Oid db_oid, const char *dbname); +static size_t quote_literal_internal(char *dst, const char *src, size_t len); +static char *quote_literal_cstr(const char *rawstr); +static int on_exit_index = 0; int main(int argc, char **argv) { RestoreOptions *opts; int c; - int exit_code; int numWorkers = 1; - Archive *AH; char *inputFileSpec; bool data_only = false; bool schema_only = false; + int n_errors = 0; + bool globals_only = false; + SimpleStringList db_exclude_patterns = {NULL, NULL}; static int disable_triggers = 0; static int enable_row_security = 0; static int if_exists = 0; @@ -86,6 +133,7 @@ main(int argc, char **argv) {"clean", 0, NULL, 'c'}, {"create", 0, NULL, 'C'}, {"data-only", 0, NULL, 'a'}, + {"globals-only", 0, NULL, 'g'}, {"dbname", 1, NULL, 'd'}, {"exit-on-error", 0, NULL, 'e'}, {"exclude-schema", 1, NULL, 'N'}, @@ -136,6 +184,7 @@ main(int argc, char **argv) {"no-statistics", no_argument, &no_statistics, 1}, {"statistics-only", no_argument, &statistics_only, 1}, {"filter", required_argument, NULL, 4}, + {"exclude-database", required_argument, NULL, 6}, {NULL, 0, NULL, 0} }; @@ -164,7 +213,7 @@ main(int argc, char **argv) } } - while ((c = getopt_long(argc, argv, "acCd:ef:F:h:I:j:lL:n:N:Op:P:RsS:t:T:U:vwWx1", + while ((c = getopt_long(argc, argv, "acCd:ef:F:gh:I:j:lL:n:N:Op:P:RsS:t:T:U:vwWx1", cmdopts, NULL)) != -1) { switch (c) @@ -191,11 +240,14 @@ main(int argc, char **argv) if (strlen(optarg) != 0) opts->formatName = pg_strdup(optarg); break; + case 'g': + /* restore only global.dat file from directory */ + globals_only = true; + break; case 'h': if (strlen(optarg) != 0) opts->cparams.pghost = pg_strdup(optarg); break; - case 'j': /* number of restore jobs */ if (!option_parse_int(optarg, "-j/--jobs", 1, PG_MAX_JOBS, @@ -310,6 +362,10 @@ main(int argc, char **argv) exit(1); opts->exit_on_error = true; break; + case 6: + /* list of databases patterns those needs to skip while restoring */ + simple_string_list_append(&db_exclude_patterns, optarg); + break; default: /* getopt_long already emitted a complaint */ @@ -337,6 +393,13 @@ main(int argc, char **argv) if (!opts->cparams.dbname && !opts->filename && !opts->tocSummary) pg_fatal("one of -d/--dbname and -f/--file must be specified"); + if (db_exclude_patterns.head != NULL && globals_only) + { + pg_log_error("option --exclude-database cannot be used together with -g/--globals-only"); + pg_log_error_hint("Try \"%s --help\" for more information.", progname); + exit_nicely(1); + } + /* Should get at most one of -d and -f, else user is confused */ if (opts->cparams.dbname) { @@ -417,6 +480,108 @@ main(int argc, char **argv) opts->formatName); } + /* + * If toc.dat file does not present in current path, then check for + * global.dat. If global.dat file is present, then restore all the + * databases from map.dat(if exist) file list and skip restoring for + * --exclude-database patterns. + */ + if (inputFileSpec != NULL && !IsFileExistsInDirectory(inputFileSpec, "toc.dat") && + IsFileExistsInDirectory(inputFileSpec, "global.dat")) + { + PGconn *conn = NULL; /* Connection to restore global sql commands. */ + + /* + * User is suggested to use single database dump for --list option. + */ + if (opts->tocSummary) + pg_fatal("option -l/--list cannot be used when restoring multiple databases by archive of pg_dumpall"); + + /* + * To restore multiple databases, -C (create database) option should be specified. + * Even there is single database in dump, report error because it might be possible + * that database hasn't created so better we report error. + */ + if (!globals_only && opts->createDB != 1) + { + pg_log_error("-C/--create option should be specified when restoring multiple databases by archive of pg_dumpall"); + pg_log_error_hint("Try \"%s --help\" for more information.", progname); + pg_log_error_hint("If db is already created and dump has single db dump, then use particular dump file."); + exit_nicely(1); + } + + /* + * Connect to database to execute global sql commands from global.dat file. + */ + if (opts->cparams.dbname) + { + conn = ConnectDatabase(opts->cparams.dbname, NULL, opts->cparams.pghost, + opts->cparams.pgport, opts->cparams.username, TRI_DEFAULT, + false, progname, NULL, NULL, NULL, NULL); + + if (!conn) + pg_fatal("could not connect to database \"%s\"", opts->cparams.dbname); + } + + /* If globals-only, then return from here. */ + if (globals_only) + { + /* Open global.dat file and execute/append all the global sql commands. */ + n_errors = process_global_sql_commands(conn, inputFileSpec, + opts->filename); + + if (conn) + PQfinish(conn); + + pg_log_info("databases restoring is skipped as -g/--globals-only option is specified"); + } + else + { + /* Now restore all the databases from map.dat file. */ + n_errors = restoreAllDatabases(conn, inputFileSpec, db_exclude_patterns, + opts, numWorkers); + } + + /* Free db pattern list. */ + simple_string_full_list_delete(&db_exclude_patterns); + } + else /* process if global.dat file does not exist. */ + { + if (db_exclude_patterns.head != NULL) + pg_fatal("option --exclude-database can be used only when restoring multiple databases by archive of pg_dumpall"); + + if (globals_only) + pg_fatal("option -g/--globals-only can be used only when restoring multiple databases by archive of pg_dumpall"); + + n_errors = restoreOneDatabase(inputFileSpec, opts, numWorkers, false, 0); + } + + on_exit_index = 0; /* Reset index. */ + + /* Done, print a summary of ignored errors during restore. */ + if (n_errors) + { + pg_log_warning("errors ignored on restore: %d", n_errors); + return 1; + } + + return 0; +} + +/* + * restoreOneDatabase + * + * This will restore one database using toc.dat file. + * + * returns the number of errors while doing restore. + */ +static int +restoreOneDatabase(const char *inputFileSpec, RestoreOptions *opts, + int numWorkers, bool append_data, int num) +{ + Archive *AH; + int n_errors; + AH = OpenArchive(inputFileSpec, opts->format); SetArchiveOptions(AH, NULL, opts); @@ -425,8 +590,14 @@ main(int argc, char **argv) * We don't have a connection yet but that doesn't matter. The connection * is initialized to NULL and if we terminate through exit_nicely() while * it's still NULL, the cleanup function will just be a no-op. + * If we are restoring multiple databases, then save index of exit_nicely + * so that we can use same slot for all the databases as we already closed + * the previous archive by CloseArchive. */ - on_exit_close_archive(AH); + if (!append_data || num == 0) + on_exit_index = on_exit_close_archive(AH); + else + replace_on_exit_close_archive(AH, on_exit_index); /* Let the archiver know how noisy to be */ AH->verbose = opts->verbose; @@ -446,25 +617,22 @@ main(int argc, char **argv) else { ProcessArchiveRestoreOptions(AH); - RestoreArchive(AH); + RestoreArchive(AH, append_data); } - /* done, print a summary of ignored errors */ - if (AH->n_errors) - pg_log_warning("errors ignored on restore: %d", AH->n_errors); + n_errors = AH->n_errors; /* AH may be freed in CloseArchive? */ - exit_code = AH->n_errors ? 1 : 0; - CloseArchive(AH); - return exit_code; + return n_errors; } static void usage(const char *progname) { - printf(_("%s restores a PostgreSQL database from an archive created by pg_dump.\n\n"), progname); + printf(_("%s restores a PostgreSQL database from an archive created by pg_dump.\n" + "If archive is created by pg_dumpall, then restores multiple databases also. \n\n"), progname); printf(_("Usage:\n")); printf(_(" %s [OPTION]... [FILE]\n"), progname); @@ -482,6 +650,7 @@ usage(const char *progname) printf(_(" -c, --clean clean (drop) database objects before recreating\n")); printf(_(" -C, --create create the target database\n")); printf(_(" -e, --exit-on-error exit on error, default is to continue\n")); + printf(_(" -g, --globals-only restore only global objects, no databases\n")); printf(_(" -I, --index=NAME restore named index\n")); printf(_(" -j, --jobs=NUM use this many parallel jobs to restore\n")); printf(_(" -L, --use-list=FILENAME use table of contents from this file for\n" @@ -494,6 +663,7 @@ usage(const char *progname) printf(_(" -S, --superuser=NAME superuser user name to use for disabling triggers\n")); printf(_(" -t, --table=NAME restore named relation (table, view, etc.)\n")); printf(_(" -T, --trigger=NAME restore named trigger\n")); + printf(_(" --exclude-database=PATTERN exclude databases whose name matches with pattern\n")); printf(_(" -x, --no-privileges skip restoration of access privileges (grant/revoke)\n")); printf(_(" -1, --single-transaction restore as a single transaction\n")); printf(_(" --disable-triggers disable triggers during data-only restore\n")); @@ -530,8 +700,8 @@ usage(const char *progname) printf(_(" --role=ROLENAME do SET ROLE before restore\n")); printf(_("\n" - "The options -I, -n, -N, -P, -t, -T, and --section can be combined and specified\n" - "multiple times to select multiple objects.\n")); + "The options -I, -n, -N, -P, -t, -T, --section, and --exclude-database can be combined\n" + "and specified multiple times to select multiple objects.\n")); printf(_("\nIf no input file name is supplied, then standard input is used.\n\n")); printf(_("Report bugs to <%s>.\n"), PACKAGE_BUGREPORT); printf(_("%s home page: <%s>\n"), PACKAGE_NAME, PACKAGE_URL); @@ -636,3 +806,648 @@ read_restore_filters(const char *filename, RestoreOptions *opts) filter_free(&fstate); } + +/* + * IsFileExistsInDirectory + * + * Returns true if file exist in current directory. + */ +static bool +IsFileExistsInDirectory(const char *dir, const char *filename) +{ + struct stat st; + char buf[MAXPGPATH]; + + if (snprintf(buf, MAXPGPATH, "%s/%s", dir, filename) >= MAXPGPATH) + pg_fatal("directory name too long: \"%s\"", dir); + + return (stat(buf, &st) == 0 && S_ISREG(st.st_mode)); +} + +/* + * ReadOneStatement + * + * This will start reading from passed file pointer using fgetc and read till + * semicolon(sql statement terminator for global.dat file) + * + * EOF is returned if end-of-file input is seen; time to shut down. + */ + +static int +ReadOneStatement(StringInfo inBuf, FILE *pfile) +{ + int c; /* character read from getc() */ + int m; + + StringInfoData q; + initStringInfo(&q); + + resetStringInfo(inBuf); + + /* + * Read characters until EOF or the appropriate delimiter is seen. + */ + while ((c = fgetc(pfile)) != EOF) + { + if (c != '\'' && c != '"' && c != '\n' && c != ';') + { + appendStringInfoChar(inBuf, (char) c); + while ((c = fgetc(pfile)) != EOF) + { + if (c != '\'' && c != '"' && c != ';' && c != '\n') + appendStringInfoChar(inBuf, (char) c); + else + break; + } + } + + if (c == '\'' || c == '"') + { + appendStringInfoChar(&q, (char) c); + m = c; + + while ((c = fgetc(pfile)) != EOF) + { + appendStringInfoChar(&q, (char) c); + + if(c == m) + { + appendStringInfoString(inBuf, q.data); + resetStringInfo(&q); + break; + } + } + } + + if (c == ';') + { + appendStringInfoChar(inBuf, (char) ';'); + break; + } + + if (c == '\n') + appendStringInfoChar(inBuf, (char) '\n'); + } + + /* No input before EOF signal means time to quit. */ + if (c == EOF && inBuf->len == 0) + return EOF; + + /* Add '\0' to make it look the same as message case. */ + appendStringInfoChar(inBuf, (char) '\0'); + + return 'Q'; +} + +/* + * get_dbnames_list_to_restore + * + * This will remove entries from dbname_oid_list that pattern matching any + * in the db_exclude_patterns list. dbname_oid_list maybe inplace modified. + * + * returns, number of database will be restored. + * + */ +static int +get_dbnames_list_to_restore(PGconn *conn, + SimpleDatabaseOidList *dbname_oid_list, + SimpleStringList db_exclude_patterns) +{ + SimpleDatabaseOidListCell *dboid_cell = dbname_oid_list->head; + SimpleDatabaseOidListCell *dboidprecell = NULL; + int count_db = 0; + PQExpBuffer query; + PGresult *res; + + /* Return 0 if there is no database to restore. */ + if (dboid_cell == NULL) + return 0; + + query = createPQExpBuffer(); + + if (!conn) + pg_log_info("considering PATTERN as NAME for --exclude-database option as no db connection while doing pg_restore."); + + /* + * Process one by one all dbnames and if specified to skip restoring, then + * remove dbname from list. + */ + while (dboid_cell != NULL) + { + bool skip_db_restore = false; + SimpleDatabaseOidListCell *next = dboid_cell->next; + + for (SimpleStringListCell *celldb = db_exclude_patterns.head; celldb; celldb = celldb->next) + { + /* + * the construct pattern matching query: + * SELECT 1 WHERE XXX OPERATOR(pg_catalog.~) '^(PATTERN)$' COLLATE + * pg_catalog.default + * + * XXX represents the string literal database name derived from the + * dbname_oid_list, which is initially extracted from the map.dat + * file located in the backup directory. that's why we need + * quote_literal_cstr. + * + * If no db connection, then consider PATTERN as NAME. + */ + if (pg_strcasecmp(dboid_cell->db_name, celldb->val) == 0) + skip_db_restore = true; + else if (conn) + { + int dotcnt; + + appendPQExpBufferStr(query, "SELECT 1 "); + processSQLNamePattern(conn, query, celldb->val, false, + false, NULL, quote_literal_cstr(dboid_cell->db_name), + NULL, NULL, NULL, &dotcnt); + + if (dotcnt > 0) + { + pg_log_error("improper qualified name (too many dotted names): %s", + celldb->val); + PQfinish(conn); + exit_nicely(1); + } + + res = executeQuery(conn, query->data); + + if ((PQresultStatus(res) == PGRES_TUPLES_OK) && PQntuples(res)) + { + skip_db_restore = true; + pg_log_info("database \"%s\" is matching with exclude pattern: \"%s\"", dboid_cell->db_name, celldb->val); + } + + PQclear(res); + resetPQExpBuffer(query); + } + + if (skip_db_restore) + break; + } + + /* Increment count if database needs to be restored. */ + if (skip_db_restore) + { + pg_log_info("excluding database \"%s\"", dboid_cell->db_name); + simple_db_oid_list_delete(dbname_oid_list, dboid_cell, dboidprecell); + } + else + { + count_db++; + dboidprecell = dboid_cell; + } + + /* Process next dbname from dbname list. */ + dboid_cell = next; + } + + return count_db; +} + +/* + * get_dbname_oid_list_from_mfile + * + * Open map.dat file and read line by line and then prepare a list of database + * names and corresponding db_oid. + * + * Returns, total number of database names in map.dat file. + */ +static int +get_dbname_oid_list_from_mfile(const char *dumpdirpath, SimpleDatabaseOidList *dbname_oid_list) +{ + FILE *pfile; + char map_file_path[MAXPGPATH]; + char line[MAXPGPATH]; + int count = 0; + + /* + * If there is only global.dat file in dump, then return from here as there + * is no database to restore. + */ + if (!IsFileExistsInDirectory(pg_strdup(dumpdirpath), "map.dat")) + { + pg_log_info("databases restoring is skipped as map.dat file is not present in \"%s\"", dumpdirpath); + return 0; + } + + snprintf(map_file_path, MAXPGPATH, "%s/map.dat", dumpdirpath); + + /* Open map.dat file. */ + pfile = fopen(map_file_path, PG_BINARY_R); + + if (pfile == NULL) + pg_fatal("could not open map.dat file: \"%s\"", map_file_path); + + /* Append all the dbname and db_oid to the list. */ + while((fgets(line, MAXPGPATH, pfile)) != NULL) + { + Oid db_oid = InvalidOid; + char db_oid_str[MAXPGPATH + 1] = {'\0'}; + char dbname[MAXPGPATH + 1] = {'\0'}; + + /* Extract dboid. */ + sscanf(line, "%u" , &db_oid); + sscanf(line, "%s" , db_oid_str); + + /* Now copy dbname. */ + strcpy(dbname, line + strlen(db_oid_str) + 1); + + /* Remove \n from dbanme. */ + dbname[strlen(dbname) - 1] = '\0'; + + pg_log_info("found database \"%s\" (OID: %u) in map.dat file while restoring.", dbname, db_oid); + + /* Report error and exit if the file has any corrupted data. */ + if (!OidIsValid(db_oid) || strlen(dbname) == 0) + pg_fatal("invalid entry in map.dat file at line : %d", count + 1); + + /* + * XXX : before adding dbname into list, we can verify that this db + * needs to skipped for restore or not but as of now, we are making + * a list of all the databases. + */ + simple_db_oid_list_append(dbname_oid_list, db_oid, dbname); + count++; + } + + /* Close map.dat file. */ + fclose(pfile); + + return count; +} + +/* + * restoreAllDatabases + * + * This will restore databases those dumps are present in + * directory based on map.dat file mapping. + * + * This will skip restoring for databases that are specified with + * exclude-database option. + * + * returns, number of errors while doing restore. + */ +static int +restoreAllDatabases(PGconn *conn, const char *dumpdirpath, + SimpleStringList db_exclude_patterns, RestoreOptions *opts, + int numWorkers) +{ + SimpleDatabaseOidList dbname_oid_list = {NULL, NULL}; + SimpleDatabaseOidListCell *dboid_cell; + int num_db_restore = 0; + int num_total_db; + int n_errors_total; + int count = 0; + + num_total_db = get_dbname_oid_list_from_mfile(dumpdirpath, &dbname_oid_list); + + /* + * If map.dat has no entry, return from here after processing + * global.dat file. + */ + if (dbname_oid_list.head == NULL) + return process_global_sql_commands(conn, dumpdirpath, opts->filename); + + pg_log_info("found total %d database names in map.dat file", num_total_db); + + if (!conn) + { + pg_log_info("trying to connect database \"postgres\" to dump into out file"); + + conn = ConnectDatabase("postgres", NULL, opts->cparams.pghost, + opts->cparams.pgport, opts->cparams.username, TRI_DEFAULT, + false, progname, NULL, NULL, NULL, NULL); + + /* Try with template1. */ + if (!conn) + { + pg_log_info("trying to connect database \"template1\" as failed to connect to database \"postgres\" to dump into out file"); + + conn = ConnectDatabase("template1", NULL, opts->cparams.pghost, + opts->cparams.pgport, opts->cparams.username, TRI_DEFAULT, + false, progname, NULL, NULL, NULL, NULL); + } + } + + /* + * processing pg_retsore --exclude-database=PATTERN/NAME if no connection. + */ + num_db_restore = get_dbnames_list_to_restore(conn, &dbname_oid_list, + db_exclude_patterns); + + /* Open global.dat file and execute/append all the global sql commands. */ + n_errors_total = process_global_sql_commands(conn, dumpdirpath, opts->filename); + + /* Close the db connection as we are done with globals and patterns. */ + if (conn) + PQfinish(conn); + + /* Exit if no db needs to be restored. */ + if (dbname_oid_list.head == NULL) + { + pg_log_info("no database needs to restore out of %d databases", num_total_db); + return n_errors_total; + } + + pg_log_info("needs to restore %d databases out of %d databases", num_db_restore, num_total_db); + + /* + * Till now, we made a list of databases, those needs to be restored + * after skipping names of exclude-database. Now we can launch parallel + * workers to restore these databases. + */ + dboid_cell = dbname_oid_list.head; + + while(dboid_cell != NULL) + { + char subdirpath[MAXPGPATH]; + int n_errors; + + /* + * We need to reset override_dbname so that objects can be restored into + * already created database. (used with -d/--dbname option) + */ + if (opts->cparams.override_dbname) + { + pfree(opts->cparams.override_dbname); + opts->cparams.override_dbname = NULL; + } + + snprintf(subdirpath, MAXPGPATH, "%s/databases/%u", dumpdirpath, dboid_cell->db_oid); + + pg_log_info("restoring database \"%s\"", dboid_cell->db_name); + + /* Restore single database. */ + n_errors = restoreOneDatabase(subdirpath, opts, numWorkers, true, count); + + /* Print a summary of ignored errors during single database restore. */ + if (n_errors) + { + n_errors_total += n_errors; + pg_log_warning("errors ignored on database \"%s\" restore: %d", dboid_cell->db_name, n_errors); + } + + dboid_cell = dboid_cell->next; + count++; + } + + /* Log number of processed databases.*/ + pg_log_info("number of restored databases are %d", num_db_restore); + + /* Free dbname and dboid list. */ + simple_db_oid_full_list_delete(&dbname_oid_list); + + return n_errors_total; +} + +/* + * process_global_sql_commands + * + * This will open global.dat file and will execute all global sql commands one + * by one statement. + * Semicolon is considered as statement terminator. If outfile is passed, then + * this will copy all sql commands into outfile rather then executing them. + * + * returns the number of errors while processing global.dat + */ +static int +process_global_sql_commands(PGconn *conn, const char *dumpdirpath, const char *outfile) +{ + char global_file_path[MAXPGPATH]; + PGresult *result; + StringInfoData sqlstatement; + FILE *pfile; + int n_errors = 0; + + snprintf(global_file_path, MAXPGPATH, "%s/global.dat", dumpdirpath); + + /* Open global.dat file. */ + pfile = fopen(global_file_path, PG_BINARY_R); + + if (pfile == NULL) + pg_fatal("could not open global.dat file: \"%s\"", global_file_path); + + /* + * If outfile is given, then just copy all global.dat file data into + * outfile. + */ + if (outfile) + { + copy_or_print_global_file(outfile, pfile); + return 0; + } + + /* Init sqlstatement to append commands. */ + initStringInfo(&sqlstatement); + + /* Process file till EOF and execute sql statements. */ + while (ReadOneStatement(&sqlstatement, pfile) != EOF) + { + pg_log_info("executing query: %s", sqlstatement.data); + result = PQexec(conn, sqlstatement.data); + + switch (PQresultStatus(result)) + { + case PGRES_COMMAND_OK: + case PGRES_TUPLES_OK: + case PGRES_EMPTY_QUERY: + break; + default: + n_errors++; + pg_log_error("could not execute query: \"%s\" \nCommand was: \"%s\"", PQerrorMessage(conn), sqlstatement.data); + } + PQclear(result); + } + + /* Print a summary of ignored errors during global.dat. */ + if (n_errors) + pg_log_warning("errors ignored on global.dat file restore: %d", n_errors); + + fclose(pfile); + + return n_errors; +} + +/* + * copy_or_print_global_file + * + * This will copy global.dat file into out file. If "-" is used as outfile, + * then print commands to the stdout. + */ +static void +copy_or_print_global_file(const char *outfile, FILE *pfile) +{ + char out_file_path[MAXPGPATH]; + FILE *OPF; + int c; + + /* "-" is used for stdout. */ + if (strcmp(outfile, "-") == 0) + OPF = stdout; + else + { + snprintf(out_file_path, MAXPGPATH, "%s", outfile); + OPF = fopen(out_file_path, PG_BINARY_W); + + if (OPF == NULL) + { + fclose(pfile); + pg_fatal("could not open file: \"%s\"", outfile); + } + } + + /* Append global.dat into out file or print to the stdout. */ + while ((c = fgetc(pfile)) != EOF) + fputc(c, OPF); + + fclose(pfile); + + /* Close out file. */ + if (strcmp(outfile, "-") != 0) + fclose(OPF); +} + +/* + * simple_db_oid_list_append + * + * appends a node to the list in the end. + */ +static void +simple_db_oid_list_append(SimpleDatabaseOidList *list, Oid db_oid, + const char *dbname) +{ + SimpleDatabaseOidListCell *cell; + + cell = pg_malloc_object(SimpleDatabaseOidListCell); + + cell->next = NULL; + cell->db_oid = db_oid; + cell->db_name = pg_strdup(dbname); + + if (list->tail) + list->tail->next = cell; + else + list->head = cell; + list->tail = cell; +} + +/* + * simple_db_oid_full_list_delete + * + * delete all cell from dbname and dboid list. + */ +static void +simple_db_oid_full_list_delete(SimpleDatabaseOidList *list) +{ + SimpleDatabaseOidListCell *cell = list->head; + SimpleDatabaseOidListCell *nextcell = NULL; + + while (cell) + { + nextcell = cell->next; + pfree (cell); + cell = nextcell; + } + + list->head = NULL; + list->tail = NULL; +} + +/* + * simple_string_full_list_delete + * + * delete all cell from string list. + */ +static void +simple_string_full_list_delete(SimpleStringList *list) +{ + SimpleStringListCell *cell = list->head; + SimpleStringListCell *cellnext = NULL; + + while (cell) + { + cellnext = cell->next; + pfree(cell); + cell = cellnext; + } + + list->head = NULL; + list->tail = NULL; +} + +/* + * simple_db_oid_list_delete + * + * delete cell from database and oid list. + */ +static void +simple_db_oid_list_delete(SimpleDatabaseOidList *list, + SimpleDatabaseOidListCell *cell, + SimpleDatabaseOidListCell *prev) +{ + if (prev == NULL) + { + list->head = cell->next; + pfree(cell); + } + else + { + prev->next = cell->next; + pfree(cell); + } +} + +/* + * quote_literal_internal + */ +static size_t +quote_literal_internal(char *dst, const char *src, size_t len) +{ + const char *s; + char *savedst = dst; + + for (s = src; s < src + len; s++) + { + if (*s == '\\') + { + *dst++ = ESCAPE_STRING_SYNTAX; + break; + } + } + + *dst++ = '\''; + while (len-- > 0) + { + if (SQL_STR_DOUBLE(*src, true)) + *dst++ = *src; + *dst++ = *src++; + } + *dst++ = '\''; + + return dst - savedst; +} + +/* + * quote_literal_cstr + * + * returns a properly quoted literal + * copied from src/backend/utils/adt/quote.c + */ +static char * +quote_literal_cstr(const char *rawstr) +{ + char *result; + int len; + int newlen; + + len = strlen(rawstr); + + /* We make a worst-case result area; wasting a little space is OK */ + result = pg_malloc(len * 2 + 3 + 1); + + newlen = quote_literal_internal(result, rawstr, len); + result[newlen] = '\0'; + + return result; +} diff --git a/src/bin/pg_dump/t/001_basic.pl b/src/bin/pg_dump/t/001_basic.pl old mode 100644 new mode 100755 index 37d893d5e6a..0bbcdbe84a7 --- a/src/bin/pg_dump/t/001_basic.pl +++ b/src/bin/pg_dump/t/001_basic.pl @@ -237,6 +237,11 @@ command_fails_like( 'pg_restore: options -C\/--create and -1\/--single-transaction cannot be used together' ); +command_fails_like( + [ 'pg_restore', '--exclude-database=foo', '--globals-only', '-d', 'xxx' ], + qr/\Qpg_restore: error: option --exclude-database cannot be used together with -g\/--globals-only\E/, + 'pg_restore: option --exclude-database cannot be used together with -g/--globals-only'); + # also fails for -r and -t, but it seems pointless to add more tests for those. command_fails_like( [ 'pg_dumpall', '--exclude-database=foo', '--globals-only' ], @@ -244,4 +249,8 @@ command_fails_like( 'pg_dumpall: option --exclude-database cannot be used together with -g/--globals-only' ); +command_fails_like( + [ 'pg_dumpall', '--format', 'x' ], + qr/\Qpg_dumpall: error: unrecognized archive format "x";\E/, + 'pg_dumpall: unrecognized archive format'); done_testing(); diff --git a/src/tools/pgindent/typedefs.list b/src/tools/pgindent/typedefs.list index dfe2690bdd3..a922d983514 100644 --- a/src/tools/pgindent/typedefs.list +++ b/src/tools/pgindent/typedefs.list @@ -2697,6 +2697,8 @@ ShutdownMode SignTSVector SimpleActionList SimpleActionListCell +SimpleDatabaseOidList +SimpleDatabaseOidListCell SimpleEcontextStackEntry SimpleOidList SimpleOidListCell -- 2.39.3