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-2020, 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 *pattern, bool verbose, bool showSystem);
23 
24 /* \dT */
25 extern bool describeTypes(const char *pattern, bool verbose, bool showSystem);
26 
27 /* \do */
28 extern bool describeOperators(const char *pattern, bool verbose, bool showSystem);
29 
30 /* \du, \dg */
31 extern bool describeRoles(const char *pattern, bool verbose, bool showSystem);
32 
33 /* \drds */
34 extern bool listDbRoleSettings(const char *pattern, const char *pattern2);
35 
36 /* \z (or \dp) */
37 extern bool permissionsList(const char *pattern);
38 
39 /* \ddp */
40 extern bool listDefaultACLs(const char *pattern);
41 
42 /* \dd */
43 extern bool objectDescription(const char *pattern, bool showSystem);
44 
45 /* \d foo */
46 extern bool describeTableDetails(const char *pattern, bool verbose, bool showSystem);
47 
48 /* \dF */
49 extern bool listTSConfigs(const char *pattern, bool verbose);
50 
51 /* \dFp */
52 extern bool listTSParsers(const char *pattern, bool verbose);
53 
54 /* \dFd */
55 extern bool listTSDictionaries(const char *pattern, bool verbose);
56 
57 /* \dFt */
58 extern bool listTSTemplates(const char *pattern, bool verbose);
59 
60 /* \l */
61 extern bool listAllDbs(const char *pattern, bool verbose);
62 
63 /* \dt, \di, \ds, \dS, etc. */
64 extern bool listTables(const char *tabtypes, const char *pattern, bool verbose, bool showSystem);
65 
66 /* \dP */
67 extern bool listPartitionedTables(const char *reltypes, const char *pattern, bool verbose);
68 
69 /* \dD */
70 extern bool listDomains(const char *pattern, bool verbose, bool showSystem);
71 
72 /* \dc */
73 extern bool listConversions(const char *pattern, bool verbose, bool showSystem);
74 
75 /* \dC */
76 extern bool listCasts(const char *pattern, bool verbose);
77 
78 /* \dO */
79 extern bool listCollations(const char *pattern, bool verbose, bool showSystem);
80 
81 /* \dn */
82 extern bool listSchemas(const char *pattern, bool verbose, bool showSystem);
83 
84 /* \dew */
85 extern bool listForeignDataWrappers(const char *pattern, bool verbose);
86 
87 /* \des */
88 extern bool listForeignServers(const char *pattern, bool verbose);
89 
90 /* \deu */
91 extern bool listUserMappings(const char *pattern, bool verbose);
92 
93 /* \det */
94 extern bool listForeignTables(const char *pattern, bool verbose);
95 
96 /* \dL */
97 extern bool listLanguages(const char *pattern, bool verbose, bool showSystem);
98 
99 /* \dx */
100 extern bool listExtensions(const char *pattern);
101 
102 /* \dx+ */
103 extern bool listExtensionContents(const char *pattern);
104 
105 /* \dy */
106 extern bool listEventTriggers(const char *pattern, bool verbose);
107 
108 /* \dRp */
109 bool listPublications(const char *pattern);
110 
111 /* \dRp+ */
112 bool describePublications(const char *pattern);
113 
114 /* \dRs */
115 bool describeSubscriptions(const char *pattern, bool verbose);
116 
117 /* \dAc */
118 extern bool listOperatorClasses(const char *access_method_pattern,
119  const char *opclass_pattern,
120  bool verbose);
121 
122 /* \dAf */
123 extern bool listOperatorFamilies(const char *access_method_pattern,
124  const char *opclass_pattern,
125  bool verbose);
126 
127 /* \dAo */
128 extern bool listOpFamilyOperators(const char *accessMethod_pattern,
129  const char *family_pattern, bool verbose);
130 
131 /* \dAp */
132 extern bool listOpFamilyFunctions(const char *access_method_pattern,
133  const char *family_pattern);
134 
135 
136 #endif /* DESCRIBE_H */
bool listOperatorClasses(const char *access_method_pattern, const char *opclass_pattern, bool verbose)
Definition: describe.c:6056
bool listTables(const char *tabtypes, const char *pattern, bool verbose, bool showSystem)
Definition: describe.c:3668
bool listCasts(const char *pattern, bool verbose)
Definition: describe.c:4376
bool listDomains(const char *pattern, bool verbose, bool showSystem)
Definition: describe.c:4148
bool listEventTriggers(const char *pattern, bool verbose)
Definition: describe.c:4310
bool listUserMappings(const char *pattern, bool verbose)
Definition: describe.c:5410
bool describeTablespaces(const char *pattern, bool verbose)
Definition: describe.c:219
bool listTSConfigs(const char *pattern, bool verbose)
Definition: describe.c:5039
bool listExtensionContents(const char *pattern)
Definition: describe.c:5606
bool describeSubscriptions(const char *pattern, bool verbose)
Definition: describe.c:5960
bool listForeignTables(const char *pattern, bool verbose)
Definition: describe.c:5471
bool listAllDbs(const char *pattern, bool verbose)
Definition: describe.c:860
bool listExtensions(const char *pattern)
Definition: describe.c:5549
bool listPartitionedTables(const char *reltypes, const char *pattern, bool verbose)
Definition: describe.c:3869
bool listConversions(const char *pattern, bool verbose, bool showSystem)
Definition: describe.c:4234
bool listPublications(const char *pattern)
Definition: describe.c:5719
bool listForeignServers(const char *pattern, bool verbose)
Definition: describe.c:5328
bool describePublications(const char *pattern)
Definition: describe.c:5794
bool listOpFamilyFunctions(const char *access_method_pattern, const char *family_pattern)
Definition: describe.c:6319
bool permissionsList(const char *pattern)
Definition: describe.c:930
bool describeAggregates(const char *pattern, bool verbose, bool showSystem)
Definition: describe.c:63
bool listTSParsers(const char *pattern, bool verbose)
Definition: describe.c:4650
static int verbose
bool describeTableDetails(const char *pattern, bool verbose, bool showSystem)
Definition: describe.c:1367
bool listForeignDataWrappers(const char *pattern, bool verbose)
Definition: describe.c:5245
bool listDbRoleSettings(const char *pattern, const char *pattern2)
Definition: describe.c:3584
bool listTSTemplates(const char *pattern, bool verbose)
Definition: describe.c:4968
bool describeOperators(const char *pattern, bool verbose, bool showSystem)
Definition: describe.c:783
bool describeRoles(const char *pattern, bool verbose, bool showSystem)
Definition: describe.c:3413
bool describeAccessMethods(const char *pattern, bool verbose)
Definition: describe.c:149
bool listTSDictionaries(const char *pattern, bool verbose)
Definition: describe.c:4897
bool listOperatorFamilies(const char *access_method_pattern, const char *opclass_pattern, bool verbose)
Definition: describe.c:6144
bool listSchemas(const char *pattern, bool verbose, bool showSystem)
Definition: describe.c:4593
bool objectDescription(const char *pattern, bool showSystem)
Definition: describe.c:1175
bool describeTypes(const char *pattern, bool verbose, bool showSystem)
Definition: describe.c:667
bool describeFunctions(const char *functypes, const char *pattern, bool verbose, bool showSystem)
Definition: describe.c:315
bool listDefaultACLs(const char *pattern)
Definition: describe.c:1090
bool listOpFamilyOperators(const char *accessMethod_pattern, const char *family_pattern, bool verbose)
Definition: describe.c:6223
bool listCollations(const char *pattern, bool verbose, bool showSystem)
Definition: describe.c:4494
bool listLanguages(const char *pattern, bool verbose, bool showSystem)
Definition: describe.c:4073