2 * psql - the PostgreSQL interactive terminal
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 7.4 and up. It's okay to omit irrelevant
7 * information for an old server, but not to fail outright.
9 * Copyright (c) 2000-2012, PostgreSQL Global Development Group
11 * src/bin/psql/describe.c
13 #include "postgres_fe.h"
19 #include "dumputils.h"
23 #include "variables.h"
26 static bool describeOneTableDetails(const char *schemaname,
27 const char *relationname,
30 static void add_tablespace_footer(printTableContent *const cont, char relkind,
31 Oid tablespace, const bool newline);
32 static void add_role_attribute(PQExpBuffer buf, const char *const str);
33 static bool listTSParsersVerbose(const char *pattern);
34 static bool describeOneTSParser(const char *oid, const char *nspname,
36 static bool listTSConfigsVerbose(const char *pattern);
37 static bool describeOneTSConfig(const char *oid, const char *nspname,
39 const char *pnspname, const char *prsname);
40 static void printACLColumn(PQExpBuffer buf, const char *colname);
41 static bool listOneExtensionContents(const char *extname, const char *oid);
45 * Handlers for various slash commands displaying some sort of list
46 * of things in the database.
48 * Note: try to format the queries to look nice in -E output.
54 * Takes an optional regexp to select particular aggregates
57 describeAggregates(const char *pattern, bool verbose, bool showSystem)
61 printQueryOpt myopt = pset.popt;
63 initPQExpBuffer(&buf);
65 printfPQExpBuffer(&buf,
66 "SELECT n.nspname as \"%s\",\n"
67 " p.proname AS \"%s\",\n"
68 " pg_catalog.format_type(p.prorettype, NULL) AS \"%s\",\n",
69 gettext_noop("Schema"),
71 gettext_noop("Result data type"));
73 if (pset.sversion >= 80200)
74 appendPQExpBuffer(&buf,
75 " CASE WHEN p.pronargs = 0\n"
76 " THEN CAST('*' AS pg_catalog.text)\n"
78 " pg_catalog.array_to_string(ARRAY(\n"
80 " pg_catalog.format_type(p.proargtypes[s.i], NULL)\n"
82 " pg_catalog.generate_series(0, pg_catalog.array_upper(p.proargtypes, 1)) AS s(i)\n"
85 gettext_noop("Argument data types"));
87 appendPQExpBuffer(&buf,
88 " pg_catalog.format_type(p.proargtypes[0], NULL) AS \"%s\",\n",
89 gettext_noop("Argument data types"));
91 appendPQExpBuffer(&buf,
92 " pg_catalog.obj_description(p.oid, 'pg_proc') as \"%s\"\n"
93 "FROM pg_catalog.pg_proc p\n"
94 " LEFT JOIN pg_catalog.pg_namespace n ON n.oid = p.pronamespace\n"
96 gettext_noop("Description"));
98 if (!showSystem && !pattern)
99 appendPQExpBuffer(&buf, " AND n.nspname <> 'pg_catalog'\n"
100 " AND n.nspname <> 'information_schema'\n");
102 processSQLNamePattern(pset.db, &buf, pattern, true, false,
103 "n.nspname", "p.proname", NULL,
104 "pg_catalog.pg_function_is_visible(p.oid)");
106 appendPQExpBuffer(&buf, "ORDER BY 1, 2, 4;");
108 res = PSQLexec(buf.data, false);
109 termPQExpBuffer(&buf);
113 myopt.nullPrint = NULL;
114 myopt.title = _("List of aggregate functions");
115 myopt.translate_header = true;
117 printQuery(res, &myopt, pset.queryFout, pset.logfile);
124 * Takes an optional regexp to select particular tablespaces
127 describeTablespaces(const char *pattern, bool verbose)
131 printQueryOpt myopt = pset.popt;
133 if (pset.sversion < 80000)
135 psql_error("The server (version %d.%d) does not support tablespaces.\n",
136 pset.sversion / 10000, (pset.sversion / 100) % 100);
140 initPQExpBuffer(&buf);
142 if (pset.sversion >= 90200)
143 printfPQExpBuffer(&buf,
144 "SELECT spcname AS \"%s\",\n"
145 " pg_catalog.pg_get_userbyid(spcowner) AS \"%s\",\n"
146 " pg_catalog.pg_tablespace_location(oid) AS \"%s\"",
147 gettext_noop("Name"),
148 gettext_noop("Owner"),
149 gettext_noop("Location"));
151 printfPQExpBuffer(&buf,
152 "SELECT spcname AS \"%s\",\n"
153 " pg_catalog.pg_get_userbyid(spcowner) AS \"%s\",\n"
154 " spclocation AS \"%s\"",
155 gettext_noop("Name"),
156 gettext_noop("Owner"),
157 gettext_noop("Location"));
161 appendPQExpBuffer(&buf, ",\n ");
162 printACLColumn(&buf, "spcacl");
165 if (verbose && pset.sversion >= 80200)
166 appendPQExpBuffer(&buf,
167 ",\n pg_catalog.shobj_description(oid, 'pg_tablespace') AS \"%s\"",
168 gettext_noop("Description"));
170 appendPQExpBuffer(&buf,
171 "\nFROM pg_catalog.pg_tablespace\n");
173 processSQLNamePattern(pset.db, &buf, pattern, false, false,
174 NULL, "spcname", NULL,
177 appendPQExpBuffer(&buf, "ORDER BY 1;");
179 res = PSQLexec(buf.data, false);
180 termPQExpBuffer(&buf);
184 myopt.nullPrint = NULL;
185 myopt.title = _("List of tablespaces");
186 myopt.translate_header = true;
188 printQuery(res, &myopt, pset.queryFout, pset.logfile);
196 * Takes an optional regexp to select particular functions.
198 * As with \d, you can specify the kinds of functions you want:
205 * and you can mix and match these in any order.
208 describeFunctions(const char *functypes, const char *pattern, bool verbose, bool showSystem)
210 bool showAggregate = strchr(functypes, 'a') != NULL;
211 bool showNormal = strchr(functypes, 'n') != NULL;
212 bool showTrigger = strchr(functypes, 't') != NULL;
213 bool showWindow = strchr(functypes, 'w') != NULL;
217 printQueryOpt myopt = pset.popt;
218 static const bool translate_columns[] = {false, false, false, false, true, true, false, false, false, false};
220 if (strlen(functypes) != strspn(functypes, "antwS+"))
222 psql_error("\\df only takes [antwS+] as options\n");
226 if (showWindow && pset.sversion < 80400)
228 psql_error("\\df does not take a \"w\" option with server version %d.%d\n",
229 pset.sversion / 10000, (pset.sversion / 100) % 100);
233 if (!showAggregate && !showNormal && !showTrigger && !showWindow)
235 showAggregate = showNormal = showTrigger = true;
236 if (pset.sversion >= 80400)
240 initPQExpBuffer(&buf);
242 printfPQExpBuffer(&buf,
243 "SELECT n.nspname as \"%s\",\n"
244 " p.proname as \"%s\",\n",
245 gettext_noop("Schema"),
246 gettext_noop("Name"));
248 if (pset.sversion >= 80400)
249 appendPQExpBuffer(&buf,
250 " pg_catalog.pg_get_function_result(p.oid) as \"%s\",\n"
251 " pg_catalog.pg_get_function_arguments(p.oid) as \"%s\",\n"
253 " WHEN p.proisagg THEN '%s'\n"
254 " WHEN p.proiswindow THEN '%s'\n"
255 " WHEN p.prorettype = 'pg_catalog.trigger'::pg_catalog.regtype THEN '%s'\n"
258 gettext_noop("Result data type"),
259 gettext_noop("Argument data types"),
260 /* translator: "agg" is short for "aggregate" */
262 gettext_noop("window"),
263 gettext_noop("trigger"),
264 gettext_noop("normal"),
265 gettext_noop("Type"));
266 else if (pset.sversion >= 80100)
267 appendPQExpBuffer(&buf,
268 " CASE WHEN p.proretset THEN 'SETOF ' ELSE '' END ||\n"
269 " pg_catalog.format_type(p.prorettype, NULL) as \"%s\",\n"
270 " CASE WHEN proallargtypes IS NOT NULL THEN\n"
271 " pg_catalog.array_to_string(ARRAY(\n"
274 " WHEN p.proargmodes[s.i] = 'i' THEN ''\n"
275 " WHEN p.proargmodes[s.i] = 'o' THEN 'OUT '\n"
276 " WHEN p.proargmodes[s.i] = 'b' THEN 'INOUT '\n"
277 " WHEN p.proargmodes[s.i] = 'v' THEN 'VARIADIC '\n"
280 " WHEN COALESCE(p.proargnames[s.i], '') = '' THEN ''\n"
281 " ELSE p.proargnames[s.i] || ' ' \n"
283 " pg_catalog.format_type(p.proallargtypes[s.i], NULL)\n"
285 " pg_catalog.generate_series(1, pg_catalog.array_upper(p.proallargtypes, 1)) AS s(i)\n"
288 " pg_catalog.array_to_string(ARRAY(\n"
291 " WHEN COALESCE(p.proargnames[s.i+1], '') = '' THEN ''\n"
292 " ELSE p.proargnames[s.i+1] || ' '\n"
294 " pg_catalog.format_type(p.proargtypes[s.i], NULL)\n"
296 " pg_catalog.generate_series(0, pg_catalog.array_upper(p.proargtypes, 1)) AS s(i)\n"
300 " WHEN p.proisagg THEN '%s'\n"
301 " WHEN p.prorettype = 'pg_catalog.trigger'::pg_catalog.regtype THEN '%s'\n"
304 gettext_noop("Result data type"),
305 gettext_noop("Argument data types"),
306 /* translator: "agg" is short for "aggregate" */
308 gettext_noop("trigger"),
309 gettext_noop("normal"),
310 gettext_noop("Type"));
312 appendPQExpBuffer(&buf,
313 " CASE WHEN p.proretset THEN 'SETOF ' ELSE '' END ||\n"
314 " pg_catalog.format_type(p.prorettype, NULL) as \"%s\",\n"
315 " pg_catalog.oidvectortypes(p.proargtypes) as \"%s\",\n"
317 " WHEN p.proisagg THEN '%s'\n"
318 " WHEN p.prorettype = 'pg_catalog.trigger'::pg_catalog.regtype THEN '%s'\n"
321 gettext_noop("Result data type"),
322 gettext_noop("Argument data types"),
323 /* translator: "agg" is short for "aggregate" */
325 gettext_noop("trigger"),
326 gettext_noop("normal"),
327 gettext_noop("Type"));
330 appendPQExpBuffer(&buf,
332 " WHEN p.provolatile = 'i' THEN '%s'\n"
333 " WHEN p.provolatile = 's' THEN '%s'\n"
334 " WHEN p.provolatile = 'v' THEN '%s'\n"
336 ",\n pg_catalog.pg_get_userbyid(p.proowner) as \"%s\",\n"
337 " l.lanname as \"%s\",\n"
338 " p.prosrc as \"%s\",\n"
339 " pg_catalog.obj_description(p.oid, 'pg_proc') as \"%s\"",
340 gettext_noop("immutable"),
341 gettext_noop("stable"),
342 gettext_noop("volatile"),
343 gettext_noop("Volatility"),
344 gettext_noop("Owner"),
345 gettext_noop("Language"),
346 gettext_noop("Source code"),
347 gettext_noop("Description"));
349 appendPQExpBuffer(&buf,
350 "\nFROM pg_catalog.pg_proc p"
351 "\n LEFT JOIN pg_catalog.pg_namespace n ON n.oid = p.pronamespace\n");
354 appendPQExpBuffer(&buf,
355 " LEFT JOIN pg_catalog.pg_language l ON l.oid = p.prolang\n");
359 /* filter by function type, if requested */
360 if (showNormal && showAggregate && showTrigger && showWindow)
367 appendPQExpBuffer(&buf, " AND ");
370 appendPQExpBuffer(&buf, "WHERE ");
373 appendPQExpBuffer(&buf, "NOT p.proisagg\n");
378 appendPQExpBuffer(&buf, " AND ");
381 appendPQExpBuffer(&buf, "WHERE ");
384 appendPQExpBuffer(&buf, "p.prorettype <> 'pg_catalog.trigger'::pg_catalog.regtype\n");
386 if (!showWindow && pset.sversion >= 80400)
389 appendPQExpBuffer(&buf, " AND ");
392 appendPQExpBuffer(&buf, "WHERE ");
395 appendPQExpBuffer(&buf, "NOT p.proiswindow\n");
400 bool needs_or = false;
402 appendPQExpBuffer(&buf, "WHERE (\n ");
404 /* Note: at least one of these must be true ... */
407 appendPQExpBuffer(&buf, "p.proisagg\n");
413 appendPQExpBuffer(&buf, " OR ");
414 appendPQExpBuffer(&buf,
415 "p.prorettype = 'pg_catalog.trigger'::pg_catalog.regtype\n");
421 appendPQExpBuffer(&buf, " OR ");
422 appendPQExpBuffer(&buf, "p.proiswindow\n");
425 appendPQExpBuffer(&buf, " )\n");
428 processSQLNamePattern(pset.db, &buf, pattern, have_where, false,
429 "n.nspname", "p.proname", NULL,
430 "pg_catalog.pg_function_is_visible(p.oid)");
432 if (!showSystem && !pattern)
433 appendPQExpBuffer(&buf, " AND n.nspname <> 'pg_catalog'\n"
434 " AND n.nspname <> 'information_schema'\n");
436 appendPQExpBuffer(&buf, "ORDER BY 1, 2, 4;");
438 res = PSQLexec(buf.data, false);
439 termPQExpBuffer(&buf);
443 myopt.nullPrint = NULL;
444 myopt.title = _("List of functions");
445 myopt.translate_header = true;
446 myopt.translate_columns = translate_columns;
448 printQuery(res, &myopt, pset.queryFout, pset.logfile);
461 describeTypes(const char *pattern, bool verbose, bool showSystem)
465 printQueryOpt myopt = pset.popt;
467 initPQExpBuffer(&buf);
469 printfPQExpBuffer(&buf,
470 "SELECT n.nspname as \"%s\",\n"
471 " pg_catalog.format_type(t.oid, NULL) AS \"%s\",\n",
472 gettext_noop("Schema"),
473 gettext_noop("Name"));
475 appendPQExpBuffer(&buf,
476 " t.typname AS \"%s\",\n"
477 " CASE WHEN t.typrelid != 0\n"
478 " THEN CAST('tuple' AS pg_catalog.text)\n"
479 " WHEN t.typlen < 0\n"
480 " THEN CAST('var' AS pg_catalog.text)\n"
481 " ELSE CAST(t.typlen AS pg_catalog.text)\n"
483 gettext_noop("Internal name"),
484 gettext_noop("Size"));
485 if (verbose && pset.sversion >= 80300)
487 appendPQExpBuffer(&buf,
488 " pg_catalog.array_to_string(\n"
490 " SELECT e.enumlabel\n"
491 " FROM pg_catalog.pg_enum e\n"
492 " WHERE e.enumtypid = t.oid\n");
494 if (pset.sversion >= 90100)
495 appendPQExpBuffer(&buf,
496 " ORDER BY e.enumsortorder\n");
498 appendPQExpBuffer(&buf,
499 " ORDER BY e.oid\n");
501 appendPQExpBuffer(&buf,
505 gettext_noop("Elements"));
507 if (verbose && pset.sversion >= 90200)
509 printACLColumn(&buf, "t.typacl");
510 appendPQExpBuffer(&buf, ",\n ");
513 appendPQExpBuffer(&buf,
514 " pg_catalog.obj_description(t.oid, 'pg_type') as \"%s\"\n",
515 gettext_noop("Description"));
517 appendPQExpBuffer(&buf, "FROM pg_catalog.pg_type t\n"
518 " LEFT JOIN pg_catalog.pg_namespace n ON n.oid = t.typnamespace\n");
521 * do not include complex types (typrelid!=0) unless they are standalone
524 appendPQExpBuffer(&buf, "WHERE (t.typrelid = 0 ");
525 appendPQExpBuffer(&buf, "OR (SELECT c.relkind = 'c' FROM pg_catalog.pg_class c "
526 "WHERE c.oid = t.typrelid))\n");
529 * do not include array types (before 8.3 we have to use the assumption
530 * that their names start with underscore)
532 if (pset.sversion >= 80300)
533 appendPQExpBuffer(&buf, " AND NOT EXISTS(SELECT 1 FROM pg_catalog.pg_type el WHERE el.oid = t.typelem AND el.typarray = t.oid)\n");
535 appendPQExpBuffer(&buf, " AND t.typname !~ '^_'\n");
537 if (!showSystem && !pattern)
538 appendPQExpBuffer(&buf, " AND n.nspname <> 'pg_catalog'\n"
539 " AND n.nspname <> 'information_schema'\n");
541 /* Match name pattern against either internal or external name */
542 processSQLNamePattern(pset.db, &buf, pattern, true, false,
543 "n.nspname", "t.typname",
544 "pg_catalog.format_type(t.oid, NULL)",
545 "pg_catalog.pg_type_is_visible(t.oid)");
547 appendPQExpBuffer(&buf, "ORDER BY 1, 2;");
549 res = PSQLexec(buf.data, false);
550 termPQExpBuffer(&buf);
554 myopt.nullPrint = NULL;
555 myopt.title = _("List of data types");
556 myopt.translate_header = true;
558 printQuery(res, &myopt, pset.queryFout, pset.logfile);
568 describeOperators(const char *pattern, bool showSystem)
572 printQueryOpt myopt = pset.popt;
574 initPQExpBuffer(&buf);
577 * Note: before Postgres 9.1, we did not assign comments to any built-in
578 * operators, preferring to let the comment on the underlying function
579 * suffice. The coalesce() on the obj_description() calls below supports
580 * this convention by providing a fallback lookup of a comment on the
581 * operator's function. As of 9.1 there is a policy that every built-in
582 * operator should have a comment; so the coalesce() is no longer
583 * necessary so far as built-in operators are concerned. We keep it
584 * anyway, for now, because (1) third-party modules may still be following
585 * the old convention, and (2) we'd need to do it anyway when talking to a
589 printfPQExpBuffer(&buf,
590 "SELECT n.nspname as \"%s\",\n"
591 " o.oprname AS \"%s\",\n"
592 " CASE WHEN o.oprkind='l' THEN NULL ELSE pg_catalog.format_type(o.oprleft, NULL) END AS \"%s\",\n"
593 " CASE WHEN o.oprkind='r' THEN NULL ELSE pg_catalog.format_type(o.oprright, NULL) END AS \"%s\",\n"
594 " pg_catalog.format_type(o.oprresult, NULL) AS \"%s\",\n"
595 " coalesce(pg_catalog.obj_description(o.oid, 'pg_operator'),\n"
596 " pg_catalog.obj_description(o.oprcode, 'pg_proc')) AS \"%s\"\n"
597 "FROM pg_catalog.pg_operator o\n"
598 " LEFT JOIN pg_catalog.pg_namespace n ON n.oid = o.oprnamespace\n",
599 gettext_noop("Schema"),
600 gettext_noop("Name"),
601 gettext_noop("Left arg type"),
602 gettext_noop("Right arg type"),
603 gettext_noop("Result type"),
604 gettext_noop("Description"));
606 if (!showSystem && !pattern)
607 appendPQExpBuffer(&buf, "WHERE n.nspname <> 'pg_catalog'\n"
608 " AND n.nspname <> 'information_schema'\n");
610 processSQLNamePattern(pset.db, &buf, pattern, !showSystem && !pattern, true,
611 "n.nspname", "o.oprname", NULL,
612 "pg_catalog.pg_operator_is_visible(o.oid)");
614 appendPQExpBuffer(&buf, "ORDER BY 1, 2, 3, 4;");
616 res = PSQLexec(buf.data, false);
617 termPQExpBuffer(&buf);
621 myopt.nullPrint = NULL;
622 myopt.title = _("List of operators");
623 myopt.translate_header = true;
625 printQuery(res, &myopt, pset.queryFout, pset.logfile);
635 * for \l, \list, and -l switch
638 listAllDbs(bool verbose)
642 printQueryOpt myopt = pset.popt;
644 initPQExpBuffer(&buf);
646 printfPQExpBuffer(&buf,
647 "SELECT d.datname as \"%s\",\n"
648 " pg_catalog.pg_get_userbyid(d.datdba) as \"%s\",\n"
649 " pg_catalog.pg_encoding_to_char(d.encoding) as \"%s\",\n",
650 gettext_noop("Name"),
651 gettext_noop("Owner"),
652 gettext_noop("Encoding"));
653 if (pset.sversion >= 80400)
654 appendPQExpBuffer(&buf,
655 " d.datcollate as \"%s\",\n"
656 " d.datctype as \"%s\",\n",
657 gettext_noop("Collate"),
658 gettext_noop("Ctype"));
659 appendPQExpBuffer(&buf, " ");
660 printACLColumn(&buf, "d.datacl");
661 if (verbose && pset.sversion >= 80200)
662 appendPQExpBuffer(&buf,
663 ",\n CASE WHEN pg_catalog.has_database_privilege(d.datname, 'CONNECT')\n"
664 " THEN pg_catalog.pg_size_pretty(pg_catalog.pg_database_size(d.datname))\n"
665 " ELSE 'No Access'\n"
667 gettext_noop("Size"));
668 if (verbose && pset.sversion >= 80000)
669 appendPQExpBuffer(&buf,
670 ",\n t.spcname as \"%s\"",
671 gettext_noop("Tablespace"));
672 if (verbose && pset.sversion >= 80200)
673 appendPQExpBuffer(&buf,
674 ",\n pg_catalog.shobj_description(d.oid, 'pg_database') as \"%s\"",
675 gettext_noop("Description"));
676 appendPQExpBuffer(&buf,
677 "\nFROM pg_catalog.pg_database d\n");
678 if (verbose && pset.sversion >= 80000)
679 appendPQExpBuffer(&buf,
680 " JOIN pg_catalog.pg_tablespace t on d.dattablespace = t.oid\n");
681 appendPQExpBuffer(&buf, "ORDER BY 1;");
682 res = PSQLexec(buf.data, false);
683 termPQExpBuffer(&buf);
687 myopt.nullPrint = NULL;
688 myopt.title = _("List of databases");
689 myopt.translate_header = true;
691 printQuery(res, &myopt, pset.queryFout, pset.logfile);
699 * List Tables' Grant/Revoke Permissions
700 * \z (now also \dp -- perhaps more mnemonic)
703 permissionsList(const char *pattern)
707 printQueryOpt myopt = pset.popt;
708 static const bool translate_columns[] = {false, false, true, false, false};
710 initPQExpBuffer(&buf);
713 * we ignore indexes and toast tables since they have no meaningful rights
715 printfPQExpBuffer(&buf,
716 "SELECT n.nspname as \"%s\",\n"
717 " c.relname as \"%s\",\n"
718 " CASE c.relkind WHEN 'r' THEN '%s' WHEN 'v' THEN '%s' WHEN 'S' THEN '%s' WHEN 'f' THEN '%s' END as \"%s\",\n"
720 gettext_noop("Schema"),
721 gettext_noop("Name"),
722 gettext_noop("table"), gettext_noop("view"), gettext_noop("sequence"),
723 gettext_noop("foreign table"),
724 gettext_noop("Type"));
726 printACLColumn(&buf, "c.relacl");
728 if (pset.sversion >= 80400)
729 appendPQExpBuffer(&buf,
730 ",\n pg_catalog.array_to_string(ARRAY(\n"
731 " SELECT attname || E':\\n ' || pg_catalog.array_to_string(attacl, E'\\n ')\n"
732 " FROM pg_catalog.pg_attribute a\n"
733 " WHERE attrelid = c.oid AND NOT attisdropped AND attacl IS NOT NULL\n"
734 " ), E'\\n') AS \"%s\"",
735 gettext_noop("Column access privileges"));
737 appendPQExpBuffer(&buf, "\nFROM pg_catalog.pg_class c\n"
738 " LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace\n"
739 "WHERE c.relkind IN ('r', 'v', 'S', 'f')\n");
742 * Unless a schema pattern is specified, we suppress system and temp
743 * tables, since they normally aren't very interesting from a permissions
744 * point of view. You can see 'em by explicit request though, eg with \z
747 processSQLNamePattern(pset.db, &buf, pattern, true, false,
748 "n.nspname", "c.relname", NULL,
749 "n.nspname !~ '^pg_' AND pg_catalog.pg_table_is_visible(c.oid)");
751 appendPQExpBuffer(&buf, "ORDER BY 1, 2;");
753 res = PSQLexec(buf.data, false);
756 termPQExpBuffer(&buf);
760 myopt.nullPrint = NULL;
761 printfPQExpBuffer(&buf, _("Access privileges"));
762 myopt.title = buf.data;
763 myopt.translate_header = true;
764 myopt.translate_columns = translate_columns;
766 printQuery(res, &myopt, pset.queryFout, pset.logfile);
768 termPQExpBuffer(&buf);
777 * List DefaultACLs. The pattern can match either schema or role name.
780 listDefaultACLs(const char *pattern)
784 printQueryOpt myopt = pset.popt;
785 static const bool translate_columns[] = {false, false, true, false};
787 if (pset.sversion < 90000)
789 psql_error("The server (version %d.%d) does not support altering default privileges.\n",
790 pset.sversion / 10000, (pset.sversion / 100) % 100);
794 initPQExpBuffer(&buf);
796 printfPQExpBuffer(&buf,
797 "SELECT pg_catalog.pg_get_userbyid(d.defaclrole) AS \"%s\",\n"
798 " n.nspname AS \"%s\",\n"
799 " CASE d.defaclobjtype WHEN 'r' THEN '%s' WHEN 'S' THEN '%s' WHEN 'f' THEN '%s' END AS \"%s\",\n"
801 gettext_noop("Owner"),
802 gettext_noop("Schema"),
803 gettext_noop("table"),
804 gettext_noop("sequence"),
805 gettext_noop("function"),
806 gettext_noop("Type"));
808 printACLColumn(&buf, "d.defaclacl");
810 appendPQExpBuffer(&buf, "\nFROM pg_catalog.pg_default_acl d\n"
811 " LEFT JOIN pg_catalog.pg_namespace n ON n.oid = d.defaclnamespace\n");
813 processSQLNamePattern(pset.db, &buf, pattern, false, false,
816 "pg_catalog.pg_get_userbyid(d.defaclrole)",
819 appendPQExpBuffer(&buf, "ORDER BY 1, 2, 3;");
821 res = PSQLexec(buf.data, false);
824 termPQExpBuffer(&buf);
828 myopt.nullPrint = NULL;
829 printfPQExpBuffer(&buf, _("Default access privileges"));
830 myopt.title = buf.data;
831 myopt.translate_header = true;
832 myopt.translate_columns = translate_columns;
834 printQuery(res, &myopt, pset.queryFout, pset.logfile);
836 termPQExpBuffer(&buf);
843 * Get object comments
847 * Note: This command only lists comments for object types which do not have
848 * their comments displayed by their own backslash commands. The following
849 * types of objects will be displayed: constraint, operator class,
850 * operator family, rule, and trigger.
854 objectDescription(const char *pattern, bool showSystem)
858 printQueryOpt myopt = pset.popt;
859 static const bool translate_columns[] = {false, false, true, false};
861 initPQExpBuffer(&buf);
863 appendPQExpBuffer(&buf,
864 "SELECT DISTINCT tt.nspname AS \"%s\", tt.name AS \"%s\", tt.object AS \"%s\", d.description AS \"%s\"\n"
866 gettext_noop("Schema"),
867 gettext_noop("Name"),
868 gettext_noop("Object"),
869 gettext_noop("Description"));
871 /* Constraint descriptions */
872 appendPQExpBuffer(&buf,
873 " SELECT pgc.oid as oid, pgc.tableoid AS tableoid,\n"
874 " n.nspname as nspname,\n"
875 " CAST(pgc.conname AS pg_catalog.text) as name,"
876 " CAST('%s' AS pg_catalog.text) as object\n"
877 " FROM pg_catalog.pg_constraint pgc\n"
878 " JOIN pg_catalog.pg_class c "
879 "ON c.oid = pgc.conrelid\n"
880 " LEFT JOIN pg_catalog.pg_namespace n "
881 " ON n.oid = c.relnamespace\n",
882 gettext_noop("constraint"));
884 if (!showSystem && !pattern)
885 appendPQExpBuffer(&buf, "WHERE n.nspname <> 'pg_catalog'\n"
886 " AND n.nspname <> 'information_schema'\n");
888 processSQLNamePattern(pset.db, &buf, pattern, !showSystem && !pattern,
889 false, "n.nspname", "pgc.conname", NULL,
890 "pg_catalog.pg_table_is_visible(c.oid)");
893 * pg_opclass.opcmethod only available in 8.3+
895 if (pset.sversion >= 80300)
897 /* Operator class descriptions */
898 appendPQExpBuffer(&buf,
900 " SELECT o.oid as oid, o.tableoid as tableoid,\n"
901 " n.nspname as nspname,\n"
902 " CAST(o.opcname AS pg_catalog.text) as name,\n"
903 " CAST('%s' AS pg_catalog.text) as object\n"
904 " FROM pg_catalog.pg_opclass o\n"
905 " JOIN pg_catalog.pg_am am ON "
906 "o.opcmethod = am.oid\n"
907 " JOIN pg_catalog.pg_namespace n ON "
908 "n.oid = o.opcnamespace\n",
909 gettext_noop("operator class"));
911 if (!showSystem && !pattern)
912 appendPQExpBuffer(&buf, " AND n.nspname <> 'pg_catalog'\n"
913 " AND n.nspname <> 'information_schema'\n");
915 processSQLNamePattern(pset.db, &buf, pattern, true, false,
916 "n.nspname", "o.opcname", NULL,
917 "pg_catalog.pg_opclass_is_visible(o.oid)");
921 * although operator family comments have been around since 8.3,
922 * pg_opfamily_is_visible is only available in 9.2+
924 if (pset.sversion >= 90200)
926 /* Operator family descriptions */
927 appendPQExpBuffer(&buf,
929 " SELECT opf.oid as oid, opf.tableoid as tableoid,\n"
930 " n.nspname as nspname,\n"
931 " CAST(opf.opfname AS pg_catalog.text) AS name,\n"
932 " CAST('%s' AS pg_catalog.text) as object\n"
933 " FROM pg_catalog.pg_opfamily opf\n"
934 " JOIN pg_catalog.pg_am am "
935 "ON opf.opfmethod = am.oid\n"
936 " JOIN pg_catalog.pg_namespace n "
937 "ON opf.opfnamespace = n.oid\n",
938 gettext_noop("operator family"));
940 if (!showSystem && !pattern)
941 appendPQExpBuffer(&buf, " AND n.nspname <> 'pg_catalog'\n"
942 " AND n.nspname <> 'information_schema'\n");
944 processSQLNamePattern(pset.db, &buf, pattern, true, false,
945 "n.nspname", "opf.opfname", NULL,
946 "pg_catalog.pg_opfamily_is_visible(opf.oid)");
949 /* Rule descriptions (ignore rules for views) */
950 appendPQExpBuffer(&buf,
952 " SELECT r.oid as oid, r.tableoid as tableoid,\n"
953 " n.nspname as nspname,\n"
954 " CAST(r.rulename AS pg_catalog.text) as name,"
955 " CAST('%s' AS pg_catalog.text) as object\n"
956 " FROM pg_catalog.pg_rewrite r\n"
957 " JOIN pg_catalog.pg_class c ON c.oid = r.ev_class\n"
958 " LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace\n"
959 " WHERE r.rulename != '_RETURN'\n",
960 gettext_noop("rule"));
962 if (!showSystem && !pattern)
963 appendPQExpBuffer(&buf, " AND n.nspname <> 'pg_catalog'\n"
964 " AND n.nspname <> 'information_schema'\n");
966 processSQLNamePattern(pset.db, &buf, pattern, true, false,
967 "n.nspname", "r.rulename", NULL,
968 "pg_catalog.pg_table_is_visible(c.oid)");
970 /* Trigger descriptions */
971 appendPQExpBuffer(&buf,
973 " SELECT t.oid as oid, t.tableoid as tableoid,\n"
974 " n.nspname as nspname,\n"
975 " CAST(t.tgname AS pg_catalog.text) as name,"
976 " CAST('%s' AS pg_catalog.text) as object\n"
977 " FROM pg_catalog.pg_trigger t\n"
978 " JOIN pg_catalog.pg_class c ON c.oid = t.tgrelid\n"
979 " LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace\n",
980 gettext_noop("trigger"));
982 if (!showSystem && !pattern)
983 appendPQExpBuffer(&buf, "WHERE n.nspname <> 'pg_catalog'\n"
984 " AND n.nspname <> 'information_schema'\n");
986 processSQLNamePattern(pset.db, &buf, pattern, !showSystem && !pattern, false,
987 "n.nspname", "t.tgname", NULL,
988 "pg_catalog.pg_table_is_visible(c.oid)");
990 appendPQExpBuffer(&buf,
992 " JOIN pg_catalog.pg_description d ON (tt.oid = d.objoid AND tt.tableoid = d.classoid AND d.objsubid = 0)\n");
994 appendPQExpBuffer(&buf, "ORDER BY 1, 2, 3;");
996 res = PSQLexec(buf.data, false);
997 termPQExpBuffer(&buf);
1001 myopt.nullPrint = NULL;
1002 myopt.title = _("Object descriptions");
1003 myopt.translate_header = true;
1004 myopt.translate_columns = translate_columns;
1006 printQuery(res, &myopt, pset.queryFout, pset.logfile);
1014 * describeTableDetails (for \d)
1016 * This routine finds the tables to be displayed, and calls
1017 * describeOneTableDetails for each one.
1019 * verbose: if true, this is \d+
1022 describeTableDetails(const char *pattern, bool verbose, bool showSystem)
1024 PQExpBufferData buf;
1028 initPQExpBuffer(&buf);
1030 printfPQExpBuffer(&buf,
1034 "FROM pg_catalog.pg_class c\n"
1035 " LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace\n");
1037 if (!showSystem && !pattern)
1038 appendPQExpBuffer(&buf, "WHERE n.nspname <> 'pg_catalog'\n"
1039 " AND n.nspname <> 'information_schema'\n");
1041 processSQLNamePattern(pset.db, &buf, pattern, !showSystem && !pattern, false,
1042 "n.nspname", "c.relname", NULL,
1043 "pg_catalog.pg_table_is_visible(c.oid)");
1045 appendPQExpBuffer(&buf, "ORDER BY 2, 3;");
1047 res = PSQLexec(buf.data, false);
1048 termPQExpBuffer(&buf);
1052 if (PQntuples(res) == 0)
1055 psql_error("Did not find any relation named \"%s\".\n",
1061 for (i = 0; i < PQntuples(res); i++)
1064 const char *nspname;
1065 const char *relname;
1067 oid = PQgetvalue(res, i, 0);
1068 nspname = PQgetvalue(res, i, 1);
1069 relname = PQgetvalue(res, i, 2);
1071 if (!describeOneTableDetails(nspname, relname, oid, verbose))
1088 * describeOneTableDetails (for \d)
1090 * Unfortunately, the information presented here is so complicated that it
1091 * cannot be done in a single query. So we have to assemble the printed table
1092 * by hand and pass it to the underlying printTable() function.
1095 describeOneTableDetails(const char *schemaname,
1096 const char *relationname,
1100 PQExpBufferData buf;
1101 PGresult *res = NULL;
1102 printTableOpt myopt = pset.popt.topt;
1103 printTableContent cont;
1104 bool printTableInitialized = false;
1106 char *view_def = NULL;
1108 char **seq_values = NULL;
1109 char **modifiers = NULL;
1111 PQExpBufferData title;
1112 PQExpBufferData tmpbuf;
1126 char relpersistence;
1128 bool show_modifiers = false;
1133 myopt.default_footer = false;
1134 /* This output looks confusing in expanded mode. */
1135 myopt.expanded = false;
1137 initPQExpBuffer(&buf);
1138 initPQExpBuffer(&title);
1139 initPQExpBuffer(&tmpbuf);
1141 /* Get general table info */
1142 if (pset.sversion >= 90100)
1144 printfPQExpBuffer(&buf,
1145 "SELECT c.relchecks, c.relkind, c.relhasindex, c.relhasrules, "
1146 "c.relhastriggers, c.relhasoids, "
1147 "%s, c.reltablespace, "
1148 "CASE WHEN c.reloftype = 0 THEN '' ELSE c.reloftype::pg_catalog.regtype::pg_catalog.text END, "
1149 "c.relpersistence\n"
1150 "FROM pg_catalog.pg_class c\n "
1151 "LEFT JOIN pg_catalog.pg_class tc ON (c.reltoastrelid = tc.oid)\n"
1152 "WHERE c.oid = '%s';",
1154 "pg_catalog.array_to_string(c.reloptions || "
1155 "array(select 'toast.' || x from pg_catalog.unnest(tc.reloptions) x), ', ')\n"
1159 else if (pset.sversion >= 90000)
1161 printfPQExpBuffer(&buf,
1162 "SELECT c.relchecks, c.relkind, c.relhasindex, c.relhasrules, "
1163 "c.relhastriggers, c.relhasoids, "
1164 "%s, c.reltablespace, "
1165 "CASE WHEN c.reloftype = 0 THEN '' ELSE c.reloftype::pg_catalog.regtype::pg_catalog.text END\n"
1166 "FROM pg_catalog.pg_class c\n "
1167 "LEFT JOIN pg_catalog.pg_class tc ON (c.reltoastrelid = tc.oid)\n"
1168 "WHERE c.oid = '%s';",
1170 "pg_catalog.array_to_string(c.reloptions || "
1171 "array(select 'toast.' || x from pg_catalog.unnest(tc.reloptions) x), ', ')\n"
1175 else if (pset.sversion >= 80400)
1177 printfPQExpBuffer(&buf,
1178 "SELECT c.relchecks, c.relkind, c.relhasindex, c.relhasrules, "
1179 "c.relhastriggers, c.relhasoids, "
1180 "%s, c.reltablespace\n"
1181 "FROM pg_catalog.pg_class c\n "
1182 "LEFT JOIN pg_catalog.pg_class tc ON (c.reltoastrelid = tc.oid)\n"
1183 "WHERE c.oid = '%s';",
1185 "pg_catalog.array_to_string(c.reloptions || "
1186 "array(select 'toast.' || x from pg_catalog.unnest(tc.reloptions) x), ', ')\n"
1190 else if (pset.sversion >= 80200)
1192 printfPQExpBuffer(&buf,
1193 "SELECT relchecks, relkind, relhasindex, relhasrules, "
1194 "reltriggers <> 0, relhasoids, "
1195 "%s, reltablespace\n"
1196 "FROM pg_catalog.pg_class WHERE oid = '%s';",
1198 "pg_catalog.array_to_string(reloptions, E', ')" : "''"),
1201 else if (pset.sversion >= 80000)
1203 printfPQExpBuffer(&buf,
1204 "SELECT relchecks, relkind, relhasindex, relhasrules, "
1205 "reltriggers <> 0, relhasoids, "
1206 "'', reltablespace\n"
1207 "FROM pg_catalog.pg_class WHERE oid = '%s';",
1212 printfPQExpBuffer(&buf,
1213 "SELECT relchecks, relkind, relhasindex, relhasrules, "
1214 "reltriggers <> 0, relhasoids, "
1216 "FROM pg_catalog.pg_class WHERE oid = '%s';",
1220 res = PSQLexec(buf.data, false);
1224 /* Did we get anything? */
1225 if (PQntuples(res) == 0)
1228 psql_error("Did not find any relation with OID %s.\n", oid);
1232 tableinfo.checks = atoi(PQgetvalue(res, 0, 0));
1233 tableinfo.relkind = *(PQgetvalue(res, 0, 1));
1234 tableinfo.hasindex = strcmp(PQgetvalue(res, 0, 2), "t") == 0;
1235 tableinfo.hasrules = strcmp(PQgetvalue(res, 0, 3), "t") == 0;
1236 tableinfo.hastriggers = strcmp(PQgetvalue(res, 0, 4), "t") == 0;
1237 tableinfo.hasoids = strcmp(PQgetvalue(res, 0, 5), "t") == 0;
1238 tableinfo.reloptions = (pset.sversion >= 80200) ?
1239 strdup(PQgetvalue(res, 0, 6)) : NULL;
1240 tableinfo.tablespace = (pset.sversion >= 80000) ?
1241 atooid(PQgetvalue(res, 0, 7)) : 0;
1242 tableinfo.reloftype = (pset.sversion >= 90000 &&
1243 strcmp(PQgetvalue(res, 0, 8), "") != 0) ?
1244 strdup(PQgetvalue(res, 0, 8)) : NULL;
1245 tableinfo.relpersistence = (pset.sversion >= 90100) ?
1246 *(PQgetvalue(res, 0, 9)) : 0;
1251 * If it's a sequence, fetch its values and store into an array that will
1254 if (tableinfo.relkind == 'S')
1256 printfPQExpBuffer(&buf, "SELECT * FROM %s", fmtId(schemaname));
1257 /* must be separate because fmtId isn't reentrant */
1258 appendPQExpBuffer(&buf, ".%s;", fmtId(relationname));
1260 res = PSQLexec(buf.data, false);
1264 seq_values = pg_malloc((PQnfields(res) + 1) * sizeof(*seq_values));
1266 for (i = 0; i < PQnfields(res); i++)
1267 seq_values[i] = pg_strdup(PQgetvalue(res, 0, i));
1268 seq_values[i] = NULL;
1277 * You need to modify value of "firstvcol" which will be defined below if
1278 * you are adding column(s) preceding to verbose-only columns.
1280 printfPQExpBuffer(&buf, "SELECT a.attname,");
1281 appendPQExpBuffer(&buf, "\n pg_catalog.format_type(a.atttypid, a.atttypmod),"
1282 "\n (SELECT substring(pg_catalog.pg_get_expr(d.adbin, d.adrelid) for 128)"
1283 "\n FROM pg_catalog.pg_attrdef d"
1284 "\n WHERE d.adrelid = a.attrelid AND d.adnum = a.attnum AND a.atthasdef),"
1285 "\n a.attnotnull, a.attnum,");
1286 if (pset.sversion >= 90100)
1287 appendPQExpBuffer(&buf, "\n (SELECT c.collname FROM pg_catalog.pg_collation c, pg_catalog.pg_type t\n"
1288 " WHERE c.oid = a.attcollation AND t.oid = a.atttypid AND a.attcollation <> t.typcollation) AS attcollation");
1290 appendPQExpBuffer(&buf, "\n NULL AS attcollation");
1291 if (tableinfo.relkind == 'i')
1292 appendPQExpBuffer(&buf, ",\n pg_catalog.pg_get_indexdef(a.attrelid, a.attnum, TRUE) AS indexdef");
1294 appendPQExpBuffer(&buf, ",\n NULL AS indexdef");
1295 if (tableinfo.relkind == 'f' && pset.sversion >= 90200)
1296 appendPQExpBuffer(&buf, ",\n CASE WHEN attfdwoptions IS NULL THEN '' ELSE "
1297 " '(' || array_to_string(ARRAY(SELECT quote_ident(option_name) || ' ' || quote_literal(option_value) FROM "
1298 " pg_options_to_table(attfdwoptions)), ', ') || ')' END AS attfdwoptions");
1300 appendPQExpBuffer(&buf, ",\n NULL AS attfdwoptions");
1303 appendPQExpBuffer(&buf, ",\n a.attstorage");
1304 appendPQExpBuffer(&buf, ",\n CASE WHEN a.attstattarget=-1 THEN NULL ELSE a.attstattarget END AS attstattarget");
1307 * In 9.0+, we have column comments for: relations, views, composite
1308 * types, and foreign tables (c.f. CommentObject() in comment.c).
1310 if (tableinfo.relkind == 'r' || tableinfo.relkind == 'v' ||
1311 tableinfo.relkind == 'f' || tableinfo.relkind == 'c')
1312 appendPQExpBuffer(&buf, ", pg_catalog.col_description(a.attrelid, a.attnum)");
1315 appendPQExpBuffer(&buf, "\nFROM pg_catalog.pg_attribute a");
1316 appendPQExpBuffer(&buf, "\nWHERE a.attrelid = '%s' AND a.attnum > 0 AND NOT a.attisdropped", oid);
1317 appendPQExpBuffer(&buf, "\nORDER BY a.attnum;");
1319 res = PSQLexec(buf.data, false);
1322 numrows = PQntuples(res);
1325 switch (tableinfo.relkind)
1328 if (tableinfo.relpersistence == 'u')
1329 printfPQExpBuffer(&title, _("Unlogged table \"%s.%s\""),
1330 schemaname, relationname);
1332 printfPQExpBuffer(&title, _("Table \"%s.%s\""),
1333 schemaname, relationname);
1336 printfPQExpBuffer(&title, _("View \"%s.%s\""),
1337 schemaname, relationname);
1340 printfPQExpBuffer(&title, _("Sequence \"%s.%s\""),
1341 schemaname, relationname);
1344 if (tableinfo.relpersistence == 'u')
1345 printfPQExpBuffer(&title, _("Unlogged index \"%s.%s\""),
1346 schemaname, relationname);
1348 printfPQExpBuffer(&title, _("Index \"%s.%s\""),
1349 schemaname, relationname);
1352 /* not used as of 8.2, but keep it for backwards compatibility */
1353 printfPQExpBuffer(&title, _("Special relation \"%s.%s\""),
1354 schemaname, relationname);
1357 printfPQExpBuffer(&title, _("TOAST table \"%s.%s\""),
1358 schemaname, relationname);
1361 printfPQExpBuffer(&title, _("Composite type \"%s.%s\""),
1362 schemaname, relationname);
1365 printfPQExpBuffer(&title, _("Foreign table \"%s.%s\""),
1366 schemaname, relationname);
1369 /* untranslated unknown relkind */
1370 printfPQExpBuffer(&title, "?%c? \"%s.%s\"",
1371 tableinfo.relkind, schemaname, relationname);
1375 /* Set the number of columns, and their names */
1376 headers[0] = gettext_noop("Column");
1377 headers[1] = gettext_noop("Type");
1380 if (tableinfo.relkind == 'r' || tableinfo.relkind == 'v' ||
1381 tableinfo.relkind == 'f' || tableinfo.relkind == 'c')
1383 show_modifiers = true;
1384 headers[cols++] = gettext_noop("Modifiers");
1385 modifiers = pg_malloc_zero((numrows + 1) * sizeof(*modifiers));
1388 if (tableinfo.relkind == 'S')
1389 headers[cols++] = gettext_noop("Value");
1391 if (tableinfo.relkind == 'i')
1392 headers[cols++] = gettext_noop("Definition");
1394 if (tableinfo.relkind == 'f' && pset.sversion >= 90200)
1395 headers[cols++] = gettext_noop("FDW Options");
1399 headers[cols++] = gettext_noop("Storage");
1400 if (tableinfo.relkind == 'r' || tableinfo.relkind == 'f')
1401 headers[cols++] = gettext_noop("Stats target");
1402 /* Column comments, if the relkind supports this feature. */
1403 if (tableinfo.relkind == 'r' || tableinfo.relkind == 'v' ||
1404 tableinfo.relkind == 'c' || tableinfo.relkind == 'f')
1405 headers[cols++] = gettext_noop("Description");
1408 printTableInit(&cont, &myopt, title.data, cols, numrows);
1409 printTableInitialized = true;
1411 for (i = 0; i < cols; i++)
1412 printTableAddHeader(&cont, headers[i], true, 'l');
1414 /* Check if table is a view */
1415 if (tableinfo.relkind == 'v' && verbose)
1419 printfPQExpBuffer(&buf,
1420 "SELECT pg_catalog.pg_get_viewdef('%s'::pg_catalog.oid, true);",
1422 result = PSQLexec(buf.data, false);
1426 if (PQntuples(result) > 0)
1427 view_def = pg_strdup(PQgetvalue(result, 0, 0));
1432 /* Generate table cells to be printed */
1433 for (i = 0; i < numrows; i++)
1436 printTableAddCell(&cont, PQgetvalue(res, i, 0), false, false);
1439 printTableAddCell(&cont, PQgetvalue(res, i, 1), false, false);
1441 /* Modifiers: collate, not null, default */
1444 resetPQExpBuffer(&tmpbuf);
1446 if (!PQgetisnull(res, i, 5))
1449 appendPQExpBufferStr(&tmpbuf, " ");
1450 appendPQExpBuffer(&tmpbuf, _("collate %s"),
1451 PQgetvalue(res, i, 5));
1454 if (strcmp(PQgetvalue(res, i, 3), "t") == 0)
1457 appendPQExpBufferStr(&tmpbuf, " ");
1458 appendPQExpBufferStr(&tmpbuf, _("not null"));
1461 /* handle "default" here */
1462 /* (note: above we cut off the 'default' string at 128) */
1463 if (strlen(PQgetvalue(res, i, 2)) != 0)
1466 appendPQExpBufferStr(&tmpbuf, " ");
1467 /* translator: default values of column definitions */
1468 appendPQExpBuffer(&tmpbuf, _("default %s"),
1469 PQgetvalue(res, i, 2));
1472 modifiers[i] = pg_strdup(tmpbuf.data);
1473 printTableAddCell(&cont, modifiers[i], false, false);
1476 /* Value: for sequences only */
1477 if (tableinfo.relkind == 'S')
1478 printTableAddCell(&cont, seq_values[i], false, false);
1480 /* Expression for index column */
1481 if (tableinfo.relkind == 'i')
1482 printTableAddCell(&cont, PQgetvalue(res, i, 6), false, false);
1484 /* FDW options for foreign table column, only for 9.2 or later */
1485 if (tableinfo.relkind == 'f' && pset.sversion >= 90200)
1486 printTableAddCell(&cont, PQgetvalue(res, i, 7), false, false);
1488 /* Storage and Description */
1492 char *storage = PQgetvalue(res, i, firstvcol);
1494 /* these strings are literal in our syntax, so not translated. */
1495 printTableAddCell(&cont, (storage[0] == 'p' ? "plain" :
1496 (storage[0] == 'm' ? "main" :
1497 (storage[0] == 'x' ? "extended" :
1498 (storage[0] == 'e' ? "external" :
1502 /* Statistics target, if the relkind supports this feature */
1503 if (tableinfo.relkind == 'r' || tableinfo.relkind == 'f')
1505 printTableAddCell(&cont, PQgetvalue(res, i, firstvcol + 1),
1509 /* Column comments, if the relkind supports this feature. */
1510 if (tableinfo.relkind == 'r' || tableinfo.relkind == 'v' ||
1511 tableinfo.relkind == 'c' || tableinfo.relkind == 'f')
1512 printTableAddCell(&cont, PQgetvalue(res, i, firstvcol + 2),
1518 if (tableinfo.relkind == 'i')
1520 /* Footer information about an index */
1523 printfPQExpBuffer(&buf,
1524 "SELECT i.indisunique, i.indisprimary, i.indisclustered, ");
1525 if (pset.sversion >= 80200)
1526 appendPQExpBuffer(&buf, "i.indisvalid,\n");
1528 appendPQExpBuffer(&buf, "true AS indisvalid,\n");
1529 if (pset.sversion >= 90000)
1530 appendPQExpBuffer(&buf,
1531 " (NOT i.indimmediate) AND "
1532 "EXISTS (SELECT 1 FROM pg_catalog.pg_constraint "
1533 "WHERE conrelid = i.indrelid AND "
1534 "conindid = i.indexrelid AND "
1535 "contype IN ('p','u','x') AND "
1536 "condeferrable) AS condeferrable,\n"
1537 " (NOT i.indimmediate) AND "
1538 "EXISTS (SELECT 1 FROM pg_catalog.pg_constraint "
1539 "WHERE conrelid = i.indrelid AND "
1540 "conindid = i.indexrelid AND "
1541 "contype IN ('p','u','x') AND "
1542 "condeferred) AS condeferred,\n");
1544 appendPQExpBuffer(&buf,
1545 " false AS condeferrable, false AS condeferred,\n");
1546 appendPQExpBuffer(&buf, " a.amname, c2.relname, "
1547 "pg_catalog.pg_get_expr(i.indpred, i.indrelid, true)\n"
1548 "FROM pg_catalog.pg_index i, pg_catalog.pg_class c, pg_catalog.pg_class c2, pg_catalog.pg_am a\n"
1549 "WHERE i.indexrelid = c.oid AND c.oid = '%s' AND c.relam = a.oid\n"
1550 "AND i.indrelid = c2.oid;",
1553 result = PSQLexec(buf.data, false);
1556 else if (PQntuples(result) != 1)
1563 char *indisunique = PQgetvalue(result, 0, 0);
1564 char *indisprimary = PQgetvalue(result, 0, 1);
1565 char *indisclustered = PQgetvalue(result, 0, 2);
1566 char *indisvalid = PQgetvalue(result, 0, 3);
1567 char *deferrable = PQgetvalue(result, 0, 4);
1568 char *deferred = PQgetvalue(result, 0, 5);
1569 char *indamname = PQgetvalue(result, 0, 6);
1570 char *indtable = PQgetvalue(result, 0, 7);
1571 char *indpred = PQgetvalue(result, 0, 8);
1573 if (strcmp(indisprimary, "t") == 0)
1574 printfPQExpBuffer(&tmpbuf, _("primary key, "));
1575 else if (strcmp(indisunique, "t") == 0)
1576 printfPQExpBuffer(&tmpbuf, _("unique, "));
1578 resetPQExpBuffer(&tmpbuf);
1579 appendPQExpBuffer(&tmpbuf, "%s, ", indamname);
1581 /* we assume here that index and table are in same schema */
1582 appendPQExpBuffer(&tmpbuf, _("for table \"%s.%s\""),
1583 schemaname, indtable);
1585 if (strlen(indpred))
1586 appendPQExpBuffer(&tmpbuf, _(", predicate (%s)"), indpred);
1588 if (strcmp(indisclustered, "t") == 0)
1589 appendPQExpBuffer(&tmpbuf, _(", clustered"));
1591 if (strcmp(indisvalid, "t") != 0)
1592 appendPQExpBuffer(&tmpbuf, _(", invalid"));
1594 if (strcmp(deferrable, "t") == 0)
1595 appendPQExpBuffer(&tmpbuf, _(", deferrable"));
1597 if (strcmp(deferred, "t") == 0)
1598 appendPQExpBuffer(&tmpbuf, _(", initially deferred"));
1600 printTableAddFooter(&cont, tmpbuf.data);
1601 add_tablespace_footer(&cont, tableinfo.relkind,
1602 tableinfo.tablespace, true);
1609 PGresult *result = NULL;
1611 /* Footer information about a view */
1612 printTableAddFooter(&cont, _("View definition:"));
1613 printTableAddFooter(&cont, view_def);
1616 if (tableinfo.hasrules)
1618 printfPQExpBuffer(&buf,
1619 "SELECT r.rulename, trim(trailing ';' from pg_catalog.pg_get_ruledef(r.oid, true))\n"
1620 "FROM pg_catalog.pg_rewrite r\n"
1621 "WHERE r.ev_class = '%s' AND r.rulename != '_RETURN' ORDER BY 1;",
1623 result = PSQLexec(buf.data, false);
1627 if (PQntuples(result) > 0)
1629 printTableAddFooter(&cont, _("Rules:"));
1630 for (i = 0; i < PQntuples(result); i++)
1632 const char *ruledef;
1634 /* Everything after "CREATE RULE" is echoed verbatim */
1635 ruledef = PQgetvalue(result, i, 1);
1638 printfPQExpBuffer(&buf, " %s", ruledef);
1639 printTableAddFooter(&cont, buf.data);
1645 else if (tableinfo.relkind == 'S')
1647 /* Footer information about a sequence */
1648 PGresult *result = NULL;
1650 /* Get the column that owns this sequence */
1651 printfPQExpBuffer(&buf, "SELECT pg_catalog.quote_ident(nspname) || '.' ||"
1652 "\n pg_catalog.quote_ident(relname) || '.' ||"
1653 "\n pg_catalog.quote_ident(attname)"
1654 "\nFROM pg_catalog.pg_class c"
1655 "\nINNER JOIN pg_catalog.pg_depend d ON c.oid=d.refobjid"
1656 "\nINNER JOIN pg_catalog.pg_namespace n ON n.oid=c.relnamespace"
1657 "\nINNER JOIN pg_catalog.pg_attribute a ON ("
1658 "\n a.attrelid=c.oid AND"
1659 "\n a.attnum=d.refobjsubid)"
1660 "\nWHERE d.classid='pg_catalog.pg_class'::pg_catalog.regclass"
1661 "\n AND d.refclassid='pg_catalog.pg_class'::pg_catalog.regclass"
1663 "\n AND d.deptype='a'",
1666 result = PSQLexec(buf.data, false);
1669 else if (PQntuples(result) == 1)
1671 printfPQExpBuffer(&buf, _("Owned by: %s"),
1672 PQgetvalue(result, 0, 0));
1673 printTableAddFooter(&cont, buf.data);
1677 * If we get no rows back, don't show anything (obviously). We should
1678 * never get more than one row back, but if we do, just ignore it and
1679 * don't print anything.
1683 else if (tableinfo.relkind == 'r' || tableinfo.relkind == 'f')
1685 /* Footer information about a table */
1686 PGresult *result = NULL;
1690 if (tableinfo.hasindex)
1692 printfPQExpBuffer(&buf,
1693 "SELECT c2.relname, i.indisprimary, i.indisunique, i.indisclustered, ");
1694 if (pset.sversion >= 80200)
1695 appendPQExpBuffer(&buf, "i.indisvalid, ");
1697 appendPQExpBuffer(&buf, "true as indisvalid, ");
1698 appendPQExpBuffer(&buf, "pg_catalog.pg_get_indexdef(i.indexrelid, 0, true),\n ");
1699 if (pset.sversion >= 90000)
1700 appendPQExpBuffer(&buf,
1701 "pg_catalog.pg_get_constraintdef(con.oid, true), "
1702 "contype, condeferrable, condeferred");
1704 appendPQExpBuffer(&buf,
1705 "null AS constraintdef, null AS contype, "
1706 "false AS condeferrable, false AS condeferred");
1707 if (pset.sversion >= 80000)
1708 appendPQExpBuffer(&buf, ", c2.reltablespace");
1709 appendPQExpBuffer(&buf,
1710 "\nFROM pg_catalog.pg_class c, pg_catalog.pg_class c2, pg_catalog.pg_index i\n");
1711 if (pset.sversion >= 90000)
1712 appendPQExpBuffer(&buf,
1713 " LEFT JOIN pg_catalog.pg_constraint con ON (conrelid = i.indrelid AND conindid = i.indexrelid AND contype IN ('p','u','x'))\n");
1714 appendPQExpBuffer(&buf,
1715 "WHERE c.oid = '%s' AND c.oid = i.indrelid AND i.indexrelid = c2.oid\n"
1716 "ORDER BY i.indisprimary DESC, i.indisunique DESC, c2.relname;",
1718 result = PSQLexec(buf.data, false);
1722 tuples = PQntuples(result);
1726 printTableAddFooter(&cont, _("Indexes:"));
1727 for (i = 0; i < tuples; i++)
1729 /* untranslated index name */
1730 printfPQExpBuffer(&buf, " \"%s\"",
1731 PQgetvalue(result, i, 0));
1733 /* If exclusion constraint, print the constraintdef */
1734 if (strcmp(PQgetvalue(result, i, 7), "x") == 0)
1736 appendPQExpBuffer(&buf, " %s",
1737 PQgetvalue(result, i, 6));
1741 const char *indexdef;
1742 const char *usingpos;
1744 /* Label as primary key or unique (but not both) */
1745 if (strcmp(PQgetvalue(result, i, 1), "t") == 0)
1746 appendPQExpBuffer(&buf, " PRIMARY KEY,");
1747 else if (strcmp(PQgetvalue(result, i, 2), "t") == 0)
1749 if (strcmp(PQgetvalue(result, i, 7), "u") == 0)
1750 appendPQExpBuffer(&buf, " UNIQUE CONSTRAINT,");
1752 appendPQExpBuffer(&buf, " UNIQUE,");
1755 /* Everything after "USING" is echoed verbatim */
1756 indexdef = PQgetvalue(result, i, 5);
1757 usingpos = strstr(indexdef, " USING ");
1759 indexdef = usingpos + 7;
1760 appendPQExpBuffer(&buf, " %s", indexdef);
1762 /* Need these for deferrable PK/UNIQUE indexes */
1763 if (strcmp(PQgetvalue(result, i, 8), "t") == 0)
1764 appendPQExpBuffer(&buf, " DEFERRABLE");
1766 if (strcmp(PQgetvalue(result, i, 9), "t") == 0)
1767 appendPQExpBuffer(&buf, " INITIALLY DEFERRED");
1770 /* Add these for all cases */
1771 if (strcmp(PQgetvalue(result, i, 3), "t") == 0)
1772 appendPQExpBuffer(&buf, " CLUSTER");
1774 if (strcmp(PQgetvalue(result, i, 4), "t") != 0)
1775 appendPQExpBuffer(&buf, " INVALID");
1777 printTableAddFooter(&cont, buf.data);
1779 /* Print tablespace of the index on the same line */
1780 if (pset.sversion >= 80000)
1781 add_tablespace_footer(&cont, 'i',
1782 atooid(PQgetvalue(result, i, 10)),
1789 /* print table (and column) check constraints */
1790 if (tableinfo.checks)
1792 printfPQExpBuffer(&buf,
1793 "SELECT r.conname, "
1794 "pg_catalog.pg_get_constraintdef(r.oid, true)\n"
1795 "FROM pg_catalog.pg_constraint r\n"
1796 "WHERE r.conrelid = '%s' AND r.contype = 'c'\n"
1799 result = PSQLexec(buf.data, false);
1803 tuples = PQntuples(result);
1807 printTableAddFooter(&cont, _("Check constraints:"));
1808 for (i = 0; i < tuples; i++)
1810 /* untranslated contraint name and def */
1811 printfPQExpBuffer(&buf, " \"%s\" %s",
1812 PQgetvalue(result, i, 0),
1813 PQgetvalue(result, i, 1));
1815 printTableAddFooter(&cont, buf.data);
1821 /* print foreign-key constraints (there are none if no triggers) */
1822 if (tableinfo.hastriggers)
1824 printfPQExpBuffer(&buf,
1826 " pg_catalog.pg_get_constraintdef(r.oid, true) as condef\n"
1827 "FROM pg_catalog.pg_constraint r\n"
1828 "WHERE r.conrelid = '%s' AND r.contype = 'f' ORDER BY 1;",
1830 result = PSQLexec(buf.data, false);
1834 tuples = PQntuples(result);
1838 printTableAddFooter(&cont, _("Foreign-key constraints:"));
1839 for (i = 0; i < tuples; i++)
1841 /* untranslated constraint name and def */
1842 printfPQExpBuffer(&buf, " \"%s\" %s",
1843 PQgetvalue(result, i, 0),
1844 PQgetvalue(result, i, 1));
1846 printTableAddFooter(&cont, buf.data);
1852 /* print incoming foreign-key references (none if no triggers) */
1853 if (tableinfo.hastriggers)
1855 printfPQExpBuffer(&buf,
1856 "SELECT conname, conrelid::pg_catalog.regclass,\n"
1857 " pg_catalog.pg_get_constraintdef(c.oid, true) as condef\n"
1858 "FROM pg_catalog.pg_constraint c\n"
1859 "WHERE c.confrelid = '%s' AND c.contype = 'f' ORDER BY 1;",
1861 result = PSQLexec(buf.data, false);
1865 tuples = PQntuples(result);
1869 printTableAddFooter(&cont, _("Referenced by:"));
1870 for (i = 0; i < tuples; i++)
1872 printfPQExpBuffer(&buf, " TABLE \"%s\" CONSTRAINT \"%s\" %s",
1873 PQgetvalue(result, i, 1),
1874 PQgetvalue(result, i, 0),
1875 PQgetvalue(result, i, 2));
1877 printTableAddFooter(&cont, buf.data);
1884 if (tableinfo.hasrules)
1886 if (pset.sversion >= 80300)
1888 printfPQExpBuffer(&buf,
1889 "SELECT r.rulename, trim(trailing ';' from pg_catalog.pg_get_ruledef(r.oid, true)), "
1891 "FROM pg_catalog.pg_rewrite r\n"
1892 "WHERE r.ev_class = '%s' ORDER BY 1;",
1897 printfPQExpBuffer(&buf,
1898 "SELECT r.rulename, trim(trailing ';' from pg_catalog.pg_get_ruledef(r.oid, true)), "
1899 "'O'::char AS ev_enabled\n"
1900 "FROM pg_catalog.pg_rewrite r\n"
1901 "WHERE r.ev_class = '%s' ORDER BY 1;",
1904 result = PSQLexec(buf.data, false);
1908 tuples = PQntuples(result);
1915 for (category = 0; category < 4; category++)
1917 have_heading = false;
1919 for (i = 0; i < tuples; i++)
1921 const char *ruledef;
1922 bool list_rule = false;
1927 if (*PQgetvalue(result, i, 2) == 'O')
1931 if (*PQgetvalue(result, i, 2) == 'D')
1935 if (*PQgetvalue(result, i, 2) == 'A')
1939 if (*PQgetvalue(result, i, 2) == 'R')
1951 printfPQExpBuffer(&buf, _("Rules:"));
1954 printfPQExpBuffer(&buf, _("Disabled rules:"));
1957 printfPQExpBuffer(&buf, _("Rules firing always:"));
1960 printfPQExpBuffer(&buf, _("Rules firing on replica only:"));
1963 printTableAddFooter(&cont, buf.data);
1964 have_heading = true;
1967 /* Everything after "CREATE RULE" is echoed verbatim */
1968 ruledef = PQgetvalue(result, i, 1);
1970 printfPQExpBuffer(&buf, " %s", ruledef);
1971 printTableAddFooter(&cont, buf.data);
1980 * Print triggers next, if any (but only user-defined triggers). This
1981 * could apply to either a table or a view.
1983 if (tableinfo.hastriggers)
1988 printfPQExpBuffer(&buf,
1990 "pg_catalog.pg_get_triggerdef(t.oid%s), "
1992 "FROM pg_catalog.pg_trigger t\n"
1993 "WHERE t.tgrelid = '%s' AND ",
1994 (pset.sversion >= 90000 ? ", true" : ""),
1996 if (pset.sversion >= 90000)
1997 appendPQExpBuffer(&buf, "NOT t.tgisinternal");
1998 else if (pset.sversion >= 80300)
1999 appendPQExpBuffer(&buf, "t.tgconstraint = 0");
2001 appendPQExpBuffer(&buf,
2002 "(NOT tgisconstraint "
2004 " (SELECT 1 FROM pg_catalog.pg_depend d "
2005 " JOIN pg_catalog.pg_constraint c ON (d.refclassid = c.tableoid AND d.refobjid = c.oid) "
2006 " WHERE d.classid = t.tableoid AND d.objid = t.oid AND d.deptype = 'i' AND c.contype = 'f'))");
2007 appendPQExpBuffer(&buf, "\nORDER BY 1;");
2009 result = PSQLexec(buf.data, false);
2013 tuples = PQntuples(result);
2021 * split the output into 4 different categories. Enabled triggers,
2022 * disabled triggers and the two special ALWAYS and REPLICA
2025 for (category = 0; category < 4; category++)
2027 have_heading = false;
2028 for (i = 0; i < tuples; i++)
2032 const char *usingpos;
2033 const char *tgenabled;
2036 * Check if this trigger falls into the current category
2038 tgenabled = PQgetvalue(result, i, 2);
2039 list_trigger = false;
2043 if (*tgenabled == 'O' || *tgenabled == 't')
2044 list_trigger = true;
2047 if (*tgenabled == 'D' || *tgenabled == 'f')
2048 list_trigger = true;
2051 if (*tgenabled == 'A')
2052 list_trigger = true;
2055 if (*tgenabled == 'R')
2056 list_trigger = true;
2059 if (list_trigger == false)
2062 /* Print the category heading once */
2063 if (have_heading == false)
2068 printfPQExpBuffer(&buf, _("Triggers:"));
2071 printfPQExpBuffer(&buf, _("Disabled triggers:"));
2074 printfPQExpBuffer(&buf, _("Triggers firing always:"));
2077 printfPQExpBuffer(&buf, _("Triggers firing on replica only:"));
2081 printTableAddFooter(&cont, buf.data);
2082 have_heading = true;
2085 /* Everything after "TRIGGER" is echoed verbatim */
2086 tgdef = PQgetvalue(result, i, 1);
2087 usingpos = strstr(tgdef, " TRIGGER ");
2089 tgdef = usingpos + 9;
2091 printfPQExpBuffer(&buf, " %s", tgdef);
2092 printTableAddFooter(&cont, buf.data);
2100 * Finish printing the footer information about a table.
2102 if (tableinfo.relkind == 'r' || tableinfo.relkind == 'f')
2107 /* print foreign server name */
2108 if (tableinfo.relkind == 'f')
2112 /* Footer information about foreign table */
2113 printfPQExpBuffer(&buf,
2114 "SELECT s.srvname,\n"
2115 " array_to_string(ARRAY(SELECT "
2116 " quote_ident(option_name) || ' ' || "
2117 " quote_literal(option_value) FROM "
2118 " pg_options_to_table(ftoptions)), ', ') "
2119 "FROM pg_catalog.pg_foreign_table f,\n"
2120 " pg_catalog.pg_foreign_server s\n"
2121 "WHERE f.ftrelid = %s AND s.oid = f.ftserver;",
2123 result = PSQLexec(buf.data, false);
2126 else if (PQntuples(result) != 1)
2132 /* Print server name */
2133 printfPQExpBuffer(&buf, "Server: %s",
2134 PQgetvalue(result, 0, 0));
2135 printTableAddFooter(&cont, buf.data);
2137 /* Print per-table FDW options, if any */
2138 ftoptions = PQgetvalue(result, 0, 1);
2139 if (ftoptions && ftoptions[0] != '\0')
2141 printfPQExpBuffer(&buf, "FDW Options: (%s)", ftoptions);
2142 printTableAddFooter(&cont, buf.data);
2147 /* print inherited tables */
2148 printfPQExpBuffer(&buf, "SELECT c.oid::pg_catalog.regclass FROM pg_catalog.pg_class c, pg_catalog.pg_inherits i WHERE c.oid=i.inhparent AND i.inhrelid = '%s' ORDER BY inhseqno;", oid);
2150 result = PSQLexec(buf.data, false);
2155 const char *s = _("Inherits");
2156 int sw = pg_wcswidth(s, strlen(s), pset.encoding);
2158 tuples = PQntuples(result);
2160 for (i = 0; i < tuples; i++)
2163 printfPQExpBuffer(&buf, "%s: %s",
2164 s, PQgetvalue(result, i, 0));
2166 printfPQExpBuffer(&buf, "%*s %s",
2167 sw, "", PQgetvalue(result, i, 0));
2169 appendPQExpBuffer(&buf, ",");
2171 printTableAddFooter(&cont, buf.data);
2177 /* print child tables */
2178 if (pset.sversion >= 80300)
2179 printfPQExpBuffer(&buf, "SELECT c.oid::pg_catalog.regclass FROM pg_catalog.pg_class c, pg_catalog.pg_inherits i WHERE c.oid=i.inhrelid AND i.inhparent = '%s' ORDER BY c.oid::pg_catalog.regclass::pg_catalog.text;", oid);
2181 printfPQExpBuffer(&buf, "SELECT c.oid::pg_catalog.regclass FROM pg_catalog.pg_class c, pg_catalog.pg_inherits i WHERE c.oid=i.inhrelid AND i.inhparent = '%s' ORDER BY c.relname;", oid);
2183 result = PSQLexec(buf.data, false);
2187 tuples = PQntuples(result);
2191 /* print the number of child tables, if any */
2194 printfPQExpBuffer(&buf, _("Number of child tables: %d (Use \\d+ to list them.)"), tuples);
2195 printTableAddFooter(&cont, buf.data);
2200 /* display the list of child tables */
2201 const char *ct = _("Child tables");
2202 int ctw = pg_wcswidth(ct, strlen(ct), pset.encoding);
2204 for (i = 0; i < tuples; i++)
2207 printfPQExpBuffer(&buf, "%s: %s",
2208 ct, PQgetvalue(result, i, 0));
2210 printfPQExpBuffer(&buf, "%*s %s",
2211 ctw, "", PQgetvalue(result, i, 0));
2213 appendPQExpBuffer(&buf, ",");
2215 printTableAddFooter(&cont, buf.data);
2221 if (tableinfo.reloftype)
2223 printfPQExpBuffer(&buf, _("Typed table of type: %s"), tableinfo.reloftype);
2224 printTableAddFooter(&cont, buf.data);
2227 /* OIDs, if verbose */
2230 const char *s = _("Has OIDs");
2232 printfPQExpBuffer(&buf, "%s: %s", s,
2233 (tableinfo.hasoids ? _("yes") : _("no")));
2234 printTableAddFooter(&cont, buf.data);
2237 /* Tablespace info */
2238 add_tablespace_footer(&cont, tableinfo.relkind, tableinfo.tablespace,
2242 /* reloptions, if verbose */
2244 tableinfo.reloptions && tableinfo.reloptions[0] != '\0')
2246 const char *t = _("Options");
2248 printfPQExpBuffer(&buf, "%s: %s", t, tableinfo.reloptions);
2249 printTableAddFooter(&cont, buf.data);
2252 printTable(&cont, pset.queryFout, pset.logfile);
2253 printTableCleanup(&cont);
2260 if (printTableInitialized)
2261 printTableCleanup(&cont);
2262 termPQExpBuffer(&buf);
2263 termPQExpBuffer(&title);
2264 termPQExpBuffer(&tmpbuf);
2268 for (ptr = seq_values; *ptr; ptr++)
2275 for (ptr = modifiers; *ptr; ptr++)
2290 * Add a tablespace description to a footer. If 'newline' is true, it is added
2291 * in a new line; otherwise it's appended to the current value of the last
2295 add_tablespace_footer(printTableContent *const cont, char relkind,
2296 Oid tablespace, const bool newline)
2298 /* relkinds for which we support tablespaces */
2299 if (relkind == 'r' || relkind == 'i')
2302 * We ignore the database default tablespace so that users not using
2303 * tablespaces don't need to know about them. This case also covers
2304 * pre-8.0 servers, for which tablespace will always be 0.
2306 if (tablespace != 0)
2308 PGresult *result = NULL;
2309 PQExpBufferData buf;
2311 initPQExpBuffer(&buf);
2312 printfPQExpBuffer(&buf,
2313 "SELECT spcname FROM pg_catalog.pg_tablespace\n"
2314 "WHERE oid = '%u';", tablespace);
2315 result = PSQLexec(buf.data, false);
2318 /* Should always be the case, but.... */
2319 if (PQntuples(result) > 0)
2323 /* Add the tablespace as a new footer */
2324 printfPQExpBuffer(&buf, _("Tablespace: \"%s\""),
2325 PQgetvalue(result, 0, 0));
2326 printTableAddFooter(cont, buf.data);
2330 /* Append the tablespace to the latest footer */
2331 printfPQExpBuffer(&buf, "%s", cont->footer->data);
2334 * translator: before this string there's an index
2335 * description like '"foo_pkey" PRIMARY KEY, btree (a)'
2337 appendPQExpBuffer(&buf, _(", tablespace \"%s\""),
2338 PQgetvalue(result, 0, 0));
2339 printTableSetFooter(cont, buf.data);
2343 termPQExpBuffer(&buf);
2351 * Describes roles. Any schema portion of the pattern is ignored.
2354 describeRoles(const char *pattern, bool verbose)
2356 PQExpBufferData buf;
2358 printTableContent cont;
2359 printTableOpt myopt = pset.popt.topt;
2364 const char align = 'l';
2367 myopt.default_footer = false;
2369 initPQExpBuffer(&buf);
2371 if (pset.sversion >= 80100)
2373 printfPQExpBuffer(&buf,
2374 "SELECT r.rolname, r.rolsuper, r.rolinherit,\n"
2375 " r.rolcreaterole, r.rolcreatedb, r.rolcanlogin,\n"
2376 " r.rolconnlimit, r.rolvaliduntil,\n"
2377 " ARRAY(SELECT b.rolname\n"
2378 " FROM pg_catalog.pg_auth_members m\n"
2379 " JOIN pg_catalog.pg_roles b ON (m.roleid = b.oid)\n"
2380 " WHERE m.member = r.oid) as memberof");
2382 if (verbose && pset.sversion >= 80200)
2384 appendPQExpBufferStr(&buf, "\n, pg_catalog.shobj_description(r.oid, 'pg_authid') AS description");
2387 if (pset.sversion >= 90100)
2389 appendPQExpBufferStr(&buf, "\n, r.rolreplication");
2392 appendPQExpBufferStr(&buf, "\nFROM pg_catalog.pg_roles r\n");
2394 processSQLNamePattern(pset.db, &buf, pattern, false, false,
2395 NULL, "r.rolname", NULL, NULL);
2399 printfPQExpBuffer(&buf,
2400 "SELECT u.usename AS rolname,\n"
2401 " u.usesuper AS rolsuper,\n"
2402 " true AS rolinherit, false AS rolcreaterole,\n"
2403 " u.usecreatedb AS rolcreatedb, true AS rolcanlogin,\n"
2404 " -1 AS rolconnlimit,"
2405 " u.valuntil as rolvaliduntil,\n"
2406 " ARRAY(SELECT g.groname FROM pg_catalog.pg_group g WHERE u.usesysid = ANY(g.grolist)) as memberof"
2407 "\nFROM pg_catalog.pg_user u\n");
2409 processSQLNamePattern(pset.db, &buf, pattern, false, false,
2410 NULL, "u.usename", NULL, NULL);
2413 appendPQExpBuffer(&buf, "ORDER BY 1;");
2415 res = PSQLexec(buf.data, false);
2419 nrows = PQntuples(res);
2420 attr = pg_malloc_zero((nrows + 1) * sizeof(*attr));
2422 printTableInit(&cont, &myopt, _("List of roles"), ncols, nrows);
2424 printTableAddHeader(&cont, gettext_noop("Role name"), true, align);
2425 printTableAddHeader(&cont, gettext_noop("Attributes"), true, align);
2426 printTableAddHeader(&cont, gettext_noop("Member of"), true, align);
2428 if (verbose && pset.sversion >= 80200)
2429 printTableAddHeader(&cont, gettext_noop("Description"), true, align);
2431 for (i = 0; i < nrows; i++)
2433 printTableAddCell(&cont, PQgetvalue(res, i, 0), false, false);
2435 resetPQExpBuffer(&buf);
2436 if (strcmp(PQgetvalue(res, i, 1), "t") == 0)
2437 add_role_attribute(&buf, _("Superuser"));
2439 if (strcmp(PQgetvalue(res, i, 2), "t") != 0)
2440 add_role_attribute(&buf, _("No inheritance"));
2442 if (strcmp(PQgetvalue(res, i, 3), "t") == 0)
2443 add_role_attribute(&buf, _("Create role"));
2445 if (strcmp(PQgetvalue(res, i, 4), "t") == 0)
2446 add_role_attribute(&buf, _("Create DB"));
2448 if (strcmp(PQgetvalue(res, i, 5), "t") != 0)
2449 add_role_attribute(&buf, _("Cannot login"));
2451 if (pset.sversion >= 90100)
2452 if (strcmp(PQgetvalue(res, i, (verbose ? 10 : 9)), "t") == 0)
2453 add_role_attribute(&buf, _("Replication"));
2455 conns = atoi(PQgetvalue(res, i, 6));
2459 appendPQExpBufferStr(&buf, "\n");
2462 appendPQExpBuffer(&buf, _("No connections"));
2464 appendPQExpBuffer(&buf, ngettext("%d connection",
2470 if (strcmp(PQgetvalue(res, i, 7), "") != 0)
2473 appendPQExpBufferStr(&buf, "\n");
2474 appendPQExpBufferStr(&buf, _("Password valid until "));
2475 appendPQExpBufferStr(&buf, PQgetvalue(res, i, 7));
2478 attr[i] = pg_strdup(buf.data);
2480 printTableAddCell(&cont, attr[i], false, false);
2482 printTableAddCell(&cont, PQgetvalue(res, i, 8), false, false);
2484 if (verbose && pset.sversion >= 80200)
2485 printTableAddCell(&cont, PQgetvalue(res, i, 9), false, false);
2487 termPQExpBuffer(&buf);
2489 printTable(&cont, pset.queryFout, pset.logfile);
2490 printTableCleanup(&cont);
2492 for (i = 0; i < nrows; i++)
2501 add_role_attribute(PQExpBuffer buf, const char *const str)
2504 appendPQExpBufferStr(buf, ", ");
2506 appendPQExpBufferStr(buf, str);
2513 listDbRoleSettings(const char *pattern, const char *pattern2)
2515 PQExpBufferData buf;
2517 printQueryOpt myopt = pset.popt;
2519 initPQExpBuffer(&buf);
2521 if (pset.sversion >= 90000)
2525 printfPQExpBuffer(&buf, "SELECT rolname AS \"%s\", datname AS \"%s\",\n"
2526 "pg_catalog.array_to_string(setconfig, E'\\n') AS \"%s\"\n"
2527 "FROM pg_db_role_setting AS s\n"
2528 "LEFT JOIN pg_database ON pg_database.oid = setdatabase\n"
2529 "LEFT JOIN pg_roles ON pg_roles.oid = setrole\n",
2530 gettext_noop("Role"),
2531 gettext_noop("Database"),
2532 gettext_noop("Settings"));
2533 havewhere = processSQLNamePattern(pset.db, &buf, pattern, false, false,
2534 NULL, "pg_roles.rolname", NULL, NULL);
2535 processSQLNamePattern(pset.db, &buf, pattern2, havewhere, false,
2536 NULL, "pg_database.datname", NULL, NULL);
2537 appendPQExpBufferStr(&buf, "ORDER BY 1, 2;");
2541 fprintf(pset.queryFout,
2542 _("No per-database role settings support in this server version.\n"));
2546 res = PSQLexec(buf.data, false);
2550 if (PQntuples(res) == 0 && !pset.quiet)
2553 fprintf(pset.queryFout, _("No matching settings found.\n"));
2555 fprintf(pset.queryFout, _("No settings found.\n"));
2559 myopt.nullPrint = NULL;
2560 myopt.title = _("List of settings");
2561 myopt.translate_header = true;
2563 printQuery(res, &myopt, pset.queryFout, pset.logfile);
2567 resetPQExpBuffer(&buf);
2575 * handler for \dt, \di, etc.
2577 * tabtypes is an array of characters, specifying what info is desired:
2582 * E - foreign table (Note: different from 'f', the relkind value)
2583 * (any order of the above is fine)
2584 * If tabtypes is empty, we default to \dtvsE.
2587 listTables(const char *tabtypes, const char *pattern, bool verbose, bool showSystem)
2589 bool showTables = strchr(tabtypes, 't') != NULL;
2590 bool showIndexes = strchr(tabtypes, 'i') != NULL;
2591 bool showViews = strchr(tabtypes, 'v') != NULL;
2592 bool showSeq = strchr(tabtypes, 's') != NULL;
2593 bool showForeign = strchr(tabtypes, 'E') != NULL;
2595 PQExpBufferData buf;
2597 printQueryOpt myopt = pset.popt;
2598 static const bool translate_columns[] = {false, false, true, false, false, false, false};
2600 if (!(showTables || showIndexes || showViews || showSeq || showForeign))
2601 showTables = showViews = showSeq = showForeign = true;
2603 initPQExpBuffer(&buf);
2606 * Note: as of Pg 8.2, we no longer use relkind 's', but we keep it here
2607 * for backwards compatibility.
2609 printfPQExpBuffer(&buf,
2610 "SELECT n.nspname as \"%s\",\n"
2611 " c.relname as \"%s\",\n"
2612 " CASE c.relkind WHEN 'r' THEN '%s' WHEN 'v' THEN '%s' WHEN 'i' THEN '%s' WHEN 'S' THEN '%s' WHEN 's' THEN '%s' WHEN 'f' THEN '%s' END as \"%s\",\n"
2613 " pg_catalog.pg_get_userbyid(c.relowner) as \"%s\"",
2614 gettext_noop("Schema"),
2615 gettext_noop("Name"),
2616 gettext_noop("table"),
2617 gettext_noop("view"),
2618 gettext_noop("index"),
2619 gettext_noop("sequence"),
2620 gettext_noop("special"),
2621 gettext_noop("foreign table"),
2622 gettext_noop("Type"),
2623 gettext_noop("Owner"));
2626 appendPQExpBuffer(&buf,
2627 ",\n c2.relname as \"%s\"",
2628 gettext_noop("Table"));
2633 * As of PostgreSQL 9.0, use pg_table_size() to show a more acurate
2634 * size of a table, including FSM, VM and TOAST tables.
2636 if (pset.sversion >= 90000)
2637 appendPQExpBuffer(&buf,
2638 ",\n pg_catalog.pg_size_pretty(pg_catalog.pg_table_size(c.oid)) as \"%s\"",
2639 gettext_noop("Size"));
2640 else if (pset.sversion >= 80100)
2641 appendPQExpBuffer(&buf,
2642 ",\n pg_catalog.pg_size_pretty(pg_catalog.pg_relation_size(c.oid)) as \"%s\"",
2643 gettext_noop("Size"));
2645 appendPQExpBuffer(&buf,
2646 ",\n pg_catalog.obj_description(c.oid, 'pg_class') as \"%s\"",
2647 gettext_noop("Description"));
2650 appendPQExpBuffer(&buf,
2651 "\nFROM pg_catalog.pg_class c"
2652 "\n LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace");
2654 appendPQExpBuffer(&buf,
2655 "\n LEFT JOIN pg_catalog.pg_index i ON i.indexrelid = c.oid"
2656 "\n LEFT JOIN pg_catalog.pg_class c2 ON i.indrelid = c2.oid");
2658 appendPQExpBuffer(&buf, "\nWHERE c.relkind IN (");
2660 appendPQExpBuffer(&buf, "'r',");
2662 appendPQExpBuffer(&buf, "'v',");
2664 appendPQExpBuffer(&buf, "'i',");
2666 appendPQExpBuffer(&buf, "'S',");
2667 if (showSystem || pattern)
2668 appendPQExpBuffer(&buf, "'s',"); /* was RELKIND_SPECIAL in <=
2671 appendPQExpBuffer(&buf, "'f',");
2673 appendPQExpBuffer(&buf, "''"); /* dummy */
2674 appendPQExpBuffer(&buf, ")\n");
2676 if (!showSystem && !pattern)
2677 appendPQExpBuffer(&buf, " AND n.nspname <> 'pg_catalog'\n"
2678 " AND n.nspname <> 'information_schema'\n");
2681 * TOAST objects are suppressed unconditionally. Since we don't provide
2682 * any way to select relkind 't' above, we would never show toast tables
2683 * in any case; it seems a bit confusing to allow their indexes to be
2684 * shown. Use plain \d if you really need to look at a TOAST table/index.
2686 appendPQExpBuffer(&buf, " AND n.nspname !~ '^pg_toast'\n");
2688 processSQLNamePattern(pset.db, &buf, pattern, true, false,
2689 "n.nspname", "c.relname", NULL,
2690 "pg_catalog.pg_table_is_visible(c.oid)");
2692 appendPQExpBuffer(&buf, "ORDER BY 1,2;");
2694 res = PSQLexec(buf.data, false);
2695 termPQExpBuffer(&buf);
2699 if (PQntuples(res) == 0 && !pset.quiet)
2702 fprintf(pset.queryFout, _("No matching relations found.\n"));
2704 fprintf(pset.queryFout, _("No relations found.\n"));
2708 myopt.nullPrint = NULL;
2709 myopt.title = _("List of relations");
2710 myopt.translate_header = true;
2711 myopt.translate_columns = translate_columns;
2713 printQuery(res, &myopt, pset.queryFout, pset.logfile);
2724 * Describes languages.
2727 listLanguages(const char *pattern, bool verbose, bool showSystem)
2729 PQExpBufferData buf;
2731 printQueryOpt myopt = pset.popt;
2733 initPQExpBuffer(&buf);
2735 printfPQExpBuffer(&buf,
2736 "SELECT l.lanname AS \"%s\",\n",
2737 gettext_noop("Name"));
2738 if (pset.sversion >= 80300)
2739 appendPQExpBuffer(&buf,
2740 " pg_catalog.pg_get_userbyid(l.lanowner) as \"%s\",\n",
2741 gettext_noop("Owner"));
2743 appendPQExpBuffer(&buf,
2744 " l.lanpltrusted AS \"%s\"",
2745 gettext_noop("Trusted"));
2749 appendPQExpBuffer(&buf,
2750 ",\n NOT l.lanispl AS \"%s\",\n"
2751 " l.lanplcallfoid::regprocedure AS \"%s\",\n"
2752 " l.lanvalidator::regprocedure AS \"%s\",\n ",
2753 gettext_noop("Internal Language"),
2754 gettext_noop("Call Handler"),
2755 gettext_noop("Validator"));
2756 if (pset.sversion >= 90000)
2757 appendPQExpBuffer(&buf, "l.laninline::regprocedure AS \"%s\",\n ",
2758 gettext_noop("Inline Handler"));
2759 printACLColumn(&buf, "l.lanacl");
2762 appendPQExpBuffer(&buf,
2763 ",\n d.description AS \"%s\""
2764 "\nFROM pg_catalog.pg_language l\n"
2765 "LEFT JOIN pg_catalog.pg_description d\n"
2766 " ON d.classoid = l.tableoid AND d.objoid = l.oid\n"
2767 " AND d.objsubid = 0\n",
2768 gettext_noop("Description"));
2771 processSQLNamePattern(pset.db, &buf, pattern, false, false,
2772 NULL, "l.lanname", NULL, NULL);
2774 if (!showSystem && !pattern)
2775 appendPQExpBuffer(&buf, "WHERE l.lanplcallfoid != 0\n");
2778 appendPQExpBuffer(&buf, "ORDER BY 1;");
2780 res = PSQLexec(buf.data, false);
2781 termPQExpBuffer(&buf);
2785 myopt.nullPrint = NULL;
2786 myopt.title = _("List of languages");
2787 myopt.translate_header = true;
2789 printQuery(res, &myopt, pset.queryFout, pset.logfile);
2799 * Describes domains.
2802 listDomains(const char *pattern, bool verbose, bool showSystem)
2804 PQExpBufferData buf;
2806 printQueryOpt myopt = pset.popt;
2808 initPQExpBuffer(&buf);
2810 printfPQExpBuffer(&buf,
2811 "SELECT n.nspname as \"%s\",\n"
2812 " t.typname as \"%s\",\n"
2813 " pg_catalog.format_type(t.typbasetype, t.typtypmod) as \"%s\",\n"
2815 gettext_noop("Schema"),
2816 gettext_noop("Name"),
2817 gettext_noop("Type"));
2819 if (pset.sversion >= 90100)
2820 appendPQExpBuffer(&buf,
2821 " COALESCE((SELECT ' collate ' || c.collname FROM pg_catalog.pg_collation c, pg_catalog.pg_type bt\n"
2822 " WHERE c.oid = t.typcollation AND bt.oid = t.typbasetype AND t.typcollation <> bt.typcollation), '') ||\n");
2823 appendPQExpBuffer(&buf,
2824 " CASE WHEN t.typnotnull THEN ' not null' ELSE '' END ||\n"
2825 " CASE WHEN t.typdefault IS NOT NULL THEN ' default ' || t.typdefault ELSE '' END\n"
2827 " pg_catalog.array_to_string(ARRAY(\n"
2828 " SELECT pg_catalog.pg_get_constraintdef(r.oid, true) FROM pg_catalog.pg_constraint r WHERE t.oid = r.contypid\n"
2829 " ), ' ') as \"%s\"",
2830 gettext_noop("Modifier"),
2831 gettext_noop("Check"));
2835 if (pset.sversion >= 90200)
2837 appendPQExpBuffer(&buf, ",\n ");
2838 printACLColumn(&buf, "t.typacl");
2840 appendPQExpBuffer(&buf,
2841 ",\n d.description as \"%s\"",
2842 gettext_noop("Description"));
2845 appendPQExpBuffer(&buf,
2846 "\nFROM pg_catalog.pg_type t\n"
2847 " LEFT JOIN pg_catalog.pg_namespace n ON n.oid = t.typnamespace\n");
2850 appendPQExpBuffer(&buf,
2851 " LEFT JOIN pg_catalog.pg_description d "
2852 "ON d.classoid = t.tableoid AND d.objoid = t.oid "
2853 "AND d.objsubid = 0\n");
2855 appendPQExpBuffer(&buf, "WHERE t.typtype = 'd'\n");
2857 if (!showSystem && !pattern)
2858 appendPQExpBuffer(&buf, " AND n.nspname <> 'pg_catalog'\n"
2859 " AND n.nspname <> 'information_schema'\n");
2861 processSQLNamePattern(pset.db, &buf, pattern, true, false,
2862 "n.nspname", "t.typname", NULL,
2863 "pg_catalog.pg_type_is_visible(t.oid)");
2865 appendPQExpBuffer(&buf, "ORDER BY 1, 2;");
2867 res = PSQLexec(buf.data, false);
2868 termPQExpBuffer(&buf);
2872 myopt.nullPrint = NULL;
2873 myopt.title = _("List of domains");
2874 myopt.translate_header = true;
2876 printQuery(res, &myopt, pset.queryFout, pset.logfile);
2885 * Describes conversions.
2888 listConversions(const char *pattern, bool verbose, bool showSystem)
2890 PQExpBufferData buf;
2892 printQueryOpt myopt = pset.popt;
2893 static const bool translate_columns[] = {false, false, false, false, true};
2895 initPQExpBuffer(&buf);
2897 printfPQExpBuffer(&buf,
2898 "SELECT n.nspname AS \"%s\",\n"
2899 " c.conname AS \"%s\",\n"
2900 " pg_catalog.pg_encoding_to_char(c.conforencoding) AS \"%s\",\n"
2901 " pg_catalog.pg_encoding_to_char(c.contoencoding) AS \"%s\",\n"
2902 " CASE WHEN c.condefault THEN '%s'\n"
2903 " ELSE '%s' END AS \"%s\"",
2904 gettext_noop("Schema"),
2905 gettext_noop("Name"),
2906 gettext_noop("Source"),
2907 gettext_noop("Destination"),
2908 gettext_noop("yes"), gettext_noop("no"),
2909 gettext_noop("Default?"));
2912 appendPQExpBuffer(&buf,
2913 ",\n d.description AS \"%s\"",
2914 gettext_noop("Description"));
2916 appendPQExpBuffer(&buf,
2917 "\nFROM pg_catalog.pg_conversion c\n"
2918 " JOIN pg_catalog.pg_namespace n "
2919 "ON n.oid = c.connamespace\n");
2922 appendPQExpBuffer(&buf,
2923 "LEFT JOIN pg_catalog.pg_description d "
2924 "ON d.classoid = c.tableoid\n"
2925 " AND d.objoid = c.oid "
2926 "AND d.objsubid = 0\n");
2928 appendPQExpBuffer(&buf, "WHERE true\n");
2930 if (!showSystem && !pattern)
2931 appendPQExpBuffer(&buf, " AND n.nspname <> 'pg_catalog'\n"
2932 " AND n.nspname <> 'information_schema'\n");
2934 processSQLNamePattern(pset.db, &buf, pattern, true, false,
2935 "n.nspname", "c.conname", NULL,
2936 "pg_catalog.pg_conversion_is_visible(c.oid)");
2938 appendPQExpBuffer(&buf, "ORDER BY 1, 2;");
2940 res = PSQLexec(buf.data, false);
2941 termPQExpBuffer(&buf);
2945 myopt.nullPrint = NULL;
2946 myopt.title = _("List of conversions");
2947 myopt.translate_header = true;
2948 myopt.translate_columns = translate_columns;
2950 printQuery(res, &myopt, pset.queryFout, pset.logfile);
2959 * Describes Event Triggers.
2962 listEventTriggers(const char *pattern, bool verbose)
2964 PQExpBufferData buf;
2966 printQueryOpt myopt = pset.popt;
2967 static const bool translate_columns[] =
2968 {false, false, false, true, false, false, false};
2970 initPQExpBuffer(&buf);
2972 printfPQExpBuffer(&buf,
2973 "select evtname as \"%s\", "
2974 "evtevent as \"%s\", "
2975 "pg_catalog.pg_get_userbyid(e.evtowner) AS \"%s\", "
2976 "case evtenabled when 'O' then 'enabled' "
2977 " when 'R' then 'replica' "
2978 " when 'A' then 'always' "
2979 " when 'D' then 'disabled' end as \"%s\", "
2980 "e.evtfoid::regproc as \"%s\", "
2981 "array_to_string(array(select x "
2982 " from unnest(evttags) as t(x)), ', ') as \"%s\" ",
2983 gettext_noop("Name"),
2984 gettext_noop("Event"),
2985 gettext_noop("Owner"),
2986 gettext_noop("Enabled"),
2987 gettext_noop("Procedure"),
2988 gettext_noop("Tags"));
2990 appendPQExpBuffer(&buf,
2991 ",\npg_catalog.obj_description(e.oid, 'pg_event_trigger') as \"%s\"",
2992 gettext_noop("Description"));
2993 appendPQExpBuffer(&buf,
2994 "\nFROM pg_event_trigger e ");
2996 processSQLNamePattern(pset.db, &buf, pattern, false, false,
2997 NULL, "evtname", NULL, NULL);
2999 appendPQExpBuffer(&buf, "ORDER BY 1");
3001 res = PSQLexec(buf.data, false);
3002 termPQExpBuffer(&buf);
3006 myopt.nullPrint = NULL;
3007 myopt.title = _("List of event triggers");
3008 myopt.translate_header = true;
3009 myopt.translate_columns = translate_columns;
3011 printQuery(res, &myopt, pset.queryFout, pset.logfile);
3023 listCasts(const char *pattern, bool verbose)
3025 PQExpBufferData buf;
3027 printQueryOpt myopt = pset.popt;
3028 static const bool translate_columns[] = {false, false, false, true};
3030 initPQExpBuffer(&buf);
3033 * We need a left join to pg_proc for binary casts; the others are just
3034 * paranoia. Also note that we don't attempt to localize '(binary
3035 * coercible)', because there's too much risk of gettext translating a
3036 * function name that happens to match some string in the PO database.
3038 printfPQExpBuffer(&buf,
3039 "SELECT pg_catalog.format_type(castsource, NULL) AS \"%s\",\n"
3040 " pg_catalog.format_type(casttarget, NULL) AS \"%s\",\n"
3041 " CASE WHEN castfunc = 0 THEN '(binary coercible)'\n"
3044 " CASE WHEN c.castcontext = 'e' THEN '%s'\n"
3045 " WHEN c.castcontext = 'a' THEN '%s'\n"
3048 gettext_noop("Source type"),
3049 gettext_noop("Target type"),
3050 gettext_noop("Function"),
3052 gettext_noop("in assignment"),
3053 gettext_noop("yes"),
3054 gettext_noop("Implicit?"));
3057 appendPQExpBuffer(&buf,
3058 ",\n d.description AS \"%s\"\n",
3059 gettext_noop("Description"));
3061 appendPQExpBuffer(&buf,
3062 "FROM pg_catalog.pg_cast c LEFT JOIN pg_catalog.pg_proc p\n"
3063 " ON c.castfunc = p.oid\n"
3064 " LEFT JOIN pg_catalog.pg_type ts\n"
3065 " ON c.castsource = ts.oid\n"
3066 " LEFT JOIN pg_catalog.pg_namespace ns\n"
3067 " ON ns.oid = ts.typnamespace\n"
3068 " LEFT JOIN pg_catalog.pg_type tt\n"
3069 " ON c.casttarget = tt.oid\n"
3070 " LEFT JOIN pg_catalog.pg_namespace nt\n"
3071 " ON nt.oid = tt.typnamespace\n");
3074 appendPQExpBuffer(&buf,
3075 " LEFT JOIN pg_catalog.pg_description d\n"
3076 " ON d.classoid = c.tableoid AND d.objoid = "
3077 "c.oid AND d.objsubid = 0\n");
3079 appendPQExpBuffer(&buf, "WHERE ( (true");
3082 * Match name pattern against either internal or external name of either
3083 * castsource or casttarget
3085 processSQLNamePattern(pset.db, &buf, pattern, true, false,
3086 "ns.nspname", "ts.typname",
3087 "pg_catalog.format_type(ts.oid, NULL)",
3088 "pg_catalog.pg_type_is_visible(ts.oid)");
3090 appendPQExpBuffer(&buf, ") OR (true");
3092 processSQLNamePattern(pset.db, &buf, pattern, true, false,
3093 "nt.nspname", "tt.typname",
3094 "pg_catalog.format_type(tt.oid, NULL)",
3095 "pg_catalog.pg_type_is_visible(tt.oid)");
3097 appendPQExpBuffer(&buf, ") )\nORDER BY 1, 2;");
3099 res = PSQLexec(buf.data, false);
3100 termPQExpBuffer(&buf);
3104 myopt.nullPrint = NULL;
3105 myopt.title = _("List of casts");
3106 myopt.translate_header = true;
3107 myopt.translate_columns = translate_columns;
3109 printQuery(res, &myopt, pset.queryFout, pset.logfile);
3118 * Describes collations.
3121 listCollations(const char *pattern, bool verbose, bool showSystem)
3123 PQExpBufferData buf;
3125 printQueryOpt myopt = pset.popt;
3126 static const bool translate_columns[] = {false, false, false, false, false};
3128 if (pset.sversion < 90100)
3130 psql_error("The server (version %d.%d) does not support collations.\n",
3131 pset.sversion / 10000, (pset.sversion / 100) % 100);
3135 initPQExpBuffer(&buf);
3137 printfPQExpBuffer(&buf,
3138 "SELECT n.nspname AS \"%s\",\n"
3139 " c.collname AS \"%s\",\n"
3140 " c.collcollate AS \"%s\",\n"
3141 " c.collctype AS \"%s\"",
3142 gettext_noop("Schema"),
3143 gettext_noop("Name"),
3144 gettext_noop("Collate"),
3145 gettext_noop("Ctype"));
3148 appendPQExpBuffer(&buf,
3149 ",\n pg_catalog.obj_description(c.oid, 'pg_collation') AS \"%s\"",
3150 gettext_noop("Description"));
3152 appendPQExpBuffer(&buf,
3153 "\nFROM pg_catalog.pg_collation c, pg_catalog.pg_namespace n\n"
3154 "WHERE n.oid = c.collnamespace\n");
3156 if (!showSystem && !pattern)
3157 appendPQExpBuffer(&buf, " AND n.nspname <> 'pg_catalog'\n"
3158 " AND n.nspname <> 'information_schema'\n");
3161 * Hide collations that aren't usable in the current database's encoding.
3162 * If you think to change this, note that pg_collation_is_visible rejects
3163 * unusable collations, so you will need to hack name pattern processing
3164 * somehow to avoid inconsistent behavior.
3166 appendPQExpBuffer(&buf, " AND c.collencoding IN (-1, pg_catalog.pg_char_to_encoding(pg_catalog.getdatabaseencoding()))\n");
3168 processSQLNamePattern(pset.db, &buf, pattern, true, false,
3169 "n.nspname", "c.collname", NULL,
3170 "pg_catalog.pg_collation_is_visible(c.oid)");
3172 appendPQExpBuffer(&buf, "ORDER BY 1, 2;");
3174 res = PSQLexec(buf.data, false);
3175 termPQExpBuffer(&buf);
3179 myopt.nullPrint = NULL;
3180 myopt.title = _("List of collations");
3181 myopt.translate_header = true;
3182 myopt.translate_columns = translate_columns;
3184 printQuery(res, &myopt, pset.queryFout, pset.logfile);
3193 * Describes schemas (namespaces)
3196 listSchemas(const char *pattern, bool verbose, bool showSystem)
3198 PQExpBufferData buf;
3200 printQueryOpt myopt = pset.popt;
3202 initPQExpBuffer(&buf);
3203 printfPQExpBuffer(&buf,
3204 "SELECT n.nspname AS \"%s\",\n"
3205 " pg_catalog.pg_get_userbyid(n.nspowner) AS \"%s\"",
3206 gettext_noop("Name"),
3207 gettext_noop("Owner"));
3211 appendPQExpBuffer(&buf, ",\n ");
3212 printACLColumn(&buf, "n.nspacl");
3213 appendPQExpBuffer(&buf,
3214 ",\n pg_catalog.obj_description(n.oid, 'pg_namespace') AS \"%s\"",
3215 gettext_noop("Description"));
3218 appendPQExpBuffer(&buf,
3219 "\nFROM pg_catalog.pg_namespace n\n");
3221 if (!showSystem && !pattern)
3222 appendPQExpBuffer(&buf,
3223 "WHERE n.nspname !~ '^pg_' AND n.nspname <> 'information_schema'\n");
3225 processSQLNamePattern(pset.db, &buf, pattern,
3226 !showSystem && !pattern, false,
3227 NULL, "n.nspname", NULL,
3230 appendPQExpBuffer(&buf, "ORDER BY 1;");
3232 res = PSQLexec(buf.data, false);
3233 termPQExpBuffer(&buf);
3237 myopt.nullPrint = NULL;
3238 myopt.title = _("List of schemas");
3239 myopt.translate_header = true;
3241 printQuery(res, &myopt, pset.queryFout, pset.logfile);
3250 * list text search parsers
3253 listTSParsers(const char *pattern, bool verbose)
3255 PQExpBufferData buf;
3257 printQueryOpt myopt = pset.popt;
3259 if (pset.sversion < 80300)
3261 psql_error("The server (version %d.%d) does not support full text search.\n",
3262 pset.sversion / 10000, (pset.sversion / 100) % 100);
3267 return listTSParsersVerbose(pattern);
3269 initPQExpBuffer(&buf);
3271 printfPQExpBuffer(&buf,
3273 " n.nspname as \"%s\",\n"
3274 " p.prsname as \"%s\",\n"
3275 " pg_catalog.obj_description(p.oid, 'pg_ts_parser') as \"%s\"\n"
3276 "FROM pg_catalog.pg_ts_parser p \n"
3277 "LEFT JOIN pg_catalog.pg_namespace n ON n.oid = p.prsnamespace\n",
3278 gettext_noop("Schema"),
3279 gettext_noop("Name"),
3280 gettext_noop("Description")
3283 processSQLNamePattern(pset.db, &buf, pattern, false, false,
3284 "n.nspname", "p.prsname", NULL,
3285 "pg_catalog.pg_ts_parser_is_visible(p.oid)");
3287 appendPQExpBuffer(&buf, "ORDER BY 1, 2;");
3289 res = PSQLexec(buf.data, false);
3290 termPQExpBuffer(&buf);
3294 myopt.nullPrint = NULL;
3295 myopt.title = _("List of text search parsers");
3296 myopt.translate_header = true;
3298 printQuery(res, &myopt, pset.queryFout, pset.logfile);
3305 * full description of parsers
3308 listTSParsersVerbose(const char *pattern)
3310 PQExpBufferData buf;
3314 initPQExpBuffer(&buf);
3316 printfPQExpBuffer(&buf,
3320 "FROM pg_catalog.pg_ts_parser p\n"
3321 "LEFT JOIN pg_catalog.pg_namespace n ON n.oid = p.prsnamespace\n"
3324 processSQLNamePattern(pset.db, &buf, pattern, false, false,
3325 "n.nspname", "p.prsname", NULL,
3326 "pg_catalog.pg_ts_parser_is_visible(p.oid)");
3328 appendPQExpBuffer(&buf, "ORDER BY 1, 2;");
3330 res = PSQLexec(buf.data, false);
3331 termPQExpBuffer(&buf);
3335 if (PQntuples(res) == 0)
3338 psql_error("Did not find any text search parser named \"%s\".\n",
3344 for (i = 0; i < PQntuples(res); i++)
3347 const char *nspname = NULL;
3348 const char *prsname;
3350 oid = PQgetvalue(res, i, 0);
3351 if (!PQgetisnull(res, i, 1))
3352 nspname = PQgetvalue(res, i, 1);
3353 prsname = PQgetvalue(res, i, 2);
3355 if (!describeOneTSParser(oid, nspname, prsname))
3373 describeOneTSParser(const char *oid, const char *nspname, const char *prsname)
3375 PQExpBufferData buf;
3378 printQueryOpt myopt = pset.popt;
3379 static const bool translate_columns[] = {true, false, false};
3381 initPQExpBuffer(&buf);
3383 printfPQExpBuffer(&buf,
3384 "SELECT '%s' AS \"%s\", \n"
3385 " p.prsstart::pg_catalog.regproc AS \"%s\", \n"
3386 " pg_catalog.obj_description(p.prsstart, 'pg_proc') as \"%s\" \n"
3387 " FROM pg_catalog.pg_ts_parser p \n"
3388 " WHERE p.oid = '%s' \n"
3391 " p.prstoken::pg_catalog.regproc, \n"
3392 " pg_catalog.obj_description(p.prstoken, 'pg_proc') \n"
3393 " FROM pg_catalog.pg_ts_parser p \n"
3394 " WHERE p.oid = '%s' \n"
3397 " p.prsend::pg_catalog.regproc, \n"
3398 " pg_catalog.obj_description(p.prsend, 'pg_proc') \n"
3399 " FROM pg_catalog.pg_ts_parser p \n"
3400 " WHERE p.oid = '%s' \n"
3403 " p.prsheadline::pg_catalog.regproc, \n"
3404 " pg_catalog.obj_description(p.prsheadline, 'pg_proc') \n"
3405 " FROM pg_catalog.pg_ts_parser p \n"
3406 " WHERE p.oid = '%s' \n"
3409 " p.prslextype::pg_catalog.regproc, \n"
3410 " pg_catalog.obj_description(p.prslextype, 'pg_proc') \n"
3411 " FROM pg_catalog.pg_ts_parser p \n"
3412 " WHERE p.oid = '%s';",
3413 gettext_noop("Start parse"),
3414 gettext_noop("Method"),
3415 gettext_noop("Function"),
3416 gettext_noop("Description"),
3418 gettext_noop("Get next token"),
3420 gettext_noop("End parse"),
3422 gettext_noop("Get headline"),
3424 gettext_noop("Get token types"),
3427 res = PSQLexec(buf.data, false);
3428 termPQExpBuffer(&buf);
3432 myopt.nullPrint = NULL;
3434 sprintf(title, _("Text search parser \"%s.%s\""), nspname, prsname);
3436 sprintf(title, _("Text search parser \"%s\""), prsname);
3437 myopt.title = title;
3438 myopt.footers = NULL;
3439 myopt.topt.default_footer = false;
3440 myopt.translate_header = true;
3441 myopt.translate_columns = translate_columns;
3443 printQuery(res, &myopt, pset.queryFout, pset.logfile);
3447 initPQExpBuffer(&buf);
3449 printfPQExpBuffer(&buf,
3450 "SELECT t.alias as \"%s\", \n"
3451 " t.description as \"%s\" \n"
3452 "FROM pg_catalog.ts_token_type( '%s'::pg_catalog.oid ) as t \n"
3454 gettext_noop("Token name"),
3455 gettext_noop("Description"),
3458 res = PSQLexec(buf.data, false);
3459 termPQExpBuffer(&buf);
3463 myopt.nullPrint = NULL;
3465 sprintf(title, _("Token types for parser \"%s.%s\""), nspname, prsname);
3467 sprintf(title, _("Token types for parser \"%s\""), prsname);
3468 myopt.title = title;
3469 myopt.footers = NULL;
3470 myopt.topt.default_footer = true;
3471 myopt.translate_header = true;
3472 myopt.translate_columns = NULL;
3474 printQuery(res, &myopt, pset.queryFout, pset.logfile);
3483 * list text search dictionaries
3486 listTSDictionaries(const char *pattern, bool verbose)
3488 PQExpBufferData buf;
3490 printQueryOpt myopt = pset.popt;
3492 if (pset.sversion < 80300)
3494 psql_error("The server (version %d.%d) does not support full text search.\n",
3495 pset.sversion / 10000, (pset.sversion / 100) % 100);
3499 initPQExpBuffer(&buf);
3501 printfPQExpBuffer(&buf,
3503 " n.nspname as \"%s\",\n"
3504 " d.dictname as \"%s\",\n",
3505 gettext_noop("Schema"),
3506 gettext_noop("Name"));
3510 appendPQExpBuffer(&buf,
3511 " ( SELECT COALESCE(nt.nspname, '(null)')::pg_catalog.text || '.' || t.tmplname FROM \n"
3512 " pg_catalog.pg_ts_template t \n"
3513 " LEFT JOIN pg_catalog.pg_namespace nt ON nt.oid = t.tmplnamespace \n"
3514 " WHERE d.dicttemplate = t.oid ) AS \"%s\", \n"
3515 " d.dictinitoption as \"%s\", \n",
3516 gettext_noop("Template"),
3517 gettext_noop("Init options"));
3520 appendPQExpBuffer(&buf,
3521 " pg_catalog.obj_description(d.oid, 'pg_ts_dict') as \"%s\"\n",
3522 gettext_noop("Description"));
3524 appendPQExpBuffer(&buf, "FROM pg_catalog.pg_ts_dict d\n"
3525 "LEFT JOIN pg_catalog.pg_namespace n ON n.oid = d.dictnamespace\n");
3527 processSQLNamePattern(pset.db, &buf, pattern, false, false,
3528 "n.nspname", "d.dictname", NULL,
3529 "pg_catalog.pg_ts_dict_is_visible(d.oid)");
3531 appendPQExpBuffer(&buf, "ORDER BY 1, 2;");
3533 res = PSQLexec(buf.data, false);
3534 termPQExpBuffer(&buf);
3538 myopt.nullPrint = NULL;
3539 myopt.title = _("List of text search dictionaries");
3540 myopt.translate_header = true;
3542 printQuery(res, &myopt, pset.queryFout, pset.logfile);
3551 * list text search templates
3554 listTSTemplates(const char *pattern, bool verbose)
3556 PQExpBufferData buf;
3558 printQueryOpt myopt = pset.popt;
3560 if (pset.sversion < 80300)
3562 psql_error("The server (version %d.%d) does not support full text search.\n",
3563 pset.sversion / 10000, (pset.sversion / 100) % 100);
3567 initPQExpBuffer(&buf);
3570 printfPQExpBuffer(&buf,
3572 " n.nspname AS \"%s\",\n"
3573 " t.tmplname AS \"%s\",\n"
3574 " t.tmplinit::pg_catalog.regproc AS \"%s\",\n"
3575 " t.tmpllexize::pg_catalog.regproc AS \"%s\",\n"
3576 " pg_catalog.obj_description(t.oid, 'pg_ts_template') AS \"%s\"\n",
3577 gettext_noop("Schema"),
3578 gettext_noop("Name"),
3579 gettext_noop("Init"),
3580 gettext_noop("Lexize"),
3581 gettext_noop("Description"));
3583 printfPQExpBuffer(&buf,
3585 " n.nspname AS \"%s\",\n"
3586 " t.tmplname AS \"%s\",\n"
3587 " pg_catalog.obj_description(t.oid, 'pg_ts_template') AS \"%s\"\n",
3588 gettext_noop("Schema"),
3589 gettext_noop("Name"),
3590 gettext_noop("Description"));
3592 appendPQExpBuffer(&buf, "FROM pg_catalog.pg_ts_template t\n"
3593 "LEFT JOIN pg_catalog.pg_namespace n ON n.oid = t.tmplnamespace\n");
3595 processSQLNamePattern(pset.db, &buf, pattern, false, false,
3596 "n.nspname", "t.tmplname", NULL,
3597 "pg_catalog.pg_ts_template_is_visible(t.oid)");
3599 appendPQExpBuffer(&buf, "ORDER BY 1, 2;");
3601 res = PSQLexec(buf.data, false);
3602 termPQExpBuffer(&buf);
3606 myopt.nullPrint = NULL;
3607 myopt.title = _("List of text search templates");
3608 myopt.translate_header = true;
3610 printQuery(res, &myopt, pset.queryFout, pset.logfile);
3619 * list text search configurations
3622 listTSConfigs(const char *pattern, bool verbose)
3624 PQExpBufferData buf;
3626 printQueryOpt myopt = pset.popt;
3628 if (pset.sversion < 80300)
3630 psql_error("The server (version %d.%d) does not support full text search.\n",
3631 pset.sversion / 10000, (pset.sversion / 100) % 100);
3636 return listTSConfigsVerbose(pattern);
3638 initPQExpBuffer(&buf);
3640 printfPQExpBuffer(&buf,
3642 " n.nspname as \"%s\",\n"
3643 " c.cfgname as \"%s\",\n"
3644 " pg_catalog.obj_description(c.oid, 'pg_ts_config') as \"%s\"\n"
3645 "FROM pg_catalog.pg_ts_config c\n"
3646 "LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.cfgnamespace \n",
3647 gettext_noop("Schema"),
3648 gettext_noop("Name"),
3649 gettext_noop("Description")
3652 processSQLNamePattern(pset.db, &buf, pattern, false, false,
3653 "n.nspname", "c.cfgname", NULL,
3654 "pg_catalog.pg_ts_config_is_visible(c.oid)");
3656 appendPQExpBuffer(&buf, "ORDER BY 1, 2;");
3658 res = PSQLexec(buf.data, false);
3659 termPQExpBuffer(&buf);
3663 myopt.nullPrint = NULL;
3664 myopt.title = _("List of text search configurations");
3665 myopt.translate_header = true;
3667 printQuery(res, &myopt, pset.queryFout, pset.logfile);
3674 listTSConfigsVerbose(const char *pattern)
3676 PQExpBufferData buf;
3680 initPQExpBuffer(&buf);
3682 printfPQExpBuffer(&buf,
3683 "SELECT c.oid, c.cfgname,\n"
3686 " np.nspname as pnspname \n"
3687 "FROM pg_catalog.pg_ts_config c \n"
3688 " LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.cfgnamespace, \n"
3689 " pg_catalog.pg_ts_parser p \n"
3690 " LEFT JOIN pg_catalog.pg_namespace np ON np.oid = p.prsnamespace \n"
3691 "WHERE p.oid = c.cfgparser\n"
3694 processSQLNamePattern(pset.db, &buf, pattern, true, false,
3695 "n.nspname", "c.cfgname", NULL,
3696 "pg_catalog.pg_ts_config_is_visible(c.oid)");
3698 appendPQExpBuffer(&buf, "ORDER BY 3, 2;");
3700 res = PSQLexec(buf.data, false);
3701 termPQExpBuffer(&buf);
3705 if (PQntuples(res) == 0)
3708 psql_error("Did not find any text search configuration named \"%s\".\n",
3714 for (i = 0; i < PQntuples(res); i++)
3717 const char *cfgname;
3718 const char *nspname = NULL;
3719 const char *prsname;
3720 const char *pnspname = NULL;
3722 oid = PQgetvalue(res, i, 0);
3723 cfgname = PQgetvalue(res, i, 1);
3724 if (!PQgetisnull(res, i, 2))
3725 nspname = PQgetvalue(res, i, 2);
3726 prsname = PQgetvalue(res, i, 3);
3727 if (!PQgetisnull(res, i, 4))
3728 pnspname = PQgetvalue(res, i, 4);
3730 if (!describeOneTSConfig(oid, nspname, cfgname, pnspname, prsname))
3748 describeOneTSConfig(const char *oid, const char *nspname, const char *cfgname,
3749 const char *pnspname, const char *prsname)
3751 PQExpBufferData buf,
3754 printQueryOpt myopt = pset.popt;
3756 initPQExpBuffer(&buf);
3758 printfPQExpBuffer(&buf,
3760 " ( SELECT t.alias FROM \n"
3761 " pg_catalog.ts_token_type(c.cfgparser) AS t \n"
3762 " WHERE t.tokid = m.maptokentype ) AS \"%s\", \n"
3763 " pg_catalog.btrim( \n"
3764 " ARRAY( SELECT mm.mapdict::pg_catalog.regdictionary \n"
3765 " FROM pg_catalog.pg_ts_config_map AS mm \n"
3766 " WHERE mm.mapcfg = m.mapcfg AND mm.maptokentype = m.maptokentype \n"
3767 " ORDER BY mapcfg, maptokentype, mapseqno \n"
3768 " ) :: pg_catalog.text , \n"
3769 " '{}') AS \"%s\" \n"
3770 "FROM pg_catalog.pg_ts_config AS c, pg_catalog.pg_ts_config_map AS m \n"
3771 "WHERE c.oid = '%s' AND m.mapcfg = c.oid \n"
3772 "GROUP BY m.mapcfg, m.maptokentype, c.cfgparser \n"
3774 gettext_noop("Token"),
3775 gettext_noop("Dictionaries"),
3778 res = PSQLexec(buf.data, false);
3779 termPQExpBuffer(&buf);
3783 initPQExpBuffer(&title);
3786 appendPQExpBuffer(&title, _("Text search configuration \"%s.%s\""),
3789 appendPQExpBuffer(&title, _("Text search configuration \"%s\""),
3793 appendPQExpBuffer(&title, _("\nParser: \"%s.%s\""),
3796 appendPQExpBuffer(&title, _("\nParser: \"%s\""),
3799 myopt.nullPrint = NULL;
3800 myopt.title = title.data;
3801 myopt.footers = NULL;
3802 myopt.topt.default_footer = false;
3803 myopt.translate_header = true;
3805 printQuery(res, &myopt, pset.queryFout, pset.logfile);
3807 termPQExpBuffer(&title);
3817 * Describes foreign-data wrappers
3820 listForeignDataWrappers(const char *pattern, bool verbose)
3822 PQExpBufferData buf;
3824 printQueryOpt myopt = pset.popt;
3826 if (pset.sversion < 80400)
3828 psql_error("The server (version %d.%d) does not support foreign-data wrappers.\n",
3829 pset.sversion / 10000, (pset.sversion / 100) % 100);
3833 initPQExpBuffer(&buf);
3834 printfPQExpBuffer(&buf,
3835 "SELECT fdw.fdwname AS \"%s\",\n"
3836 " pg_catalog.pg_get_userbyid(fdw.fdwowner) AS \"%s\",\n",
3837 gettext_noop("Name"),
3838 gettext_noop("Owner"));
3839 if (pset.sversion >= 90100)
3840 appendPQExpBuffer(&buf,
3841 " fdw.fdwhandler::pg_catalog.regproc AS \"%s\",\n",
3842 gettext_noop("Handler"));
3843 appendPQExpBuffer(&buf,
3844 " fdw.fdwvalidator::pg_catalog.regproc AS \"%s\"",
3845 gettext_noop("Validator"));
3849 appendPQExpBuffer(&buf, ",\n ");
3850 printACLColumn(&buf, "fdwacl");
3851 appendPQExpBuffer(&buf,
3852 ",\n CASE WHEN fdwoptions IS NULL THEN '' ELSE "
3853 " '(' || array_to_string(ARRAY(SELECT "
3854 " quote_ident(option_name) || ' ' || "
3855 " quote_literal(option_value) FROM "
3856 " pg_options_to_table(fdwoptions)), ', ') || ')' "
3858 gettext_noop("FDW Options"));
3860 if (pset.sversion >= 90100)
3861 appendPQExpBuffer(&buf,
3862 ",\n d.description AS \"%s\" ",
3863 gettext_noop("Description"));
3866 appendPQExpBuffer(&buf, "\nFROM pg_catalog.pg_foreign_data_wrapper fdw\n");
3868 if (verbose && pset.sversion >= 90100)
3869 appendPQExpBuffer(&buf,
3870 "LEFT JOIN pg_catalog.pg_description d\n"
3871 " ON d.classoid = fdw.tableoid "
3872 "AND d.objoid = fdw.oid AND d.objsubid = 0\n");
3874 processSQLNamePattern(pset.db, &buf, pattern, false, false,
3875 NULL, "fdwname", NULL, NULL);
3877 appendPQExpBuffer(&buf, "ORDER BY 1;");
3879 res = PSQLexec(buf.data, false);
3880 termPQExpBuffer(&buf);
3884 myopt.nullPrint = NULL;
3885 myopt.title = _("List of foreign-data wrappers");
3886 myopt.translate_header = true;
3888 printQuery(res, &myopt, pset.queryFout, pset.logfile);
3897 * Describes foreign servers.
3900 listForeignServers(const char *pattern, bool verbose)
3902 PQExpBufferData buf;
3904 printQueryOpt myopt = pset.popt;
3906 if (pset.sversion < 80400)
3908 psql_error("The server (version %d.%d) does not support foreign servers.\n",
3909 pset.sversion / 10000, (pset.sversion / 100) % 100);
3913 initPQExpBuffer(&buf);
3914 printfPQExpBuffer(&buf,
3915 "SELECT s.srvname AS \"%s\",\n"
3916 " pg_catalog.pg_get_userbyid(s.srvowner) AS \"%s\",\n"
3917 " f.fdwname AS \"%s\"",
3918 gettext_noop("Name"),
3919 gettext_noop("Owner"),
3920 gettext_noop("Foreign-data wrapper"));
3924 appendPQExpBuffer(&buf, ",\n ");
3925 printACLColumn(&buf, "s.srvacl");
3926 appendPQExpBuffer(&buf,
3928 " s.srvtype AS \"%s\",\n"
3929 " s.srvversion AS \"%s\",\n"
3930 " CASE WHEN srvoptions IS NULL THEN '' ELSE "
3931 " '(' || array_to_string(ARRAY(SELECT "
3932 " quote_ident(option_name) || ' ' || "
3933 " quote_literal(option_value) FROM "
3934 " pg_options_to_table(srvoptions)), ', ') || ')' "
3936 " d.description AS \"%s\"",
3937 gettext_noop("Type"),
3938 gettext_noop("Version"),
3939 gettext_noop("FDW Options"),
3940 gettext_noop("Description"));
3943 appendPQExpBuffer(&buf,
3944 "\nFROM pg_catalog.pg_foreign_server s\n"
3945 " JOIN pg_catalog.pg_foreign_data_wrapper f ON f.oid=s.srvfdw\n");
3948 appendPQExpBuffer(&buf,
3949 "LEFT JOIN pg_description d\n "
3950 "ON d.classoid = s.tableoid AND d.objoid = s.oid "
3951 "AND d.objsubid = 0\n");
3953 processSQLNamePattern(pset.db, &buf, pattern, false, false,
3954 NULL, "s.srvname", NULL, NULL);
3956 appendPQExpBuffer(&buf, "ORDER BY 1;");
3958 res = PSQLexec(buf.data, false);
3959 termPQExpBuffer(&buf);
3963 myopt.nullPrint = NULL;
3964 myopt.title = _("List of foreign servers");
3965 myopt.translate_header = true;
3967 printQuery(res, &myopt, pset.queryFout, pset.logfile);
3976 * Describes user mappings.
3979 listUserMappings(const char *pattern, bool verbose)
3981 PQExpBufferData buf;
3983 printQueryOpt myopt = pset.popt;
3985 if (pset.sversion < 80400)
3987 psql_error("The server (version %d.%d) does not support user mappings.\n",
3988 pset.sversion / 10000, (pset.sversion / 100) % 100);
3992 initPQExpBuffer(&buf);
3993 printfPQExpBuffer(&buf,
3994 "SELECT um.srvname AS \"%s\",\n"
3995 " um.usename AS \"%s\"",
3996 gettext_noop("Server"),
3997 gettext_noop("User name"));
4000 appendPQExpBuffer(&buf,
4001 ",\n CASE WHEN umoptions IS NULL THEN '' ELSE "
4002 " '(' || array_to_string(ARRAY(SELECT "
4003 " quote_ident(option_name) || ' ' || "
4004 " quote_literal(option_value) FROM "
4005 " pg_options_to_table(umoptions)), ', ') || ')' "
4007 gettext_noop("FDW Options"));
4009 appendPQExpBuffer(&buf, "\nFROM pg_catalog.pg_user_mappings um\n");
4011 processSQLNamePattern(pset.db, &buf, pattern, false, false,
4012 NULL, "um.srvname", "um.usename", NULL);
4014 appendPQExpBuffer(&buf, "ORDER BY 1, 2;");
4016 res = PSQLexec(buf.data, false);
4017 termPQExpBuffer(&buf);
4021 myopt.nullPrint = NULL;
4022 myopt.title = _("List of user mappings");
4023 myopt.translate_header = true;
4025 printQuery(res, &myopt, pset.queryFout, pset.logfile);
4034 * Describes foreign tables.
4037 listForeignTables(const char *pattern, bool verbose)
4039 PQExpBufferData buf;
4041 printQueryOpt myopt = pset.popt;
4043 if (pset.sversion < 90100)
4045 psql_error("The server (version %d.%d) does not support foreign tables.\n",
4046 pset.sversion / 10000, (pset.sversion / 100) % 100);
4050 initPQExpBuffer(&buf);
4051 printfPQExpBuffer(&buf,
4052 "SELECT n.nspname AS \"%s\",\n"
4053 " c.relname AS \"%s\",\n"
4054 " s.srvname AS \"%s\"",
4055 gettext_noop("Schema"),
4056 gettext_noop("Table"),
4057 gettext_noop("Server"));
4060 appendPQExpBuffer(&buf,
4061 ",\n CASE WHEN ftoptions IS NULL THEN '' ELSE "
4062 " '(' || array_to_string(ARRAY(SELECT "
4063 " quote_ident(option_name) || ' ' || "
4064 " quote_literal(option_value) FROM "
4065 " pg_options_to_table(ftoptions)), ', ') || ')' "
4067 " d.description AS \"%s\"",
4068 gettext_noop("FDW Options"),
4069 gettext_noop("Description"));
4071 appendPQExpBuffer(&buf,
4072 "\nFROM pg_catalog.pg_foreign_table ft\n"
4073 " INNER JOIN pg_catalog.pg_class c"
4074 " ON c.oid = ft.ftrelid\n"
4075 " INNER JOIN pg_catalog.pg_namespace n"
4076 " ON n.oid = c.relnamespace\n"
4077 " INNER JOIN pg_catalog.pg_foreign_server s"
4078 " ON s.oid = ft.ftserver\n");
4080 appendPQExpBuffer(&buf,
4081 " LEFT JOIN pg_catalog.pg_description d\n"
4082 " ON d.classoid = c.tableoid AND "
4083 "d.objoid = c.oid AND d.objsubid = 0\n");
4085 processSQLNamePattern(pset.db, &buf, pattern, false, false,
4086 NULL, "n.nspname", "c.relname", NULL);
4088 appendPQExpBuffer(&buf, "ORDER BY 1, 2;");
4090 res = PSQLexec(buf.data, false);
4091 termPQExpBuffer(&buf);
4095 myopt.nullPrint = NULL;
4096 myopt.title = _("List of foreign tables");
4097 myopt.translate_header = true;
4099 printQuery(res, &myopt, pset.queryFout, pset.logfile);
4108 * Briefly describes installed extensions.
4111 listExtensions(const char *pattern)
4113 PQExpBufferData buf;
4115 printQueryOpt myopt = pset.popt;
4117 if (pset.sversion < 90100)
4119 psql_error("The server (version %d.%d) does not support extensions.\n",
4120 pset.sversion / 10000, (pset.sversion / 100) % 100);
4124 initPQExpBuffer(&buf);
4125 printfPQExpBuffer(&buf,
4126 "SELECT e.extname AS \"%s\", "
4127 "e.extversion AS \"%s\", n.nspname AS \"%s\", c.description AS \"%s\"\n"
4128 "FROM pg_catalog.pg_extension e "
4129 "LEFT JOIN pg_catalog.pg_namespace n ON n.oid = e.extnamespace "
4130 "LEFT JOIN pg_catalog.pg_description c ON c.objoid = e.oid "
4131 "AND c.classoid = 'pg_catalog.pg_extension'::pg_catalog.regclass\n",
4132 gettext_noop("Name"),
4133 gettext_noop("Version"),
4134 gettext_noop("Schema"),
4135 gettext_noop("Description"));
4137 processSQLNamePattern(pset.db, &buf, pattern,
4139 NULL, "e.extname", NULL,
4142 appendPQExpBuffer(&buf, "ORDER BY 1;");
4144 res = PSQLexec(buf.data, false);
4145 termPQExpBuffer(&buf);
4149 myopt.nullPrint = NULL;
4150 myopt.title = _("List of installed extensions");
4151 myopt.translate_header = true;
4153 printQuery(res, &myopt, pset.queryFout, pset.logfile);
4162 * List contents of installed extensions.
4165 listExtensionContents(const char *pattern)
4167 PQExpBufferData buf;
4171 if (pset.sversion < 90100)
4173 psql_error("The server (version %d.%d) does not support extensions.\n",
4174 pset.sversion / 10000, (pset.sversion / 100) % 100);
4178 initPQExpBuffer(&buf);
4179 printfPQExpBuffer(&buf,
4180 "SELECT e.extname, e.oid\n"
4181 "FROM pg_catalog.pg_extension e\n");
4183 processSQLNamePattern(pset.db, &buf, pattern,
4185 NULL, "e.extname", NULL,
4188 appendPQExpBuffer(&buf, "ORDER BY 1;");
4190 res = PSQLexec(buf.data, false);
4191 termPQExpBuffer(&buf);
4195 if (PQntuples(res) == 0)
4200 psql_error("Did not find any extension named \"%s\".\n",
4203 psql_error("Did not find any extensions.\n");
4209 for (i = 0; i < PQntuples(res); i++)
4211 const char *extname;
4214 extname = PQgetvalue(res, i, 0);
4215 oid = PQgetvalue(res, i, 1);
4217 if (!listOneExtensionContents(extname, oid))
4234 listOneExtensionContents(const char *extname, const char *oid)
4236 PQExpBufferData buf;
4239 printQueryOpt myopt = pset.popt;
4241 initPQExpBuffer(&buf);
4242 printfPQExpBuffer(&buf,
4243 "SELECT pg_catalog.pg_describe_object(classid, objid, 0) AS \"%s\"\n"
4244 "FROM pg_catalog.pg_depend\n"
4245 "WHERE refclassid = 'pg_catalog.pg_extension'::pg_catalog.regclass AND refobjid = '%s' AND deptype = 'e'\n"
4247 gettext_noop("Object Description"),
4250 res = PSQLexec(buf.data, false);
4251 termPQExpBuffer(&buf);
4255 myopt.nullPrint = NULL;
4256 snprintf(title, sizeof(title), _("Objects in extension \"%s\""), extname);
4257 myopt.title = title;
4258 myopt.translate_header = true;
4260 printQuery(res, &myopt, pset.queryFout, pset.logfile);
4269 * Helper function for consistently formatting ACL (privilege) columns.
4270 * The proper targetlist entry is appended to buf. Note lack of any
4271 * whitespace or comma decoration.
4274 printACLColumn(PQExpBuffer buf, const char *colname)
4276 if (pset.sversion >= 80100)
4277 appendPQExpBuffer(buf,
4278 "pg_catalog.array_to_string(%s, E'\\n') AS \"%s\"",
4279 colname, gettext_noop("Access privileges"));
4281 appendPQExpBuffer(buf,
4282 "pg_catalog.array_to_string(%s, '\\n') AS \"%s\"",
4283 colname, gettext_noop("Access privileges"));