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-2023, 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 /* \z (or \dp) */
41 extern bool permissionsList(const char *pattern, bool showSystem);
42 
43 /* \ddp */
44 extern bool listDefaultACLs(const char *pattern);
45 
46 /* \dd */
47 extern bool objectDescription(const char *pattern, bool showSystem);
48 
49 /* \d foo */
50 extern bool describeTableDetails(const char *pattern, bool verbose, bool showSystem);
51 
52 /* \dF */
53 extern bool listTSConfigs(const char *pattern, bool verbose);
54 
55 /* \dFp */
56 extern bool listTSParsers(const char *pattern, bool verbose);
57 
58 /* \dFd */
59 extern bool listTSDictionaries(const char *pattern, bool verbose);
60 
61 /* \dFt */
62 extern bool listTSTemplates(const char *pattern, bool verbose);
63 
64 /* \l */
65 extern bool listAllDbs(const char *pattern, bool verbose);
66 
67 /* \dt, \di, \ds, \dS, etc. */
68 extern bool listTables(const char *tabtypes, const char *pattern, bool verbose, bool showSystem);
69 
70 /* \dP */
71 extern bool listPartitionedTables(const char *reltypes, const char *pattern, bool verbose);
72 
73 /* \dD */
74 extern bool listDomains(const char *pattern, bool verbose, bool showSystem);
75 
76 /* \dc */
77 extern bool listConversions(const char *pattern, bool verbose, bool showSystem);
78 
79 /* \dconfig */
80 extern bool describeConfigurationParameters(const char *pattern, bool verbose,
81  bool showSystem);
82 
83 /* \dC */
84 extern bool listCasts(const char *pattern, bool verbose);
85 
86 /* \dO */
87 extern bool listCollations(const char *pattern, bool verbose, bool showSystem);
88 
89 /* \dn */
90 extern bool listSchemas(const char *pattern, bool verbose, bool showSystem);
91 
92 /* \dew */
93 extern bool listForeignDataWrappers(const char *pattern, bool verbose);
94 
95 /* \des */
96 extern bool listForeignServers(const char *pattern, bool verbose);
97 
98 /* \deu */
99 extern bool listUserMappings(const char *pattern, bool verbose);
100 
101 /* \det */
102 extern bool listForeignTables(const char *pattern, bool verbose);
103 
104 /* \dL */
105 extern bool listLanguages(const char *pattern, bool verbose, bool showSystem);
106 
107 /* \dx */
108 extern bool listExtensions(const char *pattern);
109 
110 /* \dx+ */
111 extern bool listExtensionContents(const char *pattern);
112 
113 /* \dX */
114 extern bool listExtendedStats(const char *pattern);
115 
116 /* \dy */
117 extern bool listEventTriggers(const char *pattern, bool verbose);
118 
119 /* \dRp */
120 bool listPublications(const char *pattern);
121 
122 /* \dRp+ */
123 bool describePublications(const char *pattern);
124 
125 /* \dRs */
126 bool describeSubscriptions(const char *pattern, bool verbose);
127 
128 /* \dAc */
129 extern bool listOperatorClasses(const char *access_method_pattern,
130  const char *type_pattern,
131  bool verbose);
132 
133 /* \dAf */
134 extern bool listOperatorFamilies(const char *access_method_pattern,
135  const char *type_pattern,
136  bool verbose);
137 
138 /* \dAo */
139 extern bool listOpFamilyOperators(const char *access_method_pattern,
140  const char *family_pattern, bool verbose);
141 
142 /* \dAp */
143 extern bool listOpFamilyFunctions(const char *access_method_pattern,
144  const char *family_pattern, bool verbose);
145 
146 /* \dl or \lo_list */
147 extern bool listLargeObjects(bool verbose);
148 
149 #endif /* DESCRIBE_H */
bool listUserMappings(const char *pattern, bool verbose)
Definition: describe.c:5835
bool listTSConfigs(const char *pattern, bool verbose)
Definition: describe.c:5480
bool describeRoles(const char *pattern, bool verbose, bool showSystem)
Definition: describe.c:3614
bool listOpFamilyFunctions(const char *access_method_pattern, const char *family_pattern, bool verbose)
Definition: describe.c:6917
bool listPublications(const char *pattern)
Definition: describe.c:6181
bool listTSParsers(const char *pattern, bool verbose)
Definition: describe.c:5098
bool listExtensionContents(const char *pattern)
Definition: describe.c:6016
bool describeAggregates(const char *pattern, bool verbose, bool showSystem)
Definition: describe.c:71
bool listForeignDataWrappers(const char *pattern, bool verbose)
Definition: describe.c:5686
bool listPartitionedTables(const char *reltypes, const char *pattern, bool verbose)
Definition: describe.c:4052
bool describeSubscriptions(const char *pattern, bool verbose)
Definition: describe.c:6490
bool listExtendedStats(const char *pattern)
Definition: describe.c:4645
bool describeTypes(const char *pattern, bool verbose, bool showSystem)
Definition: describe.c:619
bool listOperatorFamilies(const char *access_method_pattern, const char *type_pattern, bool verbose)
Definition: describe.c:6728
bool listForeignServers(const char *pattern, bool verbose)
Definition: describe.c:5758
bool describeTableDetails(const char *pattern, bool verbose, bool showSystem)
Definition: describe.c:1446
bool listDomains(const char *pattern, bool verbose, bool showSystem)
Definition: describe.c:4330
bool listTSDictionaries(const char *pattern, bool verbose)
Definition: describe.c:5348
bool listDbRoleSettings(const char *pattern, const char *pattern2)
Definition: describe.c:3769
bool describeFunctions(const char *functypes, const char *func_pattern, char **arg_patterns, int num_arg_patterns, bool verbose, bool showSystem)
Definition: describe.c:291
bool listCollations(const char *pattern, bool verbose, bool showSystem)
Definition: describe.c:4861
bool listSchemas(const char *pattern, bool verbose, bool showSystem)
Definition: describe.c:4976
bool listExtensions(const char *pattern)
Definition: describe.c:5964
bool listTables(const char *tabtypes, const char *pattern, bool verbose, bool showSystem)
Definition: describe.c:3853
bool listTSTemplates(const char *pattern, bool verbose)
Definition: describe.c:5414
bool describeTablespaces(const char *pattern, bool verbose)
Definition: describe.c:217
bool listCasts(const char *pattern, bool verbose)
Definition: describe.c:4742
bool listOpFamilyOperators(const char *access_method_pattern, const char *family_pattern, bool verbose)
Definition: describe.c:6818
bool describeOperators(const char *oper_pattern, char **arg_patterns, int num_arg_patterns, bool verbose, bool showSystem)
Definition: describe.c:775
bool listOperatorClasses(const char *access_method_pattern, const char *type_pattern, bool verbose)
Definition: describe.c:6626
bool listForeignTables(const char *pattern, bool verbose)
Definition: describe.c:5891
bool describeConfigurationParameters(const char *pattern, bool verbose, bool showSystem)
Definition: describe.c:4495
bool listEventTriggers(const char *pattern, bool verbose)
Definition: describe.c:4564
bool listDefaultACLs(const char *pattern)
Definition: describe.c:1174
bool listAllDbs(const char *pattern, bool verbose)
Definition: describe.c:917
bool listConversions(const char *pattern, bool verbose, bool showSystem)
Definition: describe.c:4414
bool permissionsList(const char *pattern, bool showSystem)
Definition: describe.c:1014
bool describeAccessMethods(const char *pattern, bool verbose)
Definition: describe.c:142
bool listLargeObjects(bool verbose)
Definition: describe.c:7007
bool listLanguages(const char *pattern, bool verbose, bool showSystem)
Definition: describe.c:4253
bool describePublications(const char *pattern)
Definition: describe.c:6304
bool objectDescription(const char *pattern, bool showSystem)
Definition: describe.c:1252
int verbose