PostgreSQL Source Code  git master
pg_dump.c
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * pg_dump.c
4  * pg_dump is a utility for dumping out a postgres database
5  * into a script file.
6  *
7  * Portions Copyright (c) 1996-2019, PostgreSQL Global Development Group
8  * Portions Copyright (c) 1994, Regents of the University of California
9  *
10  * pg_dump will read the system catalogs in a database and dump out a
11  * script that reproduces the schema in terms of SQL that is understood
12  * by PostgreSQL
13  *
14  * Note that pg_dump runs in a transaction-snapshot mode transaction,
15  * so it sees a consistent snapshot of the database including system
16  * catalogs. However, it relies in part on various specialized backend
17  * functions like pg_get_indexdef(), and those things tend to look at
18  * the currently committed state. So it is possible to get 'cache
19  * lookup failed' error if someone performs DDL changes while a dump is
20  * happening. The window for this sort of thing is from the acquisition
21  * of the transaction snapshot to getSchemaData() (when pg_dump acquires
22  * AccessShareLock on every table it intends to dump). It isn't very large,
23  * but it can happen.
24  *
25  * http://archives.postgresql.org/pgsql-bugs/2010-02/msg00187.php
26  *
27  * IDENTIFICATION
28  * src/bin/pg_dump/pg_dump.c
29  *
30  *-------------------------------------------------------------------------
31  */
32 #include "postgres_fe.h"
33 
34 #include <unistd.h>
35 #include <ctype.h>
36 #include <limits.h>
37 #ifdef HAVE_TERMIOS_H
38 #include <termios.h>
39 #endif
40 
41 #include "getopt_long.h"
42 
43 #include "access/attnum.h"
44 #include "access/sysattr.h"
45 #include "access/transam.h"
46 #include "catalog/pg_aggregate_d.h"
47 #include "catalog/pg_am_d.h"
48 #include "catalog/pg_attribute_d.h"
49 #include "catalog/pg_cast_d.h"
50 #include "catalog/pg_class_d.h"
51 #include "catalog/pg_default_acl_d.h"
52 #include "catalog/pg_largeobject_d.h"
53 #include "catalog/pg_largeobject_metadata_d.h"
54 #include "catalog/pg_proc_d.h"
55 #include "catalog/pg_trigger_d.h"
56 #include "catalog/pg_type_d.h"
57 #include "libpq/libpq-fs.h"
58 #include "storage/block.h"
59 
60 #include "dumputils.h"
61 #include "parallel.h"
62 #include "pg_backup_db.h"
63 #include "pg_backup_utils.h"
64 #include "pg_dump.h"
65 #include "fe_utils/connect.h"
66 #include "fe_utils/string_utils.h"
67 
68 
69 typedef struct
70 {
71  const char *descr; /* comment for an object */
72  Oid classoid; /* object class (catalog OID) */
73  Oid objoid; /* object OID */
74  int objsubid; /* subobject (table column #) */
75 } CommentItem;
76 
77 typedef struct
78 {
79  const char *provider; /* label provider of this security label */
80  const char *label; /* security label for an object */
81  Oid classoid; /* object class (catalog OID) */
82  Oid objoid; /* object OID */
83  int objsubid; /* subobject (table column #) */
84 } SecLabelItem;
85 
86 typedef enum OidOptions
87 {
88  zeroAsOpaque = 1,
89  zeroAsAny = 2,
90  zeroAsStar = 4,
91  zeroAsNone = 8
92 } OidOptions;
93 
94 /* global decls */
95 static bool dosync = true; /* Issue fsync() to make dump durable on disk. */
96 
97 /* subquery used to convert user ID (eg, datdba) to user name */
98 static const char *username_subquery;
99 
100 /*
101  * For 8.0 and earlier servers, pulled from pg_database, for 8.1+ we use
102  * FirstNormalObjectId - 1.
103  */
104 static Oid g_last_builtin_oid; /* value of the last builtin oid */
105 
106 /* The specified names/patterns should to match at least one entity */
107 static int strict_names = 0;
108 
109 /*
110  * Object inclusion/exclusion lists
111  *
112  * The string lists record the patterns given by command-line switches,
113  * which we then convert to lists of OIDs of matching objects.
114  */
115 static SimpleStringList schema_include_patterns = {NULL, NULL};
116 static SimpleOidList schema_include_oids = {NULL, NULL};
117 static SimpleStringList schema_exclude_patterns = {NULL, NULL};
118 static SimpleOidList schema_exclude_oids = {NULL, NULL};
119 
120 static SimpleStringList table_include_patterns = {NULL, NULL};
121 static SimpleOidList table_include_oids = {NULL, NULL};
122 static SimpleStringList table_exclude_patterns = {NULL, NULL};
123 static SimpleOidList table_exclude_oids = {NULL, NULL};
124 static SimpleStringList tabledata_exclude_patterns = {NULL, NULL};
125 static SimpleOidList tabledata_exclude_oids = {NULL, NULL};
126 
127 
128 char g_opaque_type[10]; /* name for the opaque type */
129 
130 /* placeholders for the delimiters for comments */
131 char g_comment_start[10];
132 char g_comment_end[10];
133 
134 static const CatalogId nilCatalogId = {0, 0};
135 
136 /* override for standard extra_float_digits setting */
137 static bool have_extra_float_digits = false;
138 static int extra_float_digits;
139 
140 /*
141  * The default number of rows per INSERT when
142  * --inserts is specified without --rows-per-insert
143  */
144 #define DUMP_DEFAULT_ROWS_PER_INSERT 1
145 
146 /*
147  * Macro for producing quoted, schema-qualified name of a dumpable object.
148  */
149 #define fmtQualifiedDumpable(obj) \
150  fmtQualifiedId((obj)->dobj.namespace->dobj.name, \
151  (obj)->dobj.name)
152 
153 static void help(const char *progname);
154 static void setup_connection(Archive *AH,
155  const char *dumpencoding, const char *dumpsnapshot,
156  char *use_role);
157 static ArchiveFormat parseArchiveFormat(const char *format, ArchiveMode *mode);
158 static void expand_schema_name_patterns(Archive *fout,
159  SimpleStringList *patterns,
160  SimpleOidList *oids,
161  bool strict_names);
162 static void expand_table_name_patterns(Archive *fout,
163  SimpleStringList *patterns,
164  SimpleOidList *oids,
165  bool strict_names);
166 static NamespaceInfo *findNamespace(Archive *fout, Oid nsoid);
167 static void dumpTableData(Archive *fout, TableDataInfo *tdinfo);
168 static void refreshMatViewData(Archive *fout, TableDataInfo *tdinfo);
169 static void guessConstraintInheritance(TableInfo *tblinfo, int numTables);
170 static void dumpComment(Archive *fout, const char *type, const char *name,
171  const char *namespace, const char *owner,
172  CatalogId catalogId, int subid, DumpId dumpId);
173 static int findComments(Archive *fout, Oid classoid, Oid objoid,
174  CommentItem **items);
175 static int collectComments(Archive *fout, CommentItem **items);
176 static void dumpSecLabel(Archive *fout, const char *type, const char *name,
177  const char *namespace, const char *owner,
178  CatalogId catalogId, int subid, DumpId dumpId);
179 static int findSecLabels(Archive *fout, Oid classoid, Oid objoid,
180  SecLabelItem **items);
181 static int collectSecLabels(Archive *fout, SecLabelItem **items);
182 static void dumpDumpableObject(Archive *fout, DumpableObject *dobj);
183 static void dumpNamespace(Archive *fout, NamespaceInfo *nspinfo);
184 static void dumpExtension(Archive *fout, ExtensionInfo *extinfo);
185 static void dumpType(Archive *fout, TypeInfo *tyinfo);
186 static void dumpBaseType(Archive *fout, TypeInfo *tyinfo);
187 static void dumpEnumType(Archive *fout, TypeInfo *tyinfo);
188 static void dumpRangeType(Archive *fout, TypeInfo *tyinfo);
189 static void dumpUndefinedType(Archive *fout, TypeInfo *tyinfo);
190 static void dumpDomain(Archive *fout, TypeInfo *tyinfo);
191 static void dumpCompositeType(Archive *fout, TypeInfo *tyinfo);
192 static void dumpCompositeTypeColComments(Archive *fout, TypeInfo *tyinfo);
193 static void dumpShellType(Archive *fout, ShellTypeInfo *stinfo);
194 static void dumpProcLang(Archive *fout, ProcLangInfo *plang);
195 static void dumpFunc(Archive *fout, FuncInfo *finfo);
196 static void dumpCast(Archive *fout, CastInfo *cast);
197 static void dumpTransform(Archive *fout, TransformInfo *transform);
198 static void dumpOpr(Archive *fout, OprInfo *oprinfo);
199 static void dumpAccessMethod(Archive *fout, AccessMethodInfo *oprinfo);
200 static void dumpOpclass(Archive *fout, OpclassInfo *opcinfo);
201 static void dumpOpfamily(Archive *fout, OpfamilyInfo *opfinfo);
202 static void dumpCollation(Archive *fout, CollInfo *collinfo);
203 static void dumpConversion(Archive *fout, ConvInfo *convinfo);
204 static void dumpRule(Archive *fout, RuleInfo *rinfo);
205 static void dumpAgg(Archive *fout, AggInfo *agginfo);
206 static void dumpTrigger(Archive *fout, TriggerInfo *tginfo);
207 static void dumpEventTrigger(Archive *fout, EventTriggerInfo *evtinfo);
208 static void dumpTable(Archive *fout, TableInfo *tbinfo);
209 static void dumpTableSchema(Archive *fout, TableInfo *tbinfo);
210 static void dumpAttrDef(Archive *fout, AttrDefInfo *adinfo);
211 static void dumpSequence(Archive *fout, TableInfo *tbinfo);
212 static void dumpSequenceData(Archive *fout, TableDataInfo *tdinfo);
213 static void dumpIndex(Archive *fout, IndxInfo *indxinfo);
214 static void dumpIndexAttach(Archive *fout, IndexAttachInfo *attachinfo);
215 static void dumpStatisticsExt(Archive *fout, StatsExtInfo *statsextinfo);
216 static void dumpConstraint(Archive *fout, ConstraintInfo *coninfo);
217 static void dumpTableConstraintComment(Archive *fout, ConstraintInfo *coninfo);
218 static void dumpTSParser(Archive *fout, TSParserInfo *prsinfo);
219 static void dumpTSDictionary(Archive *fout, TSDictInfo *dictinfo);
220 static void dumpTSTemplate(Archive *fout, TSTemplateInfo *tmplinfo);
221 static void dumpTSConfig(Archive *fout, TSConfigInfo *cfginfo);
222 static void dumpForeignDataWrapper(Archive *fout, FdwInfo *fdwinfo);
223 static void dumpForeignServer(Archive *fout, ForeignServerInfo *srvinfo);
224 static void dumpUserMappings(Archive *fout,
225  const char *servername, const char *namespace,
226  const char *owner, CatalogId catalogId, DumpId dumpId);
227 static void dumpDefaultACL(Archive *fout, DefaultACLInfo *daclinfo);
228 
229 static void dumpACL(Archive *fout, CatalogId objCatId, DumpId objDumpId,
230  const char *type, const char *name, const char *subname,
231  const char *nspname, const char *owner,
232  const char *acls, const char *racls,
233  const char *initacls, const char *initracls);
234 
235 static void getDependencies(Archive *fout);
236 static void BuildArchiveDependencies(Archive *fout);
237 static void findDumpableDependencies(ArchiveHandle *AH, DumpableObject *dobj,
238  DumpId **dependencies, int *nDeps, int *allocDeps);
239 
240 static DumpableObject *createBoundaryObjects(void);
241 static void addBoundaryDependencies(DumpableObject **dobjs, int numObjs,
242  DumpableObject *boundaryObjs);
243 
244 static void getDomainConstraints(Archive *fout, TypeInfo *tyinfo);
245 static void getTableData(DumpOptions *dopt, TableInfo *tblinfo, int numTables, char relkind);
246 static void makeTableDataInfo(DumpOptions *dopt, TableInfo *tbinfo);
247 static void buildMatViewRefreshDependencies(Archive *fout);
248 static void getTableDataFKConstraints(void);
249 static char *format_function_arguments(FuncInfo *finfo, char *funcargs,
250  bool is_agg);
251 static char *format_function_arguments_old(Archive *fout,
252  FuncInfo *finfo, int nallargs,
253  char **allargtypes,
254  char **argmodes,
255  char **argnames);
256 static char *format_function_signature(Archive *fout,
257  FuncInfo *finfo, bool honor_quotes);
258 static char *convertRegProcReference(Archive *fout,
259  const char *proc);
260 static char *getFormattedOperatorName(Archive *fout, const char *oproid);
261 static char *convertTSFunction(Archive *fout, Oid funcOid);
262 static Oid findLastBuiltinOid_V71(Archive *fout);
263 static char *getFormattedTypeName(Archive *fout, Oid oid, OidOptions opts);
264 static void getBlobs(Archive *fout);
265 static void dumpBlob(Archive *fout, BlobInfo *binfo);
266 static int dumpBlobs(Archive *fout, void *arg);
267 static void dumpPolicy(Archive *fout, PolicyInfo *polinfo);
268 static void dumpPublication(Archive *fout, PublicationInfo *pubinfo);
269 static void dumpPublicationTable(Archive *fout, PublicationRelInfo *pubrinfo);
270 static void dumpSubscription(Archive *fout, SubscriptionInfo *subinfo);
271 static void dumpDatabase(Archive *AH);
272 static void dumpDatabaseConfig(Archive *AH, PQExpBuffer outbuf,
273  const char *dbname, Oid dboid);
274 static void dumpEncoding(Archive *AH);
275 static void dumpStdStrings(Archive *AH);
276 static void dumpSearchPath(Archive *AH);
277 static void binary_upgrade_set_type_oids_by_type_oid(Archive *fout,
278  PQExpBuffer upgrade_buffer,
279  Oid pg_type_oid,
280  bool force_array_type);
281 static bool binary_upgrade_set_type_oids_by_rel_oid(Archive *fout,
282  PQExpBuffer upgrade_buffer, Oid pg_rel_oid);
283 static void binary_upgrade_set_pg_class_oids(Archive *fout,
284  PQExpBuffer upgrade_buffer,
285  Oid pg_class_oid, bool is_index);
286 static void binary_upgrade_extension_member(PQExpBuffer upgrade_buffer,
287  DumpableObject *dobj,
288  const char *objtype,
289  const char *objname,
290  const char *objnamespace);
291 static const char *getAttrName(int attrnum, TableInfo *tblInfo);
292 static const char *fmtCopyColumnList(const TableInfo *ti, PQExpBuffer buffer);
293 static bool nonemptyReloptions(const char *reloptions);
294 static void appendReloptionsArrayAH(PQExpBuffer buffer, const char *reloptions,
295  const char *prefix, Archive *fout);
296 static char *get_synchronized_snapshot(Archive *fout);
297 static void setupDumpWorker(Archive *AHX);
298 static TableInfo *getRootTableInfo(TableInfo *tbinfo);
299 
300 
301 int
302 main(int argc, char **argv)
303 {
304  int c;
305  const char *filename = NULL;
306  const char *format = "p";
307  TableInfo *tblinfo;
308  int numTables;
309  DumpableObject **dobjs;
310  int numObjs;
311  DumpableObject *boundaryObjs;
312  int i;
313  int optindex;
314  char *endptr;
315  RestoreOptions *ropt;
316  Archive *fout; /* the script file */
317  bool g_verbose = false;
318  const char *dumpencoding = NULL;
319  const char *dumpsnapshot = NULL;
320  char *use_role = NULL;
321  long rowsPerInsert;
322  int numWorkers = 1;
323  trivalue prompt_password = TRI_DEFAULT;
324  int compressLevel = -1;
325  int plainText = 0;
326  ArchiveFormat archiveFormat = archUnknown;
327  ArchiveMode archiveMode;
328 
329  static DumpOptions dopt;
330 
331  static struct option long_options[] = {
332  {"data-only", no_argument, NULL, 'a'},
333  {"blobs", no_argument, NULL, 'b'},
334  {"no-blobs", no_argument, NULL, 'B'},
335  {"clean", no_argument, NULL, 'c'},
336  {"create", no_argument, NULL, 'C'},
337  {"dbname", required_argument, NULL, 'd'},
338  {"file", required_argument, NULL, 'f'},
339  {"format", required_argument, NULL, 'F'},
340  {"host", required_argument, NULL, 'h'},
341  {"jobs", 1, NULL, 'j'},
342  {"no-reconnect", no_argument, NULL, 'R'},
343  {"no-owner", no_argument, NULL, 'O'},
344  {"port", required_argument, NULL, 'p'},
345  {"schema", required_argument, NULL, 'n'},
346  {"exclude-schema", required_argument, NULL, 'N'},
347  {"schema-only", no_argument, NULL, 's'},
348  {"superuser", required_argument, NULL, 'S'},
349  {"table", required_argument, NULL, 't'},
350  {"exclude-table", required_argument, NULL, 'T'},
351  {"no-password", no_argument, NULL, 'w'},
352  {"password", no_argument, NULL, 'W'},
353  {"username", required_argument, NULL, 'U'},
354  {"verbose", no_argument, NULL, 'v'},
355  {"no-privileges", no_argument, NULL, 'x'},
356  {"no-acl", no_argument, NULL, 'x'},
357  {"compress", required_argument, NULL, 'Z'},
358  {"encoding", required_argument, NULL, 'E'},
359  {"help", no_argument, NULL, '?'},
360  {"version", no_argument, NULL, 'V'},
361 
362  /*
363  * the following options don't have an equivalent short option letter
364  */
365  {"attribute-inserts", no_argument, &dopt.column_inserts, 1},
366  {"binary-upgrade", no_argument, &dopt.binary_upgrade, 1},
367  {"column-inserts", no_argument, &dopt.column_inserts, 1},
368  {"disable-dollar-quoting", no_argument, &dopt.disable_dollar_quoting, 1},
369  {"disable-triggers", no_argument, &dopt.disable_triggers, 1},
370  {"enable-row-security", no_argument, &dopt.enable_row_security, 1},
371  {"exclude-table-data", required_argument, NULL, 4},
372  {"extra-float-digits", required_argument, NULL, 8},
373  {"if-exists", no_argument, &dopt.if_exists, 1},
374  {"inserts", no_argument, NULL, 9},
375  {"lock-wait-timeout", required_argument, NULL, 2},
376  {"no-tablespaces", no_argument, &dopt.outputNoTablespaces, 1},
377  {"quote-all-identifiers", no_argument, &quote_all_identifiers, 1},
378  {"load-via-partition-root", no_argument, &dopt.load_via_partition_root, 1},
379  {"role", required_argument, NULL, 3},
380  {"section", required_argument, NULL, 5},
381  {"serializable-deferrable", no_argument, &dopt.serializable_deferrable, 1},
382  {"snapshot", required_argument, NULL, 6},
383  {"strict-names", no_argument, &strict_names, 1},
384  {"use-set-session-authorization", no_argument, &dopt.use_setsessauth, 1},
385  {"no-comments", no_argument, &dopt.no_comments, 1},
386  {"no-publications", no_argument, &dopt.no_publications, 1},
387  {"no-security-labels", no_argument, &dopt.no_security_labels, 1},
388  {"no-synchronized-snapshots", no_argument, &dopt.no_synchronized_snapshots, 1},
389  {"no-unlogged-table-data", no_argument, &dopt.no_unlogged_table_data, 1},
390  {"no-subscriptions", no_argument, &dopt.no_subscriptions, 1},
391  {"no-sync", no_argument, NULL, 7},
392  {"on-conflict-do-nothing", no_argument, &dopt.do_nothing, 1},
393  {"rows-per-insert", required_argument, NULL, 10},
394 
395  {NULL, 0, NULL, 0}
396  };
397 
398  pg_logging_init(argv[0]);
399  pg_logging_set_level(PG_LOG_WARNING);
400  set_pglocale_pgservice(argv[0], PG_TEXTDOMAIN("pg_dump"));
401 
402  /*
403  * Initialize what we need for parallel execution, especially for thread
404  * support on Windows.
405  */
406  init_parallel_dump_utils();
407 
408  strcpy(g_comment_start, "-- ");
409  g_comment_end[0] = '\0';
410  strcpy(g_opaque_type, "opaque");
411 
412  progname = get_progname(argv[0]);
413 
414  if (argc > 1)
415  {
416  if (strcmp(argv[1], "--help") == 0 || strcmp(argv[1], "-?") == 0)
417  {
418  help(progname);
419  exit_nicely(0);
420  }
421  if (strcmp(argv[1], "--version") == 0 || strcmp(argv[1], "-V") == 0)
422  {
423  puts("pg_dump (PostgreSQL) " PG_VERSION);
424  exit_nicely(0);
425  }
426  }
427 
428  InitDumpOptions(&dopt);
429 
430  while ((c = getopt_long(argc, argv, "abBcCd:E:f:F:h:j:n:N:Op:RsS:t:T:U:vwWxZ:",
431  long_options, &optindex)) != -1)
432  {
433  switch (c)
434  {
435  case 'a': /* Dump data only */
436  dopt.dataOnly = true;
437  break;
438 
439  case 'b': /* Dump blobs */
440  dopt.outputBlobs = true;
441  break;
442 
443  case 'B': /* Don't dump blobs */
444  dopt.dontOutputBlobs = true;
445  break;
446 
447  case 'c': /* clean (i.e., drop) schema prior to create */
448  dopt.outputClean = 1;
449  break;
450 
451  case 'C': /* Create DB */
452  dopt.outputCreateDB = 1;
453  break;
454 
455  case 'd': /* database name */
456  dopt.dbname = pg_strdup(optarg);
457  break;
458 
459  case 'E': /* Dump encoding */
460  dumpencoding = pg_strdup(optarg);
461  break;
462 
463  case 'f':
464  filename = pg_strdup(optarg);
465  break;
466 
467  case 'F':
468  format = pg_strdup(optarg);
469  break;
470 
471  case 'h': /* server host */
472  dopt.pghost = pg_strdup(optarg);
473  break;
474 
475  case 'j': /* number of dump jobs */
476  numWorkers = atoi(optarg);
477  break;
478 
479  case 'n': /* include schema(s) */
480  simple_string_list_append(&schema_include_patterns, optarg);
481  dopt.include_everything = false;
482  break;
483 
484  case 'N': /* exclude schema(s) */
485  simple_string_list_append(&schema_exclude_patterns, optarg);
486  break;
487 
488  case 'O': /* Don't reconnect to match owner */
489  dopt.outputNoOwner = 1;
490  break;
491 
492  case 'p': /* server port */
493  dopt.pgport = pg_strdup(optarg);
494  break;
495 
496  case 'R':
497  /* no-op, still accepted for backwards compatibility */
498  break;
499 
500  case 's': /* dump schema only */
501  dopt.schemaOnly = true;
502  break;
503 
504  case 'S': /* Username for superuser in plain text output */
505  dopt.outputSuperuser = pg_strdup(optarg);
506  break;
507 
508  case 't': /* include table(s) */
509  simple_string_list_append(&table_include_patterns, optarg);
510  dopt.include_everything = false;
511  break;
512 
513  case 'T': /* exclude table(s) */
514  simple_string_list_append(&table_exclude_patterns, optarg);
515  break;
516 
517  case 'U':
518  dopt.username = pg_strdup(optarg);
519  break;
520 
521  case 'v': /* verbose */
522  g_verbose = true;
523  pg_logging_set_level(PG_LOG_INFO);
524  break;
525 
526  case 'w':
527  prompt_password = TRI_NO;
528  break;
529 
530  case 'W':
531  prompt_password = TRI_YES;
532  break;
533 
534  case 'x': /* skip ACL dump */
535  dopt.aclsSkip = true;
536  break;
537 
538  case 'Z': /* Compression Level */
539  compressLevel = atoi(optarg);
540  if (compressLevel < 0 || compressLevel > 9)
541  {
542  pg_log_error("compression level must be in range 0..9");
543  exit_nicely(1);
544  }
545  break;
546 
547  case 0:
548  /* This covers the long options. */
549  break;
550 
551  case 2: /* lock-wait-timeout */
552  dopt.lockWaitTimeout = pg_strdup(optarg);
553  break;
554 
555  case 3: /* SET ROLE */
556  use_role = pg_strdup(optarg);
557  break;
558 
559  case 4: /* exclude table(s) data */
560  simple_string_list_append(&tabledata_exclude_patterns, optarg);
561  break;
562 
563  case 5: /* section */
564  set_dump_section(optarg, &dopt.dumpSections);
565  break;
566 
567  case 6: /* snapshot */
568  dumpsnapshot = pg_strdup(optarg);
569  break;
570 
571  case 7: /* no-sync */
572  dosync = false;
573  break;
574 
575  case 8:
576  have_extra_float_digits = true;
577  extra_float_digits = atoi(optarg);
578  if (extra_float_digits < -15 || extra_float_digits > 3)
579  {
580  pg_log_error("extra_float_digits must be in range -15..3");
581  exit_nicely(1);
582  }
583  break;
584 
585  case 9: /* inserts */
586 
587  /*
588  * dump_inserts also stores --rows-per-insert, careful not to
589  * overwrite that.
590  */
591  if (dopt.dump_inserts == 0)
592  dopt.dump_inserts = DUMP_DEFAULT_ROWS_PER_INSERT;
593  break;
594 
595  case 10: /* rows per insert */
596  errno = 0;
597  rowsPerInsert = strtol(optarg, &endptr, 10);
598 
599  if (endptr == optarg || *endptr != '\0' ||
600  rowsPerInsert <= 0 || rowsPerInsert > INT_MAX ||
601  errno == ERANGE)
602  {
603  pg_log_error("rows-per-insert must be in range %d..%d",
604  1, INT_MAX);
605  exit_nicely(1);
606  }
607  dopt.dump_inserts = (int) rowsPerInsert;
608  break;
609 
610  default:
611  fprintf(stderr, _("Try \"%s --help\" for more information.\n"), progname);
612  exit_nicely(1);
613  }
614  }
615 
616  /*
617  * Non-option argument specifies database name as long as it wasn't
618  * already specified with -d / --dbname
619  */
620  if (optind < argc && dopt.dbname == NULL)
621  dopt.dbname = argv[optind++];
622 
623  /* Complain if any arguments remain */
624  if (optind < argc)
625  {
626  pg_log_error("too many command-line arguments (first is \"%s\")",
627  argv[optind]);
628  fprintf(stderr, _("Try \"%s --help\" for more information.\n"),
629  progname);
630  exit_nicely(1);
631  }
632 
633  /* --column-inserts implies --inserts */
634  if (dopt.column_inserts && dopt.dump_inserts == 0)
635  dopt.dump_inserts = DUMP_DEFAULT_ROWS_PER_INSERT;
636 
637  /*
638  * Binary upgrade mode implies dumping sequence data even in schema-only
639  * mode. This is not exposed as a separate option, but kept separate
640  * internally for clarity.
641  */
642  if (dopt.binary_upgrade)
643  dopt.sequence_data = 1;
644 
645  if (dopt.dataOnly && dopt.schemaOnly)
646  {
647  pg_log_error("options -s/--schema-only and -a/--data-only cannot be used together");
648  exit_nicely(1);
649  }
650 
651  if (dopt.dataOnly && dopt.outputClean)
652  {
653  pg_log_error("options -c/--clean and -a/--data-only cannot be used together");
654  exit_nicely(1);
655  }
656 
657  if (dopt.if_exists && !dopt.outputClean)
658  fatal("option --if-exists requires option -c/--clean");
659 
660  /*
661  * --inserts are already implied above if --column-inserts or
662  * --rows-per-insert were specified.
663  */
664  if (dopt.do_nothing && dopt.dump_inserts == 0)
665  fatal("option --on-conflict-do-nothing requires option --inserts, --rows-per-insert, or --column-inserts");
666 
667  /* Identify archive format to emit */
668  archiveFormat = parseArchiveFormat(format, &archiveMode);
669 
670  /* archiveFormat specific setup */
671  if (archiveFormat == archNull)
672  plainText = 1;
673 
674  /* Custom and directory formats are compressed by default, others not */
675  if (compressLevel == -1)
676  {
677 #ifdef HAVE_LIBZ
678  if (archiveFormat == archCustom || archiveFormat == archDirectory)
679  compressLevel = Z_DEFAULT_COMPRESSION;
680  else
681 #endif
682  compressLevel = 0;
683  }
684 
685 #ifndef HAVE_LIBZ
686  if (compressLevel != 0)
687  pg_log_warning("requested compression not available in this installation -- archive will be uncompressed");
688  compressLevel = 0;
689 #endif
690 
691  /*
692  * If emitting an archive format, we always want to emit a DATABASE item,
693  * in case --create is specified at pg_restore time.
694  */
695  if (!plainText)
696  dopt.outputCreateDB = 1;
697 
698  /*
699  * On Windows we can only have at most MAXIMUM_WAIT_OBJECTS (= 64 usually)
700  * parallel jobs because that's the maximum limit for the
701  * WaitForMultipleObjects() call.
702  */
703  if (numWorkers <= 0
704 #ifdef WIN32
705  || numWorkers > MAXIMUM_WAIT_OBJECTS
706 #endif
707  )
708  fatal("invalid number of parallel jobs");
709 
710  /* Parallel backup only in the directory archive format so far */
711  if (archiveFormat != archDirectory && numWorkers > 1)
712  fatal("parallel backup only supported by the directory format");
713 
714  /* Open the output file */
715  fout = CreateArchive(filename, archiveFormat, compressLevel, dosync,
716  archiveMode, setupDumpWorker);
717 
718  /* Make dump options accessible right away */
719  SetArchiveOptions(fout, &dopt, NULL);
720 
721  /* Register the cleanup hook */
722  on_exit_close_archive(fout);
723 
724  /* Let the archiver know how noisy to be */
725  fout->verbose = g_verbose;
726 
727 
728  /*
729  * We allow the server to be back to 8.0, and up to any minor release of
730  * our own major version. (See also version check in pg_dumpall.c.)
731  */
732  fout->minRemoteVersion = 80000;
733  fout->maxRemoteVersion = (PG_VERSION_NUM / 100) * 100 + 99;
734 
735  fout->numWorkers = numWorkers;
736 
737  /*
738  * Open the database using the Archiver, so it knows about it. Errors mean
739  * death.
740  */
741  ConnectDatabase(fout, dopt.dbname, dopt.pghost, dopt.pgport, dopt.username, prompt_password);
742  setup_connection(fout, dumpencoding, dumpsnapshot, use_role);
743 
744  /*
745  * Disable security label support if server version < v9.1.x (prevents
746  * access to nonexistent pg_seclabel catalog)
747  */
748  if (fout->remoteVersion < 90100)
749  dopt.no_security_labels = 1;
750 
751  /*
752  * On hot standbys, never try to dump unlogged table data, since it will
753  * just throw an error.
754  */
755  if (fout->isStandby)
756  dopt.no_unlogged_table_data = true;
757 
758  /* Select the appropriate subquery to convert user IDs to names */
759  if (fout->remoteVersion >= 80100)
760  username_subquery = "SELECT rolname FROM pg_catalog.pg_roles WHERE oid =";
761  else
762  username_subquery = "SELECT usename FROM pg_catalog.pg_user WHERE usesysid =";
763 
764  /* check the version for the synchronized snapshots feature */
765  if (numWorkers > 1 && fout->remoteVersion < 90200
766  && !dopt.no_synchronized_snapshots)
767  fatal("Synchronized snapshots are not supported by this server version.\n"
768  "Run with --no-synchronized-snapshots instead if you do not need\n"
769  "synchronized snapshots.");
770 
771  /* check the version when a snapshot is explicitly specified by user */
772  if (dumpsnapshot && fout->remoteVersion < 90200)
773  fatal("Exported snapshots are not supported by this server version.");
774 
775  /*
776  * Find the last built-in OID, if needed (prior to 8.1)
777  *
778  * With 8.1 and above, we can just use FirstNormalObjectId - 1.
779  */
780  if (fout->remoteVersion < 80100)
781  g_last_builtin_oid = findLastBuiltinOid_V71(fout);
782  else
783  g_last_builtin_oid = FirstNormalObjectId - 1;
784 
785  pg_log_info("last built-in OID is %u", g_last_builtin_oid);
786 
787  /* Expand schema selection patterns into OID lists */
788  if (schema_include_patterns.head != NULL)
789  {
790  expand_schema_name_patterns(fout, &schema_include_patterns,
791  &schema_include_oids,
792  strict_names);
793  if (schema_include_oids.head == NULL)
794  fatal("no matching schemas were found");
795  }
796  expand_schema_name_patterns(fout, &schema_exclude_patterns,
797  &schema_exclude_oids,
798  false);
799  /* non-matching exclusion patterns aren't an error */
800 
801  /* Expand table selection patterns into OID lists */
802  if (table_include_patterns.head != NULL)
803  {
804  expand_table_name_patterns(fout, &table_include_patterns,
805  &table_include_oids,
806  strict_names);
807  if (table_include_oids.head == NULL)
808  fatal("no matching tables were found");
809  }
810  expand_table_name_patterns(fout, &table_exclude_patterns,
811  &table_exclude_oids,
812  false);
813 
814  expand_table_name_patterns(fout, &tabledata_exclude_patterns,
815  &tabledata_exclude_oids,
816  false);
817 
818  /* non-matching exclusion patterns aren't an error */
819 
820  /*
821  * Dumping blobs is the default for dumps where an inclusion switch is not
822  * used (an "include everything" dump). -B can be used to exclude blobs
823  * from those dumps. -b can be used to include blobs even when an
824  * inclusion switch is used.
825  *
826  * -s means "schema only" and blobs are data, not schema, so we never
827  * include blobs when -s is used.
828  */
829  if (dopt.include_everything && !dopt.schemaOnly && !dopt.dontOutputBlobs)
830  dopt.outputBlobs = true;
831 
832  /*
833  * Now scan the database and create DumpableObject structs for all the
834  * objects we intend to dump.
835  */
836  tblinfo = getSchemaData(fout, &numTables);
837 
838  if (fout->remoteVersion < 80400)
839  guessConstraintInheritance(tblinfo, numTables);
840 
841  if (!dopt.schemaOnly)
842  {
843  getTableData(&dopt, tblinfo, numTables, 0);
844  buildMatViewRefreshDependencies(fout);
845  if (dopt.dataOnly)
846  getTableDataFKConstraints();
847  }
848 
849  if (dopt.schemaOnly && dopt.sequence_data)
850  getTableData(&dopt, tblinfo, numTables, RELKIND_SEQUENCE);
851 
852  /*
853  * In binary-upgrade mode, we do not have to worry about the actual blob
854  * data or the associated metadata that resides in the pg_largeobject and
855  * pg_largeobject_metadata tables, respectively.
856  *
857  * However, we do need to collect blob information as there may be
858  * comments or other information on blobs that we do need to dump out.
859  */
860  if (dopt.outputBlobs || dopt.binary_upgrade)
861  getBlobs(fout);
862 
863  /*
864  * Collect dependency data to assist in ordering the objects.
865  */
866  getDependencies(fout);
867 
868  /* Lastly, create dummy objects to represent the section boundaries */
869  boundaryObjs = createBoundaryObjects();
870 
871  /* Get pointers to all the known DumpableObjects */
872  getDumpableObjects(&dobjs, &numObjs);
873 
874  /*
875  * Add dummy dependencies to enforce the dump section ordering.
876  */
877  addBoundaryDependencies(dobjs, numObjs, boundaryObjs);
878 
879  /*
880  * Sort the objects into a safe dump order (no forward references).
881  *
882  * We rely on dependency information to help us determine a safe order, so
883  * the initial sort is mostly for cosmetic purposes: we sort by name to
884  * ensure that logically identical schemas will dump identically.
885  */
886  sortDumpableObjectsByTypeName(dobjs, numObjs);
887 
888  sortDumpableObjects(dobjs, numObjs,
889  boundaryObjs[0].dumpId, boundaryObjs[1].dumpId);
890 
891  /*
892  * Create archive TOC entries for all the objects to be dumped, in a safe
893  * order.
894  */
895 
896  /* First the special ENCODING, STDSTRINGS, and SEARCHPATH entries. */
897  dumpEncoding(fout);
898  dumpStdStrings(fout);
899  dumpSearchPath(fout);
900 
901  /* The database items are always next, unless we don't want them at all */
902  if (dopt.outputCreateDB)
903  dumpDatabase(fout);
904 
905  /* Now the rearrangeable objects. */
906  for (i = 0; i < numObjs; i++)
907  dumpDumpableObject(fout, dobjs[i]);
908 
909  /*
910  * Set up options info to ensure we dump what we want.
911  */
912  ropt = NewRestoreOptions();
913  ropt->filename = filename;
914 
915  /* if you change this list, see dumpOptionsFromRestoreOptions */
916  ropt->dropSchema = dopt.outputClean;
917  ropt->dataOnly = dopt.dataOnly;
918  ropt->schemaOnly = dopt.schemaOnly;
919  ropt->if_exists = dopt.if_exists;
920  ropt->column_inserts = dopt.column_inserts;
921  ropt->dumpSections = dopt.dumpSections;
922  ropt->aclsSkip = dopt.aclsSkip;
923  ropt->superuser = dopt.outputSuperuser;
924  ropt->createDB = dopt.outputCreateDB;
925  ropt->noOwner = dopt.outputNoOwner;
926  ropt->noTablespace = dopt.outputNoTablespaces;
927  ropt->disable_triggers = dopt.disable_triggers;
928  ropt->use_setsessauth = dopt.use_setsessauth;
929  ropt->disable_dollar_quoting = dopt.disable_dollar_quoting;
930  ropt->dump_inserts = dopt.dump_inserts;
931  ropt->no_comments = dopt.no_comments;
932  ropt->no_publications = dopt.no_publications;
933  ropt->no_security_labels = dopt.no_security_labels;
934  ropt->no_subscriptions = dopt.no_subscriptions;
935  ropt->lockWaitTimeout = dopt.lockWaitTimeout;
936  ropt->include_everything = dopt.include_everything;
937  ropt->enable_row_security = dopt.enable_row_security;
938  ropt->sequence_data = dopt.sequence_data;
939  ropt->binary_upgrade = dopt.binary_upgrade;
940 
941  if (compressLevel == -1)
942  ropt->compression = 0;
943  else
944  ropt->compression = compressLevel;
945 
946  ropt->suppressDumpWarnings = true; /* We've already shown them */
947 
948  SetArchiveOptions(fout, &dopt, ropt);
949 
950  /* Mark which entries should be output */
951  ProcessArchiveRestoreOptions(fout);
952 
953  /*
954  * The archive's TOC entries are now marked as to which ones will actually
955  * be output, so we can set up their dependency lists properly. This isn't
956  * necessary for plain-text output, though.
957  */
958  if (!plainText)
959  BuildArchiveDependencies(fout);
960 
961  /*
962  * And finally we can do the actual output.
963  *
964  * Note: for non-plain-text output formats, the output file is written
965  * inside CloseArchive(). This is, um, bizarre; but not worth changing
966  * right now.
967  */
968  if (plainText)
969  RestoreArchive(fout);
970 
971  CloseArchive(fout);
972 
973  exit_nicely(0);
974 }
975 
976 
977 static void
978 help(const char *progname)
979 {
980  printf(_("%s dumps a database as a text file or to other formats.\n\n"), progname);
981  printf(_("Usage:\n"));
982  printf(_(" %s [OPTION]... [DBNAME]\n"), progname);
983 
984  printf(_("\nGeneral options:\n"));
985  printf(_(" -f, --file=FILENAME output file or directory name\n"));
986  printf(_(" -F, --format=c|d|t|p output file format (custom, directory, tar,\n"
987  " plain text (default))\n"));
988  printf(_(" -j, --jobs=NUM use this many parallel jobs to dump\n"));
989  printf(_(" -v, --verbose verbose mode\n"));
990  printf(_(" -V, --version output version information, then exit\n"));
991  printf(_(" -Z, --compress=0-9 compression level for compressed formats\n"));
992  printf(_(" --lock-wait-timeout=TIMEOUT fail after waiting TIMEOUT for a table lock\n"));
993  printf(_(" --no-sync do not wait for changes to be written safely to disk\n"));
994  printf(_(" -?, --help show this help, then exit\n"));
995 
996  printf(_("\nOptions controlling the output content:\n"));
997  printf(_(" -a, --data-only dump only the data, not the schema\n"));
998  printf(_(" -b, --blobs include large objects in dump\n"));
999  printf(_(" -B, --no-blobs exclude large objects in dump\n"));
1000  printf(_(" -c, --clean clean (drop) database objects before recreating\n"));
1001  printf(_(" -C, --create include commands to create database in dump\n"));
1002  printf(_(" -E, --encoding=ENCODING dump the data in encoding ENCODING\n"));
1003  printf(_(" -n, --schema=SCHEMA dump the named schema(s) only\n"));
1004  printf(_(" -N, --exclude-schema=SCHEMA do NOT dump the named schema(s)\n"));
1005  printf(_(" -O, --no-owner skip restoration of object ownership in\n"
1006  " plain-text format\n"));
1007  printf(_(" -s, --schema-only dump only the schema, no data\n"));
1008  printf(_(" -S, --superuser=NAME superuser user name to use in plain-text format\n"));
1009  printf(_(" -t, --table=TABLE dump the named table(s) only\n"));
1010  printf(_(" -T, --exclude-table=TABLE do NOT dump the named table(s)\n"));
1011  printf(_(" -x, --no-privileges do not dump privileges (grant/revoke)\n"));
1012  printf(_(" --binary-upgrade for use by upgrade utilities only\n"));
1013  printf(_(" --column-inserts dump data as INSERT commands with column names\n"));
1014  printf(_(" --disable-dollar-quoting disable dollar quoting, use SQL standard quoting\n"));
1015  printf(_(" --disable-triggers disable triggers during data-only restore\n"));
1016  printf(_(" --enable-row-security enable row security (dump only content user has\n"
1017  " access to)\n"));
1018  printf(_(" --exclude-table-data=TABLE do NOT dump data for the named table(s)\n"));
1019  printf(_(" --extra-float-digits=NUM override default setting for extra_float_digits\n"));
1020  printf(_(" --if-exists use IF EXISTS when dropping objects\n"));
1021  printf(_(" --inserts dump data as INSERT commands, rather than COPY\n"));
1022  printf(_(" --load-via-partition-root load partitions via the root table\n"));
1023  printf(_(" --no-comments do not dump comments\n"));
1024  printf(_(" --no-publications do not dump publications\n"));
1025  printf(_(" --no-security-labels do not dump security label assignments\n"));
1026  printf(_(" --no-subscriptions do not dump subscriptions\n"));
1027  printf(_(" --no-synchronized-snapshots do not use synchronized snapshots in parallel jobs\n"));
1028  printf(_(" --no-tablespaces do not dump tablespace assignments\n"));
1029  printf(_(" --no-unlogged-table-data do not dump unlogged table data\n"));
1030  printf(_(" --on-conflict-do-nothing add ON CONFLICT DO NOTHING to INSERT commands\n"));
1031  printf(_(" --quote-all-identifiers quote all identifiers, even if not key words\n"));
1032  printf(_(" --rows-per-insert=NROWS number of rows per INSERT; implies --inserts\n"));
1033  printf(_(" --section=SECTION dump named section (pre-data, data, or post-data)\n"));
1034  printf(_(" --serializable-deferrable wait until the dump can run without anomalies\n"));
1035  printf(_(" --snapshot=SNAPSHOT use given snapshot for the dump\n"));
1036  printf(_(" --strict-names require table and/or schema include patterns to\n"
1037  " match at least one entity each\n"));
1038  printf(_(" --use-set-session-authorization\n"
1039  " use SET SESSION AUTHORIZATION commands instead of\n"
1040  " ALTER OWNER commands to set ownership\n"));
1041 
1042  printf(_("\nConnection options:\n"));
1043  printf(_(" -d, --dbname=DBNAME database to dump\n"));
1044  printf(_(" -h, --host=HOSTNAME database server host or socket directory\n"));
1045  printf(_(" -p, --port=PORT database server port number\n"));
1046  printf(_(" -U, --username=NAME connect as specified database user\n"));
1047  printf(_(" -w, --no-password never prompt for password\n"));
1048  printf(_(" -W, --password force password prompt (should happen automatically)\n"));
1049  printf(_(" --role=ROLENAME do SET ROLE before dump\n"));
1050 
1051  printf(_("\nIf no database name is supplied, then the PGDATABASE environment\n"
1052  "variable value is used.\n\n"));
1053  printf(_("Report bugs to <pgsql-bugs@lists.postgresql.org>.\n"));
1054 }
1055 
1056 static void
1057 setup_connection(Archive *AH, const char *dumpencoding,
1058  const char *dumpsnapshot, char *use_role)
1059 {
1060  DumpOptions *dopt = AH->dopt;
1061  PGconn *conn = GetConnection(AH);
1062  const char *std_strings;
1063 
1064  PQclear(ExecuteSqlQueryForSingleRow(AH, ALWAYS_SECURE_SEARCH_PATH_SQL));
1065 
1066  /*
1067  * Set the client encoding if requested.
1068  */
1069  if (dumpencoding)
1070  {
1071  if (PQsetClientEncoding(conn, dumpencoding) < 0)
1072  fatal("invalid client encoding \"%s\" specified",
1073  dumpencoding);
1074  }
1075 
1076  /*
1077  * Get the active encoding and the standard_conforming_strings setting, so
1078  * we know how to escape strings.
1079  */
1080  AH->encoding = PQclientEncoding(conn);
1081 
1082  std_strings = PQparameterStatus(conn, "standard_conforming_strings");
1083  AH->std_strings = (std_strings && strcmp(std_strings, "on") == 0);
1084 
1085  /*
1086  * Set the role if requested. In a parallel dump worker, we'll be passed
1087  * use_role == NULL, but AH->use_role is already set (if user specified it
1088  * originally) and we should use that.
1089  */
1090  if (!use_role && AH->use_role)
1091  use_role = AH->use_role;
1092 
1093  /* Set the role if requested */
1094  if (use_role && AH->remoteVersion >= 80100)
1095  {
1096  PQExpBuffer query = createPQExpBuffer();
1097 
1098  appendPQExpBuffer(query, "SET ROLE %s", fmtId(use_role));
1099  ExecuteSqlStatement(AH, query->data);
1100  destroyPQExpBuffer(query);
1101 
1102  /* save it for possible later use by parallel workers */
1103  if (!AH->use_role)
1104  AH->use_role = pg_strdup(use_role);
1105  }
1106 
1107  /* Set the datestyle to ISO to ensure the dump's portability */
1108  ExecuteSqlStatement(AH, "SET DATESTYLE = ISO");
1109 
1110  /* Likewise, avoid using sql_standard intervalstyle */
1111  if (AH->remoteVersion >= 80400)
1112  ExecuteSqlStatement(AH, "SET INTERVALSTYLE = POSTGRES");
1113 
1114  /*
1115  * Use an explicitly specified extra_float_digits if it has been provided.
1116  * Otherwise, set extra_float_digits so that we can dump float data
1117  * exactly (given correctly implemented float I/O code, anyway).
1118  */
1119  if (have_extra_float_digits)
1120  {
1121  PQExpBuffer q = createPQExpBuffer();
1122 
1123  appendPQExpBuffer(q, "SET extra_float_digits TO %d",
1124  extra_float_digits);
1125  ExecuteSqlStatement(AH, q->data);
1126  destroyPQExpBuffer(q);
1127  }
1128  else if (AH->remoteVersion >= 90000)
1129  ExecuteSqlStatement(AH, "SET extra_float_digits TO 3");
1130  else
1131  ExecuteSqlStatement(AH, "SET extra_float_digits TO 2");
1132 
1133  /*
1134  * If synchronized scanning is supported, disable it, to prevent
1135  * unpredictable changes in row ordering across a dump and reload.
1136  */
1137  if (AH->remoteVersion >= 80300)
1138  ExecuteSqlStatement(AH, "SET synchronize_seqscans TO off");
1139 
1140  /*
1141  * Disable timeouts if supported.
1142  */
1143  ExecuteSqlStatement(AH, "SET statement_timeout = 0");
1144  if (AH->remoteVersion >= 90300)
1145  ExecuteSqlStatement(AH, "SET lock_timeout = 0");
1146  if (AH->remoteVersion >= 90600)
1147  ExecuteSqlStatement(AH, "SET idle_in_transaction_session_timeout = 0");
1148 
1149  /*
1150  * Quote all identifiers, if requested.
1151  */
1152  if (quote_all_identifiers && AH->remoteVersion >= 90100)
1153  ExecuteSqlStatement(AH, "SET quote_all_identifiers = true");
1154 
1155  /*
1156  * Adjust row-security mode, if supported.
1157  */
1158  if (AH->remoteVersion >= 90500)
1159  {
1160  if (dopt->enable_row_security)
1161  ExecuteSqlStatement(AH, "SET row_security = on");
1162  else
1163  ExecuteSqlStatement(AH, "SET row_security = off");
1164  }
1165 
1166  /*
1167  * Start transaction-snapshot mode transaction to dump consistent data.
1168  */
1169  ExecuteSqlStatement(AH, "BEGIN");
1170  if (AH->remoteVersion >= 90100)
1171  {
1172  /*
1173  * To support the combination of serializable_deferrable with the jobs
1174  * option we use REPEATABLE READ for the worker connections that are
1175  * passed a snapshot. As long as the snapshot is acquired in a
1176  * SERIALIZABLE, READ ONLY, DEFERRABLE transaction, its use within a
1177  * REPEATABLE READ transaction provides the appropriate integrity
1178  * guarantees. This is a kluge, but safe for back-patching.
1179  */
1180  if (dopt->serializable_deferrable && AH->sync_snapshot_id == NULL)
1181  ExecuteSqlStatement(AH,
1182  "SET TRANSACTION ISOLATION LEVEL "
1183  "SERIALIZABLE, READ ONLY, DEFERRABLE");
1184  else
1185  ExecuteSqlStatement(AH,
1186  "SET TRANSACTION ISOLATION LEVEL "
1187  "REPEATABLE READ, READ ONLY");
1188  }
1189  else
1190  {
1191  ExecuteSqlStatement(AH,
1192  "SET TRANSACTION ISOLATION LEVEL "
1193  "SERIALIZABLE, READ ONLY");
1194  }
1195 
1196  /*
1197  * If user specified a snapshot to use, select that. In a parallel dump
1198  * worker, we'll be passed dumpsnapshot == NULL, but AH->sync_snapshot_id
1199  * is already set (if the server can handle it) and we should use that.
1200  */
1201  if (dumpsnapshot)
1202  AH->sync_snapshot_id = pg_strdup(dumpsnapshot);
1203 
1204  if (AH->sync_snapshot_id)
1205  {
1206  PQExpBuffer query = createPQExpBuffer();
1207 
1208  appendPQExpBufferStr(query, "SET TRANSACTION SNAPSHOT ");
1209  appendStringLiteralConn(query, AH->sync_snapshot_id, conn);
1210  ExecuteSqlStatement(AH, query->data);
1211  destroyPQExpBuffer(query);
1212  }
1213  else if (AH->numWorkers > 1 &&
1214  AH->remoteVersion >= 90200 &&
1215  !dopt->no_synchronized_snapshots)
1216  {
1217  if (AH->isStandby && AH->remoteVersion < 100000)
1218  fatal("Synchronized snapshots on standby servers are not supported by this server version.\n"
1219  "Run with --no-synchronized-snapshots instead if you do not need\n"
1220  "synchronized snapshots.");
1221 
1222 
1223  AH->sync_snapshot_id = get_synchronized_snapshot(AH);
1224  }
1225 }
1226 
1227 /* Set up connection for a parallel worker process */
1228 static void
1229 setupDumpWorker(Archive *AH)
1230 {
1231  /*
1232  * We want to re-select all the same values the master connection is
1233  * using. We'll have inherited directly-usable values in
1234  * AH->sync_snapshot_id and AH->use_role, but we need to translate the
1235  * inherited encoding value back to a string to pass to setup_connection.
1236  */
1237  setup_connection(AH,
1238  pg_encoding_to_char(AH->encoding),
1239  NULL,
1240  NULL);
1241 }
1242 
1243 static char *
1244 get_synchronized_snapshot(Archive *fout)
1245 {
1246  char *query = "SELECT pg_catalog.pg_export_snapshot()";
1247  char *result;
1248  PGresult *res;
1249 
1250  res = ExecuteSqlQueryForSingleRow(fout, query);
1251  result = pg_strdup(PQgetvalue(res, 0, 0));
1252  PQclear(res);
1253 
1254  return result;
1255 }
1256 
1257 static ArchiveFormat
1258 parseArchiveFormat(const char *format, ArchiveMode *mode)
1259 {
1260  ArchiveFormat archiveFormat;
1261 
1262  *mode = archModeWrite;
1263 
1264  if (pg_strcasecmp(format, "a") == 0 || pg_strcasecmp(format, "append") == 0)
1265  {
1266  /* This is used by pg_dumpall, and is not documented */
1267  archiveFormat = archNull;
1268  *mode = archModeAppend;
1269  }
1270  else if (pg_strcasecmp(format, "c") == 0)
1271  archiveFormat = archCustom;
1272  else if (pg_strcasecmp(format, "custom") == 0)
1273  archiveFormat = archCustom;
1274  else if (pg_strcasecmp(format, "d") == 0)
1275  archiveFormat = archDirectory;
1276  else if (pg_strcasecmp(format, "directory") == 0)
1277  archiveFormat = archDirectory;
1278  else if (pg_strcasecmp(format, "p") == 0)
1279  archiveFormat = archNull;
1280  else if (pg_strcasecmp(format, "plain") == 0)
1281  archiveFormat = archNull;
1282  else if (pg_strcasecmp(format, "t") == 0)
1283  archiveFormat = archTar;
1284  else if (pg_strcasecmp(format, "tar") == 0)
1285  archiveFormat = archTar;
1286  else
1287  fatal("invalid output format \"%s\" specified", format);
1288  return archiveFormat;
1289 }
1290 
1291 /*
1292  * Find the OIDs of all schemas matching the given list of patterns,
1293  * and append them to the given OID list.
1294  */
1295 static void
1296 expand_schema_name_patterns(Archive *fout,
1297  SimpleStringList *patterns,
1298  SimpleOidList *oids,
1299  bool strict_names)
1300 {
1301  PQExpBuffer query;
1302  PGresult *res;
1303  SimpleStringListCell *cell;
1304  int i;
1305 
1306  if (patterns->head == NULL)
1307  return; /* nothing to do */
1308 
1309  query = createPQExpBuffer();
1310 
1311  /*
1312  * The loop below runs multiple SELECTs might sometimes result in
1313  * duplicate entries in the OID list, but we don't care.
1314  */
1315 
1316  for (cell = patterns->head; cell; cell = cell->next)
1317  {
1318  appendPQExpBufferStr(query,
1319  "SELECT oid FROM pg_catalog.pg_namespace n\n");
1320  processSQLNamePattern(GetConnection(fout), query, cell->val, false,
1321  false, NULL, "n.nspname", NULL, NULL);
1322 
1323  res = ExecuteSqlQuery(fout, query->data, PGRES_TUPLES_OK);
1324  if (strict_names && PQntuples(res) == 0)
1325  fatal("no matching schemas were found for pattern \"%s\"", cell->val);
1326 
1327  for (i = 0; i < PQntuples(res); i++)
1328  {
1329  simple_oid_list_append(oids, atooid(PQgetvalue(res, i, 0)));
1330  }
1331 
1332  PQclear(res);
1333  resetPQExpBuffer(query);
1334  }
1335 
1336  destroyPQExpBuffer(query);
1337 }
1338 
1339 /*
1340  * Find the OIDs of all tables matching the given list of patterns,
1341  * and append them to the given OID list. See also expand_dbname_patterns()
1342  * in pg_dumpall.c
1343  */
1344 static void
1345 expand_table_name_patterns(Archive *fout,
1346  SimpleStringList *patterns, SimpleOidList *oids,
1347  bool strict_names)
1348 {
1349  PQExpBuffer query;
1350  PGresult *res;
1351  SimpleStringListCell *cell;
1352  int i;
1353 
1354  if (patterns->head == NULL)
1355  return; /* nothing to do */
1356 
1357  query = createPQExpBuffer();
1358 
1359  /*
1360  * this might sometimes result in duplicate entries in the OID list, but
1361  * we don't care.
1362  */
1363 
1364  for (cell = patterns->head; cell; cell = cell->next)
1365  {
1366  /*
1367  * Query must remain ABSOLUTELY devoid of unqualified names. This
1368  * would be unnecessary given a pg_table_is_visible() variant taking a
1369  * search_path argument.
1370  */
1371  appendPQExpBuffer(query,
1372  "SELECT c.oid"
1373  "\nFROM pg_catalog.pg_class c"
1374  "\n LEFT JOIN pg_catalog.pg_namespace n"
1375  "\n ON n.oid OPERATOR(pg_catalog.=) c.relnamespace"
1376  "\nWHERE c.relkind OPERATOR(pg_catalog.=) ANY"
1377  "\n (array['%c', '%c', '%c', '%c', '%c', '%c'])\n",
1378  RELKIND_RELATION, RELKIND_SEQUENCE, RELKIND_VIEW,
1379  RELKIND_MATVIEW, RELKIND_FOREIGN_TABLE,
1380  RELKIND_PARTITIONED_TABLE);
1381  processSQLNamePattern(GetConnection(fout), query, cell->val, true,
1382  false, "n.nspname", "c.relname", NULL,
1383  "pg_catalog.pg_table_is_visible(c.oid)");
1384 
1385  ExecuteSqlStatement(fout, "RESET search_path");
1386  res = ExecuteSqlQuery(fout, query->data, PGRES_TUPLES_OK);
1387  PQclear(ExecuteSqlQueryForSingleRow(fout,
1388  ALWAYS_SECURE_SEARCH_PATH_SQL));
1389  if (strict_names && PQntuples(res) == 0)
1390  fatal("no matching tables were found for pattern \"%s\"", cell->val);
1391 
1392  for (i = 0; i < PQntuples(res); i++)
1393  {
1394  simple_oid_list_append(oids, atooid(PQgetvalue(res, i, 0)));
1395  }
1396 
1397  PQclear(res);
1398  resetPQExpBuffer(query);
1399  }
1400 
1401  destroyPQExpBuffer(query);
1402 }
1403 
1404 /*
1405  * checkExtensionMembership
1406  * Determine whether object is an extension member, and if so,
1407  * record an appropriate dependency and set the object's dump flag.
1408  *
1409  * It's important to call this for each object that could be an extension
1410  * member. Generally, we integrate this with determining the object's
1411  * to-be-dumped-ness, since extension membership overrides other rules for that.
1412  *
1413  * Returns true if object is an extension member, else false.
1414  */
1415 static bool
1416 checkExtensionMembership(DumpableObject *dobj, Archive *fout)
1417 {
1418  ExtensionInfo *ext = findOwningExtension(dobj->catId);
1419 
1420  if (ext == NULL)
1421  return false;
1422 
1423  dobj->ext_member = true;
1424 
1425  /* Record dependency so that getDependencies needn't deal with that */
1426  addObjectDependency(dobj, ext->dobj.dumpId);
1427 
1428  /*
1429  * In 9.6 and above, mark the member object to have any non-initial ACL,
1430  * policies, and security labels dumped.
1431  *
1432  * Note that any initial ACLs (see pg_init_privs) will be removed when we
1433  * extract the information about the object. We don't provide support for
1434  * initial policies and security labels and it seems unlikely for those to
1435  * ever exist, but we may have to revisit this later.
1436  *
1437  * Prior to 9.6, we do not include any extension member components.
1438  *
1439  * In binary upgrades, we still dump all components of the members
1440  * individually, since the idea is to exactly reproduce the database
1441  * contents rather than replace the extension contents with something
1442  * different.
1443  */
1444  if (fout->dopt->binary_upgrade)
1445  dobj->dump = ext->dobj.dump;
1446  else
1447  {
1448  if (fout->remoteVersion < 90600)
1449  dobj->dump = DUMP_COMPONENT_NONE;
1450  else
1451  dobj->dump = ext->dobj.dump_contains & (DUMP_COMPONENT_ACL |
1452  DUMP_COMPONENT_SECLABEL |
1453  DUMP_COMPONENT_POLICY);
1454  }
1455 
1456  return true;
1457 }
1458 
1459 /*
1460  * selectDumpableNamespace: policy-setting subroutine
1461  * Mark a namespace as to be dumped or not
1462  */
1463 static void
1464 selectDumpableNamespace(NamespaceInfo *nsinfo, Archive *fout)
1465 {
1466  /*
1467  * If specific tables are being dumped, do not dump any complete
1468  * namespaces. If specific namespaces are being dumped, dump just those
1469  * namespaces. Otherwise, dump all non-system namespaces.
1470  */
1471  if (table_include_oids.head != NULL)
1472  nsinfo->dobj.dump_contains = nsinfo->dobj.dump = DUMP_COMPONENT_NONE;
1473  else if (schema_include_oids.head != NULL)
1474  nsinfo->dobj.dump_contains = nsinfo->dobj.dump =
1475  simple_oid_list_member(&schema_include_oids,
1476  nsinfo->dobj.catId.oid) ?
1477  DUMP_COMPONENT_ALL : DUMP_COMPONENT_NONE;
1478  else if (fout->remoteVersion >= 90600 &&
1479  strcmp(nsinfo->dobj.name, "pg_catalog") == 0)
1480  {
1481  /*
1482  * In 9.6 and above, we dump out any ACLs defined in pg_catalog, if
1483  * they are interesting (and not the original ACLs which were set at
1484  * initdb time, see pg_init_privs).
1485  */
1486  nsinfo->dobj.dump_contains = nsinfo->dobj.dump = DUMP_COMPONENT_ACL;
1487  }
1488  else if (strncmp(nsinfo->dobj.name, "pg_", 3) == 0 ||
1489  strcmp(nsinfo->dobj.name, "information_schema") == 0)
1490  {
1491  /* Other system schemas don't get dumped */
1492  nsinfo->dobj.dump_contains = nsinfo->dobj.dump = DUMP_COMPONENT_NONE;
1493  }
1494  else if (strcmp(nsinfo->dobj.name, "public") == 0)
1495  {
1496  /*
1497  * The public schema is a strange beast that sits in a sort of
1498  * no-mans-land between being a system object and a user object. We
1499  * don't want to dump creation or comment commands for it, because
1500  * that complicates matters for non-superuser use of pg_dump. But we
1501  * should dump any ACL changes that have occurred for it, and of
1502  * course we should dump contained objects.
1503  */
1504  nsinfo->dobj.dump = DUMP_COMPONENT_ACL;
1505  nsinfo->dobj.dump_contains = DUMP_COMPONENT_ALL;
1506  }
1507  else
1508  nsinfo->dobj.dump_contains = nsinfo->dobj.dump = DUMP_COMPONENT_ALL;
1509 
1510  /*
1511  * In any case, a namespace can be excluded by an exclusion switch
1512  */
1513  if (nsinfo->dobj.dump_contains &&
1514  simple_oid_list_member(&schema_exclude_oids,
1515  nsinfo->dobj.catId.oid))
1516  nsinfo->dobj.dump_contains = nsinfo->dobj.dump = DUMP_COMPONENT_NONE;
1517 
1518  /*
1519  * If the schema belongs to an extension, allow extension membership to
1520  * override the dump decision for the schema itself. However, this does
1521  * not change dump_contains, so this won't change what we do with objects
1522  * within the schema. (If they belong to the extension, they'll get
1523  * suppressed by it, otherwise not.)
1524  */
1525  (void) checkExtensionMembership(&nsinfo->dobj, fout);
1526 }
1527 
1528 /*
1529  * selectDumpableTable: policy-setting subroutine
1530  * Mark a table as to be dumped or not
1531  */
1532 static void
1533 selectDumpableTable(TableInfo *tbinfo, Archive *fout)
1534 {
1535  if (checkExtensionMembership(&tbinfo->dobj, fout))
1536  return; /* extension membership overrides all else */
1537 
1538  /*
1539  * If specific tables are being dumped, dump just those tables; else, dump
1540  * according to the parent namespace's dump flag.
1541  */
1542  if (table_include_oids.head != NULL)
1543  tbinfo->dobj.dump = simple_oid_list_member(&table_include_oids,
1544  tbinfo->dobj.catId.oid) ?
1545  DUMP_COMPONENT_ALL : DUMP_COMPONENT_NONE;
1546  else
1547  tbinfo->dobj.dump = tbinfo->dobj.namespace->dobj.dump_contains;
1548 
1549  /*
1550  * In any case, a table can be excluded by an exclusion switch
1551  */
1552  if (tbinfo->dobj.dump &&
1553  simple_oid_list_member(&table_exclude_oids,
1554  tbinfo->dobj.catId.oid))
1555  tbinfo->dobj.dump = DUMP_COMPONENT_NONE;
1556 }
1557 
1558 /*
1559  * selectDumpableType: policy-setting subroutine
1560  * Mark a type as to be dumped or not
1561  *
1562  * If it's a table's rowtype or an autogenerated array type, we also apply a
1563  * special type code to facilitate sorting into the desired order. (We don't
1564  * want to consider those to be ordinary types because that would bring tables
1565  * up into the datatype part of the dump order.) We still set the object's
1566  * dump flag; that's not going to cause the dummy type to be dumped, but we
1567  * need it so that casts involving such types will be dumped correctly -- see
1568  * dumpCast. This means the flag should be set the same as for the underlying
1569  * object (the table or base type).
1570  */
1571 static void
1572 selectDumpableType(TypeInfo *tyinfo, Archive *fout)
1573 {
1574  /* skip complex types, except for standalone composite types */
1575  if (OidIsValid(tyinfo->typrelid) &&
1576  tyinfo->typrelkind != RELKIND_COMPOSITE_TYPE)
1577  {
1578  TableInfo *tytable = findTableByOid(tyinfo->typrelid);
1579 
1580  tyinfo->dobj.objType = DO_DUMMY_TYPE;
1581  if (tytable != NULL)
1582  tyinfo->dobj.dump = tytable->dobj.dump;
1583  else
1584  tyinfo->dobj.dump = DUMP_COMPONENT_NONE;
1585  return;
1586  }
1587 
1588  /* skip auto-generated array types */
1589  if (tyinfo->isArray)
1590  {
1591  tyinfo->dobj.objType = DO_DUMMY_TYPE;
1592 
1593  /*
1594  * Fall through to set the dump flag; we assume that the subsequent
1595  * rules will do the same thing as they would for the array's base
1596  * type. (We cannot reliably look up the base type here, since
1597  * getTypes may not have processed it yet.)
1598  */
1599  }
1600 
1601  if (checkExtensionMembership(&tyinfo->dobj, fout))
1602  return; /* extension membership overrides all else */
1603 
1604  /* Dump based on if the contents of the namespace are being dumped */
1605  tyinfo->dobj.dump = tyinfo->dobj.namespace->dobj.dump_contains;
1606 }
1607 
1608 /*
1609  * selectDumpableDefaultACL: policy-setting subroutine
1610  * Mark a default ACL as to be dumped or not
1611  *
1612  * For per-schema default ACLs, dump if the schema is to be dumped.
1613  * Otherwise dump if we are dumping "everything". Note that dataOnly
1614  * and aclsSkip are checked separately.
1615  */
1616 static void
1617 selectDumpableDefaultACL(DefaultACLInfo *dinfo, DumpOptions *dopt)
1618 {
1619  /* Default ACLs can't be extension members */
1620 
1621  if (dinfo->dobj.namespace)
1622  /* default ACLs are considered part of the namespace */
1623  dinfo->dobj.dump = dinfo->dobj.namespace->dobj.dump_contains;
1624  else
1625  dinfo->dobj.dump = dopt->include_everything ?
1626  DUMP_COMPONENT_ALL : DUMP_COMPONENT_NONE;
1627 }
1628 
1629 /*
1630  * selectDumpableCast: policy-setting subroutine
1631  * Mark a cast as to be dumped or not
1632  *
1633  * Casts do not belong to any particular namespace (since they haven't got
1634  * names), nor do they have identifiable owners. To distinguish user-defined
1635  * casts from built-in ones, we must resort to checking whether the cast's
1636  * OID is in the range reserved for initdb.
1637  */
1638 static void
1639 selectDumpableCast(CastInfo *cast, Archive *fout)
1640 {
1641  if (checkExtensionMembership(&cast->dobj, fout))
1642  return; /* extension membership overrides all else */
1643 
1644  /*
1645  * This would be DUMP_COMPONENT_ACL for from-initdb casts, but they do not
1646  * support ACLs currently.
1647  */
1648  if (cast->dobj.catId.oid <= (Oid) g_last_builtin_oid)
1649  cast->dobj.dump = DUMP_COMPONENT_NONE;
1650  else
1651  cast->dobj.dump = fout->dopt->include_everything ?
1652  DUMP_COMPONENT_ALL : DUMP_COMPONENT_NONE;
1653 }
1654 
1655 /*
1656  * selectDumpableProcLang: policy-setting subroutine
1657  * Mark a procedural language as to be dumped or not
1658  *
1659  * Procedural languages do not belong to any particular namespace. To
1660  * identify built-in languages, we must resort to checking whether the
1661  * language's OID is in the range reserved for initdb.
1662  */
1663 static void
1664 selectDumpableProcLang(ProcLangInfo *plang, Archive *fout)
1665 {
1666  if (checkExtensionMembership(&plang->dobj, fout))
1667  return; /* extension membership overrides all else */
1668 
1669  /*
1670  * Only include procedural languages when we are dumping everything.
1671  *
1672  * For from-initdb procedural languages, only include ACLs, as we do for
1673  * the pg_catalog namespace. We need this because procedural languages do
1674  * not live in any namespace.
1675  */
1676  if (!fout->dopt->include_everything)
1677  plang->dobj.dump = DUMP_COMPONENT_NONE;
1678  else
1679  {
1680  if (plang->dobj.catId.oid <= (Oid) g_last_builtin_oid)
1681  plang->dobj.dump = fout->remoteVersion < 90600 ?
1682  DUMP_COMPONENT_NONE : DUMP_COMPONENT_ACL;
1683  else
1684  plang->dobj.dump = DUMP_COMPONENT_ALL;
1685  }
1686 }
1687 
1688 /*
1689  * selectDumpableAccessMethod: policy-setting subroutine
1690  * Mark an access method as to be dumped or not
1691  *
1692  * Access methods do not belong to any particular namespace. To identify
1693  * built-in access methods, we must resort to checking whether the
1694  * method's OID is in the range reserved for initdb.
1695  */
1696 static void
1697 selectDumpableAccessMethod(AccessMethodInfo *method, Archive *fout)
1698 {
1699  if (checkExtensionMembership(&method->dobj, fout))
1700  return; /* extension membership overrides all else */
1701 
1702  /*
1703  * This would be DUMP_COMPONENT_ACL for from-initdb access methods, but
1704  * they do not support ACLs currently.
1705  */
1706  if (method->dobj.catId.oid <= (Oid) g_last_builtin_oid)
1707  method->dobj.dump = DUMP_COMPONENT_NONE;
1708  else
1709  method->dobj.dump = fout->dopt->include_everything ?
1710  DUMP_COMPONENT_ALL : DUMP_COMPONENT_NONE;
1711 }
1712 
1713 /*
1714  * selectDumpableExtension: policy-setting subroutine
1715  * Mark an extension as to be dumped or not
1716  *
1717  * Built-in extensions should be skipped except for checking ACLs, since we
1718  * assume those will already be installed in the target database. We identify
1719  * such extensions by their having OIDs in the range reserved for initdb.
1720  * We dump all user-added extensions by default, or none of them if
1721  * include_everything is false (i.e., a --schema or --table switch was given).
1722  */
1723 static void
1724 selectDumpableExtension(ExtensionInfo *extinfo, DumpOptions *dopt)
1725 {
1726  /*
1727  * Use DUMP_COMPONENT_ACL for built-in extensions, to allow users to
1728  * change permissions on their member objects, if they wish to, and have
1729  * those changes preserved.
1730  */
1731  if (extinfo->dobj.catId.oid <= (Oid) g_last_builtin_oid)
1732  extinfo->dobj.dump = extinfo->dobj.dump_contains = DUMP_COMPONENT_ACL;
1733  else
1734  extinfo->dobj.dump = extinfo->dobj.dump_contains =
1735  dopt->include_everything ? DUMP_COMPONENT_ALL :
1736  DUMP_COMPONENT_NONE;
1737 }
1738 
1739 /*
1740  * selectDumpablePublicationTable: policy-setting subroutine
1741  * Mark a publication table as to be dumped or not
1742  *
1743  * Publication tables have schemas, but those are ignored in decision making,
1744  * because publications are only dumped when we are dumping everything.
1745  */
1746 static void
1747 selectDumpablePublicationTable(DumpableObject *dobj, Archive *fout)
1748 {
1749  if (checkExtensionMembership(dobj, fout))
1750  return; /* extension membership overrides all else */
1751 
1752  dobj->dump = fout->dopt->include_everything ?
1753  DUMP_COMPONENT_ALL : DUMP_COMPONENT_NONE;
1754 }
1755 
1756 /*
1757  * selectDumpableObject: policy-setting subroutine
1758  * Mark a generic dumpable object as to be dumped or not
1759  *
1760  * Use this only for object types without a special-case routine above.
1761  */
1762 static void
1763 selectDumpableObject(DumpableObject *dobj, Archive *fout)
1764 {
1765  if (checkExtensionMembership(dobj, fout))
1766  return; /* extension membership overrides all else */
1767 
1768  /*
1769  * Default policy is to dump if parent namespace is dumpable, or for
1770  * non-namespace-associated items, dump if we're dumping "everything".
1771  */
1772  if (dobj->namespace)
1773  dobj->dump = dobj->namespace->dobj.dump_contains;
1774  else
1775  dobj->dump = fout->dopt->include_everything ?
1776  DUMP_COMPONENT_ALL : DUMP_COMPONENT_NONE;
1777 }
1778 
1779 /*
1780  * Dump a table's contents for loading using the COPY command
1781  * - this routine is called by the Archiver when it wants the table
1782  * to be dumped.
1783  */
1784 
1785 static int
1786 dumpTableData_copy(Archive *fout, void *dcontext)
1787 {
1788  TableDataInfo *tdinfo = (TableDataInfo *) dcontext;
1789  TableInfo *tbinfo = tdinfo->tdtable;
1790  const char *classname = tbinfo->dobj.name;
1791  PQExpBuffer q = createPQExpBuffer();
1792 
1793  /*
1794  * Note: can't use getThreadLocalPQExpBuffer() here, we're calling fmtId
1795  * which uses it already.
1796  */
1797  PQExpBuffer clistBuf = createPQExpBuffer();
1798  PGconn *conn = GetConnection(fout);
1799  PGresult *res;
1800  int ret;
1801  char *copybuf;
1802  const char *column_list;
1803 
1804  pg_log_info("dumping contents of table \"%s.%s\"",
1805  tbinfo->dobj.namespace->dobj.name, classname);
1806 
1807  /*
1808  * Specify the column list explicitly so that we have no possibility of
1809  * retrieving data in the wrong column order. (The default column
1810  * ordering of COPY will not be what we want in certain corner cases
1811  * involving ADD COLUMN and inheritance.)
1812  */
1813  column_list = fmtCopyColumnList(tbinfo, clistBuf);
1814 
1815  if (tdinfo->filtercond)
1816  {
1817  /* Note: this syntax is only supported in 8.2 and up */
1818  appendPQExpBufferStr(q, "COPY (SELECT ");
1819  /* klugery to get rid of parens in column list */
1820  if (strlen(column_list) > 2)
1821  {
1822  appendPQExpBufferStr(q, column_list + 1);
1823  q->data[q->len - 1] = ' ';
1824  }
1825  else
1826  appendPQExpBufferStr(q, "* ");
1827  appendPQExpBuffer(q, "FROM %s %s) TO stdout;",
1828  fmtQualifiedDumpable(tbinfo),
1829  tdinfo->filtercond);
1830  }
1831  else
1832  {
1833  appendPQExpBuffer(q, "COPY %s %s TO stdout;",
1834  fmtQualifiedDumpable(tbinfo),
1835  column_list);
1836  }
1837  res = ExecuteSqlQuery(fout, q->data, PGRES_COPY_OUT);
1838  PQclear(res);
1839  destroyPQExpBuffer(clistBuf);
1840 
1841  for (;;)
1842  {
1843  ret = PQgetCopyData(conn, &copybuf, 0);
1844 
1845  if (ret < 0)
1846  break; /* done or error */
1847 
1848  if (copybuf)
1849  {
1850  WriteData(fout, copybuf, ret);
1851  PQfreemem(copybuf);
1852  }
1853 
1854  /* ----------
1855  * THROTTLE:
1856  *
1857  * There was considerable discussion in late July, 2000 regarding
1858  * slowing down pg_dump when backing up large tables. Users with both
1859  * slow & fast (multi-processor) machines experienced performance
1860  * degradation when doing a backup.
1861  *
1862  * Initial attempts based on sleeping for a number of ms for each ms
1863  * of work were deemed too complex, then a simple 'sleep in each loop'
1864  * implementation was suggested. The latter failed because the loop
1865  * was too tight. Finally, the following was implemented:
1866  *
1867  * If throttle is non-zero, then
1868  * See how long since the last sleep.
1869  * Work out how long to sleep (based on ratio).
1870  * If sleep is more than 100ms, then
1871  * sleep
1872  * reset timer
1873  * EndIf
1874  * EndIf
1875  *
1876  * where the throttle value was the number of ms to sleep per ms of
1877  * work. The calculation was done in each loop.
1878  *
1879  * Most of the hard work is done in the backend, and this solution
1880  * still did not work particularly well: on slow machines, the ratio
1881  * was 50:1, and on medium paced machines, 1:1, and on fast
1882  * multi-processor machines, it had little or no effect, for reasons
1883  * that were unclear.
1884  *
1885  * Further discussion ensued, and the proposal was dropped.
1886  *
1887  * For those people who want this feature, it can be implemented using
1888  * gettimeofday in each loop, calculating the time since last sleep,
1889  * multiplying that by the sleep ratio, then if the result is more
1890  * than a preset 'minimum sleep time' (say 100ms), call the 'select'
1891  * function to sleep for a subsecond period ie.
1892  *
1893  * select(0, NULL, NULL, NULL, &tvi);
1894  *
1895  * This will return after the interval specified in the structure tvi.
1896  * Finally, call gettimeofday again to save the 'last sleep time'.
1897  * ----------
1898  */
1899  }
1900  archprintf(fout, "\\.\n\n\n");
1901 
1902  if (ret == -2)
1903  {
1904  /* copy data transfer failed */
1905  pg_log_error("Dumping the contents of table \"%s\" failed: PQgetCopyData() failed.", classname);
1906  pg_log_error("Error message from server: %s", PQerrorMessage(conn));
1907  pg_log_error("The command was: %s", q->data);
1908  exit_nicely(1);
1909  }
1910 
1911  /* Check command status and return to normal libpq state */
1912  res = PQgetResult(conn);
1913  if (PQresultStatus(res) != PGRES_COMMAND_OK)
1914  {
1915  pg_log_error("Dumping the contents of table \"%s\" failed: PQgetResult() failed.", classname);
1916  pg_log_error("Error message from server: %s", PQerrorMessage(conn));
1917  pg_log_error("The command was: %s", q->data);
1918  exit_nicely(1);
1919  }
1920  PQclear(res);
1921 
1922  /* Do this to ensure we've pumped libpq back to idle state */
1923  if (PQgetResult(conn) != NULL)
1924  pg_log_warning("unexpected extra results during COPY of table \"%s\"",
1925  classname);
1926 
1927  destroyPQExpBuffer(q);
1928  return 1;
1929 }
1930 
1931 /*
1932  * Dump table data using INSERT commands.
1933  *
1934  * Caution: when we restore from an archive file direct to database, the
1935  * INSERT commands emitted by this function have to be parsed by
1936  * pg_backup_db.c's ExecuteSimpleCommands(), which will not handle comments,
1937  * E'' strings, or dollar-quoted strings. So don't emit anything like that.
1938  */
1939 static int
1940 dumpTableData_insert(Archive *fout, void *dcontext)
1941 {
1942  TableDataInfo *tdinfo = (TableDataInfo *) dcontext;
1943  TableInfo *tbinfo = tdinfo->tdtable;
1944  DumpOptions *dopt = fout->dopt;
1945  PQExpBuffer q = createPQExpBuffer();
1946  PQExpBuffer insertStmt = NULL;
1947  PGresult *res;
1948  int nfields;
1949  int rows_per_statement = dopt->dump_inserts;
1950  int rows_this_statement = 0;
1951 
1952  appendPQExpBuffer(q, "DECLARE _pg_dump_cursor CURSOR FOR "
1953  "SELECT * FROM ONLY %s",
1954  fmtQualifiedDumpable(tbinfo));
1955  if (tdinfo->filtercond)
1956  appendPQExpBuffer(q, " %s", tdinfo->filtercond);
1957 
1958  ExecuteSqlStatement(fout, q->data);
1959 
1960  while (1)
1961  {
1962  res = ExecuteSqlQuery(fout, "FETCH 100 FROM _pg_dump_cursor",
1963  PGRES_TUPLES_OK);
1964  nfields = PQnfields(res);
1965 
1966  /*
1967  * First time through, we build as much of the INSERT statement as
1968  * possible in "insertStmt", which we can then just print for each
1969  * statement. If the table happens to have zero columns then this will
1970  * be a complete statement, otherwise it will end in "VALUES" and be
1971  * ready to have the row's column values printed.
1972  */
1973  if (insertStmt == NULL)
1974  {
1975  TableInfo *targettab;
1976 
1977  insertStmt = createPQExpBuffer();
1978 
1979  /*
1980  * When load-via-partition-root is set, get the root table name
1981  * for the partition table, so that we can reload data through the
1982  * root table.
1983  */
1984  if (dopt->load_via_partition_root && tbinfo->ispartition)
1985  targettab = getRootTableInfo(tbinfo);
1986  else
1987  targettab = tbinfo;
1988 
1989  appendPQExpBuffer(insertStmt, "INSERT INTO %s ",
1990  fmtQualifiedDumpable(targettab));
1991 
1992  /* corner case for zero-column table */
1993  if (nfields == 0)
1994  {
1995  appendPQExpBufferStr(insertStmt, "DEFAULT VALUES;\n");
1996  }
1997  else
1998  {
1999  /* append the list of column names if required */
2000  if (dopt->column_inserts)
2001  {
2002  appendPQExpBufferChar(insertStmt, '(');
2003  for (int field = 0; field < nfields; field++)
2004  {
2005  if (field > 0)
2006  appendPQExpBufferStr(insertStmt, ", ");
2007  appendPQExpBufferStr(insertStmt,
2008  fmtId(PQfname(res, field)));
2009  }
2010  appendPQExpBufferStr(insertStmt, ") ");
2011  }
2012 
2013  if (tbinfo->needs_override)
2014  appendPQExpBufferStr(insertStmt, "OVERRIDING SYSTEM VALUE ");
2015 
2016  appendPQExpBufferStr(insertStmt, "VALUES");
2017  }
2018  }
2019 
2020  for (int tuple = 0; tuple < PQntuples(res); tuple++)
2021  {
2022  /* Write the INSERT if not in the middle of a multi-row INSERT. */
2023  if (rows_this_statement == 0)
2024  archputs(insertStmt->data, fout);
2025 
2026  /*
2027  * If it is zero-column table then we've already written the
2028  * complete statement, which will mean we've disobeyed
2029  * --rows-per-insert when it's set greater than 1. We do support
2030  * a way to make this multi-row with: SELECT UNION ALL SELECT
2031  * UNION ALL ... but that's non-standard so we should avoid it
2032  * given that using INSERTs is mostly only ever needed for
2033  * cross-database exports.
2034  */
2035  if (nfields == 0)
2036  continue;
2037 
2038  /* Emit a row heading */
2039  if (rows_per_statement == 1)
2040  archputs(" (", fout);
2041  else if (rows_this_statement > 0)
2042  archputs(",\n\t(", fout);
2043  else
2044  archputs("\n\t(", fout);
2045 
2046  for (int field = 0; field < nfields; field++)
2047  {
2048  if (field > 0)
2049  archputs(", ", fout);
2050  if (tbinfo->attgenerated[field])
2051  {
2052  archputs("DEFAULT", fout);
2053  continue;
2054  }
2055  if (PQgetisnull(res, tuple, field))
2056  {
2057  archputs("NULL", fout);
2058  continue;
2059  }
2060 
2061  /* XXX This code is partially duplicated in ruleutils.c */
2062  switch (PQftype(res, field))
2063  {
2064  case INT2OID:
2065  case INT4OID:
2066  case INT8OID:
2067  case OIDOID:
2068  case FLOAT4OID:
2069  case FLOAT8OID:
2070  case NUMERICOID:
2071  {
2072  /*
2073  * These types are printed without quotes unless
2074  * they contain values that aren't accepted by the
2075  * scanner unquoted (e.g., 'NaN'). Note that
2076  * strtod() and friends might accept NaN, so we
2077  * can't use that to test.
2078  *
2079  * In reality we only need to defend against
2080  * infinity and NaN, so we need not get too crazy
2081  * about pattern matching here.
2082  */
2083  const char *s = PQgetvalue(res, tuple, field);
2084 
2085  if (strspn(s, "0123456789 +-eE.") == strlen(s))
2086  archputs(s, fout);
2087  else
2088  archprintf(fout, "'%s'", s);
2089  }
2090  break;
2091 
2092  case BITOID:
2093  case VARBITOID:
2094  archprintf(fout, "B'%s'",
2095  PQgetvalue(res, tuple, field));
2096  break;
2097 
2098  case BOOLOID:
2099  if (strcmp(PQgetvalue(res, tuple, field), "t") == 0)
2100  archputs("true", fout);
2101  else
2102  archputs("false", fout);
2103  break;
2104 
2105  default:
2106  /* All other types are printed as string literals. */
2107  resetPQExpBuffer(q);
2108  appendStringLiteralAH(q,
2109  PQgetvalue(res, tuple, field),
2110  fout);
2111  archputs(q->data, fout);
2112  break;
2113  }
2114  }
2115 
2116  /* Terminate the row ... */
2117  archputs(")", fout);
2118 
2119  /* ... and the statement, if the target no. of rows is reached */
2120  if (++rows_this_statement >= rows_per_statement)
2121  {
2122  if (dopt->do_nothing)
2123  archputs(" ON CONFLICT DO NOTHING;\n", fout);
2124  else
2125  archputs(";\n", fout);
2126  /* Reset the row counter */
2127  rows_this_statement = 0;
2128  }
2129  }
2130 
2131  if (PQntuples(res) <= 0)
2132  {
2133  PQclear(res);
2134  break;
2135  }
2136  PQclear(res);
2137  }
2138 
2139  /* Terminate any statements that didn't make the row count. */
2140  if (rows_this_statement > 0)
2141  {
2142  if (dopt->do_nothing)
2143  archputs(" ON CONFLICT DO NOTHING;\n", fout);
2144  else
2145  archputs(";\n", fout);
2146  }
2147 
2148  archputs("\n\n", fout);
2149 
2150  ExecuteSqlStatement(fout, "CLOSE _pg_dump_cursor");
2151 
2152  destroyPQExpBuffer(q);
2153  if (insertStmt != NULL)
2154  destroyPQExpBuffer(insertStmt);
2155 
2156  return 1;
2157 }
2158 
2159 /*
2160  * getRootTableInfo:
2161  * get the root TableInfo for the given partition table.
2162  */
2163 static TableInfo *
2164 getRootTableInfo(TableInfo *tbinfo)
2165 {
2166  TableInfo *parentTbinfo;
2167 
2168  Assert(tbinfo->ispartition);
2169  Assert(tbinfo->numParents == 1);
2170 
2171  parentTbinfo = tbinfo->parents[0];
2172  while (parentTbinfo->ispartition)
2173  {
2174  Assert(parentTbinfo->numParents == 1);
2175  parentTbinfo = parentTbinfo->parents[0];
2176  }
2177 
2178  return parentTbinfo;
2179 }
2180 
2181 /*
2182  * dumpTableData -
2183  * dump the contents of a single table
2184  *
2185  * Actually, this just makes an ArchiveEntry for the table contents.
2186  */
2187 static void
2188 dumpTableData(Archive *fout, TableDataInfo *tdinfo)
2189 {
2190  DumpOptions *dopt = fout->dopt;
2191  TableInfo *tbinfo = tdinfo->tdtable;
2192  PQExpBuffer copyBuf = createPQExpBuffer();
2193  PQExpBuffer clistBuf = createPQExpBuffer();
2194  DataDumperPtr dumpFn;
2195  char *copyStmt;
2196  const char *copyFrom;
2197 
2198  if (!dopt->dump_inserts)
2199  {
2200  /* Dump/restore using COPY */
2201  dumpFn = dumpTableData_copy;
2202 
2203  /*
2204  * When load-via-partition-root is set, get the root table name for
2205  * the partition table, so that we can reload data through the root
2206  * table.
2207  */
2208  if (dopt->load_via_partition_root && tbinfo->ispartition)
2209  {
2210  TableInfo *parentTbinfo;
2211 
2212  parentTbinfo = getRootTableInfo(tbinfo);
2213  copyFrom = fmtQualifiedDumpable(parentTbinfo);
2214  }
2215  else
2216  copyFrom = fmtQualifiedDumpable(tbinfo);
2217 
2218  /* must use 2 steps here 'cause fmtId is nonreentrant */
2219  appendPQExpBuffer(copyBuf, "COPY %s ",
2220  copyFrom);
2221  appendPQExpBuffer(copyBuf, "%s FROM stdin;\n",
2222  fmtCopyColumnList(tbinfo, clistBuf));
2223  copyStmt = copyBuf->data;
2224  }
2225  else
2226  {
2227  /* Restore using INSERT */
2228  dumpFn = dumpTableData_insert;
2229  copyStmt = NULL;
2230  }
2231 
2232  /*
2233  * Note: although the TableDataInfo is a full DumpableObject, we treat its
2234  * dependency on its table as "special" and pass it to ArchiveEntry now.
2235  * See comments for BuildArchiveDependencies.
2236  */
2237  if (tdinfo->dobj.dump & DUMP_COMPONENT_DATA)
2238  {
2239  TocEntry *te;
2240 
2241  te = ArchiveEntry(fout, tdinfo->dobj.catId, tdinfo->dobj.dumpId,
2242  ARCHIVE_OPTS(.tag = tbinfo->dobj.name,
2243  .namespace = tbinfo->dobj.namespace->dobj.name,
2244  .owner = tbinfo->rolname,
2245  .description = "TABLE DATA",
2246  .section = SECTION_DATA,
2247  .copyStmt = copyStmt,
2248  .deps = &(tbinfo->dobj.dumpId),
2249  .nDeps = 1,
2250  .dumpFn = dumpFn,
2251  .dumpArg = tdinfo));
2252 
2253  /*
2254  * Set the TocEntry's dataLength in case we are doing a parallel dump
2255  * and want to order dump jobs by table size. We choose to measure
2256  * dataLength in table pages during dump, so no scaling is needed.
2257  * However, relpages is declared as "integer" in pg_class, and hence
2258  * also in TableInfo, but it's really BlockNumber a/k/a unsigned int.
2259  * Cast so that we get the right interpretation of table sizes
2260  * exceeding INT_MAX pages.
2261  */
2262  te->dataLength = (BlockNumber) tbinfo->relpages;
2263  }
2264 
2265  destroyPQExpBuffer(copyBuf);
2266  destroyPQExpBuffer(clistBuf);
2267 }
2268 
2269 /*
2270  * refreshMatViewData -
2271  * load or refresh the contents of a single materialized view
2272  *
2273  * Actually, this just makes an ArchiveEntry for the REFRESH MATERIALIZED VIEW
2274  * statement.
2275  */
2276 static void
2277 refreshMatViewData(Archive *fout, TableDataInfo *tdinfo)
2278 {
2279  TableInfo *tbinfo = tdinfo->tdtable;
2280  PQExpBuffer q;
2281 
2282  /* If the materialized view is not flagged as populated, skip this. */
2283  if (!tbinfo->relispopulated)
2284  return;
2285 
2286  q = createPQExpBuffer();
2287 
2288  appendPQExpBuffer(q, "REFRESH MATERIALIZED VIEW %s;\n",
2289  fmtQualifiedDumpable(tbinfo));
2290 
2291  if (tdinfo->dobj.dump & DUMP_COMPONENT_DATA)
2292  ArchiveEntry(fout,
2293  tdinfo->dobj.catId, /* catalog ID */
2294  tdinfo->dobj.dumpId, /* dump ID */
2295  ARCHIVE_OPTS(.tag = tbinfo->dobj.name,
2296  .namespace = tbinfo->dobj.namespace->dobj.name,
2297  .owner = tbinfo->rolname,
2298  .description = "MATERIALIZED VIEW DATA",
2299  .section = SECTION_POST_DATA,
2300  .createStmt = q->data,
2301  .deps = tdinfo->dobj.dependencies,
2302  .nDeps = tdinfo->dobj.nDeps));
2303 
2304  destroyPQExpBuffer(q);
2305 }
2306 
2307 /*
2308  * getTableData -
2309  * set up dumpable objects representing the contents of tables
2310  */
2311 static void
2312 getTableData(DumpOptions *dopt, TableInfo *tblinfo, int numTables, char relkind)
2313 {
2314  int i;
2315 
2316  for (i = 0; i < numTables; i++)
2317  {
2318  if (tblinfo[i].dobj.dump & DUMP_COMPONENT_DATA &&
2319  (!relkind || tblinfo[i].relkind == relkind))
2320  makeTableDataInfo(dopt, &(tblinfo[i]));
2321  }
2322 }
2323 
2324 /*
2325  * Make a dumpable object for the data of this specific table
2326  *
2327  * Note: we make a TableDataInfo if and only if we are going to dump the
2328  * table data; the "dump" flag in such objects isn't used.
2329  */
2330 static void
2331 makeTableDataInfo(DumpOptions *dopt, TableInfo *tbinfo)
2332 {
2333  TableDataInfo *tdinfo;
2334 
2335  /*
2336  * Nothing to do if we already decided to dump the table. This will
2337  * happen for "config" tables.
2338  */
2339  if (tbinfo->dataObj != NULL)
2340  return;
2341 
2342  /* Skip VIEWs (no data to dump) */
2343  if (tbinfo->relkind == RELKIND_VIEW)
2344  return;
2345  /* Skip FOREIGN TABLEs (no data to dump) */
2346  if (tbinfo->relkind == RELKIND_FOREIGN_TABLE)
2347  return;
2348  /* Skip partitioned tables (data in partitions) */
2349  if (tbinfo->relkind == RELKIND_PARTITIONED_TABLE)
2350  return;
2351 
2352  /* Don't dump data in unlogged tables, if so requested */
2353  if (tbinfo->relpersistence == RELPERSISTENCE_UNLOGGED &&
2354  dopt->no_unlogged_table_data)
2355  return;
2356 
2357  /* Check that the data is not explicitly excluded */
2358  if (simple_oid_list_member(&tabledata_exclude_oids,
2359  tbinfo->dobj.catId.oid))
2360  return;
2361 
2362  /* OK, let's dump it */
2363  tdinfo = (TableDataInfo *) pg_malloc(sizeof(TableDataInfo));
2364 
2365  if (tbinfo->relkind == RELKIND_MATVIEW)
2366  tdinfo->dobj.objType = DO_REFRESH_MATVIEW;
2367  else if (tbinfo->relkind == RELKIND_SEQUENCE)
2368  tdinfo->dobj.objType = DO_SEQUENCE_SET;
2369  else
2370  tdinfo->dobj.objType = DO_TABLE_DATA;
2371 
2372  /*
2373  * Note: use tableoid 0 so that this object won't be mistaken for
2374  * something that pg_depend entries apply to.
2375  */
2376  tdinfo->dobj.catId.tableoid = 0;
2377  tdinfo->dobj.catId.oid = tbinfo->dobj.catId.oid;
2378  AssignDumpId(&tdinfo->dobj);
2379  tdinfo->dobj.name = tbinfo->dobj.name;
2380  tdinfo->dobj.namespace = tbinfo->dobj.namespace;
2381  tdinfo->tdtable = tbinfo;
2382  tdinfo->filtercond = NULL; /* might get set later */
2383  addObjectDependency(&tdinfo->dobj, tbinfo->dobj.dumpId);
2384 
2385  tbinfo->dataObj = tdinfo;
2386 }
2387 
2388 /*
2389  * The refresh for a materialized view must be dependent on the refresh for
2390  * any materialized view that this one is dependent on.
2391  *
2392  * This must be called after all the objects are created, but before they are
2393  * sorted.
2394  */
2395 static void
2396 buildMatViewRefreshDependencies(Archive *fout)
2397 {
2398  PQExpBuffer query;
2399  PGresult *res;
2400  int ntups,
2401  i;
2402  int i_classid,
2403  i_objid,
2404  i_refobjid;
2405 
2406  /* No Mat Views before 9.3. */
2407  if (fout->remoteVersion < 90300)
2408  return;
2409 
2410  query = createPQExpBuffer();
2411 
2412  appendPQExpBufferStr(query, "WITH RECURSIVE w AS "
2413  "( "
2414  "SELECT d1.objid, d2.refobjid, c2.relkind AS refrelkind "
2415  "FROM pg_depend d1 "
2416  "JOIN pg_class c1 ON c1.oid = d1.objid "
2417  "AND c1.relkind = " CppAsString2(RELKIND_MATVIEW)
2418  " JOIN pg_rewrite r1 ON r1.ev_class = d1.objid "
2419  "JOIN pg_depend d2 ON d2.classid = 'pg_rewrite'::regclass "
2420  "AND d2.objid = r1.oid "
2421  "AND d2.refobjid <> d1.objid "
2422  "JOIN pg_class c2 ON c2.oid = d2.refobjid "
2423  "AND c2.relkind IN (" CppAsString2(RELKIND_MATVIEW) ","
2424  CppAsString2(RELKIND_VIEW) ") "
2425  "WHERE d1.classid = 'pg_class'::regclass "
2426  "UNION "
2427  "SELECT w.objid, d3.refobjid, c3.relkind "
2428  "FROM w "
2429  "JOIN pg_rewrite r3 ON r3.ev_class = w.refobjid "
2430  "JOIN pg_depend d3 ON d3.classid = 'pg_rewrite'::regclass "
2431  "AND d3.objid = r3.oid "
2432  "AND d3.refobjid <> w.refobjid "
2433  "JOIN pg_class c3 ON c3.oid = d3.refobjid "
2434  "AND c3.relkind IN (" CppAsString2(RELKIND_MATVIEW) ","
2435  CppAsString2(RELKIND_VIEW) ") "
2436  ") "
2437  "SELECT 'pg_class'::regclass::oid AS classid, objid, refobjid "
2438  "FROM w "
2439  "WHERE refrelkind = " CppAsString2(RELKIND_MATVIEW));
2440 
2441  res = ExecuteSqlQuery(fout, query->data, PGRES_TUPLES_OK);
2442 
2443  ntups = PQntuples(res);
2444 
2445  i_classid = PQfnumber(res, "classid");
2446  i_objid = PQfnumber(res, "objid");
2447  i_refobjid = PQfnumber(res, "refobjid");
2448 
2449  for (i = 0; i < ntups; i++)
2450  {
2451  CatalogId objId;
2452  CatalogId refobjId;
2453  DumpableObject *dobj;
2454  DumpableObject *refdobj;
2455  TableInfo *tbinfo;
2456  TableInfo *reftbinfo;
2457 
2458  objId.tableoid = atooid(PQgetvalue(res, i, i_classid));
2459  objId.oid = atooid(PQgetvalue(res, i, i_objid));
2460  refobjId.tableoid = objId.tableoid;
2461  refobjId.oid = atooid(PQgetvalue(res, i, i_refobjid));
2462 
2463  dobj = findObjectByCatalogId(objId);
2464  if (dobj == NULL)
2465  continue;
2466 
2467  Assert(dobj->objType == DO_TABLE);
2468  tbinfo = (TableInfo *) dobj;
2469  Assert(tbinfo->relkind == RELKIND_MATVIEW);
2470  dobj = (DumpableObject *) tbinfo->dataObj;
2471  if (dobj == NULL)
2472  continue;
2473  Assert(dobj->objType == DO_REFRESH_MATVIEW);
2474 
2475  refdobj = findObjectByCatalogId(refobjId);
2476  if (refdobj == NULL)
2477  continue;
2478 
2479  Assert(refdobj->objType == DO_TABLE);
2480  reftbinfo = (TableInfo *) refdobj;
2481  Assert(reftbinfo->relkind == RELKIND_MATVIEW);
2482  refdobj = (DumpableObject *) reftbinfo->dataObj;
2483  if (refdobj == NULL)
2484  continue;
2485  Assert(refdobj->objType == DO_REFRESH_MATVIEW);
2486 
2487  addObjectDependency(dobj, refdobj->dumpId);
2488 
2489  if (!reftbinfo->relispopulated)
2490  tbinfo->relispopulated = false;
2491  }
2492 
2493  PQclear(res);
2494 
2495  destroyPQExpBuffer(query);
2496 }
2497 
2498 /*
2499  * getTableDataFKConstraints -
2500  * add dump-order dependencies reflecting foreign key constraints
2501  *
2502  * This code is executed only in a data-only dump --- in schema+data dumps
2503  * we handle foreign key issues by not creating the FK constraints until
2504  * after the data is loaded. In a data-only dump, however, we want to
2505  * order the table data objects in such a way that a table's referenced
2506  * tables are restored first. (In the presence of circular references or
2507  * self-references this may be impossible; we'll detect and complain about
2508  * that during the dependency sorting step.)
2509  */
2510 static void
2511 getTableDataFKConstraints(void)
2512 {
2513  DumpableObject **dobjs;
2514  int numObjs;
2515  int i;
2516 
2517  /* Search through all the dumpable objects for FK constraints */
2518  getDumpableObjects(&dobjs, &numObjs);
2519  for (i = 0; i < numObjs; i++)
2520  {
2521  if (dobjs[i]->objType == DO_FK_CONSTRAINT)
2522  {
2523  ConstraintInfo *cinfo = (ConstraintInfo *) dobjs[i];
2524  TableInfo *ftable;
2525 
2526  /* Not interesting unless both tables are to be dumped */
2527  if (cinfo->contable == NULL ||
2528  cinfo->contable->dataObj == NULL)
2529  continue;
2530  ftable = findTableByOid(cinfo->confrelid);
2531  if (ftable == NULL ||
2532  ftable->dataObj == NULL)
2533  continue;
2534 
2535  /*
2536  * Okay, make referencing table's TABLE_DATA object depend on the
2537  * referenced table's TABLE_DATA object.
2538  */
2539  addObjectDependency(&cinfo->contable->dataObj->dobj,
2540  ftable->dataObj->dobj.dumpId);
2541  }
2542  }
2543  free(dobjs);
2544 }
2545 
2546 
2547 /*
2548  * guessConstraintInheritance:
2549  * In pre-8.4 databases, we can't tell for certain which constraints
2550  * are inherited. We assume a CHECK constraint is inherited if its name
2551  * matches the name of any constraint in the parent. Originally this code
2552  * tried to compare the expression texts, but that can fail for various
2553  * reasons --- for example, if the parent and child tables are in different
2554  * schemas, reverse-listing of function calls may produce different text
2555  * (schema-qualified or not) depending on search path.
2556  *
2557  * In 8.4 and up we can rely on the conislocal field to decide which
2558  * constraints must be dumped; much safer.
2559  *
2560  * This function assumes all conislocal flags were initialized to true.
2561  * It clears the flag on anything that seems to be inherited.
2562  */
2563 static void
2564 guessConstraintInheritance(TableInfo *tblinfo, int numTables)
2565 {
2566  int i,
2567  j,
2568  k;
2569 
2570  for (i = 0; i < numTables; i++)
2571  {
2572  TableInfo *tbinfo = &(tblinfo[i]);
2573  int numParents;
2574  TableInfo **parents;
2575  TableInfo *parent;
2576 
2577  /* Sequences and views never have parents */
2578  if (tbinfo->relkind == RELKIND_SEQUENCE ||
2579  tbinfo->relkind == RELKIND_VIEW)
2580  continue;
2581 
2582  /* Don't bother computing anything for non-target tables, either */
2583  if (!(tbinfo->dobj.dump & DUMP_COMPONENT_DEFINITION))
2584  continue;
2585 
2586  numParents = tbinfo->numParents;
2587  parents = tbinfo->parents;
2588 
2589  if (numParents == 0)
2590  continue; /* nothing to see here, move along */
2591 
2592  /* scan for inherited CHECK constraints */
2593  for (j = 0; j < tbinfo->ncheck; j++)
2594  {
2595  ConstraintInfo *constr;
2596 
2597  constr = &(tbinfo->checkexprs[j]);
2598 
2599  for (k = 0; k < numParents; k++)
2600  {
2601  int l;
2602 
2603  parent = parents[k];
2604  for (l = 0; l < parent->ncheck; l++)
2605  {
2606  ConstraintInfo *pconstr = &(parent->checkexprs[l]);
2607 
2608  if (strcmp(pconstr->dobj.name, constr->dobj.name) == 0)
2609  {
2610  constr->conislocal = false;
2611  break;
2612  }
2613  }
2614  if (!constr->conislocal)
2615  break;
2616  }
2617  }
2618  }
2619 }
2620 
2621 
2622 /*
2623  * dumpDatabase:
2624  * dump the database definition
2625  */
2626 static void
2627 dumpDatabase(Archive *fout)
2628 {
2629  DumpOptions *dopt = fout->dopt;
2630  PQExpBuffer dbQry = createPQExpBuffer();
2631  PQExpBuffer delQry = createPQExpBuffer();
2632  PQExpBuffer creaQry = createPQExpBuffer();
2633  PQExpBuffer labelq = createPQExpBuffer();
2634  PGconn *conn = GetConnection(fout);
2635  PGresult *res;
2636  int i_tableoid,
2637  i_oid,
2638  i_datname,
2639  i_dba,
2640  i_encoding,
2641  i_collate,
2642  i_ctype,
2643  i_frozenxid,
2644  i_minmxid,
2645  i_datacl,
2646  i_rdatacl,
2647  i_datistemplate,
2648  i_datconnlimit,
2649  i_tablespace;
2650  CatalogId dbCatId;
2651  DumpId dbDumpId;
2652  const char *datname,
2653  *dba,
2654  *encoding,
2655  *collate,
2656  *ctype,
2657  *datacl,
2658  *rdatacl,
2659  *datistemplate,
2660  *datconnlimit,
2661  *tablespace;
2662  uint32 frozenxid,
2663  minmxid;
2664  char *qdatname;
2665 
2666  pg_log_info("saving database definition");
2667 
2668  /*
2669  * Fetch the database-level properties for this database.
2670  *
2671  * The order in which privileges are in the ACL string (the order they
2672  * have been GRANT'd in, which the backend maintains) must be preserved to
2673  * ensure that GRANTs WITH GRANT OPTION and subsequent GRANTs based on
2674  * those are dumped in the correct order. Note that initial privileges
2675  * (pg_init_privs) are not supported on databases, so this logic cannot
2676  * make use of buildACLQueries().
2677  */
2678  if (fout->remoteVersion >= 90600)
2679  {
2680  appendPQExpBuffer(dbQry, "SELECT tableoid, oid, datname, "
2681  "(%s datdba) AS dba, "
2682  "pg_encoding_to_char(encoding) AS encoding, "
2683  "datcollate, datctype, datfrozenxid, datminmxid, "
2684  "(SELECT array_agg(acl ORDER BY row_n) FROM "
2685  " (SELECT acl, row_n FROM "
2686  " unnest(coalesce(datacl,acldefault('d',datdba))) "
2687  " WITH ORDINALITY AS perm(acl,row_n) "
2688  " WHERE NOT EXISTS ( "
2689  " SELECT 1 "
2690  " FROM unnest(acldefault('d',datdba)) "
2691  " AS init(init_acl) "
2692  " WHERE acl = init_acl)) AS datacls) "
2693  " AS datacl, "
2694  "(SELECT array_agg(acl ORDER BY row_n) FROM "
2695  " (SELECT acl, row_n FROM "
2696  " unnest(acldefault('d',datdba)) "
2697  " WITH ORDINALITY AS initp(acl,row_n) "
2698  " WHERE NOT EXISTS ( "
2699  " SELECT 1 "
2700  " FROM unnest(coalesce(datacl,acldefault('d',datdba))) "
2701  " AS permp(orig_acl) "
2702  " WHERE acl = orig_acl)) AS rdatacls) "
2703  " AS rdatacl, "
2704  "datistemplate, datconnlimit, "
2705  "(SELECT spcname FROM pg_tablespace t WHERE t.oid = dattablespace) AS tablespace, "
2706  "shobj_description(oid, 'pg_database') AS description "
2707 
2708  "FROM pg_database "
2709  "WHERE datname = current_database()",
2710  username_subquery);
2711  }
2712  else if (fout->remoteVersion >= 90300)
2713  {
2714  appendPQExpBuffer(dbQry, "SELECT tableoid, oid, datname, "
2715  "(%s datdba) AS dba, "
2716  "pg_encoding_to_char(encoding) AS encoding, "
2717  "datcollate, datctype, datfrozenxid, datminmxid, "
2718  "datacl, '' as rdatacl, datistemplate, datconnlimit, "
2719  "(SELECT spcname FROM pg_tablespace t WHERE t.oid = dattablespace) AS tablespace, "
2720  "shobj_description(oid, 'pg_database') AS description "
2721 
2722  "FROM pg_database "
2723  "WHERE datname = current_database()",
2724  username_subquery);
2725  }
2726  else if (fout->remoteVersion >= 80400)
2727  {
2728  appendPQExpBuffer(dbQry, "SELECT tableoid, oid, datname, "
2729  "(%s datdba) AS dba, "
2730  "pg_encoding_to_char(encoding) AS encoding, "
2731  "datcollate, datctype, datfrozenxid, 0 AS datminmxid, "
2732  "datacl, '' as rdatacl, datistemplate, datconnlimit, "
2733  "(SELECT spcname FROM pg_tablespace t WHERE t.oid = dattablespace) AS tablespace, "
2734  "shobj_description(oid, 'pg_database') AS description "
2735 
2736  "FROM pg_database "
2737  "WHERE datname = current_database()",
2738  username_subquery);
2739  }
2740  else if (fout->remoteVersion >= 80200)
2741  {
2742  appendPQExpBuffer(dbQry, "SELECT tableoid, oid, datname, "
2743  "(%s datdba) AS dba, "
2744  "pg_encoding_to_char(encoding) AS encoding, "
2745  "NULL AS datcollate, NULL AS datctype, datfrozenxid, 0 AS datminmxid, "
2746  "datacl, '' as rdatacl, datistemplate, datconnlimit, "
2747  "(SELECT spcname FROM pg_tablespace t WHERE t.oid = dattablespace) AS tablespace, "
2748  "shobj_description(oid, 'pg_database') AS description "
2749 
2750  "FROM pg_database "
2751  "WHERE datname = current_database()",
2752  username_subquery);
2753  }
2754  else
2755  {
2756  appendPQExpBuffer(dbQry, "SELECT tableoid, oid, datname, "
2757  "(%s datdba) AS dba, "
2758  "pg_encoding_to_char(encoding) AS encoding, "
2759  "NULL AS datcollate, NULL AS datctype, datfrozenxid, 0 AS datminmxid, "
2760  "datacl, '' as rdatacl, datistemplate, "
2761  "-1 as datconnlimit, "
2762  "(SELECT spcname FROM pg_tablespace t WHERE t.oid = dattablespace) AS tablespace "
2763  "FROM pg_database "
2764  "WHERE datname = current_database()",
2765  username_subquery);
2766  }
2767 
2768  res = ExecuteSqlQueryForSingleRow(fout, dbQry->data);
2769 
2770  i_tableoid = PQfnumber(res, "tableoid");
2771  i_oid = PQfnumber(res, "oid");
2772  i_datname = PQfnumber(res, "datname");
2773  i_dba = PQfnumber(res, "dba");
2774  i_encoding = PQfnumber(res, "encoding");
2775  i_collate = PQfnumber(res, "datcollate");
2776  i_ctype = PQfnumber(res, "datctype");
2777  i_frozenxid = PQfnumber(res, "datfrozenxid");
2778  i_minmxid = PQfnumber(res, "datminmxid");
2779  i_datacl = PQfnumber(res, "datacl");
2780  i_rdatacl = PQfnumber(res, "rdatacl");
2781  i_datistemplate = PQfnumber(res, "datistemplate");
2782  i_datconnlimit = PQfnumber(res, "datconnlimit");
2783  i_tablespace = PQfnumber(res, "tablespace");
2784 
2785  dbCatId.tableoid = atooid(PQgetvalue(res, 0, i_tableoid));
2786  dbCatId.oid = atooid(PQgetvalue(res, 0, i_oid));
2787  datname = PQgetvalue(res, 0, i_datname);
2788  dba = PQgetvalue(res, 0, i_dba);
2789  encoding = PQgetvalue(res, 0, i_encoding);
2790  collate = PQgetvalue(res, 0, i_collate);
2791  ctype = PQgetvalue(res, 0, i_ctype);
2792  frozenxid = atooid(PQgetvalue(res, 0, i_frozenxid));
2793  minmxid = atooid(PQgetvalue(res, 0, i_minmxid));
2794  datacl = PQgetvalue(res, 0, i_datacl);
2795  rdatacl = PQgetvalue(res, 0, i_rdatacl);
2796  datistemplate = PQgetvalue(res, 0, i_datistemplate);
2797  datconnlimit = PQgetvalue(res, 0, i_datconnlimit);
2798  tablespace = PQgetvalue(res, 0, i_tablespace);
2799 
2800  qdatname = pg_strdup(fmtId(datname));
2801 
2802  /*
2803  * Prepare the CREATE DATABASE command. We must specify encoding, locale,
2804  * and tablespace since those can't be altered later. Other DB properties
2805  * are left to the DATABASE PROPERTIES entry, so that they can be applied
2806  * after reconnecting to the target DB.
2807  */
2808  appendPQExpBuffer(creaQry, "CREATE DATABASE %s WITH TEMPLATE = template0",
2809  qdatname);
2810  if (strlen(encoding) > 0)
2811  {
2812  appendPQExpBufferStr(creaQry, " ENCODING = ");
2813  appendStringLiteralAH(creaQry, encoding, fout);
2814  }
2815  if (strlen(collate) > 0)
2816  {
2817  appendPQExpBufferStr(creaQry, " LC_COLLATE = ");
2818  appendStringLiteralAH(creaQry, collate, fout);
2819  }
2820  if (strlen(ctype) > 0)
2821  {
2822  appendPQExpBufferStr(creaQry, " LC_CTYPE = ");
2823  appendStringLiteralAH(creaQry, ctype, fout);
2824  }
2825 
2826  /*
2827  * Note: looking at dopt->outputNoTablespaces here is completely the wrong
2828  * thing; the decision whether to specify a tablespace should be left till
2829  * pg_restore, so that pg_restore --no-tablespaces applies. Ideally we'd
2830  * label the DATABASE entry with the tablespace and let the normal
2831  * tablespace selection logic work ... but CREATE DATABASE doesn't pay
2832  * attention to default_tablespace, so that won't work.
2833  */
2834  if (strlen(tablespace) > 0 && strcmp(tablespace, "pg_default") != 0 &&
2835  !dopt->outputNoTablespaces)
2836  appendPQExpBuffer(creaQry, " TABLESPACE = %s",
2837  fmtId(tablespace));
2838  appendPQExpBufferStr(creaQry, ";\n");
2839 
2840  appendPQExpBuffer(delQry, "DROP DATABASE %s;\n",
2841  qdatname);
2842 
2843  dbDumpId = createDumpId();
2844 
2845  ArchiveEntry(fout,
2846  dbCatId, /* catalog ID */
2847  dbDumpId, /* dump ID */
2848  ARCHIVE_OPTS(.tag = datname,
2849  .owner = dba,
2850  .description = "DATABASE",
2851  .section = SECTION_PRE_DATA,
2852  .createStmt = creaQry->data,
2853  .dropStmt = delQry->data));
2854 
2855  /* Compute correct tag for archive entry */
2856  appendPQExpBuffer(labelq, "DATABASE %s", qdatname);
2857 
2858  /* Dump DB comment if any */
2859  if (fout->remoteVersion >= 80200)
2860  {
2861  /*
2862  * 8.2 and up keep comments on shared objects in a shared table, so we
2863  * cannot use the dumpComment() code used for other database objects.
2864  * Be careful that the ArchiveEntry parameters match that function.
2865  */
2866  char *comment = PQgetvalue(res, 0, PQfnumber(res, "description"));
2867 
2868  if (comment && *comment && !dopt->no_comments)
2869  {
2870  resetPQExpBuffer(dbQry);
2871 
2872  /*
2873  * Generates warning when loaded into a differently-named
2874  * database.
2875  */
2876  appendPQExpBuffer(dbQry, "COMMENT ON DATABASE %s IS ", qdatname);
2877  appendStringLiteralAH(dbQry, comment, fout);
2878  appendPQExpBufferStr(dbQry, ";\n");
2879 
2880  ArchiveEntry(fout, nilCatalogId, createDumpId(),
2881  ARCHIVE_OPTS(.tag = labelq->data,
2882  .owner = dba,
2883  .description = "COMMENT",
2884  .section = SECTION_NONE,
2885  .createStmt = dbQry->data,
2886  .deps = &dbDumpId,
2887  .nDeps = 1));
2888  }
2889  }
2890  else
2891  {
2892  dumpComment(fout, "DATABASE", qdatname, NULL, dba,
2893  dbCatId, 0, dbDumpId);
2894  }
2895 
2896  /* Dump DB security label, if enabled */
2897  if (!dopt->no_security_labels && fout->remoteVersion >= 90200)
2898  {
2899  PGresult *shres;
2900  PQExpBuffer seclabelQry;
2901 
2902  seclabelQry = createPQExpBuffer();
2903 
2904  buildShSecLabelQuery(conn, "pg_database", dbCatId.oid, seclabelQry);
2905  shres = ExecuteSqlQuery(fout, seclabelQry->data, PGRES_TUPLES_OK);
2906  resetPQExpBuffer(seclabelQry);
2907  emitShSecLabels(conn, shres, seclabelQry, "DATABASE", datname);
2908  if (seclabelQry->len > 0)
2909  ArchiveEntry(fout, nilCatalogId, createDumpId(),
2910  ARCHIVE_OPTS(.tag = labelq->data,
2911  .owner = dba,
2912  .description = "SECURITY LABEL",
2913  .section = SECTION_NONE,
2914  .createStmt = seclabelQry->data,
2915  .deps = &dbDumpId,
2916  .nDeps = 1));
2917  destroyPQExpBuffer(seclabelQry);
2918  PQclear(shres);
2919  }
2920 
2921  /*
2922  * Dump ACL if any. Note that we do not support initial privileges
2923  * (pg_init_privs) on databases.
2924  */
2925  dumpACL(fout, dbCatId, dbDumpId, "DATABASE",
2926  qdatname, NULL, NULL,
2927  dba, datacl, rdatacl, "", "");
2928 
2929  /*
2930  * Now construct a DATABASE PROPERTIES archive entry to restore any
2931  * non-default database-level properties. (The reason this must be
2932  * separate is that we cannot put any additional commands into the TOC
2933  * entry that has CREATE DATABASE. pg_restore would execute such a group
2934  * in an implicit transaction block, and the backend won't allow CREATE
2935  * DATABASE in that context.)
2936  */
2937  resetPQExpBuffer(creaQry);
2938  resetPQExpBuffer(delQry);
2939 
2940  if (strlen(datconnlimit) > 0 && strcmp(datconnlimit, "-1") != 0)
2941  appendPQExpBuffer(creaQry, "ALTER DATABASE %s CONNECTION LIMIT = %s;\n",
2942  qdatname, datconnlimit);
2943 
2944  if (strcmp(datistemplate, "t") == 0)
2945  {
2946  appendPQExpBuffer(creaQry, "ALTER DATABASE %s IS_TEMPLATE = true;\n",
2947  qdatname);
2948 
2949  /*
2950  * The backend won't accept DROP DATABASE on a template database. We
2951  * can deal with that by removing the template marking before the DROP
2952  * gets issued. We'd prefer to use ALTER DATABASE IF EXISTS here, but
2953  * since no such command is currently supported, fake it with a direct
2954  * UPDATE on pg_database.
2955  */
2956  appendPQExpBufferStr(delQry, "UPDATE pg_catalog.pg_database "
2957  "SET datistemplate = false WHERE datname = ");
2958  appendStringLiteralAH(delQry, datname, fout);
2959  appendPQExpBufferStr(delQry, ";\n");
2960  }
2961 
2962  /* Add database-specific SET options */
2963  dumpDatabaseConfig(fout, creaQry, datname, dbCatId.oid);
2964 
2965  /*
2966  * We stick this binary-upgrade query into the DATABASE PROPERTIES archive
2967  * entry, too, for lack of a better place.
2968  */
2969  if (dopt->binary_upgrade)
2970  {
2971  appendPQExpBufferStr(creaQry, "\n-- For binary upgrade, set datfrozenxid and datminmxid.\n");
2972  appendPQExpBuffer(creaQry, "UPDATE pg_catalog.pg_database\n"
2973  "SET datfrozenxid = '%u', datminmxid = '%u'\n"
2974  "WHERE datname = ",
2975  frozenxid, minmxid);
2976  appendStringLiteralAH(creaQry, datname, fout);
2977  appendPQExpBufferStr(creaQry, ";\n");
2978  }
2979 
2980  if (creaQry->len > 0)
2981  ArchiveEntry(fout, nilCatalogId, createDumpId(),
2982  ARCHIVE_OPTS(.tag = datname,
2983  .owner = dba,
2984  .description = "DATABASE PROPERTIES",
2985  .section = SECTION_PRE_DATA,
2986  .createStmt = creaQry->data,
2987  .dropStmt = delQry->data,
2988  .deps = &dbDumpId));
2989 
2990  /*
2991  * pg_largeobject comes from the old system intact, so set its
2992  * relfrozenxids and relminmxids.
2993  */
2994  if (dopt->binary_upgrade)
2995  {
2996  PGresult *lo_res;
2997  PQExpBuffer loFrozenQry = createPQExpBuffer();
2998  PQExpBuffer loOutQry = createPQExpBuffer();
2999  int i_relfrozenxid,
3000  i_relminmxid;
3001 
3002  /*
3003  * pg_largeobject
3004  */
3005  if (fout->remoteVersion >= 90300)
3006  appendPQExpBuffer(loFrozenQry, "SELECT relfrozenxid, relminmxid\n"
3007  "FROM pg_catalog.pg_class\n"
3008  "WHERE oid = %u;\n",
3009  LargeObjectRelationId);
3010  else
3011  appendPQExpBuffer(loFrozenQry, "SELECT relfrozenxid, 0 AS relminmxid\n"
3012  "FROM pg_catalog.pg_class\n"
3013  "WHERE oid = %u;\n",
3014  LargeObjectRelationId);
3015 
3016  lo_res = ExecuteSqlQueryForSingleRow(fout, loFrozenQry->data);
3017 
3018  i_relfrozenxid = PQfnumber(lo_res, "relfrozenxid");
3019  i_relminmxid = PQfnumber(lo_res, "relminmxid");
3020 
3021  appendPQExpBufferStr(loOutQry, "\n-- For binary upgrade, set pg_largeobject relfrozenxid and relminmxid\n");
3022  appendPQExpBuffer(loOutQry, "UPDATE pg_catalog.pg_class\n"
3023  "SET relfrozenxid = '%u', relminmxid = '%u'\n"
3024  "WHERE oid = %u;\n",
3025  atooid(PQgetvalue(lo_res, 0, i_relfrozenxid)),
3026  atooid(PQgetvalue(lo_res, 0, i_relminmxid)),
3027  LargeObjectRelationId);
3028  ArchiveEntry(fout, nilCatalogId, createDumpId(),
3029  ARCHIVE_OPTS(.tag = "pg_largeobject",
3030  .description = "pg_largeobject",
3031  .section = SECTION_PRE_DATA,
3032  .createStmt = loOutQry->data));
3033 
3034  PQclear(lo_res);
3035 
3036  destroyPQExpBuffer(loFrozenQry);
3037  destroyPQExpBuffer(loOutQry);
3038  }
3039 
3040  PQclear(res);
3041 
3042  free(qdatname);
3043  destroyPQExpBuffer(dbQry);
3044  destroyPQExpBuffer(delQry);
3045  destroyPQExpBuffer(creaQry);
3046  destroyPQExpBuffer(labelq);
3047 }
3048 
3049 /*
3050  * Collect any database-specific or role-and-database-specific SET options
3051  * for this database, and append them to outbuf.
3052  */
3053 static void
3054 dumpDatabaseConfig(Archive *AH, PQExpBuffer outbuf,
3055  const char *dbname, Oid dboid)
3056 {
3057  PGconn *conn = GetConnection(AH);
3058  PQExpBuffer buf = createPQExpBuffer();
3059  PGresult *res;
3060  int count = 1;
3061 
3062  /*
3063  * First collect database-specific options. Pre-8.4 server versions lack
3064  * unnest(), so we do this the hard way by querying once per subscript.
3065  */
3066  for (;;)
3067  {
3068  if (AH->remoteVersion >= 90000)
3069  printfPQExpBuffer(buf, "SELECT setconfig[%d] FROM pg_db_role_setting "
3070  "WHERE setrole = 0 AND setdatabase = '%u'::oid",
3071  count, dboid);
3072  else
3073  printfPQExpBuffer(buf, "SELECT datconfig[%d] FROM pg_database WHERE oid = '%u'::oid", count, dboid);
3074 
3075  res = ExecuteSqlQuery(AH, buf->data, PGRES_TUPLES_OK);
3076 
3077  if (PQntuples(res) == 1 &&
3078  !PQgetisnull(res, 0, 0))
3079  {
3080  makeAlterConfigCommand(conn, PQgetvalue(res, 0, 0),
3081  "DATABASE", dbname, NULL, NULL,
3082  outbuf);
3083  PQclear(res);
3084  count++;
3085  }
3086  else
3087  {
3088  PQclear(res);
3089  break;
3090  }
3091  }
3092 
3093  /* Now look for role-and-database-specific options */
3094  if (AH->remoteVersion >= 90000)
3095  {
3096  /* Here we can assume we have unnest() */
3097  printfPQExpBuffer(buf, "SELECT rolname, unnest(setconfig) "
3098  "FROM pg_db_role_setting s, pg_roles r "
3099  "WHERE setrole = r.oid AND setdatabase = '%u'::oid",
3100  dboid);
3101 
3102  res = ExecuteSqlQuery(AH, buf->data, PGRES_TUPLES_OK);
3103 
3104  if (PQntuples(res) > 0)
3105  {
3106  int i;
3107 
3108  for (i = 0; i < PQntuples(res); i++)
3109  makeAlterConfigCommand(conn, PQgetvalue(res, i, 1),
3110  "ROLE", PQgetvalue(res, i, 0),
3111  "DATABASE", dbname,
3112  outbuf);
3113  }
3114 
3115  PQclear(res);
3116  }
3117 
3118  destroyPQExpBuffer(buf);
3119 }
3120 
3121 /*
3122  * dumpEncoding: put the correct encoding into the archive
3123  */
3124 static void
3125 dumpEncoding(Archive *AH)
3126 {
3127  const char *encname = pg_encoding_to_char(AH->encoding);
3128  PQExpBuffer qry = createPQExpBuffer();
3129 
3130  pg_log_info("saving encoding = %s", encname);
3131 
3132  appendPQExpBufferStr(qry, "SET client_encoding = ");
3133  appendStringLiteralAH(qry, encname, AH);
3134  appendPQExpBufferStr(qry, ";\n");
3135 
3136  ArchiveEntry(AH, nilCatalogId, createDumpId(),
3137  ARCHIVE_OPTS(.tag = "ENCODING",
3138  .description = "ENCODING",
3139  .section = SECTION_PRE_DATA,
3140  .createStmt = qry->data));
3141 
3142  destroyPQExpBuffer(qry);
3143 }
3144 
3145 
3146 /*
3147  * dumpStdStrings: put the correct escape string behavior into the archive
3148  */
3149 static void
3150 dumpStdStrings(Archive *AH)
3151 {
3152  const char *stdstrings = AH->std_strings ? "on" : "off";
3153  PQExpBuffer qry = createPQExpBuffer();
3154 
3155  pg_log_info("saving standard_conforming_strings = %s",
3156  stdstrings);
3157 
3158  appendPQExpBuffer(qry, "SET standard_conforming_strings = '%s';\n",
3159  stdstrings);
3160 
3161  ArchiveEntry(AH, nilCatalogId, createDumpId(),
3162  ARCHIVE_OPTS(.tag = "STDSTRINGS",
3163  .description = "STDSTRINGS",
3164  .section = SECTION_PRE_DATA,
3165  .createStmt = qry->data));
3166 
3167  destroyPQExpBuffer(qry);
3168 }
3169 
3170 /*
3171  * dumpSearchPath: record the active search_path in the archive
3172  */
3173 static void
3174 dumpSearchPath(Archive *AH)
3175 {
3176  PQExpBuffer qry = createPQExpBuffer();
3177  PQExpBuffer path = createPQExpBuffer();
3178  PGresult *res;
3179  char **schemanames = NULL;
3180  int nschemanames = 0;
3181  int i;
3182 
3183  /*
3184  * We use the result of current_schemas(), not the search_path GUC,
3185  * because that might contain wildcards such as "$user", which won't
3186  * necessarily have the same value during restore. Also, this way avoids
3187  * listing schemas that may appear in search_path but not actually exist,
3188  * which seems like a prudent exclusion.
3189  */
3190  res = ExecuteSqlQueryForSingleRow(AH,
3191  "SELECT pg_catalog.current_schemas(false)");
3192 
3193  if (!parsePGArray(PQgetvalue(res, 0, 0), &schemanames, &nschemanames))
3194  fatal("could not parse result of current_schemas()");
3195 
3196  /*
3197  * We use set_config(), not a simple "SET search_path" command, because
3198  * the latter has less-clean behavior if the search path is empty. While
3199  * that's likely to get fixed at some point, it seems like a good idea to
3200  * be as backwards-compatible as possible in what we put into archives.
3201  */
3202  for (i = 0; i < nschemanames; i++)
3203  {
3204  if (i > 0)
3205  appendPQExpBufferStr(path, ", ");
3206  appendPQExpBufferStr(path, fmtId(schemanames[i]));
3207  }
3208 
3209  appendPQExpBufferStr(qry, "SELECT pg_catalog.set_config('search_path', ");
3210  appendStringLiteralAH(qry, path->data, AH);
3211  appendPQExpBufferStr(qry, ", false);\n");
3212 
3213  pg_log_info("saving search_path = %s", path->data);
3214 
3215  ArchiveEntry(AH, nilCatalogId, createDumpId(),
3216  ARCHIVE_OPTS(.tag = "SEARCHPATH",
3217  .description = "SEARCHPATH",
3218  .section = SECTION_PRE_DATA,
3219  .createStmt = qry->data));
3220 
3221  /* Also save it in AH->searchpath, in case we're doing plain text dump */
3222  AH->searchpath = pg_strdup(qry->data);
3223 
3224  if (schemanames)
3225  free(schemanames);
3226  PQclear(res);
3227  destroyPQExpBuffer(qry);
3228  destroyPQExpBuffer(path);
3229 }
3230 
3231 
3232 /*
3233  * getBlobs:
3234  * Collect schema-level data about large objects
3235  */
3236 static void
3237 getBlobs(Archive *fout)
3238 {
3239  DumpOptions *dopt = fout->dopt;
3240  PQExpBuffer blobQry = createPQExpBuffer();
3241  BlobInfo *binfo;
3242  DumpableObject *bdata;
3243  PGresult *res;
3244  int ntups;
3245  int i;
3246  int i_oid;
3247  int i_lomowner;
3248  int i_lomacl;
3249  int i_rlomacl;
3250  int i_initlomacl;
3251  int i_initrlomacl;
3252 
3253  pg_log_info("reading large objects");
3254 
3255  /* Fetch BLOB OIDs, and owner/ACL data if >= 9.0 */
3256  if (fout->remoteVersion >= 90600)
3257  {
3258  PQExpBuffer acl_subquery = createPQExpBuffer();
3259  PQExpBuffer racl_subquery = createPQExpBuffer();
3260  PQExpBuffer init_acl_subquery = createPQExpBuffer();
3261  PQExpBuffer init_racl_subquery = createPQExpBuffer();
3262 
3263  buildACLQueries(acl_subquery, racl_subquery, init_acl_subquery,
3264  init_racl_subquery, "l.lomacl", "l.lomowner", "'L'",
3265  dopt->binary_upgrade);
3266 
3267  appendPQExpBuffer(blobQry,
3268  "SELECT l.oid, (%s l.lomowner) AS rolname, "
3269  "%s AS lomacl, "
3270  "%s AS rlomacl, "
3271  "%s AS initlomacl, "
3272  "%s AS initrlomacl "
3273  "FROM pg_largeobject_metadata l "
3274  "LEFT JOIN pg_init_privs pip ON "
3275  "(l.oid = pip.objoid "
3276  "AND pip.classoid = 'pg_largeobject'::regclass "
3277  "AND pip.objsubid = 0) ",
3278  username_subquery,
3279  acl_subquery->data,
3280  racl_subquery->data,
3281  init_acl_subquery->data,
3282  init_racl_subquery->data);
3283 
3284  destroyPQExpBuffer(acl_subquery);
3285  destroyPQExpBuffer(racl_subquery);
3286  destroyPQExpBuffer(init_acl_subquery);
3287  destroyPQExpBuffer(init_racl_subquery);
3288  }
3289  else if (fout->remoteVersion >= 90000)
3290  appendPQExpBuffer(blobQry,
3291  "SELECT oid, (%s lomowner) AS rolname, lomacl, "
3292  "NULL AS rlomacl, NULL AS initlomacl, "
3293  "NULL AS initrlomacl "
3294  " FROM pg_largeobject_metadata",
3295  username_subquery);
3296  else
3297  appendPQExpBufferStr(blobQry,
3298  "SELECT DISTINCT loid AS oid, "
3299  "NULL::name AS rolname, NULL::oid AS lomacl, "
3300  "NULL::oid AS rlomacl, NULL::oid AS initlomacl, "
3301  "NULL::oid AS initrlomacl "
3302  " FROM pg_largeobject");
3303 
3304  res = ExecuteSqlQuery(fout, blobQry->data, PGRES_TUPLES_OK);
3305 
3306  i_oid = PQfnumber(res, "oid");
3307  i_lomowner = PQfnumber(res, "rolname");
3308  i_lomacl = PQfnumber(res, "lomacl");
3309  i_rlomacl = PQfnumber(res, "rlomacl");
3310  i_initlomacl = PQfnumber(res, "initlomacl");
3311  i_initrlomacl = PQfnumber(res, "initrlomacl");
3312 
3313  ntups = PQntuples(res);
3314 
3315  /*
3316  * Each large object has its own BLOB archive entry.
3317  */
3318  binfo = (BlobInfo *) pg_malloc(ntups * sizeof(BlobInfo));
3319 
3320  for (i = 0; i < ntups; i++)
3321  {
3322  binfo[i].dobj.objType = DO_BLOB;
3323  binfo[i].dobj.catId.tableoid = LargeObjectRelationId;
3324  binfo[i].dobj.catId.oid = atooid(PQgetvalue(res, i, i_oid));
3325  AssignDumpId(&binfo[i].dobj);
3326 
3327  binfo[i].dobj.name = pg_strdup(PQgetvalue(res, i, i_oid));
3328  binfo[i].rolname = pg_strdup(PQgetvalue(res, i, i_lomowner));
3329  binfo[i].blobacl = pg_strdup(PQgetvalue(res, i, i_lomacl));
3330  binfo[i].rblobacl = pg_strdup(PQgetvalue(res, i, i_rlomacl));
3331  binfo[i].initblobacl = pg_strdup(PQgetvalue(res, i, i_initlomacl));
3332  binfo[i].initrblobacl = pg_strdup(PQgetvalue(res, i, i_initrlomacl));
3333 
3334  if (PQgetisnull(res, i, i_lomacl) &&
3335  PQgetisnull(res, i, i_rlomacl) &&
3336  PQgetisnull(res, i, i_initlomacl) &&
3337  PQgetisnull(res, i, i_initrlomacl))
3338  binfo[i].dobj.dump &= ~DUMP_COMPONENT_ACL;
3339 
3340  /*
3341  * In binary-upgrade mode for blobs, we do *not* dump out the blob
3342  * data, as it will be copied by pg_upgrade, which simply copies the
3343  * pg_largeobject table. We *do* however dump out anything but the
3344  * data, as pg_upgrade copies just pg_largeobject, but not
3345  * pg_largeobject_metadata, after the dump is restored.
3346  */
3347  if (dopt->binary_upgrade)
3348  binfo[i].dobj.dump &= ~DUMP_COMPONENT_DATA;
3349  }
3350 
3351  /*
3352  * If we have any large objects, a "BLOBS" archive entry is needed. This
3353  * is just a placeholder for sorting; it carries no data now.
3354  */
3355  if (ntups > 0)
3356  {
3357  bdata = (DumpableObject *) pg_malloc(sizeof(DumpableObject));
3358  bdata->objType = DO_BLOB_DATA;
3359  bdata->catId = nilCatalogId;
3360  AssignDumpId(bdata);
3361  bdata->name = pg_strdup("BLOBS");
3362  }
3363 
3364  PQclear(res);
3365  destroyPQExpBuffer(blobQry);
3366 }
3367 
3368 /*
3369  * dumpBlob
3370  *
3371  * dump the definition (metadata) of the given large object
3372  */
3373 static void
3374 dumpBlob(Archive *fout, BlobInfo *binfo)
3375 {
3376  PQExpBuffer cquery = createPQExpBuffer();
3377  PQExpBuffer dquery = createPQExpBuffer();
3378 
3379  appendPQExpBuffer(cquery,
3380  "SELECT pg_catalog.lo_create('%s');\n",
3381  binfo->dobj.name);
3382 
3383  appendPQExpBuffer(dquery,
3384  "SELECT pg_catalog.lo_unlink('%s');\n",
3385  binfo->dobj.name);
3386 
3387  if (binfo->dobj.dump & DUMP_COMPONENT_DEFINITION)
3388  ArchiveEntry(fout, binfo->dobj.catId, binfo->dobj.dumpId,
3389  ARCHIVE_OPTS(.tag = binfo->dobj.name,
3390  .owner = binfo->rolname,
3391  .description = "BLOB",
3392  .section = SECTION_PRE_DATA,
3393  .createStmt = cquery->data,
3394  .dropStmt = dquery->data));
3395 
3396  /* Dump comment if any */
3397  if (binfo->dobj.dump & DUMP_COMPONENT_COMMENT)
3398  dumpComment(fout, "LARGE OBJECT", binfo->dobj.name,
3399  NULL, binfo->rolname,
3400  binfo->dobj.catId, 0, binfo->dobj.dumpId);
3401 
3402  /* Dump security label if any */
3403  if (binfo->dobj.dump & DUMP_COMPONENT_SECLABEL)
3404  dumpSecLabel(fout, "LARGE OBJECT", binfo->dobj.name,
3405  NULL, binfo->rolname,
3406  binfo->dobj.catId, 0, binfo->dobj.dumpId);
3407 
3408  /* Dump ACL if any */
3409  if (binfo->blobacl && (binfo->dobj.dump & DUMP_COMPONENT_ACL))
3410  dumpACL(fout, binfo->dobj.catId, binfo->dobj.dumpId, "LARGE OBJECT",
3411  binfo->dobj.name, NULL,
3412  NULL, binfo->rolname, binfo->blobacl, binfo->rblobacl,
3413  binfo->initblobacl, binfo->initrblobacl);
3414 
3415  destroyPQExpBuffer(cquery);
3416  destroyPQExpBuffer(dquery);
3417 }
3418 
3419 /*
3420  * dumpBlobs:
3421  * dump the data contents of all large objects
3422  */
3423 static int
3424 dumpBlobs(Archive *fout, void *arg)
3425 {
3426  const char *blobQry;
3427  const char *blobFetchQry;
3428  PGconn *conn = GetConnection(fout);
3429  PGresult *res;
3430  char buf[LOBBUFSIZE];
3431  int ntups;
3432  int i;
3433  int cnt;
3434 
3435  pg_log_info("saving large objects");
3436 
3437  /*
3438  * Currently, we re-fetch all BLOB OIDs using a cursor. Consider scanning
3439  * the already-in-memory dumpable objects instead...
3440  */
3441  if (fout->remoteVersion >= 90000)
3442  blobQry =
3443  "DECLARE bloboid CURSOR FOR "
3444  "SELECT oid FROM pg_largeobject_metadata ORDER BY 1";
3445  else
3446  blobQry =
3447  "DECLARE bloboid CURSOR FOR "
3448  "SELECT DISTINCT loid FROM pg_largeobject ORDER BY 1";
3449 
3450  ExecuteSqlStatement(fout, blobQry);
3451 
3452  /* Command to fetch from cursor */
3453  blobFetchQry = "FETCH 1000 IN bloboid";
3454 
3455  do
3456  {
3457  /* Do a fetch */
3458  res = ExecuteSqlQuery(fout, blobFetchQry, PGRES_TUPLES_OK);
3459 
3460  /* Process the tuples, if any */
3461  ntups = PQntuples(res);
3462  for (i = 0; i < ntups; i++)
3463  {
3464  Oid blobOid;
3465  int loFd;
3466 
3467  blobOid = atooid(PQgetvalue(res, i, 0));
3468  /* Open the BLOB */
3469  loFd = lo_open(conn, blobOid, INV_READ);
3470  if (loFd == -1)
3471  fatal("could not open large object %u: %s",
3472  blobOid, PQerrorMessage(conn));
3473 
3474  StartBlob(fout, blobOid);
3475 
3476  /* Now read it in chunks, sending data to archive */
3477  do
3478  {
3479  cnt = lo_read(conn, loFd, buf, LOBBUFSIZE);
3480  if (cnt < 0)
3481  fatal("error reading large object %u: %s",
3482  blobOid, PQerrorMessage(conn));
3483 
3484  WriteData(fout, buf, cnt);
3485  } while (cnt > 0);
3486 
3487  lo_close(conn, loFd);
3488 
3489  EndBlob(fout, blobOid);
3490  }
3491 
3492  PQclear(res);
3493  } while (ntups > 0);
3494 
3495  return 1;
3496 }
3497 
3498 /*
3499  * getPolicies
3500  * get information about policies on a dumpable table.
3501  */
3502 void
3503 getPolicies(Archive *fout, TableInfo tblinfo[], int numTables)
3504 {
3505  PQExpBuffer query;
3506  PGresult *res;
3507  PolicyInfo *polinfo;
3508  int i_oid;
3509  int i_tableoid;
3510  int i_polname;
3511  int i_polcmd;
3512  int i_polpermissive;
3513  int i_polroles;
3514  int i_polqual;
3515  int i_polwithcheck;
3516  int i,
3517  j,
3518  ntups;
3519 
3520  if (fout->remoteVersion < 90500)
3521  return;
3522 
3523  query = createPQExpBuffer();
3524 
3525  for (i = 0; i < numTables; i++)
3526  {
3527  TableInfo *tbinfo = &tblinfo[i];
3528 
3529  /* Ignore row security on tables not to be dumped */
3530  if (!(tbinfo->dobj.dump & DUMP_COMPONENT_POLICY))
3531  continue;
3532 
3533  pg_log_info("reading row security enabled for table \"%s.%s\"",
3534  tbinfo->dobj.namespace->dobj.name,
3535  tbinfo->dobj.name);
3536 
3537  /*
3538  * Get row security enabled information for the table. We represent
3539  * RLS being enabled on a table by creating a PolicyInfo object with
3540  * null polname.
3541  */
3542  if (tbinfo->rowsec)
3543  {
3544  /*
3545  * Note: use tableoid 0 so that this object won't be mistaken for
3546  * something that pg_depend entries apply to.
3547  */
3548  polinfo = pg_malloc(sizeof(PolicyInfo));
3549  polinfo->dobj.objType = DO_POLICY;
3550  polinfo->dobj.catId.tableoid = 0;
3551  polinfo->dobj.catId.oid = tbinfo->dobj.catId.oid;
3552  AssignDumpId(&polinfo->dobj);
3553  polinfo->dobj.namespace = tbinfo->dobj.namespace;
3554  polinfo->dobj.name = pg_strdup(tbinfo->dobj.name);
3555  polinfo->poltable = tbinfo;
3556  polinfo->polname = NULL;
3557  polinfo->polcmd = '\0';
3558  polinfo->polpermissive = 0;
3559  polinfo->polroles = NULL;
3560  polinfo->polqual = NULL;
3561  polinfo->polwithcheck = NULL;
3562  }
3563 
3564  pg_log_info("reading policies for table \"%s.%s\"",
3565  tbinfo->dobj.namespace->dobj.name,
3566  tbinfo->dobj.name);
3567 
3568  resetPQExpBuffer(query);
3569 
3570  /* Get the policies for the table. */
3571  if (fout->remoteVersion >= 100000)
3572  appendPQExpBuffer(query,
3573  "SELECT oid, tableoid, pol.polname, pol.polcmd, pol.polpermissive, "
3574  "CASE WHEN pol.polroles = '{0}' THEN NULL ELSE "
3575  " pg_catalog.array_to_string(ARRAY(SELECT pg_catalog.quote_ident(rolname) from pg_catalog.pg_roles WHERE oid = ANY(pol.polroles)), ', ') END AS polroles, "
3576  "pg_catalog.pg_get_expr(pol.polqual, pol.polrelid) AS polqual, "
3577  "pg_catalog.pg_get_expr(pol.polwithcheck, pol.polrelid) AS polwithcheck "
3578  "FROM pg_catalog.pg_policy pol "
3579  "WHERE polrelid = '%u'",
3580  tbinfo->dobj.catId.oid);
3581  else
3582  appendPQExpBuffer(query,
3583  "SELECT oid, tableoid, pol.polname, pol.polcmd, 't' as polpermissive, "
3584  "CASE WHEN pol.polroles = '{0}' THEN NULL ELSE "
3585  " pg_catalog.array_to_string(ARRAY(SELECT pg_catalog.quote_ident(rolname) from pg_catalog.pg_roles WHERE oid = ANY(pol.polroles)), ', ') END AS polroles, "
3586  "pg_catalog.pg_get_expr(pol.polqual, pol.polrelid) AS polqual, "
3587  "pg_catalog.pg_get_expr(pol.polwithcheck, pol.polrelid) AS polwithcheck "
3588  "FROM pg_catalog.pg_policy pol "
3589  "WHERE polrelid = '%u'",
3590  tbinfo->dobj.catId.oid);
3591  res = ExecuteSqlQuery(fout, query->data, PGRES_TUPLES_OK);
3592 
3593  ntups = PQntuples(res);
3594 
3595  if (ntups == 0)
3596  {
3597  /*
3598  * No explicit policies to handle (only the default-deny policy,
3599  * which is handled as part of the table definition). Clean up
3600  * and return.
3601  */
3602  PQclear(res);
3603  continue;
3604  }
3605 
3606  i_oid = PQfnumber(res, "oid");
3607  i_tableoid = PQfnumber(res, "tableoid");
3608  i_polname = PQfnumber(res, "polname");
3609  i_polcmd = PQfnumber(res, "polcmd");
3610  i_polpermissive = PQfnumber(res, "polpermissive");
3611  i_polroles = PQfnumber(res, "polroles");
3612  i_polqual = PQfnumber(res, "polqual");
3613  i_polwithcheck = PQfnumber(res, "polwithcheck");
3614 
3615  polinfo = pg_malloc(ntups * sizeof(PolicyInfo));
3616 
3617  for (j = 0; j < ntups; j++)
3618  {
3619  polinfo[j].dobj.objType = DO_POLICY;
3620  polinfo[j].dobj.catId.tableoid =
3621  atooid(PQgetvalue(res, j, i_tableoid));
3622  polinfo[j].dobj.catId.oid = atooid(PQgetvalue(res, j, i_oid));
3623  AssignDumpId(&polinfo[j].dobj);
3624  polinfo[j].dobj.namespace = tbinfo->dobj.namespace;
3625  polinfo[j].poltable = tbinfo;
3626  polinfo[j].polname = pg_strdup(PQgetvalue(res, j, i_polname));
3627  polinfo[j].dobj.name = pg_strdup(polinfo[j].polname);
3628 
3629  polinfo[j].polcmd = *(PQgetvalue(res, j, i_polcmd));
3630  polinfo[j].polpermissive = *(PQgetvalue(res, j, i_polpermissive)) == 't';
3631 
3632  if (PQgetisnull(res, j, i_polroles))
3633  polinfo[j].polroles = NULL;
3634  else
3635  polinfo[j].polroles = pg_strdup(PQgetvalue(res, j, i_polroles));
3636 
3637  if (PQgetisnull(res, j, i_polqual))
3638  polinfo[j].polqual = NULL;
3639  else
3640  polinfo[j].polqual = pg_strdup(PQgetvalue(res, j, i_polqual));
3641 
3642  if (PQgetisnull(res, j, i_polwithcheck))
3643  polinfo[j].polwithcheck = NULL;
3644  else
3645  polinfo[j].polwithcheck
3646  = pg_strdup(PQgetvalue(res, j, i_polwithcheck));
3647  }
3648  PQclear(res);
3649  }
3650  destroyPQExpBuffer(query);
3651 }
3652 
3653 /*
3654  * dumpPolicy
3655  * dump the definition of the given policy
3656  */
3657 static void
3658 dumpPolicy(Archive *fout, PolicyInfo *polinfo)
3659 {
3660  DumpOptions *dopt = fout->dopt;
3661  TableInfo *tbinfo = polinfo->poltable;
3662  PQExpBuffer query;
3663  PQExpBuffer delqry;
3664  const char *cmd;
3665  char *tag;
3666 
3667  if (dopt->dataOnly)
3668  return;
3669 
3670  /*
3671  * If polname is NULL, then this record is just indicating that ROW LEVEL
3672  * SECURITY is enabled for the table. Dump as ALTER TABLE <table> ENABLE
3673  * ROW LEVEL SECURITY.
3674  */
3675  if (polinfo->polname == NULL)
3676  {
3677  query = createPQExpBuffer();
3678 
3679  appendPQExpBuffer(query, "ALTER TABLE %s ENABLE ROW LEVEL SECURITY;",
3680  fmtQualifiedDumpable(tbinfo));
3681 
3682  /*
3683  * We must emit the ROW SECURITY object's dependency on its table
3684  * explicitly, because it will not match anything in pg_depend (unlike
3685  * the case for other PolicyInfo objects).
3686  */
3687  if (polinfo->dobj.dump & DUMP_COMPONENT_POLICY)
3688  ArchiveEntry(fout, polinfo->dobj.catId, polinfo->dobj.dumpId,
3689  ARCHIVE_OPTS(.tag = polinfo->dobj.name,
3690  .namespace = polinfo->dobj.namespace->dobj.name,
3691  .owner = tbinfo->rolname,
3692  .description = "ROW SECURITY",
3693  .section = SECTION_POST_DATA,
3694  .createStmt = query->data,
3695  .deps = &(tbinfo->dobj.dumpId),
3696  .nDeps = 1));
3697 
3698  destroyPQExpBuffer(query);
3699  return;
3700  }
3701 
3702  if (polinfo->polcmd == '*')
3703  cmd = "";
3704  else if (polinfo->polcmd == 'r')
3705  cmd = " FOR SELECT";
3706  else if (polinfo->polcmd == 'a')
3707  cmd = " FOR INSERT";
3708  else if (polinfo->polcmd == 'w')
3709  cmd = " FOR UPDATE";
3710  else if (polinfo->polcmd == 'd')
3711  cmd = " FOR DELETE";
3712  else
3713  {
3714  pg_log_error("unexpected policy command type: %c",
3715  polinfo->polcmd);
3716  exit_nicely(1);
3717  }
3718 
3719  query = createPQExpBuffer();
3720  delqry = createPQExpBuffer();
3721 
3722  appendPQExpBuffer(query, "CREATE POLICY %s", fmtId(polinfo->polname));
3723 
3724  appendPQExpBuffer(query, " ON %s%s%s", fmtQualifiedDumpable(tbinfo),
3725  !polinfo->polpermissive ? " AS RESTRICTIVE" : "", cmd);
3726 
3727  if (polinfo->polroles != NULL)
3728  appendPQExpBuffer(query, " TO %s", polinfo->polroles);
3729 
3730  if (polinfo->polqual != NULL)
3731  appendPQExpBuffer(query, " USING (%s)", polinfo->polqual);
3732 
3733  if (polinfo->polwithcheck != NULL)
3734  appendPQExpBuffer(query, " WITH CHECK (%s)", polinfo->polwithcheck);
3735 
3736  appendPQExpBufferStr(query, ";\n");
3737 
3738  appendPQExpBuffer(delqry, "DROP POLICY %s", fmtId(polinfo->polname));
3739  appendPQExpBuffer(delqry, " ON %s;\n", fmtQualifiedDumpable(tbinfo));
3740 
3741  tag = psprintf("%s %s", tbinfo->dobj.name, polinfo->dobj.name);
3742 
3743  if (polinfo->dobj.dump & DUMP_COMPONENT_POLICY)
3744  ArchiveEntry(fout, polinfo->dobj.catId, polinfo->dobj.dumpId,
3745  ARCHIVE_OPTS(.tag = tag,
3746  .namespace = polinfo->dobj.namespace->dobj.name,
3747  .owner = tbinfo->rolname,
3748  .description = "POLICY",
3749  .section = SECTION_POST_DATA,
3750  .createStmt = query->data,
3751  .dropStmt = delqry->data));
3752 
3753  free(tag);
3754  destroyPQExpBuffer(query);
3755  destroyPQExpBuffer(delqry);
3756 }
3757 
3758 /*
3759  * getPublications
3760  * get information about publications
3761  */
3762 void
3763 getPublications(Archive *fout)
3764 {
3765  DumpOptions *dopt = fout->dopt;
3766  PQExpBuffer query;
3767  PGresult *res;
3768  PublicationInfo *pubinfo;
3769  int i_tableoid;
3770  int i_oid;
3771  int i_pubname;
3772  int i_rolname;
3773  int i_puballtables;
3774  int i_pubinsert;
3775  int i_pubupdate;
3776  int i_pubdelete;
3777  int i_pubtruncate;
3778  int i,
3779  ntups;
3780 
3781  if (dopt->no_publications || fout->remoteVersion < 100000)
3782  return;
3783 
3784  query = createPQExpBuffer();
3785 
3786  resetPQExpBuffer(query);
3787 
3788  /* Get the publications. */
3789  if (fout->remoteVersion >= 110000)
3790  appendPQExpBuffer(query,
3791  "SELECT p.tableoid, p.oid, p.pubname, "
3792  "(%s p.pubowner) AS rolname, "
3793  "p.puballtables, p.pubinsert, p.pubupdate, p.pubdelete, p.pubtruncate "
3794  "FROM pg_publication p",
3795  username_subquery);
3796  else
3797  appendPQExpBuffer(query,
3798  "SELECT p.tableoid, p.oid, p.pubname, "
3799  "(%s p.pubowner) AS rolname, "
3800  "p.puballtables, p.pubinsert, p.pubupdate, p.pubdelete, false AS pubtruncate "
3801  "FROM pg_publication p",
3802  username_subquery);
3803 
3804  res = ExecuteSqlQuery(fout, query->data, PGRES_TUPLES_OK);
3805 
3806  ntups = PQntuples(res);
3807 
3808  i_tableoid = PQfnumber(res, "tableoid");
3809  i_oid = PQfnumber(res, "oid");
3810  i_pubname = PQfnumber(res, "pubname");
3811  i_rolname = PQfnumber(res, "rolname");
3812  i_puballtables = PQfnumber(res, "puballtables");
3813  i_pubinsert = PQfnumber(res, "pubinsert");
3814  i_pubupdate = PQfnumber(res, "pubupdate");
3815  i_pubdelete = PQfnumber(res, "pubdelete");
3816  i_pubtruncate = PQfnumber(res, "pubtruncate");
3817 
3818  pubinfo = pg_malloc(ntups * sizeof(PublicationInfo));
3819 
3820  for (i = 0; i < ntups; i++)
3821  {
3822  pubinfo[i].dobj.objType = DO_PUBLICATION;
3823  pubinfo[i].dobj.catId.tableoid =
3824  atooid(PQgetvalue(res, i, i_tableoid));
3825  pubinfo[i].dobj.catId.oid = atooid(PQgetvalue(res, i, i_oid));
3826  AssignDumpId(&pubinfo[i].dobj);
3827  pubinfo[i].dobj.name = pg_strdup(PQgetvalue(res, i, i_pubname));
3828  pubinfo[i].rolname = pg_strdup(PQgetvalue(res, i, i_rolname));
3829  pubinfo[i].puballtables =
3830  (strcmp(PQgetvalue(res, i, i_puballtables), "t") == 0);
3831  pubinfo[i].pubinsert =
3832  (strcmp(PQgetvalue(res, i, i_pubinsert), "t") == 0);
3833  pubinfo[i].pubupdate =
3834  (strcmp(PQgetvalue(res, i, i_pubupdate), "t") == 0);
3835  pubinfo[i].pubdelete =
3836  (strcmp(PQgetvalue(res, i, i_pubdelete), "t") == 0);
3837  pubinfo[i].pubtruncate =
3838  (strcmp(PQgetvalue(res, i, i_pubtruncate), "t") == 0);
3839 
3840  if (strlen(pubinfo[i].rolname) == 0)
3841  pg_log_warning("owner of publication \"%s\" appears to be invalid",
3842  pubinfo[i].dobj.name);
3843 
3844  /* Decide whether we want to dump it */
3845  selectDumpableObject(&(pubinfo[i].dobj), fout);
3846  }
3847  PQclear(res);
3848 
3849  destroyPQExpBuffer(query);
3850 }
3851 
3852 /*
3853  * dumpPublication
3854  * dump the definition of the given publication
3855  */
3856 static void
3857 dumpPublication(Archive *fout, PublicationInfo *pubinfo)
3858 {
3859  PQExpBuffer delq;
3860  PQExpBuffer query;
3861  char *qpubname;
3862  bool first = true;
3863 
3864  if (!(pubinfo->dobj.dump & DUMP_COMPONENT_DEFINITION))
3865  return;
3866 
3867  delq = createPQExpBuffer();
3868  query = createPQExpBuffer();
3869 
3870  qpubname = pg_strdup(fmtId(pubinfo->dobj.name));
3871 
3872  appendPQExpBuffer(delq, "DROP PUBLICATION %s;\n",
3873  qpubname);
3874 
3875  appendPQExpBuffer(query, "CREATE PUBLICATION %s",
3876  qpubname);
3877 
3878  if (pubinfo->puballtables)
3879  appendPQExpBufferStr(query, " FOR ALL TABLES");
3880 
3881  appendPQExpBufferStr(query, " WITH (publish = '");
3882  if (pubinfo->pubinsert)
3883  {
3884  appendPQExpBufferStr(query, "insert");
3885  first = false;
3886  }
3887 
3888  if (pubinfo->pubupdate)
3889  {
3890  if (!first)
3891  appendPQExpBufferStr(query, ", ");
3892 
3893  appendPQExpBufferStr(query, "update");
3894  first = false;
3895  }
3896 
3897  if (pubinfo->pubdelete)
3898  {
3899  if (!first)
3900  appendPQExpBufferStr(query, ", ");
3901 
3902  appendPQExpBufferStr(query, "delete");
3903  first = false;
3904  }
3905 
3906  if (pubinfo->pubtruncate)
3907  {
3908  if (!first)
3909  appendPQExpBufferStr(query, ", ");
3910 
3911  appendPQExpBufferStr(query, "truncate");
3912  first = false;
3913  }
3914 
3915  appendPQExpBufferStr(query, "');\n");
3916 
3917  ArchiveEntry(fout, pubinfo->dobj.catId, pubinfo->dobj.dumpId,
3918  ARCHIVE_OPTS(.tag = pubinfo->dobj.name,
3919  .owner = pubinfo->rolname,
3920  .description = "PUBLICATION",
3921  .section = SECTION_POST_DATA,
3922  .createStmt = query->data,
3923  .dropStmt = delq->data));
3924 
3925  if (pubinfo->dobj.dump & DUMP_COMPONENT_COMMENT)
3926  dumpComment(fout, "PUBLICATION", qpubname,
3927  NULL, pubinfo->rolname,
3928  pubinfo->dobj.catId, 0, pubinfo->dobj.dumpId);
3929 
3930  if (pubinfo->dobj.dump & DUMP_COMPONENT_SECLABEL)
3931  dumpSecLabel(fout, "PUBLICATION", qpubname,
3932  NULL, pubinfo->rolname,
3933  pubinfo->dobj.catId, 0, pubinfo->dobj.dumpId);
3934 
3935  destroyPQExpBuffer(delq);
3936  destroyPQExpBuffer(query);
3937  free(qpubname);
3938 }
3939 
3940 /*
3941  * getPublicationTables
3942  * get information about publication membership for dumpable tables.
3943  */
3944 void
3945 getPublicationTables(Archive *fout, TableInfo tblinfo[], int numTables)
3946 {
3947  PQExpBuffer query;
3948  PGresult *res;
3949  PublicationRelInfo *pubrinfo;
3950  DumpOptions *dopt = fout->dopt;
3951  int i_tableoid;
3952  int i_oid;
3953  int i_pubname;
3954  int i,
3955  j,
3956  ntups;
3957 
3958  if (dopt->no_publications || fout->remoteVersion < 100000)
3959  return;
3960 
3961  query = createPQExpBuffer();
3962 
3963  for (i = 0; i < numTables; i++)
3964  {
3965  TableInfo *tbinfo = &tblinfo[i];
3966 
3967  /* Only plain tables can be aded to publications. */
3968  if (tbinfo->relkind != RELKIND_RELATION)
3969  continue;
3970 
3971  /*
3972  * Ignore publication membership of tables whose definitions are not
3973  * to be dumped.
3974  */
3975  if (!(tbinfo->dobj.dump & DUMP_COMPONENT_DEFINITION))
3976  continue;
3977 
3978  pg_log_info("reading publication membership for table \"%s.%s\"",
3979  tbinfo->dobj.namespace->dobj.name,
3980  tbinfo->dobj.name);
3981 
3982  resetPQExpBuffer(query);
3983 
3984  /* Get the publication membership for the table. */
3985  appendPQExpBuffer(query,
3986  "SELECT pr.tableoid, pr.oid, p.pubname "
3987  "FROM pg_publication_rel pr, pg_publication p "
3988  "WHERE pr.prrelid = '%u'"
3989  " AND p.oid = pr.prpubid",
3990  tbinfo->dobj.catId.oid);
3991  res = ExecuteSqlQuery(fout, query->data, PGRES_TUPLES_OK);
3992 
3993  ntups = PQntuples(res);
3994 
3995  if (ntups == 0)
3996  {
3997  /*
3998  * Table is not member of any publications. Clean up and return.
3999  */
4000  PQclear(res);
4001  continue;
4002  }
4003 
4004  i_tableoid = PQfnumber(res, "tableoid");
4005  i_oid = PQfnumber(res, "oid");
4006  i_pubname = PQfnumber(res, "pubname");
4007 
4008  pubrinfo = pg_malloc(ntups * sizeof(PublicationRelInfo));
4009 
4010  for (j = 0; j < ntups; j++)
4011  {
4012  pubrinfo[j].dobj.objType = DO_PUBLICATION_REL;
4013  pubrinfo[j].dobj.catId.tableoid =
4014  atooid(PQgetvalue(res, j, i_tableoid));
4015  pubrinfo[j].dobj.catId.oid = atooid(PQgetvalue(res, j, i_oid));
4016  AssignDumpId(&pubrinfo[j].dobj);
4017  pubrinfo[j].dobj.namespace = tbinfo->dobj.namespace;
4018  pubrinfo[j].dobj.name = tbinfo->dobj.name;
4019  pubrinfo[j].pubname = pg_strdup(PQgetvalue(res, j, i_pubname));
4020  pubrinfo[j].pubtable = tbinfo;
4021 
4022  /* Decide whether we want to dump it */
4023  selectDumpablePublicationTable(&(pubrinfo[j].dobj), fout);
4024  }
4025  PQclear(res);
4026  }
4027  destroyPQExpBuffer(query);
4028 }
4029 
4030 /*
4031  * dumpPublicationTable
4032  * dump the definition of the given publication table mapping
4033  */
4034 static void
4035 dumpPublicationTable(Archive *fout, PublicationRelInfo *pubrinfo)
4036 {
4037  TableInfo *tbinfo = pubrinfo->pubtable;
4038  PQExpBuffer query;
4039  char *tag;
4040 
4041  if (!(pubrinfo->dobj.dump & DUMP_COMPONENT_DEFINITION))
4042  return;
4043 
4044  tag = psprintf("%s %s", pubrinfo->pubname, tbinfo->dobj.name);
4045 
4046  query = createPQExpBuffer();
4047 
4048  appendPQExpBuffer(query, "ALTER PUBLICATION %s ADD TABLE ONLY",
4049  fmtId(pubrinfo->pubname));
4050  appendPQExpBuffer(query, " %s;\n",
4051  fmtQualifiedDumpable(tbinfo));
4052 
4053  /*
4054  * There is no point in creating drop query as the drop is done by table
4055  * drop.
4056  */
4057  ArchiveEntry(fout, pubrinfo->dobj.catId, pubrinfo->dobj.dumpId,
4058  ARCHIVE_OPTS(.tag = tag,
4059  .namespace = tbinfo->dobj.namespace->dobj.name,
4060  .description = "PUBLICATION TABLE",
4061  .section = SECTION_POST_DATA,
4062  .createStmt = query->data));
4063 
4064  free(tag);
4065  destroyPQExpBuffer(query);
4066 }
4067 
4068 /*
4069  * Is the currently connected user a superuser?
4070  */
4071 static bool
4072 is_superuser(Archive *fout)
4073 {
4074  ArchiveHandle *AH = (ArchiveHandle *) fout;
4075  const char *val;
4076 
4077  val = PQparameterStatus(AH->connection, "is_superuser");
4078 
4079  if (val && strcmp(val, "on") == 0)
4080  return true;
4081 
4082  return false;
4083 }
4084 
4085 /*
4086  * getSubscriptions
4087  * get information about subscriptions
4088  */
4089 void
4090 getSubscriptions(Archive *fout)
4091 {
4092  DumpOptions *dopt = fout->dopt;
4093  PQExpBuffer query;
4094  PGresult *res;
4095  SubscriptionInfo *subinfo;
4096  int i_tableoid;
4097  int i_oid;
4098  int i_subname;
4099  int i_rolname;
4100  int i_subconninfo;
4101  int i_subslotname;
4102  int i_subsynccommit;
4103  int i_subpublications;
4104  int i,
4105  ntups;
4106 
4107  if (dopt->no_subscriptions || fout->remoteVersion < 100000)
4108  return;
4109 
4110  if (!is_superuser(fout))
4111  {
4112  int n;
4113 
4114  res = ExecuteSqlQuery(fout,
4115  "SELECT count(*) FROM pg_subscription "
4116  "WHERE subdbid = (SELECT oid FROM pg_database"
4117  " WHERE datname = current_database())",
4118  PGRES_TUPLES_OK);
4119  n = atoi(PQgetvalue(res, 0, 0));
4120  if (n > 0)
4121  pg_log_warning("subscriptions not dumped because current user is not a superuser");
4122  PQclear(res);
4123  return;
4124  }
4125 
4126  query = createPQExpBuffer();
4127 
4128  resetPQExpBuffer(query);
4129 
4130  /* Get the subscriptions in current database. */
4131  appendPQExpBuffer(query,
4132  "SELECT s.tableoid, s.oid, s.subname,"
4133  "(%s s.subowner) AS rolname, "
4134  " s.subconninfo, s.subslotname, s.subsynccommit, "
4135  " s.subpublications "
4136  "FROM pg_subscription s "
4137  "WHERE s.subdbid = (SELECT oid FROM pg_database"
4138  " WHERE datname = current_database())",
4139  username_subquery);
4140  res = ExecuteSqlQuery(fout, query->data, PGRES_TUPLES_OK);
4141 
4142  ntups = PQntuples(res);
4143 
4144  i_tableoid = PQfnumber(res, "tableoid");
4145  i_oid = PQfnumber(res, "oid");
4146  i_subname = PQfnumber(res, "subname");
4147  i_rolname = PQfnumber(res, "rolname");
4148  i_subconninfo = PQfnumber(res, "subconninfo");
4149  i_subslotname = PQfnumber(res, "subslotname");
4150  i_subsynccommit = PQfnumber(res, "subsynccommit");
4151  i_subpublications = PQfnumber(res, "subpublications");
4152 
4153  subinfo = pg_malloc(ntups * sizeof(SubscriptionInfo));
4154 
4155  for (i = 0; i < ntups; i++)
4156  {
4157  subinfo[i].dobj.objType = DO_SUBSCRIPTION;
4158  subinfo[i].dobj.catId.tableoid =
4159  atooid(PQgetvalue(res, i, i_tableoid));
4160  subinfo[i].dobj.catId.oid = atooid(PQgetvalue(res, i, i_oid));
4161  AssignDumpId(&subinfo[i].dobj);
4162  subinfo[i].dobj.name = pg_strdup(PQgetvalue(res, i, i_subname));
4163  subinfo[i].rolname = pg_strdup(PQgetvalue(res, i, i_rolname));
4164  subinfo[i].subconninfo = pg_strdup(PQgetvalue(res, i, i_subconninfo));
4165  if (PQgetisnull(res, i, i_subslotname))
4166  subinfo[i].subslotname = NULL;
4167  else
4168  subinfo[i].subslotname = pg_strdup(PQgetvalue(res, i, i_subslotname));
4169  subinfo[i].subsynccommit =
4170  pg_strdup(PQgetvalue(res, i, i_subsynccommit));
4171  subinfo[i].subpublications =
4172  pg_strdup(PQgetvalue(res, i, i_subpublications));
4173 
4174  if (strlen(subinfo[i].rolname) == 0)
4175  pg_log_warning("owner of subscription \"%s\" appears to be invalid",
4176  subinfo[i].dobj.name);
4177 
4178  /* Decide whether we want to dump it */
4179  selectDumpableObject(&(subinfo[i].dobj), fout);
4180  }
4181  PQclear(res);
4182 
4183  destroyPQExpBuffer(query);
4184 }
4185 
4186 /*
4187  * dumpSubscription
4188  * dump the definition of the given subscription
4189  */
4190 static void
4191 dumpSubscription(Archive *fout, SubscriptionInfo *subinfo)
4192 {
4193  PQExpBuffer delq;
4194  PQExpBuffer query;
4195  PQExpBuffer publications;
4196  char *qsubname;
4197  char **pubnames = NULL;
4198  int npubnames = 0;
4199  int i;
4200 
4201  if (!(subinfo->dobj.dump & DUMP_COMPONENT_DEFINITION))
4202  return;
4203 
4204  delq = createPQExpBuffer();
4205  query = createPQExpBuffer();
4206 
4207  qsubname = pg_strdup(fmtId(subinfo->dobj.name));
4208 
4209  appendPQExpBuffer(delq, "DROP SUBSCRIPTION %s;\n",
4210  qsubname);
4211 
4212  appendPQExpBuffer(query, "CREATE SUBSCRIPTION %s CONNECTION ",
4213  qsubname);
4214  appendStringLiteralAH(query, subinfo->subconninfo, fout);
4215 
4216  /* Build list of quoted publications and append them to query. */
4217  if (!parsePGArray(subinfo->subpublications, &pubnames, &npubnames))
4218  {
4219  pg_log_warning("could not parse subpublications array");
4220  if (pubnames)
4221  free(pubnames);
4222  pubnames = NULL;
4223  npubnames = 0;
4224  }
4225 
4226  publications = createPQExpBuffer();
4227  for (i = 0; i < npubnames; i++)
4228  {
4229  if (i > 0)
4230  appendPQExpBufferStr(publications, ", ");
4231 
4232  appendPQExpBufferStr(publications, fmtId(pubnames[i]));
4233  }
4234 
4235  appendPQExpBuffer(query, " PUBLICATION %s WITH (connect = false, slot_name = ", publications->data);
4236  if (subinfo->subslotname)
4237  appendStringLiteralAH(query, subinfo->subslotname, fout);
4238  else
4239  appendPQExpBufferStr(query, "NONE");
4240 
4241  if (strcmp(subinfo->subsynccommit, "off") != 0)
4242  appendPQExpBuffer(query, ", synchronous_commit = %s", fmtId(subinfo->subsynccommit));
4243 
4244  appendPQExpBufferStr(query, ");\n");
4245 
4246  ArchiveEntry(fout, subinfo->dobj.catId, subinfo->dobj.dumpId,
4247  ARCHIVE_OPTS(.tag = subinfo->dobj.name,
4248  .owner = subinfo->rolname,
4249  .description = "SUBSCRIPTION",
4250  .section = SECTION_POST_DATA,
4251  .createStmt = query->data,
4252  .dropStmt = delq->data));
4253 
4254  if (subinfo->dobj.dump & DUMP_COMPONENT_COMMENT)
4255  dumpComment(fout, "SUBSCRIPTION", qsubname,
4256  NULL, subinfo->rolname,
4257  subinfo->dobj.catId, 0, subinfo->dobj.dumpId);
4258 
4259  if (subinfo->dobj.dump & DUMP_COMPONENT_SECLABEL)
4260  dumpSecLabel(fout, "SUBSCRIPTION", qsubname,
4261  NULL, subinfo->rolname,
4262  subinfo->dobj.catId, 0, subinfo->dobj.dumpId);
4263 
4264  destroyPQExpBuffer(publications);
4265  if (pubnames)
4266  free(pubnames);
4267 
4268  destroyPQExpBuffer(delq);
4269  destroyPQExpBuffer(query);
4270  free(qsubname);
4271 }
4272 
4273 static void
4274 binary_upgrade_set_type_oids_by_type_oid(Archive *fout,
4275  PQExpBuffer upgrade_buffer,
4276  Oid pg_type_oid,
4277  bool force_array_type)
4278 {
4279  PQExpBuffer upgrade_query = createPQExpBuffer();
4280  PGresult *res;
4281  Oid pg_type_array_oid;
4282 
4283  appendPQExpBufferStr(upgrade_buffer, "\n-- For binary upgrade, must preserve pg_type oid\n");
4284  appendPQExpBuffer(upgrade_buffer,
4285  "SELECT pg_catalog.binary_upgrade_set_next_pg_type_oid('%u'::pg_catalog.oid);\n\n",
4286  pg_type_oid);
4287 
4288  /* we only support old >= 8.3 for binary upgrades */
4289  appendPQExpBuffer(upgrade_query,
4290  "SELECT typarray "
4291  "FROM pg_catalog.pg_type "
4292  "WHERE oid = '%u'::pg_catalog.oid;",
4293  pg_type_oid);
4294 
4295  res = ExecuteSqlQueryForSingleRow(fout, upgrade_query->data);
4296 
4297  pg_type_array_oid = atooid(PQgetvalue(res, 0, PQfnumber(res, "typarray")));
4298 
4299  PQclear(res);
4300 
4301  if (!OidIsValid(pg_type_array_oid) && force_array_type)
4302  {
4303  /*
4304  * If the old version didn't assign an array type, but the new version
4305  * does, we must select an unused type OID to assign. This currently
4306  * only happens for domains, when upgrading pre-v11 to v11 and up.
4307  *
4308  * Note: local state here is kind of ugly, but we must have some,
4309  * since we mustn't choose the same unused OID more than once.
4310  */
4311  static Oid next_possible_free_oid = FirstNormalObjectId;
4312  bool is_dup;
4313 
4314  do
4315  {
4316  ++next_possible_free_oid;
4317  printfPQExpBuffer(upgrade_query,
4318  "SELECT EXISTS(SELECT 1 "
4319  "FROM pg_catalog.pg_type "
4320  "WHERE oid = '%u'::pg_catalog.oid);",
4321  next_possible_free_oid);
4322  res = ExecuteSqlQueryForSingleRow(fout, upgrade_query->data);
4323  is_dup = (PQgetvalue(res, 0, 0)[0] == 't');
4324  PQclear(res);
4325  } while (is_dup);
4326 
4327  pg_type_array_oid = next_possible_free_oid;
4328  }
4329 
4330  if (OidIsValid(pg_type_array_oid))
4331  {
4332  appendPQExpBufferStr(upgrade_buffer,
4333  "\n-- For binary upgrade, must preserve pg_type array oid\n");
4334  appendPQExpBuffer(upgrade_buffer,
4335  "SELECT pg_catalog.binary_upgrade_set_next_array_pg_type_oid('%u'::pg_catalog.oid);\n\n",
4336  pg_type_array_oid);
4337  }
4338 
4339  destroyPQExpBuffer(upgrade_query);
4340 }
4341 
4342 static bool
4343 binary_upgrade_set_type_oids_by_rel_oid(Archive *fout,
4344  PQExpBuffer upgrade_buffer,
4345  Oid pg_rel_oid)
4346 {
4347  PQExpBuffer upgrade_query = createPQExpBuffer();
4348  PGresult *upgrade_res;
4349  Oid pg_type_oid;
4350  bool toast_set = false;
4351 
4352  /*
4353  * We only support old >= 8.3 for binary upgrades.
4354  *
4355  * We purposefully ignore toast OIDs for partitioned tables; the reason is
4356  * that versions 10 and 11 have them, but 12 does not, so emitting them
4357  * causes the upgrade to fail.
4358  */
4359  appendPQExpBuffer(upgrade_query,
4360  "SELECT c.reltype AS crel, t.reltype AS trel "
4361  "FROM pg_catalog.pg_class c "
4362  "LEFT JOIN pg_catalog.pg_class t ON "
4363  " (c.reltoastrelid = t.oid AND c.relkind <> '%c') "
4364  "WHERE c.oid = '%u'::pg_catalog.oid;",
4365  RELKIND_PARTITIONED_TABLE, pg_rel_oid);
4366 
4367  upgrade_res = ExecuteSqlQueryForSingleRow(fout, upgrade_query->data);
4368 
4369  pg_type_oid = atooid(PQgetvalue(upgrade_res, 0, PQfnumber(upgrade_res, "crel")));
4370 
4371  binary_upgrade_set_type_oids_by_type_oid(fout, upgrade_buffer,
4372  pg_type_oid, false);
4373 
4374  if (!PQgetisnull(upgrade_res, 0, PQfnumber(upgrade_res, "trel")))
4375  {
4376  /* Toast tables do not have pg_type array rows */
4377  Oid pg_type_toast_oid = atooid(PQgetvalue(upgrade_res, 0,
4378  PQfnumber(upgrade_res, "trel")));
4379 
4380  appendPQExpBufferStr(upgrade_buffer, "\n-- For binary upgrade, must preserve pg_type toast oid\n");
4381  appendPQExpBuffer(upgrade_buffer,
4382  "SELECT pg_catalog.binary_upgrade_set_next_toast_pg_type_oid('%u'::pg_catalog.oid);\n\n",
4383  pg_type_toast_oid);
4384 
4385  toast_set = true;
4386  }
4387 
4388  PQclear(upgrade_res);
4389  destroyPQExpBuffer(upgrade_query);
4390 
4391  return toast_set;
4392 }
4393 
4394 static void
4395 binary_upgrade_set_pg_class_oids(Archive *fout,
4396  PQExpBuffer upgrade_buffer, Oid pg_class_oid,
4397  bool is_index)
4398 {
4399  PQExpBuffer upgrade_query = createPQExpBuffer();
4400  PGresult *upgrade_res;
4401  Oid pg_class_reltoastrelid;
4402  Oid pg_index_indexrelid;
4403 
4404  appendPQExpBuffer(upgrade_query,
4405  "SELECT c.reltoastrelid, i.indexrelid "
4406  "FROM pg_catalog.pg_class c LEFT JOIN "
4407  "pg_catalog.pg_index i ON (c.reltoastrelid = i.indrelid AND i.indisvalid) "
4408  "WHERE c.oid = '%u'::pg_catalog.oid;",
4409  pg_class_oid);
4410 
4411  upgrade_res = ExecuteSqlQueryForSingleRow(fout, upgrade_query->data);
4412 
4413  pg_class_reltoastrelid = atooid(PQgetvalue(upgrade_res, 0, PQfnumber(upgrade_res, "reltoastrelid")));
4414  pg_index_indexrelid = atooid(PQgetvalue(upgrade_res, 0, PQfnumber(upgrade_res, "indexrelid")));
4415 
4416  appendPQExpBufferStr(upgrade_buffer,
4417  "\n-- For binary upgrade, must preserve pg_class oids\n");
4418 
4419  if (!is_index)
4420  {
4421  appendPQExpBuffer(upgrade_buffer,
4422  "SELECT pg_catalog.binary_upgrade_set_next_heap_pg_class_oid('%u'::pg_catalog.oid);\n",
4423  pg_class_oid);
4424  /* only tables have toast tables, not indexes */
4425  if (OidIsValid(pg_class_reltoastrelid))
4426  {
4427  /*
4428  * One complexity is that the table definition might not require
4429  * the creation of a TOAST table, and the TOAST table might have
4430  * been created long after table creation, when the table was
4431  * loaded with wide data. By setting the TOAST oid we force
4432  * creation of the TOAST heap and TOAST index by the backend so we
4433  * can cleanly copy the files during binary upgrade.
4434  */
4435 
4436  appendPQExpBuffer(upgrade_buffer,
4437  "SELECT pg_catalog.binary_upgrade_set_next_toast_pg_class_oid('%u'::pg_catalog.oid);\n",
4438  pg_class_reltoastrelid);
4439 
4440  /* every toast table has an index */
4441  appendPQExpBuffer(upgrade_buffer,
4442  "SELECT pg_catalog.binary_upgrade_set_next_index_pg_class_oid('%u'::pg_catalog.oid);\n",
4443  pg_index_indexrelid);
4444  }
4445  }
4446  else
4447  appendPQExpBuffer(upgrade_buffer,
4448  "SELECT pg_catalog.binary_upgrade_set_next_index_pg_class_oid('%u'::pg_catalog.oid);\n",
4449  pg_class_oid);
4450 
4451  appendPQExpBufferChar(upgrade_buffer, '\n');
4452 
4453  PQclear(upgrade_res);
4454  destroyPQExpBuffer(upgrade_query);
4455 }
4456 
4457 /*
4458  * If the DumpableObject is a member of an extension, add a suitable
4459  * ALTER EXTENSION ADD command to the creation commands in upgrade_buffer.
4460  *
4461  * For somewhat historical reasons, objname should already be quoted,
4462  * but not objnamespace (if any).
4463  */
4464 static void
4465 binary_upgrade_extension_member(PQExpBuffer upgrade_buffer,
4466  DumpableObject *dobj,
4467  const char *objtype,
4468  const char *objname,
4469  const char *objnamespace)
4470 {
4471  DumpableObject *extobj = NULL;
4472  int i;
4473 
4474  if (!dobj->ext_member)
4475  return;
4476 
4477  /*
4478  * Find the parent extension. We could avoid this search if we wanted to
4479  * add a link field to DumpableObject, but the space costs of that would
4480  * be considerable. We assume that member objects could only have a
4481  * direct dependency on their own extension, not any others.
4482  */
4483  for (i = 0; i < dobj->nDeps; i++)
4484  {
4485  extobj = findObjectByDumpId(dobj->dependencies[i]);
4486  if (extobj && extobj->objType == DO_EXTENSION)
4487  break;
4488  extobj = NULL;
4489  }
4490  if (extobj == NULL)
4491  fatal("could not find parent extension for %s %s",
4492  objtype, objname);
4493 
4494  appendPQExpBufferStr(upgrade_buffer,
4495  "\n-- For binary upgrade, handle extension membership the hard way\n");
4496  appendPQExpBuffer(upgrade_buffer, "ALTER EXTENSION %s ADD %s ",
4497  fmtId(extobj->name),
4498  objtype);
4499  if (objnamespace && *objnamespace)
4500  appendPQExpBuffer(upgrade_buffer, "%s.", fmtId(objnamespace));
4501  appendPQExpBuffer(upgrade_buffer, "%s;\n", objname);
4502 }
4503 
4504 /*
4505  * getNamespaces:
4506  * read all namespaces in the system catalogs and return them in the
4507  * NamespaceInfo* structure
4508  *
4509  * numNamespaces is set to the number of namespaces read in
4510  */
4511 NamespaceInfo *
4512 getNamespaces(Archive *fout, int *numNamespaces)
4513 {
4514  DumpOptions *dopt = fout->dopt;
4515  PGresult *res;
4516  int ntups;
4517  int i;
4518  PQExpBuffer query;
4519  NamespaceInfo *nsinfo;
4520  int i_tableoid;
4521  int i_oid;
4522  int i_nspname;
4523  int i_rolname;
4524  int i_nspacl;
4525  int i_rnspacl;
4526  int i_initnspacl;
4527  int i_initrnspacl;
4528 
4529  query = createPQExpBuffer();
4530 
4531  /*
4532  * we fetch all namespaces including system ones, so that every object we
4533  * read in can be linked to a containing namespace.
4534  */
4535  if (fout->remoteVersion >= 90600)
4536  {
4537  PQExpBuffer acl_subquery = createPQExpBuffer();
4538  PQExpBuffer racl_subquery = createPQExpBuffer();
4539  PQExpBuffer init_acl_subquery = createPQExpBuffer();
4540  PQExpBuffer init_racl_subquery = createPQExpBuffer();
4541 
4542  buildACLQueries(acl_subquery, racl_subquery, init_acl_subquery,
4543  init_racl_subquery, "n.nspacl", "n.nspowner", "'n'",
4544  dopt->binary_upgrade);
4545 
4546  appendPQExpBuffer(query, "SELECT n.tableoid, n.oid, n.nspname, "
4547  "(%s nspowner) AS rolname, "
4548  "%s as nspacl, "
4549  "%s as rnspacl, "
4550  "%s as initnspacl, "
4551  "%s as initrnspacl "
4552  "FROM pg_namespace n "
4553  "LEFT JOIN pg_init_privs pip "
4554  "ON (n.oid = pip.objoid "
4555  "AND pip.classoid = 'pg_namespace'::regclass "
4556  "AND pip.objsubid = 0",
4557  username_subquery,
4558  acl_subquery->data,
4559  racl_subquery->data,
4560  init_acl_subquery->data,
4561  init_racl_subquery->data);
4562 
4563  appendPQExpBufferStr(query, ") ");
4564 
4565  destroyPQExpBuffer(acl_subquery);
4566  destroyPQExpBuffer(racl_subquery);
4567  destroyPQExpBuffer(init_acl_subquery);
4568  destroyPQExpBuffer(init_racl_subquery);
4569  }
4570  else
4571  appendPQExpBuffer(query, "SELECT tableoid, oid, nspname, "
4572  "(%s nspowner) AS rolname, "
4573  "nspacl, NULL as rnspacl, "
4574  "NULL AS initnspacl, NULL as initrnspacl "
4575  "FROM pg_namespace",
4576  username_subquery);
4577 
4578  res = ExecuteSqlQuery(fout, query->data, PGRES_TUPLES_OK);
4579 
4580  ntups = PQntuples(res);
4581 
4582  nsinfo = (NamespaceInfo *) pg_malloc(ntups * sizeof(NamespaceInfo));
4583 
4584  i_tableoid = PQfnumber(res, "tableoid");
4585  i_oid = PQfnumber(res, "oid");
4586  i_nspname = PQfnumber(res, "nspname");
4587  i_rolname = PQfnumber(res, "rolname");
4588  i_nspacl = PQfnumber(res, "nspacl");
4589  i_rnspacl = PQfnumber(res, "rnspacl");
4590  i_initnspacl = PQfnumber(res, "initnspacl");
4591  i_initrnspacl = PQfnumber(res, "initrnspacl");
4592 
4593  for (i = 0; i < ntups; i++)
4594  {
4595  nsinfo[i].dobj.objType = DO_NAMESPACE;
4596  nsinfo[i].dobj.catId.tableoid = atooid(PQgetvalue(res, i, i_tableoid));
4597  nsinfo[i].dobj.catId.oid = atooid(PQgetvalue(res, i, i_oid));
4598  AssignDumpId(&nsinfo[i].dobj);
4599  nsinfo[i].dobj.name = pg_strdup(PQgetvalue(res, i, i_nspname));
4600  nsinfo[i].rolname = pg_strdup(PQgetvalue(res, i, i_rolname));
4601  nsinfo[i].nspacl = pg_strdup(PQgetvalue(res, i, i_nspacl));
4602  nsinfo[i].rnspacl = pg_strdup(PQgetvalue(res, i, i_rnspacl));
4603  nsinfo[i].initnspacl = pg_strdup(PQgetvalue(res, i, i_initnspacl));
4604  nsinfo[i].initrnspacl = pg_strdup(PQgetvalue(res, i, i_initrnspacl));
4605 
4606  /* Decide whether to dump this namespace */
4607  selectDumpableNamespace(&nsinfo[i], fout);
4608 
4609  /*
4610  * Do not try to dump ACL if the ACL is empty or the default.
4611  *
4612  * This is useful because, for some schemas/objects, the only
4613  * component we are going to try and dump is the ACL and if we can
4614  * remove that then 'dump' goes to zero/false and we don't consider
4615  * this object for dumping at all later on.
4616  */
4617  if (PQgetisnull(res, i, i_nspacl) && PQgetisnull(res, i, i_rnspacl) &&
4618  PQgetisnull(res, i, i_initnspacl) &&
4619  PQgetisnull(res, i, i_initrnspacl))
4620  nsinfo[i].dobj.dump &= ~DUMP_COMPONENT_ACL;
4621 
4622  if (strlen(nsinfo[i].rolname) == 0)
4623  pg_log_warning("owner of schema \"%s\" appears to be invalid",
4624  nsinfo[i].dobj.name);
4625  }
4626 
4627  PQclear(res);
4628  destroyPQExpBuffer(query);
4629 
4630  *numNamespaces = ntups;
4631 
4632  return nsinfo;
4633 }
4634 
4635 /*
4636  * findNamespace:
4637  * given a namespace OID, look up the info read by getNamespaces
4638  */
4639 static NamespaceInfo *
4640 findNamespace(Archive *fout, Oid nsoid)
4641 {
4642  NamespaceInfo *nsinfo;
4643 
4644  nsinfo = findNamespaceByOid(nsoid);
4645  if (nsinfo == NULL)
4646  fatal("schema with OID %u does not exist", nsoid);
4647  return nsinfo;
4648 }
4649 
4650 /*
4651  * getExtensions:
4652  * read all extensions in the system catalogs and return them in the
4653  * ExtensionInfo* structure
4654  *
4655  * numExtensions is set to the number of extensions read in
4656  */
4657 ExtensionInfo *
4658 getExtensions(Archive *fout, int *numExtensions)
4659 {
4660  DumpOptions *dopt = fout->dopt;
4661  PGresult *res;
4662  int ntups;
4663  int i;
4664  PQExpBuffer query;
4665  ExtensionInfo *extinfo;
4666  int i_tableoid;
4667  int i_oid;
4668  int i_extname;
4669  int i_nspname;
4670  int i_extrelocatable;
4671  int i_extversion;
4672  int i_extconfig;
4673  int i_extcondition;
4674 
4675  /*
4676  * Before 9.1, there are no extensions.
4677  */
4678  if (fout->remoteVersion < 90100)
4679  {
4680  *numExtensions = 0;
4681  return NULL;
4682  }
4683 
4684  query = createPQExpBuffer();
4685 
4686  appendPQExpBufferStr(query, "SELECT x.tableoid, x.oid, "
4687  "x.extname, n.nspname, x.extrelocatable, x.extversion, x.extconfig, x.extcondition "
4688  "FROM pg_extension x "
4689  "JOIN pg_namespace n ON n.oid = x.extnamespace");
4690 
4691  res = ExecuteSqlQuery(fout, query->data, PGRES_TUPLES_OK);
4692 
4693  ntups = PQntuples(res);
4694 
4695  extinfo = (ExtensionInfo *) pg_malloc(ntups * sizeof(ExtensionInfo));
4696 
4697  i_tableoid = PQfnumber(res, "tableoid");
4698  i_oid = PQfnumber(res, "oid");
4699  i_extname = PQfnumber(res, "extname");
4700  i_nspname = PQfnumber(res, "nspname");
4701  i_extrelocatable = PQfnumber(res, "extrelocatable");
4702  i_extversion = PQfnumber(res, "extversion");
4703  i_extconfig = PQfnumber(res, "extconfig");
4704  i_extcondition = PQfnumber(res, "extcondition");
4705 
4706  for (i = 0; i < ntups; i++)
4707  {
4708  extinfo[i].dobj.objType = DO_EXTENSION;
4709  extinfo[i].dobj.catId.tableoid = atooid(PQgetvalue(res, i, i_tableoid));
4710  extinfo[i].dobj.catId.oid = atooid(PQgetvalue(res, i, i_oid));
4711  AssignDumpId(&extinfo[i].dobj);
4712  extinfo[i].dobj.name = pg_strdup(PQgetvalue(res, i, i_extname));
4713  extinfo[i].namespace = pg_strdup(PQgetvalue(res, i, i_nspname));
4714  extinfo[i].relocatable = *(PQgetvalue(res, i, i_extrelocatable)) == 't';
4715  extinfo[i].extversion = pg_strdup(PQgetvalue(res, i, i_extversion));
4716  extinfo[i].extconfig = pg_strdup(PQgetvalue(res, i, i_extconfig));
4717  extinfo[i].extcondition = pg_strdup(PQgetvalue(res, i, i_extcondition));
4718 
4719  /* Decide whether we want to dump it */
4720  selectDumpableExtension(&(extinfo[i]), dopt);
4721  }
4722 
4723  PQclear(res);
4724  destroyPQExpBuffer(query);
4725 
4726  *numExtensions = ntups;
4727 
4728  return extinfo;
4729 }
4730 
4731 /*
4732  * getTypes:
4733  * read all types in the system catalogs and return them in the
4734  * TypeInfo* structure
4735  *
4736  * numTypes is set to the number of types read in
4737  *
4738  * NB: this must run after getFuncs() because we assume we can do
4739  * findFuncByOid().
4740  */
4741 TypeInfo *
4742 getTypes(Archive *fout, int *numTypes)
4743 {
4744  DumpOptions *dopt = fout->dopt;
4745  PGresult *res;
4746  int ntups;
4747  int i;
4748  PQExpBuffer query = createPQExpBuffer();
4749  TypeInfo *tyinfo;
4750  ShellTypeInfo *stinfo;
4751  int i_tableoid;
4752  int i_oid;
4753  int i_typname;
4754  int i_typnamespace;
4755  int i_typacl;
4756  int i_rtypacl;
4757  int i_inittypacl;
4758  int i_initrtypacl;
4759  int i_rolname;
4760  int i_typelem;
4761  int i_typrelid;
4762  int i_typrelkind;
4763  int i_typtype;
4764  int i_typisdefined;
4765  int i_isarray;
4766 
4767  /*
4768  * we include even the built-in types because those may be used as array
4769  * elements by user-defined types
4770  *
4771  * we filter out the built-in types when we dump out the types
4772  *
4773  * same approach for undefined (shell) types and array types
4774  *
4775  * Note: as of 8.3 we can reliably detect whether a type is an
4776  * auto-generated array type by checking the element type's typarray.
4777  * (Before that the test is capable of generating false positives.) We
4778  * still check for name beginning with '_', though, so as to avoid the
4779  * cost of the subselect probe for all standard types. This would have to
4780  * be revisited if the backend ever allows renaming of array types.
4781  */
4782 
4783  if (fout->remoteVersion >= 90600)
4784  {
4785  PQExpBuffer acl_subquery = createPQExpBuffer();
4786  PQExpBuffer racl_subquery = createPQExpBuffer();
4787  PQExpBuffer initacl_subquery = createPQExpBuffer();
4788  PQExpBuffer initracl_subquery = createPQExpBuffer();
4789 
4790  buildACLQueries(acl_subquery, racl_subquery, initacl_subquery,
4791  initracl_subquery, "t.typacl", "t.typowner", "'T'",
4792  dopt->binary_upgrade);
4793 
4794  appendPQExpBuffer(query, "SELECT t.tableoid, t.oid, t.typname, "
4795  "t.typnamespace, "
4796  "%s AS typacl, "
4797  "%s AS rtypacl, "
4798  "%s AS inittypacl, "
4799  "%s AS initrtypacl, "
4800  "(%s t.typowner) AS rolname, "
4801  "t.typelem, t.typrelid, "
4802  "CASE WHEN t.typrelid = 0 THEN ' '::\"char\" "
4803  "ELSE (SELECT relkind FROM pg_class WHERE oid = t.typrelid) END AS typrelkind, "
4804  "t.typtype, t.typisdefined, "
4805  "t.typname[0] = '_' AND t.typelem != 0 AND "
4806  "(SELECT typarray FROM pg_type te WHERE oid = t.typelem) = t.oid AS isarray "
4807  "FROM pg_type t "
4808  "LEFT JOIN pg_init_privs pip ON "
4809  "(t.oid = pip.objoid "
4810  "AND pip.classoid = 'pg_type'::regclass "
4811  "AND pip.objsubid = 0) ",
4812  acl_subquery->data,
4813  racl_subquery->data,
4814  initacl_subquery->data,
4815  initracl_subquery->data,
4816  username_subquery);
4817 
4818  destroyPQExpBuffer(acl_subquery);
4819  destroyPQExpBuffer(racl_subquery);
4820  destroyPQExpBuffer(initacl_subquery);
4821  destroyPQExpBuffer(initracl_subquery);
4822  }
4823  else if (fout->remoteVersion >= 90200)
4824  {
4825  appendPQExpBuffer(query, "SELECT tableoid, oid, typname, "
4826  "typnamespace, typacl, NULL as rtypacl, "
4827  "NULL AS inittypacl, NULL AS initrtypacl, "
4828  "(%s typowner) AS rolname, "
4829  "typelem, typrelid, "
4830  "CASE WHEN typrelid = 0 THEN ' '::\"char\" "
4831  "ELSE (SELECT relkind FROM pg_class WHERE oid = typrelid) END AS typrelkind, "
4832  "typtype, typisdefined, "
4833  "typname[0] = '_' AND typelem != 0 AND "
4834  "(SELECT typarray FROM pg_type te WHERE oid = pg_type.typelem) = oid AS isarray "
4835  "FROM pg_type",
4836  username_subquery);
4837  }
4838  else if (fout->remoteVersion >= 80300)
4839  {
4840  appendPQExpBuffer(query, "SELECT tableoid, oid, typname, "
4841  "typnamespace, NULL AS typacl, NULL as rtypacl, "
4842  "NULL AS inittypacl, NULL AS initrtypacl, "
4843  "(%s typowner) AS rolname, "
4844  "typelem, typrelid, "
4845  "CASE WHEN typrelid = 0 THEN ' '::\"char\" "
4846  "ELSE (SELECT relkind FROM pg_class WHERE oid = typrelid) END AS typrelkind, "
4847  "typtype, typisdefined, "
4848  "typname[0] = '_' AND typelem != 0 AND "
4849  "(SELECT typarray FROM pg_type te WHERE oid = pg_type.typelem) = oid AS isarray "
4850  "FROM pg_type",
4851  username_subquery);
4852  }
4853  else
4854  {
4855  appendPQExpBuffer(query, "SELECT tableoid, oid, typname, "
4856  "typnamespace, NULL AS typacl, NULL as rtypacl, "
4857  "NULL AS inittypacl, NULL AS initrtypacl, "
4858  "(%s typowner) AS rolname, "
4859  "typelem, typrelid, "
4860  "CASE WHEN typrelid = 0 THEN ' '::\"char\" "
4861  "ELSE (SELECT relkind FROM pg_class WHERE oid = typrelid) END AS typrelkind, "
4862  "typtype, typisdefined, "
4863  "typname[0] = '_' AND typelem != 0 AS isarray "
4864  "FROM pg_type",
4865  username_subquery);
4866  }
4867 
4868  res = ExecuteSqlQuery(fout, query->data, PGRES_TUPLES_OK);
4869 
4870  ntups = PQntuples(res);
4871 
4872  tyinfo = (TypeInfo *) pg_malloc(ntups * sizeof(TypeInfo));
4873 
4874  i_tableoid = PQfnumber(res, "tableoid");
4875  i_oid = PQfnumber(res, "oid");
4876  i_typname = PQfnumber(res, "typname");
4877  i_typnamespace = PQfnumber(res, "typnamespace");
4878  i_typacl = PQfnumber(res, "typacl");
4879  i_rtypacl = PQfnumber(res, "rtypacl");
4880  i_inittypacl = PQfnumber(res, "inittypacl");
4881  i_initrtypacl = PQfnumber(res, "initrtypacl");
4882  i_rolname = PQfnumber(res, "rolname");
4883  i_typelem = PQfnumber(res, "typelem");
4884  i_typrelid = PQfnumber(res, "typrelid");
4885  i_typrelkind = PQfnumber(res, "typrelkind");
4886  i_typtype = PQfnumber(res, "typtype");
4887  i_typisdefined = PQfnumber(res, "typisdefined");
4888  i_isarray = PQfnumber(res, "isarray");
4889 
4890  for (i = 0; i < ntups; i++)
4891  {
4892  tyinfo[i].dobj.objType = DO_TYPE;
4893  tyinfo[i].dobj.catId.tableoid = atooid(PQgetvalue(res, i, i_tableoid));
4894  tyinfo[i].dobj.catId.oid = atooid(PQgetvalue(res, i, i_oid));
4895  AssignDumpId(&tyinfo[i].dobj);
4896  tyinfo[i].dobj.name = pg_strdup(PQgetvalue(res, i, i_typname));
4897  tyinfo[i].dobj.namespace =
4898  findNamespace(fout,
4899  atooid(PQgetvalue(res, i, i_typnamespace)));
4900  tyinfo[i].rolname = pg_strdup(PQgetvalue(res, i, i_rolname));
4901  tyinfo[i].typacl = pg_strdup(PQgetvalue(res, i, i_typacl));
4902  tyinfo[i].rtypacl = pg_strdup(PQgetvalue(res, i, i_rtypacl));
4903  tyinfo[i].inittypacl = pg_strdup(PQgetvalue(res, i, i_inittypacl));
4904  tyinfo[i].initrtypacl = pg_strdup(PQgetvalue(res, i, i_initrtypacl));
4905  tyinfo[i].typelem = atooid(PQgetvalue(res, i, i_typelem));
4906  tyinfo[i].typrelid = atooid(PQgetvalue(res, i, i_typrelid));
4907  tyinfo[i].typrelkind = *PQgetvalue(res, i, i_typrelkind);
4908  tyinfo[i].typtype = *PQgetvalue(res, i, i_typtype);
4909  tyinfo[i].shellType = NULL;
4910 
4911  if (strcmp(PQgetvalue(res, i, i_typisdefined), "t") == 0)
4912  tyinfo[i].isDefined = true;
4913  else
4914  tyinfo[i].isDefined = false;
4915 
4916  if (strcmp(PQgetvalue(res, i, i_isarray), "t") == 0)
4917  tyinfo[i].isArray = true;
4918  else
4919  tyinfo[i].isArray = false;
4920 
4921  /* Decide whether we want to dump it */
4922  selectDumpableType(&tyinfo[i], fout);
4923 
4924  /* Do not try to dump ACL if no ACL exists. */
4925  if (PQgetisnull(res, i, i_typacl) && PQgetisnull(res, i, i_rtypacl) &&
4926  PQgetisnull(res, i, i_inittypacl) &&
4927  PQgetisnull(res, i, i_initrtypacl))
4928  tyinfo[i].dobj.dump &= ~DUMP_COMPONENT_ACL;
4929 
4930  /*
4931  * If it's a domain, fetch info about its constraints, if any
4932  */
4933  tyinfo[i].nDomChecks = 0;
4934  tyinfo[i].domChecks = NULL;
4935  if ((tyinfo[i].dobj.dump & DUMP_COMPONENT_DEFINITION) &&
4936  tyinfo[i].typtype == TYPTYPE_DOMAIN)
4937  getDomainConstraints(fout, &(tyinfo[i]));
4938 
4939  /*
4940  * If it's a base type, make a DumpableObject representing a shell
4941  * definition of the type. We will need to dump that ahead of the I/O
4942  * functions for the type. Similarly, range types need a shell
4943  * definition in case they have a canonicalize function.
4944  *
4945  * Note: the shell type doesn't have a catId. You might think it
4946  * should copy the base type's catId, but then it might capture the
4947  * pg_depend entries for the type, which we don't want.
4948  */
4949  if ((tyinfo[i].dobj.dump & DUMP_COMPONENT_DEFINITION) &&
4950  (tyinfo[i].typtype == TYPTYPE_BASE ||
4951  tyinfo[i].typtype == TYPTYPE_RANGE))
4952  {
4953  stinfo = (ShellTypeInfo *) pg_malloc(sizeof(ShellTypeInfo));
4954  stinfo->dobj.objType = DO_SHELL_TYPE;
4955  stinfo->dobj.catId = nilCatalogId;
4956  AssignDumpId(&stinfo->dobj);
4957  stinfo->dobj.name = pg_strdup(tyinfo[i].dobj.name);
4958  stinfo->dobj.namespace = tyinfo[i].dobj.namespace;
4959  stinfo->baseType = &(tyinfo[i]);
4960  tyinfo[i].shellType = stinfo;
4961 
4962  /*
4963  * Initially mark the shell type as not to be dumped. We'll only
4964  * dump it if the I/O or canonicalize functions need to be dumped;
4965  * this is taken care of while sorting dependencies.
4966  */
4967  stinfo->dobj.dump = DUMP_COMPONENT_NONE;
4968  }
4969 
4970  if (strlen(tyinfo[i].rolname) == 0)
4971  pg_log_warning("owner of data type \"%s\" appears to be invalid",
4972  tyinfo[i].dobj.name);
4973  }
4974 
4975  *numTypes = ntups;
4976 
4977  PQclear(res);
4978 
4979  destroyPQExpBuffer(query);
4980 
4981  return tyinfo;
4982 }
4983 
4984 /*
4985  * getOperators:
4986  * read all operators in the system catalogs and return them in the
4987  * OprInfo* structure
4988  *
4989  * numOprs is set to the number of operators read in
4990  */
4991 OprInfo *
4992 getOperators(Archive *fout, int *numOprs)
4993 {
4994  PGresult *res;
4995  int ntups;
4996  int i;
4997  PQExpBuffer query = createPQExpBuffer();
4998  OprInfo *oprinfo;
4999  int i_tableoid;
5000  int i_oid;
5001  int i_oprname;
5002  int i_oprnamespace;
5003  int i_rolname;
5004  int i_oprkind;
5005  int i_oprcode;
5006 
5007  /*
5008  * find all operators, including builtin operators; we filter out
5009  * system-defined operators at dump-out time.
5010  */
5011 
5012  appendPQExpBuffer(query, "SELECT tableoid, oid, oprname, "
5013  "oprnamespace, "
5014  "(%s oprowner) AS rolname, "
5015  "oprkind, "
5016  "oprcode::oid AS oprcode "
5017  "FROM pg_operator",
5018  username_subquery);
5019 
5020  res = ExecuteSqlQuery(fout, query->data, PGRES_TUPLES_OK);
5021 
5022  ntups = PQntuples(res);
5023  *numOprs = ntups;
5024 
5025  oprinfo = (OprInfo *) pg_malloc(ntups * sizeof(OprInfo));
5026 
5027  i_tableoid = PQfnumber(res, "tableoid");
5028  i_oid = PQfnumber(res, "oid");
5029  i_oprname = PQfnumber(res, "oprname");
5030  i_oprnamespace = PQfnumber(res, "oprnamespace");
5031  i_rolname = PQfnumber(res, "rolname");
5032  i_oprkind = PQfnumber(res, "oprkind");
5033  i_oprcode = PQfnumber(res, "oprcode");
5034 
5035  for (i = 0; i < ntups; i++)
5036  {
5037  oprinfo[i].dobj.objType = DO_OPERATOR;
5038  oprinfo[i].dobj.catId.tableoid = atooid(PQgetvalue(res, i, i_tableoid));
5039  oprinfo[i].dobj.catId.oid = atooid(PQgetvalue(res, i, i_oid));
5040  AssignDumpId(&oprinfo[i].dobj);
5041  oprinfo[i].dobj.name = pg_strdup(PQgetvalue(res, i, i_oprname));
5042  oprinfo[i].dobj.namespace =
5043  findNamespace(fout,
5044  atooid(PQgetvalue(res, i, i_oprnamespace)));
5045  oprinfo[i].rolname = pg_strdup(PQgetvalue(res, i, i_rolname));
5046  oprinfo[i].oprkind = (PQgetvalue(res, i, i_oprkind))[0];
5047  oprinfo[i].oprcode = atooid(PQgetvalue(res, i, i_oprcode));
5048 
5049  /* Decide whether we want to dump it */
5050  selectDumpableObject(&(oprinfo[i].dobj), fout);
5051 
5052  /* Operators do not currently have ACLs. */
5053  oprinfo[i].dobj.dump &= ~DUMP_COMPONENT_ACL;
5054 
5055  if (strlen(oprinfo[i].rolname) == 0)
5056  pg_log_warning("owner of operator \"%s\" appears to be invalid",
5057  oprinfo[i].dobj.name);
5058  }
5059 
5060  PQclear(res);
5061 
5062  destroyPQExpBuffer(query);
5063 
5064  return oprinfo;
5065 }
5066 
5067 /*
5068  * getCollations:
5069  * read all collations in the system catalogs and return them in the
5070  * CollInfo* structure
5071  *
5072  * numCollations is set to the number of collations read in
5073  */
5074 CollInfo *
5075 getCollations(Archive *fout, int *numCollations)
5076 {
5077  PGresult *res;
5078  int ntups;
5079  int i;
5080  PQExpBuffer query;
5081  CollInfo *collinfo;
5082  int i_tableoid;
5083  int i_oid;
5084  int i_collname;
5085  int i_collnamespace;
5086  int i_rolname;
5087 
5088  /* Collations didn't exist pre-9.1 */
5089  if (fout->remoteVersion < 90100)
5090  {
5091  *numCollations = 0;
5092  return NULL;
5093  }
5094 
5095  query = createPQExpBuffer();
5096 
5097  /*
5098  * find all collations, including builtin collations; we filter out
5099  * system-defined collations at dump-out time.
5100  */
5101 
5102  appendPQExpBuffer(query, "SELECT tableoid, oid, collname, "
5103  "collnamespace, "
5104  "(%s collowner) AS rolname "
5105  "FROM pg_collation",
5106  username_subquery);
5107 
5108  res = ExecuteSqlQuery(fout, query->data, PGRES_TUPLES_OK);
5109 
5110  ntups = PQntuples(res);
5111  *numCollations = ntups;
5112 
5113  collinfo = (CollInfo *) pg_malloc(ntups * sizeof(CollInfo));
5114 
5115  i_tableoid = PQfnumber(res, "tableoid");
5116  i_oid = PQfnumber(res, "oid");
5117  i_collname = PQfnumber(res, "collname");
5118  i_collnamespace = PQfnumber(res, "collnamespace");
5119  i_rolname = PQfnumber(res, "rolname");
5120 
5121  for (i = 0; i < ntups; i++)
5122  {
5123  collinfo[i].dobj.objType = DO_COLLATION;
5124  collinfo[i].dobj.catId.tableoid = atooid(PQgetvalue(res, i, i_tableoid));
5125  collinfo[i].dobj.catId.oid = atooid(PQgetvalue(res, i, i_oid));
5126  AssignDumpId(&collinfo[i].dobj);
5127  collinfo[i].dobj.name = pg_strdup(PQgetvalue(res, i, i_collname));
5128  collinfo[i].dobj.namespace =
5129  findNamespace(fout,
5130  atooid(PQgetvalue(res, i, i_collnamespace)));
5131  collinfo[i].rolname = pg_strdup(PQgetvalue(res, i, i_rolname));
5132 
5133  /* Decide whether we want to dump it */
5134  selectDumpableObject(&(collinfo[i].dobj), fout);
5135 
5136  /* Collations do not currently have ACLs. */
5137  collinfo[i].dobj.dump &= ~DUMP_COMPONENT_ACL;
5138  }
5139 
5140  PQclear(res);
5141 
5142  destroyPQExpBuffer(query);
5143 
5144  return collinfo;
5145 }
5146 
5147 /*
5148  * getConversions:
5149  * read all conversions in the system catalogs and return them in the
5150  * ConvInfo* structure
5151  *
5152  * numConversions is set to the number of conversions read in
5153  */
5154 ConvInfo *
5155 getConversions(Archive *fout, int *numConversions)
5156 {
5157  PGresult *res;
5158  int ntups;
5159  int i;
5160  PQExpBuffer query;
5161  ConvInfo *convinfo;
5162  int i_tableoid;
5163  int i_oid;
5164  int i_conname;
5165  int i_connamespace;
5166  int i_rolname;
5167 
5168  query = createPQExpBuffer();
5169 
5170  /*
5171  * find all conversions, including builtin conversions; we filter out
5172  * system-defined conversions at dump-out time.
5173  */
5174 
5175  appendPQExpBuffer(query, "SELECT tableoid, oid, conname, "
5176  "connamespace, "
5177  "(%s conowner) AS rolname "
5178  "FROM pg_conversion",
5179  username_subquery);
5180 
5181  res = ExecuteSqlQuery(fout, query->data, PGRES_TUPLES_OK);
5182 
5183  ntups = PQntuples(res);
5184  *numConversions = ntups;
5185 
5186  convinfo = (ConvInfo *) pg_malloc(ntups * sizeof(ConvInfo));
5187 
5188  i_tableoid = PQfnumber(res, "tableoid");
5189  i_oid = PQfnumber(res, "oid");
5190  i_conname = PQfnumber(res, "conname");
5191  i_connamespace = PQfnumber(res, "connamespace");
5192  i_rolname = PQfnumber(res, "rolname");
5193 
5194  for (i = 0; i < ntups; i++)
5195  {
5196  convinfo[i].dobj.objType = DO_CONVERSION;
5197  convinfo[i].dobj.catId.tableoid = atooid(PQgetvalue(res, i, i_tableoid));
5198  convinfo[i].dobj.catId.oid = atooid(PQgetvalue(res, i, i_oid));
5199  AssignDumpId(&convinfo[i].dobj);
5200  convinfo[i].dobj.name = pg_strdup(PQgetvalue(res, i, i_conname));
5201  convinfo[i].dobj.namespace =
5202  findNamespace(fout,
5203  atooid(PQgetvalue(res, i, i_connamespace)));
5204  convinfo[i].rolname = pg_strdup(PQgetvalue(res, i, i_rolname));
5205 
5206  /* Decide whether we want to dump it */
5207  selectDumpableObject(&(convinfo[i].dobj), fout);
5208 
5209  /* Conversions do not currently have ACLs. */
5210  convinfo[i].dobj.dump &= ~DUMP_COMPONENT_ACL;
5211  }
5212 
5213  PQclear(res);
5214 
5215  destroyPQExpBuffer(query);
5216 
5217  return convinfo;
5218 }
5219 
5220 /*
5221  * getAccessMethods:
5222  * read all user-defined access methods in the system catalogs and return
5223  * them in the AccessMethodInfo* structure
5224  *
5225  * numAccessMethods is set to the number of access methods read in
5226  */
5227 AccessMethodInfo *
5228 getAccessMethods(Archive *fout, int *numAccessMethods)
5229 {
5230  PGresult *res;
5231  int ntups;
5232  int i;
5233  PQExpBuffer query;
5234  AccessMethodInfo *aminfo;
5235  int i_tableoid;
5236  int i_oid;
5237  int i_amname;
5238  int i_amhandler;
5239  int i_amtype;
5240 
5241  /* Before 9.6, there are no user-defined access methods */
5242  if (fout->remoteVersion < 90600)
5243  {
5244  *numAccessMethods = 0;
5245  return NULL;
5246  }
5247 
5248  query = createPQExpBuffer();
5249 
5250  /* Select all access methods from pg_am table */
5251  appendPQExpBufferStr(query, "SELECT tableoid, oid, amname, amtype, "
5252  "amhandler::pg_catalog.regproc AS amhandler "
5253  "FROM pg_am");
5254 
5255  res = ExecuteSqlQuery(fout, query->data, PGRES_TUPLES_OK);
5256 
5257  ntups = PQntuples(res);
5258  *numAccessMethods = ntups;
5259 
5260  aminfo = (AccessMethodInfo *) pg_malloc(ntups * sizeof(AccessMethodInfo));
5261 
5262  i_tableoid = PQfnumber(res, "tableoid");
5263  i_oid = PQfnumber(res, "oid");
5264  i_amname = PQfnumber(res, "amname");
5265  i_amhandler = PQfnumber(res, "amhandler");
5266  i_amtype = PQfnumber(res, "amtype");
5267 
5268  for (i = 0; i < ntups; i++)
5269  {
5270  aminfo[i].dobj.objType = DO_ACCESS_METHOD;
5271  aminfo[i].dobj.catId.tableoid = atooid(PQgetvalue(res, i, i_tableoid));
5272  aminfo[i].dobj.catId.oid = atooid(PQgetvalue(res, i, i_oid));
5273  AssignDumpId(&aminfo[i].dobj);
5274  aminfo[i].dobj.name = pg_strdup(PQgetvalue(res, i, i_amname));
5275  aminfo[i].dobj.namespace = NULL;
5276  aminfo[i].amhandler = pg_strdup(PQgetvalue(res, i, i_amhandler));
5277  aminfo[i].amtype = *(PQgetvalue(res, i, i_amtype));
5278 
5279  /* Decide whether we want to dump it */
5280  selectDumpableAccessMethod(&(aminfo[i]), fout);
5281 
5282  /* Access methods do not currently have ACLs. */
5283  aminfo[i].dobj.dump &= ~DUMP_COMPONENT_ACL;
5284  }
5285 
5286  PQclear(res);
5287 
5288  destroyPQExpBuffer(query);
5289 
5290  return aminfo;
5291 }
5292 
5293 
5294 /*
5295  * getOpclasses:
5296  * read all opclasses in the system catalogs and return them in the
5297  * OpclassInfo* structure
5298  *
5299  * numOpclasses is set to the number of opclasses read in
5300  */
5301 OpclassInfo *
5302 getOpclasses(Archive *fout, int *numOpclasses)
5303 {
5304  PGresult *res;
5305  int ntups;
5306  int i;
5307  PQExpBuffer query = createPQExpBuffer();
5308  OpclassInfo *opcinfo;
5309  int i_tableoid;
5310  int i_oid;
5311  int i_opcname;
5312  int i_opcnamespace;
5313