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 * src/bin/pg_dump/pg_restore.c
38 *
39 *-------------------------------------------------------------------------
40 */
41 #include "postgres_fe.h"
42
43 #include <ctype.h>
44 #ifdef HAVE_TERMIOS_H
45 #include <termios.h>
46 #endif
47
48 #include "getopt_long.h"
49
50 #include "dumputils.h"
51 #include "parallel.h"
52 #include "pg_backup_utils.h"
53
54
55 static void usage(const char *progname);
56
57 typedef struct option optType;
58
59 int
main(int argc,char ** argv)60 main(int argc, char **argv)
61 {
62 RestoreOptions *opts;
63 int c;
64 int exit_code;
65 int numWorkers = 1;
66 Archive *AH;
67 char *inputFileSpec;
68 static int disable_triggers = 0;
69 static int enable_row_security = 0;
70 static int if_exists = 0;
71 static int no_data_for_failed_tables = 0;
72 static int outputNoTablespaces = 0;
73 static int use_setsessauth = 0;
74 static int no_publications = 0;
75 static int no_security_labels = 0;
76 static int no_subscriptions = 0;
77 static int strict_names = 0;
78
79 struct option cmdopts[] = {
80 {"clean", 0, NULL, 'c'},
81 {"create", 0, NULL, 'C'},
82 {"data-only", 0, NULL, 'a'},
83 {"dbname", 1, NULL, 'd'},
84 {"exit-on-error", 0, NULL, 'e'},
85 {"exclude-schema", 1, NULL, 'N'},
86 {"file", 1, NULL, 'f'},
87 {"format", 1, NULL, 'F'},
88 {"function", 1, NULL, 'P'},
89 {"host", 1, NULL, 'h'},
90 {"index", 1, NULL, 'I'},
91 {"jobs", 1, NULL, 'j'},
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 {"no-password", 0, NULL, 'w'},
99 {"password", 0, NULL, 'W'},
100 {"schema", 1, NULL, 'n'},
101 {"schema-only", 0, NULL, 's'},
102 {"superuser", 1, NULL, 'S'},
103 {"table", 1, NULL, 't'},
104 {"trigger", 1, NULL, 'T'},
105 {"use-list", 1, NULL, 'L'},
106 {"username", 1, NULL, 'U'},
107 {"verbose", 0, NULL, 'v'},
108 {"single-transaction", 0, NULL, '1'},
109
110 /*
111 * the following options don't have an equivalent short option letter
112 */
113 {"disable-triggers", no_argument, &disable_triggers, 1},
114 {"enable-row-security", no_argument, &enable_row_security, 1},
115 {"if-exists", no_argument, &if_exists, 1},
116 {"no-data-for-failed-tables", no_argument, &no_data_for_failed_tables, 1},
117 {"no-tablespaces", no_argument, &outputNoTablespaces, 1},
118 {"role", required_argument, NULL, 2},
119 {"section", required_argument, NULL, 3},
120 {"strict-names", no_argument, &strict_names, 1},
121 {"use-set-session-authorization", no_argument, &use_setsessauth, 1},
122 {"no-publications", no_argument, &no_publications, 1},
123 {"no-security-labels", no_argument, &no_security_labels, 1},
124 {"no-subscriptions", no_argument, &no_subscriptions, 1},
125
126 {NULL, 0, NULL, 0}
127 };
128
129 set_pglocale_pgservice(argv[0], PG_TEXTDOMAIN("pg_dump"));
130
131 init_parallel_dump_utils();
132
133 opts = NewRestoreOptions();
134
135 progname = get_progname(argv[0]);
136
137 if (argc > 1)
138 {
139 if (strcmp(argv[1], "--help") == 0 || strcmp(argv[1], "-?") == 0)
140 {
141 usage(progname);
142 exit_nicely(0);
143 }
144 if (strcmp(argv[1], "--version") == 0 || strcmp(argv[1], "-V") == 0)
145 {
146 puts("pg_restore (PostgreSQL) " PG_VERSION);
147 exit_nicely(0);
148 }
149 }
150
151 while ((c = getopt_long(argc, argv, "acCd:ef:F:h:I:j:lL:n:N:Op:P:RsS:t:T:U:vwWx1",
152 cmdopts, NULL)) != -1)
153 {
154 switch (c)
155 {
156 case 'a': /* Dump data only */
157 opts->dataOnly = 1;
158 break;
159 case 'c': /* clean (i.e., drop) schema prior to create */
160 opts->dropSchema = 1;
161 break;
162 case 'C':
163 opts->createDB = 1;
164 break;
165 case 'd':
166 opts->cparams.dbname = pg_strdup(optarg);
167 break;
168 case 'e':
169 opts->exit_on_error = true;
170 break;
171 case 'f': /* output file name */
172 opts->filename = pg_strdup(optarg);
173 break;
174 case 'F':
175 if (strlen(optarg) != 0)
176 opts->formatName = pg_strdup(optarg);
177 break;
178 case 'h':
179 if (strlen(optarg) != 0)
180 opts->cparams.pghost = pg_strdup(optarg);
181 break;
182
183 case 'j': /* number of restore jobs */
184 numWorkers = atoi(optarg);
185 break;
186
187 case 'l': /* Dump the TOC summary */
188 opts->tocSummary = 1;
189 break;
190
191 case 'L': /* input TOC summary file name */
192 opts->tocFile = pg_strdup(optarg);
193 break;
194
195 case 'n': /* Dump data for this schema only */
196 simple_string_list_append(&opts->schemaNames, optarg);
197 break;
198
199 case 'N': /* Do not dump data for this schema */
200 simple_string_list_append(&opts->schemaExcludeNames, optarg);
201 break;
202
203 case 'O':
204 opts->noOwner = 1;
205 break;
206
207 case 'p':
208 if (strlen(optarg) != 0)
209 opts->cparams.pgport = pg_strdup(optarg);
210 break;
211 case 'R':
212 /* no-op, still accepted for backwards compatibility */
213 break;
214 case 'P': /* Function */
215 opts->selTypes = 1;
216 opts->selFunction = 1;
217 simple_string_list_append(&opts->functionNames, optarg);
218 break;
219 case 'I': /* Index */
220 opts->selTypes = 1;
221 opts->selIndex = 1;
222 simple_string_list_append(&opts->indexNames, optarg);
223 break;
224 case 'T': /* Trigger */
225 opts->selTypes = 1;
226 opts->selTrigger = 1;
227 simple_string_list_append(&opts->triggerNames, optarg);
228 break;
229 case 's': /* dump schema only */
230 opts->schemaOnly = 1;
231 break;
232 case 'S': /* Superuser username */
233 if (strlen(optarg) != 0)
234 opts->superuser = pg_strdup(optarg);
235 break;
236 case 't': /* Dump specified table(s) only */
237 opts->selTypes = 1;
238 opts->selTable = 1;
239 simple_string_list_append(&opts->tableNames, optarg);
240 break;
241
242 case 'U':
243 opts->cparams.username = pg_strdup(optarg);
244 break;
245
246 case 'v': /* verbose */
247 opts->verbose = 1;
248 break;
249
250 case 'w':
251 opts->cparams.promptPassword = TRI_NO;
252 break;
253
254 case 'W':
255 opts->cparams.promptPassword = TRI_YES;
256 break;
257
258 case 'x': /* skip ACL dump */
259 opts->aclsSkip = 1;
260 break;
261
262 case '1': /* Restore data in a single transaction */
263 opts->single_txn = true;
264 opts->exit_on_error = true;
265 break;
266
267 case 0:
268
269 /*
270 * This covers the long options without a short equivalent.
271 */
272 break;
273
274 case 2: /* SET ROLE */
275 opts->use_role = pg_strdup(optarg);
276 break;
277
278 case 3: /* section */
279 set_dump_section(optarg, &(opts->dumpSections));
280 break;
281
282 default:
283 fprintf(stderr, _("Try \"%s --help\" for more information.\n"), progname);
284 exit_nicely(1);
285 }
286 }
287
288 /* Get file name from command line */
289 if (optind < argc)
290 inputFileSpec = argv[optind++];
291 else
292 inputFileSpec = NULL;
293
294 /* Complain if any arguments remain */
295 if (optind < argc)
296 {
297 fprintf(stderr, _("%s: too many command-line arguments (first is \"%s\")\n"),
298 progname, argv[optind]);
299 fprintf(stderr, _("Try \"%s --help\" for more information.\n"),
300 progname);
301 exit_nicely(1);
302 }
303
304 /* Should get at most one of -d and -f, else user is confused */
305 if (opts->cparams.dbname)
306 {
307 if (opts->filename)
308 {
309 fprintf(stderr, _("%s: options -d/--dbname and -f/--file cannot be used together\n"),
310 progname);
311 fprintf(stderr, _("Try \"%s --help\" for more information.\n"),
312 progname);
313 exit_nicely(1);
314 }
315 opts->useDB = 1;
316 }
317
318 if (opts->dataOnly && opts->schemaOnly)
319 {
320 fprintf(stderr, _("%s: options -s/--schema-only and -a/--data-only cannot be used together\n"),
321 progname);
322 exit_nicely(1);
323 }
324
325 if (opts->dataOnly && opts->dropSchema)
326 {
327 fprintf(stderr, _("%s: options -c/--clean and -a/--data-only cannot be used together\n"),
328 progname);
329 exit_nicely(1);
330 }
331
332 if (numWorkers <= 0)
333 {
334 fprintf(stderr, _("%s: invalid number of parallel jobs\n"), progname);
335 exit(1);
336 }
337
338 /* See comments in pg_dump.c */
339 #ifdef WIN32
340 if (numWorkers > MAXIMUM_WAIT_OBJECTS)
341 {
342 fprintf(stderr, _("%s: maximum number of parallel jobs is %d\n"),
343 progname, MAXIMUM_WAIT_OBJECTS);
344 exit(1);
345 }
346 #endif
347
348 /* Can't do single-txn mode with multiple connections */
349 if (opts->single_txn && numWorkers > 1)
350 {
351 fprintf(stderr, _("%s: cannot specify both --single-transaction and multiple jobs\n"),
352 progname);
353 exit_nicely(1);
354 }
355
356 opts->disable_triggers = disable_triggers;
357 opts->enable_row_security = enable_row_security;
358 opts->noDataForFailedTables = no_data_for_failed_tables;
359 opts->noTablespace = outputNoTablespaces;
360 opts->use_setsessauth = use_setsessauth;
361 opts->no_publications = no_publications;
362 opts->no_security_labels = no_security_labels;
363 opts->no_subscriptions = no_subscriptions;
364
365 if (if_exists && !opts->dropSchema)
366 {
367 fprintf(stderr, _("%s: option --if-exists requires option -c/--clean\n"),
368 progname);
369 exit_nicely(1);
370 }
371 opts->if_exists = if_exists;
372 opts->strict_names = strict_names;
373
374 if (opts->formatName)
375 {
376 switch (opts->formatName[0])
377 {
378 case 'c':
379 case 'C':
380 opts->format = archCustom;
381 break;
382
383 case 'd':
384 case 'D':
385 opts->format = archDirectory;
386 break;
387
388 case 't':
389 case 'T':
390 opts->format = archTar;
391 break;
392
393 default:
394 write_msg(NULL, "unrecognized archive format \"%s\"; please specify \"c\", \"d\", or \"t\"\n",
395 opts->formatName);
396 exit_nicely(1);
397 }
398 }
399
400 AH = OpenArchive(inputFileSpec, opts->format);
401
402 SetArchiveOptions(AH, NULL, opts);
403
404 /*
405 * We don't have a connection yet but that doesn't matter. The connection
406 * is initialized to NULL and if we terminate through exit_nicely() while
407 * it's still NULL, the cleanup function will just be a no-op.
408 */
409 on_exit_close_archive(AH);
410
411 /* Let the archiver know how noisy to be */
412 AH->verbose = opts->verbose;
413
414 /*
415 * Whether to keep submitting sql commands as "pg_restore ... | psql ... "
416 */
417 AH->exit_on_error = opts->exit_on_error;
418
419 if (opts->tocFile)
420 SortTocFromFile(AH);
421
422 AH->numWorkers = numWorkers;
423
424 if (opts->tocSummary)
425 PrintTOCSummary(AH);
426 else
427 {
428 ProcessArchiveRestoreOptions(AH);
429 RestoreArchive(AH);
430 }
431
432 /* done, print a summary of ignored errors */
433 if (AH->n_errors)
434 fprintf(stderr, _("WARNING: errors ignored on restore: %d\n"),
435 AH->n_errors);
436
437 /* AH may be freed in CloseArchive? */
438 exit_code = AH->n_errors ? 1 : 0;
439
440 CloseArchive(AH);
441
442 return exit_code;
443 }
444
445 static void
usage(const char * progname)446 usage(const char *progname)
447 {
448 printf(_("%s restores a PostgreSQL database from an archive created by pg_dump.\n\n"), progname);
449 printf(_("Usage:\n"));
450 printf(_(" %s [OPTION]... [FILE]\n"), progname);
451
452 printf(_("\nGeneral options:\n"));
453 printf(_(" -d, --dbname=NAME connect to database name\n"));
454 printf(_(" -f, --file=FILENAME output file name (- for stdout)\n"));
455 printf(_(" -F, --format=c|d|t backup file format (should be automatic)\n"));
456 printf(_(" -l, --list print summarized TOC of the archive\n"));
457 printf(_(" -v, --verbose verbose mode\n"));
458 printf(_(" -V, --version output version information, then exit\n"));
459 printf(_(" -?, --help show this help, then exit\n"));
460
461 printf(_("\nOptions controlling the restore:\n"));
462 printf(_(" -a, --data-only restore only the data, no schema\n"));
463 printf(_(" -c, --clean clean (drop) database objects before recreating\n"));
464 printf(_(" -C, --create create the target database\n"));
465 printf(_(" -e, --exit-on-error exit on error, default is to continue\n"));
466 printf(_(" -I, --index=NAME restore named index\n"));
467 printf(_(" -j, --jobs=NUM use this many parallel jobs to restore\n"));
468 printf(_(" -L, --use-list=FILENAME use table of contents from this file for\n"
469 " selecting/ordering output\n"));
470 printf(_(" -n, --schema=NAME restore only objects in this schema\n"));
471 printf(_(" -N, --exclude-schema=NAME do not restore objects in this schema\n"));
472 printf(_(" -O, --no-owner skip restoration of object ownership\n"));
473 printf(_(" -P, --function=NAME(args) restore named function\n"));
474 printf(_(" -s, --schema-only restore only the schema, no data\n"));
475 printf(_(" -S, --superuser=NAME superuser user name to use for disabling triggers\n"));
476 printf(_(" -t, --table=NAME restore named relation (table, view, etc.)\n"));
477 printf(_(" -T, --trigger=NAME restore named trigger\n"));
478 printf(_(" -x, --no-privileges skip restoration of access privileges (grant/revoke)\n"));
479 printf(_(" -1, --single-transaction restore as a single transaction\n"));
480 printf(_(" --disable-triggers disable triggers during data-only restore\n"));
481 printf(_(" --enable-row-security enable row security\n"));
482 printf(_(" --if-exists use IF EXISTS when dropping objects\n"));
483 printf(_(" --no-data-for-failed-tables do not restore data of tables that could not be\n"
484 " created\n"));
485 printf(_(" --no-publications do not restore publications\n"));
486 printf(_(" --no-security-labels do not restore security labels\n"));
487 printf(_(" --no-subscriptions do not restore subscriptions\n"));
488 printf(_(" --no-tablespaces do not restore tablespace assignments\n"));
489 printf(_(" --section=SECTION restore named section (pre-data, data, or post-data)\n"));
490 printf(_(" --strict-names require table and/or schema include patterns to\n"
491 " match at least one entity each\n"));
492 printf(_(" --use-set-session-authorization\n"
493 " use SET SESSION AUTHORIZATION commands instead of\n"
494 " ALTER OWNER commands to set ownership\n"));
495
496 printf(_("\nConnection options:\n"));
497 printf(_(" -h, --host=HOSTNAME database server host or socket directory\n"));
498 printf(_(" -p, --port=PORT database server port number\n"));
499 printf(_(" -U, --username=NAME connect as specified database user\n"));
500 printf(_(" -w, --no-password never prompt for password\n"));
501 printf(_(" -W, --password force password prompt (should happen automatically)\n"));
502 printf(_(" --role=ROLENAME do SET ROLE before restore\n"));
503
504 printf(_("\n"
505 "The options -I, -n, -N, -P, -t, -T, and --section can be combined and specified\n"
506 "multiple times to select multiple objects.\n"));
507 printf(_("\nIf no input file name is supplied, then standard input is used.\n\n"));
508 printf(_("Report bugs to <pgsql-bugs@postgresql.org>.\n"));
509 }
510