src/bin/psql/describe.h

   1 /*
   2  * psql - the PostgreSQL interactive terminal
   3  *
   4  * Copyright (c) 2000-2021, 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);
  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 /* \dC */
  80 extern bool listCasts(const char *pattern, bool verbose);
  81
  82 /* \dO */
  83 extern bool listCollations(const char *pattern, bool verbose, bool showSystem);
  84
  85 /* \dn */
  86 extern bool listSchemas(const char *pattern, bool verbose, bool showSystem);
  87
  88 /* \dew */
  89 extern bool listForeignDataWrappers(const char *pattern, bool verbose);
  90
  91 /* \des */
  92 extern bool listForeignServers(const char *pattern, bool verbose);
  93
  94 /* \deu */
  95 extern bool listUserMappings(const char *pattern, bool verbose);
  96
  97 /* \det */
  98 extern bool listForeignTables(const char *pattern, bool verbose);
  99
 100 /* \dL */
 101 extern bool listLanguages(const char *pattern, bool verbose, bool showSystem);
 102
 103 /* \dx */
 104 extern bool listExtensions(const char *pattern);
 105
 106 /* \dx+ */
 107 extern bool listExtensionContents(const char *pattern);
 108
 109 /* \dX */
 110 extern bool listExtendedStats(const char *pattern);
 111
 112 /* \dy */
 113 extern bool listEventTriggers(const char *pattern, bool verbose);
 114
 115 /* \dRp */
 116 bool            listPublications(const char *pattern);
 117
 118 /* \dRp+ */
 119 bool            describePublications(const char *pattern);
 120
 121 /* \dRs */
 122 bool            describeSubscriptions(const char *pattern, bool verbose);
 123
 124 /* \dAc */
 125 extern bool listOperatorClasses(const char *access_method_pattern,
 126                                                                 const char *opclass_pattern,
 127                                                                 bool verbose);
 128
 129 /* \dAf */
 130 extern bool listOperatorFamilies(const char *access_method_pattern,
 131                                                                  const char *opclass_pattern,
 132                                                                  bool verbose);
 133
 134 /* \dAo */
 135 extern bool listOpFamilyOperators(const char *accessMethod_pattern,
 136                                                                   const char *family_pattern, bool verbose);
 137
 138 /* \dAp */
 139 extern bool listOpFamilyFunctions(const char *access_method_pattern,
 140                                                                   const char *family_pattern, bool verbose);
 141
 142
 143 #endif                                                  /* DESCRIBE_H */