1 /*-------------------------------------------------------------------------
4 * pg_restore is an utility extracting postgres database definitions
5 * from a backup archive created by pg_dump using the archiver
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
12 * user-defined functions
19 * the output script is SQL that is understood by PostgreSQL
21 * Basic process in a restore operation is:
23 * Open the Archive and read the TOC.
24 * Set flags in TOC entries, and *maybe* reorder them.
25 * Generate script to stdout
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.
32 * The author is not responsible for loss or damages that may
33 * result from its use.
37 * $PostgreSQL: pgsql/src/bin/pg_dump/pg_restore.c,v 1.81 2006/09/27 15:41:23 tgl Exp $
39 *-------------------------------------------------------------------------
42 #include "pg_backup_archiver.h"
52 #include "getopt_long.h"
54 #ifndef HAVE_INT_OPTRESET
63 static void usage(const char *progname);
65 typedef struct option optType;
68 main(int argc, char **argv)
77 static int use_setsessauth = 0;
78 static int disable_triggers = 0;
80 struct option cmdopts[] = {
81 {"clean", 0, NULL, 'c'},
82 {"create", 0, NULL, 'C'},
83 {"data-only", 0, NULL, 'a'},
84 {"dbname", 1, NULL, 'd'},
85 {"exit-on-error", 0, NULL, 'e'},
86 {"file", 1, NULL, 'f'},
87 {"format", 1, NULL, 'F'},
88 {"function", 1, NULL, 'P'},
89 {"host", 1, NULL, 'h'},
90 {"ignore-version", 0, NULL, 'i'},
91 {"index", 1, NULL, 'I'},
92 {"list", 0, NULL, 'l'},
93 {"no-privileges", 0, NULL, 'x'},
94 {"no-acl", 0, NULL, 'x'},
95 {"no-owner", 0, NULL, 'O'},
96 {"no-reconnect", 0, NULL, 'R'},
97 {"port", 1, NULL, 'p'},
98 {"password", 0, NULL, 'W'},
99 {"schema", 1, NULL, 'n'},
100 {"schema-only", 0, NULL, 's'},
101 {"superuser", 1, NULL, 'S'},
102 {"table", 1, NULL, 't'},
103 {"trigger", 1, NULL, 'T'},
104 {"use-list", 1, NULL, 'L'},
105 {"username", 1, NULL, 'U'},
106 {"verbose", 0, NULL, 'v'},
107 {"single-transaction", 0, NULL, '1'},
110 * the following options don't have an equivalent short option letter,
111 * but are available as '-X long-name'
113 {"use-set-session-authorization", no_argument, &use_setsessauth, 1},
114 {"disable-triggers", no_argument, &disable_triggers, 1},
119 set_pglocale_pgservice(argv[0], "pg_dump");
121 opts = NewRestoreOptions();
123 progname = get_progname(argv[0]);
127 if (strcmp(argv[1], "--help") == 0 || strcmp(argv[1], "-?") == 0)
132 if (strcmp(argv[1], "--version") == 0 || strcmp(argv[1], "-V") == 0)
134 puts("pg_restore (PostgreSQL) " PG_VERSION);
139 while ((c = getopt_long(argc, argv, "acCd:ef:F:h:iI:lL:n:Op:P:RsS:t:T:uU:vWxX:1",
140 cmdopts, NULL)) != -1)
144 case 'a': /* Dump data only */
147 case 'c': /* clean (i.e., drop) schema prior to create */
148 opts->dropSchema = 1;
154 opts->dbname = strdup(optarg);
157 opts->exit_on_error = true;
159 case 'f': /* output file name */
160 opts->filename = strdup(optarg);
163 if (strlen(optarg) != 0)
164 opts->formatName = strdup(optarg);
167 if (strlen(optarg) != 0)
168 opts->pghost = strdup(optarg);
171 opts->ignoreVersion = 1;
174 case 'l': /* Dump the TOC summary */
175 opts->tocSummary = 1;
178 case 'L': /* input TOC summary file name */
179 opts->tocFile = strdup(optarg);
182 case 'n': /* Dump data for this schema only */
183 opts->schemaNames = strdup(optarg);
191 if (strlen(optarg) != 0)
192 opts->pgport = strdup(optarg);
195 /* no-op, still accepted for backwards compatibility */
197 case 'P': /* Function */
199 opts->selFunction = 1;
200 opts->functionNames = strdup(optarg);
202 case 'I': /* Index */
205 opts->indexNames = strdup(optarg);
207 case 'T': /* Trigger */
209 opts->selTrigger = 1;
210 opts->triggerNames = strdup(optarg);
212 case 's': /* dump schema only */
213 opts->schemaOnly = 1;
215 case 'S': /* Superuser username */
216 if (strlen(optarg) != 0)
217 opts->superuser = strdup(optarg);
219 case 't': /* Dump data for this table only */
222 opts->tableNames = strdup(optarg);
226 opts->requirePassword = true;
227 opts->username = simple_prompt("User name: ", 100, true);
231 opts->username = optarg;
234 case 'v': /* verbose */
239 opts->requirePassword = true;
242 case 'x': /* skip ACL dump */
247 if (strcmp(optarg, "use-set-session-authorization") == 0)
249 else if (strcmp(optarg, "disable-triggers") == 0)
250 disable_triggers = 1;
251 else if (strcmp(optarg, "no-data-for-failed-tables") == 0)
252 opts->noDataForFailedTables = 1;
256 _("%s: invalid -X option -- %s\n"),
258 fprintf(stderr, _("Try \"%s --help\" for more information.\n"), progname);
263 /* This covers the long options equivalent to -X xxx. */
267 case '1': /* Restore data in a single transaction */
268 opts->single_txn = true;
269 opts->exit_on_error = true;
273 fprintf(stderr, _("Try \"%s --help\" for more information.\n"), progname);
279 inputFileSpec = argv[optind];
281 inputFileSpec = NULL;
283 /* Should get at most one of -d and -f, else user is confused */
288 fprintf(stderr, _("%s: cannot specify both -d and -f output\n"),
290 fprintf(stderr, _("Try \"%s --help\" for more information.\n"),
297 opts->disable_triggers = disable_triggers;
298 opts->use_setsessauth = use_setsessauth;
300 if (opts->formatName)
303 switch (opts->formatName[0])
308 opts->format = archCustom;
313 opts->format = archFiles;
318 opts->format = archTar;
322 write_msg(NULL, "unrecognized archive format \"%s\"; please specify \"c\" or \"t\"\n",
328 AH = OpenArchive(inputFileSpec, opts->format);
330 /* Let the archiver know how noisy to be */
331 AH->verbose = opts->verbose;
334 * Whether to keep submitting sql commands as "pg_restore ... | psql ... "
336 AH->exit_on_error = opts->exit_on_error;
339 SortTocFromFile(AH, opts);
341 if (opts->tocSummary)
342 PrintTOCSummary(AH, opts);
344 RestoreArchive(AH, opts);
346 /* done, print a summary of ignored errors */
348 fprintf(stderr, _("WARNING: errors ignored on restore: %d\n"),
351 /* AH may be freed in CloseArchive? */
352 exit_code = AH->n_errors ? 1 : 0;
360 usage(const char *progname)
362 printf(_("%s restores a PostgreSQL database from an archive created by pg_dump.\n\n"), progname);
363 printf(_("Usage:\n"));
364 printf(_(" %s [OPTION]... [FILE]\n"), progname);
366 printf(_("\nGeneral options:\n"));
367 printf(_(" -d, --dbname=NAME connect to database name\n"));
368 printf(_(" -f, --file=FILENAME output file name\n"));
369 printf(_(" -F, --format=c|t specify backup file format\n"));
370 printf(_(" -i, --ignore-version proceed even when server version mismatches\n"));
371 printf(_(" -l, --list print summarized TOC of the archive\n"));
372 printf(_(" -v, --verbose verbose mode\n"));
373 printf(_(" --help show this help, then exit\n"));
374 printf(_(" --version output version information, then exit\n"));
376 printf(_("\nOptions controlling the restore:\n"));
377 printf(_(" -a, --data-only restore only the data, no schema\n"));
378 printf(_(" -c, --clean clean (drop) schema prior to create\n"));
379 printf(_(" -C, --create create the target database\n"));
380 printf(_(" -I, --index=NAME restore named index\n"));
381 printf(_(" -L, --use-list=FILENAME use specified table of contents for ordering\n"
382 " output from this file\n"));
383 printf(_(" -n, --schema=NAME restore only objects in this schema\n"));
384 printf(_(" -O, --no-owner skip restoration of object ownership\n"));
385 printf(_(" -P, --function=NAME(args)\n"
386 " restore named function\n"));
387 printf(_(" -s, --schema-only restore only the schema, no data\n"));
388 printf(_(" -S, --superuser=NAME specify the superuser user name to use for\n"
389 " disabling triggers\n"));
390 printf(_(" -t, --table=NAME restore named table\n"));
391 printf(_(" -T, --trigger=NAME restore named trigger\n"));
392 printf(_(" -x, --no-privileges skip restoration of access privileges (grant/revoke)\n"));
393 printf(_(" -X disable-triggers, --disable-triggers\n"
394 " disable triggers during data-only restore\n"));
395 printf(_(" -X use-set-session-authorization, --use-set-session-authorization\n"
396 " use SESSION AUTHORIZATION commands instead of\n"
397 " OWNER TO commands\n"));
398 printf(_(" -X no-data-for-failed-tables\n"
399 " do not restore data of tables which could not be\n"
401 printf(_(" -1, --single-transaction restore as a single transaction\n"));
403 printf(_("\nConnection options:\n"));
404 printf(_(" -h, --host=HOSTNAME database server host or socket directory\n"));
405 printf(_(" -p, --port=PORT database server port number\n"));
406 printf(_(" -U, --username=NAME connect as specified database user\n"));
407 printf(_(" -W, --password force password prompt (should happen automatically)\n"));
408 printf(_(" -e, --exit-on-error exit on error, default is to continue\n"));
410 printf(_("\nIf no input file name is supplied, then standard input is used.\n\n"));
411 printf(_("Report bugs to <pgsql-bugs@postgresql.org>.\n"));