PostgreSQL Source Code  git master
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
pg_restore.c File Reference
#include "postgres_fe.h"
#include <ctype.h>
#include "getopt_long.h"
#include "dumputils.h"
#include "parallel.h"
#include "pg_backup_utils.h"
Include dependency graph for pg_restore.c:

Go to the source code of this file.

Typedefs

typedef struct option optType
 

Functions

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

Typedef Documentation

Definition at line 57 of file pg_restore.c.

Function Documentation

int main ( int  argc,
char **  argv 
)

Definition at line 60 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, _restoreOptions::functionNames, get_progname(), getopt_long(), if_exists, _restoreOptions::if_exists, _restoreOptions::indexNames, init_parallel_dump_utils(), Archive::n_errors, NewRestoreOptions(), no_argument, _restoreOptions::no_security_labels, no_security_labels, _restoreOptions::noDataForFailedTables, _restoreOptions::noOwner, _restoreOptions::noTablespace, NULL, Archive::numWorkers, on_exit_close_archive(), OpenArchive(), optarg, optind, 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, Archive::verbose, and write_msg().

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_security_labels = 0;
75  static int strict_names = 0;
76 
77  struct option cmdopts[] = {
78  {"clean", 0, NULL, 'c'},
79  {"create", 0, NULL, 'C'},
80  {"data-only", 0, NULL, 'a'},
81  {"dbname", 1, NULL, 'd'},
82  {"exit-on-error", 0, NULL, 'e'},
83  {"exclude-schema", 1, NULL, 'N'},
84  {"file", 1, NULL, 'f'},
85  {"format", 1, NULL, 'F'},
86  {"function", 1, NULL, 'P'},
87  {"host", 1, NULL, 'h'},
88  {"index", 1, NULL, 'I'},
89  {"jobs", 1, NULL, 'j'},
90  {"list", 0, NULL, 'l'},
91  {"no-privileges", 0, NULL, 'x'},
92  {"no-acl", 0, NULL, 'x'},
93  {"no-owner", 0, NULL, 'O'},
94  {"no-reconnect", 0, NULL, 'R'},
95  {"port", 1, NULL, 'p'},
96  {"no-password", 0, NULL, 'w'},
97  {"password", 0, NULL, 'W'},
98  {"schema", 1, NULL, 'n'},
99  {"schema-only", 0, NULL, 's'},
100  {"superuser", 1, NULL, 'S'},
101  {"table", 1, NULL, 't'},
102  {"trigger", 1, NULL, 'T'},
103  {"use-list", 1, NULL, 'L'},
104  {"username", 1, NULL, 'U'},
105  {"verbose", 0, NULL, 'v'},
106  {"single-transaction", 0, NULL, '1'},
107 
108  /*
109  * the following options don't have an equivalent short option letter
110  */
111  {"disable-triggers", no_argument, &disable_triggers, 1},
112  {"enable-row-security", no_argument, &enable_row_security, 1},
113  {"if-exists", no_argument, &if_exists, 1},
114  {"no-data-for-failed-tables", no_argument, &no_data_for_failed_tables, 1},
115  {"no-tablespaces", no_argument, &outputNoTablespaces, 1},
116  {"role", required_argument, NULL, 2},
117  {"section", required_argument, NULL, 3},
118  {"strict-names", no_argument, &strict_names, 1},
119  {"use-set-session-authorization", no_argument, &use_setsessauth, 1},
120  {"no-security-labels", no_argument, &no_security_labels, 1},
121 
122  {NULL, 0, NULL, 0}
123  };
124 
125  set_pglocale_pgservice(argv[0], PG_TEXTDOMAIN("pg_dump"));
126 
128 
129  opts = NewRestoreOptions();
130 
131  progname = get_progname(argv[0]);
132 
133  if (argc > 1)
134  {
135  if (strcmp(argv[1], "--help") == 0 || strcmp(argv[1], "-?") == 0)
136  {
137  usage(progname);
138  exit_nicely(0);
139  }
140  if (strcmp(argv[1], "--version") == 0 || strcmp(argv[1], "-V") == 0)
141  {
142  puts("pg_restore (PostgreSQL) " PG_VERSION);
143  exit_nicely(0);
144  }
145  }
146 
147  while ((c = getopt_long(argc, argv, "acCd:ef:F:h:I:j:lL:n:N:Op:P:RsS:t:T:U:vwWx1",
148  cmdopts, NULL)) != -1)
149  {
150  switch (c)
151  {
152  case 'a': /* Dump data only */
153  opts->dataOnly = 1;
154  break;
155  case 'c': /* clean (i.e., drop) schema prior to create */
156  opts->dropSchema = 1;
157  break;
158  case 'C':
159  opts->createDB = 1;
160  break;
161  case 'd':
162  opts->dbname = pg_strdup(optarg);
163  break;
164  case 'e':
165  opts->exit_on_error = true;
166  break;
167  case 'f': /* output file name */
168  opts->filename = pg_strdup(optarg);
169  break;
170  case 'F':
171  if (strlen(optarg) != 0)
172  opts->formatName = pg_strdup(optarg);
173  break;
174  case 'h':
175  if (strlen(optarg) != 0)
176  opts->pghost = pg_strdup(optarg);
177  break;
178 
179  case 'j': /* number of restore jobs */
180  numWorkers = atoi(optarg);
181  break;
182 
183  case 'l': /* Dump the TOC summary */
184  opts->tocSummary = 1;
185  break;
186 
187  case 'L': /* input TOC summary file name */
188  opts->tocFile = pg_strdup(optarg);
189  break;
190 
191  case 'n': /* Dump data for this schema only */
193  break;
194 
195  case 'N': /* Do not dump data for this schema */
197  break;
198 
199  case 'O':
200  opts->noOwner = 1;
201  break;
202 
203  case 'p':
204  if (strlen(optarg) != 0)
205  opts->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;
214  break;
215  case 'I': /* Index */
216  opts->selTypes = 1;
217  opts->selIndex = 1;
219  break;
220  case 'T': /* Trigger */
221  opts->selTypes = 1;
222  opts->selTrigger = 1;
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;
236  break;
237 
238  case 'U':
239  opts->username = pg_strdup(optarg);
240  break;
241 
242  case 'v': /* verbose */
243  opts->verbose = 1;
244  break;
245 
246  case 'w':
247  opts->promptPassword = TRI_NO;
248  break;
249 
250  case 'W':
251  opts->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 */
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->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 
353  opts->enable_row_security = enable_row_security;
354  opts->noDataForFailedTables = no_data_for_failed_tables;
355  opts->noTablespace = outputNoTablespaces;
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  */
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  {
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 }
int noDataForFailedTables
Definition: pg_backup.h:111
SimpleStringList triggerNames
Definition: pg_backup.h:103
const char * get_progname(const char *argv0)
Definition: path.c:453
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:110
Archive * OpenArchive(const char *FileSpec, const ArchiveFormat fmt)
char * use_role
Definition: pg_backup.h:71
SimpleStringList schemaNames
Definition: pg_backup.h:101
int n_errors
Definition: pg_backup.h:198
void on_exit_close_archive(Archive *AHX)
Definition: parallel.c:345
const char * progname
Definition: pg_standby.c:37
char * formatName
Definition: pg_backup.h:92
RestoreOptions * NewRestoreOptions(void)
static int disable_triggers
Definition: pg_dumpall.c:72
const char * filename
Definition: pg_backup.h:80
static int strict_names
Definition: pg_dump.c:106
#define required_argument
Definition: getopt_long.h:25
int optind
Definition: getopt.c:51
SimpleStringList tableNames
Definition: pg_backup.h:104
char * c
static void usage(const char *progname)
Definition: pg_restore.c:440
SimpleStringList functionNames
Definition: pg_backup.h:100
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:77
int enable_row_security
Definition: pg_backup.h:120
char * superuser
Definition: pg_backup.h:70
#define no_argument
Definition: getopt_long.h:24
#define exit_nicely(code)
Definition: pg_dumpall.c:89
#define PG_TEXTDOMAIN(domain)
Definition: c.h:1012
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:179
void init_parallel_dump_utils(void)
Definition: parallel.c:249
void write_msg(const char *modulename, const char *fmt,...)
#define NULL
Definition: c.h:229
static int use_setsessauth
Definition: pg_dumpall.c:76
static int if_exists
Definition: pg_dumpall.c:73
int numWorkers
Definition: pg_backup.h:187
void SortTocFromFile(Archive *AHX)
SimpleStringList indexNames
Definition: pg_backup.h:99
void set_pglocale_pgservice(const char *argv0, const char *app)
Definition: exec.c:550
char * optarg
Definition: getopt.c:53
void RestoreArchive(Archive *AH)
bool exit_on_error
Definition: pg_backup.h:197
void ProcessArchiveRestoreOptions(Archive *AH)
SimpleStringList schemaExcludeNames
Definition: pg_backup.h:102
static int no_security_labels
Definition: pg_dumpall.c:77
#define _(x)
Definition: elog.c:84
char * tocFile
Definition: pg_backup.h:90
int disable_triggers
Definition: pg_backup.h:66
void SetArchiveOptions(Archive *AH, DumpOptions *dopt, RestoreOptions *ropt)
trivalue promptPassword
Definition: pg_backup.h:112
static void usage ( const char *  progname)
static

Definition at line 440 of file pg_restore.c.

References _.

Referenced by main().

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\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(_(" -N, --exclude-schema=NAME do not restore objects in this schema\n"));
466  printf(_(" -O, --no-owner skip restoration of object ownership\n"));
467  printf(_(" -P, --function=NAME(args) restore named function\n"));
468  printf(_(" -s, --schema-only restore only the schema, no data\n"));
469  printf(_(" -S, --superuser=NAME superuser user name to use for disabling triggers\n"));
470  printf(_(" -t, --table=NAME restore named relation (table, view, etc.)\n"));
471  printf(_(" -T, --trigger=NAME restore named trigger\n"));
472  printf(_(" -x, --no-privileges skip restoration of access privileges (grant/revoke)\n"));
473  printf(_(" -1, --single-transaction restore as a single transaction\n"));
474  printf(_(" --disable-triggers disable triggers during data-only restore\n"));
475  printf(_(" --enable-row-security enable row security\n"));
476  printf(_(" --if-exists use IF EXISTS when dropping objects\n"));
477  printf(_(" --no-data-for-failed-tables do not restore data of tables that could not be\n"
478  " created\n"));
479  printf(_(" --no-security-labels do not restore security labels\n"));
480  printf(_(" --no-tablespaces do not restore tablespace assignments\n"));
481  printf(_(" --section=SECTION restore named section (pre-data, data, or post-data)\n"));
482  printf(_(" --strict-names require table and/or schema include patterns to\n"
483  " match at least one entity each\n"));
484  printf(_(" --use-set-session-authorization\n"
485  " use SET SESSION AUTHORIZATION commands instead of\n"
486  " ALTER OWNER commands to set ownership\n"));
487 
488  printf(_("\nConnection options:\n"));
489  printf(_(" -h, --host=HOSTNAME database server host or socket directory\n"));
490  printf(_(" -p, --port=PORT database server port number\n"));
491  printf(_(" -U, --username=NAME connect as specified database user\n"));
492  printf(_(" -w, --no-password never prompt for password\n"));
493  printf(_(" -W, --password force password prompt (should happen automatically)\n"));
494  printf(_(" --role=ROLENAME do SET ROLE before restore\n"));
495 
496  printf(_("\n"
497  "The options -I, -n, -P, -t, -T, and --section can be combined and specified\n"
498  "multiple times to select multiple objects.\n"));
499  printf(_("\nIf no input file name is supplied, then standard input is used.\n\n"));
500  printf(_("Report bugs to <pgsql-bugs@postgresql.org>.\n"));
501 }
const char * progname
Definition: pg_standby.c:37
#define _(x)
Definition: elog.c:84