granicus.if.org Git - postgresql/blob - src/bin/pg_dump/pg_restore.c

   1 /*-------------------------------------------------------------------------
   2  *
   3  * pg_restore.c
   4  *      pg_restore is an utility extracting postgres database definitions
   5  *      from a backup archive created by pg_dump using the archiver
   6  *      interface.
   7  *
   8  *      pg_restore will read the backup archive and
   9  *      dump out a script that reproduces
  10  *      the schema of the database in terms of
  11  *                user-defined types
  12  *                user-defined functions
  13  *                tables
  14  *                indexes
  15  *                aggregates
  16  *                operators
  17  *                ACL - grant/revoke
  18  *
  19  * the output script is SQL that is understood by PostgreSQL
  20  *
  21  * Basic process in a restore operation is:
  22  *
  23  *      Open the Archive and read the TOC.
  24  *      Set flags in TOC entries, and *maybe* reorder them.
  25  *      Generate script to stdout
  26  *      Exit
  27  *
  28  * Copyright (c) 2000, Philip Warner
  29  *              Rights are granted to use this software in any way so long
  30  *              as this notice is not removed.
  31  *
  32  *      The author is not responsible for loss or damages that may
  33  *      result from its use.
  34  *
  35  *
  36  * IDENTIFICATION
  37  *              $PostgreSQL: pgsql/src/bin/pg_dump/pg_restore.c,v 1.69 2005/02/22 04:39:38 momjian Exp $
  38  *
  39  *-------------------------------------------------------------------------
  40  */
  41
  42 #include "pg_backup.h"
  43 #include "pg_backup_archiver.h"
  44 #include "dumputils.h"
  45
  46 #include <ctype.h>
  47
  48 #ifndef HAVE_STRDUP
  49 #include "strdup.h"
  50 #endif
  51
  52 #ifdef HAVE_TERMIOS_H
  53 #include <termios.h>
  54 #endif
  55
  56 #include <unistd.h>
  57
  58 #include "getopt_long.h"
  59
  60 #ifndef HAVE_INT_OPTRESET
  61 int                     optreset;
  62 #endif
  63
  64 #ifdef ENABLE_NLS
  65 #include <locale.h>
  66 #endif
  67
  68
  69 /* Forward decls */
  70 static void usage(const char *progname);
  71
  72 typedef struct option optType;
  73
  74 int
  75 main(int argc, char **argv)
  76 {
  77         RestoreOptions *opts;
  78         int                     c;
  79         int                     exit_code;
  80         Archive    *AH;
  81         char       *inputFileSpec;
  82         extern int      optind;
  83         extern char *optarg;
  84         static int      use_setsessauth = 0;
  85         static int      disable_triggers = 0;
  86
  87         struct option cmdopts[] = {
  88                 {"clean", 0, NULL, 'c'},
  89                 {"create", 0, NULL, 'C'},
  90                 {"data-only", 0, NULL, 'a'},
  91                 {"dbname", 1, NULL, 'd'},
  92                 {"exit-on-error", 0, NULL, 'e'},
  93                 {"file", 1, NULL, 'f'},
  94                 {"format", 1, NULL, 'F'},
  95                 {"function", 1, NULL, 'P'},
  96                 {"host", 1, NULL, 'h'},
  97                 {"ignore-version", 0, NULL, 'i'},
  98                 {"index", 1, NULL, 'I'},
  99                 {"list", 0, NULL, 'l'},
 100                 {"no-privileges", 0, NULL, 'x'},
 101                 {"no-acl", 0, NULL, 'x'},
 102                 {"no-owner", 0, NULL, 'O'},
 103                 {"no-reconnect", 0, NULL, 'R'},
 104                 {"port", 1, NULL, 'p'},
 105                 {"password", 0, NULL, 'W'},
 106                 {"schema-only", 0, NULL, 's'},
 107                 {"superuser", 1, NULL, 'S'},
 108                 {"table", 1, NULL, 't'},
 109                 {"trigger", 1, NULL, 'T'},
 110                 {"use-list", 1, NULL, 'L'},
 111                 {"username", 1, NULL, 'U'},
 112                 {"verbose", 0, NULL, 'v'},
 113
 114                 /*
 115                  * the following options don't have an equivalent short option
 116                  * letter, but are available as '-X long-name'
 117                  */
 118                 {"use-set-session-authorization", no_argument, &use_setsessauth, 1},
 119                 {"disable-triggers", no_argument, &disable_triggers, 1},
 120
 121                 {NULL, 0, NULL, 0}
 122         };
 123
 124         set_pglocale_pgservice(argv[0], "pg_dump");
 125
 126         opts = NewRestoreOptions();
 127
 128         progname = get_progname(argv[0]);
 129
 130         if (argc > 1)
 131         {
 132                 if (strcmp(argv[1], "--help") == 0 || strcmp(argv[1], "-?") == 0)
 133                 {
 134                         usage(progname);
 135                         exit(0);
 136                 }
 137                 if (strcmp(argv[1], "--version") == 0 || strcmp(argv[1], "-V") == 0)
 138                 {
 139                         puts("pg_restore (PostgreSQL) " PG_VERSION);
 140                         exit(0);
 141                 }
 142         }
 143
 144         while ((c = getopt_long(argc, argv, "acCd:ef:F:h:iI:lL:Op:P:RsS:t:T:uU:vWxX:",
 145                                                         cmdopts, NULL)) != -1)
 146         {
 147                 switch (c)
 148                 {
 149                         case 'a':                       /* Dump data only */
 150                                 opts->dataOnly = 1;
 151                                 break;
 152                         case 'c':                       /* clean (i.e., drop) schema prior to
 153                                                                  * create */
 154                                 opts->dropSchema = 1;
 155                                 break;
 156                         case 'C':
 157                                 opts->create = 1;
 158                                 break;
 159                         case 'd':
 160                                 opts->dbname = strdup(optarg);
 161                                 break;
 162                         case 'e':
 163                                 opts->exit_on_error = true;
 164                                 break;
 165                         case 'f':                       /* output file name */
 166                                 opts->filename = strdup(optarg);
 167                                 break;
 168                         case 'F':
 169                                 if (strlen(optarg) != 0)
 170                                         opts->formatName = strdup(optarg);
 171                                 break;
 172                         case 'h':
 173                                 if (strlen(optarg) != 0)
 174                                         opts->pghost = strdup(optarg);
 175                                 break;
 176                         case 'i':
 177                                 opts->ignoreVersion = 1;
 178                                 break;
 179
 180                         case 'l':                       /* Dump the TOC summary */
 181                                 opts->tocSummary = 1;
 182                                 break;
 183
 184                         case 'L':                       /* input TOC summary file name */
 185                                 opts->tocFile = strdup(optarg);
 186                                 break;
 187
 188                         case 'O':
 189                                 opts->noOwner = 1;
 190                                 break;
 191                         case 'p':
 192                                 if (strlen(optarg) != 0)
 193                                         opts->pgport = strdup(optarg);
 194                                 break;
 195                         case 'R':
 196                                 /* no-op, still accepted for backwards compatibility */
 197                                 break;
 198                         case 'P':                       /* Function */
 199                                 opts->selTypes = 1;
 200                                 opts->selFunction = 1;
 201                                 opts->functionNames = strdup(optarg);
 202                                 break;
 203                         case 'I':                       /* Index */
 204                                 opts->selTypes = 1;
 205                                 opts->selIndex = 1;
 206                                 opts->indexNames = strdup(optarg);
 207                                 break;
 208                         case 'T':                       /* Trigger */
 209                                 opts->selTypes = 1;
 210                                 opts->selTrigger = 1;
 211                                 opts->triggerNames = strdup(optarg);
 212                                 break;
 213                         case 's':                       /* dump schema only */
 214                                 opts->schemaOnly = 1;
 215                                 break;
 216                         case 'S':                       /* Superuser username */
 217                                 if (strlen(optarg) != 0)
 218                                         opts->superuser = strdup(optarg);
 219                                 break;
 220                         case 't':                       /* Dump data for this table only */
 221                                 opts->selTypes = 1;
 222                                 opts->selTable = 1;
 223                                 opts->tableNames = strdup(optarg);
 224                                 break;
 225
 226                         case 'u':
 227                                 opts->requirePassword = true;
 228                                 opts->username = simple_prompt("User name: ", 100, true);
 229                                 break;
 230
 231                         case 'U':
 232                                 opts->username = optarg;
 233                                 break;
 234
 235                         case 'v':                       /* verbose */
 236                                 opts->verbose = 1;
 237                                 break;
 238
 239                         case 'W':
 240                                 opts->requirePassword = true;
 241                                 break;
 242
 243                         case 'x':                       /* skip ACL dump */
 244                                 opts->aclsSkip = 1;
 245                                 break;
 246
 247                         case 'X':
 248                                 if (strcmp(optarg, "use-set-session-authorization") == 0)
 249                                         use_setsessauth = 1;
 250                                 else if (strcmp(optarg, "disable-triggers") == 0)
 251                                         disable_triggers = 1;
 252                                 else
 253                                 {
 254                                         fprintf(stderr,
 255                                                         _("%s: invalid -X option -- %s\n"),
 256                                                         progname, optarg);
 257                                         fprintf(stderr, _("Try \"%s --help\" for more information.\n"), progname);
 258                                         exit(1);
 259                                 }
 260                                 break;
 261
 262                                 /* This covers the long options equivalent to -X xxx. */
 263                         case 0:
 264                                 break;
 265
 266                         default:
 267                                 fprintf(stderr, _("Try \"%s --help\" for more information.\n"), progname);
 268                                 exit(1);
 269                 }
 270         }
 271
 272         if (optind < argc)
 273                 inputFileSpec = argv[optind];
 274         else
 275                 inputFileSpec = NULL;
 276
 277         /* Should get at most one of -d and -f, else user is confused */
 278         if (opts->dbname)
 279         {
 280                 if (opts->filename)
 281                 {
 282                         fprintf(stderr, _("%s: cannot specify both -d and -f output\n"),
 283                                         progname);
 284                         fprintf(stderr, _("Try \"%s --help\" for more information.\n"),
 285                                         progname);
 286                         exit(1);
 287                 }
 288                 opts->useDB = 1;
 289         }
 290
 291         opts->disable_triggers = disable_triggers;
 292         opts->use_setsessauth = use_setsessauth;
 293
 294         if (opts->formatName)
 295         {
 296
 297                 switch (opts->formatName[0])
 298                 {
 299
 300                         case 'c':
 301                         case 'C':
 302                                 opts->format = archCustom;
 303                                 break;
 304
 305                         case 'f':
 306                         case 'F':
 307                                 opts->format = archFiles;
 308                                 break;
 309
 310                         case 't':
 311                         case 'T':
 312                                 opts->format = archTar;
 313                                 break;
 314
 315                         default:
 316                                 write_msg("unrecognized archive format '%s'; please specify 't' or 'c'\n",
 317                                                   opts->formatName);
 318                                 exit(1);
 319                 }
 320         }
 321
 322         AH = OpenArchive(inputFileSpec, opts->format);
 323
 324         /* Let the archiver know how noisy to be */
 325         AH->verbose = opts->verbose;
 326
 327         /*
 328          * Whether to keep submitting sql commands as "pg_restore ... | psql
 329          * ... "
 330          */
 331         AH->exit_on_error = opts->exit_on_error;
 332
 333         if (opts->tocFile)
 334                 SortTocFromFile(AH, opts);
 335
 336         if (opts->tocSummary)
 337                 PrintTOCSummary(AH, opts);
 338         else
 339                 RestoreArchive(AH, opts);
 340
 341         /* done, print a summary of ignored errors */
 342         if (AH->n_errors)
 343                 fprintf(stderr, _("WARNING: errors ignored on restore: %d\n"),
 344                                 AH->n_errors);
 345
 346         /* AH may be freed in CloseArchive? */
 347         exit_code = AH->n_errors ? 1 : 0;
 348
 349         CloseArchive(AH);
 350
 351         return exit_code;
 352 }
 353
 354 static void
 355 usage(const char *progname)
 356 {
 357         printf(_("%s restores a PostgreSQL database from an archive created by pg_dump.\n\n"), progname);
 358         printf(_("Usage:\n"));
 359         printf(_("  %s [OPTION]... [FILE]\n"), progname);
 360
 361         printf(_("\nGeneral options:\n"));
 362         printf(_("  -d, --dbname=NAME        connect to database name\n"));
 363         printf(_("  -f, --file=FILENAME      output file name\n"));
 364         printf(_("  -F, --format=c|t         specify backup file format\n"));
 365         printf(_("  -i, --ignore-version     proceed even when server version mismatches\n"));
 366         printf(_("  -l, --list               print summarized TOC of the archive\n"));
 367         printf(_("  -v, --verbose            verbose mode\n"));
 368         printf(_("  --help                   show this help, then exit\n"));
 369         printf(_("  --version                output version information, then exit\n"));
 370
 371         printf(_("\nOptions controlling the restore:\n"));
 372         printf(_("  -a, --data-only          restore only the data, no schema\n"));
 373         printf(_("  -c, --clean              clean (drop) schema prior to create\n"));
 374         printf(_("  -C, --create             create the target database\n"));
 375         printf(_("  -I, --index=NAME         restore named index\n"));
 376         printf(_("  -L, --use-list=FILENAME  use specified table of contents for ordering\n"
 377                          "                           output from this file\n"));
 378         printf(_("  -O, --no-owner           skip restoration of object ownership\n"));
 379         printf(_("  -P, --function=NAME(args)\n"
 380                          "                           restore named function\n"));
 381         printf(_("  -s, --schema-only        restore only the schema, no data\n"));
 382         printf(_("  -S, --superuser=NAME     specify the superuser user name to use for\n"
 383                          "                           disabling triggers\n"));
 384         printf(_("  -t, --table=NAME         restore named table\n"));
 385         printf(_("  -T, --trigger=NAME       restore named trigger\n"));
 386         printf(_("  -x, --no-privileges      skip restoration of access privileges (grant/revoke)\n"));
 387         printf(_("  -X disable-triggers, --disable-triggers\n"
 388                          "                           disable triggers during data-only restore\n"));
 389         printf(_("  -X use-set-session-authorization, --use-set-session-authorization\n"
 390                          "                           use SESSION AUTHORIZATION commands instead of\n"
 391                          "                           OWNER TO commands\n"));
 392
 393         printf(_("\nConnection options:\n"));
 394         printf(_("  -h, --host=HOSTNAME      database server host or socket directory\n"));
 395         printf(_("  -p, --port=PORT          database server port number\n"));
 396         printf(_("  -U, --username=NAME      connect as specified database user\n"));
 397         printf(_("  -W, --password           force password prompt (should happen automatically)\n"));
 398         printf(_("  -e, --exit-on-error      exit on error, default is to continue\n"));
 399
 400         printf(_("\nIf no input file name is supplied, then standard input is used.\n\n"));
 401         printf(_("Report bugs to <pgsql-bugs@postgresql.org>.\n"));
 402 }