PostgreSQL Source Code git master
Functions
pg_restore.c File Reference
#include "postgres_fe.h"
#include <ctype.h>
#include "dumputils.h"
#include "fe_utils/option_utils.h"
#include "filter.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)
 
static void read_restore_filters (const char *filename, RestoreOptions *opts)
 
int main (int argc, char **argv)
 

Function Documentation

◆ main()

int main ( int  argc,
char **  argv 
)

Definition at line 59 of file pg_restore.c.

60{
61 RestoreOptions *opts;
62 int c;
63 int exit_code;
64 int numWorkers = 1;
65 Archive *AH;
66 char *inputFileSpec;
67 bool data_only = false;
68 bool schema_only = false;
69 static int disable_triggers = 0;
70 static int enable_row_security = 0;
71 static int if_exists = 0;
72 static int no_data_for_failed_tables = 0;
73 static int outputNoTableAm = 0;
74 static int outputNoTablespaces = 0;
75 static int use_setsessauth = 0;
76 static int no_comments = 0;
77 static int no_data = 0;
78 static int no_policies = 0;
79 static int no_publications = 0;
80 static int no_schema = 0;
81 static int no_security_labels = 0;
82 static int no_statistics = 0;
83 static int no_subscriptions = 0;
84 static int strict_names = 0;
85 static int statistics_only = 0;
86 static int with_statistics = 0;
87
88 struct option cmdopts[] = {
89 {"clean", 0, NULL, 'c'},
90 {"create", 0, NULL, 'C'},
91 {"data-only", 0, NULL, 'a'},
92 {"dbname", 1, NULL, 'd'},
93 {"exit-on-error", 0, NULL, 'e'},
94 {"exclude-schema", 1, NULL, 'N'},
95 {"file", 1, NULL, 'f'},
96 {"format", 1, NULL, 'F'},
97 {"function", 1, NULL, 'P'},
98 {"host", 1, NULL, 'h'},
99 {"index", 1, NULL, 'I'},
100 {"jobs", 1, NULL, 'j'},
101 {"list", 0, NULL, 'l'},
102 {"no-privileges", 0, NULL, 'x'},
103 {"no-acl", 0, NULL, 'x'},
104 {"no-owner", 0, NULL, 'O'},
105 {"no-reconnect", 0, NULL, 'R'},
106 {"port", 1, NULL, 'p'},
107 {"no-password", 0, NULL, 'w'},
108 {"password", 0, NULL, 'W'},
109 {"schema", 1, NULL, 'n'},
110 {"schema-only", 0, NULL, 's'},
111 {"superuser", 1, NULL, 'S'},
112 {"table", 1, NULL, 't'},
113 {"trigger", 1, NULL, 'T'},
114 {"use-list", 1, NULL, 'L'},
115 {"username", 1, NULL, 'U'},
116 {"verbose", 0, NULL, 'v'},
117 {"single-transaction", 0, NULL, '1'},
118
119 /*
120 * the following options don't have an equivalent short option letter
121 */
122 {"disable-triggers", no_argument, &disable_triggers, 1},
123 {"enable-row-security", no_argument, &enable_row_security, 1},
124 {"if-exists", no_argument, &if_exists, 1},
125 {"no-data-for-failed-tables", no_argument, &no_data_for_failed_tables, 1},
126 {"no-table-access-method", no_argument, &outputNoTableAm, 1},
127 {"no-tablespaces", no_argument, &outputNoTablespaces, 1},
128 {"role", required_argument, NULL, 2},
129 {"section", required_argument, NULL, 3},
130 {"strict-names", no_argument, &strict_names, 1},
131 {"transaction-size", required_argument, NULL, 5},
132 {"use-set-session-authorization", no_argument, &use_setsessauth, 1},
133 {"no-comments", no_argument, &no_comments, 1},
134 {"no-data", no_argument, &no_data, 1},
135 {"no-policies", no_argument, &no_policies, 1},
136 {"no-publications", no_argument, &no_publications, 1},
137 {"no-schema", no_argument, &no_schema, 1},
138 {"no-security-labels", no_argument, &no_security_labels, 1},
139 {"no-subscriptions", no_argument, &no_subscriptions, 1},
140 {"no-statistics", no_argument, &no_statistics, 1},
141 {"statistics", no_argument, &with_statistics, 1},
142 {"statistics-only", no_argument, &statistics_only, 1},
143 {"filter", required_argument, NULL, 4},
144 {"restrict-key", required_argument, NULL, 6},
145
146 {NULL, 0, NULL, 0}
147 };
148
149 pg_logging_init(argv[0]);
150 pg_logging_set_level(PG_LOG_WARNING);
151 set_pglocale_pgservice(argv[0], PG_TEXTDOMAIN("pg_dump"));
152
153 init_parallel_dump_utils();
154
155 opts = NewRestoreOptions();
156
157 progname = get_progname(argv[0]);
158
159 if (argc > 1)
160 {
161 if (strcmp(argv[1], "--help") == 0 || strcmp(argv[1], "-?") == 0)
162 {
163 usage(progname);
164 exit_nicely(0);
165 }
166 if (strcmp(argv[1], "--version") == 0 || strcmp(argv[1], "-V") == 0)
167 {
168 puts("pg_restore (PostgreSQL) " PG_VERSION);
169 exit_nicely(0);
170 }
171 }
172
173 while ((c = getopt_long(argc, argv, "acCd:ef:F:h:I:j:lL:n:N:Op:P:RsS:t:T:U:vwWx1",
174 cmdopts, NULL)) != -1)
175 {
176 switch (c)
177 {
178 case 'a': /* Dump data only */
179 data_only = true;
180 break;
181 case 'c': /* clean (i.e., drop) schema prior to create */
182 opts->dropSchema = 1;
183 break;
184 case 'C':
185 opts->createDB = 1;
186 break;
187 case 'd':
188 opts->cparams.dbname = pg_strdup(optarg);
189 break;
190 case 'e':
191 opts->exit_on_error = true;
192 break;
193 case 'f': /* output file name */
194 opts->filename = pg_strdup(optarg);
195 break;
196 case 'F':
197 if (strlen(optarg) != 0)
198 opts->formatName = pg_strdup(optarg);
199 break;
200 case 'h':
201 if (strlen(optarg) != 0)
202 opts->cparams.pghost = pg_strdup(optarg);
203 break;
204
205 case 'j': /* number of restore jobs */
206 if (!option_parse_int(optarg, "-j/--jobs", 1,
207 PG_MAX_JOBS,
208 &numWorkers))
209 exit(1);
210 break;
211
212 case 'l': /* Dump the TOC summary */
213 opts->tocSummary = 1;
214 break;
215
216 case 'L': /* input TOC summary file name */
217 opts->tocFile = pg_strdup(optarg);
218 break;
219
220 case 'n': /* Dump data for this schema only */
221 simple_string_list_append(&opts->schemaNames, optarg);
222 break;
223
224 case 'N': /* Do not dump data for this schema */
225 simple_string_list_append(&opts->schemaExcludeNames, optarg);
226 break;
227
228 case 'O':
229 opts->noOwner = 1;
230 break;
231
232 case 'p':
233 if (strlen(optarg) != 0)
234 opts->cparams.pgport = pg_strdup(optarg);
235 break;
236 case 'R':
237 /* no-op, still accepted for backwards compatibility */
238 break;
239 case 'P': /* Function */
240 opts->selTypes = 1;
241 opts->selFunction = 1;
242 simple_string_list_append(&opts->functionNames, optarg);
243 break;
244 case 'I': /* Index */
245 opts->selTypes = 1;
246 opts->selIndex = 1;
247 simple_string_list_append(&opts->indexNames, optarg);
248 break;
249 case 'T': /* Trigger */
250 opts->selTypes = 1;
251 opts->selTrigger = 1;
252 simple_string_list_append(&opts->triggerNames, optarg);
253 break;
254 case 's': /* dump schema only */
255 schema_only = true;
256 break;
257 case 'S': /* Superuser username */
258 if (strlen(optarg) != 0)
259 opts->superuser = pg_strdup(optarg);
260 break;
261 case 't': /* Dump specified table(s) only */
262 opts->selTypes = 1;
263 opts->selTable = 1;
264 simple_string_list_append(&opts->tableNames, optarg);
265 break;
266
267 case 'U':
268 opts->cparams.username = pg_strdup(optarg);
269 break;
270
271 case 'v': /* verbose */
272 opts->verbose = 1;
273 pg_logging_increase_verbosity();
274 break;
275
276 case 'w':
277 opts->cparams.promptPassword = TRI_NO;
278 break;
279
280 case 'W':
281 opts->cparams.promptPassword = TRI_YES;
282 break;
283
284 case 'x': /* skip ACL dump */
285 opts->aclsSkip = 1;
286 break;
287
288 case '1': /* Restore data in a single transaction */
289 opts->single_txn = true;
290 opts->exit_on_error = true;
291 break;
292
293 case 0:
294
295 /*
296 * This covers the long options without a short equivalent.
297 */
298 break;
299
300 case 2: /* SET ROLE */
301 opts->use_role = pg_strdup(optarg);
302 break;
303
304 case 3: /* section */
305 set_dump_section(optarg, &(opts->dumpSections));
306 break;
307
308 case 4: /* filter */
309 read_restore_filters(optarg, opts);
310 break;
311
312 case 5: /* transaction-size */
313 if (!option_parse_int(optarg, "--transaction-size",
314 1, INT_MAX,
315 &opts->txn_size))
316 exit(1);
317 opts->exit_on_error = true;
318 break;
319
320 case 6:
321 opts->restrict_key = pg_strdup(optarg);
322 break;
323
324 default:
325 /* getopt_long already emitted a complaint */
326 pg_log_error_hint("Try \"%s --help\" for more information.", progname);
327 exit_nicely(1);
328 }
329 }
330
331 /* Get file name from command line */
332 if (optind < argc)
333 inputFileSpec = argv[optind++];
334 else
335 inputFileSpec = NULL;
336
337 /* Complain if any arguments remain */
338 if (optind < argc)
339 {
340 pg_log_error("too many command-line arguments (first is \"%s\")",
341 argv[optind]);
342 pg_log_error_hint("Try \"%s --help\" for more information.", progname);
343 exit_nicely(1);
344 }
345
346 /* Complain if neither -f nor -d was specified (except if dumping TOC) */
347 if (!opts->cparams.dbname && !opts->filename && !opts->tocSummary)
348 pg_fatal("one of -d/--dbname and -f/--file must be specified");
349
350 /* Should get at most one of -d and -f, else user is confused */
351 if (opts->cparams.dbname)
352 {
353 if (opts->filename)
354 {
355 pg_log_error("options -d/--dbname and -f/--file cannot be used together");
356 pg_log_error_hint("Try \"%s --help\" for more information.", progname);
357 exit_nicely(1);
358 }
359
360 if (opts->restrict_key)
361 pg_fatal("options -d/--dbname and --restrict-key cannot be used together");
362
363 opts->useDB = 1;
364 }
365 else
366 {
367 /*
368 * If you don't provide a restrict key, one will be appointed for you.
369 */
370 if (!opts->restrict_key)
371 opts->restrict_key = generate_restrict_key();
372 if (!opts->restrict_key)
373 pg_fatal("could not generate restrict key");
374 if (!valid_restrict_key(opts->restrict_key))
375 pg_fatal("invalid restrict key");
376 }
377
378 /* reject conflicting "-only" options */
379 if (data_only && schema_only)
380 pg_fatal("options -s/--schema-only and -a/--data-only cannot be used together");
381 if (schema_only && statistics_only)
382 pg_fatal("options -s/--schema-only and --statistics-only cannot be used together");
383 if (data_only && statistics_only)
384 pg_fatal("options -a/--data-only and --statistics-only cannot be used together");
385
386 /* reject conflicting "-only" and "no-" options */
387 if (data_only && no_data)
388 pg_fatal("options -a/--data-only and --no-data cannot be used together");
389 if (schema_only && no_schema)
390 pg_fatal("options -s/--schema-only and --no-schema cannot be used together");
391 if (statistics_only && no_statistics)
392 pg_fatal("options --statistics-only and --no-statistics cannot be used together");
393
394 /* reject conflicting "no-" options */
395 if (with_statistics && no_statistics)
396 pg_fatal("options --statistics and --no-statistics cannot be used together");
397
398 /* reject conflicting "only-" options */
399 if (data_only && with_statistics)
400 pg_fatal("options %s and %s cannot be used together",
401 "-a/--data-only", "--statistics");
402 if (schema_only && with_statistics)
403 pg_fatal("options %s and %s cannot be used together",
404 "-s/--schema-only", "--statistics");
405
406 if (data_only && opts->dropSchema)
407 pg_fatal("options -c/--clean and -a/--data-only cannot be used together");
408
409 if (opts->single_txn && opts->txn_size > 0)
410 pg_fatal("options -1/--single-transaction and --transaction-size cannot be used together");
411
412 /*
413 * -C is not compatible with -1, because we can't create a database inside
414 * a transaction block.
415 */
416 if (opts->createDB && opts->single_txn)
417 pg_fatal("options -C/--create and -1/--single-transaction cannot be used together");
418
419 /* Can't do single-txn mode with multiple connections */
420 if (opts->single_txn && numWorkers > 1)
421 pg_fatal("cannot specify both --single-transaction and multiple jobs");
422
423 /*
424 * Set derivative flags. Ambiguous or nonsensical combinations, e.g.
425 * "--schema-only --no-schema", will have already caused an error in one
426 * of the checks above.
427 */
428 opts->dumpData = ((opts->dumpData && !schema_only && !statistics_only) ||
429 data_only) && !no_data;
430 opts->dumpSchema = ((opts->dumpSchema && !data_only && !statistics_only) ||
431 schema_only) && !no_schema;
432 opts->dumpStatistics = ((opts->dumpStatistics && !schema_only && !data_only) ||
433 (statistics_only || with_statistics)) && !no_statistics;
434
435 opts->disable_triggers = disable_triggers;
436 opts->enable_row_security = enable_row_security;
437 opts->noDataForFailedTables = no_data_for_failed_tables;
438 opts->noTableAm = outputNoTableAm;
439 opts->noTablespace = outputNoTablespaces;
440 opts->use_setsessauth = use_setsessauth;
441 opts->no_comments = no_comments;
442 opts->no_policies = no_policies;
443 opts->no_publications = no_publications;
444 opts->no_security_labels = no_security_labels;
445 opts->no_subscriptions = no_subscriptions;
446
447 if (if_exists && !opts->dropSchema)
448 pg_fatal("option --if-exists requires option -c/--clean");
449 opts->if_exists = if_exists;
450 opts->strict_names = strict_names;
451
452 if (opts->formatName)
453 {
454 if (pg_strcasecmp(opts->formatName, "c") == 0 ||
455 pg_strcasecmp(opts->formatName, "custom") == 0)
456 opts->format = archCustom;
457 else if (pg_strcasecmp(opts->formatName, "d") == 0 ||
458 pg_strcasecmp(opts->formatName, "directory") == 0)
459 opts->format = archDirectory;
460 else if (pg_strcasecmp(opts->formatName, "t") == 0 ||
461 pg_strcasecmp(opts->formatName, "tar") == 0)
462 opts->format = archTar;
463 else if (pg_strcasecmp(opts->formatName, "p") == 0 ||
464 pg_strcasecmp(opts->formatName, "plain") == 0)
465 {
466 /* recognize this for consistency with pg_dump */
467 pg_fatal("archive format \"%s\" is not supported; please use psql",
468 opts->formatName);
469 }
470 else
471 pg_fatal("unrecognized archive format \"%s\"; please specify \"c\", \"d\", or \"t\"",
472 opts->formatName);
473 }
474
475 AH = OpenArchive(inputFileSpec, opts->format);
476
477 SetArchiveOptions(AH, NULL, opts);
478
479 /*
480 * We don't have a connection yet but that doesn't matter. The connection
481 * is initialized to NULL and if we terminate through exit_nicely() while
482 * it's still NULL, the cleanup function will just be a no-op.
483 */
484 on_exit_close_archive(AH);
485
486 /* Let the archiver know how noisy to be */
487 AH->verbose = opts->verbose;
488
489 /*
490 * Whether to keep submitting sql commands as "pg_restore ... | psql ... "
491 */
492 AH->exit_on_error = opts->exit_on_error;
493
494 if (opts->tocFile)
495 SortTocFromFile(AH);
496
497 AH->numWorkers = numWorkers;
498
499 if (opts->tocSummary)
500 PrintTOCSummary(AH);
501 else
502 {
503 ProcessArchiveRestoreOptions(AH);
504 RestoreArchive(AH);
505 }
506
507 /* done, print a summary of ignored errors */
508 if (AH->n_errors)
509 pg_log_warning("errors ignored on restore: %d", AH->n_errors);
510
511 /* AH may be freed in CloseArchive? */
512 exit_code = AH->n_errors ? 1 : 0;
513
514 CloseArchive(AH);
515
516 return exit_code;
517}
on_exit_close_archive
void on_exit_close_archive(Archive *AHX)
Definition: parallel.c:330
init_parallel_dump_utils
void init_parallel_dump_utils(void)
Definition: parallel.c:238
PG_MAX_JOBS
#define PG_MAX_JOBS
Definition: parallel.h:48
PG_TEXTDOMAIN
#define PG_TEXTDOMAIN(domain)
Definition: c.h:1202
set_pglocale_pgservice
void set_pglocale_pgservice(const char *argv0, const char *app)
Definition: exec.c:430
generate_restrict_key
char * generate_restrict_key(void)
Definition: dumputils.c:972
valid_restrict_key
bool valid_restrict_key(const char *restrict_key)
Definition: dumputils.c:996
pg_strdup
char * pg_strdup(const char *in)
Definition: fe_memutils.c:85
getopt_long
int getopt_long(int argc, char *const argv[], const char *optstring, const struct option *longopts, int *longindex)
Definition: getopt_long.c:60
no_argument
#define no_argument
Definition: getopt_long.h:25
required_argument
#define required_argument
Definition: getopt_long.h:26
pg_logging_increase_verbosity
void pg_logging_increase_verbosity(void)
Definition: logging.c:185
pg_logging_init
void pg_logging_init(const char *argv0)
Definition: logging.c:83
pg_logging_set_level
void pg_logging_set_level(enum pg_log_level new_level)
Definition: logging.c:176
pg_log_error
#define pg_log_error(...)
Definition: logging.h:106
pg_log_error_hint
#define pg_log_error_hint(...)
Definition: logging.h:112
PG_LOG_WARNING
@ PG_LOG_WARNING
Definition: logging.h:38
progname
const char * progname
Definition: main.c:44
option_parse_int
bool option_parse_int(const char *optarg, const char *optname, int min_range, int max_range, int *result)
Definition: option_utils.c:50
opts
static AmcheckOptions opts
Definition: pg_amcheck.c:112
ProcessArchiveRestoreOptions
void ProcessArchiveRestoreOptions(Archive *AHX)
Definition: pg_backup_archiver.c:289
NewRestoreOptions
RestoreOptions * NewRestoreOptions(void)
Definition: pg_backup_archiver.c:1106
OpenArchive
Archive * OpenArchive(const char *FileSpec, const ArchiveFormat fmt)
Definition: pg_backup_archiver.c:247
CloseArchive
void CloseArchive(Archive *AHX)
Definition: pg_backup_archiver.c:262
SortTocFromFile
void SortTocFromFile(Archive *AHX)
Definition: pg_backup_archiver.c:1570
PrintTOCSummary
void PrintTOCSummary(Archive *AHX)
Definition: pg_backup_archiver.c:1303
SetArchiveOptions
void SetArchiveOptions(Archive *AH, DumpOptions *dopt, RestoreOptions *ropt)
Definition: pg_backup_archiver.c:276
RestoreArchive
void RestoreArchive(Archive *AHX)
Definition: pg_backup_archiver.c:344
archTar
@ archTar
Definition: pg_backup.h:43
archCustom
@ archCustom
Definition: pg_backup.h:42
archDirectory
@ archDirectory
Definition: pg_backup.h:45
exit_nicely
void exit_nicely(int code)
Definition: pg_backup_utils.c:92
set_dump_section
void set_dump_section(const char *arg, int *dumpSections)
Definition: pg_backup_utils.c:42
pg_fatal
#define pg_fatal(...)
Definition: pg_backup_utils.h:36
strict_names
static int strict_names
Definition: pg_dump.c:155
if_exists
static int if_exists
Definition: pg_dumpall.c:92
statistics_only
static int statistics_only
Definition: pg_dumpall.c:112
no_policies
static int no_policies
Definition: pg_dumpall.c:98
disable_triggers
static int disable_triggers
Definition: pg_dumpall.c:91
no_comments
static int no_comments
Definition: pg_dumpall.c:97
no_publications
static int no_publications
Definition: pg_dumpall.c:99
no_security_labels
static int no_security_labels
Definition: pg_dumpall.c:100
no_statistics
static int no_statistics
Definition: pg_dumpall.c:103
use_setsessauth
static int use_setsessauth
Definition: pg_dumpall.c:96
no_data
static int no_data
Definition: pg_dumpall.c:101
no_schema
static int no_schema
Definition: pg_dumpall.c:102
no_subscriptions
static int no_subscriptions
Definition: pg_dumpall.c:104
with_statistics
static int with_statistics
Definition: pg_dumpall.c:108
optind
PGDLLIMPORT int optind
Definition: getopt.c:51
optarg
PGDLLIMPORT char * optarg
Definition: getopt.c:53
usage
static void usage(const char *progname)
Definition: pg_restore.c:520
read_restore_filters
static void read_restore_filters(const char *filename, RestoreOptions *opts)
Definition: pg_restore.c:606
pg_log_warning
#define pg_log_warning(...)
Definition: pgfnames.c:24
pg_strcasecmp
int pg_strcasecmp(const char *s1, const char *s2)
Definition: pgstrcasecmp.c:32
get_progname
const char * get_progname(const char *argv0)
Definition: path.c:652
c
char * c
Definition: preproc-cursor.c:31
simple_string_list_append
void simple_string_list_append(SimpleStringList *list, const char *val)
Definition: simple_list.c:63
AmcheckOptions::strict_names
bool strict_names
Definition: pg_amcheck.c:61
Archive::exit_on_error
bool exit_on_error
Definition: pg_backup.h:251
Archive::n_errors
int n_errors
Definition: pg_backup.h:252
Archive::numWorkers
int numWorkers
Definition: pg_backup.h:239
Archive::verbose
int verbose
Definition: pg_backup.h:231
_restoreOptions
Definition: pg_backup.h:97
TRI_YES
@ TRI_YES
Definition: vacuumlo.c:38
TRI_NO
@ TRI_NO
Definition: vacuumlo.c:37

References archCustom, archDirectory, archTar, CloseArchive(), disable_triggers, exit_nicely(), Archive::exit_on_error, generate_restrict_key(), get_progname(), getopt_long(), if_exists, init_parallel_dump_utils(), Archive::n_errors, NewRestoreOptions(), no_argument, no_comments, no_data, no_policies, no_publications, no_schema, no_security_labels, no_statistics, no_subscriptions, Archive::numWorkers, on_exit_close_archive(), OpenArchive(), optarg, optind, option_parse_int(), opts, pg_fatal, pg_log_error, pg_log_error_hint, pg_log_warning, PG_LOG_WARNING, pg_logging_increase_verbosity(), pg_logging_init(), pg_logging_set_level(), PG_MAX_JOBS, pg_strcasecmp(), pg_strdup(), PG_TEXTDOMAIN, PrintTOCSummary(), ProcessArchiveRestoreOptions(), progname, read_restore_filters(), required_argument, RestoreArchive(), set_dump_section(), set_pglocale_pgservice(), SetArchiveOptions(), simple_string_list_append(), SortTocFromFile(), statistics_only, AmcheckOptions::strict_names, strict_names, TRI_NO, TRI_YES, usage(), use_setsessauth, valid_restrict_key(), AmcheckOptions::verbose, Archive::verbose, and with_statistics.

◆ read_restore_filters()

static void read_restore_filters ( const char *  filename,
RestoreOptions *  opts 
)
static

Definition at line 606 of file pg_restore.c.

607{
608 FilterStateData fstate;
609 char *objname;
610 FilterCommandType comtype;
611 FilterObjectType objtype;
612
613 filter_init(&fstate, filename, exit_nicely);
614
615 while (filter_read_item(&fstate, &objname, &comtype, &objtype))
616 {
617 if (comtype == FILTER_COMMAND_TYPE_INCLUDE)
618 {
619 switch (objtype)
620 {
621 case FILTER_OBJECT_TYPE_NONE:
622 break;
623 case FILTER_OBJECT_TYPE_TABLE_DATA:
624 case FILTER_OBJECT_TYPE_TABLE_DATA_AND_CHILDREN:
625 case FILTER_OBJECT_TYPE_TABLE_AND_CHILDREN:
626 case FILTER_OBJECT_TYPE_DATABASE:
627 case FILTER_OBJECT_TYPE_EXTENSION:
628 case FILTER_OBJECT_TYPE_FOREIGN_DATA:
629 pg_log_filter_error(&fstate, _("%s filter for \"%s\" is not allowed"),
630 "include",
631 filter_object_type_name(objtype));
632 exit_nicely(1);
633
634 case FILTER_OBJECT_TYPE_FUNCTION:
635 opts->selTypes = 1;
636 opts->selFunction = 1;
637 simple_string_list_append(&opts->functionNames, objname);
638 break;
639 case FILTER_OBJECT_TYPE_INDEX:
640 opts->selTypes = 1;
641 opts->selIndex = 1;
642 simple_string_list_append(&opts->indexNames, objname);
643 break;
644 case FILTER_OBJECT_TYPE_SCHEMA:
645 simple_string_list_append(&opts->schemaNames, objname);
646 break;
647 case FILTER_OBJECT_TYPE_TABLE:
648 opts->selTypes = 1;
649 opts->selTable = 1;
650 simple_string_list_append(&opts->tableNames, objname);
651 break;
652 case FILTER_OBJECT_TYPE_TRIGGER:
653 opts->selTypes = 1;
654 opts->selTrigger = 1;
655 simple_string_list_append(&opts->triggerNames, objname);
656 break;
657 }
658 }
659 else if (comtype == FILTER_COMMAND_TYPE_EXCLUDE)
660 {
661 switch (objtype)
662 {
663 case FILTER_OBJECT_TYPE_NONE:
664 break;
665 case FILTER_OBJECT_TYPE_TABLE_DATA:
666 case FILTER_OBJECT_TYPE_TABLE_DATA_AND_CHILDREN:
667 case FILTER_OBJECT_TYPE_DATABASE:
668 case FILTER_OBJECT_TYPE_EXTENSION:
669 case FILTER_OBJECT_TYPE_FOREIGN_DATA:
670 case FILTER_OBJECT_TYPE_FUNCTION:
671 case FILTER_OBJECT_TYPE_INDEX:
672 case FILTER_OBJECT_TYPE_TABLE:
673 case FILTER_OBJECT_TYPE_TABLE_AND_CHILDREN:
674 case FILTER_OBJECT_TYPE_TRIGGER:
675 pg_log_filter_error(&fstate, _("%s filter for \"%s\" is not allowed"),
676 "exclude",
677 filter_object_type_name(objtype));
678 exit_nicely(1);
679
680 case FILTER_OBJECT_TYPE_SCHEMA:
681 simple_string_list_append(&opts->schemaExcludeNames, objname);
682 break;
683 }
684 }
685 else
686 {
687 Assert(comtype == FILTER_COMMAND_TYPE_NONE);
688 Assert(objtype == FILTER_OBJECT_TYPE_NONE);
689 }
690
691 if (objname)
692 free(objname);
693 }
694
695 filter_free(&fstate);
696}
_
#define _(x)
Definition: elog.c:91
filter_init
void filter_init(FilterStateData *fstate, const char *filename, exit_function f_exit)
Definition: filter.c:36
filter_free
void filter_free(FilterStateData *fstate)
Definition: filter.c:60
filter_object_type_name
const char * filter_object_type_name(FilterObjectType fot)
Definition: filter.c:82
filter_read_item
bool filter_read_item(FilterStateData *fstate, char **objname, FilterCommandType *comtype, FilterObjectType *objtype)
Definition: filter.c:392
pg_log_filter_error
void pg_log_filter_error(FilterStateData *fstate, const char *fmt,...)
Definition: filter.c:154
FilterObjectType
FilterObjectType
Definition: filter.h:48
FILTER_OBJECT_TYPE_TABLE_DATA_AND_CHILDREN
@ FILTER_OBJECT_TYPE_TABLE_DATA_AND_CHILDREN
Definition: filter.h:51
FILTER_OBJECT_TYPE_SCHEMA
@ FILTER_OBJECT_TYPE_SCHEMA
Definition: filter.h:57
FILTER_OBJECT_TYPE_INDEX
@ FILTER_OBJECT_TYPE_INDEX
Definition: filter.h:56
FILTER_OBJECT_TYPE_TRIGGER
@ FILTER_OBJECT_TYPE_TRIGGER
Definition: filter.h:60
FILTER_OBJECT_TYPE_FOREIGN_DATA
@ FILTER_OBJECT_TYPE_FOREIGN_DATA
Definition: filter.h:54
FILTER_OBJECT_TYPE_DATABASE
@ FILTER_OBJECT_TYPE_DATABASE
Definition: filter.h:52
FILTER_OBJECT_TYPE_FUNCTION
@ FILTER_OBJECT_TYPE_FUNCTION
Definition: filter.h:55
FILTER_OBJECT_TYPE_TABLE_DATA
@ FILTER_OBJECT_TYPE_TABLE_DATA
Definition: filter.h:50
FILTER_OBJECT_TYPE_NONE
@ FILTER_OBJECT_TYPE_NONE
Definition: filter.h:49
FILTER_OBJECT_TYPE_TABLE_AND_CHILDREN
@ FILTER_OBJECT_TYPE_TABLE_AND_CHILDREN
Definition: filter.h:59
FILTER_OBJECT_TYPE_EXTENSION
@ FILTER_OBJECT_TYPE_EXTENSION
Definition: filter.h:53
FILTER_OBJECT_TYPE_TABLE
@ FILTER_OBJECT_TYPE_TABLE
Definition: filter.h:58
FilterCommandType
FilterCommandType
Definition: filter.h:38
FILTER_COMMAND_TYPE_NONE
@ FILTER_COMMAND_TYPE_NONE
Definition: filter.h:39
FILTER_COMMAND_TYPE_EXCLUDE
@ FILTER_COMMAND_TYPE_EXCLUDE
Definition: filter.h:41
FILTER_COMMAND_TYPE_INCLUDE
@ FILTER_COMMAND_TYPE_INCLUDE
Definition: filter.h:40
Assert
Assert(PointerIsAligned(start, uint64))
free
#define free(a)
Definition: header.h:65
filename
static char * filename
Definition: pg_dumpall.c:120

References _, Assert(), exit_nicely(), filename, FILTER_COMMAND_TYPE_EXCLUDE, FILTER_COMMAND_TYPE_INCLUDE, FILTER_COMMAND_TYPE_NONE, filter_free(), filter_init(), FILTER_OBJECT_TYPE_DATABASE, FILTER_OBJECT_TYPE_EXTENSION, FILTER_OBJECT_TYPE_FOREIGN_DATA, FILTER_OBJECT_TYPE_FUNCTION, FILTER_OBJECT_TYPE_INDEX, filter_object_type_name(), FILTER_OBJECT_TYPE_NONE, FILTER_OBJECT_TYPE_SCHEMA, FILTER_OBJECT_TYPE_TABLE, FILTER_OBJECT_TYPE_TABLE_AND_CHILDREN, FILTER_OBJECT_TYPE_TABLE_DATA, FILTER_OBJECT_TYPE_TABLE_DATA_AND_CHILDREN, FILTER_OBJECT_TYPE_TRIGGER, filter_read_item(), free, opts, pg_log_filter_error(), and simple_string_list_append().

Referenced by main().

◆ usage()

static void usage ( const char *  progname)
static

Definition at line 520 of file pg_restore.c.

521{
522 printf(_("%s restores a PostgreSQL database from an archive created by pg_dump.\n\n"), progname);
523 printf(_("Usage:\n"));
524 printf(_(" %s [OPTION]... [FILE]\n"), progname);
525
526 printf(_("\nGeneral options:\n"));
527 printf(_(" -d, --dbname=NAME connect to database name\n"));
528 printf(_(" -f, --file=FILENAME output file name (- for stdout)\n"));
529 printf(_(" -F, --format=c|d|t backup file format (should be automatic)\n"));
530 printf(_(" -l, --list print summarized TOC of the archive\n"));
531 printf(_(" -v, --verbose verbose mode\n"));
532 printf(_(" -V, --version output version information, then exit\n"));
533 printf(_(" -?, --help show this help, then exit\n"));
534
535 printf(_("\nOptions controlling the restore:\n"));
536 printf(_(" -a, --data-only restore only the data, no schema\n"));
537 printf(_(" -c, --clean clean (drop) database objects before recreating\n"));
538 printf(_(" -C, --create create the target database\n"));
539 printf(_(" -e, --exit-on-error exit on error, default is to continue\n"));
540 printf(_(" -I, --index=NAME restore named index\n"));
541 printf(_(" -j, --jobs=NUM use this many parallel jobs to restore\n"));
542 printf(_(" -L, --use-list=FILENAME use table of contents from this file for\n"
543 " selecting/ordering output\n"));
544 printf(_(" -n, --schema=NAME restore only objects in this schema\n"));
545 printf(_(" -N, --exclude-schema=NAME do not restore objects in this schema\n"));
546 printf(_(" -O, --no-owner skip restoration of object ownership\n"));
547 printf(_(" -P, --function=NAME(args) restore named function\n"));
548 printf(_(" -s, --schema-only restore only the schema, no data\n"));
549 printf(_(" -S, --superuser=NAME superuser user name to use for disabling triggers\n"));
550 printf(_(" -t, --table=NAME restore named relation (table, view, etc.)\n"));
551 printf(_(" -T, --trigger=NAME restore named trigger\n"));
552 printf(_(" -x, --no-privileges skip restoration of access privileges (grant/revoke)\n"));
553 printf(_(" -1, --single-transaction restore as a single transaction\n"));
554 printf(_(" --disable-triggers disable triggers during data-only restore\n"));
555 printf(_(" --enable-row-security enable row security\n"));
556 printf(_(" --filter=FILENAME restore or skip objects based on expressions\n"
557 " in FILENAME\n"));
558 printf(_(" --if-exists use IF EXISTS when dropping objects\n"));
559 printf(_(" --no-comments do not restore comment commands\n"));
560 printf(_(" --no-data do not restore data\n"));
561 printf(_(" --no-data-for-failed-tables do not restore data of tables that could not be\n"
562 " created\n"));
563 printf(_(" --no-policies do not restore row security policies\n"));
564 printf(_(" --no-publications do not restore publications\n"));
565 printf(_(" --no-schema do not restore schema\n"));
566 printf(_(" --no-security-labels do not restore security labels\n"));
567 printf(_(" --no-statistics do not restore statistics\n"));
568 printf(_(" --no-subscriptions do not restore subscriptions\n"));
569 printf(_(" --no-table-access-method do not restore table access methods\n"));
570 printf(_(" --no-tablespaces do not restore tablespace assignments\n"));
571 printf(_(" --restrict-key=RESTRICT_KEY use provided string as psql \\restrict key\n"));
572 printf(_(" --section=SECTION restore named section (pre-data, data, or post-data)\n"));
573 printf(_(" --statistics restore the statistics\n"));
574 printf(_(" --statistics-only restore only the statistics, not schema or data\n"));
575 printf(_(" --strict-names require table and/or schema include patterns to\n"
576 " match at least one entity each\n"));
577 printf(_(" --transaction-size=N commit after every N objects\n"));
578 printf(_(" --use-set-session-authorization\n"
579 " use SET SESSION AUTHORIZATION commands instead of\n"
580 " ALTER OWNER commands to set ownership\n"));
581
582 printf(_("\nConnection options:\n"));
583 printf(_(" -h, --host=HOSTNAME database server host or socket directory\n"));
584 printf(_(" -p, --port=PORT database server port number\n"));
585 printf(_(" -U, --username=NAME connect as specified database user\n"));
586 printf(_(" -w, --no-password never prompt for password\n"));
587 printf(_(" -W, --password force password prompt (should happen automatically)\n"));
588 printf(_(" --role=ROLENAME do SET ROLE before restore\n"));
589
590 printf(_("\n"
591 "The options -I, -n, -N, -P, -t, -T, and --section can be combined and specified\n"
592 "multiple times to select multiple objects.\n"));
593 printf(_("\nIf no input file name is supplied, then standard input is used.\n\n"));
594 printf(_("Report bugs to <%s>.\n"), PACKAGE_BUGREPORT);
595 printf(_("%s home page: <%s>\n"), PACKAGE_NAME, PACKAGE_URL);
596}
printf
#define printf(...)
Definition: port.h:266

References _, printf, and progname.

Referenced by main().