src/include/catalog/namespace.h

   1 /*-------------------------------------------------------------------------
   2  *
   3  * namespace.h
   4  *        prototypes for functions in backend/catalog/namespace.c
   5  *
   6  *
   7  * Portions Copyright (c) 1996-2011, PostgreSQL Global Development Group
   8  * Portions Copyright (c) 1994, Regents of the University of California
   9  *
  10  * src/include/catalog/namespace.h
  11  *
  12  *-------------------------------------------------------------------------
  13  */
  14 #ifndef NAMESPACE_H
  15 #define NAMESPACE_H
  16
  17 #include "nodes/primnodes.h"
  18
  19
  20 /*
  21  *      This structure holds a list of possible functions or operators
  22  *      found by namespace lookup.      Each function/operator is identified
  23  *      by OID and by argument types; the list must be pruned by type
  24  *      resolution rules that are embodied in the parser, not here.
  25  *      See FuncnameGetCandidates's comments for more info.
  26  */
  27 typedef struct _FuncCandidateList
  28 {
  29         struct _FuncCandidateList *next;
  30         int                     pathpos;                /* for internal use of namespace lookup */
  31         Oid                     oid;                    /* the function or operator's OID */
  32         int                     nargs;                  /* number of arg types returned */
  33         int                     nvargs;                 /* number of args to become variadic array */
  34         int                     ndargs;                 /* number of defaulted args */
  35         int                *argnumbers;         /* args' positional indexes, if named call */
  36         Oid                     args[1];                /* arg types --- VARIABLE LENGTH ARRAY */
  37 }       *FuncCandidateList;     /* VARIABLE LENGTH STRUCT */
  38
  39 /*
  40  *      Structure for xxxOverrideSearchPath functions
  41  */
  42 typedef struct OverrideSearchPath
  43 {
  44         List       *schemas;            /* OIDs of explicitly named schemas */
  45         bool            addCatalog;             /* implicitly prepend pg_catalog? */
  46         bool            addTemp;                /* implicitly prepend temp schema? */
  47 } OverrideSearchPath;
  48
  49
  50 extern Oid      RangeVarGetRelid(const RangeVar *relation, bool failOK);
  51 extern Oid      RangeVarGetCreationNamespace(const RangeVar *newRelation);
  52 extern Oid      RangeVarGetAndCheckCreationNamespace(const RangeVar *newRelation);
  53 extern Oid      RelnameGetRelid(const char *relname);
  54 extern bool RelationIsVisible(Oid relid);
  55
  56 extern Oid      TypenameGetTypid(const char *typname);
  57 extern bool TypeIsVisible(Oid typid);
  58
  59 extern FuncCandidateList FuncnameGetCandidates(List *names,
  60                                           int nargs, List *argnames,
  61                                           bool expand_variadic,
  62                                           bool expand_defaults);
  63 extern bool FunctionIsVisible(Oid funcid);
  64
  65 extern Oid      OpernameGetOprid(List *names, Oid oprleft, Oid oprright);
  66 extern FuncCandidateList OpernameGetCandidates(List *names, char oprkind);
  67 extern bool OperatorIsVisible(Oid oprid);
  68
  69 extern Oid      OpclassnameGetOpcid(Oid amid, const char *opcname);
  70 extern bool OpclassIsVisible(Oid opcid);
  71
  72 extern Oid      OpfamilynameGetOpfid(Oid amid, const char *opfname);
  73 extern bool OpfamilyIsVisible(Oid opfid);
  74
  75 extern Oid      CollationGetCollid(const char *collname);
  76 extern bool CollationIsVisible(Oid collid);
  77
  78 extern Oid      ConversionGetConid(const char *conname);
  79 extern bool ConversionIsVisible(Oid conid);
  80
  81 extern Oid      get_ts_parser_oid(List *names, bool missing_ok);
  82 extern bool TSParserIsVisible(Oid prsId);
  83
  84 extern Oid      get_ts_dict_oid(List *names, bool missing_ok);
  85 extern bool TSDictionaryIsVisible(Oid dictId);
  86
  87 extern Oid      get_ts_template_oid(List *names, bool missing_ok);
  88 extern bool TSTemplateIsVisible(Oid tmplId);
  89
  90 extern Oid      get_ts_config_oid(List *names, bool missing_ok);
  91 extern bool TSConfigIsVisible(Oid cfgid);
  92
  93 extern void DeconstructQualifiedName(List *names,
  94                                                  char **nspname_p,
  95                                                  char **objname_p);
  96 extern Oid      LookupNamespaceNoError(const char *nspname);
  97 extern Oid      LookupExplicitNamespace(const char *nspname);
  98 extern Oid      get_namespace_oid(const char *nspname, bool missing_ok);
  99
 100 extern Oid      LookupCreationNamespace(const char *nspname);
 101 extern void CheckSetNamespace(Oid oldNspOid, Oid nspOid, Oid classid,
 102                                   Oid objid);
 103 extern Oid      QualifiedNameGetCreationNamespace(List *names, char **objname_p);
 104 extern RangeVar *makeRangeVarFromNameList(List *names);
 105 extern char *NameListToString(List *names);
 106 extern char *NameListToQuotedString(List *names);
 107
 108 extern bool isTempNamespace(Oid namespaceId);
 109 extern bool isTempToastNamespace(Oid namespaceId);
 110 extern bool isTempOrToastNamespace(Oid namespaceId);
 111 extern bool isAnyTempNamespace(Oid namespaceId);
 112 extern bool isOtherTempNamespace(Oid namespaceId);
 113 extern int      GetTempNamespaceBackendId(Oid namespaceId);
 114 extern Oid      GetTempToastNamespace(void);
 115 extern void ResetTempTableNamespace(void);
 116
 117 extern OverrideSearchPath *GetOverrideSearchPath(MemoryContext context);
 118 extern void PushOverrideSearchPath(OverrideSearchPath *newpath);
 119 extern void PopOverrideSearchPath(void);
 120
 121 extern Oid      get_collation_oid(List *collname, bool missing_ok);
 122 extern Oid      get_conversion_oid(List *conname, bool missing_ok);
 123 extern Oid      FindDefaultConversionProc(int4 for_encoding, int4 to_encoding);
 124
 125 /* initialization & transaction cleanup code */
 126 extern void InitializeSearchPath(void);
 127 extern void AtEOXact_Namespace(bool isCommit);
 128 extern void AtEOSubXact_Namespace(bool isCommit, SubTransactionId mySubid,
 129                                           SubTransactionId parentSubid);
 130
 131 /* stuff for search_path GUC variable */
 132 extern char *namespace_search_path;
 133
 134 extern List *fetch_search_path(bool includeImplicit);
 135 extern int      fetch_search_path_array(Oid *sarray, int sarray_len);
 136
 137 #endif   /* NAMESPACE_H */