1 /*-------------------------------------------------------------------------
4 * prototypes for functions in backend/catalog/namespace.c
7 * Portions Copyright (c) 1996-2013, PostgreSQL Global Development Group
8 * Portions Copyright (c) 1994, Regents of the University of California
10 * src/include/catalog/namespace.h
12 *-------------------------------------------------------------------------
17 #include "nodes/primnodes.h"
18 #include "storage/lock.h"
22 * This structure holds a list of possible functions or operators
23 * found by namespace lookup. Each function/operator is identified
24 * by OID and by argument types; the list must be pruned by type
25 * resolution rules that are embodied in the parser, not here.
26 * See FuncnameGetCandidates's comments for more info.
28 typedef struct _FuncCandidateList
30 struct _FuncCandidateList *next;
31 int pathpos; /* for internal use of namespace lookup */
32 Oid oid; /* the function or operator's OID */
33 int nargs; /* number of arg types returned */
34 int nvargs; /* number of args to become variadic array */
35 int ndargs; /* number of defaulted args */
36 int *argnumbers; /* args' positional indexes, if named call */
37 Oid args[1]; /* arg types --- VARIABLE LENGTH ARRAY */
38 } *FuncCandidateList; /* VARIABLE LENGTH STRUCT */
41 * Structure for xxxOverrideSearchPath functions
43 typedef struct OverrideSearchPath
45 List *schemas; /* OIDs of explicitly named schemas */
46 bool addCatalog; /* implicitly prepend pg_catalog? */
47 bool addTemp; /* implicitly prepend temp schema? */
50 typedef void (*RangeVarGetRelidCallback) (const RangeVar *relation, Oid relId,
51 Oid oldRelId, void *callback_arg);
53 #define RangeVarGetRelid(relation, lockmode, missing_ok) \
54 RangeVarGetRelidExtended(relation, lockmode, missing_ok, false, NULL, NULL)
56 extern Oid RangeVarGetRelidExtended(const RangeVar *relation,
57 LOCKMODE lockmode, bool missing_ok, bool nowait,
58 RangeVarGetRelidCallback callback,
60 extern Oid RangeVarGetCreationNamespace(const RangeVar *newRelation);
61 extern Oid RangeVarGetAndCheckCreationNamespace(RangeVar *newRelation,
63 Oid *existing_relation_id);
64 extern void RangeVarAdjustRelationPersistence(RangeVar *newRelation, Oid nspid);
65 extern Oid RelnameGetRelid(const char *relname);
66 extern bool RelationIsVisible(Oid relid);
68 extern Oid TypenameGetTypid(const char *typname);
69 extern bool TypeIsVisible(Oid typid);
71 extern FuncCandidateList FuncnameGetCandidates(List *names,
72 int nargs, List *argnames,
74 bool expand_defaults);
75 extern bool FunctionIsVisible(Oid funcid);
77 extern Oid OpernameGetOprid(List *names, Oid oprleft, Oid oprright);
78 extern FuncCandidateList OpernameGetCandidates(List *names, char oprkind);
79 extern bool OperatorIsVisible(Oid oprid);
81 extern Oid OpclassnameGetOpcid(Oid amid, const char *opcname);
82 extern bool OpclassIsVisible(Oid opcid);
84 extern Oid OpfamilynameGetOpfid(Oid amid, const char *opfname);
85 extern bool OpfamilyIsVisible(Oid opfid);
87 extern Oid CollationGetCollid(const char *collname);
88 extern bool CollationIsVisible(Oid collid);
90 extern Oid ConversionGetConid(const char *conname);
91 extern bool ConversionIsVisible(Oid conid);
93 extern Oid get_ts_parser_oid(List *names, bool missing_ok);
94 extern bool TSParserIsVisible(Oid prsId);
96 extern Oid get_ts_dict_oid(List *names, bool missing_ok);
97 extern bool TSDictionaryIsVisible(Oid dictId);
99 extern Oid get_ts_template_oid(List *names, bool missing_ok);
100 extern bool TSTemplateIsVisible(Oid tmplId);
102 extern Oid get_ts_config_oid(List *names, bool missing_ok);
103 extern bool TSConfigIsVisible(Oid cfgid);
105 extern void DeconstructQualifiedName(List *names,
108 extern Oid LookupNamespaceNoError(const char *nspname);
109 extern Oid LookupExplicitNamespace(const char *nspname);
110 extern Oid get_namespace_oid(const char *nspname, bool missing_ok);
112 extern Oid LookupCreationNamespace(const char *nspname);
113 extern void CheckSetNamespace(Oid oldNspOid, Oid nspOid, Oid classid,
115 extern Oid QualifiedNameGetCreationNamespace(List *names, char **objname_p);
116 extern RangeVar *makeRangeVarFromNameList(List *names);
117 extern char *NameListToString(List *names);
118 extern char *NameListToQuotedString(List *names);
120 extern bool isTempNamespace(Oid namespaceId);
121 extern bool isTempToastNamespace(Oid namespaceId);
122 extern bool isTempOrToastNamespace(Oid namespaceId);
123 extern bool isAnyTempNamespace(Oid namespaceId);
124 extern bool isOtherTempNamespace(Oid namespaceId);
125 extern int GetTempNamespaceBackendId(Oid namespaceId);
126 extern Oid GetTempToastNamespace(void);
127 extern void ResetTempTableNamespace(void);
129 extern OverrideSearchPath *GetOverrideSearchPath(MemoryContext context);
130 extern OverrideSearchPath *CopyOverrideSearchPath(OverrideSearchPath *path);
131 extern bool OverrideSearchPathMatchesCurrent(OverrideSearchPath *path);
132 extern void PushOverrideSearchPath(OverrideSearchPath *newpath);
133 extern void PopOverrideSearchPath(void);
135 extern Oid get_collation_oid(List *collname, bool missing_ok);
136 extern Oid get_conversion_oid(List *conname, bool missing_ok);
137 extern Oid FindDefaultConversionProc(int32 for_encoding, int32 to_encoding);
139 /* initialization & transaction cleanup code */
140 extern void InitializeSearchPath(void);
141 extern void AtEOXact_Namespace(bool isCommit);
142 extern void AtEOSubXact_Namespace(bool isCommit, SubTransactionId mySubid,
143 SubTransactionId parentSubid);
145 /* stuff for search_path GUC variable */
146 extern char *namespace_search_path;
148 extern List *fetch_search_path(bool includeImplicit);
149 extern int fetch_search_path_array(Oid *sarray, int sarray_len);
151 #endif /* NAMESPACE_H */