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.71 2005/06/09 17:56:51 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", 1, NULL, 'n'},
 107                 {"schema-only", 0, NULL, 's'},
 108                 {"superuser", 1, NULL, 'S'},
 109                 {"table", 1, NULL, 't'},
 110                 {"trigger", 1, NULL, 'T'},
 111                 {"use-list", 1, NULL, 'L'},
 112                 {"username", 1, NULL, 'U'},
 113                 {"verbose", 0, NULL, 'v'},
 114
 115                 /*
 116                  * the following options don't have an equivalent short option
 117                  * letter, but are available as '-X long-name'
 118                  */
 119                 {"use-set-session-authorization", no_argument, &use_setsessauth, 1},
 120                 {"disable-triggers", no_argument, &disable_triggers, 1},
 121
 122                 {NULL, 0, NULL, 0}
 123         };
 124
 125         set_pglocale_pgservice(argv[0], "pg_dump");
 126
 127         opts = NewRestoreOptions();
 128
 129         progname = get_progname(argv[0]);
 130
 131         if (argc > 1)
 132         {
 133                 if (strcmp(argv[1], "--help") == 0 || strcmp(argv[1], "-?") == 0)
 134                 {
 135                         usage(progname);
 136                         exit(0);
 137                 }
 138                 if (strcmp(argv[1], "--version") == 0 || strcmp(argv[1], "-V") == 0)
 139                 {
 140                         puts("pg_restore (PostgreSQL) " PG_VERSION);
 141                         exit(0);
 142                 }
 143         }
 144
 145         while ((c = getopt_long(argc, argv, "acCd:ef:F:h:iI:lL:n:Op:P:RsS:t:T:uU:vWxX:",
 146                                                         cmdopts, NULL)) != -1)
 147         {
 148                 switch (c)
 149                 {
 150                         case 'a':                       /* Dump data only */
 151                                 opts->dataOnly = 1;
 152                                 break;
 153                         case 'c':                       /* clean (i.e., drop) schema prior to
 154                                                                  * create */
 155                                 opts->dropSchema = 1;
 156                                 break;
 157                         case 'C':
 158                                 opts->create = 1;
 159                                 break;
 160                         case 'd':
 161                                 opts->dbname = strdup(optarg);
 162                                 break;
 163                         case 'e':
 164                                 opts->exit_on_error = true;
 165                                 break;
 166                         case 'f':                       /* output file name */
 167                                 opts->filename = strdup(optarg);
 168                                 break;
 169                         case 'F':
 170                                 if (strlen(optarg) != 0)
 171                                         opts->formatName = strdup(optarg);
 172                                 break;
 173                         case 'h':
 174                                 if (strlen(optarg) != 0)
 175                                         opts->pghost = strdup(optarg);
 176                                 break;
 177                         case 'i':
 178                                 opts->ignoreVersion = 1;
 179                                 break;
 180
 181                         case 'l':                       /* Dump the TOC summary */
 182                                 opts->tocSummary = 1;
 183                                 break;
 184
 185                         case 'L':                       /* input TOC summary file name */
 186                                 opts->tocFile = strdup(optarg);
 187                                 break;
 188
 189                         case 'O':
 190                                 opts->noOwner = 1;
 191                                 break;
 192                         case 'p':
 193                                 if (strlen(optarg) != 0)
 194                                         opts->pgport = strdup(optarg);
 195                                 break;
 196                         case 'R':
 197                                 /* no-op, still accepted for backwards compatibility */
 198                                 break;
 199                         case 'P':                       /* Function */
 200                                 opts->selTypes = 1;
 201                                 opts->selFunction = 1;
 202                                 opts->functionNames = strdup(optarg);
 203                                 break;
 204                         case 'I':                       /* Index */
 205                                 opts->selTypes = 1;
 206                                 opts->selIndex = 1;
 207                                 opts->indexNames = strdup(optarg);
 208                                 break;
 209                         case 'T':                       /* Trigger */
 210                                 opts->selTypes = 1;
 211                                 opts->selTrigger = 1;
 212                                 opts->triggerNames = strdup(optarg);
 213                                 break;
 214                         case 's':                       /* dump schema only */
 215                                 opts->schemaOnly = 1;
 216                                 break;
 217                         case 'S':                       /* Superuser username */
 218                                 if (strlen(optarg) != 0)
 219                                         opts->superuser = strdup(optarg);
 220                                 break;
 221                         case 't':                       /* Dump data for this table only */
 222                                 opts->selTypes = 1;
 223                                 opts->selTable = 1;
 224                                 opts->tableNames = strdup(optarg);
 225                                 break;
 226
 227                         case 'n':                       /* Dump data for this schema only */
 228                                 opts->selTypes = 1;
 229                                 opts->schemaNames = strdup(optarg);
 230                                 break;
 231
 232                         case 'u':
 233                                 opts->requirePassword = true;
 234                                 opts->username = simple_prompt("User name: ", 100, true);
 235                                 break;
 236
 237                         case 'U':
 238                                 opts->username = optarg;
 239                                 break;
 240
 241                         case 'v':                       /* verbose */
 242                                 opts->verbose = 1;
 243                                 break;
 244
 245                         case 'W':
 246                                 opts->requirePassword = true;
 247                                 break;
 248
 249                         case 'x':                       /* skip ACL dump */
 250                                 opts->aclsSkip = 1;
 251                                 break;
 252
 253                         case 'X':
 254                                 if (strcmp(optarg, "use-set-session-authorization") == 0)
 255                                         use_setsessauth = 1;
 256                                 else if (strcmp(optarg, "disable-triggers") == 0)
 257                                         disable_triggers = 1;
 258                                 else
 259                                 {
 260                                         fprintf(stderr,
 261                                                         _("%s: invalid -X option -- %s\n"),
 262                                                         progname, optarg);
 263                                         fprintf(stderr, _("Try \"%s --help\" for more information.\n"), progname);
 264                                         exit(1);
 265                                 }
 266                                 break;
 267
 268                                 /* This covers the long options equivalent to -X xxx. */
 269                         case 0:
 270                                 break;
 271
 272                         default:
 273                                 fprintf(stderr, _("Try \"%s --help\" for more information.\n"), progname);
 274                                 exit(1);
 275                 }
 276         }
 277
 278         if (optind < argc)
 279                 inputFileSpec = argv[optind];
 280         else
 281                 inputFileSpec = NULL;
 282
 283         /* Should get at most one of -d and -f, else user is confused */
 284         if (opts->dbname)
 285         {
 286                 if (opts->filename)
 287                 {
 288                         fprintf(stderr, _("%s: cannot specify both -d and -f output\n"),
 289                                         progname);
 290                         fprintf(stderr, _("Try \"%s --help\" for more information.\n"),
 291                                         progname);
 292                         exit(1);
 293                 }
 294                 opts->useDB = 1;
 295         }
 296
 297         opts->disable_triggers = disable_triggers;
 298         opts->use_setsessauth = use_setsessauth;
 299
 300         if (opts->formatName)
 301         {
 302
 303                 switch (opts->formatName[0])
 304                 {
 305
 306                         case 'c':
 307                         case 'C':
 308                                 opts->format = archCustom;
 309                                 break;
 310
 311                         case 'f':
 312                         case 'F':
 313                                 opts->format = archFiles;
 314                                 break;
 315
 316                         case 't':
 317                         case 'T':
 318                                 opts->format = archTar;
 319                                 break;
 320
 321                         default:
 322                                 write_msg(NULL, "unrecognized archive format '%s'; please specify 't' or 'c'\n",
 323                                                   opts->formatName);
 324                                 exit(1);
 325                 }
 326         }
 327
 328         AH = OpenArchive(inputFileSpec, opts->format);
 329
 330         /* Let the archiver know how noisy to be */
 331         AH->verbose = opts->verbose;
 332
 333         /*
 334          * Whether to keep submitting sql commands as "pg_restore ... | psql
 335          * ... "
 336          */
 337         AH->exit_on_error = opts->exit_on_error;
 338
 339         if (opts->tocFile)
 340                 SortTocFromFile(AH, opts);
 341
 342         if (opts->tocSummary)
 343                 PrintTOCSummary(AH, opts);
 344         else
 345                 RestoreArchive(AH, opts);
 346
 347         /* done, print a summary of ignored errors */
 348         if (AH->n_errors)
 349                 fprintf(stderr, _("WARNING: errors ignored on restore: %d\n"),
 350                                 AH->n_errors);
 351
 352         /* AH may be freed in CloseArchive? */
 353         exit_code = AH->n_errors ? 1 : 0;
 354
 355         CloseArchive(AH);
 356
 357         return exit_code;
 358 }
 359
 360 static void
 361 usage(const char *progname)
 362 {
 363         printf(_("%s restores a PostgreSQL database from an archive created by pg_dump.\n\n"), progname);
 364         printf(_("Usage:\n"));
 365         printf(_("  %s [OPTION]... [FILE]\n"), progname);
 366
 367         printf(_("\nGeneral options:\n"));
 368         printf(_("  -d, --dbname=NAME        connect to database name\n"));
 369         printf(_("  -f, --file=FILENAME      output file name\n"));
 370         printf(_("  -F, --format=c|t         specify backup file format\n"));
 371         printf(_("  -i, --ignore-version     proceed even when server version mismatches\n"));
 372         printf(_("  -l, --list               print summarized TOC of the archive\n"));
 373         printf(_("  -v, --verbose            verbose mode\n"));
 374         printf(_("  --help                   show this help, then exit\n"));
 375         printf(_("  --version                output version information, then exit\n"));
 376
 377         printf(_("\nOptions controlling the restore:\n"));
 378         printf(_("  -a, --data-only          restore only the data, no schema\n"));
 379         printf(_("  -c, --clean              clean (drop) schema prior to create\n"));
 380         printf(_("  -C, --create             create the target database\n"));
 381         printf(_("  -I, --index=NAME         restore named index\n"));
 382         printf(_("  -L, --use-list=FILENAME  use specified table of contents for ordering\n"
 383                          "                           output from this file\n"));
 384         printf(_("  -n, --schema=NAME        restore only objects in this schema\n"));
 385         printf(_("  -O, --no-owner           skip restoration of object ownership\n"));
 386         printf(_("  -P, --function=NAME(args)\n"
 387                          "                           restore named function\n"));
 388         printf(_("  -s, --schema-only        restore only the schema, no data\n"));
 389         printf(_("  -S, --superuser=NAME     specify the superuser user name to use for\n"
 390                          "                           disabling triggers\n"));
 391         printf(_("  -t, --table=NAME         restore named table\n"));
 392         printf(_("  -T, --trigger=NAME       restore named trigger\n"));
 393         printf(_("  -x, --no-privileges      skip restoration of access privileges (grant/revoke)\n"));
 394         printf(_("  -X disable-triggers, --disable-triggers\n"
 395                          "                           disable triggers during data-only restore\n"));
 396         printf(_("  -X use-set-session-authorization, --use-set-session-authorization\n"
 397                          "                           use SESSION AUTHORIZATION commands instead of\n"
 398                          "                           OWNER TO commands\n"));
 399
 400         printf(_("\nConnection options:\n"));
 401         printf(_("  -h, --host=HOSTNAME      database server host or socket directory\n"));
 402         printf(_("  -p, --port=PORT          database server port number\n"));
 403         printf(_("  -U, --username=NAME      connect as specified database user\n"));
 404         printf(_("  -W, --password           force password prompt (should happen automatically)\n"));
 405         printf(_("  -e, --exit-on-error      exit on error, default is to continue\n"));
 406
 407         printf(_("\nIf no input file name is supplied, then standard input is used.\n\n"));
 408         printf(_("Report bugs to <pgsql-bugs@postgresql.org>.\n"));
 409 }