PostgreSQL Source Code  git master
pg_restore.c File Reference
#include "postgres_fe.h"
#include <ctype.h>
#include "dumputils.h"
#include "getopt_long.h"
#include "parallel.h"
#include "pg_backup_utils.h"
Include dependency graph for pg_restore.c:

Go to the source code of this file.

Functions

static void usage (const char *progname)
 
int main (int argc, char **argv)
 

Function Documentation

◆ main()

int main ( int  argc,
char **  argv 
)

Definition at line 56 of file pg_restore.c.

References _, _restoreOptions::aclsSkip, archCustom, archDirectory, archTar, CloseArchive(), _restoreOptions::createDB, _restoreOptions::dataOnly, _restoreOptions::dbname, _restoreOptions::disable_triggers, disable_triggers, _restoreOptions::dropSchema, _restoreOptions::dumpSections, _restoreOptions::enable_row_security, exit_nicely, _restoreOptions::exit_on_error, Archive::exit_on_error, _restoreOptions::filename, _restoreOptions::format, _restoreOptions::formatName, fprintf, _restoreOptions::functionNames, get_progname(), getopt_long(), if_exists, _restoreOptions::if_exists, _restoreOptions::indexNames, init_parallel_dump_utils(), Archive::n_errors, NewRestoreOptions(), no_argument, no_comments, _restoreOptions::no_comments, no_publications, _restoreOptions::no_publications, no_security_labels, _restoreOptions::no_security_labels, no_subscriptions, _restoreOptions::no_subscriptions, _restoreOptions::noDataForFailedTables, _restoreOptions::noOwner, _restoreOptions::noTablespace, Archive::numWorkers, on_exit_close_archive(), OpenArchive(), optarg, optind, pg_log_error, PG_LOG_INFO, pg_log_warning, PG_LOG_WARNING, pg_logging_init(), pg_logging_set_level(), pg_strdup(), PG_TEXTDOMAIN, _restoreOptions::pghost, _restoreOptions::pgport, PrintTOCSummary(), ProcessArchiveRestoreOptions(), progname, _restoreOptions::promptPassword, required_argument, RestoreArchive(), _restoreOptions::schemaExcludeNames, _restoreOptions::schemaNames, _restoreOptions::schemaOnly, _restoreOptions::selFunction, _restoreOptions::selIndex, _restoreOptions::selTable, _restoreOptions::selTrigger, _restoreOptions::selTypes, set_dump_section(), set_pglocale_pgservice(), SetArchiveOptions(), simple_string_list_append(), _restoreOptions::single_txn, SortTocFromFile(), _restoreOptions::strict_names, strict_names, _restoreOptions::superuser, _restoreOptions::tableNames, _restoreOptions::tocFile, _restoreOptions::tocSummary, TRI_NO, TRI_YES, _restoreOptions::triggerNames, usage(), _restoreOptions::use_role, _restoreOptions::use_setsessauth, use_setsessauth, _restoreOptions::useDB, _restoreOptions::username, _restoreOptions::verbose, and Archive::verbose.

57 {
58  RestoreOptions *opts;
59  int c;
60  int exit_code;
61  int numWorkers = 1;
62  Archive *AH;
63  char *inputFileSpec;
64  static int disable_triggers = 0;
65  static int enable_row_security = 0;
66  static int if_exists = 0;
67  static int no_data_for_failed_tables = 0;
68  static int outputNoTablespaces = 0;
69  static int use_setsessauth = 0;
70  static int no_comments = 0;
71  static int no_publications = 0;
72  static int no_security_labels = 0;
73  static int no_subscriptions = 0;
74  static int strict_names = 0;
75 
76  struct option cmdopts[] = {
77  {"clean", 0, NULL, 'c'},
78  {"create", 0, NULL, 'C'},
79  {"data-only", 0, NULL, 'a'},
80  {"dbname", 1, NULL, 'd'},
81  {"exit-on-error", 0, NULL, 'e'},
82  {"exclude-schema", 1, NULL, 'N'},
83  {"file", 1, NULL, 'f'},
84  {"format", 1, NULL, 'F'},
85  {"function", 1, NULL, 'P'},
86  {"host", 1, NULL, 'h'},
87  {"index", 1, NULL, 'I'},
88  {"jobs", 1, NULL, 'j'},
89  {"list", 0, NULL, 'l'},
90  {"no-privileges", 0, NULL, 'x'},
91  {"no-acl", 0, NULL, 'x'},
92  {"no-owner", 0, NULL, 'O'},
93  {"no-reconnect", 0, NULL, 'R'},
94  {"port", 1, NULL, 'p'},
95  {"no-password", 0, NULL, 'w'},
96  {"password", 0, NULL, 'W'},
97  {"schema", 1, NULL, 'n'},
98  {"schema-only", 0, NULL, 's'},
99  {"superuser", 1, NULL, 'S'},
100  {"table", 1, NULL, 't'},
101  {"trigger", 1, NULL, 'T'},
102  {"use-list", 1, NULL, 'L'},
103  {"username", 1, NULL, 'U'},
104  {"verbose", 0, NULL, 'v'},
105  {"single-transaction", 0, NULL, '1'},
106 
107  /*
108  * the following options don't have an equivalent short option letter
109  */
110  {"disable-triggers", no_argument, &disable_triggers, 1},
111  {"enable-row-security", no_argument, &enable_row_security, 1},
112  {"if-exists", no_argument, &if_exists, 1},
113  {"no-data-for-failed-tables", no_argument, &no_data_for_failed_tables, 1},
114  {"no-tablespaces", no_argument, &outputNoTablespaces, 1},
115  {"role", required_argument, NULL, 2},
116  {"section", required_argument, NULL, 3},
117  {"strict-names", no_argument, &strict_names, 1},
118  {"use-set-session-authorization", no_argument, &use_setsessauth, 1},
119  {"no-comments", no_argument, &no_comments, 1},
120  {"no-publications", no_argument, &no_publications, 1},
121  {"no-security-labels", no_argument, &no_security_labels, 1},
122  {"no-subscriptions", no_argument, &no_subscriptions, 1},
123 
124  {NULL, 0, NULL, 0}
125  };
126 
127  pg_logging_init(argv[0]);
129  set_pglocale_pgservice(argv[0], PG_TEXTDOMAIN("pg_dump"));
130 
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->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->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 */
197  break;
198 
199  case 'N': /* Do not dump data for this schema */
201  break;
202 
203  case 'O':
204  opts->noOwner = 1;
205  break;
206 
207  case 'p':
208  if (strlen(optarg) != 0)
209  opts->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;
218  break;
219  case 'I': /* Index */
220  opts->selTypes = 1;
221  opts->selIndex = 1;
223  break;
224  case 'T': /* Trigger */
225  opts->selTypes = 1;
226  opts->selTrigger = 1;
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;
240  break;
241 
242  case 'U':
243  opts->username = pg_strdup(optarg);
244  break;
245 
246  case 'v': /* verbose */
247  opts->verbose = 1;
249  break;
250 
251  case 'w':
252  opts->promptPassword = TRI_NO;
253  break;
254 
255  case 'W':
256  opts->promptPassword = TRI_YES;
257  break;
258 
259  case 'x': /* skip ACL dump */
260  opts->aclsSkip = 1;
261  break;
262 
263  case '1': /* Restore data in a single transaction */
264  opts->single_txn = true;
265  opts->exit_on_error = true;
266  break;
267 
268  case 0:
269 
270  /*
271  * This covers the long options without a short equivalent.
272  */
273  break;
274 
275  case 2: /* SET ROLE */
276  opts->use_role = pg_strdup(optarg);
277  break;
278 
279  case 3: /* section */
281  break;
282 
283  default:
284  fprintf(stderr, _("Try \"%s --help\" for more information.\n"), progname);
285  exit_nicely(1);
286  }
287  }
288 
289  /* Get file name from command line */
290  if (optind < argc)
291  inputFileSpec = argv[optind++];
292  else
293  inputFileSpec = NULL;
294 
295  /* Complain if any arguments remain */
296  if (optind < argc)
297  {
298  pg_log_error("too many command-line arguments (first is \"%s\")",
299  argv[optind]);
300  fprintf(stderr, _("Try \"%s --help\" for more information.\n"),
301  progname);
302  exit_nicely(1);
303  }
304 
305  /* Complain if neither -f nor -d was specified (except if dumping TOC) */
306  if (!opts->dbname && !opts->filename && !opts->tocSummary)
307  {
308  pg_log_error("one of -d/--dbname and -f/--file must be specified");
309  exit_nicely(1);
310  }
311 
312  /* Should get at most one of -d and -f, else user is confused */
313  if (opts->dbname)
314  {
315  if (opts->filename)
316  {
317  pg_log_error("options -d/--dbname and -f/--file cannot be used together");
318  fprintf(stderr, _("Try \"%s --help\" for more information.\n"),
319  progname);
320  exit_nicely(1);
321  }
322  opts->useDB = 1;
323  }
324 
325  if (opts->dataOnly && opts->schemaOnly)
326  {
327  pg_log_error("options -s/--schema-only and -a/--data-only cannot be used together");
328  exit_nicely(1);
329  }
330 
331  if (opts->dataOnly && opts->dropSchema)
332  {
333  pg_log_error("options -c/--clean and -a/--data-only cannot be used together");
334  exit_nicely(1);
335  }
336 
337  /*
338  * -C is not compatible with -1, because we can't create a database inside
339  * a transaction block.
340  */
341  if (opts->createDB && opts->single_txn)
342  {
343  pg_log_error("options -C/--create and -1/--single-transaction cannot be used together");
344  exit_nicely(1);
345  }
346 
347  if (numWorkers <= 0)
348  {
349  pg_log_error("invalid number of parallel jobs");
350  exit(1);
351  }
352 
353  /* See comments in pg_dump.c */
354 #ifdef WIN32
355  if (numWorkers > MAXIMUM_WAIT_OBJECTS)
356  {
357  pg_log_error("maximum number of parallel jobs is %d",
358  MAXIMUM_WAIT_OBJECTS);
359  exit(1);
360  }
361 #endif
362 
363  /* Can't do single-txn mode with multiple connections */
364  if (opts->single_txn && numWorkers > 1)
365  {
366  pg_log_error("cannot specify both --single-transaction and multiple jobs");
367  exit_nicely(1);
368  }
369 
371  opts->enable_row_security = enable_row_security;
372  opts->noDataForFailedTables = no_data_for_failed_tables;
373  opts->noTablespace = outputNoTablespaces;
375  opts->no_comments = no_comments;
379 
380  if (if_exists && !opts->dropSchema)
381  {
382  pg_log_error("option --if-exists requires option -c/--clean");
383  exit_nicely(1);
384  }
385  opts->if_exists = if_exists;
386  opts->strict_names = strict_names;
387 
388  if (opts->formatName)
389  {
390  switch (opts->formatName[0])
391  {
392  case 'c':
393  case 'C':
394  opts->format = archCustom;
395  break;
396 
397  case 'd':
398  case 'D':
399  opts->format = archDirectory;
400  break;
401 
402  case 't':
403  case 'T':
404  opts->format = archTar;
405  break;
406 
407  default:
408  pg_log_error("unrecognized archive format \"%s\"; please specify \"c\", \"d\", or \"t\"",
409  opts->formatName);
410  exit_nicely(1);
411  }
412  }
413 
414  AH = OpenArchive(inputFileSpec, opts->format);
415 
416  SetArchiveOptions(AH, NULL, opts);
417 
418  /*
419  * We don't have a connection yet but that doesn't matter. The connection
420  * is initialized to NULL and if we terminate through exit_nicely() while
421  * it's still NULL, the cleanup function will just be a no-op.
422  */
424 
425  /* Let the archiver know how noisy to be */
426  AH->verbose = opts->verbose;
427 
428  /*
429  * Whether to keep submitting sql commands as "pg_restore ... | psql ... "
430  */
431  AH->exit_on_error = opts->exit_on_error;
432 
433  if (opts->tocFile)
434  SortTocFromFile(AH);
435 
436  AH->numWorkers = numWorkers;
437 
438  if (opts->tocSummary)
439  PrintTOCSummary(AH);
440  else
441  {
443  RestoreArchive(AH);
444  }
445 
446  /* done, print a summary of ignored errors */
447  if (AH->n_errors)
448  pg_log_warning("errors ignored on restore: %d", AH->n_errors);
449 
450  /* AH may be freed in CloseArchive? */
451  exit_code = AH->n_errors ? 1 : 0;
452 
453  CloseArchive(AH);
454 
455  return exit_code;
456 }
int noDataForFailedTables
Definition: pg_backup.h:114
SimpleStringList triggerNames
Definition: pg_backup.h:106
static int no_publications
Definition: pg_dumpall.c:76
const char * get_progname(const char *argv0)
Definition: path.c:453
#define pg_log_error(...)
Definition: logging.h:79
int getopt_long(int argc, char *const argv[], const char *optstring, const struct option *longopts, int *longindex)
Definition: getopt_long.c:57
char * username
Definition: pg_backup.h:113
void pg_logging_init(const char *argv0)
Definition: logging.c:39
Archive * OpenArchive(const char *FileSpec, const ArchiveFormat fmt)
char * use_role
Definition: pg_backup.h:71
SimpleStringList schemaNames
Definition: pg_backup.h:104
int n_errors
Definition: pg_backup.h:206
void on_exit_close_archive(Archive *AHX)
Definition: parallel.c:342
const char * progname
Definition: pg_standby.c:36
#define fprintf
Definition: port.h:196
char * formatName
Definition: pg_backup.h:95
RestoreOptions * NewRestoreOptions(void)
static int disable_triggers
Definition: pg_dumpall.c:70
const char * filename
Definition: pg_backup.h:83
static int strict_names
Definition: pg_dump.c:104
#define required_argument
Definition: getopt_long.h:25
int optind
Definition: getopt.c:50
SimpleStringList tableNames
Definition: pg_backup.h:107
char * c
static void usage(const char *progname)
Definition: pg_restore.c:459
SimpleStringList functionNames
Definition: pg_backup.h:103
char * pg_strdup(const char *in)
Definition: fe_memutils.c:85
void PrintTOCSummary(Archive *AH)
void CloseArchive(Archive *AH)
int no_security_labels
Definition: pg_backup.h:79
int enable_row_security
Definition: pg_backup.h:123
int no_subscriptions
Definition: pg_backup.h:80
char * superuser
Definition: pg_backup.h:70
#define no_argument
Definition: getopt_long.h:24
#define exit_nicely(code)
Definition: pg_dumpall.c:95
#define PG_TEXTDOMAIN(domain)
Definition: c.h:1160
void simple_string_list_append(SimpleStringList *list, const char *val)
Definition: simple_list.c:63
void set_dump_section(const char *arg, int *dumpSections)
int use_setsessauth
Definition: pg_backup.h:68
int verbose
Definition: pg_backup.h:185
static int no_subscriptions
Definition: pg_dumpall.c:78
void init_parallel_dump_utils(void)
Definition: parallel.c:246
static int use_setsessauth
Definition: pg_dumpall.c:74
static int no_comments
Definition: pg_dumpall.c:75
static int if_exists
Definition: pg_dumpall.c:71
int numWorkers
Definition: pg_backup.h:193
void SortTocFromFile(Archive *AHX)
SimpleStringList indexNames
Definition: pg_backup.h:102
void set_pglocale_pgservice(const char *argv0, const char *app)
Definition: exec.c:565
int no_publications
Definition: pg_backup.h:78
char * optarg
Definition: getopt.c:52
void RestoreArchive(Archive *AH)
bool exit_on_error
Definition: pg_backup.h:205
void pg_logging_set_level(enum pg_log_level new_level)
Definition: logging.c:108
void ProcessArchiveRestoreOptions(Archive *AH)
SimpleStringList schemaExcludeNames
Definition: pg_backup.h:105
static int no_security_labels
Definition: pg_dumpall.c:77
#define pg_log_warning(...)
Definition: pgfnames.c:24
#define _(x)
Definition: elog.c:87
char * tocFile
Definition: pg_backup.h:93
int disable_triggers
Definition: pg_backup.h:66
void SetArchiveOptions(Archive *AH, DumpOptions *dopt, RestoreOptions *ropt)
trivalue promptPassword
Definition: pg_backup.h:115

◆ usage()

static void usage ( const char *  progname)
static

Definition at line 459 of file pg_restore.c.

References _, and printf.

Referenced by main().

460 {
461  printf(_("%s restores a PostgreSQL database from an archive created by pg_dump.\n\n"), progname);
462  printf(_("Usage:\n"));
463  printf(_(" %s [OPTION]... [FILE]\n"), progname);
464 
465  printf(_("\nGeneral options:\n"));
466  printf(_(" -d, --dbname=NAME connect to database name\n"));
467  printf(_(" -f, --file=FILENAME output file name (- for stdout)\n"));
468  printf(_(" -F, --format=c|d|t backup file format (should be automatic)\n"));
469  printf(_(" -l, --list print summarized TOC of the archive\n"));
470  printf(_(" -v, --verbose verbose mode\n"));
471  printf(_(" -V, --version output version information, then exit\n"));
472  printf(_(" -?, --help show this help, then exit\n"));
473 
474  printf(_("\nOptions controlling the restore:\n"));
475  printf(_(" -a, --data-only restore only the data, no schema\n"));
476  printf(_(" -c, --clean clean (drop) database objects before recreating\n"));
477  printf(_(" -C, --create create the target database\n"));
478  printf(_(" -e, --exit-on-error exit on error, default is to continue\n"));
479  printf(_(" -I, --index=NAME restore named index\n"));
480  printf(_(" -j, --jobs=NUM use this many parallel jobs to restore\n"));
481  printf(_(" -L, --use-list=FILENAME use table of contents from this file for\n"
482  " selecting/ordering output\n"));
483  printf(_(" -n, --schema=NAME restore only objects in this schema\n"));
484  printf(_(" -N, --exclude-schema=NAME do not restore objects in this schema\n"));
485  printf(_(" -O, --no-owner skip restoration of object ownership\n"));
486  printf(_(" -P, --function=NAME(args) restore named function\n"));
487  printf(_(" -s, --schema-only restore only the schema, no data\n"));
488  printf(_(" -S, --superuser=NAME superuser user name to use for disabling triggers\n"));
489  printf(_(" -t, --table=NAME restore named relation (table, view, etc.)\n"));
490  printf(_(" -T, --trigger=NAME restore named trigger\n"));
491  printf(_(" -x, --no-privileges skip restoration of access privileges (grant/revoke)\n"));
492  printf(_(" -1, --single-transaction restore as a single transaction\n"));
493  printf(_(" --disable-triggers disable triggers during data-only restore\n"));
494  printf(_(" --enable-row-security enable row security\n"));
495  printf(_(" --if-exists use IF EXISTS when dropping objects\n"));
496  printf(_(" --no-comments do not restore comments\n"));
497  printf(_(" --no-data-for-failed-tables do not restore data of tables that could not be\n"
498  " created\n"));
499  printf(_(" --no-publications do not restore publications\n"));
500  printf(_(" --no-security-labels do not restore security labels\n"));
501  printf(_(" --no-subscriptions do not restore subscriptions\n"));
502  printf(_(" --no-tablespaces do not restore tablespace assignments\n"));
503  printf(_(" --section=SECTION restore named section (pre-data, data, or post-data)\n"));
504  printf(_(" --strict-names require table and/or schema include patterns to\n"
505  " match at least one entity each\n"));
506  printf(_(" --use-set-session-authorization\n"
507  " use SET SESSION AUTHORIZATION commands instead of\n"
508  " ALTER OWNER commands to set ownership\n"));
509 
510  printf(_("\nConnection options:\n"));
511  printf(_(" -h, --host=HOSTNAME database server host or socket directory\n"));
512  printf(_(" -p, --port=PORT database server port number\n"));
513  printf(_(" -U, --username=NAME connect as specified database user\n"));
514  printf(_(" -w, --no-password never prompt for password\n"));
515  printf(_(" -W, --password force password prompt (should happen automatically)\n"));
516  printf(_(" --role=ROLENAME do SET ROLE before restore\n"));
517 
518  printf(_("\n"
519  "The options -I, -n, -N, -P, -t, -T, and --section can be combined and specified\n"
520  "multiple times to select multiple objects.\n"));
521  printf(_("\nIf no input file name is supplied, then standard input is used.\n\n"));
522  printf(_("Report bugs to <pgsql-bugs@lists.postgresql.org>.\n"));
523 }
#define printf(...)
Definition: port.h:198
const char * progname
Definition: pg_standby.c:36
#define _(x)
Definition: elog.c:87