?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Add psql \drg command to display role grants.
[pgsql.git] / src / bin / psql / describe.c
blob45f6a86b87278b0be318089c167b8e214d1bf334
1 /*
2 * psql - the PostgreSQL interactive terminal
3 *
4 * Support for the various \d ("describe") commands. Note that the current
5 * expectation is that all functions in this file will succeed when working
6 * with servers of versions 9.2 and up. It's okay to omit irrelevant
7 * information for an old server, but not to fail outright. (But failing
8 * against a pre-9.2 server is allowed.)
9 *
10 * Copyright (c) 2000-2023, PostgreSQL Global Development Group
11 *
12 * src/bin/psql/describe.c
13 */
14 #include "postgres_fe.h"
15
16 #include <ctype.h>
17
18 #include "catalog/pg_am.h"
19 #include "catalog/pg_attribute_d.h"
20 #include "catalog/pg_cast_d.h"
21 #include "catalog/pg_class_d.h"
22 #include "catalog/pg_default_acl_d.h"
23 #include "common.h"
24 #include "common/logging.h"
25 #include "describe.h"
26 #include "fe_utils/mbprint.h"
27 #include "fe_utils/print.h"
28 #include "fe_utils/string_utils.h"
29 #include "settings.h"
30 #include "variables.h"
31
32 static const char *map_typename_pattern(const char *pattern);
33 static bool describeOneTableDetails(const char *schemaname,
34 const char *relationname,
35 const char *oid,
36 bool verbose);
37 static void add_tablespace_footer(printTableContent *const cont, char relkind,
38 Oid tablespace, const bool newline);
39 static void add_role_attribute(PQExpBuffer buf, const char *const str);
40 static bool listTSParsersVerbose(const char *pattern);
41 static bool describeOneTSParser(const char *oid, const char *nspname,
42 const char *prsname);
43 static bool listTSConfigsVerbose(const char *pattern);
44 static bool describeOneTSConfig(const char *oid, const char *nspname,
45 const char *cfgname,
46 const char *pnspname, const char *prsname);
47 static void printACLColumn(PQExpBuffer buf, const char *colname);
48 static bool listOneExtensionContents(const char *extname, const char *oid);
49 static bool validateSQLNamePattern(PQExpBuffer buf, const char *pattern,
50 bool have_where, bool force_escape,
51 const char *schemavar, const char *namevar,
52 const char *altnamevar,
53 const char *visibilityrule,
54 bool *added_clause, int maxparts);
55
56
57 /*----------------
58 * Handlers for various slash commands displaying some sort of list
59 * of things in the database.
60 *
61 * Note: try to format the queries to look nice in -E output.
62 *----------------
63 */
64
65
66 /*
67 * \da
68 * Takes an optional regexp to select particular aggregates
69 */
70 bool
71 describeAggregates(const char *pattern, bool verbose, bool showSystem)
72 {
73 PQExpBufferData buf;
74 PGresult *res;
75 printQueryOpt myopt = pset.popt;
76
77 initPQExpBuffer(&buf);
78
79 printfPQExpBuffer(&buf,
80 "SELECT n.nspname as \"%s\",\n"
81 " p.proname AS \"%s\",\n"
82 " pg_catalog.format_type(p.prorettype, NULL) AS \"%s\",\n"
83 " CASE WHEN p.pronargs = 0\n"
84 " THEN CAST('*' AS pg_catalog.text)\n"
85 " ELSE pg_catalog.pg_get_function_arguments(p.oid)\n"
86 " END AS \"%s\",\n",
87 gettext_noop("Schema"),
88 gettext_noop("Name"),
89 gettext_noop("Result data type"),
90 gettext_noop("Argument data types"));
91
92 if (pset.sversion >= 110000)
93 appendPQExpBuffer(&buf,
94 " pg_catalog.obj_description(p.oid, 'pg_proc') as \"%s\"\n"
95 "FROM pg_catalog.pg_proc p\n"
96 " LEFT JOIN pg_catalog.pg_namespace n ON n.oid = p.pronamespace\n"
97 "WHERE p.prokind = 'a'\n",
98 gettext_noop("Description"));
99 else
100 appendPQExpBuffer(&buf,
101 " pg_catalog.obj_description(p.oid, 'pg_proc') as \"%s\"\n"
102 "FROM pg_catalog.pg_proc p\n"
103 " LEFT JOIN pg_catalog.pg_namespace n ON n.oid = p.pronamespace\n"
104 "WHERE p.proisagg\n",
105 gettext_noop("Description"));
106
107 if (!showSystem && !pattern)
108 appendPQExpBufferStr(&buf, " AND n.nspname <> 'pg_catalog'\n"
109 " AND n.nspname <> 'information_schema'\n");
110
111 if (!validateSQLNamePattern(&buf, pattern, true, false,
112 "n.nspname", "p.proname", NULL,
113 "pg_catalog.pg_function_is_visible(p.oid)",
114 NULL, 3))
115 {
116 termPQExpBuffer(&buf);
117 return false;
118 }
119
120 appendPQExpBufferStr(&buf, "ORDER BY 1, 2, 4;");
121
122 res = PSQLexec(buf.data);
123 termPQExpBuffer(&buf);
124 if (!res)
125 return false;
126
127 myopt.nullPrint = NULL;
128 myopt.title = _("List of aggregate functions");
129 myopt.translate_header = true;
130
131 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
132
133 PQclear(res);
134 return true;
135 }
136
137 /*
138 * \dA
139 * Takes an optional regexp to select particular access methods
140 */
141 bool
142 describeAccessMethods(const char *pattern, bool verbose)
143 {
144 PQExpBufferData buf;
145 PGresult *res;
146 printQueryOpt myopt = pset.popt;
147 static const bool translate_columns[] = {false, true, false, false};
148
149 if (pset.sversion < 90600)
150 {
151 char sverbuf[32];
152
153 pg_log_error("The server (version %s) does not support access methods.",
154 formatPGVersionNumber(pset.sversion, false,
155 sverbuf, sizeof(sverbuf)));
156 return true;
157 }
158
159 initPQExpBuffer(&buf);
160
161 printfPQExpBuffer(&buf,
162 "SELECT amname AS \"%s\",\n"
163 " CASE amtype"
164 " WHEN 'i' THEN '%s'"
165 " WHEN 't' THEN '%s'"
166 " END AS \"%s\"",
167 gettext_noop("Name"),
168 gettext_noop("Index"),
169 gettext_noop("Table"),
170 gettext_noop("Type"));
171
172 if (verbose)
173 {
174 appendPQExpBuffer(&buf,
175 ",\n amhandler AS \"%s\",\n"
176 " pg_catalog.obj_description(oid, 'pg_am') AS \"%s\"",
177 gettext_noop("Handler"),
178 gettext_noop("Description"));
179 }
180
181 appendPQExpBufferStr(&buf,
182 "\nFROM pg_catalog.pg_am\n");
183
184 if (!validateSQLNamePattern(&buf, pattern, false, false,
185 NULL, "amname", NULL,
186 NULL,
187 NULL, 1))
188 {
189 termPQExpBuffer(&buf);
190 return false;
191 }
192
193 appendPQExpBufferStr(&buf, "ORDER BY 1;");
194
195 res = PSQLexec(buf.data);
196 termPQExpBuffer(&buf);
197 if (!res)
198 return false;
199
200 myopt.nullPrint = NULL;
201 myopt.title = _("List of access methods");
202 myopt.translate_header = true;
203 myopt.translate_columns = translate_columns;
204 myopt.n_translate_columns = lengthof(translate_columns);
205
206 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
207
208 PQclear(res);
209 return true;
210 }
211
212 /*
213 * \db
214 * Takes an optional regexp to select particular tablespaces
215 */
216 bool
217 describeTablespaces(const char *pattern, bool verbose)
218 {
219 PQExpBufferData buf;
220 PGresult *res;
221 printQueryOpt myopt = pset.popt;
222
223 initPQExpBuffer(&buf);
224
225 printfPQExpBuffer(&buf,
226 "SELECT spcname AS \"%s\",\n"
227 " pg_catalog.pg_get_userbyid(spcowner) AS \"%s\",\n"
228 " pg_catalog.pg_tablespace_location(oid) AS \"%s\"",
229 gettext_noop("Name"),
230 gettext_noop("Owner"),
231 gettext_noop("Location"));
232
233 if (verbose)
234 {
235 appendPQExpBufferStr(&buf, ",\n ");
236 printACLColumn(&buf, "spcacl");
237 appendPQExpBuffer(&buf,
238 ",\n spcoptions AS \"%s\""
239 ",\n pg_catalog.pg_size_pretty(pg_catalog.pg_tablespace_size(oid)) AS \"%s\""
240 ",\n pg_catalog.shobj_description(oid, 'pg_tablespace') AS \"%s\"",
241 gettext_noop("Options"),
242 gettext_noop("Size"),
243 gettext_noop("Description"));
244 }
245
246 appendPQExpBufferStr(&buf,
247 "\nFROM pg_catalog.pg_tablespace\n");
248
249 if (!validateSQLNamePattern(&buf, pattern, false, false,
250 NULL, "spcname", NULL,
251 NULL,
252 NULL, 1))
253 {
254 termPQExpBuffer(&buf);
255 return false;
256 }
257
258 appendPQExpBufferStr(&buf, "ORDER BY 1;");
259
260 res = PSQLexec(buf.data);
261 termPQExpBuffer(&buf);
262 if (!res)
263 return false;
264
265 myopt.nullPrint = NULL;
266 myopt.title = _("List of tablespaces");
267 myopt.translate_header = true;
268
269 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
270
271 PQclear(res);
272 return true;
273 }
274
275
276 /*
277 * \df
278 * Takes an optional regexp to select particular functions.
279 *
280 * As with \d, you can specify the kinds of functions you want:
281 *
282 * a for aggregates
283 * n for normal
284 * p for procedure
285 * t for trigger
286 * w for window
287 *
288 * and you can mix and match these in any order.
289 */
290 bool
291 describeFunctions(const char *functypes, const char *func_pattern,
292 char **arg_patterns, int num_arg_patterns,
293 bool verbose, bool showSystem)
294 {
295 bool showAggregate = strchr(functypes, 'a') != NULL;
296 bool showNormal = strchr(functypes, 'n') != NULL;
297 bool showProcedure = strchr(functypes, 'p') != NULL;
298 bool showTrigger = strchr(functypes, 't') != NULL;
299 bool showWindow = strchr(functypes, 'w') != NULL;
300 bool have_where;
301 PQExpBufferData buf;
302 PGresult *res;
303 printQueryOpt myopt = pset.popt;
304 static const bool translate_columns[] = {false, false, false, false, true, true, true, false, true, false, false, false, false};
305
306 /* No "Parallel" column before 9.6 */
307 static const bool translate_columns_pre_96[] = {false, false, false, false, true, true, false, true, false, false, false, false};
308
309 if (strlen(functypes) != strspn(functypes, "anptwS+"))
310 {
311 pg_log_error("\\df only takes [anptwS+] as options");
312 return true;
313 }
314
315 if (showProcedure && pset.sversion < 110000)
316 {
317 char sverbuf[32];
318
319 pg_log_error("\\df does not take a \"%c\" option with server version %s",
320 'p',
321 formatPGVersionNumber(pset.sversion, false,
322 sverbuf, sizeof(sverbuf)));
323 return true;
324 }
325
326 if (!showAggregate && !showNormal && !showProcedure && !showTrigger && !showWindow)
327 {
328 showAggregate = showNormal = showTrigger = showWindow = true;
329 if (pset.sversion >= 110000)
330 showProcedure = true;
331 }
332
333 initPQExpBuffer(&buf);
334
335 printfPQExpBuffer(&buf,
336 "SELECT n.nspname as \"%s\",\n"
337 " p.proname as \"%s\",\n",
338 gettext_noop("Schema"),
339 gettext_noop("Name"));
340
341 if (pset.sversion >= 110000)
342 appendPQExpBuffer(&buf,
343 " pg_catalog.pg_get_function_result(p.oid) as \"%s\",\n"
344 " pg_catalog.pg_get_function_arguments(p.oid) as \"%s\",\n"
345 " CASE p.prokind\n"
346 " WHEN 'a' THEN '%s'\n"
347 " WHEN 'w' THEN '%s'\n"
348 " WHEN 'p' THEN '%s'\n"
349 " ELSE '%s'\n"
350 " END as \"%s\"",
351 gettext_noop("Result data type"),
352 gettext_noop("Argument data types"),
353 /* translator: "agg" is short for "aggregate" */
354 gettext_noop("agg"),
355 gettext_noop("window"),
356 gettext_noop("proc"),
357 gettext_noop("func"),
358 gettext_noop("Type"));
359 else
360 appendPQExpBuffer(&buf,
361 " pg_catalog.pg_get_function_result(p.oid) as \"%s\",\n"
362 " pg_catalog.pg_get_function_arguments(p.oid) as \"%s\",\n"
363 " CASE\n"
364 " WHEN p.proisagg THEN '%s'\n"
365 " WHEN p.proiswindow THEN '%s'\n"
366 " WHEN p.prorettype = 'pg_catalog.trigger'::pg_catalog.regtype THEN '%s'\n"
367 " ELSE '%s'\n"
368 " END as \"%s\"",
369 gettext_noop("Result data type"),
370 gettext_noop("Argument data types"),
371 /* translator: "agg" is short for "aggregate" */
372 gettext_noop("agg"),
373 gettext_noop("window"),
374 gettext_noop("trigger"),
375 gettext_noop("func"),
376 gettext_noop("Type"));
377
378 if (verbose)
379 {
380 appendPQExpBuffer(&buf,
381 ",\n CASE\n"
382 " WHEN p.provolatile = 'i' THEN '%s'\n"
383 " WHEN p.provolatile = 's' THEN '%s'\n"
384 " WHEN p.provolatile = 'v' THEN '%s'\n"
385 " END as \"%s\"",
386 gettext_noop("immutable"),
387 gettext_noop("stable"),
388 gettext_noop("volatile"),
389 gettext_noop("Volatility"));
390 if (pset.sversion >= 90600)
391 appendPQExpBuffer(&buf,
392 ",\n CASE\n"
393 " WHEN p.proparallel = 'r' THEN '%s'\n"
394 " WHEN p.proparallel = 's' THEN '%s'\n"
395 " WHEN p.proparallel = 'u' THEN '%s'\n"
396 " END as \"%s\"",
397 gettext_noop("restricted"),
398 gettext_noop("safe"),
399 gettext_noop("unsafe"),
400 gettext_noop("Parallel"));
401 appendPQExpBuffer(&buf,
402 ",\n pg_catalog.pg_get_userbyid(p.proowner) as \"%s\""
403 ",\n CASE WHEN prosecdef THEN '%s' ELSE '%s' END AS \"%s\"",
404 gettext_noop("Owner"),
405 gettext_noop("definer"),
406 gettext_noop("invoker"),
407 gettext_noop("Security"));
408 appendPQExpBufferStr(&buf, ",\n ");
409 printACLColumn(&buf, "p.proacl");
410 appendPQExpBuffer(&buf,
411 ",\n l.lanname as \"%s\"",
412 gettext_noop("Language"));
413 appendPQExpBuffer(&buf,
414 ",\n CASE WHEN l.lanname IN ('internal', 'c') THEN p.prosrc END as \"%s\"",
415 gettext_noop("Internal name"));
416 appendPQExpBuffer(&buf,
417 ",\n pg_catalog.obj_description(p.oid, 'pg_proc') as \"%s\"",
418 gettext_noop("Description"));
419 }
420
421 appendPQExpBufferStr(&buf,
422 "\nFROM pg_catalog.pg_proc p"
423 "\n LEFT JOIN pg_catalog.pg_namespace n ON n.oid = p.pronamespace\n");
424
425 for (int i = 0; i < num_arg_patterns; i++)
426 {
427 appendPQExpBuffer(&buf,
428 " LEFT JOIN pg_catalog.pg_type t%d ON t%d.oid = p.proargtypes[%d]\n"
429 " LEFT JOIN pg_catalog.pg_namespace nt%d ON nt%d.oid = t%d.typnamespace\n",
430 i, i, i, i, i, i);
431 }
432
433 if (verbose)
434 appendPQExpBufferStr(&buf,
435 " LEFT JOIN pg_catalog.pg_language l ON l.oid = p.prolang\n");
436
437 have_where = false;
438
439 /* filter by function type, if requested */
440 if (showNormal && showAggregate && showProcedure && showTrigger && showWindow)
441 /* Do nothing */ ;
442 else if (showNormal)
443 {
444 if (!showAggregate)
445 {
446 if (have_where)
447 appendPQExpBufferStr(&buf, " AND ");
448 else
449 {
450 appendPQExpBufferStr(&buf, "WHERE ");
451 have_where = true;
452 }
453 if (pset.sversion >= 110000)
454 appendPQExpBufferStr(&buf, "p.prokind <> 'a'\n");
455 else
456 appendPQExpBufferStr(&buf, "NOT p.proisagg\n");
457 }
458 if (!showProcedure && pset.sversion >= 110000)
459 {
460 if (have_where)
461 appendPQExpBufferStr(&buf, " AND ");
462 else
463 {
464 appendPQExpBufferStr(&buf, "WHERE ");
465 have_where = true;
466 }
467 appendPQExpBufferStr(&buf, "p.prokind <> 'p'\n");
468 }
469 if (!showTrigger)
470 {
471 if (have_where)
472 appendPQExpBufferStr(&buf, " AND ");
473 else
474 {
475 appendPQExpBufferStr(&buf, "WHERE ");
476 have_where = true;
477 }
478 appendPQExpBufferStr(&buf, "p.prorettype <> 'pg_catalog.trigger'::pg_catalog.regtype\n");
479 }
480 if (!showWindow)
481 {
482 if (have_where)
483 appendPQExpBufferStr(&buf, " AND ");
484 else
485 {
486 appendPQExpBufferStr(&buf, "WHERE ");
487 have_where = true;
488 }
489 if (pset.sversion >= 110000)
490 appendPQExpBufferStr(&buf, "p.prokind <> 'w'\n");
491 else
492 appendPQExpBufferStr(&buf, "NOT p.proiswindow\n");
493 }
494 }
495 else
496 {
497 bool needs_or = false;
498
499 appendPQExpBufferStr(&buf, "WHERE (\n ");
500 have_where = true;
501 /* Note: at least one of these must be true ... */
502 if (showAggregate)
503 {
504 if (pset.sversion >= 110000)
505 appendPQExpBufferStr(&buf, "p.prokind = 'a'\n");
506 else
507 appendPQExpBufferStr(&buf, "p.proisagg\n");
508 needs_or = true;
509 }
510 if (showTrigger)
511 {
512 if (needs_or)
513 appendPQExpBufferStr(&buf, " OR ");
514 appendPQExpBufferStr(&buf,
515 "p.prorettype = 'pg_catalog.trigger'::pg_catalog.regtype\n");
516 needs_or = true;
517 }
518 if (showProcedure)
519 {
520 if (needs_or)
521 appendPQExpBufferStr(&buf, " OR ");
522 appendPQExpBufferStr(&buf, "p.prokind = 'p'\n");
523 needs_or = true;
524 }
525 if (showWindow)
526 {
527 if (needs_or)
528 appendPQExpBufferStr(&buf, " OR ");
529 if (pset.sversion >= 110000)
530 appendPQExpBufferStr(&buf, "p.prokind = 'w'\n");
531 else
532 appendPQExpBufferStr(&buf, "p.proiswindow\n");
533 }
534 appendPQExpBufferStr(&buf, " )\n");
535 }
536
537 if (!validateSQLNamePattern(&buf, func_pattern, have_where, false,
538 "n.nspname", "p.proname", NULL,
539 "pg_catalog.pg_function_is_visible(p.oid)",
540 NULL, 3))
541 goto error_return;
542
543 for (int i = 0; i < num_arg_patterns; i++)
544 {
545 if (strcmp(arg_patterns[i], "-") != 0)
546 {
547 /*
548 * Match type-name patterns against either internal or external
549 * name, like \dT. Unlike \dT, there seems no reason to
550 * discriminate against arrays or composite types.
551 */
552 char nspname[64];
553 char typname[64];
554 char ft[64];
555 char tiv[64];
556
557 snprintf(nspname, sizeof(nspname), "nt%d.nspname", i);
558 snprintf(typname, sizeof(typname), "t%d.typname", i);
559 snprintf(ft, sizeof(ft),
560 "pg_catalog.format_type(t%d.oid, NULL)", i);
561 snprintf(tiv, sizeof(tiv),
562 "pg_catalog.pg_type_is_visible(t%d.oid)", i);
563 if (!validateSQLNamePattern(&buf,
564 map_typename_pattern(arg_patterns[i]),
565 true, false,
566 nspname, typname, ft, tiv,
567 NULL, 3))
568 goto error_return;
569 }
570 else
571 {
572 /* "-" pattern specifies no such parameter */
573 appendPQExpBuffer(&buf, " AND t%d.typname IS NULL\n", i);
574 }
575 }
576
577 if (!showSystem && !func_pattern)
578 appendPQExpBufferStr(&buf, " AND n.nspname <> 'pg_catalog'\n"
579 " AND n.nspname <> 'information_schema'\n");
580
581 appendPQExpBufferStr(&buf, "ORDER BY 1, 2, 4;");
582
583 res = PSQLexec(buf.data);
584 termPQExpBuffer(&buf);
585 if (!res)
586 return false;
587
588 myopt.nullPrint = NULL;
589 myopt.title = _("List of functions");
590 myopt.translate_header = true;
591 if (pset.sversion >= 90600)
592 {
593 myopt.translate_columns = translate_columns;
594 myopt.n_translate_columns = lengthof(translate_columns);
595 }
596 else
597 {
598 myopt.translate_columns = translate_columns_pre_96;
599 myopt.n_translate_columns = lengthof(translate_columns_pre_96);
600 }
601
602 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
603
604 PQclear(res);
605 return true;
606
607 error_return:
608 termPQExpBuffer(&buf);
609 return false;
610 }
611
612
613
614 /*
615 * \dT
616 * describe types
617 */
618 bool
619 describeTypes(const char *pattern, bool verbose, bool showSystem)
620 {
621 PQExpBufferData buf;
622 PGresult *res;
623 printQueryOpt myopt = pset.popt;
624
625 initPQExpBuffer(&buf);
626
627 printfPQExpBuffer(&buf,
628 "SELECT n.nspname as \"%s\",\n"
629 " pg_catalog.format_type(t.oid, NULL) AS \"%s\",\n",
630 gettext_noop("Schema"),
631 gettext_noop("Name"));
632 if (verbose)
633 {
634 appendPQExpBuffer(&buf,
635 " t.typname AS \"%s\",\n"
636 " CASE WHEN t.typrelid != 0\n"
637 " THEN CAST('tuple' AS pg_catalog.text)\n"
638 " WHEN t.typlen < 0\n"
639 " THEN CAST('var' AS pg_catalog.text)\n"
640 " ELSE CAST(t.typlen AS pg_catalog.text)\n"
641 " END AS \"%s\",\n"
642 " pg_catalog.array_to_string(\n"
643 " ARRAY(\n"
644 " SELECT e.enumlabel\n"
645 " FROM pg_catalog.pg_enum e\n"
646 " WHERE e.enumtypid = t.oid\n"
647 " ORDER BY e.enumsortorder\n"
648 " ),\n"
649 " E'\\n'\n"
650 " ) AS \"%s\",\n"
651 " pg_catalog.pg_get_userbyid(t.typowner) AS \"%s\",\n",
652 gettext_noop("Internal name"),
653 gettext_noop("Size"),
654 gettext_noop("Elements"),
655 gettext_noop("Owner"));
656 printACLColumn(&buf, "t.typacl");
657 appendPQExpBufferStr(&buf, ",\n ");
658 }
659
660 appendPQExpBuffer(&buf,
661 " pg_catalog.obj_description(t.oid, 'pg_type') as \"%s\"\n",
662 gettext_noop("Description"));
663
664 appendPQExpBufferStr(&buf, "FROM pg_catalog.pg_type t\n"
665 " LEFT JOIN pg_catalog.pg_namespace n ON n.oid = t.typnamespace\n");
666
667 /*
668 * do not include complex types (typrelid!=0) unless they are standalone
669 * composite types
670 */
671 appendPQExpBufferStr(&buf, "WHERE (t.typrelid = 0 ");
672 appendPQExpBufferStr(&buf, "OR (SELECT c.relkind = " CppAsString2(RELKIND_COMPOSITE_TYPE)
673 " FROM pg_catalog.pg_class c "
674 "WHERE c.oid = t.typrelid))\n");
675
676 /*
677 * do not include array types unless the pattern contains []
678 */
679 if (pattern == NULL || strstr(pattern, "[]") == NULL)
680 appendPQExpBufferStr(&buf, " AND NOT EXISTS(SELECT 1 FROM pg_catalog.pg_type el WHERE el.oid = t.typelem AND el.typarray = t.oid)\n");
681
682 if (!showSystem && !pattern)
683 appendPQExpBufferStr(&buf, " AND n.nspname <> 'pg_catalog'\n"
684 " AND n.nspname <> 'information_schema'\n");
685
686 /* Match name pattern against either internal or external name */
687 if (!validateSQLNamePattern(&buf, map_typename_pattern(pattern),
688 true, false,
689 "n.nspname", "t.typname",
690 "pg_catalog.format_type(t.oid, NULL)",
691 "pg_catalog.pg_type_is_visible(t.oid)",
692 NULL, 3))
693 {
694 termPQExpBuffer(&buf);
695 return false;
696 }
697
698 appendPQExpBufferStr(&buf, "ORDER BY 1, 2;");
699
700 res = PSQLexec(buf.data);
701 termPQExpBuffer(&buf);
702 if (!res)
703 return false;
704
705 myopt.nullPrint = NULL;
706 myopt.title = _("List of data types");
707 myopt.translate_header = true;
708
709 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
710
711 PQclear(res);
712 return true;
713 }
714
715 /*
716 * Map some variant type names accepted by the backend grammar into
717 * canonical type names.
718 *
719 * Helper for \dT and other functions that take typename patterns.
720 * This doesn't completely mask the fact that these names are special;
721 * for example, a pattern of "dec*" won't magically match "numeric".
722 * But it goes a long way to reduce the surprise factor.
723 */
724 static const char *
725 map_typename_pattern(const char *pattern)
726 {
727 static const char *const typename_map[] = {
728 /*
729 * These names are accepted by gram.y, although they are neither the
730 * "real" name seen in pg_type nor the canonical name printed by
731 * format_type().
732 */
733 "decimal", "numeric",
734 "float", "double precision",
735 "int", "integer",
736
737 /*
738 * We also have to map the array names for cases where the canonical
739 * name is different from what pg_type says.
740 */
741 "bool[]", "boolean[]",
742 "decimal[]", "numeric[]",
743 "float[]", "double precision[]",
744 "float4[]", "real[]",
745 "float8[]", "double precision[]",
746 "int[]", "integer[]",
747 "int2[]", "smallint[]",
748 "int4[]", "integer[]",
749 "int8[]", "bigint[]",
750 "time[]", "time without time zone[]",
751 "timetz[]", "time with time zone[]",
752 "timestamp[]", "timestamp without time zone[]",
753 "timestamptz[]", "timestamp with time zone[]",
754 "varbit[]", "bit varying[]",
755 "varchar[]", "character varying[]",
756 NULL
757 };
758
759 if (pattern == NULL)
760 return NULL;
761 for (int i = 0; typename_map[i] != NULL; i += 2)
762 {
763 if (pg_strcasecmp(pattern, typename_map[i]) == 0)
764 return typename_map[i + 1];
765 }
766 return pattern;
767 }
768
769
770 /*
771 * \do
772 * Describe operators
773 */
774 bool
775 describeOperators(const char *oper_pattern,
776 char **arg_patterns, int num_arg_patterns,
777 bool verbose, bool showSystem)
778 {
779 PQExpBufferData buf;
780 PGresult *res;
781 printQueryOpt myopt = pset.popt;
782
783 initPQExpBuffer(&buf);
784
785 /*
786 * Note: before Postgres 9.1, we did not assign comments to any built-in
787 * operators, preferring to let the comment on the underlying function
788 * suffice. The coalesce() on the obj_description() calls below supports
789 * this convention by providing a fallback lookup of a comment on the
790 * operator's function. Since 9.1 there is a policy that every built-in
791 * operator should have a comment; so the coalesce() is no longer
792 * necessary so far as built-in operators are concerned. We keep it
793 * anyway, for now, because third-party modules may still be following the
794 * old convention.
795 *
796 * The support for postfix operators in this query is dead code as of
797 * Postgres 14, but we need to keep it for as long as we support talking
798 * to pre-v14 servers.
799 */
800
801 printfPQExpBuffer(&buf,
802 "SELECT n.nspname as \"%s\",\n"
803 " o.oprname AS \"%s\",\n"
804 " CASE WHEN o.oprkind='l' THEN NULL ELSE pg_catalog.format_type(o.oprleft, NULL) END AS \"%s\",\n"
805 " CASE WHEN o.oprkind='r' THEN NULL ELSE pg_catalog.format_type(o.oprright, NULL) END AS \"%s\",\n"
806 " pg_catalog.format_type(o.oprresult, NULL) AS \"%s\",\n",
807 gettext_noop("Schema"),
808 gettext_noop("Name"),
809 gettext_noop("Left arg type"),
810 gettext_noop("Right arg type"),
811 gettext_noop("Result type"));
812
813 if (verbose)
814 appendPQExpBuffer(&buf,
815 " o.oprcode AS \"%s\",\n",
816 gettext_noop("Function"));
817
818 appendPQExpBuffer(&buf,
819 " coalesce(pg_catalog.obj_description(o.oid, 'pg_operator'),\n"
820 " pg_catalog.obj_description(o.oprcode, 'pg_proc')) AS \"%s\"\n"
821 "FROM pg_catalog.pg_operator o\n"
822 " LEFT JOIN pg_catalog.pg_namespace n ON n.oid = o.oprnamespace\n",
823 gettext_noop("Description"));
824
825 if (num_arg_patterns >= 2)
826 {
827 num_arg_patterns = 2; /* ignore any additional arguments */
828 appendPQExpBufferStr(&buf,
829 " LEFT JOIN pg_catalog.pg_type t0 ON t0.oid = o.oprleft\n"
830 " LEFT JOIN pg_catalog.pg_namespace nt0 ON nt0.oid = t0.typnamespace\n"
831 " LEFT JOIN pg_catalog.pg_type t1 ON t1.oid = o.oprright\n"
832 " LEFT JOIN pg_catalog.pg_namespace nt1 ON nt1.oid = t1.typnamespace\n");
833 }
834 else if (num_arg_patterns == 1)
835 {
836 appendPQExpBufferStr(&buf,
837 " LEFT JOIN pg_catalog.pg_type t0 ON t0.oid = o.oprright\n"
838 " LEFT JOIN pg_catalog.pg_namespace nt0 ON nt0.oid = t0.typnamespace\n");
839 }
840
841 if (!showSystem && !oper_pattern)
842 appendPQExpBufferStr(&buf, "WHERE n.nspname <> 'pg_catalog'\n"
843 " AND n.nspname <> 'information_schema'\n");
844
845 if (!validateSQLNamePattern(&buf, oper_pattern,
846 !showSystem && !oper_pattern, true,
847 "n.nspname", "o.oprname", NULL,
848 "pg_catalog.pg_operator_is_visible(o.oid)",
849 NULL, 3))
850 goto error_return;
851
852 if (num_arg_patterns == 1)
853 appendPQExpBufferStr(&buf, " AND o.oprleft = 0\n");
854
855 for (int i = 0; i < num_arg_patterns; i++)
856 {
857 if (strcmp(arg_patterns[i], "-") != 0)
858 {
859 /*
860 * Match type-name patterns against either internal or external
861 * name, like \dT. Unlike \dT, there seems no reason to
862 * discriminate against arrays or composite types.
863 */
864 char nspname[64];
865 char typname[64];
866 char ft[64];
867 char tiv[64];
868
869 snprintf(nspname, sizeof(nspname), "nt%d.nspname", i);
870 snprintf(typname, sizeof(typname), "t%d.typname", i);
871 snprintf(ft, sizeof(ft),
872 "pg_catalog.format_type(t%d.oid, NULL)", i);
873 snprintf(tiv, sizeof(tiv),
874 "pg_catalog.pg_type_is_visible(t%d.oid)", i);
875 if (!validateSQLNamePattern(&buf,
876 map_typename_pattern(arg_patterns[i]),
877 true, false,
878 nspname, typname, ft, tiv,
879 NULL, 3))
880 goto error_return;
881 }
882 else
883 {
884 /* "-" pattern specifies no such parameter */
885 appendPQExpBuffer(&buf, " AND t%d.typname IS NULL\n", i);
886 }
887 }
888
889 appendPQExpBufferStr(&buf, "ORDER BY 1, 2, 3, 4;");
890
891 res = PSQLexec(buf.data);
892 termPQExpBuffer(&buf);
893 if (!res)
894 return false;
895
896 myopt.nullPrint = NULL;
897 myopt.title = _("List of operators");
898 myopt.translate_header = true;
899
900 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
901
902 PQclear(res);
903 return true;
904
905 error_return:
906 termPQExpBuffer(&buf);
907 return false;
908 }
909
910
911 /*
912 * listAllDbs
913 *
914 * for \l, \list, and -l switch
915 */
916 bool
917 listAllDbs(const char *pattern, bool verbose)
918 {
919 PGresult *res;
920 PQExpBufferData buf;
921 printQueryOpt myopt = pset.popt;
922
923 initPQExpBuffer(&buf);
924
925 printfPQExpBuffer(&buf,
926 "SELECT\n"
927 " d.datname as \"%s\",\n"
928 " pg_catalog.pg_get_userbyid(d.datdba) as \"%s\",\n"
929 " pg_catalog.pg_encoding_to_char(d.encoding) as \"%s\",\n",
930 gettext_noop("Name"),
931 gettext_noop("Owner"),
932 gettext_noop("Encoding"));
933 if (pset.sversion >= 150000)
934 appendPQExpBuffer(&buf,
935 " CASE d.datlocprovider WHEN 'c' THEN 'libc' WHEN 'i' THEN 'icu' END AS \"%s\",\n",
936 gettext_noop("Locale Provider"));
937 else
938 appendPQExpBuffer(&buf,
939 " 'libc' AS \"%s\",\n",
940 gettext_noop("Locale Provider"));
941 appendPQExpBuffer(&buf,
942 " d.datcollate as \"%s\",\n"
943 " d.datctype as \"%s\",\n",
944 gettext_noop("Collate"),
945 gettext_noop("Ctype"));
946 if (pset.sversion >= 150000)
947 appendPQExpBuffer(&buf,
948 " d.daticulocale as \"%s\",\n",
949 gettext_noop("ICU Locale"));
950 else
951 appendPQExpBuffer(&buf,
952 " NULL as \"%s\",\n",
953 gettext_noop("ICU Locale"));
954 if (pset.sversion >= 160000)
955 appendPQExpBuffer(&buf,
956 " d.daticurules as \"%s\",\n",
957 gettext_noop("ICU Rules"));
958 else
959 appendPQExpBuffer(&buf,
960 " NULL as \"%s\",\n",
961 gettext_noop("ICU Rules"));
962 appendPQExpBufferStr(&buf, " ");
963 printACLColumn(&buf, "d.datacl");
964 if (verbose)
965 appendPQExpBuffer(&buf,
966 ",\n CASE WHEN pg_catalog.has_database_privilege(d.datname, 'CONNECT')\n"
967 " THEN pg_catalog.pg_size_pretty(pg_catalog.pg_database_size(d.datname))\n"
968 " ELSE 'No Access'\n"
969 " END as \"%s\""
970 ",\n t.spcname as \"%s\""
971 ",\n pg_catalog.shobj_description(d.oid, 'pg_database') as \"%s\"",
972 gettext_noop("Size"),
973 gettext_noop("Tablespace"),
974 gettext_noop("Description"));
975 appendPQExpBufferStr(&buf,
976 "\nFROM pg_catalog.pg_database d\n");
977 if (verbose)
978 appendPQExpBufferStr(&buf,
979 " JOIN pg_catalog.pg_tablespace t on d.dattablespace = t.oid\n");
980
981 if (pattern)
982 {
983 if (!validateSQLNamePattern(&buf, pattern, false, false,
984 NULL, "d.datname", NULL, NULL,
985 NULL, 1))
986 {
987 termPQExpBuffer(&buf);
988 return false;
989 }
990 }
991
992 appendPQExpBufferStr(&buf, "ORDER BY 1;");
993 res = PSQLexec(buf.data);
994 termPQExpBuffer(&buf);
995 if (!res)
996 return false;
997
998 myopt.nullPrint = NULL;
999 myopt.title = _("List of databases");
1000 myopt.translate_header = true;
1001
1002 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
1003
1004 PQclear(res);
1005 return true;
1006 }
1007
1008
1009 /*
1010 * List Tables' Grant/Revoke Permissions
1011 * \z (now also \dp -- perhaps more mnemonic)
1012 */
1013 bool
1014 permissionsList(const char *pattern, bool showSystem)
1015 {
1016 PQExpBufferData buf;
1017 PGresult *res;
1018 printQueryOpt myopt = pset.popt;
1019 static const bool translate_columns[] = {false, false, true, false, false, false};
1020
1021 initPQExpBuffer(&buf);
1022
1023 /*
1024 * we ignore indexes and toast tables since they have no meaningful rights
1025 */
1026 printfPQExpBuffer(&buf,
1027 "SELECT n.nspname as \"%s\",\n"
1028 " c.relname as \"%s\",\n"
1029 " CASE c.relkind"
1030 " WHEN " CppAsString2(RELKIND_RELATION) " THEN '%s'"
1031 " WHEN " CppAsString2(RELKIND_VIEW) " THEN '%s'"
1032 " WHEN " CppAsString2(RELKIND_MATVIEW) " THEN '%s'"
1033 " WHEN " CppAsString2(RELKIND_SEQUENCE) " THEN '%s'"
1034 " WHEN " CppAsString2(RELKIND_FOREIGN_TABLE) " THEN '%s'"
1035 " WHEN " CppAsString2(RELKIND_PARTITIONED_TABLE) " THEN '%s'"
1036 " END as \"%s\",\n"
1037 " ",
1038 gettext_noop("Schema"),
1039 gettext_noop("Name"),
1040 gettext_noop("table"),
1041 gettext_noop("view"),
1042 gettext_noop("materialized view"),
1043 gettext_noop("sequence"),
1044 gettext_noop("foreign table"),
1045 gettext_noop("partitioned table"),
1046 gettext_noop("Type"));
1047
1048 printACLColumn(&buf, "c.relacl");
1049
1050 appendPQExpBuffer(&buf,
1051 ",\n pg_catalog.array_to_string(ARRAY(\n"
1052 " SELECT attname || E':\\n ' || pg_catalog.array_to_string(attacl, E'\\n ')\n"
1053 " FROM pg_catalog.pg_attribute a\n"
1054 " WHERE attrelid = c.oid AND NOT attisdropped AND attacl IS NOT NULL\n"
1055 " ), E'\\n') AS \"%s\"",
1056 gettext_noop("Column privileges"));
1057
1058 if (pset.sversion >= 90500 && pset.sversion < 100000)
1059 appendPQExpBuffer(&buf,
1060 ",\n pg_catalog.array_to_string(ARRAY(\n"
1061 " SELECT polname\n"
1062 " || CASE WHEN polcmd != '*' THEN\n"
1063 " E' (' || polcmd::pg_catalog.text || E'):'\n"
1064 " ELSE E':'\n"
1065 " END\n"
1066 " || CASE WHEN polqual IS NOT NULL THEN\n"
1067 " E'\\n (u): ' || pg_catalog.pg_get_expr(polqual, polrelid)\n"
1068 " ELSE E''\n"
1069 " END\n"
1070 " || CASE WHEN polwithcheck IS NOT NULL THEN\n"
1071 " E'\\n (c): ' || pg_catalog.pg_get_expr(polwithcheck, polrelid)\n"
1072 " ELSE E''\n"
1073 " END"
1074 " || CASE WHEN polroles <> '{0}' THEN\n"
1075 " E'\\n to: ' || pg_catalog.array_to_string(\n"
1076 " ARRAY(\n"
1077 " SELECT rolname\n"
1078 " FROM pg_catalog.pg_roles\n"
1079 " WHERE oid = ANY (polroles)\n"
1080 " ORDER BY 1\n"
1081 " ), E', ')\n"
1082 " ELSE E''\n"
1083 " END\n"
1084 " FROM pg_catalog.pg_policy pol\n"
1085 " WHERE polrelid = c.oid), E'\\n')\n"
1086 " AS \"%s\"",
1087 gettext_noop("Policies"));
1088
1089 if (pset.sversion >= 100000)
1090 appendPQExpBuffer(&buf,
1091 ",\n pg_catalog.array_to_string(ARRAY(\n"
1092 " SELECT polname\n"
1093 " || CASE WHEN NOT polpermissive THEN\n"
1094 " E' (RESTRICTIVE)'\n"
1095 " ELSE '' END\n"
1096 " || CASE WHEN polcmd != '*' THEN\n"
1097 " E' (' || polcmd::pg_catalog.text || E'):'\n"
1098 " ELSE E':'\n"
1099 " END\n"
1100 " || CASE WHEN polqual IS NOT NULL THEN\n"
1101 " E'\\n (u): ' || pg_catalog.pg_get_expr(polqual, polrelid)\n"
1102 " ELSE E''\n"
1103 " END\n"
1104 " || CASE WHEN polwithcheck IS NOT NULL THEN\n"
1105 " E'\\n (c): ' || pg_catalog.pg_get_expr(polwithcheck, polrelid)\n"
1106 " ELSE E''\n"
1107 " END"
1108 " || CASE WHEN polroles <> '{0}' THEN\n"
1109 " E'\\n to: ' || pg_catalog.array_to_string(\n"
1110 " ARRAY(\n"
1111 " SELECT rolname\n"
1112 " FROM pg_catalog.pg_roles\n"
1113 " WHERE oid = ANY (polroles)\n"
1114 " ORDER BY 1\n"
1115 " ), E', ')\n"
1116 " ELSE E''\n"
1117 " END\n"
1118 " FROM pg_catalog.pg_policy pol\n"
1119 " WHERE polrelid = c.oid), E'\\n')\n"
1120 " AS \"%s\"",
1121 gettext_noop("Policies"));
1122
1123 appendPQExpBufferStr(&buf, "\nFROM pg_catalog.pg_class c\n"
1124 " LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace\n"
1125 "WHERE c.relkind IN ("
1126 CppAsString2(RELKIND_RELATION) ","
1127 CppAsString2(RELKIND_VIEW) ","
1128 CppAsString2(RELKIND_MATVIEW) ","
1129 CppAsString2(RELKIND_SEQUENCE) ","
1130 CppAsString2(RELKIND_FOREIGN_TABLE) ","
1131 CppAsString2(RELKIND_PARTITIONED_TABLE) ")\n");
1132
1133 if (!showSystem && !pattern)
1134 appendPQExpBufferStr(&buf, " AND n.nspname <> 'pg_catalog'\n"
1135 " AND n.nspname <> 'information_schema'\n");
1136
1137 if (!validateSQLNamePattern(&buf, pattern, true, false,
1138 "n.nspname", "c.relname", NULL,
1139 "pg_catalog.pg_table_is_visible(c.oid)",
1140 NULL, 3))
1141 goto error_return;
1142
1143 appendPQExpBufferStr(&buf, "ORDER BY 1, 2;");
1144
1145 res = PSQLexec(buf.data);
1146 if (!res)
1147 goto error_return;
1148
1149 myopt.nullPrint = NULL;
1150 printfPQExpBuffer(&buf, _("Access privileges"));
1151 myopt.title = buf.data;
1152 myopt.translate_header = true;
1153 myopt.translate_columns = translate_columns;
1154 myopt.n_translate_columns = lengthof(translate_columns);
1155
1156 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
1157
1158 termPQExpBuffer(&buf);
1159 PQclear(res);
1160 return true;
1161
1162 error_return:
1163 termPQExpBuffer(&buf);
1164 return false;
1165 }
1166
1167
1168 /*
1169 * \ddp
1170 *
1171 * List Default ACLs. The pattern can match either schema or role name.
1172 */
1173 bool
1174 listDefaultACLs(const char *pattern)
1175 {
1176 PQExpBufferData buf;
1177 PGresult *res;
1178 printQueryOpt myopt = pset.popt;
1179 static const bool translate_columns[] = {false, false, true, false};
1180
1181 initPQExpBuffer(&buf);
1182
1183 printfPQExpBuffer(&buf,
1184 "SELECT pg_catalog.pg_get_userbyid(d.defaclrole) AS \"%s\",\n"
1185 " n.nspname AS \"%s\",\n"
1186 " CASE d.defaclobjtype WHEN '%c' THEN '%s' WHEN '%c' THEN '%s' WHEN '%c' THEN '%s' WHEN '%c' THEN '%s' WHEN '%c' THEN '%s' END AS \"%s\",\n"
1187 " ",
1188 gettext_noop("Owner"),
1189 gettext_noop("Schema"),
1190 DEFACLOBJ_RELATION,
1191 gettext_noop("table"),
1192 DEFACLOBJ_SEQUENCE,
1193 gettext_noop("sequence"),
1194 DEFACLOBJ_FUNCTION,
1195 gettext_noop("function"),
1196 DEFACLOBJ_TYPE,
1197 gettext_noop("type"),
1198 DEFACLOBJ_NAMESPACE,
1199 gettext_noop("schema"),
1200 gettext_noop("Type"));
1201
1202 printACLColumn(&buf, "d.defaclacl");
1203
1204 appendPQExpBufferStr(&buf, "\nFROM pg_catalog.pg_default_acl d\n"
1205 " LEFT JOIN pg_catalog.pg_namespace n ON n.oid = d.defaclnamespace\n");
1206
1207 if (!validateSQLNamePattern(&buf, pattern, false, false,
1208 NULL,
1209 "n.nspname",
1210 "pg_catalog.pg_get_userbyid(d.defaclrole)",
1211 NULL,
1212 NULL, 3))
1213 goto error_return;
1214
1215 appendPQExpBufferStr(&buf, "ORDER BY 1, 2, 3;");
1216
1217 res = PSQLexec(buf.data);
1218 if (!res)
1219 goto error_return;
1220
1221 myopt.nullPrint = NULL;
1222 printfPQExpBuffer(&buf, _("Default access privileges"));
1223 myopt.title = buf.data;
1224 myopt.translate_header = true;
1225 myopt.translate_columns = translate_columns;
1226 myopt.n_translate_columns = lengthof(translate_columns);
1227
1228 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
1229
1230 termPQExpBuffer(&buf);
1231 PQclear(res);
1232 return true;
1233
1234 error_return:
1235 termPQExpBuffer(&buf);
1236 return false;
1237 }
1238
1239
1240 /*
1241 * Get object comments
1242 *
1243 * \dd [foo]
1244 *
1245 * Note: This command only lists comments for object types which do not have
1246 * their comments displayed by their own backslash commands. The following
1247 * types of objects will be displayed: constraint, operator class,
1248 * operator family, rule, and trigger.
1249 *
1250 */
1251 bool
1252 objectDescription(const char *pattern, bool showSystem)
1253 {
1254 PQExpBufferData buf;
1255 PGresult *res;
1256 printQueryOpt myopt = pset.popt;
1257 static const bool translate_columns[] = {false, false, true, false};
1258
1259 initPQExpBuffer(&buf);
1260
1261 appendPQExpBuffer(&buf,
1262 "SELECT DISTINCT tt.nspname AS \"%s\", tt.name AS \"%s\", tt.object AS \"%s\", d.description AS \"%s\"\n"
1263 "FROM (\n",
1264 gettext_noop("Schema"),
1265 gettext_noop("Name"),
1266 gettext_noop("Object"),
1267 gettext_noop("Description"));
1268
1269 /* Table constraint descriptions */
1270 appendPQExpBuffer(&buf,
1271 " SELECT pgc.oid as oid, pgc.tableoid AS tableoid,\n"
1272 " n.nspname as nspname,\n"
1273 " CAST(pgc.conname AS pg_catalog.text) as name,"
1274 " CAST('%s' AS pg_catalog.text) as object\n"
1275 " FROM pg_catalog.pg_constraint pgc\n"
1276 " JOIN pg_catalog.pg_class c "
1277 "ON c.oid = pgc.conrelid\n"
1278 " LEFT JOIN pg_catalog.pg_namespace n "
1279 " ON n.oid = c.relnamespace\n",
1280 gettext_noop("table constraint"));
1281
1282 if (!showSystem && !pattern)
1283 appendPQExpBufferStr(&buf, "WHERE n.nspname <> 'pg_catalog'\n"
1284 " AND n.nspname <> 'information_schema'\n");
1285
1286 if (!validateSQLNamePattern(&buf, pattern, !showSystem && !pattern,
1287 false, "n.nspname", "pgc.conname", NULL,
1288 "pg_catalog.pg_table_is_visible(c.oid)",
1289 NULL, 3))
1290 goto error_return;
1291
1292 /* Domain constraint descriptions */
1293 appendPQExpBuffer(&buf,
1294 "UNION ALL\n"
1295 " SELECT pgc.oid as oid, pgc.tableoid AS tableoid,\n"
1296 " n.nspname as nspname,\n"
1297 " CAST(pgc.conname AS pg_catalog.text) as name,"
1298 " CAST('%s' AS pg_catalog.text) as object\n"
1299 " FROM pg_catalog.pg_constraint pgc\n"
1300 " JOIN pg_catalog.pg_type t "
1301 "ON t.oid = pgc.contypid\n"
1302 " LEFT JOIN pg_catalog.pg_namespace n "
1303 " ON n.oid = t.typnamespace\n",
1304 gettext_noop("domain constraint"));
1305
1306 if (!showSystem && !pattern)
1307 appendPQExpBufferStr(&buf, "WHERE n.nspname <> 'pg_catalog'\n"
1308 " AND n.nspname <> 'information_schema'\n");
1309
1310 if (!validateSQLNamePattern(&buf, pattern, !showSystem && !pattern,
1311 false, "n.nspname", "pgc.conname", NULL,
1312 "pg_catalog.pg_type_is_visible(t.oid)",
1313 NULL, 3))
1314 goto error_return;
1315
1316 /* Operator class descriptions */
1317 appendPQExpBuffer(&buf,
1318 "UNION ALL\n"
1319 " SELECT o.oid as oid, o.tableoid as tableoid,\n"
1320 " n.nspname as nspname,\n"
1321 " CAST(o.opcname AS pg_catalog.text) as name,\n"
1322 " CAST('%s' AS pg_catalog.text) as object\n"
1323 " FROM pg_catalog.pg_opclass o\n"
1324 " JOIN pg_catalog.pg_am am ON "
1325 "o.opcmethod = am.oid\n"
1326 " JOIN pg_catalog.pg_namespace n ON "
1327 "n.oid = o.opcnamespace\n",
1328 gettext_noop("operator class"));
1329
1330 if (!showSystem && !pattern)
1331 appendPQExpBufferStr(&buf, " AND n.nspname <> 'pg_catalog'\n"
1332 " AND n.nspname <> 'information_schema'\n");
1333
1334 if (!validateSQLNamePattern(&buf, pattern, true, false,
1335 "n.nspname", "o.opcname", NULL,
1336 "pg_catalog.pg_opclass_is_visible(o.oid)",
1337 NULL, 3))
1338 goto error_return;
1339
1340 /* Operator family descriptions */
1341 appendPQExpBuffer(&buf,
1342 "UNION ALL\n"
1343 " SELECT opf.oid as oid, opf.tableoid as tableoid,\n"
1344 " n.nspname as nspname,\n"
1345 " CAST(opf.opfname AS pg_catalog.text) AS name,\n"
1346 " CAST('%s' AS pg_catalog.text) as object\n"
1347 " FROM pg_catalog.pg_opfamily opf\n"
1348 " JOIN pg_catalog.pg_am am "
1349 "ON opf.opfmethod = am.oid\n"
1350 " JOIN pg_catalog.pg_namespace n "
1351 "ON opf.opfnamespace = n.oid\n",
1352 gettext_noop("operator family"));
1353
1354 if (!showSystem && !pattern)
1355 appendPQExpBufferStr(&buf, " AND n.nspname <> 'pg_catalog'\n"
1356 " AND n.nspname <> 'information_schema'\n");
1357
1358 if (!validateSQLNamePattern(&buf, pattern, true, false,
1359 "n.nspname", "opf.opfname", NULL,
1360 "pg_catalog.pg_opfamily_is_visible(opf.oid)",
1361 NULL, 3))
1362 goto error_return;
1363
1364 /* Rule descriptions (ignore rules for views) */
1365 appendPQExpBuffer(&buf,
1366 "UNION ALL\n"
1367 " SELECT r.oid as oid, r.tableoid as tableoid,\n"
1368 " n.nspname as nspname,\n"
1369 " CAST(r.rulename AS pg_catalog.text) as name,"
1370 " CAST('%s' AS pg_catalog.text) as object\n"
1371 " FROM pg_catalog.pg_rewrite r\n"
1372 " JOIN pg_catalog.pg_class c ON c.oid = r.ev_class\n"
1373 " LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace\n"
1374 " WHERE r.rulename != '_RETURN'\n",
1375 gettext_noop("rule"));
1376
1377 if (!showSystem && !pattern)
1378 appendPQExpBufferStr(&buf, " AND n.nspname <> 'pg_catalog'\n"
1379 " AND n.nspname <> 'information_schema'\n");
1380
1381 if (!validateSQLNamePattern(&buf, pattern, true, false,
1382 "n.nspname", "r.rulename", NULL,
1383 "pg_catalog.pg_table_is_visible(c.oid)",
1384 NULL, 3))
1385 goto error_return;
1386
1387 /* Trigger descriptions */
1388 appendPQExpBuffer(&buf,
1389 "UNION ALL\n"
1390 " SELECT t.oid as oid, t.tableoid as tableoid,\n"
1391 " n.nspname as nspname,\n"
1392 " CAST(t.tgname AS pg_catalog.text) as name,"
1393 " CAST('%s' AS pg_catalog.text) as object\n"
1394 " FROM pg_catalog.pg_trigger t\n"
1395 " JOIN pg_catalog.pg_class c ON c.oid = t.tgrelid\n"
1396 " LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace\n",
1397 gettext_noop("trigger"));
1398
1399 if (!showSystem && !pattern)
1400 appendPQExpBufferStr(&buf, "WHERE n.nspname <> 'pg_catalog'\n"
1401 " AND n.nspname <> 'information_schema'\n");
1402
1403 if (!validateSQLNamePattern(&buf, pattern, !showSystem && !pattern, false,
1404 "n.nspname", "t.tgname", NULL,
1405 "pg_catalog.pg_table_is_visible(c.oid)",
1406 NULL, 3))
1407 goto error_return;
1408
1409 appendPQExpBufferStr(&buf,
1410 ") AS tt\n"
1411 " JOIN pg_catalog.pg_description d ON (tt.oid = d.objoid AND tt.tableoid = d.classoid AND d.objsubid = 0)\n");
1412
1413 appendPQExpBufferStr(&buf, "ORDER BY 1, 2, 3;");
1414
1415 res = PSQLexec(buf.data);
1416 termPQExpBuffer(&buf);
1417 if (!res)
1418 return false;
1419
1420 myopt.nullPrint = NULL;
1421 myopt.title = _("Object descriptions");
1422 myopt.translate_header = true;
1423 myopt.translate_columns = translate_columns;
1424 myopt.n_translate_columns = lengthof(translate_columns);
1425
1426 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
1427
1428 PQclear(res);
1429 return true;
1430
1431 error_return:
1432 termPQExpBuffer(&buf);
1433 return false;
1434 }
1435
1436
1437 /*
1438 * describeTableDetails (for \d)
1439 *
1440 * This routine finds the tables to be displayed, and calls
1441 * describeOneTableDetails for each one.
1442 *
1443 * verbose: if true, this is \d+
1444 */
1445 bool
1446 describeTableDetails(const char *pattern, bool verbose, bool showSystem)
1447 {
1448 PQExpBufferData buf;
1449 PGresult *res;
1450 int i;
1451
1452 initPQExpBuffer(&buf);
1453
1454 printfPQExpBuffer(&buf,
1455 "SELECT c.oid,\n"
1456 " n.nspname,\n"
1457 " c.relname\n"
1458 "FROM pg_catalog.pg_class c\n"
1459 " LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace\n");
1460
1461 if (!showSystem && !pattern)
1462 appendPQExpBufferStr(&buf, "WHERE n.nspname <> 'pg_catalog'\n"
1463 " AND n.nspname <> 'information_schema'\n");
1464
1465 if (!validateSQLNamePattern(&buf, pattern, !showSystem && !pattern, false,
1466 "n.nspname", "c.relname", NULL,
1467 "pg_catalog.pg_table_is_visible(c.oid)",
1468 NULL, 3))
1469 {
1470 termPQExpBuffer(&buf);
1471 return false;
1472 }
1473
1474 appendPQExpBufferStr(&buf, "ORDER BY 2, 3;");
1475
1476 res = PSQLexec(buf.data);
1477 termPQExpBuffer(&buf);
1478 if (!res)
1479 return false;
1480
1481 if (PQntuples(res) == 0)
1482 {
1483 if (!pset.quiet)
1484 {
1485 if (pattern)
1486 pg_log_error("Did not find any relation named \"%s\".",
1487 pattern);
1488 else
1489 pg_log_error("Did not find any relations.");
1490 }
1491 PQclear(res);
1492 return false;
1493 }
1494
1495 for (i = 0; i < PQntuples(res); i++)
1496 {
1497 const char *oid;
1498 const char *nspname;
1499 const char *relname;
1500
1501 oid = PQgetvalue(res, i, 0);
1502 nspname = PQgetvalue(res, i, 1);
1503 relname = PQgetvalue(res, i, 2);
1504
1505 if (!describeOneTableDetails(nspname, relname, oid, verbose))
1506 {
1507 PQclear(res);
1508 return false;
1509 }
1510 if (cancel_pressed)
1511 {
1512 PQclear(res);
1513 return false;
1514 }
1515 }
1516
1517 PQclear(res);
1518 return true;
1519 }
1520
1521 /*
1522 * describeOneTableDetails (for \d)
1523 *
1524 * Unfortunately, the information presented here is so complicated that it
1525 * cannot be done in a single query. So we have to assemble the printed table
1526 * by hand and pass it to the underlying printTable() function.
1527 */
1528 static bool
1529 describeOneTableDetails(const char *schemaname,
1530 const char *relationname,
1531 const char *oid,
1532 bool verbose)
1533 {
1534 bool retval = false;
1535 PQExpBufferData buf;
1536 PGresult *res = NULL;
1537 printTableOpt myopt = pset.popt.topt;
1538 printTableContent cont;
1539 bool printTableInitialized = false;
1540 int i;
1541 char *view_def = NULL;
1542 char *headers[12];
1543 PQExpBufferData title;
1544 PQExpBufferData tmpbuf;
1545 int cols;
1546 int attname_col = -1, /* column indexes in "res" */
1547 atttype_col = -1,
1548 attrdef_col = -1,
1549 attnotnull_col = -1,
1550 attcoll_col = -1,
1551 attidentity_col = -1,
1552 attgenerated_col = -1,
1553 isindexkey_col = -1,
1554 indexdef_col = -1,
1555 fdwopts_col = -1,
1556 attstorage_col = -1,
1557 attcompression_col = -1,
1558 attstattarget_col = -1,
1559 attdescr_col = -1;
1560 int numrows;
1561 struct
1562 {
1563 int16 checks;
1564 char relkind;
1565 bool hasindex;
1566 bool hasrules;
1567 bool hastriggers;
1568 bool rowsecurity;
1569 bool forcerowsecurity;
1570 bool hasoids;
1571 bool ispartition;
1572 Oid tablespace;
1573 char *reloptions;
1574 char *reloftype;
1575 char relpersistence;
1576 char relreplident;
1577 char *relam;
1578 } tableinfo;
1579 bool show_column_details = false;
1580
1581 myopt.default_footer = false;
1582 /* This output looks confusing in expanded mode. */
1583 myopt.expanded = false;
1584
1585 initPQExpBuffer(&buf);
1586 initPQExpBuffer(&title);
1587 initPQExpBuffer(&tmpbuf);
1588
1589 /* Get general table info */
1590 if (pset.sversion >= 120000)
1591 {
1592 printfPQExpBuffer(&buf,
1593 "SELECT c.relchecks, c.relkind, c.relhasindex, c.relhasrules, "
1594 "c.relhastriggers, c.relrowsecurity, c.relforcerowsecurity, "
1595 "false AS relhasoids, c.relispartition, %s, c.reltablespace, "
1596 "CASE WHEN c.reloftype = 0 THEN '' ELSE c.reloftype::pg_catalog.regtype::pg_catalog.text END, "
1597 "c.relpersistence, c.relreplident, am.amname\n"
1598 "FROM pg_catalog.pg_class c\n "
1599 "LEFT JOIN pg_catalog.pg_class tc ON (c.reltoastrelid = tc.oid)\n"
1600 "LEFT JOIN pg_catalog.pg_am am ON (c.relam = am.oid)\n"
1601 "WHERE c.oid = '%s';",
1602 (verbose ?
1603 "pg_catalog.array_to_string(c.reloptions || "
1604 "array(select 'toast.' || x from pg_catalog.unnest(tc.reloptions) x), ', ')\n"
1605 : "''"),
1606 oid);
1607 }
1608 else if (pset.sversion >= 100000)
1609 {
1610 printfPQExpBuffer(&buf,
1611 "SELECT c.relchecks, c.relkind, c.relhasindex, c.relhasrules, "
1612 "c.relhastriggers, c.relrowsecurity, c.relforcerowsecurity, "
1613 "c.relhasoids, c.relispartition, %s, c.reltablespace, "
1614 "CASE WHEN c.reloftype = 0 THEN '' ELSE c.reloftype::pg_catalog.regtype::pg_catalog.text END, "
1615 "c.relpersistence, c.relreplident\n"
1616 "FROM pg_catalog.pg_class c\n "
1617 "LEFT JOIN pg_catalog.pg_class tc ON (c.reltoastrelid = tc.oid)\n"
1618 "WHERE c.oid = '%s';",
1619 (verbose ?
1620 "pg_catalog.array_to_string(c.reloptions || "
1621 "array(select 'toast.' || x from pg_catalog.unnest(tc.reloptions) x), ', ')\n"
1622 : "''"),
1623 oid);
1624 }
1625 else if (pset.sversion >= 90500)
1626 {
1627 printfPQExpBuffer(&buf,
1628 "SELECT c.relchecks, c.relkind, c.relhasindex, c.relhasrules, "
1629 "c.relhastriggers, c.relrowsecurity, c.relforcerowsecurity, "
1630 "c.relhasoids, false as relispartition, %s, c.reltablespace, "
1631 "CASE WHEN c.reloftype = 0 THEN '' ELSE c.reloftype::pg_catalog.regtype::pg_catalog.text END, "
1632 "c.relpersistence, c.relreplident\n"
1633 "FROM pg_catalog.pg_class c\n "
1634 "LEFT JOIN pg_catalog.pg_class tc ON (c.reltoastrelid = tc.oid)\n"
1635 "WHERE c.oid = '%s';",
1636 (verbose ?
1637 "pg_catalog.array_to_string(c.reloptions || "
1638 "array(select 'toast.' || x from pg_catalog.unnest(tc.reloptions) x), ', ')\n"
1639 : "''"),
1640 oid);
1641 }
1642 else if (pset.sversion >= 90400)
1643 {
1644 printfPQExpBuffer(&buf,
1645 "SELECT c.relchecks, c.relkind, c.relhasindex, c.relhasrules, "
1646 "c.relhastriggers, false, false, c.relhasoids, "
1647 "false as relispartition, %s, c.reltablespace, "
1648 "CASE WHEN c.reloftype = 0 THEN '' ELSE c.reloftype::pg_catalog.regtype::pg_catalog.text END, "
1649 "c.relpersistence, c.relreplident\n"
1650 "FROM pg_catalog.pg_class c\n "
1651 "LEFT JOIN pg_catalog.pg_class tc ON (c.reltoastrelid = tc.oid)\n"
1652 "WHERE c.oid = '%s';",
1653 (verbose ?
1654 "pg_catalog.array_to_string(c.reloptions || "
1655 "array(select 'toast.' || x from pg_catalog.unnest(tc.reloptions) x), ', ')\n"
1656 : "''"),
1657 oid);
1658 }
1659 else
1660 {
1661 printfPQExpBuffer(&buf,
1662 "SELECT c.relchecks, c.relkind, c.relhasindex, c.relhasrules, "
1663 "c.relhastriggers, false, false, c.relhasoids, "
1664 "false as relispartition, %s, c.reltablespace, "
1665 "CASE WHEN c.reloftype = 0 THEN '' ELSE c.reloftype::pg_catalog.regtype::pg_catalog.text END, "
1666 "c.relpersistence\n"
1667 "FROM pg_catalog.pg_class c\n "
1668 "LEFT JOIN pg_catalog.pg_class tc ON (c.reltoastrelid = tc.oid)\n"
1669 "WHERE c.oid = '%s';",
1670 (verbose ?
1671 "pg_catalog.array_to_string(c.reloptions || "
1672 "array(select 'toast.' || x from pg_catalog.unnest(tc.reloptions) x), ', ')\n"
1673 : "''"),
1674 oid);
1675 }
1676
1677 res = PSQLexec(buf.data);
1678 if (!res)
1679 goto error_return;
1680
1681 /* Did we get anything? */
1682 if (PQntuples(res) == 0)
1683 {
1684 if (!pset.quiet)
1685 pg_log_error("Did not find any relation with OID %s.", oid);
1686 goto error_return;
1687 }
1688
1689 tableinfo.checks = atoi(PQgetvalue(res, 0, 0));
1690 tableinfo.relkind = *(PQgetvalue(res, 0, 1));
1691 tableinfo.hasindex = strcmp(PQgetvalue(res, 0, 2), "t") == 0;
1692 tableinfo.hasrules = strcmp(PQgetvalue(res, 0, 3), "t") == 0;
1693 tableinfo.hastriggers = strcmp(PQgetvalue(res, 0, 4), "t") == 0;
1694 tableinfo.rowsecurity = strcmp(PQgetvalue(res, 0, 5), "t") == 0;
1695 tableinfo.forcerowsecurity = strcmp(PQgetvalue(res, 0, 6), "t") == 0;
1696 tableinfo.hasoids = strcmp(PQgetvalue(res, 0, 7), "t") == 0;
1697 tableinfo.ispartition = strcmp(PQgetvalue(res, 0, 8), "t") == 0;
1698 tableinfo.reloptions = pg_strdup(PQgetvalue(res, 0, 9));
1699 tableinfo.tablespace = atooid(PQgetvalue(res, 0, 10));
1700 tableinfo.reloftype = (strcmp(PQgetvalue(res, 0, 11), "") != 0) ?
1701 pg_strdup(PQgetvalue(res, 0, 11)) : NULL;
1702 tableinfo.relpersistence = *(PQgetvalue(res, 0, 12));
1703 tableinfo.relreplident = (pset.sversion >= 90400) ?
1704 *(PQgetvalue(res, 0, 13)) : 'd';
1705 if (pset.sversion >= 120000)
1706 tableinfo.relam = PQgetisnull(res, 0, 14) ?
1707 (char *) NULL : pg_strdup(PQgetvalue(res, 0, 14));
1708 else
1709 tableinfo.relam = NULL;
1710 PQclear(res);
1711 res = NULL;
1712
1713 /*
1714 * If it's a sequence, deal with it here separately.
1715 */
1716 if (tableinfo.relkind == RELKIND_SEQUENCE)
1717 {
1718 PGresult *result = NULL;
1719 printQueryOpt myopt = pset.popt;
1720 char *footers[2] = {NULL, NULL};
1721
1722 if (pset.sversion >= 100000)
1723 {
1724 printfPQExpBuffer(&buf,
1725 "SELECT pg_catalog.format_type(seqtypid, NULL) AS \"%s\",\n"
1726 " seqstart AS \"%s\",\n"
1727 " seqmin AS \"%s\",\n"
1728 " seqmax AS \"%s\",\n"
1729 " seqincrement AS \"%s\",\n"
1730 " CASE WHEN seqcycle THEN '%s' ELSE '%s' END AS \"%s\",\n"
1731 " seqcache AS \"%s\"\n",
1732 gettext_noop("Type"),
1733 gettext_noop("Start"),
1734 gettext_noop("Minimum"),
1735 gettext_noop("Maximum"),
1736 gettext_noop("Increment"),
1737 gettext_noop("yes"),
1738 gettext_noop("no"),
1739 gettext_noop("Cycles?"),
1740 gettext_noop("Cache"));
1741 appendPQExpBuffer(&buf,
1742 "FROM pg_catalog.pg_sequence\n"
1743 "WHERE seqrelid = '%s';",
1744 oid);
1745 }
1746 else
1747 {
1748 printfPQExpBuffer(&buf,
1749 "SELECT 'bigint' AS \"%s\",\n"
1750 " start_value AS \"%s\",\n"
1751 " min_value AS \"%s\",\n"
1752 " max_value AS \"%s\",\n"
1753 " increment_by AS \"%s\",\n"
1754 " CASE WHEN is_cycled THEN '%s' ELSE '%s' END AS \"%s\",\n"
1755 " cache_value AS \"%s\"\n",
1756 gettext_noop("Type"),
1757 gettext_noop("Start"),
1758 gettext_noop("Minimum"),
1759 gettext_noop("Maximum"),
1760 gettext_noop("Increment"),
1761 gettext_noop("yes"),
1762 gettext_noop("no"),
1763 gettext_noop("Cycles?"),
1764 gettext_noop("Cache"));
1765 appendPQExpBuffer(&buf, "FROM %s", fmtId(schemaname));
1766 /* must be separate because fmtId isn't reentrant */
1767 appendPQExpBuffer(&buf, ".%s;", fmtId(relationname));
1768 }
1769
1770 res = PSQLexec(buf.data);
1771 if (!res)
1772 goto error_return;
1773
1774 /* Get the column that owns this sequence */
1775 printfPQExpBuffer(&buf, "SELECT pg_catalog.quote_ident(nspname) || '.' ||"
1776 "\n pg_catalog.quote_ident(relname) || '.' ||"
1777 "\n pg_catalog.quote_ident(attname),"
1778 "\n d.deptype"
1779 "\nFROM pg_catalog.pg_class c"
1780 "\nINNER JOIN pg_catalog.pg_depend d ON c.oid=d.refobjid"
1781 "\nINNER JOIN pg_catalog.pg_namespace n ON n.oid=c.relnamespace"
1782 "\nINNER JOIN pg_catalog.pg_attribute a ON ("
1783 "\n a.attrelid=c.oid AND"
1784 "\n a.attnum=d.refobjsubid)"
1785 "\nWHERE d.classid='pg_catalog.pg_class'::pg_catalog.regclass"
1786 "\n AND d.refclassid='pg_catalog.pg_class'::pg_catalog.regclass"
1787 "\n AND d.objid='%s'"
1788 "\n AND d.deptype IN ('a', 'i')",
1789 oid);
1790
1791 result = PSQLexec(buf.data);
1792
1793 /*
1794 * If we get no rows back, don't show anything (obviously). We should
1795 * never get more than one row back, but if we do, just ignore it and
1796 * don't print anything.
1797 */
1798 if (!result)
1799 goto error_return;
1800 else if (PQntuples(result) == 1)
1801 {
1802 switch (PQgetvalue(result, 0, 1)[0])
1803 {
1804 case 'a':
1805 footers[0] = psprintf(_("Owned by: %s"),
1806 PQgetvalue(result, 0, 0));
1807 break;
1808 case 'i':
1809 footers[0] = psprintf(_("Sequence for identity column: %s"),
1810 PQgetvalue(result, 0, 0));
1811 break;
1812 }
1813 }
1814 PQclear(result);
1815
1816 if (tableinfo.relpersistence == 'u')
1817 printfPQExpBuffer(&title, _("Unlogged sequence \"%s.%s\""),
1818 schemaname, relationname);
1819 else
1820 printfPQExpBuffer(&title, _("Sequence \"%s.%s\""),
1821 schemaname, relationname);
1822
1823 myopt.footers = footers;
1824 myopt.topt.default_footer = false;
1825 myopt.title = title.data;
1826 myopt.translate_header = true;
1827
1828 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
1829
1830 free(footers[0]);
1831
1832 retval = true;
1833 goto error_return; /* not an error, just return early */
1834 }
1835
1836 /* Identify whether we should print collation, nullable, default vals */
1837 if (tableinfo.relkind == RELKIND_RELATION ||
1838 tableinfo.relkind == RELKIND_VIEW ||
1839 tableinfo.relkind == RELKIND_MATVIEW ||
1840 tableinfo.relkind == RELKIND_FOREIGN_TABLE ||
1841 tableinfo.relkind == RELKIND_COMPOSITE_TYPE ||
1842 tableinfo.relkind == RELKIND_PARTITIONED_TABLE)
1843 show_column_details = true;
1844
1845 /*
1846 * Get per-column info
1847 *
1848 * Since the set of query columns we need varies depending on relkind and
1849 * server version, we compute all the column numbers on-the-fly. Column
1850 * number variables for columns not fetched are left as -1; this avoids
1851 * duplicative test logic below.
1852 */
1853 cols = 0;
1854 printfPQExpBuffer(&buf, "SELECT a.attname");
1855 attname_col = cols++;
1856 appendPQExpBufferStr(&buf, ",\n pg_catalog.format_type(a.atttypid, a.atttypmod)");
1857 atttype_col = cols++;
1858
1859 if (show_column_details)
1860 {
1861 /* use "pretty" mode for expression to avoid excessive parentheses */
1862 appendPQExpBufferStr(&buf,
1863 ",\n (SELECT pg_catalog.pg_get_expr(d.adbin, d.adrelid, true)"
1864 "\n FROM pg_catalog.pg_attrdef d"
1865 "\n WHERE d.adrelid = a.attrelid AND d.adnum = a.attnum AND a.atthasdef)"
1866 ",\n a.attnotnull");
1867 attrdef_col = cols++;
1868 attnotnull_col = cols++;
1869 appendPQExpBufferStr(&buf, ",\n (SELECT c.collname FROM pg_catalog.pg_collation c, pg_catalog.pg_type t\n"
1870 " WHERE c.oid = a.attcollation AND t.oid = a.atttypid AND a.attcollation <> t.typcollation) AS attcollation");
1871 attcoll_col = cols++;
1872 if (pset.sversion >= 100000)
1873 appendPQExpBufferStr(&buf, ",\n a.attidentity");
1874 else
1875 appendPQExpBufferStr(&buf, ",\n ''::pg_catalog.char AS attidentity");
1876 attidentity_col = cols++;
1877 if (pset.sversion >= 120000)
1878 appendPQExpBufferStr(&buf, ",\n a.attgenerated");
1879 else
1880 appendPQExpBufferStr(&buf, ",\n ''::pg_catalog.char AS attgenerated");
1881 attgenerated_col = cols++;
1882 }
1883 if (tableinfo.relkind == RELKIND_INDEX ||
1884 tableinfo.relkind == RELKIND_PARTITIONED_INDEX)
1885 {
1886 if (pset.sversion >= 110000)
1887 {
1888 appendPQExpBuffer(&buf, ",\n CASE WHEN a.attnum <= (SELECT i.indnkeyatts FROM pg_catalog.pg_index i WHERE i.indexrelid = '%s') THEN '%s' ELSE '%s' END AS is_key",
1889 oid,
1890 gettext_noop("yes"),
1891 gettext_noop("no"));
1892 isindexkey_col = cols++;
1893 }
1894 appendPQExpBufferStr(&buf, ",\n pg_catalog.pg_get_indexdef(a.attrelid, a.attnum, TRUE) AS indexdef");
1895 indexdef_col = cols++;
1896 }
1897 /* FDW options for foreign table column */
1898 if (tableinfo.relkind == RELKIND_FOREIGN_TABLE)
1899 {
1900 appendPQExpBufferStr(&buf, ",\n CASE WHEN attfdwoptions IS NULL THEN '' ELSE "
1901 " '(' || pg_catalog.array_to_string(ARRAY(SELECT pg_catalog.quote_ident(option_name) || ' ' || pg_catalog.quote_literal(option_value) FROM "
1902 " pg_catalog.pg_options_to_table(attfdwoptions)), ', ') || ')' END AS attfdwoptions");
1903 fdwopts_col = cols++;
1904 }
1905 if (verbose)
1906 {
1907 appendPQExpBufferStr(&buf, ",\n a.attstorage");
1908 attstorage_col = cols++;
1909
1910 /* compression info, if relevant to relkind */
1911 if (pset.sversion >= 140000 &&
1912 !pset.hide_compression &&
1913 (tableinfo.relkind == RELKIND_RELATION ||
1914 tableinfo.relkind == RELKIND_PARTITIONED_TABLE ||
1915 tableinfo.relkind == RELKIND_MATVIEW))
1916 {
1917 appendPQExpBufferStr(&buf, ",\n a.attcompression AS attcompression");
1918 attcompression_col = cols++;
1919 }
1920
1921 /* stats target, if relevant to relkind */
1922 if (tableinfo.relkind == RELKIND_RELATION ||
1923 tableinfo.relkind == RELKIND_INDEX ||
1924 tableinfo.relkind == RELKIND_PARTITIONED_INDEX ||
1925 tableinfo.relkind == RELKIND_MATVIEW ||
1926 tableinfo.relkind == RELKIND_FOREIGN_TABLE ||
1927 tableinfo.relkind == RELKIND_PARTITIONED_TABLE)
1928 {
1929 appendPQExpBufferStr(&buf, ",\n CASE WHEN a.attstattarget=-1 THEN NULL ELSE a.attstattarget END AS attstattarget");
1930 attstattarget_col = cols++;
1931 }
1932
1933 /*
1934 * In 9.0+, we have column comments for: relations, views, composite
1935 * types, and foreign tables (cf. CommentObject() in comment.c).
1936 */
1937 if (tableinfo.relkind == RELKIND_RELATION ||
1938 tableinfo.relkind == RELKIND_VIEW ||
1939 tableinfo.relkind == RELKIND_MATVIEW ||
1940 tableinfo.relkind == RELKIND_FOREIGN_TABLE ||
1941 tableinfo.relkind == RELKIND_COMPOSITE_TYPE ||
1942 tableinfo.relkind == RELKIND_PARTITIONED_TABLE)
1943 {
1944 appendPQExpBufferStr(&buf, ",\n pg_catalog.col_description(a.attrelid, a.attnum)");
1945 attdescr_col = cols++;
1946 }
1947 }
1948
1949 appendPQExpBufferStr(&buf, "\nFROM pg_catalog.pg_attribute a");
1950 appendPQExpBuffer(&buf, "\nWHERE a.attrelid = '%s' AND a.attnum > 0 AND NOT a.attisdropped", oid);
1951 appendPQExpBufferStr(&buf, "\nORDER BY a.attnum;");
1952
1953 res = PSQLexec(buf.data);
1954 if (!res)
1955 goto error_return;
1956 numrows = PQntuples(res);
1957
1958 /* Make title */
1959 switch (tableinfo.relkind)
1960 {
1961 case RELKIND_RELATION:
1962 if (tableinfo.relpersistence == 'u')
1963 printfPQExpBuffer(&title, _("Unlogged table \"%s.%s\""),
1964 schemaname, relationname);
1965 else
1966 printfPQExpBuffer(&title, _("Table \"%s.%s\""),
1967 schemaname, relationname);
1968 break;
1969 case RELKIND_VIEW:
1970 printfPQExpBuffer(&title, _("View \"%s.%s\""),
1971 schemaname, relationname);
1972 break;
1973 case RELKIND_MATVIEW:
1974 if (tableinfo.relpersistence == 'u')
1975 printfPQExpBuffer(&title, _("Unlogged materialized view \"%s.%s\""),
1976 schemaname, relationname);
1977 else
1978 printfPQExpBuffer(&title, _("Materialized view \"%s.%s\""),
1979 schemaname, relationname);
1980 break;
1981 case RELKIND_INDEX:
1982 if (tableinfo.relpersistence == 'u')
1983 printfPQExpBuffer(&title, _("Unlogged index \"%s.%s\""),
1984 schemaname, relationname);
1985 else
1986 printfPQExpBuffer(&title, _("Index \"%s.%s\""),
1987 schemaname, relationname);
1988 break;
1989 case RELKIND_PARTITIONED_INDEX:
1990 if (tableinfo.relpersistence == 'u')
1991 printfPQExpBuffer(&title, _("Unlogged partitioned index \"%s.%s\""),
1992 schemaname, relationname);
1993 else
1994 printfPQExpBuffer(&title, _("Partitioned index \"%s.%s\""),
1995 schemaname, relationname);
1996 break;
1997 case RELKIND_TOASTVALUE:
1998 printfPQExpBuffer(&title, _("TOAST table \"%s.%s\""),
1999 schemaname, relationname);
2000 break;
2001 case RELKIND_COMPOSITE_TYPE:
2002 printfPQExpBuffer(&title, _("Composite type \"%s.%s\""),
2003 schemaname, relationname);
2004 break;
2005 case RELKIND_FOREIGN_TABLE:
2006 printfPQExpBuffer(&title, _("Foreign table \"%s.%s\""),
2007 schemaname, relationname);
2008 break;
2009 case RELKIND_PARTITIONED_TABLE:
2010 if (tableinfo.relpersistence == 'u')
2011 printfPQExpBuffer(&title, _("Unlogged partitioned table \"%s.%s\""),
2012 schemaname, relationname);
2013 else
2014 printfPQExpBuffer(&title, _("Partitioned table \"%s.%s\""),
2015 schemaname, relationname);
2016 break;
2017 default:
2018 /* untranslated unknown relkind */
2019 printfPQExpBuffer(&title, "?%c? \"%s.%s\"",
2020 tableinfo.relkind, schemaname, relationname);
2021 break;
2022 }
2023
2024 /* Fill headers[] with the names of the columns we will output */
2025 cols = 0;
2026 headers[cols++] = gettext_noop("Column");
2027 headers[cols++] = gettext_noop("Type");
2028 if (show_column_details)
2029 {
2030 headers[cols++] = gettext_noop("Collation");
2031 headers[cols++] = gettext_noop("Nullable");
2032 headers[cols++] = gettext_noop("Default");
2033 }
2034 if (isindexkey_col >= 0)
2035 headers[cols++] = gettext_noop("Key?");
2036 if (indexdef_col >= 0)
2037 headers[cols++] = gettext_noop("Definition");
2038 if (fdwopts_col >= 0)
2039 headers[cols++] = gettext_noop("FDW options");
2040 if (attstorage_col >= 0)
2041 headers[cols++] = gettext_noop("Storage");
2042 if (attcompression_col >= 0)
2043 headers[cols++] = gettext_noop("Compression");
2044 if (attstattarget_col >= 0)
2045 headers[cols++] = gettext_noop("Stats target");
2046 if (attdescr_col >= 0)
2047 headers[cols++] = gettext_noop("Description");
2048
2049 Assert(cols <= lengthof(headers));
2050
2051 printTableInit(&cont, &myopt, title.data, cols, numrows);
2052 printTableInitialized = true;
2053
2054 for (i = 0; i < cols; i++)
2055 printTableAddHeader(&cont, headers[i], true, 'l');
2056
2057 /* Generate table cells to be printed */
2058 for (i = 0; i < numrows; i++)
2059 {
2060 /* Column */
2061 printTableAddCell(&cont, PQgetvalue(res, i, attname_col), false, false);
2062
2063 /* Type */
2064 printTableAddCell(&cont, PQgetvalue(res, i, atttype_col), false, false);
2065
2066 /* Collation, Nullable, Default */
2067 if (show_column_details)
2068 {
2069 char *identity;
2070 char *generated;
2071 char *default_str;
2072 bool mustfree = false;
2073
2074 printTableAddCell(&cont, PQgetvalue(res, i, attcoll_col), false, false);
2075
2076 printTableAddCell(&cont,
2077 strcmp(PQgetvalue(res, i, attnotnull_col), "t") == 0 ? "not null" : "",
2078 false, false);
2079
2080 identity = PQgetvalue(res, i, attidentity_col);
2081 generated = PQgetvalue(res, i, attgenerated_col);
2082
2083 if (identity[0] == ATTRIBUTE_IDENTITY_ALWAYS)
2084 default_str = "generated always as identity";
2085 else if (identity[0] == ATTRIBUTE_IDENTITY_BY_DEFAULT)
2086 default_str = "generated by default as identity";
2087 else if (generated[0] == ATTRIBUTE_GENERATED_STORED)
2088 {
2089 default_str = psprintf("generated always as (%s) stored",
2090 PQgetvalue(res, i, attrdef_col));
2091 mustfree = true;
2092 }
2093 else
2094 default_str = PQgetvalue(res, i, attrdef_col);
2095
2096 printTableAddCell(&cont, default_str, false, mustfree);
2097 }
2098
2099 /* Info for index columns */
2100 if (isindexkey_col >= 0)
2101 printTableAddCell(&cont, PQgetvalue(res, i, isindexkey_col), true, false);
2102 if (indexdef_col >= 0)
2103 printTableAddCell(&cont, PQgetvalue(res, i, indexdef_col), false, false);
2104
2105 /* FDW options for foreign table columns */
2106 if (fdwopts_col >= 0)
2107 printTableAddCell(&cont, PQgetvalue(res, i, fdwopts_col), false, false);
2108
2109 /* Storage mode, if relevant */
2110 if (attstorage_col >= 0)
2111 {
2112 char *storage = PQgetvalue(res, i, attstorage_col);
2113
2114 /* these strings are literal in our syntax, so not translated. */
2115 printTableAddCell(&cont, (storage[0] == 'p' ? "plain" :
2116 (storage[0] == 'm' ? "main" :
2117 (storage[0] == 'x' ? "extended" :
2118 (storage[0] == 'e' ? "external" :
2119 "???")))),
2120 false, false);
2121 }
2122
2123 /* Column compression, if relevant */
2124 if (attcompression_col >= 0)
2125 {
2126 char *compression = PQgetvalue(res, i, attcompression_col);
2127
2128 /* these strings are literal in our syntax, so not translated. */
2129 printTableAddCell(&cont, (compression[0] == 'p' ? "pglz" :
2130 (compression[0] == 'l' ? "lz4" :
2131 (compression[0] == '\0' ? "" :
2132 "???"))),
2133 false, false);
2134 }
2135
2136 /* Statistics target, if the relkind supports this feature */
2137 if (attstattarget_col >= 0)
2138 printTableAddCell(&cont, PQgetvalue(res, i, attstattarget_col),
2139 false, false);
2140
2141 /* Column comments, if the relkind supports this feature */
2142 if (attdescr_col >= 0)
2143 printTableAddCell(&cont, PQgetvalue(res, i, attdescr_col),
2144 false, false);
2145 }
2146
2147 /* Make footers */
2148
2149 if (tableinfo.ispartition)
2150 {
2151 /* Footer information for a partition child table */
2152 PGresult *result;
2153
2154 printfPQExpBuffer(&buf,
2155 "SELECT inhparent::pg_catalog.regclass,\n"
2156 " pg_catalog.pg_get_expr(c.relpartbound, c.oid),\n ");
2157
2158 appendPQExpBufferStr(&buf,
2159 pset.sversion >= 140000 ? "inhdetachpending" :
2160 "false as inhdetachpending");
2161
2162 /* If verbose, also request the partition constraint definition */
2163 if (verbose)
2164 appendPQExpBufferStr(&buf,
2165 ",\n pg_catalog.pg_get_partition_constraintdef(c.oid)");
2166 appendPQExpBuffer(&buf,
2167 "\nFROM pg_catalog.pg_class c"
2168 " JOIN pg_catalog.pg_inherits i"
2169 " ON c.oid = inhrelid"
2170 "\nWHERE c.oid = '%s';", oid);
2171 result = PSQLexec(buf.data);
2172 if (!result)
2173 goto error_return;
2174
2175 if (PQntuples(result) > 0)
2176 {
2177 char *parent_name = PQgetvalue(result, 0, 0);
2178 char *partdef = PQgetvalue(result, 0, 1);
2179 char *detached = PQgetvalue(result, 0, 2);
2180
2181 printfPQExpBuffer(&tmpbuf, _("Partition of: %s %s%s"), parent_name,
2182 partdef,
2183 strcmp(detached, "t") == 0 ? " DETACH PENDING" : "");
2184 printTableAddFooter(&cont, tmpbuf.data);
2185
2186 if (verbose)
2187 {
2188 char *partconstraintdef = NULL;
2189
2190 if (!PQgetisnull(result, 0, 3))
2191 partconstraintdef = PQgetvalue(result, 0, 3);
2192 /* If there isn't any constraint, show that explicitly */
2193 if (partconstraintdef == NULL || partconstraintdef[0] == '\0')
2194 printfPQExpBuffer(&tmpbuf, _("No partition constraint"));
2195 else
2196 printfPQExpBuffer(&tmpbuf, _("Partition constraint: %s"),
2197 partconstraintdef);
2198 printTableAddFooter(&cont, tmpbuf.data);
2199 }
2200 }
2201 PQclear(result);
2202 }
2203
2204 if (tableinfo.relkind == RELKIND_PARTITIONED_TABLE)
2205 {
2206 /* Footer information for a partitioned table (partitioning parent) */
2207 PGresult *result;
2208
2209 printfPQExpBuffer(&buf,
2210 "SELECT pg_catalog.pg_get_partkeydef('%s'::pg_catalog.oid);",
2211 oid);
2212 result = PSQLexec(buf.data);
2213 if (!result)
2214 goto error_return;
2215
2216 if (PQntuples(result) == 1)
2217 {
2218 char *partkeydef = PQgetvalue(result, 0, 0);
2219
2220 printfPQExpBuffer(&tmpbuf, _("Partition key: %s"), partkeydef);
2221 printTableAddFooter(&cont, tmpbuf.data);
2222 }
2223 PQclear(result);
2224 }
2225
2226 if (tableinfo.relkind == RELKIND_TOASTVALUE)
2227 {
2228 /* For a TOAST table, print name of owning table */
2229 PGresult *result;
2230
2231 printfPQExpBuffer(&buf,
2232 "SELECT n.nspname, c.relname\n"
2233 "FROM pg_catalog.pg_class c"
2234 " JOIN pg_catalog.pg_namespace n"
2235 " ON n.oid = c.relnamespace\n"
2236 "WHERE reltoastrelid = '%s';", oid);
2237 result = PSQLexec(buf.data);
2238 if (!result)
2239 goto error_return;
2240
2241 if (PQntuples(result) == 1)
2242 {
2243 char *schemaname = PQgetvalue(result, 0, 0);
2244 char *relname = PQgetvalue(result, 0, 1);
2245
2246 printfPQExpBuffer(&tmpbuf, _("Owning table: \"%s.%s\""),
2247 schemaname, relname);
2248 printTableAddFooter(&cont, tmpbuf.data);
2249 }
2250 PQclear(result);
2251 }
2252
2253 if (tableinfo.relkind == RELKIND_INDEX ||
2254 tableinfo.relkind == RELKIND_PARTITIONED_INDEX)
2255 {
2256 /* Footer information about an index */
2257 PGresult *result;
2258
2259 printfPQExpBuffer(&buf,
2260 "SELECT i.indisunique, i.indisprimary, i.indisclustered, "
2261 "i.indisvalid,\n"
2262 " (NOT i.indimmediate) AND "
2263 "EXISTS (SELECT 1 FROM pg_catalog.pg_constraint "
2264 "WHERE conrelid = i.indrelid AND "
2265 "conindid = i.indexrelid AND "
2266 "contype IN ('p','u','x') AND "
2267 "condeferrable) AS condeferrable,\n"
2268 " (NOT i.indimmediate) AND "
2269 "EXISTS (SELECT 1 FROM pg_catalog.pg_constraint "
2270 "WHERE conrelid = i.indrelid AND "
2271 "conindid = i.indexrelid AND "
2272 "contype IN ('p','u','x') AND "
2273 "condeferred) AS condeferred,\n");
2274
2275 if (pset.sversion >= 90400)
2276 appendPQExpBufferStr(&buf, "i.indisreplident,\n");
2277 else
2278 appendPQExpBufferStr(&buf, "false AS indisreplident,\n");
2279
2280 if (pset.sversion >= 150000)
2281 appendPQExpBufferStr(&buf, "i.indnullsnotdistinct,\n");
2282 else
2283 appendPQExpBufferStr(&buf, "false AS indnullsnotdistinct,\n");
2284
2285 appendPQExpBuffer(&buf, " a.amname, c2.relname, "
2286 "pg_catalog.pg_get_expr(i.indpred, i.indrelid, true)\n"
2287 "FROM pg_catalog.pg_index i, pg_catalog.pg_class c, pg_catalog.pg_class c2, pg_catalog.pg_am a\n"
2288 "WHERE i.indexrelid = c.oid AND c.oid = '%s' AND c.relam = a.oid\n"
2289 "AND i.indrelid = c2.oid;",
2290 oid);
2291
2292 result = PSQLexec(buf.data);
2293 if (!result)
2294 goto error_return;
2295 else if (PQntuples(result) != 1)
2296 {
2297 PQclear(result);
2298 goto error_return;
2299 }
2300 else
2301 {
2302 char *indisunique = PQgetvalue(result, 0, 0);
2303 char *indisprimary = PQgetvalue(result, 0, 1);
2304 char *indisclustered = PQgetvalue(result, 0, 2);
2305 char *indisvalid = PQgetvalue(result, 0, 3);
2306 char *deferrable = PQgetvalue(result, 0, 4);
2307 char *deferred = PQgetvalue(result, 0, 5);
2308 char *indisreplident = PQgetvalue(result, 0, 6);
2309 char *indnullsnotdistinct = PQgetvalue(result, 0, 7);
2310 char *indamname = PQgetvalue(result, 0, 8);
2311 char *indtable = PQgetvalue(result, 0, 9);
2312 char *indpred = PQgetvalue(result, 0, 10);
2313
2314 if (strcmp(indisprimary, "t") == 0)
2315 printfPQExpBuffer(&tmpbuf, _("primary key, "));
2316 else if (strcmp(indisunique, "t") == 0)
2317 {
2318 printfPQExpBuffer(&tmpbuf, _("unique"));
2319 if (strcmp(indnullsnotdistinct, "t") == 0)
2320 appendPQExpBufferStr(&tmpbuf, _(" nulls not distinct"));
2321 appendPQExpBufferStr(&tmpbuf, _(", "));
2322 }
2323 else
2324 resetPQExpBuffer(&tmpbuf);
2325 appendPQExpBuffer(&tmpbuf, "%s, ", indamname);
2326
2327 /* we assume here that index and table are in same schema */
2328 appendPQExpBuffer(&tmpbuf, _("for table \"%s.%s\""),
2329 schemaname, indtable);
2330
2331 if (strlen(indpred))
2332 appendPQExpBuffer(&tmpbuf, _(", predicate (%s)"), indpred);
2333
2334 if (strcmp(indisclustered, "t") == 0)
2335 appendPQExpBufferStr(&tmpbuf, _(", clustered"));
2336
2337 if (strcmp(indisvalid, "t") != 0)
2338 appendPQExpBufferStr(&tmpbuf, _(", invalid"));
2339
2340 if (strcmp(deferrable, "t") == 0)
2341 appendPQExpBufferStr(&tmpbuf, _(", deferrable"));
2342
2343 if (strcmp(deferred, "t") == 0)
2344 appendPQExpBufferStr(&tmpbuf, _(", initially deferred"));
2345
2346 if (strcmp(indisreplident, "t") == 0)
2347 appendPQExpBufferStr(&tmpbuf, _(", replica identity"));
2348
2349 printTableAddFooter(&cont, tmpbuf.data);
2350
2351 /*
2352 * If it's a partitioned index, we'll print the tablespace below
2353 */
2354 if (tableinfo.relkind == RELKIND_INDEX)
2355 add_tablespace_footer(&cont, tableinfo.relkind,
2356 tableinfo.tablespace, true);
2357 }
2358
2359 PQclear(result);
2360 }
2361 /* If you add relkinds here, see also "Finish printing..." stanza below */
2362 else if (tableinfo.relkind == RELKIND_RELATION ||
2363 tableinfo.relkind == RELKIND_MATVIEW ||
2364 tableinfo.relkind == RELKIND_FOREIGN_TABLE ||
2365 tableinfo.relkind == RELKIND_PARTITIONED_TABLE ||
2366 tableinfo.relkind == RELKIND_PARTITIONED_INDEX ||
2367 tableinfo.relkind == RELKIND_TOASTVALUE)
2368 {
2369 /* Footer information about a table */
2370 PGresult *result = NULL;
2371 int tuples = 0;
2372
2373 /* print indexes */
2374 if (tableinfo.hasindex)
2375 {
2376 printfPQExpBuffer(&buf,
2377 "SELECT c2.relname, i.indisprimary, i.indisunique, "
2378 "i.indisclustered, i.indisvalid, "
2379 "pg_catalog.pg_get_indexdef(i.indexrelid, 0, true),\n "
2380 "pg_catalog.pg_get_constraintdef(con.oid, true), "
2381 "contype, condeferrable, condeferred");
2382 if (pset.sversion >= 90400)
2383 appendPQExpBufferStr(&buf, ", i.indisreplident");
2384 else
2385 appendPQExpBufferStr(&buf, ", false AS indisreplident");
2386 appendPQExpBufferStr(&buf, ", c2.reltablespace");
2387 appendPQExpBuffer(&buf,
2388 "\nFROM pg_catalog.pg_class c, pg_catalog.pg_class c2, pg_catalog.pg_index i\n"
2389 " LEFT JOIN pg_catalog.pg_constraint con ON (conrelid = i.indrelid AND conindid = i.indexrelid AND contype IN ('p','u','x'))\n"
2390 "WHERE c.oid = '%s' AND c.oid = i.indrelid AND i.indexrelid = c2.oid\n"
2391 "ORDER BY i.indisprimary DESC, c2.relname;",
2392 oid);
2393 result = PSQLexec(buf.data);
2394 if (!result)
2395 goto error_return;
2396 else
2397 tuples = PQntuples(result);
2398
2399 if (tuples > 0)
2400 {
2401 printTableAddFooter(&cont, _("Indexes:"));
2402 for (i = 0; i < tuples; i++)
2403 {
2404 /* untranslated index name */
2405 printfPQExpBuffer(&buf, " \"%s\"",
2406 PQgetvalue(result, i, 0));
2407
2408 /* If exclusion constraint, print the constraintdef */
2409 if (strcmp(PQgetvalue(result, i, 7), "x") == 0)
2410 {
2411 appendPQExpBuffer(&buf, " %s",
2412 PQgetvalue(result, i, 6));
2413 }
2414 else
2415 {
2416 const char *indexdef;
2417 const char *usingpos;
2418
2419 /* Label as primary key or unique (but not both) */
2420 if (strcmp(PQgetvalue(result, i, 1), "t") == 0)
2421 appendPQExpBufferStr(&buf, " PRIMARY KEY,");
2422 else if (strcmp(PQgetvalue(result, i, 2), "t") == 0)
2423 {
2424 if (strcmp(PQgetvalue(result, i, 7), "u") == 0)
2425 appendPQExpBufferStr(&buf, " UNIQUE CONSTRAINT,");
2426 else
2427 appendPQExpBufferStr(&buf, " UNIQUE,");
2428 }
2429
2430 /* Everything after "USING" is echoed verbatim */
2431 indexdef = PQgetvalue(result, i, 5);
2432 usingpos = strstr(indexdef, " USING ");
2433 if (usingpos)
2434 indexdef = usingpos + 7;
2435 appendPQExpBuffer(&buf, " %s", indexdef);
2436
2437 /* Need these for deferrable PK/UNIQUE indexes */
2438 if (strcmp(PQgetvalue(result, i, 8), "t") == 0)
2439 appendPQExpBufferStr(&buf, " DEFERRABLE");
2440
2441 if (strcmp(PQgetvalue(result, i, 9), "t") == 0)
2442 appendPQExpBufferStr(&buf, " INITIALLY DEFERRED");
2443 }
2444
2445 /* Add these for all cases */
2446 if (strcmp(PQgetvalue(result, i, 3), "t") == 0)
2447 appendPQExpBufferStr(&buf, " CLUSTER");
2448
2449 if (strcmp(PQgetvalue(result, i, 4), "t") != 0)
2450 appendPQExpBufferStr(&buf, " INVALID");
2451
2452 if (strcmp(PQgetvalue(result, i, 10), "t") == 0)
2453 appendPQExpBufferStr(&buf, " REPLICA IDENTITY");
2454
2455 printTableAddFooter(&cont, buf.data);
2456
2457 /* Print tablespace of the index on the same line */
2458 add_tablespace_footer(&cont, RELKIND_INDEX,
2459 atooid(PQgetvalue(result, i, 11)),
2460 false);
2461 }
2462 }
2463 PQclear(result);
2464 }
2465
2466 /* print table (and column) check constraints */
2467 if (tableinfo.checks)
2468 {
2469 printfPQExpBuffer(&buf,
2470 "SELECT r.conname, "
2471 "pg_catalog.pg_get_constraintdef(r.oid, true)\n"
2472 "FROM pg_catalog.pg_constraint r\n"
2473 "WHERE r.conrelid = '%s' AND r.contype = 'c'\n"
2474 "ORDER BY 1;",
2475 oid);
2476 result = PSQLexec(buf.data);
2477 if (!result)
2478 goto error_return;
2479 else
2480 tuples = PQntuples(result);
2481
2482 if (tuples > 0)
2483 {
2484 printTableAddFooter(&cont, _("Check constraints:"));
2485 for (i = 0; i < tuples; i++)
2486 {
2487 /* untranslated constraint name and def */
2488 printfPQExpBuffer(&buf, " \"%s\" %s",
2489 PQgetvalue(result, i, 0),
2490 PQgetvalue(result, i, 1));
2491
2492 printTableAddFooter(&cont, buf.data);
2493 }
2494 }
2495 PQclear(result);
2496 }
2497
2498 /*
2499 * Print foreign-key constraints (there are none if no triggers,
2500 * except if the table is partitioned, in which case the triggers
2501 * appear in the partitions)
2502 */
2503 if (tableinfo.hastriggers ||
2504 tableinfo.relkind == RELKIND_PARTITIONED_TABLE)
2505 {
2506 if (pset.sversion >= 120000 &&
2507 (tableinfo.ispartition || tableinfo.relkind == RELKIND_PARTITIONED_TABLE))
2508 {
2509 /*
2510 * Put the constraints defined in this table first, followed
2511 * by the constraints defined in ancestor partitioned tables.
2512 */
2513 printfPQExpBuffer(&buf,
2514 "SELECT conrelid = '%s'::pg_catalog.regclass AS sametable,\n"
2515 " conname,\n"
2516 " pg_catalog.pg_get_constraintdef(oid, true) AS condef,\n"
2517 " conrelid::pg_catalog.regclass AS ontable\n"
2518 " FROM pg_catalog.pg_constraint,\n"
2519 " pg_catalog.pg_partition_ancestors('%s')\n"
2520 " WHERE conrelid = relid AND contype = 'f' AND conparentid = 0\n"
2521 "ORDER BY sametable DESC, conname;",
2522 oid, oid);
2523 }
2524 else
2525 {
2526 printfPQExpBuffer(&buf,
2527 "SELECT true as sametable, conname,\n"
2528 " pg_catalog.pg_get_constraintdef(r.oid, true) as condef,\n"
2529 " conrelid::pg_catalog.regclass AS ontable\n"
2530 "FROM pg_catalog.pg_constraint r\n"
2531 "WHERE r.conrelid = '%s' AND r.contype = 'f'\n",
2532 oid);
2533
2534 if (pset.sversion >= 120000)
2535 appendPQExpBufferStr(&buf, " AND conparentid = 0\n");
2536 appendPQExpBufferStr(&buf, "ORDER BY conname");
2537 }
2538
2539 result = PSQLexec(buf.data);
2540 if (!result)
2541 goto error_return;
2542 else
2543 tuples = PQntuples(result);
2544
2545 if (tuples > 0)
2546 {
2547 int i_sametable = PQfnumber(result, "sametable"),
2548 i_conname = PQfnumber(result, "conname"),
2549 i_condef = PQfnumber(result, "condef"),
2550 i_ontable = PQfnumber(result, "ontable");
2551
2552 printTableAddFooter(&cont, _("Foreign-key constraints:"));
2553 for (i = 0; i < tuples; i++)
2554 {
2555 /*
2556 * Print untranslated constraint name and definition. Use
2557 * a "TABLE tab" prefix when the constraint is defined in
2558 * a parent partitioned table.
2559 */
2560 if (strcmp(PQgetvalue(result, i, i_sametable), "f") == 0)
2561 printfPQExpBuffer(&buf, " TABLE \"%s\" CONSTRAINT \"%s\" %s",
2562 PQgetvalue(result, i, i_ontable),
2563 PQgetvalue(result, i, i_conname),
2564 PQgetvalue(result, i, i_condef));
2565 else
2566 printfPQExpBuffer(&buf, " \"%s\" %s",
2567 PQgetvalue(result, i, i_conname),
2568 PQgetvalue(result, i, i_condef));
2569
2570 printTableAddFooter(&cont, buf.data);
2571 }
2572 }
2573 PQclear(result);
2574 }
2575
2576 /* print incoming foreign-key references */
2577 if (tableinfo.hastriggers ||
2578 tableinfo.relkind == RELKIND_PARTITIONED_TABLE)
2579 {
2580 if (pset.sversion >= 120000)
2581 {
2582 printfPQExpBuffer(&buf,
2583 "SELECT conname, conrelid::pg_catalog.regclass AS ontable,\n"
2584 " pg_catalog.pg_get_constraintdef(oid, true) AS condef\n"
2585 " FROM pg_catalog.pg_constraint c\n"
2586 " WHERE confrelid IN (SELECT pg_catalog.pg_partition_ancestors('%s')\n"
2587 " UNION ALL VALUES ('%s'::pg_catalog.regclass))\n"
2588 " AND contype = 'f' AND conparentid = 0\n"
2589 "ORDER BY conname;",
2590 oid, oid);
2591 }
2592 else
2593 {
2594 printfPQExpBuffer(&buf,
2595 "SELECT conname, conrelid::pg_catalog.regclass AS ontable,\n"
2596 " pg_catalog.pg_get_constraintdef(oid, true) AS condef\n"
2597 " FROM pg_catalog.pg_constraint\n"
2598 " WHERE confrelid = %s AND contype = 'f'\n"
2599 "ORDER BY conname;",
2600 oid);
2601 }
2602
2603 result = PSQLexec(buf.data);
2604 if (!result)
2605 goto error_return;
2606 else
2607 tuples = PQntuples(result);
2608
2609 if (tuples > 0)
2610 {
2611 int i_conname = PQfnumber(result, "conname"),
2612 i_ontable = PQfnumber(result, "ontable"),
2613 i_condef = PQfnumber(result, "condef");
2614
2615 printTableAddFooter(&cont, _("Referenced by:"));
2616 for (i = 0; i < tuples; i++)
2617 {
2618 printfPQExpBuffer(&buf, " TABLE \"%s\" CONSTRAINT \"%s\" %s",
2619 PQgetvalue(result, i, i_ontable),
2620 PQgetvalue(result, i, i_conname),
2621 PQgetvalue(result, i, i_condef));
2622
2623 printTableAddFooter(&cont, buf.data);
2624 }
2625 }
2626 PQclear(result);
2627 }
2628
2629 /* print any row-level policies */
2630 if (pset.sversion >= 90500)
2631 {
2632 printfPQExpBuffer(&buf, "SELECT pol.polname,");
2633 if (pset.sversion >= 100000)
2634 appendPQExpBufferStr(&buf,
2635 " pol.polpermissive,\n");
2636 else
2637 appendPQExpBufferStr(&buf,
2638 " 't' as polpermissive,\n");
2639 appendPQExpBuffer(&buf,
2640 " CASE WHEN pol.polroles = '{0}' THEN NULL ELSE pg_catalog.array_to_string(array(select rolname from pg_catalog.pg_roles where oid = any (pol.polroles) order by 1),',') END,\n"
2641 " pg_catalog.pg_get_expr(pol.polqual, pol.polrelid),\n"
2642 " pg_catalog.pg_get_expr(pol.polwithcheck, pol.polrelid),\n"
2643 " CASE pol.polcmd\n"
2644 " WHEN 'r' THEN 'SELECT'\n"
2645 " WHEN 'a' THEN 'INSERT'\n"
2646 " WHEN 'w' THEN 'UPDATE'\n"
2647 " WHEN 'd' THEN 'DELETE'\n"
2648 " END AS cmd\n"
2649 "FROM pg_catalog.pg_policy pol\n"
2650 "WHERE pol.polrelid = '%s' ORDER BY 1;",
2651 oid);
2652
2653 result = PSQLexec(buf.data);
2654 if (!result)
2655 goto error_return;
2656 else
2657 tuples = PQntuples(result);
2658
2659 /*
2660 * Handle cases where RLS is enabled and there are policies, or
2661 * there aren't policies, or RLS isn't enabled but there are
2662 * policies
2663 */
2664 if (tableinfo.rowsecurity && !tableinfo.forcerowsecurity && tuples > 0)
2665 printTableAddFooter(&cont, _("Policies:"));
2666
2667 if (tableinfo.rowsecurity && tableinfo.forcerowsecurity && tuples > 0)
2668 printTableAddFooter(&cont, _("Policies (forced row security enabled):"));
2669
2670 if (tableinfo.rowsecurity && !tableinfo.forcerowsecurity && tuples == 0)
2671 printTableAddFooter(&cont, _("Policies (row security enabled): (none)"));
2672
2673 if (tableinfo.rowsecurity && tableinfo.forcerowsecurity && tuples == 0)
2674 printTableAddFooter(&cont, _("Policies (forced row security enabled): (none)"));
2675
2676 if (!tableinfo.rowsecurity && tuples > 0)
2677 printTableAddFooter(&cont, _("Policies (row security disabled):"));
2678
2679 /* Might be an empty set - that's ok */
2680 for (i = 0; i < tuples; i++)
2681 {
2682 printfPQExpBuffer(&buf, " POLICY \"%s\"",
2683 PQgetvalue(result, i, 0));
2684
2685 if (*(PQgetvalue(result, i, 1)) == 'f')
2686 appendPQExpBufferStr(&buf, " AS RESTRICTIVE");
2687
2688 if (!PQgetisnull(result, i, 5))
2689 appendPQExpBuffer(&buf, " FOR %s",
2690 PQgetvalue(result, i, 5));
2691
2692 if (!PQgetisnull(result, i, 2))
2693 {
2694 appendPQExpBuffer(&buf, "\n TO %s",
2695 PQgetvalue(result, i, 2));
2696 }
2697
2698 if (!PQgetisnull(result, i, 3))
2699 appendPQExpBuffer(&buf, "\n USING (%s)",
2700 PQgetvalue(result, i, 3));
2701
2702 if (!PQgetisnull(result, i, 4))
2703 appendPQExpBuffer(&buf, "\n WITH CHECK (%s)",
2704 PQgetvalue(result, i, 4));
2705
2706 printTableAddFooter(&cont, buf.data);
2707 }
2708 PQclear(result);
2709 }
2710
2711 /* print any extended statistics */
2712 if (pset.sversion >= 140000)
2713 {
2714 printfPQExpBuffer(&buf,
2715 "SELECT oid, "
2716 "stxrelid::pg_catalog.regclass, "
2717 "stxnamespace::pg_catalog.regnamespace::pg_catalog.text AS nsp, "
2718 "stxname,\n"
2719 "pg_catalog.pg_get_statisticsobjdef_columns(oid) AS columns,\n"
2720 " 'd' = any(stxkind) AS ndist_enabled,\n"
2721 " 'f' = any(stxkind) AS deps_enabled,\n"
2722 " 'm' = any(stxkind) AS mcv_enabled,\n"
2723 "stxstattarget\n"
2724 "FROM pg_catalog.pg_statistic_ext\n"
2725 "WHERE stxrelid = '%s'\n"
2726 "ORDER BY nsp, stxname;",
2727 oid);
2728
2729 result = PSQLexec(buf.data);
2730 if (!result)
2731 goto error_return;
2732 else
2733 tuples = PQntuples(result);
2734
2735 if (tuples > 0)
2736 {
2737 printTableAddFooter(&cont, _("Statistics objects:"));
2738
2739 for (i = 0; i < tuples; i++)
2740 {
2741 bool gotone = false;
2742 bool has_ndistinct;
2743 bool has_dependencies;
2744 bool has_mcv;
2745 bool has_all;
2746 bool has_some;
2747
2748 has_ndistinct = (strcmp(PQgetvalue(result, i, 5), "t") == 0);
2749 has_dependencies = (strcmp(PQgetvalue(result, i, 6), "t") == 0);
2750 has_mcv = (strcmp(PQgetvalue(result, i, 7), "t") == 0);
2751
2752 printfPQExpBuffer(&buf, " ");
2753
2754 /* statistics object name (qualified with namespace) */
2755 appendPQExpBuffer(&buf, "\"%s.%s\"",
2756 PQgetvalue(result, i, 2),
2757 PQgetvalue(result, i, 3));
2758
2759 /*
2760 * When printing kinds we ignore expression statistics,
2761 * which are used only internally and can't be specified
2762 * by user. We don't print the kinds when none are
2763 * specified (in which case it has to be statistics on a
2764 * single expr) or when all are specified (in which case
2765 * we assume it's expanded by CREATE STATISTICS).
2766 */
2767 has_all = (has_ndistinct && has_dependencies && has_mcv);
2768 has_some = (has_ndistinct || has_dependencies || has_mcv);
2769
2770 if (has_some && !has_all)
2771 {
2772 appendPQExpBufferStr(&buf, " (");
2773
2774 /* options */
2775 if (has_ndistinct)
2776 {
2777 appendPQExpBufferStr(&buf, "ndistinct");
2778 gotone = true;
2779 }
2780
2781 if (has_dependencies)
2782 {
2783 appendPQExpBuffer(&buf, "%sdependencies", gotone ? ", " : "");
2784 gotone = true;
2785 }
2786
2787 if (has_mcv)
2788 {
2789 appendPQExpBuffer(&buf, "%smcv", gotone ? ", " : "");
2790 }
2791
2792 appendPQExpBufferChar(&buf, ')');
2793 }
2794
2795 appendPQExpBuffer(&buf, " ON %s FROM %s",
2796 PQgetvalue(result, i, 4),
2797 PQgetvalue(result, i, 1));
2798
2799 /* Show the stats target if it's not default */
2800 if (strcmp(PQgetvalue(result, i, 8), "-1") != 0)
2801 appendPQExpBuffer(&buf, "; STATISTICS %s",
2802 PQgetvalue(result, i, 8));
2803
2804 printTableAddFooter(&cont, buf.data);
2805 }
2806 }
2807 PQclear(result);
2808 }
2809 else if (pset.sversion >= 100000)
2810 {
2811 printfPQExpBuffer(&buf,
2812 "SELECT oid, "
2813 "stxrelid::pg_catalog.regclass, "
2814 "stxnamespace::pg_catalog.regnamespace AS nsp, "
2815 "stxname,\n"
2816 " (SELECT pg_catalog.string_agg(pg_catalog.quote_ident(attname),', ')\n"
2817 " FROM pg_catalog.unnest(stxkeys) s(attnum)\n"
2818 " JOIN pg_catalog.pg_attribute a ON (stxrelid = a.attrelid AND\n"
2819 " a.attnum = s.attnum AND NOT attisdropped)) AS columns,\n"
2820 " 'd' = any(stxkind) AS ndist_enabled,\n"
2821 " 'f' = any(stxkind) AS deps_enabled,\n"
2822 " 'm' = any(stxkind) AS mcv_enabled,\n");
2823
2824 if (pset.sversion >= 130000)
2825 appendPQExpBufferStr(&buf, " stxstattarget\n");
2826 else
2827 appendPQExpBufferStr(&buf, " -1 AS stxstattarget\n");
2828 appendPQExpBuffer(&buf, "FROM pg_catalog.pg_statistic_ext\n"
2829 "WHERE stxrelid = '%s'\n"
2830 "ORDER BY 1;",
2831 oid);
2832
2833 result = PSQLexec(buf.data);
2834 if (!result)
2835 goto error_return;
2836 else
2837 tuples = PQntuples(result);
2838
2839 if (tuples > 0)
2840 {
2841 printTableAddFooter(&cont, _("Statistics objects:"));
2842
2843 for (i = 0; i < tuples; i++)
2844 {
2845 bool gotone = false;
2846
2847 printfPQExpBuffer(&buf, " ");
2848
2849 /* statistics object name (qualified with namespace) */
2850 appendPQExpBuffer(&buf, "\"%s.%s\" (",
2851 PQgetvalue(result, i, 2),
2852 PQgetvalue(result, i, 3));
2853
2854 /* options */
2855 if (strcmp(PQgetvalue(result, i, 5), "t") == 0)
2856 {
2857 appendPQExpBufferStr(&buf, "ndistinct");
2858 gotone = true;
2859 }
2860
2861 if (strcmp(PQgetvalue(result, i, 6), "t") == 0)
2862 {
2863 appendPQExpBuffer(&buf, "%sdependencies", gotone ? ", " : "");
2864 gotone = true;
2865 }
2866
2867 if (strcmp(PQgetvalue(result, i, 7), "t") == 0)
2868 {
2869 appendPQExpBuffer(&buf, "%smcv", gotone ? ", " : "");
2870 }
2871
2872 appendPQExpBuffer(&buf, ") ON %s FROM %s",
2873 PQgetvalue(result, i, 4),
2874 PQgetvalue(result, i, 1));
2875
2876 /* Show the stats target if it's not default */
2877 if (strcmp(PQgetvalue(result, i, 8), "-1") != 0)
2878 appendPQExpBuffer(&buf, "; STATISTICS %s",
2879 PQgetvalue(result, i, 8));
2880
2881 printTableAddFooter(&cont, buf.data);
2882 }
2883 }
2884 PQclear(result);
2885 }
2886
2887 /* print rules */
2888 if (tableinfo.hasrules && tableinfo.relkind != RELKIND_MATVIEW)
2889 {
2890 printfPQExpBuffer(&buf,
2891 "SELECT r.rulename, trim(trailing ';' from pg_catalog.pg_get_ruledef(r.oid, true)), "
2892 "ev_enabled\n"
2893 "FROM pg_catalog.pg_rewrite r\n"
2894 "WHERE r.ev_class = '%s' ORDER BY 1;",
2895 oid);
2896 result = PSQLexec(buf.data);
2897 if (!result)
2898 goto error_return;
2899 else
2900 tuples = PQntuples(result);
2901
2902 if (tuples > 0)
2903 {
2904 bool have_heading;
2905 int category;
2906
2907 for (category = 0; category < 4; category++)
2908 {
2909 have_heading = false;
2910
2911 for (i = 0; i < tuples; i++)
2912 {
2913 const char *ruledef;
2914 bool list_rule = false;
2915
2916 switch (category)
2917 {
2918 case 0:
2919 if (*PQgetvalue(result, i, 2) == 'O')
2920 list_rule = true;
2921 break;
2922 case 1:
2923 if (*PQgetvalue(result, i, 2) == 'D')
2924 list_rule = true;
2925 break;
2926 case 2:
2927 if (*PQgetvalue(result, i, 2) == 'A')
2928 list_rule = true;
2929 break;
2930 case 3:
2931 if (*PQgetvalue(result, i, 2) == 'R')
2932 list_rule = true;
2933 break;
2934 }
2935 if (!list_rule)
2936 continue;
2937
2938 if (!have_heading)
2939 {
2940 switch (category)
2941 {
2942 case 0:
2943 printfPQExpBuffer(&buf, _("Rules:"));
2944 break;
2945 case 1:
2946 printfPQExpBuffer(&buf, _("Disabled rules:"));
2947 break;
2948 case 2:
2949 printfPQExpBuffer(&buf, _("Rules firing always:"));
2950 break;
2951 case 3:
2952 printfPQExpBuffer(&buf, _("Rules firing on replica only:"));
2953 break;
2954 }
2955 printTableAddFooter(&cont, buf.data);
2956 have_heading = true;
2957 }
2958
2959 /* Everything after "CREATE RULE" is echoed verbatim */
2960 ruledef = PQgetvalue(result, i, 1);
2961 ruledef += 12;
2962 printfPQExpBuffer(&buf, " %s", ruledef);
2963 printTableAddFooter(&cont, buf.data);
2964 }
2965 }
2966 }
2967 PQclear(result);
2968 }
2969
2970 /* print any publications */
2971 if (pset.sversion >= 100000)
2972 {
2973 if (pset.sversion >= 150000)
2974 {
2975 printfPQExpBuffer(&buf,
2976 "SELECT pubname\n"
2977 " , NULL\n"
2978 " , NULL\n"
2979 "FROM pg_catalog.pg_publication p\n"
2980 " JOIN pg_catalog.pg_publication_namespace pn ON p.oid = pn.pnpubid\n"
2981 " JOIN pg_catalog.pg_class pc ON pc.relnamespace = pn.pnnspid\n"
2982 "WHERE pc.oid ='%s' and pg_catalog.pg_relation_is_publishable('%s')\n"
2983 "UNION\n"
2984 "SELECT pubname\n"
2985 " , pg_get_expr(pr.prqual, c.oid)\n"
2986 " , (CASE WHEN pr.prattrs IS NOT NULL THEN\n"
2987 " (SELECT string_agg(attname, ', ')\n"
2988 " FROM pg_catalog.generate_series(0, pg_catalog.array_upper(pr.prattrs::pg_catalog.int2[], 1)) s,\n"
2989 " pg_catalog.pg_attribute\n"
2990 " WHERE attrelid = pr.prrelid AND attnum = prattrs[s])\n"
2991 " ELSE NULL END) "
2992 "FROM pg_catalog.pg_publication p\n"
2993 " JOIN pg_catalog.pg_publication_rel pr ON p.oid = pr.prpubid\n"
2994 " JOIN pg_catalog.pg_class c ON c.oid = pr.prrelid\n"
2995 "WHERE pr.prrelid = '%s'\n"
2996 "UNION\n"
2997 "SELECT pubname\n"
2998 " , NULL\n"
2999 " , NULL\n"
3000 "FROM pg_catalog.pg_publication p\n"
3001 "WHERE p.puballtables AND pg_catalog.pg_relation_is_publishable('%s')\n"
3002 "ORDER BY 1;",
3003 oid, oid, oid, oid);
3004 }
3005 else
3006 {
3007 printfPQExpBuffer(&buf,
3008 "SELECT pubname\n"
3009 " , NULL\n"
3010 " , NULL\n"
3011 "FROM pg_catalog.pg_publication p\n"
3012 "JOIN pg_catalog.pg_publication_rel pr ON p.oid = pr.prpubid\n"
3013 "WHERE pr.prrelid = '%s'\n"
3014 "UNION ALL\n"
3015 "SELECT pubname\n"
3016 " , NULL\n"
3017 " , NULL\n"
3018 "FROM pg_catalog.pg_publication p\n"
3019 "WHERE p.puballtables AND pg_catalog.pg_relation_is_publishable('%s')\n"
3020 "ORDER BY 1;",
3021 oid, oid);
3022 }
3023
3024 result = PSQLexec(buf.data);
3025 if (!result)
3026 goto error_return;
3027 else
3028 tuples = PQntuples(result);
3029
3030 if (tuples > 0)
3031 printTableAddFooter(&cont, _("Publications:"));
3032
3033 /* Might be an empty set - that's ok */
3034 for (i = 0; i < tuples; i++)
3035 {
3036 printfPQExpBuffer(&buf, " \"%s\"",
3037 PQgetvalue(result, i, 0));
3038
3039 /* column list (if any) */
3040 if (!PQgetisnull(result, i, 2))
3041 appendPQExpBuffer(&buf, " (%s)",
3042 PQgetvalue(result, i, 2));
3043
3044 /* row filter (if any) */
3045 if (!PQgetisnull(result, i, 1))
3046 appendPQExpBuffer(&buf, " WHERE %s",
3047 PQgetvalue(result, i, 1));
3048
3049 printTableAddFooter(&cont, buf.data);
3050 }
3051 PQclear(result);
3052 }
3053 }
3054
3055 /* Get view_def if table is a view or materialized view */
3056 if ((tableinfo.relkind == RELKIND_VIEW ||
3057 tableinfo.relkind == RELKIND_MATVIEW) && verbose)
3058 {
3059 PGresult *result;
3060
3061 printfPQExpBuffer(&buf,
3062 "SELECT pg_catalog.pg_get_viewdef('%s'::pg_catalog.oid, true);",
3063 oid);
3064 result = PSQLexec(buf.data);
3065 if (!result)
3066 goto error_return;
3067
3068 if (PQntuples(result) > 0)
3069 view_def = pg_strdup(PQgetvalue(result, 0, 0));
3070
3071 PQclear(result);
3072 }
3073
3074 if (view_def)
3075 {
3076 PGresult *result = NULL;
3077
3078 /* Footer information about a view */
3079 printTableAddFooter(&cont, _("View definition:"));
3080 printTableAddFooter(&cont, view_def);
3081
3082 /* print rules */
3083 if (tableinfo.hasrules)
3084 {
3085 printfPQExpBuffer(&buf,
3086 "SELECT r.rulename, trim(trailing ';' from pg_catalog.pg_get_ruledef(r.oid, true))\n"
3087 "FROM pg_catalog.pg_rewrite r\n"
3088 "WHERE r.ev_class = '%s' AND r.rulename != '_RETURN' ORDER BY 1;",
3089 oid);
3090 result = PSQLexec(buf.data);
3091 if (!result)
3092 goto error_return;
3093
3094 if (PQntuples(result) > 0)
3095 {
3096 printTableAddFooter(&cont, _("Rules:"));
3097 for (i = 0; i < PQntuples(result); i++)
3098 {
3099 const char *ruledef;
3100
3101 /* Everything after "CREATE RULE" is echoed verbatim */
3102 ruledef = PQgetvalue(result, i, 1);
3103 ruledef += 12;
3104
3105 printfPQExpBuffer(&buf, " %s", ruledef);
3106 printTableAddFooter(&cont, buf.data);
3107 }
3108 }
3109 PQclear(result);
3110 }
3111 }
3112
3113 /*
3114 * Print triggers next, if any (but only user-defined triggers). This
3115 * could apply to either a table or a view.
3116 */
3117 if (tableinfo.hastriggers)
3118 {
3119 PGresult *result;
3120 int tuples;
3121
3122 printfPQExpBuffer(&buf,
3123 "SELECT t.tgname, "
3124 "pg_catalog.pg_get_triggerdef(t.oid, true), "
3125 "t.tgenabled, t.tgisinternal,\n");
3126
3127 /*
3128 * Detect whether each trigger is inherited, and if so, get the name
3129 * of the topmost table it's inherited from. We have no easy way to
3130 * do that pre-v13, for lack of the tgparentid column. Even with
3131 * tgparentid, a straightforward search for the topmost parent would
3132 * require a recursive CTE, which seems unduly expensive. We cheat a
3133 * bit by assuming parent triggers will match by tgname; then, joining
3134 * with pg_partition_ancestors() allows the planner to make use of
3135 * pg_trigger_tgrelid_tgname_index if it wishes. We ensure we find
3136 * the correct topmost parent by stopping at the first-in-partition-
3137 * ancestry-order trigger that has tgparentid = 0. (There might be
3138 * unrelated, non-inherited triggers with the same name further up the
3139 * stack, so this is important.)
3140 */
3141 if (pset.sversion >= 130000)
3142 appendPQExpBufferStr(&buf,
3143 " CASE WHEN t.tgparentid != 0 THEN\n"
3144 " (SELECT u.tgrelid::pg_catalog.regclass\n"
3145 " FROM pg_catalog.pg_trigger AS u,\n"
3146 " pg_catalog.pg_partition_ancestors(t.tgrelid) WITH ORDINALITY AS a(relid, depth)\n"
3147 " WHERE u.tgname = t.tgname AND u.tgrelid = a.relid\n"
3148 " AND u.tgparentid = 0\n"
3149 " ORDER BY a.depth LIMIT 1)\n"
3150 " END AS parent\n");
3151 else
3152 appendPQExpBufferStr(&buf, " NULL AS parent\n");
3153
3154 appendPQExpBuffer(&buf,
3155 "FROM pg_catalog.pg_trigger t\n"
3156 "WHERE t.tgrelid = '%s' AND ",
3157 oid);
3158
3159 /*
3160 * tgisinternal is set true for inherited triggers of partitions in
3161 * servers between v11 and v14, though these must still be shown to
3162 * the user. So we use another property that is true for such
3163 * inherited triggers to avoid them being hidden, which is their
3164 * dependence on another trigger.
3165 */
3166 if (pset.sversion >= 110000 && pset.sversion < 150000)
3167 appendPQExpBufferStr(&buf, "(NOT t.tgisinternal OR (t.tgisinternal AND t.tgenabled = 'D') \n"
3168 " OR EXISTS (SELECT 1 FROM pg_catalog.pg_depend WHERE objid = t.oid \n"
3169 " AND refclassid = 'pg_catalog.pg_trigger'::pg_catalog.regclass))");
3170 else
3171 /* display/warn about disabled internal triggers */
3172 appendPQExpBufferStr(&buf, "(NOT t.tgisinternal OR (t.tgisinternal AND t.tgenabled = 'D'))");
3173 appendPQExpBufferStr(&buf, "\nORDER BY 1;");
3174
3175 result = PSQLexec(buf.data);
3176 if (!result)
3177 goto error_return;
3178 else
3179 tuples = PQntuples(result);
3180
3181 if (tuples > 0)
3182 {
3183 bool have_heading;
3184 int category;
3185
3186 /*
3187 * split the output into 4 different categories. Enabled triggers,
3188 * disabled triggers and the two special ALWAYS and REPLICA
3189 * configurations.
3190 */
3191 for (category = 0; category <= 4; category++)
3192 {
3193 have_heading = false;
3194 for (i = 0; i < tuples; i++)
3195 {
3196 bool list_trigger;
3197 const char *tgdef;
3198 const char *usingpos;
3199 const char *tgenabled;
3200 const char *tgisinternal;
3201
3202 /*
3203 * Check if this trigger falls into the current category
3204 */
3205 tgenabled = PQgetvalue(result, i, 2);
3206 tgisinternal = PQgetvalue(result, i, 3);
3207 list_trigger = false;
3208 switch (category)
3209 {
3210 case 0:
3211 if (*tgenabled == 'O' || *tgenabled == 't')
3212 list_trigger = true;
3213 break;
3214 case 1:
3215 if ((*tgenabled == 'D' || *tgenabled == 'f') &&
3216 *tgisinternal == 'f')
3217 list_trigger = true;
3218 break;
3219 case 2:
3220 if ((*tgenabled == 'D' || *tgenabled == 'f') &&
3221 *tgisinternal == 't')
3222 list_trigger = true;
3223 break;
3224 case 3:
3225 if (*tgenabled == 'A')
3226 list_trigger = true;
3227 break;
3228 case 4:
3229 if (*tgenabled == 'R')
3230 list_trigger = true;
3231 break;
3232 }
3233 if (list_trigger == false)
3234 continue;
3235
3236 /* Print the category heading once */
3237 if (have_heading == false)
3238 {
3239 switch (category)
3240 {
3241 case 0:
3242 printfPQExpBuffer(&buf, _("Triggers:"));
3243 break;
3244 case 1:
3245 printfPQExpBuffer(&buf, _("Disabled user triggers:"));
3246 break;
3247 case 2:
3248 printfPQExpBuffer(&buf, _("Disabled internal triggers:"));
3249 break;
3250 case 3:
3251 printfPQExpBuffer(&buf, _("Triggers firing always:"));
3252 break;
3253 case 4:
3254 printfPQExpBuffer(&buf, _("Triggers firing on replica only:"));
3255 break;
3256 }
3257 printTableAddFooter(&cont, buf.data);
3258 have_heading = true;
3259 }
3260
3261 /* Everything after "TRIGGER" is echoed verbatim */
3262 tgdef = PQgetvalue(result, i, 1);
3263 usingpos = strstr(tgdef, " TRIGGER ");
3264 if (usingpos)
3265 tgdef = usingpos + 9;
3266
3267 printfPQExpBuffer(&buf, " %s", tgdef);
3268
3269 /* Visually distinguish inherited triggers */
3270 if (!PQgetisnull(result, i, 4))
3271 appendPQExpBuffer(&buf, ", ON TABLE %s",
3272 PQgetvalue(result, i, 4));
3273
3274 printTableAddFooter(&cont, buf.data);
3275 }
3276 }
3277 }
3278 PQclear(result);
3279 }
3280
3281 /*
3282 * Finish printing the footer information about a table.
3283 */
3284 if (tableinfo.relkind == RELKIND_RELATION ||
3285 tableinfo.relkind == RELKIND_MATVIEW ||
3286 tableinfo.relkind == RELKIND_FOREIGN_TABLE ||
3287 tableinfo.relkind == RELKIND_PARTITIONED_TABLE ||
3288 tableinfo.relkind == RELKIND_PARTITIONED_INDEX ||
3289 tableinfo.relkind == RELKIND_TOASTVALUE)
3290 {
3291 bool is_partitioned;
3292 PGresult *result;
3293 int tuples;
3294
3295 /* simplify some repeated tests below */
3296 is_partitioned = (tableinfo.relkind == RELKIND_PARTITIONED_TABLE ||
3297 tableinfo.relkind == RELKIND_PARTITIONED_INDEX);
3298
3299 /* print foreign server name */
3300 if (tableinfo.relkind == RELKIND_FOREIGN_TABLE)
3301 {
3302 char *ftoptions;
3303
3304 /* Footer information about foreign table */
3305 printfPQExpBuffer(&buf,
3306 "SELECT s.srvname,\n"
3307 " pg_catalog.array_to_string(ARRAY(\n"
3308 " SELECT pg_catalog.quote_ident(option_name)"
3309 " || ' ' || pg_catalog.quote_literal(option_value)\n"
3310 " FROM pg_catalog.pg_options_to_table(ftoptions)), ', ')\n"
3311 "FROM pg_catalog.pg_foreign_table f,\n"
3312 " pg_catalog.pg_foreign_server s\n"
3313 "WHERE f.ftrelid = '%s' AND s.oid = f.ftserver;",
3314 oid);
3315 result = PSQLexec(buf.data);
3316 if (!result)
3317 goto error_return;
3318 else if (PQntuples(result) != 1)
3319 {
3320 PQclear(result);
3321 goto error_return;
3322 }
3323
3324 /* Print server name */
3325 printfPQExpBuffer(&buf, _("Server: %s"),
3326 PQgetvalue(result, 0, 0));
3327 printTableAddFooter(&cont, buf.data);
3328
3329 /* Print per-table FDW options, if any */
3330 ftoptions = PQgetvalue(result, 0, 1);
3331 if (ftoptions && ftoptions[0] != '\0')
3332 {
3333 printfPQExpBuffer(&buf, _("FDW options: (%s)"), ftoptions);
3334 printTableAddFooter(&cont, buf.data);
3335 }
3336 PQclear(result);
3337 }
3338
3339 /* print tables inherited from (exclude partitioned parents) */
3340 printfPQExpBuffer(&buf,
3341 "SELECT c.oid::pg_catalog.regclass\n"
3342 "FROM pg_catalog.pg_class c, pg_catalog.pg_inherits i\n"
3343 "WHERE c.oid = i.inhparent AND i.inhrelid = '%s'\n"
3344 " AND c.relkind != " CppAsString2(RELKIND_PARTITIONED_TABLE)
3345 " AND c.relkind != " CppAsString2(RELKIND_PARTITIONED_INDEX)
3346 "\nORDER BY inhseqno;",
3347 oid);
3348
3349 result = PSQLexec(buf.data);
3350 if (!result)
3351 goto error_return;
3352 else
3353 {
3354 const char *s = _("Inherits");
3355 int sw = pg_wcswidth(s, strlen(s), pset.encoding);
3356
3357 tuples = PQntuples(result);
3358
3359 for (i = 0; i < tuples; i++)
3360 {
3361 if (i == 0)
3362 printfPQExpBuffer(&buf, "%s: %s",
3363 s, PQgetvalue(result, i, 0));
3364 else
3365 printfPQExpBuffer(&buf, "%*s %s",
3366 sw, "", PQgetvalue(result, i, 0));
3367 if (i < tuples - 1)
3368 appendPQExpBufferChar(&buf, ',');
3369
3370 printTableAddFooter(&cont, buf.data);
3371 }
3372
3373 PQclear(result);
3374 }
3375
3376 /* print child tables (with additional info if partitions) */
3377 if (pset.sversion >= 140000)
3378 printfPQExpBuffer(&buf,
3379 "SELECT c.oid::pg_catalog.regclass, c.relkind,"
3380 " inhdetachpending,"
3381 " pg_catalog.pg_get_expr(c.relpartbound, c.oid)\n"
3382 "FROM pg_catalog.pg_class c, pg_catalog.pg_inherits i\n"
3383 "WHERE c.oid = i.inhrelid AND i.inhparent = '%s'\n"
3384 "ORDER BY pg_catalog.pg_get_expr(c.relpartbound, c.oid) = 'DEFAULT',"
3385 " c.oid::pg_catalog.regclass::pg_catalog.text;",
3386 oid);
3387 else if (pset.sversion >= 100000)
3388 printfPQExpBuffer(&buf,
3389 "SELECT c.oid::pg_catalog.regclass, c.relkind,"
3390 " false AS inhdetachpending,"
3391 " pg_catalog.pg_get_expr(c.relpartbound, c.oid)\n"
3392 "FROM pg_catalog.pg_class c, pg_catalog.pg_inherits i\n"
3393 "WHERE c.oid = i.inhrelid AND i.inhparent = '%s'\n"
3394 "ORDER BY pg_catalog.pg_get_expr(c.relpartbound, c.oid) = 'DEFAULT',"
3395 " c.oid::pg_catalog.regclass::pg_catalog.text;",
3396 oid);
3397 else
3398 printfPQExpBuffer(&buf,
3399 "SELECT c.oid::pg_catalog.regclass, c.relkind,"
3400 " false AS inhdetachpending, NULL\n"
3401 "FROM pg_catalog.pg_class c, pg_catalog.pg_inherits i\n"
3402 "WHERE c.oid = i.inhrelid AND i.inhparent = '%s'\n"
3403 "ORDER BY c.oid::pg_catalog.regclass::pg_catalog.text;",
3404 oid);
3405
3406 result = PSQLexec(buf.data);
3407 if (!result)
3408 goto error_return;
3409 tuples = PQntuples(result);
3410
3411 /*
3412 * For a partitioned table with no partitions, always print the number
3413 * of partitions as zero, even when verbose output is expected.
3414 * Otherwise, we will not print "Partitions" section for a partitioned
3415 * table without any partitions.
3416 */
3417 if (is_partitioned && tuples == 0)
3418 {
3419 printfPQExpBuffer(&buf, _("Number of partitions: %d"), tuples);
3420 printTableAddFooter(&cont, buf.data);
3421 }
3422 else if (!verbose)
3423 {
3424 /* print the number of child tables, if any */
3425 if (tuples > 0)
3426 {
3427 if (is_partitioned)
3428 printfPQExpBuffer(&buf, _("Number of partitions: %d (Use \\d+ to list them.)"), tuples);
3429 else
3430 printfPQExpBuffer(&buf, _("Number of child tables: %d (Use \\d+ to list them.)"), tuples);
3431 printTableAddFooter(&cont, buf.data);
3432 }
3433 }
3434 else
3435 {
3436 /* display the list of child tables */
3437 const char *ct = is_partitioned ? _("Partitions") : _("Child tables");
3438 int ctw = pg_wcswidth(ct, strlen(ct), pset.encoding);
3439
3440 for (i = 0; i < tuples; i++)
3441 {
3442 char child_relkind = *PQgetvalue(result, i, 1);
3443
3444 if (i == 0)
3445 printfPQExpBuffer(&buf, "%s: %s",
3446 ct, PQgetvalue(result, i, 0));
3447 else
3448 printfPQExpBuffer(&buf, "%*s %s",
3449 ctw, "", PQgetvalue(result, i, 0));
3450 if (!PQgetisnull(result, i, 3))
3451 appendPQExpBuffer(&buf, " %s", PQgetvalue(result, i, 3));
3452 if (child_relkind == RELKIND_PARTITIONED_TABLE ||
3453 child_relkind == RELKIND_PARTITIONED_INDEX)
3454 appendPQExpBufferStr(&buf, ", PARTITIONED");
3455 else if (child_relkind == RELKIND_FOREIGN_TABLE)
3456 appendPQExpBufferStr(&buf, ", FOREIGN");
3457 if (strcmp(PQgetvalue(result, i, 2), "t") == 0)
3458 appendPQExpBufferStr(&buf, " (DETACH PENDING)");
3459 if (i < tuples - 1)
3460 appendPQExpBufferChar(&buf, ',');
3461
3462 printTableAddFooter(&cont, buf.data);
3463 }
3464 }
3465 PQclear(result);
3466
3467 /* Table type */
3468 if (tableinfo.reloftype)
3469 {
3470 printfPQExpBuffer(&buf, _("Typed table of type: %s"), tableinfo.reloftype);
3471 printTableAddFooter(&cont, buf.data);
3472 }
3473
3474 if (verbose &&
3475 (tableinfo.relkind == RELKIND_RELATION ||
3476 tableinfo.relkind == RELKIND_MATVIEW) &&
3477
3478 /*
3479 * No need to display default values; we already display a REPLICA
3480 * IDENTITY marker on indexes.
3481 */
3482 tableinfo.relreplident != 'i' &&
3483 ((strcmp(schemaname, "pg_catalog") != 0 && tableinfo.relreplident != 'd') ||
3484 (strcmp(schemaname, "pg_catalog") == 0 && tableinfo.relreplident != 'n')))
3485 {
3486 const char *s = _("Replica Identity");
3487
3488 printfPQExpBuffer(&buf, "%s: %s",
3489 s,
3490 tableinfo.relreplident == 'f' ? "FULL" :
3491 tableinfo.relreplident == 'n' ? "NOTHING" :
3492 "???");
3493
3494 printTableAddFooter(&cont, buf.data);
3495 }
3496
3497 /* OIDs, if verbose and not a materialized view */
3498 if (verbose && tableinfo.relkind != RELKIND_MATVIEW && tableinfo.hasoids)
3499 printTableAddFooter(&cont, _("Has OIDs: yes"));
3500
3501 /* Tablespace info */
3502 add_tablespace_footer(&cont, tableinfo.relkind, tableinfo.tablespace,
3503 true);
3504
3505 /* Access method info */
3506 if (verbose && tableinfo.relam != NULL && !pset.hide_tableam)
3507 {
3508 printfPQExpBuffer(&buf, _("Access method: %s"), tableinfo.relam);
3509 printTableAddFooter(&cont, buf.data);
3510 }
3511 }
3512
3513 /* reloptions, if verbose */
3514 if (verbose &&
3515 tableinfo.reloptions && tableinfo.reloptions[0] != '\0')
3516 {
3517 const char *t = _("Options");
3518
3519 printfPQExpBuffer(&buf, "%s: %s", t, tableinfo.reloptions);
3520 printTableAddFooter(&cont, buf.data);
3521 }
3522
3523 printTable(&cont, pset.queryFout, false, pset.logfile);
3524
3525 retval = true;
3526
3527 error_return:
3528
3529 /* clean up */
3530 if (printTableInitialized)
3531 printTableCleanup(&cont);
3532 termPQExpBuffer(&buf);
3533 termPQExpBuffer(&title);
3534 termPQExpBuffer(&tmpbuf);
3535
3536 free(view_def);
3537
3538 PQclear(res);
3539
3540 return retval;
3541 }
3542
3543 /*
3544 * Add a tablespace description to a footer. If 'newline' is true, it is added
3545 * in a new line; otherwise it's appended to the current value of the last
3546 * footer.
3547 */
3548 static void
3549 add_tablespace_footer(printTableContent *const cont, char relkind,
3550 Oid tablespace, const bool newline)
3551 {
3552 /* relkinds for which we support tablespaces */
3553 if (relkind == RELKIND_RELATION ||
3554 relkind == RELKIND_MATVIEW ||
3555 relkind == RELKIND_INDEX ||
3556 relkind == RELKIND_PARTITIONED_TABLE ||
3557 relkind == RELKIND_PARTITIONED_INDEX ||
3558 relkind == RELKIND_TOASTVALUE)
3559 {
3560 /*
3561 * We ignore the database default tablespace so that users not using
3562 * tablespaces don't need to know about them.
3563 */
3564 if (tablespace != 0)
3565 {
3566 PGresult *result = NULL;
3567 PQExpBufferData buf;
3568
3569 initPQExpBuffer(&buf);
3570 printfPQExpBuffer(&buf,
3571 "SELECT spcname FROM pg_catalog.pg_tablespace\n"
3572 "WHERE oid = '%u';", tablespace);
3573 result = PSQLexec(buf.data);
3574 if (!result)
3575 {
3576 termPQExpBuffer(&buf);
3577 return;
3578 }
3579 /* Should always be the case, but.... */
3580 if (PQntuples(result) > 0)
3581 {
3582 if (newline)
3583 {
3584 /* Add the tablespace as a new footer */
3585 printfPQExpBuffer(&buf, _("Tablespace: \"%s\""),
3586 PQgetvalue(result, 0, 0));
3587 printTableAddFooter(cont, buf.data);
3588 }
3589 else
3590 {
3591 /* Append the tablespace to the latest footer */
3592 printfPQExpBuffer(&buf, "%s", cont->footer->data);
3593
3594 /*-------
3595 translator: before this string there's an index description like
3596 '"foo_pkey" PRIMARY KEY, btree (a)' */
3597 appendPQExpBuffer(&buf, _(", tablespace \"%s\""),
3598 PQgetvalue(result, 0, 0));
3599 printTableSetFooter(cont, buf.data);
3600 }
3601 }
3602 PQclear(result);
3603 termPQExpBuffer(&buf);
3604 }
3605 }
3606 }
3607
3608 /*
3609 * \du or \dg
3610 *
3611 * Describes roles. Any schema portion of the pattern is ignored.
3612 */
3613 bool
3614 describeRoles(const char *pattern, bool verbose, bool showSystem)
3615 {
3616 PQExpBufferData buf;
3617 PGresult *res;
3618 printTableContent cont;
3619 printTableOpt myopt = pset.popt.topt;
3620 int ncols = 2;
3621 int nrows = 0;
3622 int i;
3623 int conns;
3624 const char align = 'l';
3625 char **attr;
3626
3627 myopt.default_footer = false;
3628
3629 initPQExpBuffer(&buf);
3630
3631 printfPQExpBuffer(&buf,
3632 "SELECT r.rolname, r.rolsuper, r.rolinherit,\n"
3633 " r.rolcreaterole, r.rolcreatedb, r.rolcanlogin,\n"
3634 " r.rolconnlimit, r.rolvaliduntil");
3635
3636 if (verbose)
3637 {
3638 appendPQExpBufferStr(&buf, "\n, pg_catalog.shobj_description(r.oid, 'pg_authid') AS description");
3639 ncols++;
3640 }
3641 appendPQExpBufferStr(&buf, "\n, r.rolreplication");
3642
3643 if (pset.sversion >= 90500)
3644 {
3645 appendPQExpBufferStr(&buf, "\n, r.rolbypassrls");
3646 }
3647
3648 appendPQExpBufferStr(&buf, "\nFROM pg_catalog.pg_roles r\n");
3649
3650 if (!showSystem && !pattern)
3651 appendPQExpBufferStr(&buf, "WHERE r.rolname !~ '^pg_'\n");
3652
3653 if (!validateSQLNamePattern(&buf, pattern, false, false,
3654 NULL, "r.rolname", NULL, NULL,
3655 NULL, 1))
3656 {
3657 termPQExpBuffer(&buf);
3658 return false;
3659 }
3660
3661 appendPQExpBufferStr(&buf, "ORDER BY 1;");
3662
3663 res = PSQLexec(buf.data);
3664 if (!res)
3665 return false;
3666
3667 nrows = PQntuples(res);
3668 attr = pg_malloc0((nrows + 1) * sizeof(*attr));
3669
3670 printTableInit(&cont, &myopt, _("List of roles"), ncols, nrows);
3671
3672 printTableAddHeader(&cont, gettext_noop("Role name"), true, align);
3673 printTableAddHeader(&cont, gettext_noop("Attributes"), true, align);
3674
3675 if (verbose)
3676 printTableAddHeader(&cont, gettext_noop("Description"), true, align);
3677
3678 for (i = 0; i < nrows; i++)
3679 {
3680 printTableAddCell(&cont, PQgetvalue(res, i, 0), false, false);
3681
3682 resetPQExpBuffer(&buf);
3683 if (strcmp(PQgetvalue(res, i, 1), "t") == 0)
3684 add_role_attribute(&buf, _("Superuser"));
3685
3686 if (strcmp(PQgetvalue(res, i, 2), "t") != 0)
3687 add_role_attribute(&buf, _("No inheritance"));
3688
3689 if (strcmp(PQgetvalue(res, i, 3), "t") == 0)
3690 add_role_attribute(&buf, _("Create role"));
3691
3692 if (strcmp(PQgetvalue(res, i, 4), "t") == 0)
3693 add_role_attribute(&buf, _("Create DB"));
3694
3695 if (strcmp(PQgetvalue(res, i, 5), "t") != 0)
3696 add_role_attribute(&buf, _("Cannot login"));
3697
3698 if (strcmp(PQgetvalue(res, i, (verbose ? 9 : 8)), "t") == 0)
3699 add_role_attribute(&buf, _("Replication"));
3700
3701 if (pset.sversion >= 90500)
3702 if (strcmp(PQgetvalue(res, i, (verbose ? 10 : 9)), "t") == 0)
3703 add_role_attribute(&buf, _("Bypass RLS"));
3704
3705 conns = atoi(PQgetvalue(res, i, 6));
3706 if (conns >= 0)
3707 {
3708 if (buf.len > 0)
3709 appendPQExpBufferChar(&buf, '\n');
3710
3711 if (conns == 0)
3712 appendPQExpBufferStr(&buf, _("No connections"));
3713 else
3714 appendPQExpBuffer(&buf, ngettext("%d connection",
3715 "%d connections",
3716 conns),
3717 conns);
3718 }
3719
3720 if (strcmp(PQgetvalue(res, i, 7), "") != 0)
3721 {
3722 if (buf.len > 0)
3723 appendPQExpBufferChar(&buf, '\n');
3724 appendPQExpBufferStr(&buf, _("Password valid until "));
3725 appendPQExpBufferStr(&buf, PQgetvalue(res, i, 7));
3726 }
3727
3728 attr[i] = pg_strdup(buf.data);
3729
3730 printTableAddCell(&cont, attr[i], false, false);
3731
3732 if (verbose)
3733 printTableAddCell(&cont, PQgetvalue(res, i, 8), false, false);
3734 }
3735 termPQExpBuffer(&buf);
3736
3737 printTable(&cont, pset.queryFout, false, pset.logfile);
3738 printTableCleanup(&cont);
3739
3740 for (i = 0; i < nrows; i++)
3741 free(attr[i]);
3742 free(attr);
3743
3744 PQclear(res);
3745 return true;
3746 }
3747
3748 static void
3749 add_role_attribute(PQExpBuffer buf, const char *const str)
3750 {
3751 if (buf->len > 0)
3752 appendPQExpBufferStr(buf, ", ");
3753
3754 appendPQExpBufferStr(buf, str);
3755 }
3756
3757 /*
3758 * \drds
3759 */
3760 bool
3761 listDbRoleSettings(const char *pattern, const char *pattern2)
3762 {
3763 PQExpBufferData buf;
3764 PGresult *res;
3765 printQueryOpt myopt = pset.popt;
3766 bool havewhere;
3767
3768 initPQExpBuffer(&buf);
3769
3770 printfPQExpBuffer(&buf, "SELECT rolname AS \"%s\", datname AS \"%s\",\n"
3771 "pg_catalog.array_to_string(setconfig, E'\\n') AS \"%s\"\n"
3772 "FROM pg_catalog.pg_db_role_setting s\n"
3773 "LEFT JOIN pg_catalog.pg_database d ON d.oid = setdatabase\n"
3774 "LEFT JOIN pg_catalog.pg_roles r ON r.oid = setrole\n",
3775 gettext_noop("Role"),
3776 gettext_noop("Database"),
3777 gettext_noop("Settings"));
3778 if (!validateSQLNamePattern(&buf, pattern, false, false,
3779 NULL, "r.rolname", NULL, NULL, &havewhere, 1))
3780 goto error_return;
3781 if (!validateSQLNamePattern(&buf, pattern2, havewhere, false,
3782 NULL, "d.datname", NULL, NULL,
3783 NULL, 1))
3784 goto error_return;
3785 appendPQExpBufferStr(&buf, "ORDER BY 1, 2;");
3786
3787 res = PSQLexec(buf.data);
3788 termPQExpBuffer(&buf);
3789 if (!res)
3790 return false;
3791
3792 /*
3793 * Most functions in this file are content to print an empty table when
3794 * there are no matching objects. We intentionally deviate from that
3795 * here, but only in !quiet mode, because of the possibility that the user
3796 * is confused about what the two pattern arguments mean.
3797 */
3798 if (PQntuples(res) == 0 && !pset.quiet)
3799 {
3800 if (pattern && pattern2)
3801 pg_log_error("Did not find any settings for role \"%s\" and database \"%s\".",
3802 pattern, pattern2);
3803 else if (pattern)
3804 pg_log_error("Did not find any settings for role \"%s\".",
3805 pattern);
3806 else
3807 pg_log_error("Did not find any settings.");
3808 }
3809 else
3810 {
3811 myopt.nullPrint = NULL;
3812 myopt.title = _("List of settings");
3813 myopt.translate_header = true;
3814
3815 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
3816 }
3817
3818 PQclear(res);
3819 return true;
3820
3821 error_return:
3822 termPQExpBuffer(&buf);
3823 return false;
3824 }
3825
3826 /*
3827 * \drg
3828 * Describes role grants.
3829 */
3830 bool
3831 describeRoleGrants(const char *pattern, bool showSystem)
3832 {
3833 PQExpBufferData buf;
3834 PGresult *res;
3835 printQueryOpt myopt = pset.popt;
3836
3837 initPQExpBuffer(&buf);
3838 printfPQExpBuffer(&buf,
3839 "SELECT m.rolname AS \"%s\", r.rolname AS \"%s\",\n"
3840 " pg_catalog.concat_ws(', ',\n",
3841 gettext_noop("Role name"),
3842 gettext_noop("Member of"));
3843
3844 if (pset.sversion >= 160000)
3845 appendPQExpBufferStr(&buf,
3846 " CASE WHEN pam.admin_option THEN 'ADMIN' END,\n"
3847 " CASE WHEN pam.inherit_option THEN 'INHERIT' END,\n"
3848 " CASE WHEN pam.set_option THEN 'SET' END\n");
3849 else
3850 appendPQExpBufferStr(&buf,
3851 " CASE WHEN pam.admin_option THEN 'ADMIN' END,\n"
3852 " CASE WHEN m.rolinherit THEN 'INHERIT' END,\n"
3853 " 'SET'\n");
3854
3855 appendPQExpBuffer(&buf,
3856 " ) AS \"%s\",\n"
3857 " g.rolname AS \"%s\"\n",
3858 gettext_noop("Options"),
3859 gettext_noop("Grantor"));
3860
3861 appendPQExpBufferStr(&buf,
3862 "FROM pg_catalog.pg_roles m\n"
3863 " JOIN pg_catalog.pg_auth_members pam ON (pam.member = m.oid)\n"
3864 " LEFT JOIN pg_catalog.pg_roles r ON (pam.roleid = r.oid)\n"
3865 " LEFT JOIN pg_catalog.pg_roles g ON (pam.grantor = g.oid)\n");
3866
3867 if (!showSystem && !pattern)
3868 appendPQExpBufferStr(&buf, "WHERE m.rolname !~ '^pg_'\n");
3869
3870 if (!validateSQLNamePattern(&buf, pattern, false, false,
3871 NULL, "m.rolname", NULL, NULL,
3872 NULL, 1))
3873 {
3874 termPQExpBuffer(&buf);
3875 return false;
3876 }
3877
3878 appendPQExpBufferStr(&buf, "ORDER BY 1, 2, 4;\n");
3879
3880 res = PSQLexec(buf.data);
3881 termPQExpBuffer(&buf);
3882 if (!res)
3883 return false;
3884
3885 myopt.nullPrint = NULL;
3886 myopt.title = _("List of role grants");
3887 myopt.translate_header = true;
3888
3889 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
3890
3891 PQclear(res);
3892 return true;
3893 }
3894
3895
3896 /*
3897 * listTables()
3898 *
3899 * handler for \dt, \di, etc.
3900 *
3901 * tabtypes is an array of characters, specifying what info is desired:
3902 * t - tables
3903 * i - indexes
3904 * v - views
3905 * m - materialized views
3906 * s - sequences
3907 * E - foreign table (Note: different from 'f', the relkind value)
3908 * (any order of the above is fine)
3909 */
3910 bool
3911 listTables(const char *tabtypes, const char *pattern, bool verbose, bool showSystem)
3912 {
3913 bool showTables = strchr(tabtypes, 't') != NULL;
3914 bool showIndexes = strchr(tabtypes, 'i') != NULL;
3915 bool showViews = strchr(tabtypes, 'v') != NULL;
3916 bool showMatViews = strchr(tabtypes, 'm') != NULL;
3917 bool showSeq = strchr(tabtypes, 's') != NULL;
3918 bool showForeign = strchr(tabtypes, 'E') != NULL;
3919
3920 PQExpBufferData buf;
3921 PGresult *res;
3922 printQueryOpt myopt = pset.popt;
3923 int cols_so_far;
3924 bool translate_columns[] = {false, false, true, false, false, false, false, false, false};
3925
3926 /* If tabtypes is empty, we default to \dtvmsE (but see also command.c) */
3927 if (!(showTables || showIndexes || showViews || showMatViews || showSeq || showForeign))
3928 showTables = showViews = showMatViews = showSeq = showForeign = true;
3929
3930 initPQExpBuffer(&buf);
3931
3932 printfPQExpBuffer(&buf,
3933 "SELECT n.nspname as \"%s\",\n"
3934 " c.relname as \"%s\",\n"
3935 " CASE c.relkind"
3936 " WHEN " CppAsString2(RELKIND_RELATION) " THEN '%s'"
3937 " WHEN " CppAsString2(RELKIND_VIEW) " THEN '%s'"
3938 " WHEN " CppAsString2(RELKIND_MATVIEW) " THEN '%s'"
3939 " WHEN " CppAsString2(RELKIND_INDEX) " THEN '%s'"
3940 " WHEN " CppAsString2(RELKIND_SEQUENCE) " THEN '%s'"
3941 " WHEN " CppAsString2(RELKIND_TOASTVALUE) " THEN '%s'"
3942 " WHEN " CppAsString2(RELKIND_FOREIGN_TABLE) " THEN '%s'"
3943 " WHEN " CppAsString2(RELKIND_PARTITIONED_TABLE) " THEN '%s'"
3944 " WHEN " CppAsString2(RELKIND_PARTITIONED_INDEX) " THEN '%s'"
3945 " END as \"%s\",\n"
3946 " pg_catalog.pg_get_userbyid(c.relowner) as \"%s\"",
3947 gettext_noop("Schema"),
3948 gettext_noop("Name"),
3949 gettext_noop("table"),
3950 gettext_noop("view"),
3951 gettext_noop("materialized view"),
3952 gettext_noop("index"),
3953 gettext_noop("sequence"),
3954 gettext_noop("TOAST table"),
3955 gettext_noop("foreign table"),
3956 gettext_noop("partitioned table"),
3957 gettext_noop("partitioned index"),
3958 gettext_noop("Type"),
3959 gettext_noop("Owner"));
3960 cols_so_far = 4;
3961
3962 if (showIndexes)
3963 {
3964 appendPQExpBuffer(&buf,
3965 ",\n c2.relname as \"%s\"",
3966 gettext_noop("Table"));
3967 cols_so_far++;
3968 }
3969
3970 if (verbose)
3971 {
3972 /*
3973 * Show whether a relation is permanent, temporary, or unlogged.
3974 */
3975 appendPQExpBuffer(&buf,
3976 ",\n CASE c.relpersistence WHEN 'p' THEN '%s' WHEN 't' THEN '%s' WHEN 'u' THEN '%s' END as \"%s\"",
3977 gettext_noop("permanent"),
3978 gettext_noop("temporary"),
3979 gettext_noop("unlogged"),
3980 gettext_noop("Persistence"));
3981 translate_columns[cols_so_far] = true;
3982
3983 /*
3984 * We don't bother to count cols_so_far below here, as there's no need
3985 * to; this might change with future additions to the output columns.
3986 */
3987
3988 /*
3989 * Access methods exist for tables, materialized views and indexes.
3990 * This has been introduced in PostgreSQL 12 for tables.
3991 */
3992 if (pset.sversion >= 120000 && !pset.hide_tableam &&
3993 (showTables || showMatViews || showIndexes))
3994 appendPQExpBuffer(&buf,
3995 ",\n am.amname as \"%s\"",
3996 gettext_noop("Access method"));
3997
3998 appendPQExpBuffer(&buf,
3999 ",\n pg_catalog.pg_size_pretty(pg_catalog.pg_table_size(c.oid)) as \"%s\""
4000 ",\n pg_catalog.obj_description(c.oid, 'pg_class') as \"%s\"",
4001 gettext_noop("Size"),
4002 gettext_noop("Description"));
4003 }
4004
4005 appendPQExpBufferStr(&buf,
4006 "\nFROM pg_catalog.pg_class c"
4007 "\n LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace");
4008
4009 if (pset.sversion >= 120000 && !pset.hide_tableam &&
4010 (showTables || showMatViews || showIndexes))
4011 appendPQExpBufferStr(&buf,
4012 "\n LEFT JOIN pg_catalog.pg_am am ON am.oid = c.relam");
4013
4014 if (showIndexes)
4015 appendPQExpBufferStr(&buf,
4016 "\n LEFT JOIN pg_catalog.pg_index i ON i.indexrelid = c.oid"
4017 "\n LEFT JOIN pg_catalog.pg_class c2 ON i.indrelid = c2.oid");
4018
4019 appendPQExpBufferStr(&buf, "\nWHERE c.relkind IN (");
4020 if (showTables)
4021 {
4022 appendPQExpBufferStr(&buf, CppAsString2(RELKIND_RELATION) ","
4023 CppAsString2(RELKIND_PARTITIONED_TABLE) ",");
4024 /* with 'S' or a pattern, allow 't' to match TOAST tables too */
4025 if (showSystem || pattern)
4026 appendPQExpBufferStr(&buf, CppAsString2(RELKIND_TOASTVALUE) ",");
4027 }
4028 if (showViews)
4029 appendPQExpBufferStr(&buf, CppAsString2(RELKIND_VIEW) ",");
4030 if (showMatViews)
4031 appendPQExpBufferStr(&buf, CppAsString2(RELKIND_MATVIEW) ",");
4032 if (showIndexes)
4033 appendPQExpBufferStr(&buf, CppAsString2(RELKIND_INDEX) ","
4034 CppAsString2(RELKIND_PARTITIONED_INDEX) ",");
4035 if (showSeq)
4036 appendPQExpBufferStr(&buf, CppAsString2(RELKIND_SEQUENCE) ",");
4037 if (showSystem || pattern)
4038 appendPQExpBufferStr(&buf, "'s',"); /* was RELKIND_SPECIAL */
4039 if (showForeign)
4040 appendPQExpBufferStr(&buf, CppAsString2(RELKIND_FOREIGN_TABLE) ",");
4041
4042 appendPQExpBufferStr(&buf, "''"); /* dummy */
4043 appendPQExpBufferStr(&buf, ")\n");
4044
4045 if (!showSystem && !pattern)
4046 appendPQExpBufferStr(&buf, " AND n.nspname <> 'pg_catalog'\n"
4047 " AND n.nspname !~ '^pg_toast'\n"
4048 " AND n.nspname <> 'information_schema'\n");
4049
4050 if (!validateSQLNamePattern(&buf, pattern, true, false,
4051 "n.nspname", "c.relname", NULL,
4052 "pg_catalog.pg_table_is_visible(c.oid)",
4053 NULL, 3))
4054 {
4055 termPQExpBuffer(&buf);
4056 return false;
4057 }
4058
4059 appendPQExpBufferStr(&buf, "ORDER BY 1,2;");
4060
4061 res = PSQLexec(buf.data);
4062 termPQExpBuffer(&buf);
4063 if (!res)
4064 return false;
4065
4066 /*
4067 * Most functions in this file are content to print an empty table when
4068 * there are no matching objects. We intentionally deviate from that
4069 * here, but only in !quiet mode, for historical reasons.
4070 */
4071 if (PQntuples(res) == 0 && !pset.quiet)
4072 {
4073 if (pattern)
4074 pg_log_error("Did not find any relation named \"%s\".",
4075 pattern);
4076 else
4077 pg_log_error("Did not find any relations.");
4078 }
4079 else
4080 {
4081 myopt.nullPrint = NULL;
4082 myopt.title = _("List of relations");
4083 myopt.translate_header = true;
4084 myopt.translate_columns = translate_columns;
4085 myopt.n_translate_columns = lengthof(translate_columns);
4086
4087 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
4088 }
4089
4090 PQclear(res);
4091 return true;
4092 }
4093
4094 /*
4095 * \dP
4096 * Takes an optional regexp to select particular relations
4097 *
4098 * As with \d, you can specify the kinds of relations you want:
4099 *
4100 * t for tables
4101 * i for indexes
4102 *
4103 * And there's additional flags:
4104 *
4105 * n to list non-leaf partitioned tables
4106 *
4107 * and you can mix and match these in any order.
4108 */
4109 bool
4110 listPartitionedTables(const char *reltypes, const char *pattern, bool verbose)
4111 {
4112 bool showTables = strchr(reltypes, 't') != NULL;
4113 bool showIndexes = strchr(reltypes, 'i') != NULL;
4114 bool showNested = strchr(reltypes, 'n') != NULL;
4115 PQExpBufferData buf;
4116 PQExpBufferData title;
4117 PGresult *res;
4118 printQueryOpt myopt = pset.popt;
4119 bool translate_columns[] = {false, false, false, false, false, false, false, false, false};
4120 const char *tabletitle;
4121 bool mixed_output = false;
4122
4123 /*
4124 * Note: Declarative table partitioning is only supported as of Pg 10.0.
4125 */
4126 if (pset.sversion < 100000)
4127 {
4128 char sverbuf[32];
4129
4130 pg_log_error("The server (version %s) does not support declarative table partitioning.",
4131 formatPGVersionNumber(pset.sversion, false,
4132 sverbuf, sizeof(sverbuf)));
4133 return true;
4134 }
4135
4136 /* If no relation kind was selected, show them all */
4137 if (!showTables && !showIndexes)
4138 showTables = showIndexes = true;
4139
4140 if (showIndexes && !showTables)
4141 tabletitle = _("List of partitioned indexes"); /* \dPi */
4142 else if (showTables && !showIndexes)
4143 tabletitle = _("List of partitioned tables"); /* \dPt */
4144 else
4145 {
4146 /* show all kinds */
4147 tabletitle = _("List of partitioned relations");
4148 mixed_output = true;
4149 }
4150
4151 initPQExpBuffer(&buf);
4152
4153 printfPQExpBuffer(&buf,
4154 "SELECT n.nspname as \"%s\",\n"
4155 " c.relname as \"%s\",\n"
4156 " pg_catalog.pg_get_userbyid(c.relowner) as \"%s\"",
4157 gettext_noop("Schema"),
4158 gettext_noop("Name"),
4159 gettext_noop("Owner"));
4160
4161 if (mixed_output)
4162 {
4163 appendPQExpBuffer(&buf,
4164 ",\n CASE c.relkind"
4165 " WHEN " CppAsString2(RELKIND_PARTITIONED_TABLE) " THEN '%s'"
4166 " WHEN " CppAsString2(RELKIND_PARTITIONED_INDEX) " THEN '%s'"
4167 " END as \"%s\"",
4168 gettext_noop("partitioned table"),
4169 gettext_noop("partitioned index"),
4170 gettext_noop("Type"));
4171
4172 translate_columns[3] = true;
4173 }
4174
4175 if (showNested || pattern)
4176 appendPQExpBuffer(&buf,
4177 ",\n inh.inhparent::pg_catalog.regclass as \"%s\"",
4178 gettext_noop("Parent name"));
4179
4180 if (showIndexes)
4181 appendPQExpBuffer(&buf,
4182 ",\n c2.oid::pg_catalog.regclass as \"%s\"",
4183 gettext_noop("Table"));
4184
4185 if (verbose)
4186 {
4187 if (showNested)
4188 {
4189 appendPQExpBuffer(&buf,
4190 ",\n s.dps as \"%s\"",
4191 gettext_noop("Leaf partition size"));
4192 appendPQExpBuffer(&buf,
4193 ",\n s.tps as \"%s\"",
4194 gettext_noop("Total size"));
4195 }
4196 else
4197 /* Sizes of all partitions are considered in this case. */
4198 appendPQExpBuffer(&buf,
4199 ",\n s.tps as \"%s\"",
4200 gettext_noop("Total size"));
4201
4202 appendPQExpBuffer(&buf,
4203 ",\n pg_catalog.obj_description(c.oid, 'pg_class') as \"%s\"",
4204 gettext_noop("Description"));
4205 }
4206
4207 appendPQExpBufferStr(&buf,
4208 "\nFROM pg_catalog.pg_class c"
4209 "\n LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace");
4210
4211 if (showIndexes)
4212 appendPQExpBufferStr(&buf,
4213 "\n LEFT JOIN pg_catalog.pg_index i ON i.indexrelid = c.oid"
4214 "\n LEFT JOIN pg_catalog.pg_class c2 ON i.indrelid = c2.oid");
4215
4216 if (showNested || pattern)
4217 appendPQExpBufferStr(&buf,
4218 "\n LEFT JOIN pg_catalog.pg_inherits inh ON c.oid = inh.inhrelid");
4219
4220 if (verbose)
4221 {
4222 if (pset.sversion < 120000)
4223 {
4224 appendPQExpBufferStr(&buf,
4225 ",\n LATERAL (WITH RECURSIVE d\n"
4226 " AS (SELECT inhrelid AS oid, 1 AS level\n"
4227 " FROM pg_catalog.pg_inherits\n"
4228 " WHERE inhparent = c.oid\n"
4229 " UNION ALL\n"
4230 " SELECT inhrelid, level + 1\n"
4231 " FROM pg_catalog.pg_inherits i\n"
4232 " JOIN d ON i.inhparent = d.oid)\n"
4233 " SELECT pg_catalog.pg_size_pretty(sum(pg_catalog.pg_table_size("
4234 "d.oid))) AS tps,\n"
4235 " pg_catalog.pg_size_pretty(sum("
4236 "\n CASE WHEN d.level = 1"
4237 " THEN pg_catalog.pg_table_size(d.oid) ELSE 0 END)) AS dps\n"
4238 " FROM d) s");
4239 }
4240 else
4241 {
4242 /* PostgreSQL 12 has pg_partition_tree function */
4243 appendPQExpBufferStr(&buf,
4244 ",\n LATERAL (SELECT pg_catalog.pg_size_pretty(sum("
4245 "\n CASE WHEN ppt.isleaf AND ppt.level = 1"
4246 "\n THEN pg_catalog.pg_table_size(ppt.relid)"
4247 " ELSE 0 END)) AS dps"
4248 ",\n pg_catalog.pg_size_pretty(sum("
4249 "pg_catalog.pg_table_size(ppt.relid))) AS tps"
4250 "\n FROM pg_catalog.pg_partition_tree(c.oid) ppt) s");
4251 }
4252 }
4253
4254 appendPQExpBufferStr(&buf, "\nWHERE c.relkind IN (");
4255 if (showTables)
4256 appendPQExpBufferStr(&buf, CppAsString2(RELKIND_PARTITIONED_TABLE) ",");
4257 if (showIndexes)
4258 appendPQExpBufferStr(&buf, CppAsString2(RELKIND_PARTITIONED_INDEX) ",");
4259 appendPQExpBufferStr(&buf, "''"); /* dummy */
4260 appendPQExpBufferStr(&buf, ")\n");
4261
4262 appendPQExpBufferStr(&buf, !showNested && !pattern ?
4263 " AND NOT c.relispartition\n" : "");
4264
4265 if (!pattern)
4266 appendPQExpBufferStr(&buf, " AND n.nspname <> 'pg_catalog'\n"
4267 " AND n.nspname !~ '^pg_toast'\n"
4268 " AND n.nspname <> 'information_schema'\n");
4269
4270 if (!validateSQLNamePattern(&buf, pattern, true, false,
4271 "n.nspname", "c.relname", NULL,
4272 "pg_catalog.pg_table_is_visible(c.oid)",
4273 NULL, 3))
4274 {
4275 termPQExpBuffer(&buf);
4276 return false;
4277 }
4278
4279 appendPQExpBuffer(&buf, "ORDER BY \"Schema\", %s%s\"Name\";",
4280 mixed_output ? "\"Type\" DESC, " : "",
4281 showNested || pattern ? "\"Parent name\" NULLS FIRST, " : "");
4282
4283 res = PSQLexec(buf.data);
4284 termPQExpBuffer(&buf);
4285 if (!res)
4286 return false;
4287
4288 initPQExpBuffer(&title);
4289 appendPQExpBufferStr(&title, tabletitle);
4290
4291 myopt.nullPrint = NULL;
4292 myopt.title = title.data;
4293 myopt.translate_header = true;
4294 myopt.translate_columns = translate_columns;
4295 myopt.n_translate_columns = lengthof(translate_columns);
4296
4297 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
4298
4299 termPQExpBuffer(&title);
4300
4301 PQclear(res);
4302 return true;
4303 }
4304
4305 /*
4306 * \dL
4307 *
4308 * Describes languages.
4309 */
4310 bool
4311 listLanguages(const char *pattern, bool verbose, bool showSystem)
4312 {
4313 PQExpBufferData buf;
4314 PGresult *res;
4315 printQueryOpt myopt = pset.popt;
4316
4317 initPQExpBuffer(&buf);
4318
4319 printfPQExpBuffer(&buf,
4320 "SELECT l.lanname AS \"%s\",\n"
4321 " pg_catalog.pg_get_userbyid(l.lanowner) as \"%s\",\n"
4322 " l.lanpltrusted AS \"%s\"",
4323 gettext_noop("Name"),
4324 gettext_noop("Owner"),
4325 gettext_noop("Trusted"));
4326
4327 if (verbose)
4328 {
4329 appendPQExpBuffer(&buf,
4330 ",\n NOT l.lanispl AS \"%s\",\n"
4331 " l.lanplcallfoid::pg_catalog.regprocedure AS \"%s\",\n"
4332 " l.lanvalidator::pg_catalog.regprocedure AS \"%s\",\n "
4333 "l.laninline::pg_catalog.regprocedure AS \"%s\",\n ",
4334 gettext_noop("Internal language"),
4335 gettext_noop("Call handler"),
4336 gettext_noop("Validator"),
4337 gettext_noop("Inline handler"));
4338 printACLColumn(&buf, "l.lanacl");
4339 }
4340
4341 appendPQExpBuffer(&buf,
4342 ",\n d.description AS \"%s\""
4343 "\nFROM pg_catalog.pg_language l\n"
4344 "LEFT JOIN pg_catalog.pg_description d\n"
4345 " ON d.classoid = l.tableoid AND d.objoid = l.oid\n"
4346 " AND d.objsubid = 0\n",
4347 gettext_noop("Description"));
4348
4349 if (pattern)
4350 {
4351 if (!validateSQLNamePattern(&buf, pattern, false, false,
4352 NULL, "l.lanname", NULL, NULL,
4353 NULL, 2))
4354 {
4355 termPQExpBuffer(&buf);
4356 return false;
4357 }
4358 }
4359
4360 if (!showSystem && !pattern)
4361 appendPQExpBufferStr(&buf, "WHERE l.lanplcallfoid != 0\n");
4362
4363
4364 appendPQExpBufferStr(&buf, "ORDER BY 1;");
4365
4366 res = PSQLexec(buf.data);
4367 termPQExpBuffer(&buf);
4368 if (!res)
4369 return false;
4370
4371 myopt.nullPrint = NULL;
4372 myopt.title = _("List of languages");
4373 myopt.translate_header = true;
4374
4375 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
4376
4377 PQclear(res);
4378 return true;
4379 }
4380
4381
4382 /*
4383 * \dD
4384 *
4385 * Describes domains.
4386 */
4387 bool
4388 listDomains(const char *pattern, bool verbose, bool showSystem)
4389 {
4390 PQExpBufferData buf;
4391 PGresult *res;
4392 printQueryOpt myopt = pset.popt;
4393
4394 initPQExpBuffer(&buf);
4395
4396 printfPQExpBuffer(&buf,
4397 "SELECT n.nspname as \"%s\",\n"
4398 " t.typname as \"%s\",\n"
4399 " pg_catalog.format_type(t.typbasetype, t.typtypmod) as \"%s\",\n"
4400 " (SELECT c.collname FROM pg_catalog.pg_collation c, pg_catalog.pg_type bt\n"
4401 " WHERE c.oid = t.typcollation AND bt.oid = t.typbasetype AND t.typcollation <> bt.typcollation) as \"%s\",\n"
4402 " CASE WHEN t.typnotnull THEN 'not null' END as \"%s\",\n"
4403 " t.typdefault as \"%s\",\n"
4404 " pg_catalog.array_to_string(ARRAY(\n"
4405 " SELECT pg_catalog.pg_get_constraintdef(r.oid, true) FROM pg_catalog.pg_constraint r WHERE t.oid = r.contypid\n"
4406 " ), ' ') as \"%s\"",
4407 gettext_noop("Schema"),
4408 gettext_noop("Name"),
4409 gettext_noop("Type"),
4410 gettext_noop("Collation"),
4411 gettext_noop("Nullable"),
4412 gettext_noop("Default"),
4413 gettext_noop("Check"));
4414
4415 if (verbose)
4416 {
4417 appendPQExpBufferStr(&buf, ",\n ");
4418 printACLColumn(&buf, "t.typacl");
4419 appendPQExpBuffer(&buf,
4420 ",\n d.description as \"%s\"",
4421 gettext_noop("Description"));
4422 }
4423
4424 appendPQExpBufferStr(&buf,
4425 "\nFROM pg_catalog.pg_type t\n"
4426 " LEFT JOIN pg_catalog.pg_namespace n ON n.oid = t.typnamespace\n");
4427
4428 if (verbose)
4429 appendPQExpBufferStr(&buf,
4430 " LEFT JOIN pg_catalog.pg_description d "
4431 "ON d.classoid = t.tableoid AND d.objoid = t.oid "
4432 "AND d.objsubid = 0\n");
4433
4434 appendPQExpBufferStr(&buf, "WHERE t.typtype = 'd'\n");
4435
4436 if (!showSystem && !pattern)
4437 appendPQExpBufferStr(&buf, " AND n.nspname <> 'pg_catalog'\n"
4438 " AND n.nspname <> 'information_schema'\n");
4439
4440 if (!validateSQLNamePattern(&buf, pattern, true, false,
4441 "n.nspname", "t.typname", NULL,
4442 "pg_catalog.pg_type_is_visible(t.oid)",
4443 NULL, 3))
4444 {
4445 termPQExpBuffer(&buf);
4446 return false;
4447 }
4448
4449 appendPQExpBufferStr(&buf, "ORDER BY 1, 2;");
4450
4451 res = PSQLexec(buf.data);
4452 termPQExpBuffer(&buf);
4453 if (!res)
4454 return false;
4455
4456 myopt.nullPrint = NULL;
4457 myopt.title = _("List of domains");
4458 myopt.translate_header = true;
4459
4460 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
4461
4462 PQclear(res);
4463 return true;
4464 }
4465
4466 /*
4467 * \dc
4468 *
4469 * Describes conversions.
4470 */
4471 bool
4472 listConversions(const char *pattern, bool verbose, bool showSystem)
4473 {
4474 PQExpBufferData buf;
4475 PGresult *res;
4476 printQueryOpt myopt = pset.popt;
4477 static const bool translate_columns[] =
4478 {false, false, false, false, true, false};
4479
4480 initPQExpBuffer(&buf);
4481
4482 printfPQExpBuffer(&buf,
4483 "SELECT n.nspname AS \"%s\",\n"
4484 " c.conname AS \"%s\",\n"
4485 " pg_catalog.pg_encoding_to_char(c.conforencoding) AS \"%s\",\n"
4486 " pg_catalog.pg_encoding_to_char(c.contoencoding) AS \"%s\",\n"
4487 " CASE WHEN c.condefault THEN '%s'\n"
4488 " ELSE '%s' END AS \"%s\"",
4489 gettext_noop("Schema"),
4490 gettext_noop("Name"),
4491 gettext_noop("Source"),
4492 gettext_noop("Destination"),
4493 gettext_noop("yes"), gettext_noop("no"),
4494 gettext_noop("Default?"));
4495
4496 if (verbose)
4497 appendPQExpBuffer(&buf,
4498 ",\n d.description AS \"%s\"",
4499 gettext_noop("Description"));
4500
4501 appendPQExpBufferStr(&buf,
4502 "\nFROM pg_catalog.pg_conversion c\n"
4503 " JOIN pg_catalog.pg_namespace n "
4504 "ON n.oid = c.connamespace\n");
4505
4506 if (verbose)
4507 appendPQExpBufferStr(&buf,
4508 "LEFT JOIN pg_catalog.pg_description d "
4509 "ON d.classoid = c.tableoid\n"
4510 " AND d.objoid = c.oid "
4511 "AND d.objsubid = 0\n");
4512
4513 appendPQExpBufferStr(&buf, "WHERE true\n");
4514
4515 if (!showSystem && !pattern)
4516 appendPQExpBufferStr(&buf, " AND n.nspname <> 'pg_catalog'\n"
4517 " AND n.nspname <> 'information_schema'\n");
4518
4519 if (!validateSQLNamePattern(&buf, pattern, true, false,
4520 "n.nspname", "c.conname", NULL,
4521 "pg_catalog.pg_conversion_is_visible(c.oid)",
4522 NULL, 3))
4523 {
4524 termPQExpBuffer(&buf);
4525 return false;
4526 }
4527
4528 appendPQExpBufferStr(&buf, "ORDER BY 1, 2;");
4529
4530 res = PSQLexec(buf.data);
4531 termPQExpBuffer(&buf);
4532 if (!res)
4533 return false;
4534
4535 myopt.nullPrint = NULL;
4536 myopt.title = _("List of conversions");
4537 myopt.translate_header = true;
4538 myopt.translate_columns = translate_columns;
4539 myopt.n_translate_columns = lengthof(translate_columns);
4540
4541 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
4542
4543 PQclear(res);
4544 return true;
4545 }
4546
4547 /*
4548 * \dconfig
4549 *
4550 * Describes configuration parameters.
4551 */
4552 bool
4553 describeConfigurationParameters(const char *pattern, bool verbose,
4554 bool showSystem)
4555 {
4556 PQExpBufferData buf;
4557 PGresult *res;
4558 printQueryOpt myopt = pset.popt;
4559
4560 initPQExpBuffer(&buf);
4561 printfPQExpBuffer(&buf,
4562 "SELECT s.name AS \"%s\", "
4563 "pg_catalog.current_setting(s.name) AS \"%s\"",
4564 gettext_noop("Parameter"),
4565 gettext_noop("Value"));
4566
4567 if (verbose)
4568 {
4569 appendPQExpBuffer(&buf,
4570 ", s.vartype AS \"%s\", s.context AS \"%s\", ",
4571 gettext_noop("Type"),
4572 gettext_noop("Context"));
4573 if (pset.sversion >= 150000)
4574 printACLColumn(&buf, "p.paracl");
4575 else
4576 appendPQExpBuffer(&buf, "NULL AS \"%s\"",
4577 gettext_noop("Access privileges"));
4578 }
4579
4580 appendPQExpBufferStr(&buf, "\nFROM pg_catalog.pg_settings s\n");
4581
4582 if (verbose && pset.sversion >= 150000)
4583 appendPQExpBufferStr(&buf,
4584 " LEFT JOIN pg_catalog.pg_parameter_acl p\n"
4585 " ON pg_catalog.lower(s.name) = p.parname\n");
4586
4587 if (pattern)
4588 processSQLNamePattern(pset.db, &buf, pattern,
4589 false, false,
4590 NULL, "pg_catalog.lower(s.name)", NULL,
4591 NULL, NULL, NULL);
4592 else
4593 appendPQExpBufferStr(&buf, "WHERE s.source <> 'default' AND\n"
4594 " s.setting IS DISTINCT FROM s.boot_val\n");
4595
4596 appendPQExpBufferStr(&buf, "ORDER BY 1;");
4597
4598 res = PSQLexec(buf.data);
4599 termPQExpBuffer(&buf);
4600 if (!res)
4601 return false;
4602
4603 myopt.nullPrint = NULL;
4604 if (pattern)
4605 myopt.title = _("List of configuration parameters");
4606 else
4607 myopt.title = _("List of non-default configuration parameters");
4608 myopt.translate_header = true;
4609
4610 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
4611
4612 PQclear(res);
4613 return true;
4614 }
4615
4616 /*
4617 * \dy
4618 *
4619 * Describes Event Triggers.
4620 */
4621 bool
4622 listEventTriggers(const char *pattern, bool verbose)
4623 {
4624 PQExpBufferData buf;
4625 PGresult *res;
4626 printQueryOpt myopt = pset.popt;
4627 static const bool translate_columns[] =
4628 {false, false, false, true, false, false, false};
4629
4630 if (pset.sversion < 90300)
4631 {
4632 char sverbuf[32];
4633
4634 pg_log_error("The server (version %s) does not support event triggers.",
4635 formatPGVersionNumber(pset.sversion, false,
4636 sverbuf, sizeof(sverbuf)));
4637 return true;
4638 }
4639
4640 initPQExpBuffer(&buf);
4641
4642 printfPQExpBuffer(&buf,
4643 "SELECT evtname as \"%s\", "
4644 "evtevent as \"%s\", "
4645 "pg_catalog.pg_get_userbyid(e.evtowner) as \"%s\",\n"
4646 " case evtenabled when 'O' then '%s'"
4647 " when 'R' then '%s'"
4648 " when 'A' then '%s'"
4649 " when 'D' then '%s' end as \"%s\",\n"
4650 " e.evtfoid::pg_catalog.regproc as \"%s\", "
4651 "pg_catalog.array_to_string(array(select x"
4652 " from pg_catalog.unnest(evttags) as t(x)), ', ') as \"%s\"",
4653 gettext_noop("Name"),
4654 gettext_noop("Event"),
4655 gettext_noop("Owner"),
4656 gettext_noop("enabled"),
4657 gettext_noop("replica"),
4658 gettext_noop("always"),
4659 gettext_noop("disabled"),
4660 gettext_noop("Enabled"),
4661 gettext_noop("Function"),
4662 gettext_noop("Tags"));
4663 if (verbose)
4664 appendPQExpBuffer(&buf,
4665 ",\npg_catalog.obj_description(e.oid, 'pg_event_trigger') as \"%s\"",
4666 gettext_noop("Description"));
4667 appendPQExpBufferStr(&buf,
4668 "\nFROM pg_catalog.pg_event_trigger e ");
4669
4670 if (!validateSQLNamePattern(&buf, pattern, false, false,
4671 NULL, "evtname", NULL, NULL,
4672 NULL, 1))
4673 {
4674 termPQExpBuffer(&buf);
4675 return false;
4676 }
4677
4678 appendPQExpBufferStr(&buf, "ORDER BY 1");
4679
4680 res = PSQLexec(buf.data);
4681 termPQExpBuffer(&buf);
4682 if (!res)
4683 return false;
4684
4685 myopt.nullPrint = NULL;
4686 myopt.title = _("List of event triggers");
4687 myopt.translate_header = true;
4688 myopt.translate_columns = translate_columns;
4689 myopt.n_translate_columns = lengthof(translate_columns);
4690
4691 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
4692
4693 PQclear(res);
4694 return true;
4695 }
4696
4697 /*
4698 * \dX
4699 *
4700 * Describes extended statistics.
4701 */
4702 bool
4703 listExtendedStats(const char *pattern)
4704 {
4705 PQExpBufferData buf;
4706 PGresult *res;
4707 printQueryOpt myopt = pset.popt;
4708
4709 if (pset.sversion < 100000)
4710 {
4711 char sverbuf[32];
4712
4713 pg_log_error("The server (version %s) does not support extended statistics.",
4714 formatPGVersionNumber(pset.sversion, false,
4715 sverbuf, sizeof(sverbuf)));
4716 return true;
4717 }
4718
4719 initPQExpBuffer(&buf);
4720 printfPQExpBuffer(&buf,
4721 "SELECT \n"
4722 "es.stxnamespace::pg_catalog.regnamespace::pg_catalog.text AS \"%s\", \n"
4723 "es.stxname AS \"%s\", \n",
4724 gettext_noop("Schema"),
4725 gettext_noop("Name"));
4726
4727 if (pset.sversion >= 140000)
4728 appendPQExpBuffer(&buf,
4729 "pg_catalog.format('%%s FROM %%s', \n"
4730 " pg_catalog.pg_get_statisticsobjdef_columns(es.oid), \n"
4731 " es.stxrelid::pg_catalog.regclass) AS \"%s\"",
4732 gettext_noop("Definition"));
4733 else
4734 appendPQExpBuffer(&buf,
4735 "pg_catalog.format('%%s FROM %%s', \n"
4736 " (SELECT pg_catalog.string_agg(pg_catalog.quote_ident(a.attname),', ') \n"
4737 " FROM pg_catalog.unnest(es.stxkeys) s(attnum) \n"
4738 " JOIN pg_catalog.pg_attribute a \n"
4739 " ON (es.stxrelid = a.attrelid \n"
4740 " AND a.attnum = s.attnum \n"
4741 " AND NOT a.attisdropped)), \n"
4742 "es.stxrelid::pg_catalog.regclass) AS \"%s\"",
4743 gettext_noop("Definition"));
4744
4745 appendPQExpBuffer(&buf,
4746 ",\nCASE WHEN 'd' = any(es.stxkind) THEN 'defined' \n"
4747 "END AS \"%s\", \n"
4748 "CASE WHEN 'f' = any(es.stxkind) THEN 'defined' \n"
4749 "END AS \"%s\"",
4750 gettext_noop("Ndistinct"),
4751 gettext_noop("Dependencies"));
4752
4753 /*
4754 * Include the MCV statistics kind.
4755 */
4756 if (pset.sversion >= 120000)
4757 {
4758 appendPQExpBuffer(&buf,
4759 ",\nCASE WHEN 'm' = any(es.stxkind) THEN 'defined' \n"
4760 "END AS \"%s\" ",
4761 gettext_noop("MCV"));
4762 }
4763
4764 appendPQExpBufferStr(&buf,
4765 " \nFROM pg_catalog.pg_statistic_ext es \n");
4766
4767 if (!validateSQLNamePattern(&buf, pattern,
4768 false, false,
4769 "es.stxnamespace::pg_catalog.regnamespace::pg_catalog.text", "es.stxname",
4770 NULL, "pg_catalog.pg_statistics_obj_is_visible(es.oid)",
4771 NULL, 3))
4772 {
4773 termPQExpBuffer(&buf);
4774 return false;
4775 }
4776
4777 appendPQExpBufferStr(&buf, "ORDER BY 1, 2;");
4778
4779 res = PSQLexec(buf.data);
4780 termPQExpBuffer(&buf);
4781 if (!res)
4782 return false;
4783
4784 myopt.nullPrint = NULL;
4785 myopt.title = _("List of extended statistics");
4786 myopt.translate_header = true;
4787
4788 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
4789
4790 PQclear(res);
4791 return true;
4792 }
4793
4794 /*
4795 * \dC
4796 *
4797 * Describes casts.
4798 */
4799 bool
4800 listCasts(const char *pattern, bool verbose)
4801 {
4802 PQExpBufferData buf;
4803 PGresult *res;
4804 printQueryOpt myopt = pset.popt;
4805 static const bool translate_columns[] = {false, false, false, true, false};
4806
4807 initPQExpBuffer(&buf);
4808
4809 printfPQExpBuffer(&buf,
4810 "SELECT pg_catalog.format_type(castsource, NULL) AS \"%s\",\n"
4811 " pg_catalog.format_type(casttarget, NULL) AS \"%s\",\n",
4812 gettext_noop("Source type"),
4813 gettext_noop("Target type"));
4814
4815 /*
4816 * We don't attempt to localize '(binary coercible)' or '(with inout)',
4817 * because there's too much risk of gettext translating a function name
4818 * that happens to match some string in the PO database.
4819 */
4820 appendPQExpBuffer(&buf,
4821 " CASE WHEN c.castmethod = '%c' THEN '(binary coercible)'\n"
4822 " WHEN c.castmethod = '%c' THEN '(with inout)'\n"
4823 " ELSE p.proname\n"
4824 " END AS \"%s\",\n",
4825 COERCION_METHOD_BINARY,
4826 COERCION_METHOD_INOUT,
4827 gettext_noop("Function"));
4828
4829 appendPQExpBuffer(&buf,
4830 " CASE WHEN c.castcontext = '%c' THEN '%s'\n"
4831 " WHEN c.castcontext = '%c' THEN '%s'\n"
4832 " ELSE '%s'\n"
4833 " END AS \"%s\"",
4834 COERCION_CODE_EXPLICIT,
4835 gettext_noop("no"),
4836 COERCION_CODE_ASSIGNMENT,
4837 gettext_noop("in assignment"),
4838 gettext_noop("yes"),
4839 gettext_noop("Implicit?"));
4840
4841 if (verbose)
4842 appendPQExpBuffer(&buf,
4843 ",\n d.description AS \"%s\"",
4844 gettext_noop("Description"));
4845
4846 /*
4847 * We need a left join to pg_proc for binary casts; the others are just
4848 * paranoia.
4849 */
4850 appendPQExpBufferStr(&buf,
4851 "\nFROM pg_catalog.pg_cast c LEFT JOIN pg_catalog.pg_proc p\n"
4852 " ON c.castfunc = p.oid\n"
4853 " LEFT JOIN pg_catalog.pg_type ts\n"
4854 " ON c.castsource = ts.oid\n"
4855 " LEFT JOIN pg_catalog.pg_namespace ns\n"
4856 " ON ns.oid = ts.typnamespace\n"
4857 " LEFT JOIN pg_catalog.pg_type tt\n"
4858 " ON c.casttarget = tt.oid\n"
4859 " LEFT JOIN pg_catalog.pg_namespace nt\n"
4860 " ON nt.oid = tt.typnamespace\n");
4861
4862 if (verbose)
4863 appendPQExpBufferStr(&buf,
4864 " LEFT JOIN pg_catalog.pg_description d\n"
4865 " ON d.classoid = c.tableoid AND d.objoid = "
4866 "c.oid AND d.objsubid = 0\n");
4867
4868 appendPQExpBufferStr(&buf, "WHERE ( (true");
4869
4870 /*
4871 * Match name pattern against either internal or external name of either
4872 * castsource or casttarget
4873 */
4874 if (!validateSQLNamePattern(&buf, pattern, true, false,
4875 "ns.nspname", "ts.typname",
4876 "pg_catalog.format_type(ts.oid, NULL)",
4877 "pg_catalog.pg_type_is_visible(ts.oid)",
4878 NULL, 3))
4879 goto error_return;
4880
4881 appendPQExpBufferStr(&buf, ") OR (true");
4882
4883 if (!validateSQLNamePattern(&buf, pattern, true, false,
4884 "nt.nspname", "tt.typname",
4885 "pg_catalog.format_type(tt.oid, NULL)",
4886 "pg_catalog.pg_type_is_visible(tt.oid)",
4887 NULL, 3))
4888 goto error_return;
4889
4890 appendPQExpBufferStr(&buf, ") )\nORDER BY 1, 2;");
4891
4892 res = PSQLexec(buf.data);
4893 termPQExpBuffer(&buf);
4894 if (!res)
4895 return false;
4896
4897 myopt.nullPrint = NULL;
4898 myopt.title = _("List of casts");
4899 myopt.translate_header = true;
4900 myopt.translate_columns = translate_columns;
4901 myopt.n_translate_columns = lengthof(translate_columns);
4902
4903 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
4904
4905 PQclear(res);
4906 return true;
4907
4908 error_return:
4909 termPQExpBuffer(&buf);
4910 return false;
4911 }
4912
4913 /*
4914 * \dO
4915 *
4916 * Describes collations.
4917 */
4918 bool
4919 listCollations(const char *pattern, bool verbose, bool showSystem)
4920 {
4921 PQExpBufferData buf;
4922 PGresult *res;
4923 printQueryOpt myopt = pset.popt;
4924 static const bool translate_columns[] = {false, false, false, false, false, false, false, true, false};
4925
4926 initPQExpBuffer(&buf);
4927
4928 printfPQExpBuffer(&buf,
4929 "SELECT\n"
4930 " n.nspname AS \"%s\",\n"
4931 " c.collname AS \"%s\",\n",
4932 gettext_noop("Schema"),
4933 gettext_noop("Name"));
4934
4935 if (pset.sversion >= 100000)
4936 appendPQExpBuffer(&buf,
4937 " CASE c.collprovider WHEN 'd' THEN 'default' WHEN 'c' THEN 'libc' WHEN 'i' THEN 'icu' END AS \"%s\",\n",
4938 gettext_noop("Provider"));
4939 else
4940 appendPQExpBuffer(&buf,
4941 " 'libc' AS \"%s\",\n",
4942 gettext_noop("Provider"));
4943
4944 appendPQExpBuffer(&buf,
4945 " c.collcollate AS \"%s\",\n"
4946 " c.collctype AS \"%s\",\n",
4947 gettext_noop("Collate"),
4948 gettext_noop("Ctype"));
4949
4950 if (pset.sversion >= 150000)
4951 appendPQExpBuffer(&buf,
4952 " c.colliculocale AS \"%s\",\n",
4953 gettext_noop("ICU Locale"));
4954 else
4955 appendPQExpBuffer(&buf,
4956 " c.collcollate AS \"%s\",\n",
4957 gettext_noop("ICU Locale"));
4958
4959 if (pset.sversion >= 160000)
4960 appendPQExpBuffer(&buf,
4961 " c.collicurules AS \"%s\",\n",
4962 gettext_noop("ICU Rules"));
4963 else
4964 appendPQExpBuffer(&buf,
4965 " NULL AS \"%s\",\n",
4966 gettext_noop("ICU Rules"));
4967
4968 if (pset.sversion >= 120000)
4969 appendPQExpBuffer(&buf,
4970 " CASE WHEN c.collisdeterministic THEN '%s' ELSE '%s' END AS \"%s\"",
4971 gettext_noop("yes"), gettext_noop("no"),
4972 gettext_noop("Deterministic?"));
4973 else
4974 appendPQExpBuffer(&buf,
4975 " '%s' AS \"%s\"",
4976 gettext_noop("yes"),
4977 gettext_noop("Deterministic?"));
4978
4979 if (verbose)
4980 appendPQExpBuffer(&buf,
4981 ",\n pg_catalog.obj_description(c.oid, 'pg_collation') AS \"%s\"",
4982 gettext_noop("Description"));
4983
4984 appendPQExpBufferStr(&buf,
4985 "\nFROM pg_catalog.pg_collation c, pg_catalog.pg_namespace n\n"
4986 "WHERE n.oid = c.collnamespace\n");
4987
4988 if (!showSystem && !pattern)
4989 appendPQExpBufferStr(&buf, " AND n.nspname <> 'pg_catalog'\n"
4990 " AND n.nspname <> 'information_schema'\n");
4991
4992 /*
4993 * Hide collations that aren't usable in the current database's encoding.
4994 * If you think to change this, note that pg_collation_is_visible rejects
4995 * unusable collations, so you will need to hack name pattern processing
4996 * somehow to avoid inconsistent behavior.
4997 */
4998 appendPQExpBufferStr(&buf, " AND c.collencoding IN (-1, pg_catalog.pg_char_to_encoding(pg_catalog.getdatabaseencoding()))\n");
4999
5000 if (!validateSQLNamePattern(&buf, pattern, true, false,
5001 "n.nspname", "c.collname", NULL,
5002 "pg_catalog.pg_collation_is_visible(c.oid)",
5003 NULL, 3))
5004 {
5005 termPQExpBuffer(&buf);
5006 return false;
5007 }
5008
5009 appendPQExpBufferStr(&buf, "ORDER BY 1, 2;");
5010
5011 res = PSQLexec(buf.data);
5012 termPQExpBuffer(&buf);
5013 if (!res)
5014 return false;
5015
5016 myopt.nullPrint = NULL;
5017 myopt.title = _("List of collations");
5018 myopt.translate_header = true;
5019 myopt.translate_columns = translate_columns;
5020 myopt.n_translate_columns = lengthof(translate_columns);
5021
5022 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
5023
5024 PQclear(res);
5025 return true;
5026 }
5027
5028 /*
5029 * \dn
5030 *
5031 * Describes schemas (namespaces)
5032 */
5033 bool
5034 listSchemas(const char *pattern, bool verbose, bool showSystem)
5035 {
5036 PQExpBufferData buf;
5037 PGresult *res;
5038 printQueryOpt myopt = pset.popt;
5039 int pub_schema_tuples = 0;
5040 char **footers = NULL;
5041
5042 initPQExpBuffer(&buf);
5043 printfPQExpBuffer(&buf,
5044 "SELECT n.nspname AS \"%s\",\n"
5045 " pg_catalog.pg_get_userbyid(n.nspowner) AS \"%s\"",
5046 gettext_noop("Name"),
5047 gettext_noop("Owner"));
5048
5049 if (verbose)
5050 {
5051 appendPQExpBufferStr(&buf, ",\n ");
5052 printACLColumn(&buf, "n.nspacl");
5053 appendPQExpBuffer(&buf,
5054 ",\n pg_catalog.obj_description(n.oid, 'pg_namespace') AS \"%s\"",
5055 gettext_noop("Description"));
5056 }
5057
5058 appendPQExpBufferStr(&buf,
5059 "\nFROM pg_catalog.pg_namespace n\n");
5060
5061 if (!showSystem && !pattern)
5062 appendPQExpBufferStr(&buf,
5063 "WHERE n.nspname !~ '^pg_' AND n.nspname <> 'information_schema'\n");
5064
5065 if (!validateSQLNamePattern(&buf, pattern,
5066 !showSystem && !pattern, false,
5067 NULL, "n.nspname", NULL,
5068 NULL,
5069 NULL, 2))
5070 goto error_return;
5071
5072 appendPQExpBufferStr(&buf, "ORDER BY 1;");
5073
5074 res = PSQLexec(buf.data);
5075 if (!res)
5076 goto error_return;
5077
5078 myopt.nullPrint = NULL;
5079 myopt.title = _("List of schemas");
5080 myopt.translate_header = true;
5081
5082 if (pattern && pset.sversion >= 150000)
5083 {
5084 PGresult *result;
5085 int i;
5086
5087 printfPQExpBuffer(&buf,
5088 "SELECT pubname \n"
5089 "FROM pg_catalog.pg_publication p\n"
5090 " JOIN pg_catalog.pg_publication_namespace pn ON p.oid = pn.pnpubid\n"
5091 " JOIN pg_catalog.pg_namespace n ON n.oid = pn.pnnspid \n"
5092 "WHERE n.nspname = '%s'\n"
5093 "ORDER BY 1",
5094 pattern);
5095 result = PSQLexec(buf.data);
5096 if (!result)
5097 goto error_return;
5098 else
5099 pub_schema_tuples = PQntuples(result);
5100
5101 if (pub_schema_tuples > 0)
5102 {
5103 /*
5104 * Allocate memory for footers. Size of footers will be 1 (for
5105 * storing "Publications:" string) + publication schema mapping
5106 * count + 1 (for storing NULL).
5107 */
5108 footers = (char **) pg_malloc((1 + pub_schema_tuples + 1) * sizeof(char *));
5109 footers[0] = pg_strdup(_("Publications:"));
5110
5111 /* Might be an empty set - that's ok */
5112 for (i = 0; i < pub_schema_tuples; i++)
5113 {
5114 printfPQExpBuffer(&buf, " \"%s\"",
5115 PQgetvalue(result, i, 0));
5116
5117 footers[i + 1] = pg_strdup(buf.data);
5118 }
5119
5120 footers[i + 1] = NULL;
5121 myopt.footers = footers;
5122 }
5123
5124 PQclear(result);
5125 }
5126
5127 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
5128
5129 termPQExpBuffer(&buf);
5130 PQclear(res);
5131
5132 /* Free the memory allocated for the footer */
5133 if (footers)
5134 {
5135 char **footer = NULL;
5136
5137 for (footer = footers; *footer; footer++)
5138 pg_free(*footer);
5139
5140 pg_free(footers);
5141 }
5142
5143 return true;
5144
5145 error_return:
5146 termPQExpBuffer(&buf);
5147 return false;
5148 }
5149
5150
5151 /*
5152 * \dFp
5153 * list text search parsers
5154 */
5155 bool
5156 listTSParsers(const char *pattern, bool verbose)
5157 {
5158 PQExpBufferData buf;
5159 PGresult *res;
5160 printQueryOpt myopt = pset.popt;
5161
5162 if (verbose)
5163 return listTSParsersVerbose(pattern);
5164
5165 initPQExpBuffer(&buf);
5166
5167 printfPQExpBuffer(&buf,
5168 "SELECT\n"
5169 " n.nspname as \"%s\",\n"
5170 " p.prsname as \"%s\",\n"
5171 " pg_catalog.obj_description(p.oid, 'pg_ts_parser') as \"%s\"\n"
5172 "FROM pg_catalog.pg_ts_parser p\n"
5173 "LEFT JOIN pg_catalog.pg_namespace n ON n.oid = p.prsnamespace\n",
5174 gettext_noop("Schema"),
5175 gettext_noop("Name"),
5176 gettext_noop("Description")
5177 );
5178
5179 if (!validateSQLNamePattern(&buf, pattern, false, false,
5180 "n.nspname", "p.prsname", NULL,
5181 "pg_catalog.pg_ts_parser_is_visible(p.oid)",
5182 NULL, 3))
5183 {
5184 termPQExpBuffer(&buf);
5185 return false;
5186 }
5187
5188 appendPQExpBufferStr(&buf, "ORDER BY 1, 2;");
5189
5190 res = PSQLexec(buf.data);
5191 termPQExpBuffer(&buf);
5192 if (!res)
5193 return false;
5194
5195 myopt.nullPrint = NULL;
5196 myopt.title = _("List of text search parsers");
5197 myopt.translate_header = true;
5198
5199 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
5200
5201 PQclear(res);
5202 return true;
5203 }
5204
5205 /*
5206 * full description of parsers
5207 */
5208 static bool
5209 listTSParsersVerbose(const char *pattern)
5210 {
5211 PQExpBufferData buf;
5212 PGresult *res;
5213 int i;
5214
5215 initPQExpBuffer(&buf);
5216
5217 printfPQExpBuffer(&buf,
5218 "SELECT p.oid,\n"
5219 " n.nspname,\n"
5220 " p.prsname\n"
5221 "FROM pg_catalog.pg_ts_parser p\n"
5222 "LEFT JOIN pg_catalog.pg_namespace n ON n.oid = p.prsnamespace\n"
5223 );
5224
5225 if (!validateSQLNamePattern(&buf, pattern, false, false,
5226 "n.nspname", "p.prsname", NULL,
5227 "pg_catalog.pg_ts_parser_is_visible(p.oid)",
5228 NULL, 3))
5229 {
5230 termPQExpBuffer(&buf);
5231 return false;
5232 }
5233
5234 appendPQExpBufferStr(&buf, "ORDER BY 1, 2;");
5235
5236 res = PSQLexec(buf.data);
5237 termPQExpBuffer(&buf);
5238 if (!res)
5239 return false;
5240
5241 if (PQntuples(res) == 0)
5242 {
5243 if (!pset.quiet)
5244 {
5245 if (pattern)
5246 pg_log_error("Did not find any text search parser named \"%s\".",
5247 pattern);
5248 else
5249 pg_log_error("Did not find any text search parsers.");
5250 }
5251 PQclear(res);
5252 return false;
5253 }
5254
5255 for (i = 0; i < PQntuples(res); i++)
5256 {
5257 const char *oid;
5258 const char *nspname = NULL;
5259 const char *prsname;
5260
5261 oid = PQgetvalue(res, i, 0);
5262 if (!PQgetisnull(res, i, 1))
5263 nspname = PQgetvalue(res, i, 1);
5264 prsname = PQgetvalue(res, i, 2);
5265
5266 if (!describeOneTSParser(oid, nspname, prsname))
5267 {
5268 PQclear(res);
5269 return false;
5270 }
5271
5272 if (cancel_pressed)
5273 {
5274 PQclear(res);
5275 return false;
5276 }
5277 }
5278
5279 PQclear(res);
5280 return true;
5281 }
5282
5283 static bool
5284 describeOneTSParser(const char *oid, const char *nspname, const char *prsname)
5285 {
5286 PQExpBufferData buf;
5287 PGresult *res;
5288 PQExpBufferData title;
5289 printQueryOpt myopt = pset.popt;
5290 static const bool translate_columns[] = {true, false, false};
5291
5292 initPQExpBuffer(&buf);
5293
5294 printfPQExpBuffer(&buf,
5295 "SELECT '%s' AS \"%s\",\n"
5296 " p.prsstart::pg_catalog.regproc AS \"%s\",\n"
5297 " pg_catalog.obj_description(p.prsstart, 'pg_proc') as \"%s\"\n"
5298 " FROM pg_catalog.pg_ts_parser p\n"
5299 " WHERE p.oid = '%s'\n"
5300 "UNION ALL\n"
5301 "SELECT '%s',\n"
5302 " p.prstoken::pg_catalog.regproc,\n"
5303 " pg_catalog.obj_description(p.prstoken, 'pg_proc')\n"
5304 " FROM pg_catalog.pg_ts_parser p\n"
5305 " WHERE p.oid = '%s'\n"
5306 "UNION ALL\n"
5307 "SELECT '%s',\n"
5308 " p.prsend::pg_catalog.regproc,\n"
5309 " pg_catalog.obj_description(p.prsend, 'pg_proc')\n"
5310 " FROM pg_catalog.pg_ts_parser p\n"
5311 " WHERE p.oid = '%s'\n"
5312 "UNION ALL\n"
5313 "SELECT '%s',\n"
5314 " p.prsheadline::pg_catalog.regproc,\n"
5315 " pg_catalog.obj_description(p.prsheadline, 'pg_proc')\n"
5316 " FROM pg_catalog.pg_ts_parser p\n"
5317 " WHERE p.oid = '%s'\n"
5318 "UNION ALL\n"
5319 "SELECT '%s',\n"
5320 " p.prslextype::pg_catalog.regproc,\n"
5321 " pg_catalog.obj_description(p.prslextype, 'pg_proc')\n"
5322 " FROM pg_catalog.pg_ts_parser p\n"
5323 " WHERE p.oid = '%s';",
5324 gettext_noop("Start parse"),
5325 gettext_noop("Method"),
5326 gettext_noop("Function"),
5327 gettext_noop("Description"),
5328 oid,
5329 gettext_noop("Get next token"),
5330 oid,
5331 gettext_noop("End parse"),
5332 oid,
5333 gettext_noop("Get headline"),
5334 oid,
5335 gettext_noop("Get token types"),
5336 oid);
5337
5338 res = PSQLexec(buf.data);
5339 termPQExpBuffer(&buf);
5340 if (!res)
5341 return false;
5342
5343 myopt.nullPrint = NULL;
5344 initPQExpBuffer(&title);
5345 if (nspname)
5346 printfPQExpBuffer(&title, _("Text search parser \"%s.%s\""),
5347 nspname, prsname);
5348 else
5349 printfPQExpBuffer(&title, _("Text search parser \"%s\""), prsname);
5350 myopt.title = title.data;
5351 myopt.footers = NULL;
5352 myopt.topt.default_footer = false;
5353 myopt.translate_header = true;
5354 myopt.translate_columns = translate_columns;
5355 myopt.n_translate_columns = lengthof(translate_columns);
5356
5357 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
5358
5359 PQclear(res);
5360
5361 initPQExpBuffer(&buf);
5362
5363 printfPQExpBuffer(&buf,
5364 "SELECT t.alias as \"%s\",\n"
5365 " t.description as \"%s\"\n"
5366 "FROM pg_catalog.ts_token_type( '%s'::pg_catalog.oid ) as t\n"
5367 "ORDER BY 1;",
5368 gettext_noop("Token name"),
5369 gettext_noop("Description"),
5370 oid);
5371
5372 res = PSQLexec(buf.data);
5373 termPQExpBuffer(&buf);
5374 if (!res)
5375 {
5376 termPQExpBuffer(&title);
5377 return false;
5378 }
5379
5380 myopt.nullPrint = NULL;
5381 if (nspname)
5382 printfPQExpBuffer(&title, _("Token types for parser \"%s.%s\""),
5383 nspname, prsname);
5384 else
5385 printfPQExpBuffer(&title, _("Token types for parser \"%s\""), prsname);
5386 myopt.title = title.data;
5387 myopt.footers = NULL;
5388 myopt.topt.default_footer = true;
5389 myopt.translate_header = true;
5390 myopt.translate_columns = NULL;
5391 myopt.n_translate_columns = 0;
5392
5393 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
5394
5395 termPQExpBuffer(&title);
5396 PQclear(res);
5397 return true;
5398 }
5399
5400
5401 /*
5402 * \dFd
5403 * list text search dictionaries
5404 */
5405 bool
5406 listTSDictionaries(const char *pattern, bool verbose)
5407 {
5408 PQExpBufferData buf;
5409 PGresult *res;
5410 printQueryOpt myopt = pset.popt;
5411
5412 initPQExpBuffer(&buf);
5413
5414 printfPQExpBuffer(&buf,
5415 "SELECT\n"
5416 " n.nspname as \"%s\",\n"
5417 " d.dictname as \"%s\",\n",
5418 gettext_noop("Schema"),
5419 gettext_noop("Name"));
5420
5421 if (verbose)
5422 {
5423 appendPQExpBuffer(&buf,
5424 " ( SELECT COALESCE(nt.nspname, '(null)')::pg_catalog.text || '.' || t.tmplname FROM\n"
5425 " pg_catalog.pg_ts_template t\n"
5426 " LEFT JOIN pg_catalog.pg_namespace nt ON nt.oid = t.tmplnamespace\n"
5427 " WHERE d.dicttemplate = t.oid ) AS \"%s\",\n"
5428 " d.dictinitoption as \"%s\",\n",
5429 gettext_noop("Template"),
5430 gettext_noop("Init options"));
5431 }
5432
5433 appendPQExpBuffer(&buf,
5434 " pg_catalog.obj_description(d.oid, 'pg_ts_dict') as \"%s\"\n",
5435 gettext_noop("Description"));
5436
5437 appendPQExpBufferStr(&buf, "FROM pg_catalog.pg_ts_dict d\n"
5438 "LEFT JOIN pg_catalog.pg_namespace n ON n.oid = d.dictnamespace\n");
5439
5440 if (!validateSQLNamePattern(&buf, pattern, false, false,
5441 "n.nspname", "d.dictname", NULL,
5442 "pg_catalog.pg_ts_dict_is_visible(d.oid)",
5443 NULL, 3))
5444 {
5445 termPQExpBuffer(&buf);
5446 return false;
5447 }
5448
5449 appendPQExpBufferStr(&buf, "ORDER BY 1, 2;");
5450
5451 res = PSQLexec(buf.data);
5452 termPQExpBuffer(&buf);
5453 if (!res)
5454 return false;
5455
5456 myopt.nullPrint = NULL;
5457 myopt.title = _("List of text search dictionaries");
5458 myopt.translate_header = true;
5459
5460 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
5461
5462 PQclear(res);
5463 return true;
5464 }
5465
5466
5467 /*
5468 * \dFt
5469 * list text search templates
5470 */
5471 bool
5472 listTSTemplates(const char *pattern, bool verbose)
5473 {
5474 PQExpBufferData buf;
5475 PGresult *res;
5476 printQueryOpt myopt = pset.popt;
5477
5478 initPQExpBuffer(&buf);
5479
5480 if (verbose)
5481 printfPQExpBuffer(&buf,
5482 "SELECT\n"
5483 " n.nspname AS \"%s\",\n"
5484 " t.tmplname AS \"%s\",\n"
5485 " t.tmplinit::pg_catalog.regproc AS \"%s\",\n"
5486 " t.tmpllexize::pg_catalog.regproc AS \"%s\",\n"
5487 " pg_catalog.obj_description(t.oid, 'pg_ts_template') AS \"%s\"\n",
5488 gettext_noop("Schema"),
5489 gettext_noop("Name"),
5490 gettext_noop("Init"),
5491 gettext_noop("Lexize"),
5492 gettext_noop("Description"));
5493 else
5494 printfPQExpBuffer(&buf,
5495 "SELECT\n"
5496 " n.nspname AS \"%s\",\n"
5497 " t.tmplname AS \"%s\",\n"
5498 " pg_catalog.obj_description(t.oid, 'pg_ts_template') AS \"%s\"\n",
5499 gettext_noop("Schema"),
5500 gettext_noop("Name"),
5501 gettext_noop("Description"));
5502
5503 appendPQExpBufferStr(&buf, "FROM pg_catalog.pg_ts_template t\n"
5504 "LEFT JOIN pg_catalog.pg_namespace n ON n.oid = t.tmplnamespace\n");
5505
5506 if (!validateSQLNamePattern(&buf, pattern, false, false,
5507 "n.nspname", "t.tmplname", NULL,
5508 "pg_catalog.pg_ts_template_is_visible(t.oid)",
5509 NULL, 3))
5510 {
5511 termPQExpBuffer(&buf);
5512 return false;
5513 }
5514
5515 appendPQExpBufferStr(&buf, "ORDER BY 1, 2;");
5516
5517 res = PSQLexec(buf.data);
5518 termPQExpBuffer(&buf);
5519 if (!res)
5520 return false;
5521
5522 myopt.nullPrint = NULL;
5523 myopt.title = _("List of text search templates");
5524 myopt.translate_header = true;
5525
5526 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
5527
5528 PQclear(res);
5529 return true;
5530 }
5531
5532
5533 /*
5534 * \dF
5535 * list text search configurations
5536 */
5537 bool
5538 listTSConfigs(const char *pattern, bool verbose)
5539 {
5540 PQExpBufferData buf;
5541 PGresult *res;
5542 printQueryOpt myopt = pset.popt;
5543
5544 if (verbose)
5545 return listTSConfigsVerbose(pattern);
5546
5547 initPQExpBuffer(&buf);
5548
5549 printfPQExpBuffer(&buf,
5550 "SELECT\n"
5551 " n.nspname as \"%s\",\n"
5552 " c.cfgname as \"%s\",\n"
5553 " pg_catalog.obj_description(c.oid, 'pg_ts_config') as \"%s\"\n"
5554 "FROM pg_catalog.pg_ts_config c\n"
5555 "LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.cfgnamespace\n",
5556 gettext_noop("Schema"),
5557 gettext_noop("Name"),
5558 gettext_noop("Description")
5559 );
5560
5561 if (!validateSQLNamePattern(&buf, pattern, false, false,
5562 "n.nspname", "c.cfgname", NULL,
5563 "pg_catalog.pg_ts_config_is_visible(c.oid)",
5564 NULL, 3))
5565 {
5566 termPQExpBuffer(&buf);
5567 return false;
5568 }
5569
5570 appendPQExpBufferStr(&buf, "ORDER BY 1, 2;");
5571
5572 res = PSQLexec(buf.data);
5573 termPQExpBuffer(&buf);
5574 if (!res)
5575 return false;
5576
5577 myopt.nullPrint = NULL;
5578 myopt.title = _("List of text search configurations");
5579 myopt.translate_header = true;
5580
5581 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
5582
5583 PQclear(res);
5584 return true;
5585 }
5586
5587 static bool
5588 listTSConfigsVerbose(const char *pattern)
5589 {
5590 PQExpBufferData buf;
5591 PGresult *res;
5592 int i;
5593
5594 initPQExpBuffer(&buf);
5595
5596 printfPQExpBuffer(&buf,
5597 "SELECT c.oid, c.cfgname,\n"
5598 " n.nspname,\n"
5599 " p.prsname,\n"
5600 " np.nspname as pnspname\n"
5601 "FROM pg_catalog.pg_ts_config c\n"
5602 " LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.cfgnamespace,\n"
5603 " pg_catalog.pg_ts_parser p\n"
5604 " LEFT JOIN pg_catalog.pg_namespace np ON np.oid = p.prsnamespace\n"
5605 "WHERE p.oid = c.cfgparser\n"
5606 );
5607
5608 if (!validateSQLNamePattern(&buf, pattern, true, false,
5609 "n.nspname", "c.cfgname", NULL,
5610 "pg_catalog.pg_ts_config_is_visible(c.oid)",
5611 NULL, 3))
5612 {
5613 termPQExpBuffer(&buf);
5614 return false;
5615 }
5616
5617 appendPQExpBufferStr(&buf, "ORDER BY 3, 2;");
5618
5619 res = PSQLexec(buf.data);
5620 termPQExpBuffer(&buf);
5621 if (!res)
5622 return false;
5623
5624 if (PQntuples(res) == 0)
5625 {
5626 if (!pset.quiet)
5627 {
5628 if (pattern)
5629 pg_log_error("Did not find any text search configuration named \"%s\".",
5630 pattern);
5631 else
5632 pg_log_error("Did not find any text search configurations.");
5633 }
5634 PQclear(res);
5635 return false;
5636 }
5637
5638 for (i = 0; i < PQntuples(res); i++)
5639 {
5640 const char *oid;
5641 const char *cfgname;
5642 const char *nspname = NULL;
5643 const char *prsname;
5644 const char *pnspname = NULL;
5645
5646 oid = PQgetvalue(res, i, 0);
5647 cfgname = PQgetvalue(res, i, 1);
5648 if (!PQgetisnull(res, i, 2))
5649 nspname = PQgetvalue(res, i, 2);
5650 prsname = PQgetvalue(res, i, 3);
5651 if (!PQgetisnull(res, i, 4))
5652 pnspname = PQgetvalue(res, i, 4);
5653
5654 if (!describeOneTSConfig(oid, nspname, cfgname, pnspname, prsname))
5655 {
5656 PQclear(res);
5657 return false;
5658 }
5659
5660 if (cancel_pressed)
5661 {
5662 PQclear(res);
5663 return false;
5664 }
5665 }
5666
5667 PQclear(res);
5668 return true;
5669 }
5670
5671 static bool
5672 describeOneTSConfig(const char *oid, const char *nspname, const char *cfgname,
5673 const char *pnspname, const char *prsname)
5674 {
5675 PQExpBufferData buf,
5676 title;
5677 PGresult *res;
5678 printQueryOpt myopt = pset.popt;
5679
5680 initPQExpBuffer(&buf);
5681
5682 printfPQExpBuffer(&buf,
5683 "SELECT\n"
5684 " ( SELECT t.alias FROM\n"
5685 " pg_catalog.ts_token_type(c.cfgparser) AS t\n"
5686 " WHERE t.tokid = m.maptokentype ) AS \"%s\",\n"
5687 " pg_catalog.btrim(\n"
5688 " ARRAY( SELECT mm.mapdict::pg_catalog.regdictionary\n"
5689 " FROM pg_catalog.pg_ts_config_map AS mm\n"
5690 " WHERE mm.mapcfg = m.mapcfg AND mm.maptokentype = m.maptokentype\n"
5691 " ORDER BY mapcfg, maptokentype, mapseqno\n"
5692 " ) :: pg_catalog.text,\n"
5693 " '{}') AS \"%s\"\n"
5694 "FROM pg_catalog.pg_ts_config AS c, pg_catalog.pg_ts_config_map AS m\n"
5695 "WHERE c.oid = '%s' AND m.mapcfg = c.oid\n"
5696 "GROUP BY m.mapcfg, m.maptokentype, c.cfgparser\n"
5697 "ORDER BY 1;",
5698 gettext_noop("Token"),
5699 gettext_noop("Dictionaries"),
5700 oid);
5701
5702 res = PSQLexec(buf.data);
5703 termPQExpBuffer(&buf);
5704 if (!res)
5705 return false;
5706
5707 initPQExpBuffer(&title);
5708
5709 if (nspname)
5710 appendPQExpBuffer(&title, _("Text search configuration \"%s.%s\""),
5711 nspname, cfgname);
5712 else
5713 appendPQExpBuffer(&title, _("Text search configuration \"%s\""),
5714 cfgname);
5715
5716 if (pnspname)
5717 appendPQExpBuffer(&title, _("\nParser: \"%s.%s\""),
5718 pnspname, prsname);
5719 else
5720 appendPQExpBuffer(&title, _("\nParser: \"%s\""),
5721 prsname);
5722
5723 myopt.nullPrint = NULL;
5724 myopt.title = title.data;
5725 myopt.footers = NULL;
5726 myopt.topt.default_footer = false;
5727 myopt.translate_header = true;
5728
5729 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
5730
5731 termPQExpBuffer(&title);
5732
5733 PQclear(res);
5734 return true;
5735 }
5736
5737
5738 /*
5739 * \dew
5740 *
5741 * Describes foreign-data wrappers
5742 */
5743 bool
5744 listForeignDataWrappers(const char *pattern, bool verbose)
5745 {
5746 PQExpBufferData buf;
5747 PGresult *res;
5748 printQueryOpt myopt = pset.popt;
5749
5750 initPQExpBuffer(&buf);
5751 printfPQExpBuffer(&buf,
5752 "SELECT fdw.fdwname AS \"%s\",\n"
5753 " pg_catalog.pg_get_userbyid(fdw.fdwowner) AS \"%s\",\n"
5754 " fdw.fdwhandler::pg_catalog.regproc AS \"%s\",\n"
5755 " fdw.fdwvalidator::pg_catalog.regproc AS \"%s\"",
5756 gettext_noop("Name"),
5757 gettext_noop("Owner"),
5758 gettext_noop("Handler"),
5759 gettext_noop("Validator"));
5760
5761 if (verbose)
5762 {
5763 appendPQExpBufferStr(&buf, ",\n ");
5764 printACLColumn(&buf, "fdwacl");
5765 appendPQExpBuffer(&buf,
5766 ",\n CASE WHEN fdwoptions IS NULL THEN '' ELSE "
5767 " '(' || pg_catalog.array_to_string(ARRAY(SELECT "
5768 " pg_catalog.quote_ident(option_name) || ' ' || "
5769 " pg_catalog.quote_literal(option_value) FROM "
5770 " pg_catalog.pg_options_to_table(fdwoptions)), ', ') || ')' "
5771 " END AS \"%s\""
5772 ",\n d.description AS \"%s\" ",
5773 gettext_noop("FDW options"),
5774 gettext_noop("Description"));
5775 }
5776
5777 appendPQExpBufferStr(&buf, "\nFROM pg_catalog.pg_foreign_data_wrapper fdw\n");
5778
5779 if (verbose)
5780 appendPQExpBufferStr(&buf,
5781 "LEFT JOIN pg_catalog.pg_description d\n"
5782 " ON d.classoid = fdw.tableoid "
5783 "AND d.objoid = fdw.oid AND d.objsubid = 0\n");
5784
5785 if (!validateSQLNamePattern(&buf, pattern, false, false,
5786 NULL, "fdwname", NULL, NULL,
5787 NULL, 1))
5788 {
5789 termPQExpBuffer(&buf);
5790 return false;
5791 }
5792
5793 appendPQExpBufferStr(&buf, "ORDER BY 1;");
5794
5795 res = PSQLexec(buf.data);
5796 termPQExpBuffer(&buf);
5797 if (!res)
5798 return false;
5799
5800 myopt.nullPrint = NULL;
5801 myopt.title = _("List of foreign-data wrappers");
5802 myopt.translate_header = true;
5803
5804 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
5805
5806 PQclear(res);
5807 return true;
5808 }
5809
5810 /*
5811 * \des
5812 *
5813 * Describes foreign servers.
5814 */
5815 bool
5816 listForeignServers(const char *pattern, bool verbose)
5817 {
5818 PQExpBufferData buf;
5819 PGresult *res;
5820 printQueryOpt myopt = pset.popt;
5821
5822 initPQExpBuffer(&buf);
5823 printfPQExpBuffer(&buf,
5824 "SELECT s.srvname AS \"%s\",\n"
5825 " pg_catalog.pg_get_userbyid(s.srvowner) AS \"%s\",\n"
5826 " f.fdwname AS \"%s\"",
5827 gettext_noop("Name"),
5828 gettext_noop("Owner"),
5829 gettext_noop("Foreign-data wrapper"));
5830
5831 if (verbose)
5832 {
5833 appendPQExpBufferStr(&buf, ",\n ");
5834 printACLColumn(&buf, "s.srvacl");
5835 appendPQExpBuffer(&buf,
5836 ",\n"
5837 " s.srvtype AS \"%s\",\n"
5838 " s.srvversion AS \"%s\",\n"
5839 " CASE WHEN srvoptions IS NULL THEN '' ELSE "
5840 " '(' || pg_catalog.array_to_string(ARRAY(SELECT "
5841 " pg_catalog.quote_ident(option_name) || ' ' || "
5842 " pg_catalog.quote_literal(option_value) FROM "
5843 " pg_catalog.pg_options_to_table(srvoptions)), ', ') || ')' "
5844 " END AS \"%s\",\n"
5845 " d.description AS \"%s\"",
5846 gettext_noop("Type"),
5847 gettext_noop("Version"),
5848 gettext_noop("FDW options"),
5849 gettext_noop("Description"));
5850 }
5851
5852 appendPQExpBufferStr(&buf,
5853 "\nFROM pg_catalog.pg_foreign_server s\n"
5854 " JOIN pg_catalog.pg_foreign_data_wrapper f ON f.oid=s.srvfdw\n");
5855
5856 if (verbose)
5857 appendPQExpBufferStr(&buf,
5858 "LEFT JOIN pg_catalog.pg_description d\n "
5859 "ON d.classoid = s.tableoid AND d.objoid = s.oid "
5860 "AND d.objsubid = 0\n");
5861
5862 if (!validateSQLNamePattern(&buf, pattern, false, false,
5863 NULL, "s.srvname", NULL, NULL,
5864 NULL, 1))
5865 {
5866 termPQExpBuffer(&buf);
5867 return false;
5868 }
5869
5870 appendPQExpBufferStr(&buf, "ORDER BY 1;");
5871
5872 res = PSQLexec(buf.data);
5873 termPQExpBuffer(&buf);
5874 if (!res)
5875 return false;
5876
5877 myopt.nullPrint = NULL;
5878 myopt.title = _("List of foreign servers");
5879 myopt.translate_header = true;
5880
5881 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
5882
5883 PQclear(res);
5884 return true;
5885 }
5886
5887 /*
5888 * \deu
5889 *
5890 * Describes user mappings.
5891 */
5892 bool
5893 listUserMappings(const char *pattern, bool verbose)
5894 {
5895 PQExpBufferData buf;
5896 PGresult *res;
5897 printQueryOpt myopt = pset.popt;
5898
5899 initPQExpBuffer(&buf);
5900 printfPQExpBuffer(&buf,
5901 "SELECT um.srvname AS \"%s\",\n"
5902 " um.usename AS \"%s\"",
5903 gettext_noop("Server"),
5904 gettext_noop("User name"));
5905
5906 if (verbose)
5907 appendPQExpBuffer(&buf,
5908 ",\n CASE WHEN umoptions IS NULL THEN '' ELSE "
5909 " '(' || pg_catalog.array_to_string(ARRAY(SELECT "
5910 " pg_catalog.quote_ident(option_name) || ' ' || "
5911 " pg_catalog.quote_literal(option_value) FROM "
5912 " pg_catalog.pg_options_to_table(umoptions)), ', ') || ')' "
5913 " END AS \"%s\"",
5914 gettext_noop("FDW options"));
5915
5916 appendPQExpBufferStr(&buf, "\nFROM pg_catalog.pg_user_mappings um\n");
5917
5918 if (!validateSQLNamePattern(&buf, pattern, false, false,
5919 NULL, "um.srvname", "um.usename", NULL,
5920 NULL, 1))
5921 {
5922 termPQExpBuffer(&buf);
5923 return false;
5924 }
5925
5926 appendPQExpBufferStr(&buf, "ORDER BY 1, 2;");
5927
5928 res = PSQLexec(buf.data);
5929 termPQExpBuffer(&buf);
5930 if (!res)
5931 return false;
5932
5933 myopt.nullPrint = NULL;
5934 myopt.title = _("List of user mappings");
5935 myopt.translate_header = true;
5936
5937 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
5938
5939 PQclear(res);
5940 return true;
5941 }
5942
5943 /*
5944 * \det
5945 *
5946 * Describes foreign tables.
5947 */
5948 bool
5949 listForeignTables(const char *pattern, bool verbose)
5950 {
5951 PQExpBufferData buf;
5952 PGresult *res;
5953 printQueryOpt myopt = pset.popt;
5954
5955 initPQExpBuffer(&buf);
5956 printfPQExpBuffer(&buf,
5957 "SELECT n.nspname AS \"%s\",\n"
5958 " c.relname AS \"%s\",\n"
5959 " s.srvname AS \"%s\"",
5960 gettext_noop("Schema"),
5961 gettext_noop("Table"),
5962 gettext_noop("Server"));
5963
5964 if (verbose)
5965 appendPQExpBuffer(&buf,
5966 ",\n CASE WHEN ftoptions IS NULL THEN '' ELSE "
5967 " '(' || pg_catalog.array_to_string(ARRAY(SELECT "
5968 " pg_catalog.quote_ident(option_name) || ' ' || "
5969 " pg_catalog.quote_literal(option_value) FROM "
5970 " pg_catalog.pg_options_to_table(ftoptions)), ', ') || ')' "
5971 " END AS \"%s\",\n"
5972 " d.description AS \"%s\"",
5973 gettext_noop("FDW options"),
5974 gettext_noop("Description"));
5975
5976 appendPQExpBufferStr(&buf,
5977 "\nFROM pg_catalog.pg_foreign_table ft\n"
5978 " INNER JOIN pg_catalog.pg_class c"
5979 " ON c.oid = ft.ftrelid\n"
5980 " INNER JOIN pg_catalog.pg_namespace n"
5981 " ON n.oid = c.relnamespace\n"
5982 " INNER JOIN pg_catalog.pg_foreign_server s"
5983 " ON s.oid = ft.ftserver\n");
5984 if (verbose)
5985 appendPQExpBufferStr(&buf,
5986 " LEFT JOIN pg_catalog.pg_description d\n"
5987 " ON d.classoid = c.tableoid AND "
5988 "d.objoid = c.oid AND d.objsubid = 0\n");
5989
5990 if (!validateSQLNamePattern(&buf, pattern, false, false,
5991 "n.nspname", "c.relname", NULL,
5992 "pg_catalog.pg_table_is_visible(c.oid)",
5993 NULL, 3))
5994 {
5995 termPQExpBuffer(&buf);
5996 return false;
5997 }
5998
5999 appendPQExpBufferStr(&buf, "ORDER BY 1, 2;");
6000
6001 res = PSQLexec(buf.data);
6002 termPQExpBuffer(&buf);
6003 if (!res)
6004 return false;
6005
6006 myopt.nullPrint = NULL;
6007 myopt.title = _("List of foreign tables");
6008 myopt.translate_header = true;
6009
6010 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
6011
6012 PQclear(res);
6013 return true;
6014 }
6015
6016 /*
6017 * \dx
6018 *
6019 * Briefly describes installed extensions.
6020 */
6021 bool
6022 listExtensions(const char *pattern)
6023 {
6024 PQExpBufferData buf;
6025 PGresult *res;
6026 printQueryOpt myopt = pset.popt;
6027
6028 initPQExpBuffer(&buf);
6029 printfPQExpBuffer(&buf,
6030 "SELECT e.extname AS \"%s\", "
6031 "e.extversion AS \"%s\", n.nspname AS \"%s\", c.description AS \"%s\"\n"
6032 "FROM pg_catalog.pg_extension e "
6033 "LEFT JOIN pg_catalog.pg_namespace n ON n.oid = e.extnamespace "
6034 "LEFT JOIN pg_catalog.pg_description c ON c.objoid = e.oid "
6035 "AND c.classoid = 'pg_catalog.pg_extension'::pg_catalog.regclass\n",
6036 gettext_noop("Name"),
6037 gettext_noop("Version"),
6038 gettext_noop("Schema"),
6039 gettext_noop("Description"));
6040
6041 if (!validateSQLNamePattern(&buf, pattern,
6042 false, false,
6043 NULL, "e.extname", NULL,
6044 NULL,
6045 NULL, 1))
6046 {
6047 termPQExpBuffer(&buf);
6048 return false;
6049 }
6050
6051 appendPQExpBufferStr(&buf, "ORDER BY 1;");
6052
6053 res = PSQLexec(buf.data);
6054 termPQExpBuffer(&buf);
6055 if (!res)
6056 return false;
6057
6058 myopt.nullPrint = NULL;
6059 myopt.title = _("List of installed extensions");
6060 myopt.translate_header = true;
6061
6062 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
6063
6064 PQclear(res);
6065 return true;
6066 }
6067
6068 /*
6069 * \dx+
6070 *
6071 * List contents of installed extensions.
6072 */
6073 bool
6074 listExtensionContents(const char *pattern)
6075 {
6076 PQExpBufferData buf;
6077 PGresult *res;
6078 int i;
6079
6080 initPQExpBuffer(&buf);
6081 printfPQExpBuffer(&buf,
6082 "SELECT e.extname, e.oid\n"
6083 "FROM pg_catalog.pg_extension e\n");
6084
6085 if (!validateSQLNamePattern(&buf, pattern,
6086 false, false,
6087 NULL, "e.extname", NULL,
6088 NULL,
6089 NULL, 1))
6090 {
6091 termPQExpBuffer(&buf);
6092 return false;
6093 }
6094
6095 appendPQExpBufferStr(&buf, "ORDER BY 1;");
6096
6097 res = PSQLexec(buf.data);
6098 termPQExpBuffer(&buf);
6099 if (!res)
6100 return false;
6101
6102 if (PQntuples(res) == 0)
6103 {
6104 if (!pset.quiet)
6105 {
6106 if (pattern)
6107 pg_log_error("Did not find any extension named \"%s\".",
6108 pattern);
6109 else
6110 pg_log_error("Did not find any extensions.");
6111 }
6112 PQclear(res);
6113 return false;
6114 }
6115
6116 for (i = 0; i < PQntuples(res); i++)
6117 {
6118 const char *extname;
6119 const char *oid;
6120
6121 extname = PQgetvalue(res, i, 0);
6122 oid = PQgetvalue(res, i, 1);
6123
6124 if (!listOneExtensionContents(extname, oid))
6125 {
6126 PQclear(res);
6127 return false;
6128 }
6129 if (cancel_pressed)
6130 {
6131 PQclear(res);
6132 return false;
6133 }
6134 }
6135
6136 PQclear(res);
6137 return true;
6138 }
6139
6140 static bool
6141 listOneExtensionContents(const char *extname, const char *oid)
6142 {
6143 PQExpBufferData buf;
6144 PGresult *res;
6145 PQExpBufferData title;
6146 printQueryOpt myopt = pset.popt;
6147
6148 initPQExpBuffer(&buf);
6149 printfPQExpBuffer(&buf,
6150 "SELECT pg_catalog.pg_describe_object(classid, objid, 0) AS \"%s\"\n"
6151 "FROM pg_catalog.pg_depend\n"
6152 "WHERE refclassid = 'pg_catalog.pg_extension'::pg_catalog.regclass AND refobjid = '%s' AND deptype = 'e'\n"
6153 "ORDER BY 1;",
6154 gettext_noop("Object description"),
6155 oid);
6156
6157 res = PSQLexec(buf.data);
6158 termPQExpBuffer(&buf);
6159 if (!res)
6160 return false;
6161
6162 myopt.nullPrint = NULL;
6163 initPQExpBuffer(&title);
6164 printfPQExpBuffer(&title, _("Objects in extension \"%s\""), extname);
6165 myopt.title = title.data;
6166 myopt.translate_header = true;
6167
6168 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
6169
6170 termPQExpBuffer(&title);
6171 PQclear(res);
6172 return true;
6173 }
6174
6175 /*
6176 * validateSQLNamePattern
6177 *
6178 * Wrapper around string_utils's processSQLNamePattern which also checks the
6179 * pattern's validity. In addition to that function's parameters, takes a
6180 * 'maxparts' parameter specifying the maximum number of dotted names the
6181 * pattern is allowed to have, and a 'added_clause' parameter that returns by
6182 * reference whether a clause was added to 'buf'. Returns whether the pattern
6183 * passed validation, after logging any errors.
6184 */
6185 static bool
6186 validateSQLNamePattern(PQExpBuffer buf, const char *pattern, bool have_where,
6187 bool force_escape, const char *schemavar,
6188 const char *namevar, const char *altnamevar,
6189 const char *visibilityrule, bool *added_clause,
6190 int maxparts)
6191 {
6192 PQExpBufferData dbbuf;
6193 int dotcnt;
6194 bool added;
6195
6196 initPQExpBuffer(&dbbuf);
6197 added = processSQLNamePattern(pset.db, buf, pattern, have_where, force_escape,
6198 schemavar, namevar, altnamevar,
6199 visibilityrule, &dbbuf, &dotcnt);
6200 if (added_clause != NULL)
6201 *added_clause = added;
6202
6203 if (dotcnt >= maxparts)
6204 {
6205 pg_log_error("improper qualified name (too many dotted names): %s",
6206 pattern);
6207 goto error_return;
6208 }
6209
6210 if (maxparts > 1 && dotcnt == maxparts - 1)
6211 {
6212 if (PQdb(pset.db) == NULL)
6213 {
6214 pg_log_error("You are currently not connected to a database.");
6215 goto error_return;
6216 }
6217 if (strcmp(PQdb(pset.db), dbbuf.data) != 0)
6218 {
6219 pg_log_error("cross-database references are not implemented: %s",
6220 pattern);
6221 goto error_return;
6222 }
6223 }
6224 termPQExpBuffer(&dbbuf);
6225 return true;
6226
6227 error_return:
6228 termPQExpBuffer(&dbbuf);
6229 return false;
6230 }
6231
6232 /*
6233 * \dRp
6234 * Lists publications.
6235 *
6236 * Takes an optional regexp to select particular publications
6237 */
6238 bool
6239 listPublications(const char *pattern)
6240 {
6241 PQExpBufferData buf;
6242 PGresult *res;
6243 printQueryOpt myopt = pset.popt;
6244 static const bool translate_columns[] = {false, false, false, false, false, false, false, false};
6245
6246 if (pset.sversion < 100000)
6247 {
6248 char sverbuf[32];
6249
6250 pg_log_error("The server (version %s) does not support publications.",
6251 formatPGVersionNumber(pset.sversion, false,
6252 sverbuf, sizeof(sverbuf)));
6253 return true;
6254 }
6255
6256 initPQExpBuffer(&buf);
6257
6258 printfPQExpBuffer(&buf,
6259 "SELECT pubname AS \"%s\",\n"
6260 " pg_catalog.pg_get_userbyid(pubowner) AS \"%s\",\n"
6261 " puballtables AS \"%s\",\n"
6262 " pubinsert AS \"%s\",\n"
6263 " pubupdate AS \"%s\",\n"
6264 " pubdelete AS \"%s\"",
6265 gettext_noop("Name"),
6266 gettext_noop("Owner"),
6267 gettext_noop("All tables"),
6268 gettext_noop("Inserts"),
6269 gettext_noop("Updates"),
6270 gettext_noop("Deletes"));
6271 if (pset.sversion >= 110000)
6272 appendPQExpBuffer(&buf,
6273 ",\n pubtruncate AS \"%s\"",
6274 gettext_noop("Truncates"));
6275 if (pset.sversion >= 130000)
6276 appendPQExpBuffer(&buf,
6277 ",\n pubviaroot AS \"%s\"",
6278 gettext_noop("Via root"));
6279
6280 appendPQExpBufferStr(&buf,
6281 "\nFROM pg_catalog.pg_publication\n");
6282
6283 if (!validateSQLNamePattern(&buf, pattern, false, false,
6284 NULL, "pubname", NULL,
6285 NULL,
6286 NULL, 1))
6287 {
6288 termPQExpBuffer(&buf);
6289 return false;
6290 }
6291
6292 appendPQExpBufferStr(&buf, "ORDER BY 1;");
6293
6294 res = PSQLexec(buf.data);
6295 termPQExpBuffer(&buf);
6296 if (!res)
6297 return false;
6298
6299 myopt.nullPrint = NULL;
6300 myopt.title = _("List of publications");
6301 myopt.translate_header = true;
6302 myopt.translate_columns = translate_columns;
6303 myopt.n_translate_columns = lengthof(translate_columns);
6304
6305 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
6306
6307 PQclear(res);
6308
6309 return true;
6310 }
6311
6312 /*
6313 * Add footer to publication description.
6314 */
6315 static bool
6316 addFooterToPublicationDesc(PQExpBuffer buf, const char *footermsg,
6317 bool as_schema, printTableContent *const cont)
6318 {
6319 PGresult *res;
6320 int count = 0;
6321 int i = 0;
6322
6323 res = PSQLexec(buf->data);
6324 if (!res)
6325 return false;
6326 else
6327 count = PQntuples(res);
6328
6329 if (count > 0)
6330 printTableAddFooter(cont, footermsg);
6331
6332 for (i = 0; i < count; i++)
6333 {
6334 if (as_schema)
6335 printfPQExpBuffer(buf, " \"%s\"", PQgetvalue(res, i, 0));
6336 else
6337 {
6338 printfPQExpBuffer(buf, " \"%s.%s\"", PQgetvalue(res, i, 0),
6339 PQgetvalue(res, i, 1));
6340
6341 if (!PQgetisnull(res, i, 3))
6342 appendPQExpBuffer(buf, " (%s)", PQgetvalue(res, i, 3));
6343
6344 if (!PQgetisnull(res, i, 2))
6345 appendPQExpBuffer(buf, " WHERE %s", PQgetvalue(res, i, 2));
6346 }
6347
6348 printTableAddFooter(cont, buf->data);
6349 }
6350
6351 PQclear(res);
6352 return true;
6353 }
6354
6355 /*
6356 * \dRp+
6357 * Describes publications including the contents.
6358 *
6359 * Takes an optional regexp to select particular publications
6360 */
6361 bool
6362 describePublications(const char *pattern)
6363 {
6364 PQExpBufferData buf;
6365 int i;
6366 PGresult *res;
6367 bool has_pubtruncate;
6368 bool has_pubviaroot;
6369
6370 PQExpBufferData title;
6371 printTableContent cont;
6372
6373 if (pset.sversion < 100000)
6374 {
6375 char sverbuf[32];
6376
6377 pg_log_error("The server (version %s) does not support publications.",
6378 formatPGVersionNumber(pset.sversion, false,
6379 sverbuf, sizeof(sverbuf)));
6380 return true;
6381 }
6382
6383 has_pubtruncate = (pset.sversion >= 110000);
6384 has_pubviaroot = (pset.sversion >= 130000);
6385
6386 initPQExpBuffer(&buf);
6387
6388 printfPQExpBuffer(&buf,
6389 "SELECT oid, pubname,\n"
6390 " pg_catalog.pg_get_userbyid(pubowner) AS owner,\n"
6391 " puballtables, pubinsert, pubupdate, pubdelete");
6392 if (has_pubtruncate)
6393 appendPQExpBufferStr(&buf,
6394 ", pubtruncate");
6395 if (has_pubviaroot)
6396 appendPQExpBufferStr(&buf,
6397 ", pubviaroot");
6398 appendPQExpBufferStr(&buf,
6399 "\nFROM pg_catalog.pg_publication\n");
6400
6401 if (!validateSQLNamePattern(&buf, pattern, false, false,
6402 NULL, "pubname", NULL,
6403 NULL,
6404 NULL, 1))
6405 {
6406 termPQExpBuffer(&buf);
6407 return false;
6408 }
6409
6410 appendPQExpBufferStr(&buf, "ORDER BY 2;");
6411
6412 res = PSQLexec(buf.data);
6413 if (!res)
6414 {
6415 termPQExpBuffer(&buf);
6416 return false;
6417 }
6418
6419 if (PQntuples(res) == 0)
6420 {
6421 if (!pset.quiet)
6422 {
6423 if (pattern)
6424 pg_log_error("Did not find any publication named \"%s\".",
6425 pattern);
6426 else
6427 pg_log_error("Did not find any publications.");
6428 }
6429
6430 termPQExpBuffer(&buf);
6431 PQclear(res);
6432 return false;
6433 }
6434
6435 for (i = 0; i < PQntuples(res); i++)
6436 {
6437 const char align = 'l';
6438 int ncols = 5;
6439 int nrows = 1;
6440 char *pubid = PQgetvalue(res, i, 0);
6441 char *pubname = PQgetvalue(res, i, 1);
6442 bool puballtables = strcmp(PQgetvalue(res, i, 3), "t") == 0;
6443 printTableOpt myopt = pset.popt.topt;
6444
6445 if (has_pubtruncate)
6446 ncols++;
6447 if (has_pubviaroot)
6448 ncols++;
6449
6450 initPQExpBuffer(&title);
6451 printfPQExpBuffer(&title, _("Publication %s"), pubname);
6452 printTableInit(&cont, &myopt, title.data, ncols, nrows);
6453
6454 printTableAddHeader(&cont, gettext_noop("Owner"), true, align);
6455 printTableAddHeader(&cont, gettext_noop("All tables"), true, align);
6456 printTableAddHeader(&cont, gettext_noop("Inserts"), true, align);
6457 printTableAddHeader(&cont, gettext_noop("Updates"), true, align);
6458 printTableAddHeader(&cont, gettext_noop("Deletes"), true, align);
6459 if (has_pubtruncate)
6460 printTableAddHeader(&cont, gettext_noop("Truncates"), true, align);
6461 if (has_pubviaroot)
6462 printTableAddHeader(&cont, gettext_noop("Via root"), true, align);
6463
6464 printTableAddCell(&cont, PQgetvalue(res, i, 2), false, false);
6465 printTableAddCell(&cont, PQgetvalue(res, i, 3), false, false);
6466 printTableAddCell(&cont, PQgetvalue(res, i, 4), false, false);
6467 printTableAddCell(&cont, PQgetvalue(res, i, 5), false, false);
6468 printTableAddCell(&cont, PQgetvalue(res, i, 6), false, false);
6469 if (has_pubtruncate)
6470 printTableAddCell(&cont, PQgetvalue(res, i, 7), false, false);
6471 if (has_pubviaroot)
6472 printTableAddCell(&cont, PQgetvalue(res, i, 8), false, false);
6473
6474 if (!puballtables)
6475 {
6476 /* Get the tables for the specified publication */
6477 printfPQExpBuffer(&buf,
6478 "SELECT n.nspname, c.relname");
6479 if (pset.sversion >= 150000)
6480 {
6481 appendPQExpBufferStr(&buf,
6482 ", pg_get_expr(pr.prqual, c.oid)");
6483 appendPQExpBufferStr(&buf,
6484 ", (CASE WHEN pr.prattrs IS NOT NULL THEN\n"
6485 " pg_catalog.array_to_string("
6486 " ARRAY(SELECT attname\n"
6487 " FROM\n"
6488 " pg_catalog.generate_series(0, pg_catalog.array_upper(pr.prattrs::pg_catalog.int2[], 1)) s,\n"
6489 " pg_catalog.pg_attribute\n"
6490 " WHERE attrelid = c.oid AND attnum = prattrs[s]), ', ')\n"
6491 " ELSE NULL END)");
6492 }
6493 else
6494 appendPQExpBufferStr(&buf,
6495 ", NULL, NULL");
6496 appendPQExpBuffer(&buf,
6497 "\nFROM pg_catalog.pg_class c,\n"
6498 " pg_catalog.pg_namespace n,\n"
6499 " pg_catalog.pg_publication_rel pr\n"
6500 "WHERE c.relnamespace = n.oid\n"
6501 " AND c.oid = pr.prrelid\n"
6502 " AND pr.prpubid = '%s'\n"
6503 "ORDER BY 1,2", pubid);
6504 if (!addFooterToPublicationDesc(&buf, _("Tables:"), false, &cont))
6505 goto error_return;
6506
6507 if (pset.sversion >= 150000)
6508 {
6509 /* Get the schemas for the specified publication */
6510 printfPQExpBuffer(&buf,
6511 "SELECT n.nspname\n"
6512 "FROM pg_catalog.pg_namespace n\n"
6513 " JOIN pg_catalog.pg_publication_namespace pn ON n.oid = pn.pnnspid\n"
6514 "WHERE pn.pnpubid = '%s'\n"
6515 "ORDER BY 1", pubid);
6516 if (!addFooterToPublicationDesc(&buf, _("Tables from schemas:"),
6517 true, &cont))
6518 goto error_return;
6519 }
6520 }
6521
6522 printTable(&cont, pset.queryFout, false, pset.logfile);
6523 printTableCleanup(&cont);
6524
6525 termPQExpBuffer(&title);
6526 }
6527
6528 termPQExpBuffer(&buf);
6529 PQclear(res);
6530
6531 return true;
6532
6533 error_return:
6534 printTableCleanup(&cont);
6535 PQclear(res);
6536 termPQExpBuffer(&buf);
6537 termPQExpBuffer(&title);
6538 return false;
6539 }
6540
6541 /*
6542 * \dRs
6543 * Describes subscriptions.
6544 *
6545 * Takes an optional regexp to select particular subscriptions
6546 */
6547 bool
6548 describeSubscriptions(const char *pattern, bool verbose)
6549 {
6550 PQExpBufferData buf;
6551 PGresult *res;
6552 printQueryOpt myopt = pset.popt;
6553 static const bool translate_columns[] = {false, false, false, false,
6554 false, false, false, false, false, false, false, false, false, false};
6555
6556 if (pset.sversion < 100000)
6557 {
6558 char sverbuf[32];
6559
6560 pg_log_error("The server (version %s) does not support subscriptions.",
6561 formatPGVersionNumber(pset.sversion, false,
6562 sverbuf, sizeof(sverbuf)));
6563 return true;
6564 }
6565
6566 initPQExpBuffer(&buf);
6567
6568 printfPQExpBuffer(&buf,
6569 "SELECT subname AS \"%s\"\n"
6570 ", pg_catalog.pg_get_userbyid(subowner) AS \"%s\"\n"
6571 ", subenabled AS \"%s\"\n"
6572 ", subpublications AS \"%s\"\n",
6573 gettext_noop("Name"),
6574 gettext_noop("Owner"),
6575 gettext_noop("Enabled"),
6576 gettext_noop("Publication"));
6577
6578 if (verbose)
6579 {
6580 /* Binary mode and streaming are only supported in v14 and higher */
6581 if (pset.sversion >= 140000)
6582 {
6583 appendPQExpBuffer(&buf,
6584 ", subbinary AS \"%s\"\n",
6585 gettext_noop("Binary"));
6586
6587 if (pset.sversion >= 160000)
6588 appendPQExpBuffer(&buf,
6589 ", (CASE substream\n"
6590 " WHEN 'f' THEN 'off'\n"
6591 " WHEN 't' THEN 'on'\n"
6592 " WHEN 'p' THEN 'parallel'\n"
6593 " END) AS \"%s\"\n",
6594 gettext_noop("Streaming"));
6595 else
6596 appendPQExpBuffer(&buf,
6597 ", substream AS \"%s\"\n",
6598 gettext_noop("Streaming"));
6599 }
6600
6601 /* Two_phase and disable_on_error are only supported in v15 and higher */
6602 if (pset.sversion >= 150000)
6603 appendPQExpBuffer(&buf,
6604 ", subtwophasestate AS \"%s\"\n"
6605 ", subdisableonerr AS \"%s\"\n",
6606 gettext_noop("Two-phase commit"),
6607 gettext_noop("Disable on error"));
6608
6609 if (pset.sversion >= 160000)
6610 appendPQExpBuffer(&buf,
6611 ", suborigin AS \"%s\"\n"
6612 ", subpasswordrequired AS \"%s\"\n"
6613 ", subrunasowner AS \"%s\"\n",
6614 gettext_noop("Origin"),
6615 gettext_noop("Password required"),
6616 gettext_noop("Run as owner?"));
6617
6618 appendPQExpBuffer(&buf,
6619 ", subsynccommit AS \"%s\"\n"
6620 ", subconninfo AS \"%s\"\n",
6621 gettext_noop("Synchronous commit"),
6622 gettext_noop("Conninfo"));
6623
6624 /* Skip LSN is only supported in v15 and higher */
6625 if (pset.sversion >= 150000)
6626 appendPQExpBuffer(&buf,
6627 ", subskiplsn AS \"%s\"\n",
6628 gettext_noop("Skip LSN"));
6629 }
6630
6631 /* Only display subscriptions in current database. */
6632 appendPQExpBufferStr(&buf,
6633 "FROM pg_catalog.pg_subscription\n"
6634 "WHERE subdbid = (SELECT oid\n"
6635 " FROM pg_catalog.pg_database\n"
6636 " WHERE datname = pg_catalog.current_database())");
6637
6638 if (!validateSQLNamePattern(&buf, pattern, true, false,
6639 NULL, "subname", NULL,
6640 NULL,
6641 NULL, 1))
6642 {
6643 termPQExpBuffer(&buf);
6644 return false;
6645 }
6646
6647 appendPQExpBufferStr(&buf, "ORDER BY 1;");
6648
6649 res = PSQLexec(buf.data);
6650 termPQExpBuffer(&buf);
6651 if (!res)
6652 return false;
6653
6654 myopt.nullPrint = NULL;
6655 myopt.title = _("List of subscriptions");
6656 myopt.translate_header = true;
6657 myopt.translate_columns = translate_columns;
6658 myopt.n_translate_columns = lengthof(translate_columns);
6659
6660 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
6661
6662 PQclear(res);
6663 return true;
6664 }
6665
6666 /*
6667 * printACLColumn
6668 *
6669 * Helper function for consistently formatting ACL (privilege) columns.
6670 * The proper targetlist entry is appended to buf. Note lack of any
6671 * whitespace or comma decoration.
6672 */
6673 static void
6674 printACLColumn(PQExpBuffer buf, const char *colname)
6675 {
6676 appendPQExpBuffer(buf,
6677 "pg_catalog.array_to_string(%s, E'\\n') AS \"%s\"",
6678 colname, gettext_noop("Access privileges"));
6679 }
6680
6681 /*
6682 * \dAc
6683 * Lists operator classes
6684 *
6685 * Takes optional regexps to filter by index access method and input data type.
6686 */
6687 bool
6688 listOperatorClasses(const char *access_method_pattern,
6689 const char *type_pattern, bool verbose)
6690 {
6691 PQExpBufferData buf;
6692 PGresult *res;
6693 printQueryOpt myopt = pset.popt;
6694 bool have_where = false;
6695 static const bool translate_columns[] = {false, false, false, false, false, false, false};
6696
6697 initPQExpBuffer(&buf);
6698
6699 printfPQExpBuffer(&buf,
6700 "SELECT\n"
6701 " am.amname AS \"%s\",\n"
6702 " pg_catalog.format_type(c.opcintype, NULL) AS \"%s\",\n"
6703 " CASE\n"
6704 " WHEN c.opckeytype <> 0 AND c.opckeytype <> c.opcintype\n"
6705 " THEN pg_catalog.format_type(c.opckeytype, NULL)\n"
6706 " ELSE NULL\n"
6707 " END AS \"%s\",\n"
6708 " CASE\n"
6709 " WHEN pg_catalog.pg_opclass_is_visible(c.oid)\n"
6710 " THEN pg_catalog.format('%%I', c.opcname)\n"
6711 " ELSE pg_catalog.format('%%I.%%I', n.nspname, c.opcname)\n"
6712 " END AS \"%s\",\n"
6713 " (CASE WHEN c.opcdefault\n"
6714 " THEN '%s'\n"
6715 " ELSE '%s'\n"
6716 " END) AS \"%s\"",
6717 gettext_noop("AM"),
6718 gettext_noop("Input type"),
6719 gettext_noop("Storage type"),
6720 gettext_noop("Operator class"),
6721 gettext_noop("yes"),
6722 gettext_noop("no"),
6723 gettext_noop("Default?"));
6724 if (verbose)
6725 appendPQExpBuffer(&buf,
6726 ",\n CASE\n"
6727 " WHEN pg_catalog.pg_opfamily_is_visible(of.oid)\n"
6728 " THEN pg_catalog.format('%%I', of.opfname)\n"
6729 " ELSE pg_catalog.format('%%I.%%I', ofn.nspname, of.opfname)\n"
6730 " END AS \"%s\",\n"
6731 " pg_catalog.pg_get_userbyid(c.opcowner) AS \"%s\"\n",
6732 gettext_noop("Operator family"),
6733 gettext_noop("Owner"));
6734 appendPQExpBufferStr(&buf,
6735 "\nFROM pg_catalog.pg_opclass c\n"
6736 " LEFT JOIN pg_catalog.pg_am am on am.oid = c.opcmethod\n"
6737 " LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.opcnamespace\n"
6738 " LEFT JOIN pg_catalog.pg_type t ON t.oid = c.opcintype\n"
6739 " LEFT JOIN pg_catalog.pg_namespace tn ON tn.oid = t.typnamespace\n");
6740 if (verbose)
6741 appendPQExpBufferStr(&buf,
6742 " LEFT JOIN pg_catalog.pg_opfamily of ON of.oid = c.opcfamily\n"
6743 " LEFT JOIN pg_catalog.pg_namespace ofn ON ofn.oid = of.opfnamespace\n");
6744
6745 if (access_method_pattern)
6746 if (!validateSQLNamePattern(&buf, access_method_pattern,
6747 false, false, NULL, "am.amname", NULL, NULL,
6748 &have_where, 1))
6749 goto error_return;
6750 if (type_pattern)
6751 {
6752 /* Match type name pattern against either internal or external name */
6753 if (!validateSQLNamePattern(&buf, type_pattern, have_where, false,
6754 "tn.nspname", "t.typname",
6755 "pg_catalog.format_type(t.oid, NULL)",
6756 "pg_catalog.pg_type_is_visible(t.oid)",
6757 NULL, 3))
6758 goto error_return;
6759 }
6760
6761 appendPQExpBufferStr(&buf, "ORDER BY 1, 2, 4;");
6762 res = PSQLexec(buf.data);
6763 termPQExpBuffer(&buf);
6764 if (!res)
6765 return false;
6766
6767 myopt.nullPrint = NULL;
6768 myopt.title = _("List of operator classes");
6769 myopt.translate_header = true;
6770 myopt.translate_columns = translate_columns;
6771 myopt.n_translate_columns = lengthof(translate_columns);
6772
6773 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
6774
6775 PQclear(res);
6776 return true;
6777
6778 error_return:
6779 termPQExpBuffer(&buf);
6780 return false;
6781 }
6782
6783 /*
6784 * \dAf
6785 * Lists operator families
6786 *
6787 * Takes optional regexps to filter by index access method and input data type.
6788 */
6789 bool
6790 listOperatorFamilies(const char *access_method_pattern,
6791 const char *type_pattern, bool verbose)
6792 {
6793 PQExpBufferData buf;
6794 PGresult *res;
6795 printQueryOpt myopt = pset.popt;
6796 bool have_where = false;
6797 static const bool translate_columns[] = {false, false, false, false};
6798
6799 initPQExpBuffer(&buf);
6800
6801 printfPQExpBuffer(&buf,
6802 "SELECT\n"
6803 " am.amname AS \"%s\",\n"
6804 " CASE\n"
6805 " WHEN pg_catalog.pg_opfamily_is_visible(f.oid)\n"
6806 " THEN pg_catalog.format('%%I', f.opfname)\n"
6807 " ELSE pg_catalog.format('%%I.%%I', n.nspname, f.opfname)\n"
6808 " END AS \"%s\",\n"
6809 " (SELECT\n"
6810 " pg_catalog.string_agg(pg_catalog.format_type(oc.opcintype, NULL), ', ')\n"
6811 " FROM pg_catalog.pg_opclass oc\n"
6812 " WHERE oc.opcfamily = f.oid) \"%s\"",
6813 gettext_noop("AM"),
6814 gettext_noop("Operator family"),
6815 gettext_noop("Applicable types"));
6816 if (verbose)
6817 appendPQExpBuffer(&buf,
6818 ",\n pg_catalog.pg_get_userbyid(f.opfowner) AS \"%s\"\n",
6819 gettext_noop("Owner"));
6820 appendPQExpBufferStr(&buf,
6821 "\nFROM pg_catalog.pg_opfamily f\n"
6822 " LEFT JOIN pg_catalog.pg_am am on am.oid = f.opfmethod\n"
6823 " LEFT JOIN pg_catalog.pg_namespace n ON n.oid = f.opfnamespace\n");
6824
6825 if (access_method_pattern)
6826 if (!validateSQLNamePattern(&buf, access_method_pattern,
6827 false, false, NULL, "am.amname", NULL, NULL,
6828 &have_where, 1))
6829 goto error_return;
6830 if (type_pattern)
6831 {
6832 appendPQExpBuffer(&buf,
6833 " %s EXISTS (\n"
6834 " SELECT 1\n"
6835 " FROM pg_catalog.pg_type t\n"
6836 " JOIN pg_catalog.pg_opclass oc ON oc.opcintype = t.oid\n"
6837 " LEFT JOIN pg_catalog.pg_namespace tn ON tn.oid = t.typnamespace\n"
6838 " WHERE oc.opcfamily = f.oid\n",
6839 have_where ? "AND" : "WHERE");
6840 /* Match type name pattern against either internal or external name */
6841 if (!validateSQLNamePattern(&buf, type_pattern, true, false,
6842 "tn.nspname", "t.typname",
6843 "pg_catalog.format_type(t.oid, NULL)",
6844 "pg_catalog.pg_type_is_visible(t.oid)",
6845 NULL, 3))
6846 goto error_return;
6847 appendPQExpBufferStr(&buf, " )\n");
6848 }
6849
6850 appendPQExpBufferStr(&buf, "ORDER BY 1, 2;");
6851 res = PSQLexec(buf.data);
6852 termPQExpBuffer(&buf);
6853 if (!res)
6854 return false;
6855
6856 myopt.nullPrint = NULL;
6857 myopt.title = _("List of operator families");
6858 myopt.translate_header = true;
6859 myopt.translate_columns = translate_columns;
6860 myopt.n_translate_columns = lengthof(translate_columns);
6861
6862 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
6863
6864 PQclear(res);
6865 return true;
6866
6867 error_return:
6868 termPQExpBuffer(&buf);
6869 return false;
6870 }
6871
6872 /*
6873 * \dAo
6874 * Lists operators of operator families
6875 *
6876 * Takes optional regexps to filter by index access method and operator
6877 * family.
6878 */
6879 bool
6880 listOpFamilyOperators(const char *access_method_pattern,
6881 const char *family_pattern, bool verbose)
6882 {
6883 PQExpBufferData buf;
6884 PGresult *res;
6885 printQueryOpt myopt = pset.popt;
6886 bool have_where = false;
6887
6888 static const bool translate_columns[] = {false, false, false, false, false, false};
6889
6890 initPQExpBuffer(&buf);
6891
6892 printfPQExpBuffer(&buf,
6893 "SELECT\n"
6894 " am.amname AS \"%s\",\n"
6895 " CASE\n"
6896 " WHEN pg_catalog.pg_opfamily_is_visible(of.oid)\n"
6897 " THEN pg_catalog.format('%%I', of.opfname)\n"
6898 " ELSE pg_catalog.format('%%I.%%I', nsf.nspname, of.opfname)\n"
6899 " END AS \"%s\",\n"
6900 " o.amopopr::pg_catalog.regoperator AS \"%s\"\n,"
6901 " o.amopstrategy AS \"%s\",\n"
6902 " CASE o.amoppurpose\n"
6903 " WHEN 'o' THEN '%s'\n"
6904 " WHEN 's' THEN '%s'\n"
6905 " END AS \"%s\"\n",
6906 gettext_noop("AM"),
6907 gettext_noop("Operator family"),
6908 gettext_noop("Operator"),
6909 gettext_noop("Strategy"),
6910 gettext_noop("ordering"),
6911 gettext_noop("search"),
6912 gettext_noop("Purpose"));
6913
6914 if (verbose)
6915 appendPQExpBuffer(&buf,
6916 ", ofs.opfname AS \"%s\"\n",
6917 gettext_noop("Sort opfamily"));
6918 appendPQExpBufferStr(&buf,
6919 "FROM pg_catalog.pg_amop o\n"
6920 " LEFT JOIN pg_catalog.pg_opfamily of ON of.oid = o.amopfamily\n"
6921 " LEFT JOIN pg_catalog.pg_am am ON am.oid = of.opfmethod AND am.oid = o.amopmethod\n"
6922 " LEFT JOIN pg_catalog.pg_namespace nsf ON of.opfnamespace = nsf.oid\n");
6923 if (verbose)
6924 appendPQExpBufferStr(&buf,
6925 " LEFT JOIN pg_catalog.pg_opfamily ofs ON ofs.oid = o.amopsortfamily\n");
6926
6927 if (access_method_pattern)
6928 {
6929 if (!validateSQLNamePattern(&buf, access_method_pattern,
6930 false, false, NULL, "am.amname",
6931 NULL, NULL,
6932 &have_where, 1))
6933 goto error_return;
6934 }
6935
6936 if (family_pattern)
6937 {
6938 if (!validateSQLNamePattern(&buf, family_pattern, have_where, false,
6939 "nsf.nspname", "of.opfname", NULL, NULL,
6940 NULL, 3))
6941 goto error_return;
6942 }
6943
6944 appendPQExpBufferStr(&buf, "ORDER BY 1, 2,\n"
6945 " o.amoplefttype = o.amoprighttype DESC,\n"
6946 " pg_catalog.format_type(o.amoplefttype, NULL),\n"
6947 " pg_catalog.format_type(o.amoprighttype, NULL),\n"
6948 " o.amopstrategy;");
6949
6950 res = PSQLexec(buf.data);
6951 termPQExpBuffer(&buf);
6952 if (!res)
6953 return false;
6954
6955 myopt.nullPrint = NULL;
6956 myopt.title = _("List of operators of operator families");
6957 myopt.translate_header = true;
6958 myopt.translate_columns = translate_columns;
6959 myopt.n_translate_columns = lengthof(translate_columns);
6960
6961 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
6962
6963 PQclear(res);
6964 return true;
6965
6966 error_return:
6967 termPQExpBuffer(&buf);
6968 return false;
6969 }
6970
6971 /*
6972 * \dAp
6973 * Lists support functions of operator families
6974 *
6975 * Takes optional regexps to filter by index access method and operator
6976 * family.
6977 */
6978 bool
6979 listOpFamilyFunctions(const char *access_method_pattern,
6980 const char *family_pattern, bool verbose)
6981 {
6982 PQExpBufferData buf;
6983 PGresult *res;
6984 printQueryOpt myopt = pset.popt;
6985 bool have_where = false;
6986 static const bool translate_columns[] = {false, false, false, false, false, false};
6987
6988 initPQExpBuffer(&buf);
6989
6990 printfPQExpBuffer(&buf,
6991 "SELECT\n"
6992 " am.amname AS \"%s\",\n"
6993 " CASE\n"
6994 " WHEN pg_catalog.pg_opfamily_is_visible(of.oid)\n"
6995 " THEN pg_catalog.format('%%I', of.opfname)\n"
6996 " ELSE pg_catalog.format('%%I.%%I', ns.nspname, of.opfname)\n"
6997 " END AS \"%s\",\n"
6998 " pg_catalog.format_type(ap.amproclefttype, NULL) AS \"%s\",\n"
6999 " pg_catalog.format_type(ap.amprocrighttype, NULL) AS \"%s\",\n"
7000 " ap.amprocnum AS \"%s\"\n",
7001 gettext_noop("AM"),
7002 gettext_noop("Operator family"),
7003 gettext_noop("Registered left type"),
7004 gettext_noop("Registered right type"),
7005 gettext_noop("Number"));
7006
7007 if (!verbose)
7008 appendPQExpBuffer(&buf,
7009 ", p.proname AS \"%s\"\n",
7010 gettext_noop("Function"));
7011 else
7012 appendPQExpBuffer(&buf,
7013 ", ap.amproc::pg_catalog.regprocedure AS \"%s\"\n",
7014 gettext_noop("Function"));
7015
7016 appendPQExpBufferStr(&buf,
7017 "FROM pg_catalog.pg_amproc ap\n"
7018 " LEFT JOIN pg_catalog.pg_opfamily of ON of.oid = ap.amprocfamily\n"
7019 " LEFT JOIN pg_catalog.pg_am am ON am.oid = of.opfmethod\n"
7020 " LEFT JOIN pg_catalog.pg_namespace ns ON of.opfnamespace = ns.oid\n"
7021 " LEFT JOIN pg_catalog.pg_proc p ON ap.amproc = p.oid\n");
7022
7023 if (access_method_pattern)
7024 {
7025 if (!validateSQLNamePattern(&buf, access_method_pattern,
7026 false, false, NULL, "am.amname",
7027 NULL, NULL,
7028 &have_where, 1))
7029 goto error_return;
7030 }
7031 if (family_pattern)
7032 {
7033 if (!validateSQLNamePattern(&buf, family_pattern, have_where, false,
7034 "ns.nspname", "of.opfname", NULL, NULL,
7035 NULL, 3))
7036 goto error_return;
7037 }
7038
7039 appendPQExpBufferStr(&buf, "ORDER BY 1, 2,\n"
7040 " ap.amproclefttype = ap.amprocrighttype DESC,\n"
7041 " 3, 4, 5;");
7042
7043 res = PSQLexec(buf.data);
7044 termPQExpBuffer(&buf);
7045 if (!res)
7046 return false;
7047
7048 myopt.nullPrint = NULL;
7049 myopt.title = _("List of support functions of operator families");
7050 myopt.translate_header = true;
7051 myopt.translate_columns = translate_columns;
7052 myopt.n_translate_columns = lengthof(translate_columns);
7053
7054 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
7055
7056 PQclear(res);
7057 return true;
7058
7059 error_return:
7060 termPQExpBuffer(&buf);
7061 return false;
7062 }
7063
7064 /*
7065 * \dl or \lo_list
7066 * Lists large objects
7067 */
7068 bool
7069 listLargeObjects(bool verbose)
7070 {
7071 PQExpBufferData buf;
7072 PGresult *res;
7073 printQueryOpt myopt = pset.popt;
7074
7075 initPQExpBuffer(&buf);
7076
7077 printfPQExpBuffer(&buf,
7078 "SELECT oid as \"%s\",\n"
7079 " pg_catalog.pg_get_userbyid(lomowner) as \"%s\",\n ",
7080 gettext_noop("ID"),
7081 gettext_noop("Owner"));
7082
7083 if (verbose)
7084 {
7085 printACLColumn(&buf, "lomacl");
7086 appendPQExpBufferStr(&buf, ",\n ");
7087 }
7088
7089 appendPQExpBuffer(&buf,
7090 "pg_catalog.obj_description(oid, 'pg_largeobject') as \"%s\"\n"
7091 "FROM pg_catalog.pg_largeobject_metadata\n"
7092 "ORDER BY oid",
7093 gettext_noop("Description"));
7094
7095 res = PSQLexec(buf.data);
7096 termPQExpBuffer(&buf);
7097 if (!res)
7098 return false;
7099
7100 myopt.nullPrint = NULL;
7101 myopt.title = _("Large objects");
7102 myopt.translate_header = true;
7103
7104 printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
7105
7106 PQclear(res);
7107 return true;
7108 }
Postgresql Clone from git://git.postgresql.org/git/postgresql.git