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