PostgreSQL Source Code  git master
describe.h
Go to the documentation of this file.
1 /*
2  * psql - the PostgreSQL interactive terminal
3  *
4  * Copyright (c) 2000-2024, PostgreSQL Global Development Group
5  *
6  * src/bin/psql/describe.h
7  */
8 #ifndef DESCRIBE_H
9 #define DESCRIBE_H
10 
11 
12 /* \da */
13 extern bool describeAggregates(const char *pattern, bool verbose, bool showSystem);
14 
15 /* \dA */
16 extern bool describeAccessMethods(const char *pattern, bool verbose);
17 
18 /* \db */
19 extern bool describeTablespaces(const char *pattern, bool verbose);
20 
21 /* \df, \dfa, \dfn, \dft, \dfw, etc. */
22 extern bool describeFunctions(const char *functypes, const char *func_pattern,
23  char **arg_patterns, int num_arg_patterns,
24  bool verbose, bool showSystem);
25 
26 /* \dT */
27 extern bool describeTypes(const char *pattern, bool verbose, bool showSystem);
28 
29 /* \do */
30 extern bool describeOperators(const char *oper_pattern,
31  char **arg_patterns, int num_arg_patterns,
32  bool verbose, bool showSystem);
33 
34 /* \du, \dg */
35 extern bool describeRoles(const char *pattern, bool verbose, bool showSystem);
36 
37 /* \drds */
38 extern bool listDbRoleSettings(const char *pattern, const char *pattern2);
39 
40 /* \drg */
41 extern bool describeRoleGrants(const char *pattern, bool showSystem);
42 
43 /* \z (or \dp) */
44 extern bool permissionsList(const char *pattern, bool showSystem);
45 
46 /* \ddp */
47 extern bool listDefaultACLs(const char *pattern);
48 
49 /* \dd */
50 extern bool objectDescription(const char *pattern, bool showSystem);
51 
52 /* \d foo */
53 extern bool describeTableDetails(const char *pattern, bool verbose, bool showSystem);
54 
55 /* \dF */
56 extern bool listTSConfigs(const char *pattern, bool verbose);
57 
58 /* \dFp */
59 extern bool listTSParsers(const char *pattern, bool verbose);
60 
61 /* \dFd */
62 extern bool listTSDictionaries(const char *pattern, bool verbose);
63 
64 /* \dFt */
65 extern bool listTSTemplates(const char *pattern, bool verbose);
66 
67 /* \l */
68 extern bool listAllDbs(const char *pattern, bool verbose);
69 
70 /* \dt, \di, \ds, \dS, etc. */
71 extern bool listTables(const char *tabtypes, const char *pattern, bool verbose, bool showSystem);
72 
73 /* \dP */
74 extern bool listPartitionedTables(const char *reltypes, const char *pattern, bool verbose);
75 
76 /* \dD */
77 extern bool listDomains(const char *pattern, bool verbose, bool showSystem);
78 
79 /* \dc */
80 extern bool listConversions(const char *pattern, bool verbose, bool showSystem);
81 
82 /* \dconfig */
83 extern bool describeConfigurationParameters(const char *pattern, bool verbose,
84  bool showSystem);
85 
86 /* \dC */
87 extern bool listCasts(const char *pattern, bool verbose);
88 
89 /* \dO */
90 extern bool listCollations(const char *pattern, bool verbose, bool showSystem);
91 
92 /* \dn */
93 extern bool listSchemas(const char *pattern, bool verbose, bool showSystem);
94 
95 /* \dew */
96 extern bool listForeignDataWrappers(const char *pattern, bool verbose);
97 
98 /* \des */
99 extern bool listForeignServers(const char *pattern, bool verbose);
100 
101 /* \deu */
102 extern bool listUserMappings(const char *pattern, bool verbose);
103 
104 /* \det */
105 extern bool listForeignTables(const char *pattern, bool verbose);
106 
107 /* \dL */
108 extern bool listLanguages(const char *pattern, bool verbose, bool showSystem);
109 
110 /* \dx */
111 extern bool listExtensions(const char *pattern);
112 
113 /* \dx+ */
114 extern bool listExtensionContents(const char *pattern);
115 
116 /* \dX */
117 extern bool listExtendedStats(const char *pattern);
118 
119 /* \dy */
120 extern bool listEventTriggers(const char *pattern, bool verbose);
121 
122 /* \dRp */
123 bool listPublications(const char *pattern);
124 
125 /* \dRp+ */
126 bool describePublications(const char *pattern);
127 
128 /* \dRs */
129 bool describeSubscriptions(const char *pattern, bool verbose);
130 
131 /* \dAc */
132 extern bool listOperatorClasses(const char *access_method_pattern,
133  const char *type_pattern,
134  bool verbose);
135 
136 /* \dAf */
137 extern bool listOperatorFamilies(const char *access_method_pattern,
138  const char *type_pattern,
139  bool verbose);
140 
141 /* \dAo */
142 extern bool listOpFamilyOperators(const char *access_method_pattern,
143  const char *family_pattern, bool verbose);
144 
145 /* \dAp */
146 extern bool listOpFamilyFunctions(const char *access_method_pattern,
147  const char *family_pattern, bool verbose);
148 
149 /* \dl or \lo_list */
150 extern bool listLargeObjects(bool verbose);
151 
152 #endif /* DESCRIBE_H */
bool listUserMappings(const char *pattern, bool verbose)
Definition: describe.c:5918
bool listTSConfigs(const char *pattern, bool verbose)
Definition: describe.c:5567
bool describeRoles(const char *pattern, bool verbose, bool showSystem)
Definition: describe.c:3661
bool listOpFamilyFunctions(const char *access_method_pattern, const char *family_pattern, bool verbose)
Definition: describe.c:7008
bool listPublications(const char *pattern)
Definition: describe.c:6260
bool listTSParsers(const char *pattern, bool verbose)
Definition: describe.c:5190
bool listExtensionContents(const char *pattern)
Definition: describe.c:6096
bool describeAggregates(const char *pattern, bool verbose, bool showSystem)
Definition: describe.c:71
bool listForeignDataWrappers(const char *pattern, bool verbose)
Definition: describe.c:5771
bool listPartitionedTables(const char *reltypes, const char *pattern, bool verbose)
Definition: describe.c:4154
bool describeSubscriptions(const char *pattern, bool verbose)
Definition: describe.c:6568
bool describeRoleGrants(const char *pattern, bool showSystem)
Definition: describe.c:3877
bool listExtendedStats(const char *pattern)
Definition: describe.c:4741
bool describeTypes(const char *pattern, bool verbose, bool showSystem)
Definition: describe.c:615
bool listOperatorFamilies(const char *access_method_pattern, const char *type_pattern, bool verbose)
Definition: describe.c:6821
bool listForeignServers(const char *pattern, bool verbose)
Definition: describe.c:5842
bool describeTableDetails(const char *pattern, bool verbose, bool showSystem)
Definition: describe.c:1441
bool listDomains(const char *pattern, bool verbose, bool showSystem)
Definition: describe.c:4430
bool listTSDictionaries(const char *pattern, bool verbose)
Definition: describe.c:5437
bool listDbRoleSettings(const char *pattern, const char *pattern2)
Definition: describe.c:3808
bool describeFunctions(const char *functypes, const char *func_pattern, char **arg_patterns, int num_arg_patterns, bool verbose, bool showSystem)
Definition: describe.c:288
bool listCollations(const char *pattern, bool verbose, bool showSystem)
Definition: describe.c:4955
bool listSchemas(const char *pattern, bool verbose, bool showSystem)
Definition: describe.c:5069
bool listExtensions(const char *pattern)
Definition: describe.c:6045
bool listTables(const char *tabtypes, const char *pattern, bool verbose, bool showSystem)
Definition: describe.c:3956
bool listTSTemplates(const char *pattern, bool verbose)
Definition: describe.c:5502
bool describeTablespaces(const char *pattern, bool verbose)
Definition: describe.c:215
bool listCasts(const char *pattern, bool verbose)
Definition: describe.c:4837
bool listOpFamilyOperators(const char *access_method_pattern, const char *family_pattern, bool verbose)
Definition: describe.c:6910
bool describeOperators(const char *oper_pattern, char **arg_patterns, int num_arg_patterns, bool verbose, bool showSystem)
Definition: describe.c:770
bool listOperatorClasses(const char *access_method_pattern, const char *type_pattern, bool verbose)
Definition: describe.c:6720
bool listForeignTables(const char *pattern, bool verbose)
Definition: describe.c:5973
bool describeConfigurationParameters(const char *pattern, bool verbose, bool showSystem)
Definition: describe.c:4593
bool listEventTriggers(const char *pattern, bool verbose)
Definition: describe.c:4661
bool listDefaultACLs(const char *pattern)
Definition: describe.c:1171
bool listAllDbs(const char *pattern, bool verbose)
Definition: describe.c:911
bool listConversions(const char *pattern, bool verbose, bool showSystem)
Definition: describe.c:4513
bool permissionsList(const char *pattern, bool showSystem)
Definition: describe.c:1007
bool describeAccessMethods(const char *pattern, bool verbose)
Definition: describe.c:141
bool listLargeObjects(bool verbose)
Definition: describe.c:7097
bool listLanguages(const char *pattern, bool verbose, bool showSystem)
Definition: describe.c:4354
bool describePublications(const char *pattern)
Definition: describe.c:6382
bool objectDescription(const char *pattern, bool showSystem)
Definition: describe.c:1248
int verbose