1 /*-------------------------------------------------------------------------
4 * code to support accessing and searching namespaces
6 * This is separate from pg_namespace.c, which contains the routines that
7 * directly manipulate the pg_namespace system catalog. This module
8 * provides routines associated with defining a "namespace search path"
9 * and implementing search-path-controlled searches.
12 * Portions Copyright (c) 1996-2019, PostgreSQL Global Development Group
13 * Portions Copyright (c) 1994, Regents of the University of California
16 * src/backend/catalog/namespace.c
18 *-------------------------------------------------------------------------
22 #include "access/htup_details.h"
23 #include "access/parallel.h"
24 #include "access/xact.h"
25 #include "access/xlog.h"
26 #include "catalog/dependency.h"
27 #include "catalog/objectaccess.h"
28 #include "catalog/pg_authid.h"
29 #include "catalog/pg_collation.h"
30 #include "catalog/pg_conversion.h"
31 #include "catalog/pg_namespace.h"
32 #include "catalog/pg_opclass.h"
33 #include "catalog/pg_operator.h"
34 #include "catalog/pg_opfamily.h"
35 #include "catalog/pg_proc.h"
36 #include "catalog/pg_statistic_ext.h"
37 #include "catalog/pg_ts_config.h"
38 #include "catalog/pg_ts_dict.h"
39 #include "catalog/pg_ts_parser.h"
40 #include "catalog/pg_ts_template.h"
41 #include "catalog/pg_type.h"
42 #include "commands/dbcommands.h"
44 #include "mb/pg_wchar.h"
45 #include "miscadmin.h"
46 #include "nodes/makefuncs.h"
47 #include "parser/parse_func.h"
48 #include "storage/ipc.h"
49 #include "storage/lmgr.h"
50 #include "storage/sinvaladt.h"
51 #include "utils/acl.h"
52 #include "utils/builtins.h"
53 #include "utils/catcache.h"
54 #include "utils/guc.h"
55 #include "utils/inval.h"
56 #include "utils/lsyscache.h"
57 #include "utils/memutils.h"
58 #include "utils/syscache.h"
59 #include "utils/varlena.h"
63 * The namespace search path is a possibly-empty list of namespace OIDs.
64 * In addition to the explicit list, implicitly-searched namespaces
67 * 1. If a TEMP table namespace has been initialized in this session, it
68 * is implicitly searched first. (The only time this doesn't happen is
69 * when we are obeying an override search path spec that says not to use the
70 * temp namespace, or the temp namespace is included in the explicit list.)
72 * 2. The system catalog namespace is always searched. If the system
73 * namespace is present in the explicit path then it will be searched in
74 * the specified order; otherwise it will be searched after TEMP tables and
75 * *before* the explicit list. (It might seem that the system namespace
76 * should be implicitly last, but this behavior appears to be required by
77 * SQL99. Also, this provides a way to search the system namespace first
78 * without thereby making it the default creation target namespace.)
80 * For security reasons, searches using the search path will ignore the temp
81 * namespace when searching for any object type other than relations and
82 * types. (We must allow types since temp tables have rowtypes.)
84 * The default creation target namespace is always the first element of the
85 * explicit list. If the explicit list is empty, there is no default target.
87 * The textual specification of search_path can include "$user" to refer to
88 * the namespace named the same as the current user, if any. (This is just
89 * ignored if there is no such namespace.) Also, it can include "pg_temp"
90 * to refer to the current backend's temp namespace. This is usually also
91 * ignorable if the temp namespace hasn't been set up, but there's a special
92 * case: if "pg_temp" appears first then it should be the default creation
93 * target. We kluge this case a little bit so that the temp namespace isn't
94 * set up until the first attempt to create something in it. (The reason for
95 * klugery is that we can't create the temp namespace outside a transaction,
96 * but initial GUC processing of search_path happens outside a transaction.)
97 * activeTempCreationPending is true if "pg_temp" appears first in the string
98 * but is not reflected in activeCreationNamespace because the namespace isn't
101 * In bootstrap mode, the search path is set equal to "pg_catalog", so that
102 * the system namespace is the only one searched or inserted into.
103 * initdb is also careful to set search_path to "pg_catalog" for its
104 * post-bootstrap standalone backend runs. Otherwise the default search
105 * path is determined by GUC. The factory default path contains the PUBLIC
106 * namespace (if it exists), preceded by the user's personal namespace
109 * We support a stack of "override" search path settings for use within
110 * specific sections of backend code. namespace_search_path is ignored
111 * whenever the override stack is nonempty. activeSearchPath is always
112 * the actually active path; it points either to the search list of the
113 * topmost stack entry, or to baseSearchPath which is the list derived
114 * from namespace_search_path.
116 * If baseSearchPathValid is false, then baseSearchPath (and other
117 * derived variables) need to be recomputed from namespace_search_path.
118 * We mark it invalid upon an assignment to namespace_search_path or receipt
119 * of a syscache invalidation event for pg_namespace. The recomputation
120 * is done during the next non-overridden lookup attempt. Note that an
121 * override spec is never subject to recomputation.
123 * Any namespaces mentioned in namespace_search_path that are not readable
124 * by the current user ID are simply left out of baseSearchPath; so
125 * we have to be willing to recompute the path when current userid changes.
126 * namespaceUser is the userid the path has been computed for.
128 * Note: all data pointed to by these List variables is in TopMemoryContext.
131 /* These variables define the actually active state: */
133 static List *activeSearchPath = NIL;
135 /* default place to create stuff; if InvalidOid, no default */
136 static Oid activeCreationNamespace = InvalidOid;
138 /* if true, activeCreationNamespace is wrong, it should be temp namespace */
139 static bool activeTempCreationPending = false;
141 /* These variables are the values last derived from namespace_search_path: */
143 static List *baseSearchPath = NIL;
145 static Oid baseCreationNamespace = InvalidOid;
147 static bool baseTempCreationPending = false;
149 static Oid namespaceUser = InvalidOid;
151 /* The above four values are valid only if baseSearchPathValid */
152 static bool baseSearchPathValid = true;
154 /* Override requests are remembered in a stack of OverrideStackEntry structs */
158 List *searchPath; /* the desired search path */
159 Oid creationNamespace; /* the desired creation namespace */
160 int nestLevel; /* subtransaction nesting level */
161 } OverrideStackEntry;
163 static List *overrideStack = NIL;
166 * myTempNamespace is InvalidOid until and unless a TEMP namespace is set up
167 * in a particular backend session (this happens when a CREATE TEMP TABLE
168 * command is first executed). Thereafter it's the OID of the temp namespace.
170 * myTempToastNamespace is the OID of the namespace for my temp tables' toast
171 * tables. It is set when myTempNamespace is, and is InvalidOid before that.
173 * myTempNamespaceSubID shows whether we've created the TEMP namespace in the
174 * current subtransaction. The flag propagates up the subtransaction tree,
175 * so the main transaction will correctly recognize the flag if all
176 * intermediate subtransactions commit. When it is InvalidSubTransactionId,
177 * we either haven't made the TEMP namespace yet, or have successfully
178 * committed its creation, depending on whether myTempNamespace is valid.
180 static Oid myTempNamespace = InvalidOid;
182 static Oid myTempToastNamespace = InvalidOid;
184 static SubTransactionId myTempNamespaceSubID = InvalidSubTransactionId;
187 * This is the user's textual search path specification --- it's the value
188 * of the GUC variable 'search_path'.
190 char *namespace_search_path = NULL;
193 /* Local functions */
194 static void recomputeNamespacePath(void);
195 static void AccessTempTableNamespace(bool force);
196 static void InitTempTableNamespace(void);
197 static void RemoveTempRelations(Oid tempNamespaceId);
198 static void RemoveTempRelationsCallback(int code, Datum arg);
199 static void NamespaceCallback(Datum arg, int cacheid, uint32 hashvalue);
200 static bool MatchNamedCall(HeapTuple proctup, int nargs, List *argnames,
205 * RangeVarGetRelidExtended
206 * Given a RangeVar describing an existing relation,
207 * select the proper namespace and look up the relation OID.
209 * If the schema or relation is not found, return InvalidOid if flags contains
210 * RVR_MISSING_OK, otherwise raise an error.
212 * If flags contains RVR_NOWAIT, throw an error if we'd have to wait for a
215 * If flags contains RVR_SKIP_LOCKED, return InvalidOid if we'd have to wait
218 * flags cannot contain both RVR_NOWAIT and RVR_SKIP_LOCKED.
220 * Note that if RVR_MISSING_OK and RVR_SKIP_LOCKED are both specified, a
221 * return value of InvalidOid could either mean the relation is missing or it
222 * could not be locked.
224 * Callback allows caller to check permissions or acquire additional locks
225 * prior to grabbing the relation lock.
228 RangeVarGetRelidExtended(const RangeVar *relation, LOCKMODE lockmode,
230 RangeVarGetRelidCallback callback, void *callback_arg)
234 Oid oldRelId = InvalidOid;
236 bool missing_ok = (flags & RVR_MISSING_OK) != 0;
238 /* verify that flags do no conflict */
239 Assert(!((flags & RVR_NOWAIT) && (flags & RVR_SKIP_LOCKED)));
242 * We check the catalog name and then ignore it.
244 if (relation->catalogname)
246 if (strcmp(relation->catalogname, get_database_name(MyDatabaseId)) != 0)
248 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
249 errmsg("cross-database references are not implemented: \"%s.%s.%s\"",
250 relation->catalogname, relation->schemaname,
251 relation->relname)));
255 * DDL operations can change the results of a name lookup. Since all such
256 * operations will generate invalidation messages, we keep track of
257 * whether any such messages show up while we're performing the operation,
258 * and retry until either (1) no more invalidation messages show up or (2)
259 * the answer doesn't change.
261 * But if lockmode = NoLock, then we assume that either the caller is OK
262 * with the answer changing under them, or that they already hold some
263 * appropriate lock, and therefore return the first answer we get without
264 * checking for invalidation messages. Also, if the requested lock is
265 * already held, LockRelationOid will not AcceptInvalidationMessages, so
266 * we may fail to notice a change. We could protect against that case by
267 * calling AcceptInvalidationMessages() before beginning this loop, but
268 * that would add a significant amount overhead, so for now we don't.
273 * Remember this value, so that, after looking up the relation name
274 * and locking its OID, we can check whether any invalidation messages
275 * have been processed that might require a do-over.
277 inval_count = SharedInvalidMessageCounter;
280 * Some non-default relpersistence value may have been specified. The
281 * parser never generates such a RangeVar in simple DML, but it can
282 * happen in contexts such as "CREATE TEMP TABLE foo (f1 int PRIMARY
283 * KEY)". Such a command will generate an added CREATE INDEX
284 * operation, which must be careful to find the temp table, even when
285 * pg_temp is not first in the search path.
287 if (relation->relpersistence == RELPERSISTENCE_TEMP)
289 if (!OidIsValid(myTempNamespace))
290 relId = InvalidOid; /* this probably can't happen? */
293 if (relation->schemaname)
297 namespaceId = LookupExplicitNamespace(relation->schemaname, missing_ok);
300 * For missing_ok, allow a non-existent schema name to
303 if (namespaceId != myTempNamespace)
305 (errcode(ERRCODE_INVALID_TABLE_DEFINITION),
306 errmsg("temporary tables cannot specify a schema name")));
309 relId = get_relname_relid(relation->relname, myTempNamespace);
312 else if (relation->schemaname)
316 /* use exact schema given */
317 namespaceId = LookupExplicitNamespace(relation->schemaname, missing_ok);
318 if (missing_ok && !OidIsValid(namespaceId))
321 relId = get_relname_relid(relation->relname, namespaceId);
325 /* search the namespace path */
326 relId = RelnameGetRelid(relation->relname);
330 * Invoke caller-supplied callback, if any.
332 * This callback is a good place to check permissions: we haven't
333 * taken the table lock yet (and it's really best to check permissions
334 * before locking anything!), but we've gotten far enough to know what
335 * OID we think we should lock. Of course, concurrent DDL might
336 * change things while we're waiting for the lock, but in that case
337 * the callback will be invoked again for the new OID.
340 callback(relation, relId, oldRelId, callback_arg);
343 * If no lock requested, we assume the caller knows what they're
344 * doing. They should have already acquired a heavyweight lock on
345 * this relation earlier in the processing of this same statement, so
346 * it wouldn't be appropriate to AcceptInvalidationMessages() here, as
347 * that might pull the rug out from under them.
349 if (lockmode == NoLock)
353 * If, upon retry, we get back the same OID we did last time, then the
354 * invalidation messages we processed did not change the final answer.
357 * If we got a different OID, we've locked the relation that used to
358 * have this name rather than the one that does now. So release the
363 if (relId == oldRelId)
365 if (OidIsValid(oldRelId))
366 UnlockRelationOid(oldRelId, lockmode);
370 * Lock relation. This will also accept any pending invalidation
371 * messages. If we got back InvalidOid, indicating not found, then
372 * there's nothing to lock, but we accept invalidation messages
373 * anyway, to flush any negative catcache entries that may be
376 if (!OidIsValid(relId))
377 AcceptInvalidationMessages();
378 else if (!(flags & (RVR_NOWAIT | RVR_SKIP_LOCKED)))
379 LockRelationOid(relId, lockmode);
380 else if (!ConditionalLockRelationOid(relId, lockmode))
382 int elevel = (flags & RVR_SKIP_LOCKED) ? DEBUG1 : ERROR;
384 if (relation->schemaname)
386 (errcode(ERRCODE_LOCK_NOT_AVAILABLE),
387 errmsg("could not obtain lock on relation \"%s.%s\"",
388 relation->schemaname, relation->relname)));
391 (errcode(ERRCODE_LOCK_NOT_AVAILABLE),
392 errmsg("could not obtain lock on relation \"%s\"",
393 relation->relname)));
399 * If no invalidation message were processed, we're done!
401 if (inval_count == SharedInvalidMessageCounter)
405 * Something may have changed. Let's repeat the name lookup, to make
406 * sure this name still references the same relation it did
413 if (!OidIsValid(relId))
415 int elevel = missing_ok ? DEBUG1 : ERROR;
417 if (relation->schemaname)
419 (errcode(ERRCODE_UNDEFINED_TABLE),
420 errmsg("relation \"%s.%s\" does not exist",
421 relation->schemaname, relation->relname)));
424 (errcode(ERRCODE_UNDEFINED_TABLE),
425 errmsg("relation \"%s\" does not exist",
426 relation->relname)));
432 * RangeVarGetCreationNamespace
433 * Given a RangeVar describing a to-be-created relation,
434 * choose which namespace to create it in.
436 * Note: calling this may result in a CommandCounterIncrement operation.
437 * That will happen on the first request for a temp table in any particular
438 * backend run; we will need to either create or clean out the temp schema.
441 RangeVarGetCreationNamespace(const RangeVar *newRelation)
446 * We check the catalog name and then ignore it.
448 if (newRelation->catalogname)
450 if (strcmp(newRelation->catalogname, get_database_name(MyDatabaseId)) != 0)
452 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
453 errmsg("cross-database references are not implemented: \"%s.%s.%s\"",
454 newRelation->catalogname, newRelation->schemaname,
455 newRelation->relname)));
458 if (newRelation->schemaname)
460 /* check for pg_temp alias */
461 if (strcmp(newRelation->schemaname, "pg_temp") == 0)
463 /* Initialize temp namespace */
464 AccessTempTableNamespace(false);
465 return myTempNamespace;
467 /* use exact schema given */
468 namespaceId = get_namespace_oid(newRelation->schemaname, false);
469 /* we do not check for USAGE rights here! */
471 else if (newRelation->relpersistence == RELPERSISTENCE_TEMP)
473 /* Initialize temp namespace */
474 AccessTempTableNamespace(false);
475 return myTempNamespace;
479 /* use the default creation namespace */
480 recomputeNamespacePath();
481 if (activeTempCreationPending)
483 /* Need to initialize temp namespace */
484 AccessTempTableNamespace(true);
485 return myTempNamespace;
487 namespaceId = activeCreationNamespace;
488 if (!OidIsValid(namespaceId))
490 (errcode(ERRCODE_UNDEFINED_SCHEMA),
491 errmsg("no schema has been selected to create in")));
494 /* Note: callers will check for CREATE rights when appropriate */
500 * RangeVarGetAndCheckCreationNamespace
502 * This function returns the OID of the namespace in which a new relation
503 * with a given name should be created. If the user does not have CREATE
504 * permission on the target namespace, this function will instead signal
507 * If non-NULL, *existing_relation_id is set to the OID of any existing relation
508 * with the same name which already exists in that namespace, or to InvalidOid
509 * if no such relation exists.
511 * If lockmode != NoLock, the specified lock mode is acquired on the existing
512 * relation, if any, provided that the current user owns the target relation.
513 * However, if lockmode != NoLock and the user does not own the target
514 * relation, we throw an ERROR, as we must not try to lock relations the
515 * user does not have permissions on.
517 * As a side effect, this function acquires AccessShareLock on the target
518 * namespace. Without this, the namespace could be dropped before our
519 * transaction commits, leaving behind relations with relnamespace pointing
520 * to a no-longer-existent namespace.
522 * As a further side-effect, if the selected namespace is a temporary namespace,
523 * we mark the RangeVar as RELPERSISTENCE_TEMP.
526 RangeVarGetAndCheckCreationNamespace(RangeVar *relation,
528 Oid *existing_relation_id)
532 Oid oldrelid = InvalidOid;
534 Oid oldnspid = InvalidOid;
538 * We check the catalog name and then ignore it.
540 if (relation->catalogname)
542 if (strcmp(relation->catalogname, get_database_name(MyDatabaseId)) != 0)
544 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
545 errmsg("cross-database references are not implemented: \"%s.%s.%s\"",
546 relation->catalogname, relation->schemaname,
547 relation->relname)));
551 * As in RangeVarGetRelidExtended(), we guard against concurrent DDL
552 * operations by tracking whether any invalidation messages are processed
553 * while we're doing the name lookups and acquiring locks. See comments
554 * in that function for a more detailed explanation of this logic.
560 inval_count = SharedInvalidMessageCounter;
562 /* Look up creation namespace and check for existing relation. */
563 nspid = RangeVarGetCreationNamespace(relation);
564 Assert(OidIsValid(nspid));
565 if (existing_relation_id != NULL)
566 relid = get_relname_relid(relation->relname, nspid);
571 * In bootstrap processing mode, we don't bother with permissions or
572 * locking. Permissions might not be working yet, and locking is
575 if (IsBootstrapProcessingMode())
578 /* Check namespace permissions. */
579 aclresult = pg_namespace_aclcheck(nspid, GetUserId(), ACL_CREATE);
580 if (aclresult != ACLCHECK_OK)
581 aclcheck_error(aclresult, OBJECT_SCHEMA,
582 get_namespace_name(nspid));
586 /* If nothing changed, we're done. */
587 if (relid == oldrelid && nspid == oldnspid)
589 /* If creation namespace has changed, give up old lock. */
590 if (nspid != oldnspid)
591 UnlockDatabaseObject(NamespaceRelationId, oldnspid, 0,
593 /* If name points to something different, give up old lock. */
594 if (relid != oldrelid && OidIsValid(oldrelid) && lockmode != NoLock)
595 UnlockRelationOid(oldrelid, lockmode);
598 /* Lock namespace. */
599 if (nspid != oldnspid)
600 LockDatabaseObject(NamespaceRelationId, nspid, 0, AccessShareLock);
602 /* Lock relation, if required if and we have permission. */
603 if (lockmode != NoLock && OidIsValid(relid))
605 if (!pg_class_ownercheck(relid, GetUserId()))
606 aclcheck_error(ACLCHECK_NOT_OWNER, get_relkind_objtype(get_rel_relkind(relid)),
608 if (relid != oldrelid)
609 LockRelationOid(relid, lockmode);
612 /* If no invalidation message were processed, we're done! */
613 if (inval_count == SharedInvalidMessageCounter)
616 /* Something may have changed, so recheck our work. */
622 RangeVarAdjustRelationPersistence(relation, nspid);
623 if (existing_relation_id != NULL)
624 *existing_relation_id = relid;
629 * Adjust the relpersistence for an about-to-be-created relation based on the
630 * creation namespace, and throw an error for invalid combinations.
633 RangeVarAdjustRelationPersistence(RangeVar *newRelation, Oid nspid)
635 switch (newRelation->relpersistence)
637 case RELPERSISTENCE_TEMP:
638 if (!isTempOrTempToastNamespace(nspid))
640 if (isAnyTempNamespace(nspid))
642 (errcode(ERRCODE_INVALID_TABLE_DEFINITION),
643 errmsg("cannot create relations in temporary schemas of other sessions")));
646 (errcode(ERRCODE_INVALID_TABLE_DEFINITION),
647 errmsg("cannot create temporary relation in non-temporary schema")));
650 case RELPERSISTENCE_PERMANENT:
651 if (isTempOrTempToastNamespace(nspid))
652 newRelation->relpersistence = RELPERSISTENCE_TEMP;
653 else if (isAnyTempNamespace(nspid))
655 (errcode(ERRCODE_INVALID_TABLE_DEFINITION),
656 errmsg("cannot create relations in temporary schemas of other sessions")));
659 if (isAnyTempNamespace(nspid))
661 (errcode(ERRCODE_INVALID_TABLE_DEFINITION),
662 errmsg("only temporary relations may be created in temporary schemas")));
668 * Try to resolve an unqualified relation name.
669 * Returns OID if relation found in search path, else InvalidOid.
672 RelnameGetRelid(const char *relname)
677 recomputeNamespacePath();
679 foreach(l, activeSearchPath)
681 Oid namespaceId = lfirst_oid(l);
683 relid = get_relname_relid(relname, namespaceId);
684 if (OidIsValid(relid))
688 /* Not found in path */
695 * Determine whether a relation (identified by OID) is visible in the
696 * current search path. Visible means "would be found by searching
697 * for the unqualified relation name".
700 RelationIsVisible(Oid relid)
703 Form_pg_class relform;
707 reltup = SearchSysCache1(RELOID, ObjectIdGetDatum(relid));
708 if (!HeapTupleIsValid(reltup))
709 elog(ERROR, "cache lookup failed for relation %u", relid);
710 relform = (Form_pg_class) GETSTRUCT(reltup);
712 recomputeNamespacePath();
715 * Quick check: if it ain't in the path at all, it ain't visible. Items in
716 * the system namespace are surely in the path and so we needn't even do
717 * list_member_oid() for them.
719 relnamespace = relform->relnamespace;
720 if (relnamespace != PG_CATALOG_NAMESPACE &&
721 !list_member_oid(activeSearchPath, relnamespace))
726 * If it is in the path, it might still not be visible; it could be
727 * hidden by another relation of the same name earlier in the path. So
728 * we must do a slow check for conflicting relations.
730 char *relname = NameStr(relform->relname);
734 foreach(l, activeSearchPath)
736 Oid namespaceId = lfirst_oid(l);
738 if (namespaceId == relnamespace)
740 /* Found it first in path */
744 if (OidIsValid(get_relname_relid(relname, namespaceId)))
746 /* Found something else first in path */
752 ReleaseSysCache(reltup);
760 * Try to resolve an unqualified datatype name.
761 * Returns OID if type found in search path, else InvalidOid.
763 * This is essentially the same as RelnameGetRelid.
766 TypenameGetTypid(const char *typname)
771 recomputeNamespacePath();
773 foreach(l, activeSearchPath)
775 Oid namespaceId = lfirst_oid(l);
777 typid = GetSysCacheOid2(TYPENAMENSP, Anum_pg_type_oid,
778 PointerGetDatum(typname),
779 ObjectIdGetDatum(namespaceId));
780 if (OidIsValid(typid))
784 /* Not found in path */
790 * Determine whether a type (identified by OID) is visible in the
791 * current search path. Visible means "would be found by searching
792 * for the unqualified type name".
795 TypeIsVisible(Oid typid)
798 Form_pg_type typform;
802 typtup = SearchSysCache1(TYPEOID, ObjectIdGetDatum(typid));
803 if (!HeapTupleIsValid(typtup))
804 elog(ERROR, "cache lookup failed for type %u", typid);
805 typform = (Form_pg_type) GETSTRUCT(typtup);
807 recomputeNamespacePath();
810 * Quick check: if it ain't in the path at all, it ain't visible. Items in
811 * the system namespace are surely in the path and so we needn't even do
812 * list_member_oid() for them.
814 typnamespace = typform->typnamespace;
815 if (typnamespace != PG_CATALOG_NAMESPACE &&
816 !list_member_oid(activeSearchPath, typnamespace))
821 * If it is in the path, it might still not be visible; it could be
822 * hidden by another type of the same name earlier in the path. So we
823 * must do a slow check for conflicting types.
825 char *typname = NameStr(typform->typname);
829 foreach(l, activeSearchPath)
831 Oid namespaceId = lfirst_oid(l);
833 if (namespaceId == typnamespace)
835 /* Found it first in path */
839 if (SearchSysCacheExists2(TYPENAMENSP,
840 PointerGetDatum(typname),
841 ObjectIdGetDatum(namespaceId)))
843 /* Found something else first in path */
849 ReleaseSysCache(typtup);
856 * FuncnameGetCandidates
857 * Given a possibly-qualified function name and argument count,
858 * retrieve a list of the possible matches.
860 * If nargs is -1, we return all functions matching the given name,
861 * regardless of argument count. (argnames must be NIL, and expand_variadic
862 * and expand_defaults must be false, in this case.)
864 * If argnames isn't NIL, we are considering a named- or mixed-notation call,
865 * and only functions having all the listed argument names will be returned.
866 * (We assume that length(argnames) <= nargs and all the passed-in names are
867 * distinct.) The returned structs will include an argnumbers array showing
868 * the actual argument index for each logical argument position.
870 * If expand_variadic is true, then variadic functions having the same number
871 * or fewer arguments will be retrieved, with the variadic argument and any
872 * additional argument positions filled with the variadic element type.
873 * nvargs in the returned struct is set to the number of such arguments.
874 * If expand_variadic is false, variadic arguments are not treated specially,
875 * and the returned nvargs will always be zero.
877 * If expand_defaults is true, functions that could match after insertion of
878 * default argument values will also be retrieved. In this case the returned
879 * structs could have nargs > passed-in nargs, and ndargs is set to the number
880 * of additional args (which can be retrieved from the function's
881 * proargdefaults entry).
883 * It is not possible for nvargs and ndargs to both be nonzero in the same
884 * list entry, since default insertion allows matches to functions with more
885 * than nargs arguments while the variadic transformation requires the same
888 * When argnames isn't NIL, the returned args[] type arrays are not ordered
889 * according to the functions' declarations, but rather according to the call:
890 * first any positional arguments, then the named arguments, then defaulted
891 * arguments (if needed and allowed by expand_defaults). The argnumbers[]
892 * array can be used to map this back to the catalog information.
893 * argnumbers[k] is set to the proargtypes index of the k'th call argument.
895 * We search a single namespace if the function name is qualified, else
896 * all namespaces in the search path. In the multiple-namespace case,
897 * we arrange for entries in earlier namespaces to mask identical entries in
900 * When expanding variadics, we arrange for non-variadic functions to mask
901 * variadic ones if the expanded argument list is the same. It is still
902 * possible for there to be conflicts between different variadic functions,
905 * It is guaranteed that the return list will never contain multiple entries
906 * with identical argument lists. When expand_defaults is true, the entries
907 * could have more than nargs positions, but we still guarantee that they are
908 * distinct in the first nargs positions. However, if argnames isn't NIL or
909 * either expand_variadic or expand_defaults is true, there might be multiple
910 * candidate functions that expand to identical argument lists. Rather than
911 * throw error here, we report such situations by returning a single entry
912 * with oid = 0 that represents a set of such conflicting candidates.
913 * The caller might end up discarding such an entry anyway, but if it selects
914 * such an entry it should react as though the call were ambiguous.
916 * If missing_ok is true, an empty list (NULL) is returned if the name was
917 * schema- qualified with a schema that does not exist. Likewise if no
918 * candidate is found for other reasons.
921 FuncnameGetCandidates(List *names, int nargs, List *argnames,
922 bool expand_variadic, bool expand_defaults,
925 FuncCandidateList resultList = NULL;
926 bool any_special = false;
933 /* check for caller error */
934 Assert(nargs >= 0 || !(expand_variadic | expand_defaults));
936 /* deconstruct the name list */
937 DeconstructQualifiedName(names, &schemaname, &funcname);
941 /* use exact schema given */
942 namespaceId = LookupExplicitNamespace(schemaname, missing_ok);
943 if (!OidIsValid(namespaceId))
948 /* flag to indicate we need namespace search */
949 namespaceId = InvalidOid;
950 recomputeNamespacePath();
953 /* Search syscache by name only */
954 catlist = SearchSysCacheList1(PROCNAMEARGSNSP, CStringGetDatum(funcname));
956 for (i = 0; i < catlist->n_members; i++)
958 HeapTuple proctup = &catlist->members[i]->tuple;
959 Form_pg_proc procform = (Form_pg_proc) GETSTRUCT(proctup);
960 int pronargs = procform->pronargs;
966 int *argnumbers = NULL;
967 FuncCandidateList newResult;
969 if (OidIsValid(namespaceId))
971 /* Consider only procs in specified namespace */
972 if (procform->pronamespace != namespaceId)
978 * Consider only procs that are in the search path and are not in
979 * the temp namespace.
983 foreach(nsp, activeSearchPath)
985 if (procform->pronamespace == lfirst_oid(nsp) &&
986 procform->pronamespace != myTempNamespace)
991 continue; /* proc is not in search path */
997 * Call uses named or mixed notation
999 * Named or mixed notation can match a variadic function only if
1000 * expand_variadic is off; otherwise there is no way to match the
1001 * presumed-nameless parameters expanded from the variadic array.
1003 if (OidIsValid(procform->provariadic) && expand_variadic)
1005 va_elem_type = InvalidOid;
1009 * Check argument count.
1011 Assert(nargs >= 0); /* -1 not supported with argnames */
1013 if (pronargs > nargs && expand_defaults)
1015 /* Ignore if not enough default expressions */
1016 if (nargs + procform->pronargdefaults < pronargs)
1018 use_defaults = true;
1021 use_defaults = false;
1023 /* Ignore if it doesn't match requested argument count */
1024 if (pronargs != nargs && !use_defaults)
1027 /* Check for argument name match, generate positional mapping */
1028 if (!MatchNamedCall(proctup, nargs, argnames,
1032 /* Named argument matching is always "special" */
1038 * Call uses positional notation
1040 * Check if function is variadic, and get variadic element type if
1041 * so. If expand_variadic is false, we should just ignore
1044 if (pronargs <= nargs && expand_variadic)
1046 va_elem_type = procform->provariadic;
1047 variadic = OidIsValid(va_elem_type);
1048 any_special |= variadic;
1052 va_elem_type = InvalidOid;
1057 * Check if function can match by using parameter defaults.
1059 if (pronargs > nargs && expand_defaults)
1061 /* Ignore if not enough default expressions */
1062 if (nargs + procform->pronargdefaults < pronargs)
1064 use_defaults = true;
1068 use_defaults = false;
1070 /* Ignore if it doesn't match requested argument count */
1071 if (nargs >= 0 && pronargs != nargs && !variadic && !use_defaults)
1076 * We must compute the effective argument list so that we can easily
1077 * compare it to earlier results. We waste a palloc cycle if it gets
1078 * masked by an earlier result, but really that's a pretty infrequent
1079 * case so it's not worth worrying about.
1081 effective_nargs = Max(pronargs, nargs);
1082 newResult = (FuncCandidateList)
1083 palloc(offsetof(struct _FuncCandidateList, args) +
1084 effective_nargs * sizeof(Oid));
1085 newResult->pathpos = pathpos;
1086 newResult->oid = procform->oid;
1087 newResult->nargs = effective_nargs;
1088 newResult->argnumbers = argnumbers;
1091 /* Re-order the argument types into call's logical order */
1092 Oid *proargtypes = procform->proargtypes.values;
1095 for (i = 0; i < pronargs; i++)
1096 newResult->args[i] = proargtypes[argnumbers[i]];
1100 /* Simple positional case, just copy proargtypes as-is */
1101 memcpy(newResult->args, procform->proargtypes.values,
1102 pronargs * sizeof(Oid));
1108 newResult->nvargs = effective_nargs - pronargs + 1;
1109 /* Expand variadic argument into N copies of element type */
1110 for (i = pronargs - 1; i < effective_nargs; i++)
1111 newResult->args[i] = va_elem_type;
1114 newResult->nvargs = 0;
1115 newResult->ndargs = use_defaults ? pronargs - nargs : 0;
1118 * Does it have the same arguments as something we already accepted?
1119 * If so, decide what to do to avoid returning duplicate argument
1120 * lists. We can skip this check for the single-namespace case if no
1121 * special (named, variadic or defaults) match has been made, since
1122 * then the unique index on pg_proc guarantees all the matches have
1123 * different argument lists.
1125 if (resultList != NULL &&
1126 (any_special || !OidIsValid(namespaceId)))
1129 * If we have an ordered list from SearchSysCacheList (the normal
1130 * case), then any conflicting proc must immediately adjoin this
1131 * one in the list, so we only need to look at the newest result
1132 * item. If we have an unordered list, we have to scan the whole
1133 * result list. Also, if either the current candidate or any
1134 * previous candidate is a special match, we can't assume that
1135 * conflicts are adjacent.
1137 * We ignore defaulted arguments in deciding what is a match.
1139 FuncCandidateList prevResult;
1141 if (catlist->ordered && !any_special)
1143 /* ndargs must be 0 if !any_special */
1144 if (effective_nargs == resultList->nargs &&
1145 memcmp(newResult->args,
1147 effective_nargs * sizeof(Oid)) == 0)
1148 prevResult = resultList;
1154 int cmp_nargs = newResult->nargs - newResult->ndargs;
1156 for (prevResult = resultList;
1158 prevResult = prevResult->next)
1160 if (cmp_nargs == prevResult->nargs - prevResult->ndargs &&
1161 memcmp(newResult->args,
1163 cmp_nargs * sizeof(Oid)) == 0)
1171 * We have a match with a previous result. Decide which one
1172 * to keep, or mark it ambiguous if we can't decide. The
1173 * logic here is preference > 0 means prefer the old result,
1174 * preference < 0 means prefer the new, preference = 0 means
1179 if (pathpos != prevResult->pathpos)
1182 * Prefer the one that's earlier in the search path.
1184 preference = pathpos - prevResult->pathpos;
1186 else if (variadic && prevResult->nvargs == 0)
1189 * With variadic functions we could have, for example,
1190 * both foo(numeric) and foo(variadic numeric[]) in the
1191 * same namespace; if so we prefer the non-variadic match
1192 * on efficiency grounds.
1196 else if (!variadic && prevResult->nvargs > 0)
1203 * We can't decide. This can happen with, for example,
1204 * both foo(numeric, variadic numeric[]) and
1205 * foo(variadic numeric[]) in the same namespace, or
1206 * both foo(int) and foo (int, int default something)
1207 * in the same namespace, or both foo(a int, b text)
1208 * and foo(b text, a int) in the same namespace.
1216 /* keep previous result */
1220 else if (preference < 0)
1222 /* remove previous result from the list */
1223 if (prevResult == resultList)
1224 resultList = prevResult->next;
1227 FuncCandidateList prevPrevResult;
1229 for (prevPrevResult = resultList;
1231 prevPrevResult = prevPrevResult->next)
1233 if (prevResult == prevPrevResult->next)
1235 prevPrevResult->next = prevResult->next;
1239 Assert(prevPrevResult); /* assert we found it */
1242 /* fall through to add newResult to list */
1246 /* mark old result as ambiguous, discard new */
1247 prevResult->oid = InvalidOid;
1255 * Okay to add it to result list
1257 newResult->next = resultList;
1258 resultList = newResult;
1261 ReleaseSysCacheList(catlist);
1268 * Given a pg_proc heap tuple and a call's list of argument names,
1269 * check whether the function could match the call.
1271 * The call could match if all supplied argument names are accepted by
1272 * the function, in positions after the last positional argument, and there
1273 * are defaults for all unsupplied arguments.
1275 * The number of positional arguments is nargs - list_length(argnames).
1276 * Note caller has already done basic checks on argument count.
1278 * On match, return true and fill *argnumbers with a palloc'd array showing
1279 * the mapping from call argument positions to actual function argument
1280 * numbers. Defaulted arguments are included in this map, at positions
1281 * after the last supplied argument.
1284 MatchNamedCall(HeapTuple proctup, int nargs, List *argnames,
1287 Form_pg_proc procform = (Form_pg_proc) GETSTRUCT(proctup);
1288 int pronargs = procform->pronargs;
1289 int numposargs = nargs - list_length(argnames);
1294 bool arggiven[FUNC_MAX_ARGS];
1296 int ap; /* call args position */
1297 int pp; /* proargs position */
1300 Assert(argnames != NIL);
1301 Assert(numposargs >= 0);
1302 Assert(nargs <= pronargs);
1304 /* Ignore this function if its proargnames is null */
1305 (void) SysCacheGetAttr(PROCOID, proctup, Anum_pg_proc_proargnames,
1310 /* OK, let's extract the argument names and types */
1311 pronallargs = get_func_arg_info(proctup,
1312 &p_argtypes, &p_argnames, &p_argmodes);
1313 Assert(p_argnames != NULL);
1315 /* initialize state for matching */
1316 *argnumbers = (int *) palloc(pronargs * sizeof(int));
1317 memset(arggiven, false, pronargs * sizeof(bool));
1319 /* there are numposargs positional args before the named args */
1320 for (ap = 0; ap < numposargs; ap++)
1322 (*argnumbers)[ap] = ap;
1323 arggiven[ap] = true;
1326 /* now examine the named args */
1327 foreach(lc, argnames)
1329 char *argname = (char *) lfirst(lc);
1335 for (i = 0; i < pronallargs; i++)
1337 /* consider only input parameters */
1339 (p_argmodes[i] != FUNC_PARAM_IN &&
1340 p_argmodes[i] != FUNC_PARAM_INOUT &&
1341 p_argmodes[i] != FUNC_PARAM_VARIADIC))
1343 if (p_argnames[i] && strcmp(p_argnames[i], argname) == 0)
1345 /* fail if argname matches a positional argument */
1348 arggiven[pp] = true;
1349 (*argnumbers)[ap] = pp;
1353 /* increase pp only for input parameters */
1356 /* if name isn't in proargnames, fail */
1362 Assert(ap == nargs); /* processed all actual parameters */
1364 /* Check for default arguments */
1365 if (nargs < pronargs)
1367 int first_arg_with_default = pronargs - procform->pronargdefaults;
1369 for (pp = numposargs; pp < pronargs; pp++)
1373 /* fail if arg not given and no default available */
1374 if (pp < first_arg_with_default)
1376 (*argnumbers)[ap++] = pp;
1380 Assert(ap == pronargs); /* processed all function parameters */
1387 * Determine whether a function (identified by OID) is visible in the
1388 * current search path. Visible means "would be found by searching
1389 * for the unqualified function name with exact argument matches".
1392 FunctionIsVisible(Oid funcid)
1395 Form_pg_proc procform;
1399 proctup = SearchSysCache1(PROCOID, ObjectIdGetDatum(funcid));
1400 if (!HeapTupleIsValid(proctup))
1401 elog(ERROR, "cache lookup failed for function %u", funcid);
1402 procform = (Form_pg_proc) GETSTRUCT(proctup);
1404 recomputeNamespacePath();
1407 * Quick check: if it ain't in the path at all, it ain't visible. Items in
1408 * the system namespace are surely in the path and so we needn't even do
1409 * list_member_oid() for them.
1411 pronamespace = procform->pronamespace;
1412 if (pronamespace != PG_CATALOG_NAMESPACE &&
1413 !list_member_oid(activeSearchPath, pronamespace))
1418 * If it is in the path, it might still not be visible; it could be
1419 * hidden by another proc of the same name and arguments earlier in
1420 * the path. So we must do a slow check to see if this is the same
1421 * proc that would be found by FuncnameGetCandidates.
1423 char *proname = NameStr(procform->proname);
1424 int nargs = procform->pronargs;
1425 FuncCandidateList clist;
1429 clist = FuncnameGetCandidates(list_make1(makeString(proname)),
1430 nargs, NIL, false, false, false);
1432 for (; clist; clist = clist->next)
1434 if (memcmp(clist->args, procform->proargtypes.values,
1435 nargs * sizeof(Oid)) == 0)
1437 /* Found the expected entry; is it the right proc? */
1438 visible = (clist->oid == funcid);
1444 ReleaseSysCache(proctup);
1452 * Given a possibly-qualified operator name and exact input datatypes,
1453 * look up the operator. Returns InvalidOid if not found.
1455 * Pass oprleft = InvalidOid for a prefix op, oprright = InvalidOid for
1458 * If the operator name is not schema-qualified, it is sought in the current
1459 * namespace search path. If the name is schema-qualified and the given
1460 * schema does not exist, InvalidOid is returned.
1463 OpernameGetOprid(List *names, Oid oprleft, Oid oprright)
1470 /* deconstruct the name list */
1471 DeconstructQualifiedName(names, &schemaname, &opername);
1475 /* search only in exact schema given */
1478 namespaceId = LookupExplicitNamespace(schemaname, true);
1479 if (OidIsValid(namespaceId))
1483 opertup = SearchSysCache4(OPERNAMENSP,
1484 CStringGetDatum(opername),
1485 ObjectIdGetDatum(oprleft),
1486 ObjectIdGetDatum(oprright),
1487 ObjectIdGetDatum(namespaceId));
1488 if (HeapTupleIsValid(opertup))
1490 Form_pg_operator operclass = (Form_pg_operator) GETSTRUCT(opertup);
1491 Oid result = operclass->oid;
1493 ReleaseSysCache(opertup);
1501 /* Search syscache by name and argument types */
1502 catlist = SearchSysCacheList3(OPERNAMENSP,
1503 CStringGetDatum(opername),
1504 ObjectIdGetDatum(oprleft),
1505 ObjectIdGetDatum(oprright));
1507 if (catlist->n_members == 0)
1509 /* no hope, fall out early */
1510 ReleaseSysCacheList(catlist);
1515 * We have to find the list member that is first in the search path, if
1516 * there's more than one. This doubly-nested loop looks ugly, but in
1517 * practice there should usually be few catlist members.
1519 recomputeNamespacePath();
1521 foreach(l, activeSearchPath)
1523 Oid namespaceId = lfirst_oid(l);
1526 if (namespaceId == myTempNamespace)
1527 continue; /* do not look in temp namespace */
1529 for (i = 0; i < catlist->n_members; i++)
1531 HeapTuple opertup = &catlist->members[i]->tuple;
1532 Form_pg_operator operform = (Form_pg_operator) GETSTRUCT(opertup);
1534 if (operform->oprnamespace == namespaceId)
1536 Oid result = operform->oid;
1538 ReleaseSysCacheList(catlist);
1544 ReleaseSysCacheList(catlist);
1549 * OpernameGetCandidates
1550 * Given a possibly-qualified operator name and operator kind,
1551 * retrieve a list of the possible matches.
1553 * If oprkind is '\0', we return all operators matching the given name,
1554 * regardless of arguments.
1556 * We search a single namespace if the operator name is qualified, else
1557 * all namespaces in the search path. The return list will never contain
1558 * multiple entries with identical argument lists --- in the multiple-
1559 * namespace case, we arrange for entries in earlier namespaces to mask
1560 * identical entries in later namespaces.
1562 * The returned items always have two args[] entries --- one or the other
1563 * will be InvalidOid for a prefix or postfix oprkind. nargs is 2, too.
1566 OpernameGetCandidates(List *names, char oprkind, bool missing_schema_ok)
1568 FuncCandidateList resultList = NULL;
1569 char *resultSpace = NULL;
1577 /* deconstruct the name list */
1578 DeconstructQualifiedName(names, &schemaname, &opername);
1582 /* use exact schema given */
1583 namespaceId = LookupExplicitNamespace(schemaname, missing_schema_ok);
1584 if (missing_schema_ok && !OidIsValid(namespaceId))
1589 /* flag to indicate we need namespace search */
1590 namespaceId = InvalidOid;
1591 recomputeNamespacePath();
1594 /* Search syscache by name only */
1595 catlist = SearchSysCacheList1(OPERNAMENSP, CStringGetDatum(opername));
1598 * In typical scenarios, most if not all of the operators found by the
1599 * catcache search will end up getting returned; and there can be quite a
1600 * few, for common operator names such as '=' or '+'. To reduce the time
1601 * spent in palloc, we allocate the result space as an array large enough
1602 * to hold all the operators. The original coding of this routine did a
1603 * separate palloc for each operator, but profiling revealed that the
1604 * pallocs used an unreasonably large fraction of parsing time.
1606 #define SPACE_PER_OP MAXALIGN(offsetof(struct _FuncCandidateList, args) + \
1609 if (catlist->n_members > 0)
1610 resultSpace = palloc(catlist->n_members * SPACE_PER_OP);
1612 for (i = 0; i < catlist->n_members; i++)
1614 HeapTuple opertup = &catlist->members[i]->tuple;
1615 Form_pg_operator operform = (Form_pg_operator) GETSTRUCT(opertup);
1617 FuncCandidateList newResult;
1619 /* Ignore operators of wrong kind, if specific kind requested */
1620 if (oprkind && operform->oprkind != oprkind)
1623 if (OidIsValid(namespaceId))
1625 /* Consider only opers in specified namespace */
1626 if (operform->oprnamespace != namespaceId)
1628 /* No need to check args, they must all be different */
1633 * Consider only opers that are in the search path and are not in
1634 * the temp namespace.
1638 foreach(nsp, activeSearchPath)
1640 if (operform->oprnamespace == lfirst_oid(nsp) &&
1641 operform->oprnamespace != myTempNamespace)
1646 continue; /* oper is not in search path */
1649 * Okay, it's in the search path, but does it have the same
1650 * arguments as something we already accepted? If so, keep only
1651 * the one that appears earlier in the search path.
1653 * If we have an ordered list from SearchSysCacheList (the normal
1654 * case), then any conflicting oper must immediately adjoin this
1655 * one in the list, so we only need to look at the newest result
1656 * item. If we have an unordered list, we have to scan the whole
1661 FuncCandidateList prevResult;
1663 if (catlist->ordered)
1665 if (operform->oprleft == resultList->args[0] &&
1666 operform->oprright == resultList->args[1])
1667 prevResult = resultList;
1673 for (prevResult = resultList;
1675 prevResult = prevResult->next)
1677 if (operform->oprleft == prevResult->args[0] &&
1678 operform->oprright == prevResult->args[1])
1684 /* We have a match with a previous result */
1685 Assert(pathpos != prevResult->pathpos);
1686 if (pathpos > prevResult->pathpos)
1687 continue; /* keep previous result */
1688 /* replace previous result */
1689 prevResult->pathpos = pathpos;
1690 prevResult->oid = operform->oid;
1691 continue; /* args are same, of course */
1697 * Okay to add it to result list
1699 newResult = (FuncCandidateList) (resultSpace + nextResult);
1700 nextResult += SPACE_PER_OP;
1702 newResult->pathpos = pathpos;
1703 newResult->oid = operform->oid;
1704 newResult->nargs = 2;
1705 newResult->nvargs = 0;
1706 newResult->ndargs = 0;
1707 newResult->argnumbers = NULL;
1708 newResult->args[0] = operform->oprleft;
1709 newResult->args[1] = operform->oprright;
1710 newResult->next = resultList;
1711 resultList = newResult;
1714 ReleaseSysCacheList(catlist);
1721 * Determine whether an operator (identified by OID) is visible in the
1722 * current search path. Visible means "would be found by searching
1723 * for the unqualified operator name with exact argument matches".
1726 OperatorIsVisible(Oid oprid)
1729 Form_pg_operator oprform;
1733 oprtup = SearchSysCache1(OPEROID, ObjectIdGetDatum(oprid));
1734 if (!HeapTupleIsValid(oprtup))
1735 elog(ERROR, "cache lookup failed for operator %u", oprid);
1736 oprform = (Form_pg_operator) GETSTRUCT(oprtup);
1738 recomputeNamespacePath();
1741 * Quick check: if it ain't in the path at all, it ain't visible. Items in
1742 * the system namespace are surely in the path and so we needn't even do
1743 * list_member_oid() for them.
1745 oprnamespace = oprform->oprnamespace;
1746 if (oprnamespace != PG_CATALOG_NAMESPACE &&
1747 !list_member_oid(activeSearchPath, oprnamespace))
1752 * If it is in the path, it might still not be visible; it could be
1753 * hidden by another operator of the same name and arguments earlier
1754 * in the path. So we must do a slow check to see if this is the same
1755 * operator that would be found by OpernameGetOprid.
1757 char *oprname = NameStr(oprform->oprname);
1759 visible = (OpernameGetOprid(list_make1(makeString(oprname)),
1760 oprform->oprleft, oprform->oprright)
1764 ReleaseSysCache(oprtup);
1771 * OpclassnameGetOpcid
1772 * Try to resolve an unqualified index opclass name.
1773 * Returns OID if opclass found in search path, else InvalidOid.
1775 * This is essentially the same as TypenameGetTypid, but we have to have
1776 * an extra argument for the index AM OID.
1779 OpclassnameGetOpcid(Oid amid, const char *opcname)
1784 recomputeNamespacePath();
1786 foreach(l, activeSearchPath)
1788 Oid namespaceId = lfirst_oid(l);
1790 if (namespaceId == myTempNamespace)
1791 continue; /* do not look in temp namespace */
1793 opcid = GetSysCacheOid3(CLAAMNAMENSP, Anum_pg_opclass_oid,
1794 ObjectIdGetDatum(amid),
1795 PointerGetDatum(opcname),
1796 ObjectIdGetDatum(namespaceId));
1797 if (OidIsValid(opcid))
1801 /* Not found in path */
1807 * Determine whether an opclass (identified by OID) is visible in the
1808 * current search path. Visible means "would be found by searching
1809 * for the unqualified opclass name".
1812 OpclassIsVisible(Oid opcid)
1815 Form_pg_opclass opcform;
1819 opctup = SearchSysCache1(CLAOID, ObjectIdGetDatum(opcid));
1820 if (!HeapTupleIsValid(opctup))
1821 elog(ERROR, "cache lookup failed for opclass %u", opcid);
1822 opcform = (Form_pg_opclass) GETSTRUCT(opctup);
1824 recomputeNamespacePath();
1827 * Quick check: if it ain't in the path at all, it ain't visible. Items in
1828 * the system namespace are surely in the path and so we needn't even do
1829 * list_member_oid() for them.
1831 opcnamespace = opcform->opcnamespace;
1832 if (opcnamespace != PG_CATALOG_NAMESPACE &&
1833 !list_member_oid(activeSearchPath, opcnamespace))
1838 * If it is in the path, it might still not be visible; it could be
1839 * hidden by another opclass of the same name earlier in the path. So
1840 * we must do a slow check to see if this opclass would be found by
1841 * OpclassnameGetOpcid.
1843 char *opcname = NameStr(opcform->opcname);
1845 visible = (OpclassnameGetOpcid(opcform->opcmethod, opcname) == opcid);
1848 ReleaseSysCache(opctup);
1854 * OpfamilynameGetOpfid
1855 * Try to resolve an unqualified index opfamily name.
1856 * Returns OID if opfamily found in search path, else InvalidOid.
1858 * This is essentially the same as TypenameGetTypid, but we have to have
1859 * an extra argument for the index AM OID.
1862 OpfamilynameGetOpfid(Oid amid, const char *opfname)
1867 recomputeNamespacePath();
1869 foreach(l, activeSearchPath)
1871 Oid namespaceId = lfirst_oid(l);
1873 if (namespaceId == myTempNamespace)
1874 continue; /* do not look in temp namespace */
1876 opfid = GetSysCacheOid3(OPFAMILYAMNAMENSP, Anum_pg_opfamily_oid,
1877 ObjectIdGetDatum(amid),
1878 PointerGetDatum(opfname),
1879 ObjectIdGetDatum(namespaceId));
1880 if (OidIsValid(opfid))
1884 /* Not found in path */
1890 * Determine whether an opfamily (identified by OID) is visible in the
1891 * current search path. Visible means "would be found by searching
1892 * for the unqualified opfamily name".
1895 OpfamilyIsVisible(Oid opfid)
1898 Form_pg_opfamily opfform;
1902 opftup = SearchSysCache1(OPFAMILYOID, ObjectIdGetDatum(opfid));
1903 if (!HeapTupleIsValid(opftup))
1904 elog(ERROR, "cache lookup failed for opfamily %u", opfid);
1905 opfform = (Form_pg_opfamily) GETSTRUCT(opftup);
1907 recomputeNamespacePath();
1910 * Quick check: if it ain't in the path at all, it ain't visible. Items in
1911 * the system namespace are surely in the path and so we needn't even do
1912 * list_member_oid() for them.
1914 opfnamespace = opfform->opfnamespace;
1915 if (opfnamespace != PG_CATALOG_NAMESPACE &&
1916 !list_member_oid(activeSearchPath, opfnamespace))
1921 * If it is in the path, it might still not be visible; it could be
1922 * hidden by another opfamily of the same name earlier in the path. So
1923 * we must do a slow check to see if this opfamily would be found by
1924 * OpfamilynameGetOpfid.
1926 char *opfname = NameStr(opfform->opfname);
1928 visible = (OpfamilynameGetOpfid(opfform->opfmethod, opfname) == opfid);
1931 ReleaseSysCache(opftup);
1938 * If there's a collation of the given name/namespace, and it works
1939 * with the given encoding, return its OID. Else return InvalidOid.
1942 lookup_collation(const char *collname, Oid collnamespace, int32 encoding)
1946 Form_pg_collation collform;
1948 /* Check for encoding-specific entry (exact match) */
1949 collid = GetSysCacheOid3(COLLNAMEENCNSP, Anum_pg_collation_oid,
1950 PointerGetDatum(collname),
1951 Int32GetDatum(encoding),
1952 ObjectIdGetDatum(collnamespace));
1953 if (OidIsValid(collid))
1957 * Check for any-encoding entry. This takes a bit more work: while libc
1958 * collations with collencoding = -1 do work with all encodings, ICU
1959 * collations only work with certain encodings, so we have to check that
1960 * aspect before deciding it's a match.
1962 colltup = SearchSysCache3(COLLNAMEENCNSP,
1963 PointerGetDatum(collname),
1965 ObjectIdGetDatum(collnamespace));
1966 if (!HeapTupleIsValid(colltup))
1968 collform = (Form_pg_collation) GETSTRUCT(colltup);
1969 if (collform->collprovider == COLLPROVIDER_ICU)
1971 if (is_encoding_supported_by_icu(encoding))
1972 collid = collform->oid;
1974 collid = InvalidOid;
1978 collid = collform->oid;
1980 ReleaseSysCache(colltup);
1985 * CollationGetCollid
1986 * Try to resolve an unqualified collation name.
1987 * Returns OID if collation found in search path, else InvalidOid.
1989 * Note that this will only find collations that work with the current
1990 * database's encoding.
1993 CollationGetCollid(const char *collname)
1995 int32 dbencoding = GetDatabaseEncoding();
1998 recomputeNamespacePath();
2000 foreach(l, activeSearchPath)
2002 Oid namespaceId = lfirst_oid(l);
2005 if (namespaceId == myTempNamespace)
2006 continue; /* do not look in temp namespace */
2008 collid = lookup_collation(collname, namespaceId, dbencoding);
2009 if (OidIsValid(collid))
2013 /* Not found in path */
2018 * CollationIsVisible
2019 * Determine whether a collation (identified by OID) is visible in the
2020 * current search path. Visible means "would be found by searching
2021 * for the unqualified collation name".
2023 * Note that only collations that work with the current database's encoding
2024 * will be considered visible.
2027 CollationIsVisible(Oid collid)
2030 Form_pg_collation collform;
2034 colltup = SearchSysCache1(COLLOID, ObjectIdGetDatum(collid));
2035 if (!HeapTupleIsValid(colltup))
2036 elog(ERROR, "cache lookup failed for collation %u", collid);
2037 collform = (Form_pg_collation) GETSTRUCT(colltup);
2039 recomputeNamespacePath();
2042 * Quick check: if it ain't in the path at all, it ain't visible. Items in
2043 * the system namespace are surely in the path and so we needn't even do
2044 * list_member_oid() for them.
2046 collnamespace = collform->collnamespace;
2047 if (collnamespace != PG_CATALOG_NAMESPACE &&
2048 !list_member_oid(activeSearchPath, collnamespace))
2053 * If it is in the path, it might still not be visible; it could be
2054 * hidden by another collation of the same name earlier in the path,
2055 * or it might not work with the current DB encoding. So we must do a
2056 * slow check to see if this collation would be found by
2057 * CollationGetCollid.
2059 char *collname = NameStr(collform->collname);
2061 visible = (CollationGetCollid(collname) == collid);
2064 ReleaseSysCache(colltup);
2071 * ConversionGetConid
2072 * Try to resolve an unqualified conversion name.
2073 * Returns OID if conversion found in search path, else InvalidOid.
2075 * This is essentially the same as RelnameGetRelid.
2078 ConversionGetConid(const char *conname)
2083 recomputeNamespacePath();
2085 foreach(l, activeSearchPath)
2087 Oid namespaceId = lfirst_oid(l);
2089 if (namespaceId == myTempNamespace)
2090 continue; /* do not look in temp namespace */
2092 conid = GetSysCacheOid2(CONNAMENSP, Anum_pg_conversion_oid,
2093 PointerGetDatum(conname),
2094 ObjectIdGetDatum(namespaceId));
2095 if (OidIsValid(conid))
2099 /* Not found in path */
2104 * ConversionIsVisible
2105 * Determine whether a conversion (identified by OID) is visible in the
2106 * current search path. Visible means "would be found by searching
2107 * for the unqualified conversion name".
2110 ConversionIsVisible(Oid conid)
2113 Form_pg_conversion conform;
2117 contup = SearchSysCache1(CONVOID, ObjectIdGetDatum(conid));
2118 if (!HeapTupleIsValid(contup))
2119 elog(ERROR, "cache lookup failed for conversion %u", conid);
2120 conform = (Form_pg_conversion) GETSTRUCT(contup);
2122 recomputeNamespacePath();
2125 * Quick check: if it ain't in the path at all, it ain't visible. Items in
2126 * the system namespace are surely in the path and so we needn't even do
2127 * list_member_oid() for them.
2129 connamespace = conform->connamespace;
2130 if (connamespace != PG_CATALOG_NAMESPACE &&
2131 !list_member_oid(activeSearchPath, connamespace))
2136 * If it is in the path, it might still not be visible; it could be
2137 * hidden by another conversion of the same name earlier in the path.
2138 * So we must do a slow check to see if this conversion would be found
2139 * by ConversionGetConid.
2141 char *conname = NameStr(conform->conname);
2143 visible = (ConversionGetConid(conname) == conid);
2146 ReleaseSysCache(contup);
2152 * get_statistics_object_oid - find a statistics object by possibly qualified name
2154 * If not found, returns InvalidOid if missing_ok, else throws error
2157 get_statistics_object_oid(List *names, bool missing_ok)
2162 Oid stats_oid = InvalidOid;
2165 /* deconstruct the name list */
2166 DeconstructQualifiedName(names, &schemaname, &stats_name);
2170 /* use exact schema given */
2171 namespaceId = LookupExplicitNamespace(schemaname, missing_ok);
2172 if (missing_ok && !OidIsValid(namespaceId))
2173 stats_oid = InvalidOid;
2175 stats_oid = GetSysCacheOid2(STATEXTNAMENSP, Anum_pg_statistic_ext_oid,
2176 PointerGetDatum(stats_name),
2177 ObjectIdGetDatum(namespaceId));
2181 /* search for it in search path */
2182 recomputeNamespacePath();
2184 foreach(l, activeSearchPath)
2186 namespaceId = lfirst_oid(l);
2188 if (namespaceId == myTempNamespace)
2189 continue; /* do not look in temp namespace */
2190 stats_oid = GetSysCacheOid2(STATEXTNAMENSP, Anum_pg_statistic_ext_oid,
2191 PointerGetDatum(stats_name),
2192 ObjectIdGetDatum(namespaceId));
2193 if (OidIsValid(stats_oid))
2198 if (!OidIsValid(stats_oid) && !missing_ok)
2200 (errcode(ERRCODE_UNDEFINED_OBJECT),
2201 errmsg("statistics object \"%s\" does not exist",
2202 NameListToString(names))));
2208 * StatisticsObjIsVisible
2209 * Determine whether a statistics object (identified by OID) is visible in
2210 * the current search path. Visible means "would be found by searching
2211 * for the unqualified statistics object name".
2214 StatisticsObjIsVisible(Oid relid)
2217 Form_pg_statistic_ext stxform;
2221 stxtup = SearchSysCache1(STATEXTOID, ObjectIdGetDatum(relid));
2222 if (!HeapTupleIsValid(stxtup))
2223 elog(ERROR, "cache lookup failed for statistics object %u", relid);
2224 stxform = (Form_pg_statistic_ext) GETSTRUCT(stxtup);
2226 recomputeNamespacePath();
2229 * Quick check: if it ain't in the path at all, it ain't visible. Items in
2230 * the system namespace are surely in the path and so we needn't even do
2231 * list_member_oid() for them.
2233 stxnamespace = stxform->stxnamespace;
2234 if (stxnamespace != PG_CATALOG_NAMESPACE &&
2235 !list_member_oid(activeSearchPath, stxnamespace))
2240 * If it is in the path, it might still not be visible; it could be
2241 * hidden by another statistics object of the same name earlier in the
2242 * path. So we must do a slow check for conflicting objects.
2244 char *stxname = NameStr(stxform->stxname);
2248 foreach(l, activeSearchPath)
2250 Oid namespaceId = lfirst_oid(l);
2252 if (namespaceId == stxnamespace)
2254 /* Found it first in path */
2258 if (SearchSysCacheExists2(STATEXTNAMENSP,
2259 PointerGetDatum(stxname),
2260 ObjectIdGetDatum(namespaceId)))
2262 /* Found something else first in path */
2268 ReleaseSysCache(stxtup);
2274 * get_ts_parser_oid - find a TS parser by possibly qualified name
2276 * If not found, returns InvalidOid if missing_ok, else throws error
2279 get_ts_parser_oid(List *names, bool missing_ok)
2284 Oid prsoid = InvalidOid;
2287 /* deconstruct the name list */
2288 DeconstructQualifiedName(names, &schemaname, &parser_name);
2292 /* use exact schema given */
2293 namespaceId = LookupExplicitNamespace(schemaname, missing_ok);
2294 if (missing_ok && !OidIsValid(namespaceId))
2295 prsoid = InvalidOid;
2297 prsoid = GetSysCacheOid2(TSPARSERNAMENSP, Anum_pg_ts_parser_oid,
2298 PointerGetDatum(parser_name),
2299 ObjectIdGetDatum(namespaceId));
2303 /* search for it in search path */
2304 recomputeNamespacePath();
2306 foreach(l, activeSearchPath)
2308 namespaceId = lfirst_oid(l);
2310 if (namespaceId == myTempNamespace)
2311 continue; /* do not look in temp namespace */
2313 prsoid = GetSysCacheOid2(TSPARSERNAMENSP, Anum_pg_ts_parser_oid,
2314 PointerGetDatum(parser_name),
2315 ObjectIdGetDatum(namespaceId));
2316 if (OidIsValid(prsoid))
2321 if (!OidIsValid(prsoid) && !missing_ok)
2323 (errcode(ERRCODE_UNDEFINED_OBJECT),
2324 errmsg("text search parser \"%s\" does not exist",
2325 NameListToString(names))));
2332 * Determine whether a parser (identified by OID) is visible in the
2333 * current search path. Visible means "would be found by searching
2334 * for the unqualified parser name".
2337 TSParserIsVisible(Oid prsId)
2340 Form_pg_ts_parser form;
2344 tup = SearchSysCache1(TSPARSEROID, ObjectIdGetDatum(prsId));
2345 if (!HeapTupleIsValid(tup))
2346 elog(ERROR, "cache lookup failed for text search parser %u", prsId);
2347 form = (Form_pg_ts_parser) GETSTRUCT(tup);
2349 recomputeNamespacePath();
2352 * Quick check: if it ain't in the path at all, it ain't visible. Items in
2353 * the system namespace are surely in the path and so we needn't even do
2354 * list_member_oid() for them.
2356 namespace = form->prsnamespace;
2357 if (namespace != PG_CATALOG_NAMESPACE &&
2358 !list_member_oid(activeSearchPath, namespace))
2363 * If it is in the path, it might still not be visible; it could be
2364 * hidden by another parser of the same name earlier in the path. So
2365 * we must do a slow check for conflicting parsers.
2367 char *name = NameStr(form->prsname);
2371 foreach(l, activeSearchPath)
2373 Oid namespaceId = lfirst_oid(l);
2375 if (namespaceId == myTempNamespace)
2376 continue; /* do not look in temp namespace */
2378 if (namespaceId == namespace)
2380 /* Found it first in path */
2384 if (SearchSysCacheExists2(TSPARSERNAMENSP,
2385 PointerGetDatum(name),
2386 ObjectIdGetDatum(namespaceId)))
2388 /* Found something else first in path */
2394 ReleaseSysCache(tup);
2400 * get_ts_dict_oid - find a TS dictionary by possibly qualified name
2402 * If not found, returns InvalidOid if failOK, else throws error
2405 get_ts_dict_oid(List *names, bool missing_ok)
2410 Oid dictoid = InvalidOid;
2413 /* deconstruct the name list */
2414 DeconstructQualifiedName(names, &schemaname, &dict_name);
2418 /* use exact schema given */
2419 namespaceId = LookupExplicitNamespace(schemaname, missing_ok);
2420 if (missing_ok && !OidIsValid(namespaceId))
2421 dictoid = InvalidOid;
2423 dictoid = GetSysCacheOid2(TSDICTNAMENSP, Anum_pg_ts_dict_oid,
2424 PointerGetDatum(dict_name),
2425 ObjectIdGetDatum(namespaceId));
2429 /* search for it in search path */
2430 recomputeNamespacePath();
2432 foreach(l, activeSearchPath)
2434 namespaceId = lfirst_oid(l);
2436 if (namespaceId == myTempNamespace)
2437 continue; /* do not look in temp namespace */
2439 dictoid = GetSysCacheOid2(TSDICTNAMENSP, Anum_pg_ts_dict_oid,
2440 PointerGetDatum(dict_name),
2441 ObjectIdGetDatum(namespaceId));
2442 if (OidIsValid(dictoid))
2447 if (!OidIsValid(dictoid) && !missing_ok)
2449 (errcode(ERRCODE_UNDEFINED_OBJECT),
2450 errmsg("text search dictionary \"%s\" does not exist",
2451 NameListToString(names))));
2457 * TSDictionaryIsVisible
2458 * Determine whether a dictionary (identified by OID) is visible in the
2459 * current search path. Visible means "would be found by searching
2460 * for the unqualified dictionary name".
2463 TSDictionaryIsVisible(Oid dictId)
2466 Form_pg_ts_dict form;
2470 tup = SearchSysCache1(TSDICTOID, ObjectIdGetDatum(dictId));
2471 if (!HeapTupleIsValid(tup))
2472 elog(ERROR, "cache lookup failed for text search dictionary %u",
2474 form = (Form_pg_ts_dict) GETSTRUCT(tup);
2476 recomputeNamespacePath();
2479 * Quick check: if it ain't in the path at all, it ain't visible. Items in
2480 * the system namespace are surely in the path and so we needn't even do
2481 * list_member_oid() for them.
2483 namespace = form->dictnamespace;
2484 if (namespace != PG_CATALOG_NAMESPACE &&
2485 !list_member_oid(activeSearchPath, namespace))
2490 * If it is in the path, it might still not be visible; it could be
2491 * hidden by another dictionary of the same name earlier in the path.
2492 * So we must do a slow check for conflicting dictionaries.
2494 char *name = NameStr(form->dictname);
2498 foreach(l, activeSearchPath)
2500 Oid namespaceId = lfirst_oid(l);
2502 if (namespaceId == myTempNamespace)
2503 continue; /* do not look in temp namespace */
2505 if (namespaceId == namespace)
2507 /* Found it first in path */
2511 if (SearchSysCacheExists2(TSDICTNAMENSP,
2512 PointerGetDatum(name),
2513 ObjectIdGetDatum(namespaceId)))
2515 /* Found something else first in path */
2521 ReleaseSysCache(tup);
2527 * get_ts_template_oid - find a TS template by possibly qualified name
2529 * If not found, returns InvalidOid if missing_ok, else throws error
2532 get_ts_template_oid(List *names, bool missing_ok)
2535 char *template_name;
2537 Oid tmploid = InvalidOid;
2540 /* deconstruct the name list */
2541 DeconstructQualifiedName(names, &schemaname, &template_name);
2545 /* use exact schema given */
2546 namespaceId = LookupExplicitNamespace(schemaname, missing_ok);
2547 if (missing_ok && !OidIsValid(namespaceId))
2548 tmploid = InvalidOid;
2550 tmploid = GetSysCacheOid2(TSTEMPLATENAMENSP, Anum_pg_ts_template_oid,
2551 PointerGetDatum(template_name),
2552 ObjectIdGetDatum(namespaceId));
2556 /* search for it in search path */
2557 recomputeNamespacePath();
2559 foreach(l, activeSearchPath)
2561 namespaceId = lfirst_oid(l);
2563 if (namespaceId == myTempNamespace)
2564 continue; /* do not look in temp namespace */
2566 tmploid = GetSysCacheOid2(TSTEMPLATENAMENSP, Anum_pg_ts_template_oid,
2567 PointerGetDatum(template_name),
2568 ObjectIdGetDatum(namespaceId));
2569 if (OidIsValid(tmploid))
2574 if (!OidIsValid(tmploid) && !missing_ok)
2576 (errcode(ERRCODE_UNDEFINED_OBJECT),
2577 errmsg("text search template \"%s\" does not exist",
2578 NameListToString(names))));
2584 * TSTemplateIsVisible
2585 * Determine whether a template (identified by OID) is visible in the
2586 * current search path. Visible means "would be found by searching
2587 * for the unqualified template name".
2590 TSTemplateIsVisible(Oid tmplId)
2593 Form_pg_ts_template form;
2597 tup = SearchSysCache1(TSTEMPLATEOID, ObjectIdGetDatum(tmplId));
2598 if (!HeapTupleIsValid(tup))
2599 elog(ERROR, "cache lookup failed for text search template %u", tmplId);
2600 form = (Form_pg_ts_template) GETSTRUCT(tup);
2602 recomputeNamespacePath();
2605 * Quick check: if it ain't in the path at all, it ain't visible. Items in
2606 * the system namespace are surely in the path and so we needn't even do
2607 * list_member_oid() for them.
2609 namespace = form->tmplnamespace;
2610 if (namespace != PG_CATALOG_NAMESPACE &&
2611 !list_member_oid(activeSearchPath, namespace))
2616 * If it is in the path, it might still not be visible; it could be
2617 * hidden by another template of the same name earlier in the path. So
2618 * we must do a slow check for conflicting templates.
2620 char *name = NameStr(form->tmplname);
2624 foreach(l, activeSearchPath)
2626 Oid namespaceId = lfirst_oid(l);
2628 if (namespaceId == myTempNamespace)
2629 continue; /* do not look in temp namespace */
2631 if (namespaceId == namespace)
2633 /* Found it first in path */
2637 if (SearchSysCacheExists2(TSTEMPLATENAMENSP,
2638 PointerGetDatum(name),
2639 ObjectIdGetDatum(namespaceId)))
2641 /* Found something else first in path */
2647 ReleaseSysCache(tup);
2653 * get_ts_config_oid - find a TS config by possibly qualified name
2655 * If not found, returns InvalidOid if missing_ok, else throws error
2658 get_ts_config_oid(List *names, bool missing_ok)
2663 Oid cfgoid = InvalidOid;
2666 /* deconstruct the name list */
2667 DeconstructQualifiedName(names, &schemaname, &config_name);
2671 /* use exact schema given */
2672 namespaceId = LookupExplicitNamespace(schemaname, missing_ok);
2673 if (missing_ok && !OidIsValid(namespaceId))
2674 cfgoid = InvalidOid;
2676 cfgoid = GetSysCacheOid2(TSCONFIGNAMENSP, Anum_pg_ts_config_oid,
2677 PointerGetDatum(config_name),
2678 ObjectIdGetDatum(namespaceId));
2682 /* search for it in search path */
2683 recomputeNamespacePath();
2685 foreach(l, activeSearchPath)
2687 namespaceId = lfirst_oid(l);
2689 if (namespaceId == myTempNamespace)
2690 continue; /* do not look in temp namespace */
2692 cfgoid = GetSysCacheOid2(TSCONFIGNAMENSP, Anum_pg_ts_config_oid,
2693 PointerGetDatum(config_name),
2694 ObjectIdGetDatum(namespaceId));
2695 if (OidIsValid(cfgoid))
2700 if (!OidIsValid(cfgoid) && !missing_ok)
2702 (errcode(ERRCODE_UNDEFINED_OBJECT),
2703 errmsg("text search configuration \"%s\" does not exist",
2704 NameListToString(names))));
2711 * Determine whether a text search configuration (identified by OID)
2712 * is visible in the current search path. Visible means "would be found
2713 * by searching for the unqualified text search configuration name".
2716 TSConfigIsVisible(Oid cfgid)
2719 Form_pg_ts_config form;
2723 tup = SearchSysCache1(TSCONFIGOID, ObjectIdGetDatum(cfgid));
2724 if (!HeapTupleIsValid(tup))
2725 elog(ERROR, "cache lookup failed for text search configuration %u",
2727 form = (Form_pg_ts_config) GETSTRUCT(tup);
2729 recomputeNamespacePath();
2732 * Quick check: if it ain't in the path at all, it ain't visible. Items in
2733 * the system namespace are surely in the path and so we needn't even do
2734 * list_member_oid() for them.
2736 namespace = form->cfgnamespace;
2737 if (namespace != PG_CATALOG_NAMESPACE &&
2738 !list_member_oid(activeSearchPath, namespace))
2743 * If it is in the path, it might still not be visible; it could be
2744 * hidden by another configuration of the same name earlier in the
2745 * path. So we must do a slow check for conflicting configurations.
2747 char *name = NameStr(form->cfgname);
2751 foreach(l, activeSearchPath)
2753 Oid namespaceId = lfirst_oid(l);
2755 if (namespaceId == myTempNamespace)
2756 continue; /* do not look in temp namespace */
2758 if (namespaceId == namespace)
2760 /* Found it first in path */
2764 if (SearchSysCacheExists2(TSCONFIGNAMENSP,
2765 PointerGetDatum(name),
2766 ObjectIdGetDatum(namespaceId)))
2768 /* Found something else first in path */
2774 ReleaseSysCache(tup);
2781 * DeconstructQualifiedName
2782 * Given a possibly-qualified name expressed as a list of String nodes,
2783 * extract the schema name and object name.
2785 * *nspname_p is set to NULL if there is no explicit schema name.
2788 DeconstructQualifiedName(List *names,
2793 char *schemaname = NULL;
2794 char *objname = NULL;
2796 switch (list_length(names))
2799 objname = strVal(linitial(names));
2802 schemaname = strVal(linitial(names));
2803 objname = strVal(lsecond(names));
2806 catalogname = strVal(linitial(names));
2807 schemaname = strVal(lsecond(names));
2808 objname = strVal(lthird(names));
2811 * We check the catalog name and then ignore it.
2813 if (strcmp(catalogname, get_database_name(MyDatabaseId)) != 0)
2815 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
2816 errmsg("cross-database references are not implemented: %s",
2817 NameListToString(names))));
2821 (errcode(ERRCODE_SYNTAX_ERROR),
2822 errmsg("improper qualified name (too many dotted names): %s",
2823 NameListToString(names))));
2827 *nspname_p = schemaname;
2828 *objname_p = objname;
2832 * LookupNamespaceNoError
2833 * Look up a schema name.
2835 * Returns the namespace OID, or InvalidOid if not found.
2837 * Note this does NOT perform any permissions check --- callers are
2838 * responsible for being sure that an appropriate check is made.
2839 * In the majority of cases LookupExplicitNamespace is preferable.
2842 LookupNamespaceNoError(const char *nspname)
2844 /* check for pg_temp alias */
2845 if (strcmp(nspname, "pg_temp") == 0)
2847 if (OidIsValid(myTempNamespace))
2849 InvokeNamespaceSearchHook(myTempNamespace, true);
2850 return myTempNamespace;
2854 * Since this is used only for looking up existing objects, there is
2855 * no point in trying to initialize the temp namespace here; and doing
2856 * so might create problems for some callers. Just report "not found".
2861 return get_namespace_oid(nspname, true);
2865 * LookupExplicitNamespace
2866 * Process an explicitly-specified schema name: look up the schema
2867 * and verify we have USAGE (lookup) rights in it.
2869 * Returns the namespace OID
2872 LookupExplicitNamespace(const char *nspname, bool missing_ok)
2875 AclResult aclresult;
2877 /* check for pg_temp alias */
2878 if (strcmp(nspname, "pg_temp") == 0)
2880 if (OidIsValid(myTempNamespace))
2881 return myTempNamespace;
2884 * Since this is used only for looking up existing objects, there is
2885 * no point in trying to initialize the temp namespace here; and doing
2886 * so might create problems for some callers --- just fall through.
2890 namespaceId = get_namespace_oid(nspname, missing_ok);
2891 if (missing_ok && !OidIsValid(namespaceId))
2894 aclresult = pg_namespace_aclcheck(namespaceId, GetUserId(), ACL_USAGE);
2895 if (aclresult != ACLCHECK_OK)
2896 aclcheck_error(aclresult, OBJECT_SCHEMA,
2898 /* Schema search hook for this lookup */
2899 InvokeNamespaceSearchHook(namespaceId, true);
2905 * LookupCreationNamespace
2906 * Look up the schema and verify we have CREATE rights on it.
2908 * This is just like LookupExplicitNamespace except for the different
2909 * permission check, and that we are willing to create pg_temp if needed.
2911 * Note: calling this may result in a CommandCounterIncrement operation,
2912 * if we have to create or clean out the temp namespace.
2915 LookupCreationNamespace(const char *nspname)
2918 AclResult aclresult;
2920 /* check for pg_temp alias */
2921 if (strcmp(nspname, "pg_temp") == 0)
2923 /* Initialize temp namespace */
2924 AccessTempTableNamespace(false);
2925 return myTempNamespace;
2928 namespaceId = get_namespace_oid(nspname, false);
2930 aclresult = pg_namespace_aclcheck(namespaceId, GetUserId(), ACL_CREATE);
2931 if (aclresult != ACLCHECK_OK)
2932 aclcheck_error(aclresult, OBJECT_SCHEMA,
2939 * Common checks on switching namespaces.
2941 * We complain if either the old or new namespaces is a temporary schema
2942 * (or temporary toast schema), or if either the old or new namespaces is the
2946 CheckSetNamespace(Oid oldNspOid, Oid nspOid)
2948 /* disallow renaming into or out of temp schemas */
2949 if (isAnyTempNamespace(nspOid) || isAnyTempNamespace(oldNspOid))
2951 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
2952 errmsg("cannot move objects into or out of temporary schemas")));
2954 /* same for TOAST schema */
2955 if (nspOid == PG_TOAST_NAMESPACE || oldNspOid == PG_TOAST_NAMESPACE)
2957 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
2958 errmsg("cannot move objects into or out of TOAST schema")));
2962 * QualifiedNameGetCreationNamespace
2963 * Given a possibly-qualified name for an object (in List-of-Values
2964 * format), determine what namespace the object should be created in.
2965 * Also extract and return the object name (last component of list).
2967 * Note: this does not apply any permissions check. Callers must check
2968 * for CREATE rights on the selected namespace when appropriate.
2970 * Note: calling this may result in a CommandCounterIncrement operation,
2971 * if we have to create or clean out the temp namespace.
2974 QualifiedNameGetCreationNamespace(List *names, char **objname_p)
2979 /* deconstruct the name list */
2980 DeconstructQualifiedName(names, &schemaname, objname_p);
2984 /* check for pg_temp alias */
2985 if (strcmp(schemaname, "pg_temp") == 0)
2987 /* Initialize temp namespace */
2988 AccessTempTableNamespace(false);
2989 return myTempNamespace;
2991 /* use exact schema given */
2992 namespaceId = get_namespace_oid(schemaname, false);
2993 /* we do not check for USAGE rights here! */
2997 /* use the default creation namespace */
2998 recomputeNamespacePath();
2999 if (activeTempCreationPending)
3001 /* Need to initialize temp namespace */
3002 AccessTempTableNamespace(true);
3003 return myTempNamespace;
3005 namespaceId = activeCreationNamespace;
3006 if (!OidIsValid(namespaceId))
3008 (errcode(ERRCODE_UNDEFINED_SCHEMA),
3009 errmsg("no schema has been selected to create in")));
3016 * get_namespace_oid - given a namespace name, look up the OID
3018 * If missing_ok is false, throw an error if namespace name not found. If
3019 * true, just return InvalidOid.
3022 get_namespace_oid(const char *nspname, bool missing_ok)
3026 oid = GetSysCacheOid1(NAMESPACENAME, Anum_pg_namespace_oid,
3027 CStringGetDatum(nspname));
3028 if (!OidIsValid(oid) && !missing_ok)
3030 (errcode(ERRCODE_UNDEFINED_SCHEMA),
3031 errmsg("schema \"%s\" does not exist", nspname)));
3037 * makeRangeVarFromNameList
3038 * Utility routine to convert a qualified-name list into RangeVar form.
3041 makeRangeVarFromNameList(List *names)
3043 RangeVar *rel = makeRangeVar(NULL, NULL, -1);
3045 switch (list_length(names))
3048 rel->relname = strVal(linitial(names));
3051 rel->schemaname = strVal(linitial(names));
3052 rel->relname = strVal(lsecond(names));
3055 rel->catalogname = strVal(linitial(names));
3056 rel->schemaname = strVal(lsecond(names));
3057 rel->relname = strVal(lthird(names));
3061 (errcode(ERRCODE_SYNTAX_ERROR),
3062 errmsg("improper relation name (too many dotted names): %s",
3063 NameListToString(names))));
3072 * Utility routine to convert a qualified-name list into a string.
3074 * This is used primarily to form error messages, and so we do not quote
3075 * the list elements, for the sake of legibility.
3077 * In most scenarios the list elements should always be Value strings,
3078 * but we also allow A_Star for the convenience of ColumnRef processing.
3081 NameListToString(List *names)
3083 StringInfoData string;
3086 initStringInfo(&string);
3090 Node *name = (Node *) lfirst(l);
3092 if (l != list_head(names))
3093 appendStringInfoChar(&string, '.');
3095 if (IsA(name, String))
3096 appendStringInfoString(&string, strVal(name));
3097 else if (IsA(name, A_Star))
3098 appendStringInfoChar(&string, '*');
3100 elog(ERROR, "unexpected node type in name list: %d",
3101 (int) nodeTag(name));
3108 * NameListToQuotedString
3109 * Utility routine to convert a qualified-name list into a string.
3111 * Same as above except that names will be double-quoted where necessary,
3112 * so the string could be re-parsed (eg, by textToQualifiedNameList).
3115 NameListToQuotedString(List *names)
3117 StringInfoData string;
3120 initStringInfo(&string);
3124 if (l != list_head(names))
3125 appendStringInfoChar(&string, '.');
3126 appendStringInfoString(&string, quote_identifier(strVal(lfirst(l))));
3133 * isTempNamespace - is the given namespace my temporary-table namespace?
3136 isTempNamespace(Oid namespaceId)
3138 if (OidIsValid(myTempNamespace) && myTempNamespace == namespaceId)
3144 * isTempToastNamespace - is the given namespace my temporary-toast-table
3148 isTempToastNamespace(Oid namespaceId)
3150 if (OidIsValid(myTempToastNamespace) && myTempToastNamespace == namespaceId)
3156 * isTempOrTempToastNamespace - is the given namespace my temporary-table
3157 * namespace or my temporary-toast-table namespace?
3160 isTempOrTempToastNamespace(Oid namespaceId)
3162 if (OidIsValid(myTempNamespace) &&
3163 (myTempNamespace == namespaceId || myTempToastNamespace == namespaceId))
3169 * isAnyTempNamespace - is the given namespace a temporary-table namespace
3170 * (either my own, or another backend's)? Temporary-toast-table namespaces
3171 * are included, too.
3174 isAnyTempNamespace(Oid namespaceId)
3179 /* True if the namespace name starts with "pg_temp_" or "pg_toast_temp_" */
3180 nspname = get_namespace_name(namespaceId);
3182 return false; /* no such namespace? */
3183 result = (strncmp(nspname, "pg_temp_", 8) == 0) ||
3184 (strncmp(nspname, "pg_toast_temp_", 14) == 0);
3190 * isOtherTempNamespace - is the given namespace some other backend's
3191 * temporary-table namespace (including temporary-toast-table namespaces)?
3193 * Note: for most purposes in the C code, this function is obsolete. Use
3194 * RELATION_IS_OTHER_TEMP() instead to detect non-local temp relations.
3197 isOtherTempNamespace(Oid namespaceId)
3199 /* If it's my own temp namespace, say "false" */
3200 if (isTempOrTempToastNamespace(namespaceId))
3202 /* Else, if it's any temp namespace, say "true" */
3203 return isAnyTempNamespace(namespaceId);
3207 * isTempNamespaceInUse - is the given namespace owned and actively used
3210 * Note: this can be used while scanning relations in pg_class to detect
3211 * orphaned temporary tables or namespaces with a backend connected to a
3212 * given database. The result may be out of date quickly, so the caller
3213 * must be careful how to handle this information.
3216 isTempNamespaceInUse(Oid namespaceId)
3221 Assert(OidIsValid(MyDatabaseId));
3223 backendId = GetTempNamespaceBackendId(namespaceId);
3225 if (backendId == InvalidBackendId ||
3226 backendId == MyBackendId)
3229 /* Is the backend alive? */
3230 proc = BackendIdGetProc(backendId);
3234 /* Is the backend connected to the same database we are looking at? */
3235 if (proc->databaseId != MyDatabaseId)
3238 /* Does the backend own the temporary namespace? */
3239 if (proc->tempNamespaceId != namespaceId)
3242 /* all good to go */
3247 * GetTempNamespaceBackendId - if the given namespace is a temporary-table
3248 * namespace (either my own, or another backend's), return the BackendId
3249 * that owns it. Temporary-toast-table namespaces are included, too.
3250 * If it isn't a temp namespace, return InvalidBackendId.
3253 GetTempNamespaceBackendId(Oid namespaceId)
3258 /* See if the namespace name starts with "pg_temp_" or "pg_toast_temp_" */
3259 nspname = get_namespace_name(namespaceId);
3261 return InvalidBackendId; /* no such namespace? */
3262 if (strncmp(nspname, "pg_temp_", 8) == 0)
3263 result = atoi(nspname + 8);
3264 else if (strncmp(nspname, "pg_toast_temp_", 14) == 0)
3265 result = atoi(nspname + 14);
3267 result = InvalidBackendId;
3273 * GetTempToastNamespace - get the OID of my temporary-toast-table namespace,
3274 * which must already be assigned. (This is only used when creating a toast
3275 * table for a temp table, so we must have already done InitTempTableNamespace)
3278 GetTempToastNamespace(void)
3280 Assert(OidIsValid(myTempToastNamespace));
3281 return myTempToastNamespace;
3286 * GetTempNamespaceState - fetch status of session's temporary namespace
3288 * This is used for conveying state to a parallel worker, and is not meant
3289 * for general-purpose access.
3292 GetTempNamespaceState(Oid *tempNamespaceId, Oid *tempToastNamespaceId)
3294 /* Return namespace OIDs, or 0 if session has not created temp namespace */
3295 *tempNamespaceId = myTempNamespace;
3296 *tempToastNamespaceId = myTempToastNamespace;
3300 * SetTempNamespaceState - set status of session's temporary namespace
3302 * This is used for conveying state to a parallel worker, and is not meant for
3303 * general-purpose access. By transferring these namespace OIDs to workers,
3304 * we ensure they will have the same notion of the search path as their leader
3308 SetTempNamespaceState(Oid tempNamespaceId, Oid tempToastNamespaceId)
3310 /* Worker should not have created its own namespaces ... */
3311 Assert(myTempNamespace == InvalidOid);
3312 Assert(myTempToastNamespace == InvalidOid);
3313 Assert(myTempNamespaceSubID == InvalidSubTransactionId);
3315 /* Assign same namespace OIDs that leader has */
3316 myTempNamespace = tempNamespaceId;
3317 myTempToastNamespace = tempToastNamespaceId;
3320 * It's fine to leave myTempNamespaceSubID == InvalidSubTransactionId.
3321 * Even if the namespace is new so far as the leader is concerned, it's
3322 * not new to the worker, and we certainly wouldn't want the worker trying
3326 baseSearchPathValid = false; /* may need to rebuild list */
3331 * GetOverrideSearchPath - fetch current search path definition in form
3332 * used by PushOverrideSearchPath.
3334 * The result structure is allocated in the specified memory context
3335 * (which might or might not be equal to CurrentMemoryContext); but any
3336 * junk created by revalidation calculations will be in CurrentMemoryContext.
3338 OverrideSearchPath *
3339 GetOverrideSearchPath(MemoryContext context)
3341 OverrideSearchPath *result;
3343 MemoryContext oldcxt;
3345 recomputeNamespacePath();
3347 oldcxt = MemoryContextSwitchTo(context);
3349 result = (OverrideSearchPath *) palloc0(sizeof(OverrideSearchPath));
3350 schemas = list_copy(activeSearchPath);
3351 while (schemas && linitial_oid(schemas) != activeCreationNamespace)
3353 if (linitial_oid(schemas) == myTempNamespace)
3354 result->addTemp = true;
3357 Assert(linitial_oid(schemas) == PG_CATALOG_NAMESPACE);
3358 result->addCatalog = true;
3360 schemas = list_delete_first(schemas);
3362 result->schemas = schemas;
3364 MemoryContextSwitchTo(oldcxt);
3370 * CopyOverrideSearchPath - copy the specified OverrideSearchPath.
3372 * The result structure is allocated in CurrentMemoryContext.
3374 OverrideSearchPath *
3375 CopyOverrideSearchPath(OverrideSearchPath *path)
3377 OverrideSearchPath *result;
3379 result = (OverrideSearchPath *) palloc(sizeof(OverrideSearchPath));
3380 result->schemas = list_copy(path->schemas);
3381 result->addCatalog = path->addCatalog;
3382 result->addTemp = path->addTemp;
3388 * OverrideSearchPathMatchesCurrent - does path match current setting?
3391 OverrideSearchPathMatchesCurrent(OverrideSearchPath *path)
3396 recomputeNamespacePath();
3398 /* We scan down the activeSearchPath to see if it matches the input. */
3399 lc = list_head(activeSearchPath);
3401 /* If path->addTemp, first item should be my temp namespace. */
3404 if (lc && lfirst_oid(lc) == myTempNamespace)
3409 /* If path->addCatalog, next item should be pg_catalog. */
3410 if (path->addCatalog)
3412 if (lc && lfirst_oid(lc) == PG_CATALOG_NAMESPACE)
3417 /* We should now be looking at the activeCreationNamespace. */
3418 if (activeCreationNamespace != (lc ? lfirst_oid(lc) : InvalidOid))
3420 /* The remainder of activeSearchPath should match path->schemas. */
3421 foreach(lcp, path->schemas)
3423 if (lc && lfirst_oid(lc) == lfirst_oid(lcp))
3434 * PushOverrideSearchPath - temporarily override the search path
3436 * We allow nested overrides, hence the push/pop terminology. The GUC
3437 * search_path variable is ignored while an override is active.
3439 * It's possible that newpath->useTemp is set but there is no longer any
3440 * active temp namespace, if the path was saved during a transaction that
3441 * created a temp namespace and was later rolled back. In that case we just
3442 * ignore useTemp. A plausible alternative would be to create a new temp
3443 * namespace, but for existing callers that's not necessary because an empty
3444 * temp namespace wouldn't affect their results anyway.
3446 * It's also worth noting that other schemas listed in newpath might not
3447 * exist anymore either. We don't worry about this because OIDs that match
3448 * no existing namespace will simply not produce any hits during searches.
3451 PushOverrideSearchPath(OverrideSearchPath *newpath)
3453 OverrideStackEntry *entry;
3456 MemoryContext oldcxt;
3459 * Copy the list for safekeeping, and insert implicitly-searched
3460 * namespaces as needed. This code should track recomputeNamespacePath.
3462 oldcxt = MemoryContextSwitchTo(TopMemoryContext);
3464 oidlist = list_copy(newpath->schemas);
3467 * Remember the first member of the explicit list.
3470 firstNS = InvalidOid;
3472 firstNS = linitial_oid(oidlist);
3475 * Add any implicitly-searched namespaces to the list. Note these go on
3476 * the front, not the back; also notice that we do not check USAGE
3477 * permissions for these.
3479 if (newpath->addCatalog)
3480 oidlist = lcons_oid(PG_CATALOG_NAMESPACE, oidlist);
3482 if (newpath->addTemp && OidIsValid(myTempNamespace))
3483 oidlist = lcons_oid(myTempNamespace, oidlist);
3486 * Build the new stack entry, then insert it at the head of the list.
3488 entry = (OverrideStackEntry *) palloc(sizeof(OverrideStackEntry));
3489 entry->searchPath = oidlist;
3490 entry->creationNamespace = firstNS;
3491 entry->nestLevel = GetCurrentTransactionNestLevel();
3493 overrideStack = lcons(entry, overrideStack);
3495 /* And make it active. */
3496 activeSearchPath = entry->searchPath;
3497 activeCreationNamespace = entry->creationNamespace;
3498 activeTempCreationPending = false; /* XXX is this OK? */
3500 MemoryContextSwitchTo(oldcxt);
3504 * PopOverrideSearchPath - undo a previous PushOverrideSearchPath
3506 * Any push during a (sub)transaction will be popped automatically at abort.
3507 * But it's caller error if a push isn't popped in normal control flow.
3510 PopOverrideSearchPath(void)
3512 OverrideStackEntry *entry;
3514 /* Sanity checks. */
3515 if (overrideStack == NIL)
3516 elog(ERROR, "bogus PopOverrideSearchPath call");
3517 entry = (OverrideStackEntry *) linitial(overrideStack);
3518 if (entry->nestLevel != GetCurrentTransactionNestLevel())
3519 elog(ERROR, "bogus PopOverrideSearchPath call");
3521 /* Pop the stack and free storage. */
3522 overrideStack = list_delete_first(overrideStack);
3523 list_free(entry->searchPath);
3526 /* Activate the next level down. */
3529 entry = (OverrideStackEntry *) linitial(overrideStack);
3530 activeSearchPath = entry->searchPath;
3531 activeCreationNamespace = entry->creationNamespace;
3532 activeTempCreationPending = false; /* XXX is this OK? */
3536 /* If not baseSearchPathValid, this is useless but harmless */
3537 activeSearchPath = baseSearchPath;
3538 activeCreationNamespace = baseCreationNamespace;
3539 activeTempCreationPending = baseTempCreationPending;
3545 * get_collation_oid - find a collation by possibly qualified name
3547 * Note that this will only find collations that work with the current
3548 * database's encoding.
3551 get_collation_oid(List *name, bool missing_ok)
3554 char *collation_name;
3555 int32 dbencoding = GetDatabaseEncoding();
3560 /* deconstruct the name list */
3561 DeconstructQualifiedName(name, &schemaname, &collation_name);
3565 /* use exact schema given */
3566 namespaceId = LookupExplicitNamespace(schemaname, missing_ok);
3567 if (missing_ok && !OidIsValid(namespaceId))
3570 colloid = lookup_collation(collation_name, namespaceId, dbencoding);
3571 if (OidIsValid(colloid))
3576 /* search for it in search path */
3577 recomputeNamespacePath();
3579 foreach(l, activeSearchPath)
3581 namespaceId = lfirst_oid(l);
3583 if (namespaceId == myTempNamespace)
3584 continue; /* do not look in temp namespace */
3586 colloid = lookup_collation(collation_name, namespaceId, dbencoding);
3587 if (OidIsValid(colloid))
3592 /* Not found in path */
3595 (errcode(ERRCODE_UNDEFINED_OBJECT),
3596 errmsg("collation \"%s\" for encoding \"%s\" does not exist",
3597 NameListToString(name), GetDatabaseEncodingName())));
3602 * get_conversion_oid - find a conversion by possibly qualified name
3605 get_conversion_oid(List *name, bool missing_ok)
3608 char *conversion_name;
3610 Oid conoid = InvalidOid;
3613 /* deconstruct the name list */
3614 DeconstructQualifiedName(name, &schemaname, &conversion_name);
3618 /* use exact schema given */
3619 namespaceId = LookupExplicitNamespace(schemaname, missing_ok);
3620 if (missing_ok && !OidIsValid(namespaceId))
3621 conoid = InvalidOid;
3623 conoid = GetSysCacheOid2(CONNAMENSP, Anum_pg_conversion_oid,
3624 PointerGetDatum(conversion_name),
3625 ObjectIdGetDatum(namespaceId));
3629 /* search for it in search path */
3630 recomputeNamespacePath();
3632 foreach(l, activeSearchPath)
3634 namespaceId = lfirst_oid(l);
3636 if (namespaceId == myTempNamespace)
3637 continue; /* do not look in temp namespace */
3639 conoid = GetSysCacheOid2(CONNAMENSP, Anum_pg_conversion_oid,
3640 PointerGetDatum(conversion_name),
3641 ObjectIdGetDatum(namespaceId));
3642 if (OidIsValid(conoid))
3647 /* Not found in path */
3648 if (!OidIsValid(conoid) && !missing_ok)
3650 (errcode(ERRCODE_UNDEFINED_OBJECT),
3651 errmsg("conversion \"%s\" does not exist",
3652 NameListToString(name))));
3657 * FindDefaultConversionProc - find default encoding conversion proc
3660 FindDefaultConversionProc(int32 for_encoding, int32 to_encoding)
3665 recomputeNamespacePath();
3667 foreach(l, activeSearchPath)
3669 Oid namespaceId = lfirst_oid(l);
3671 if (namespaceId == myTempNamespace)
3672 continue; /* do not look in temp namespace */
3674 proc = FindDefaultConversion(namespaceId, for_encoding, to_encoding);
3675 if (OidIsValid(proc))
3679 /* Not found in path */
3684 * recomputeNamespacePath - recompute path derived variables if needed.
3687 recomputeNamespacePath(void)
3689 Oid roleid = GetUserId();
3697 MemoryContext oldcxt;
3699 /* Do nothing if an override search spec is active. */
3703 /* Do nothing if path is already valid. */
3704 if (baseSearchPathValid && namespaceUser == roleid)
3707 /* Need a modifiable copy of namespace_search_path string */
3708 rawname = pstrdup(namespace_search_path);
3710 /* Parse string into list of identifiers */
3711 if (!SplitIdentifierString(rawname, ',', &namelist))
3713 /* syntax error in name list */
3714 /* this should not happen if GUC checked check_search_path */
3715 elog(ERROR, "invalid list syntax");
3719 * Convert the list of names to a list of OIDs. If any names are not
3720 * recognizable or we don't have read access, just leave them out of the
3721 * list. (We can't raise an error, since the search_path setting has
3722 * already been accepted.) Don't make duplicate entries, either.
3725 temp_missing = false;
3726 foreach(l, namelist)
3728 char *curname = (char *) lfirst(l);
3731 if (strcmp(curname, "$user") == 0)
3733 /* $user --- substitute namespace matching user name, if any */
3736 tuple = SearchSysCache1(AUTHOID, ObjectIdGetDatum(roleid));
3737 if (HeapTupleIsValid(tuple))
3741 rname = NameStr(((Form_pg_authid) GETSTRUCT(tuple))->rolname);
3742 namespaceId = get_namespace_oid(rname, true);
3743 ReleaseSysCache(tuple);
3744 if (OidIsValid(namespaceId) &&
3745 !list_member_oid(oidlist, namespaceId) &&
3746 pg_namespace_aclcheck(namespaceId, roleid,
3747 ACL_USAGE) == ACLCHECK_OK &&
3748 InvokeNamespaceSearchHook(namespaceId, false))
3749 oidlist = lappend_oid(oidlist, namespaceId);
3752 else if (strcmp(curname, "pg_temp") == 0)
3754 /* pg_temp --- substitute temp namespace, if any */
3755 if (OidIsValid(myTempNamespace))
3757 if (!list_member_oid(oidlist, myTempNamespace) &&
3758 InvokeNamespaceSearchHook(myTempNamespace, false))
3759 oidlist = lappend_oid(oidlist, myTempNamespace);
3763 /* If it ought to be the creation namespace, set flag */
3765 temp_missing = true;
3770 /* normal namespace reference */
3771 namespaceId = get_namespace_oid(curname, true);
3772 if (OidIsValid(namespaceId) &&
3773 !list_member_oid(oidlist, namespaceId) &&
3774 pg_namespace_aclcheck(namespaceId, roleid,
3775 ACL_USAGE) == ACLCHECK_OK &&
3776 InvokeNamespaceSearchHook(namespaceId, false))
3777 oidlist = lappend_oid(oidlist, namespaceId);
3782 * Remember the first member of the explicit list. (Note: this is
3783 * nominally wrong if temp_missing, but we need it anyway to distinguish
3784 * explicit from implicit mention of pg_catalog.)
3787 firstNS = InvalidOid;
3789 firstNS = linitial_oid(oidlist);
3792 * Add any implicitly-searched namespaces to the list. Note these go on
3793 * the front, not the back; also notice that we do not check USAGE
3794 * permissions for these.
3796 if (!list_member_oid(oidlist, PG_CATALOG_NAMESPACE))
3797 oidlist = lcons_oid(PG_CATALOG_NAMESPACE, oidlist);
3799 if (OidIsValid(myTempNamespace) &&
3800 !list_member_oid(oidlist, myTempNamespace))
3801 oidlist = lcons_oid(myTempNamespace, oidlist);
3804 * Now that we've successfully built the new list of namespace OIDs, save
3805 * it in permanent storage.
3807 oldcxt = MemoryContextSwitchTo(TopMemoryContext);
3808 newpath = list_copy(oidlist);
3809 MemoryContextSwitchTo(oldcxt);
3811 /* Now safe to assign to state variables. */
3812 list_free(baseSearchPath);
3813 baseSearchPath = newpath;
3814 baseCreationNamespace = firstNS;
3815 baseTempCreationPending = temp_missing;
3817 /* Mark the path valid. */
3818 baseSearchPathValid = true;
3819 namespaceUser = roleid;
3821 /* And make it active. */
3822 activeSearchPath = baseSearchPath;
3823 activeCreationNamespace = baseCreationNamespace;
3824 activeTempCreationPending = baseTempCreationPending;
3828 list_free(namelist);
3833 * AccessTempTableNamespace
3834 * Provide access to a temporary namespace, potentially creating it
3835 * if not present yet. This routine registers if the namespace gets
3836 * in use in this transaction. 'force' can be set to true to allow
3837 * the caller to enforce the creation of the temporary namespace for
3838 * use in this backend, which happens if its creation is pending.
3841 AccessTempTableNamespace(bool force)
3844 * Make note that this temporary namespace has been accessed in this
3847 MyXactFlags |= XACT_FLAGS_ACCESSEDTEMPNAMESPACE;
3850 * If the caller attempting to access a temporary schema expects the
3851 * creation of the namespace to be pending and should be enforced, then go
3852 * through the creation.
3854 if (!force && OidIsValid(myTempNamespace))
3858 * The temporary tablespace does not exist yet and is wanted, so
3861 InitTempTableNamespace();
3865 * InitTempTableNamespace
3866 * Initialize temp table namespace on first use in a particular backend
3869 InitTempTableNamespace(void)
3871 char namespaceName[NAMEDATALEN];
3875 Assert(!OidIsValid(myTempNamespace));
3878 * First, do permission check to see if we are authorized to make temp
3879 * tables. We use a nonstandard error message here since "databasename:
3880 * permission denied" might be a tad cryptic.
3882 * Note that ACL_CREATE_TEMP rights are rechecked in pg_namespace_aclmask;
3883 * that's necessary since current user ID could change during the session.
3884 * But there's no need to make the namespace in the first place until a
3885 * temp table creation request is made by someone with appropriate rights.
3887 if (pg_database_aclcheck(MyDatabaseId, GetUserId(),
3888 ACL_CREATE_TEMP) != ACLCHECK_OK)
3890 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
3891 errmsg("permission denied to create temporary tables in database \"%s\"",
3892 get_database_name(MyDatabaseId))));
3895 * Do not allow a Hot Standby session to make temp tables. Aside from
3896 * problems with modifying the system catalogs, there is a naming
3897 * conflict: pg_temp_N belongs to the session with BackendId N on the
3898 * master, not to a hot standby session with the same BackendId. We
3899 * should not be able to get here anyway due to XactReadOnly checks, but
3900 * let's just make real sure. Note that this also backstops various
3901 * operations that allow XactReadOnly transactions to modify temp tables;
3902 * they'd need RecoveryInProgress checks if not for this.
3904 if (RecoveryInProgress())
3906 (errcode(ERRCODE_READ_ONLY_SQL_TRANSACTION),
3907 errmsg("cannot create temporary tables during recovery")));
3909 /* Parallel workers can't create temporary tables, either. */
3910 if (IsParallelWorker())
3912 (errcode(ERRCODE_READ_ONLY_SQL_TRANSACTION),
3913 errmsg("cannot create temporary tables during a parallel operation")));
3915 snprintf(namespaceName, sizeof(namespaceName), "pg_temp_%d", MyBackendId);
3917 namespaceId = get_namespace_oid(namespaceName, true);
3918 if (!OidIsValid(namespaceId))
3921 * First use of this temp namespace in this database; create it. The
3922 * temp namespaces are always owned by the superuser. We leave their
3923 * permissions at default --- i.e., no access except to superuser ---
3924 * to ensure that unprivileged users can't peek at other backends'
3925 * temp tables. This works because the places that access the temp
3926 * namespace for my own backend skip permissions checks on it.
3928 namespaceId = NamespaceCreate(namespaceName, BOOTSTRAP_SUPERUSERID,
3930 /* Advance command counter to make namespace visible */
3931 CommandCounterIncrement();
3936 * If the namespace already exists, clean it out (in case the former
3937 * owner crashed without doing so).
3939 RemoveTempRelations(namespaceId);
3943 * If the corresponding toast-table namespace doesn't exist yet, create
3944 * it. (We assume there is no need to clean it out if it does exist, since
3945 * dropping a parent table should make its toast table go away.)
3947 snprintf(namespaceName, sizeof(namespaceName), "pg_toast_temp_%d",
3950 toastspaceId = get_namespace_oid(namespaceName, true);
3951 if (!OidIsValid(toastspaceId))
3953 toastspaceId = NamespaceCreate(namespaceName, BOOTSTRAP_SUPERUSERID,
3955 /* Advance command counter to make namespace visible */
3956 CommandCounterIncrement();
3960 * Okay, we've prepared the temp namespace ... but it's not committed yet,
3961 * so all our work could be undone by transaction rollback. Set flag for
3962 * AtEOXact_Namespace to know what to do.
3964 myTempNamespace = namespaceId;
3965 myTempToastNamespace = toastspaceId;
3968 * Mark MyProc as owning this namespace which other processes can use to
3969 * decide if a temporary namespace is in use or not. We assume that
3970 * assignment of namespaceId is an atomic operation. Even if it is not,
3971 * the temporary relation which resulted in the creation of this temporary
3972 * namespace is still locked until the current transaction commits, and
3973 * its pg_namespace row is not visible yet. However it does not matter:
3974 * this flag makes the namespace as being in use, so no objects created on
3975 * it would be removed concurrently.
3977 MyProc->tempNamespaceId = namespaceId;
3979 /* It should not be done already. */
3980 AssertState(myTempNamespaceSubID == InvalidSubTransactionId);
3981 myTempNamespaceSubID = GetCurrentSubTransactionId();
3983 baseSearchPathValid = false; /* need to rebuild list */
3987 * End-of-transaction cleanup for namespaces.
3990 AtEOXact_Namespace(bool isCommit, bool parallel)
3993 * If we abort the transaction in which a temp namespace was selected,
3994 * we'll have to do any creation or cleanout work over again. So, just
3995 * forget the namespace entirely until next time. On the other hand, if
3996 * we commit then register an exit callback to clean out the temp tables
3997 * at backend shutdown. (We only want to register the callback once per
3998 * session, so this is a good place to do it.)
4000 if (myTempNamespaceSubID != InvalidSubTransactionId && !parallel)
4003 before_shmem_exit(RemoveTempRelationsCallback, 0);
4006 myTempNamespace = InvalidOid;
4007 myTempToastNamespace = InvalidOid;
4008 baseSearchPathValid = false; /* need to rebuild list */
4011 * Reset the temporary namespace flag in MyProc. We assume that
4012 * this operation is atomic.
4014 * Because this transaction is aborting, the pg_namespace row is
4015 * not visible to anyone else anyway, but that doesn't matter:
4016 * it's not a problem if objects contained in this namespace are
4017 * removed concurrently.
4019 MyProc->tempNamespaceId = InvalidOid;
4021 myTempNamespaceSubID = InvalidSubTransactionId;
4025 * Clean up if someone failed to do PopOverrideSearchPath
4030 elog(WARNING, "leaked override search path");
4031 while (overrideStack)
4033 OverrideStackEntry *entry;
4035 entry = (OverrideStackEntry *) linitial(overrideStack);
4036 overrideStack = list_delete_first(overrideStack);
4037 list_free(entry->searchPath);
4040 /* If not baseSearchPathValid, this is useless but harmless */
4041 activeSearchPath = baseSearchPath;
4042 activeCreationNamespace = baseCreationNamespace;
4043 activeTempCreationPending = baseTempCreationPending;
4048 * AtEOSubXact_Namespace
4050 * At subtransaction commit, propagate the temp-namespace-creation
4051 * flag to the parent subtransaction.
4053 * At subtransaction abort, forget the flag if we set it up.
4056 AtEOSubXact_Namespace(bool isCommit, SubTransactionId mySubid,
4057 SubTransactionId parentSubid)
4059 OverrideStackEntry *entry;
4061 if (myTempNamespaceSubID == mySubid)
4064 myTempNamespaceSubID = parentSubid;
4067 myTempNamespaceSubID = InvalidSubTransactionId;
4068 /* TEMP namespace creation failed, so reset state */
4069 myTempNamespace = InvalidOid;
4070 myTempToastNamespace = InvalidOid;
4071 baseSearchPathValid = false; /* need to rebuild list */
4074 * Reset the temporary namespace flag in MyProc. We assume that
4075 * this operation is atomic.
4077 * Because this subtransaction is aborting, the pg_namespace row
4078 * is not visible to anyone else anyway, but that doesn't matter:
4079 * it's not a problem if objects contained in this namespace are
4080 * removed concurrently.
4082 MyProc->tempNamespaceId = InvalidOid;
4087 * Clean up if someone failed to do PopOverrideSearchPath
4089 while (overrideStack)
4091 entry = (OverrideStackEntry *) linitial(overrideStack);
4092 if (entry->nestLevel < GetCurrentTransactionNestLevel())
4095 elog(WARNING, "leaked override search path");
4096 overrideStack = list_delete_first(overrideStack);
4097 list_free(entry->searchPath);
4101 /* Activate the next level down. */
4104 entry = (OverrideStackEntry *) linitial(overrideStack);
4105 activeSearchPath = entry->searchPath;
4106 activeCreationNamespace = entry->creationNamespace;
4107 activeTempCreationPending = false; /* XXX is this OK? */
4111 /* If not baseSearchPathValid, this is useless but harmless */
4112 activeSearchPath = baseSearchPath;
4113 activeCreationNamespace = baseCreationNamespace;
4114 activeTempCreationPending = baseTempCreationPending;
4119 * Remove all relations in the specified temp namespace.
4121 * This is called at backend shutdown (if we made any temp relations).
4122 * It is also called when we begin using a pre-existing temp namespace,
4123 * in order to clean out any relations that might have been created by
4124 * a crashed backend.
4127 RemoveTempRelations(Oid tempNamespaceId)
4129 ObjectAddress object;
4132 * We want to get rid of everything in the target namespace, but not the
4133 * namespace itself (deleting it only to recreate it later would be a
4134 * waste of cycles). Hence, specify SKIP_ORIGINAL. It's also an INTERNAL
4135 * deletion, and we want to not drop any extensions that might happen to
4138 object.classId = NamespaceRelationId;
4139 object.objectId = tempNamespaceId;
4140 object.objectSubId = 0;
4142 performDeletion(&object, DROP_CASCADE,
4143 PERFORM_DELETION_INTERNAL |
4144 PERFORM_DELETION_QUIETLY |
4145 PERFORM_DELETION_SKIP_ORIGINAL |
4146 PERFORM_DELETION_SKIP_EXTENSIONS);
4150 * Callback to remove temp relations at backend exit.
4153 RemoveTempRelationsCallback(int code, Datum arg)
4155 if (OidIsValid(myTempNamespace)) /* should always be true */
4157 /* Need to ensure we have a usable transaction. */
4158 AbortOutOfAnyTransaction();
4159 StartTransactionCommand();
4161 RemoveTempRelations(myTempNamespace);
4163 CommitTransactionCommand();
4168 * Remove all temp tables from the temporary namespace.
4171 ResetTempTableNamespace(void)
4173 if (OidIsValid(myTempNamespace))
4174 RemoveTempRelations(myTempNamespace);
4179 * Routines for handling the GUC variable 'search_path'.
4182 /* check_hook: validate new search_path value */
4184 check_search_path(char **newval, void **extra, GucSource source)
4189 /* Need a modifiable copy of string */
4190 rawname = pstrdup(*newval);
4192 /* Parse string into list of identifiers */
4193 if (!SplitIdentifierString(rawname, ',', &namelist))
4195 /* syntax error in name list */
4196 GUC_check_errdetail("List syntax is invalid.");
4198 list_free(namelist);
4203 * We used to try to check that the named schemas exist, but there are
4204 * many valid use-cases for having search_path settings that include
4205 * schemas that don't exist; and often, we are not inside a transaction
4206 * here and so can't consult the system catalogs anyway. So now, the only
4207 * requirement is syntactic validity of the identifier list.
4211 list_free(namelist);
4216 /* assign_hook: do extra actions as needed */
4218 assign_search_path(const char *newval, void *extra)
4221 * We mark the path as needing recomputation, but don't do anything until
4222 * it's needed. This avoids trying to do database access during GUC
4223 * initialization, or outside a transaction.
4225 baseSearchPathValid = false;
4229 * InitializeSearchPath: initialize module during InitPostgres.
4231 * This is called after we are up enough to be able to do catalog lookups.
4234 InitializeSearchPath(void)
4236 if (IsBootstrapProcessingMode())
4239 * In bootstrap mode, the search path must be 'pg_catalog' so that
4240 * tables are created in the proper namespace; ignore the GUC setting.
4242 MemoryContext oldcxt;
4244 oldcxt = MemoryContextSwitchTo(TopMemoryContext);
4245 baseSearchPath = list_make1_oid(PG_CATALOG_NAMESPACE);
4246 MemoryContextSwitchTo(oldcxt);
4247 baseCreationNamespace = PG_CATALOG_NAMESPACE;
4248 baseTempCreationPending = false;
4249 baseSearchPathValid = true;
4250 namespaceUser = GetUserId();
4251 activeSearchPath = baseSearchPath;
4252 activeCreationNamespace = baseCreationNamespace;
4253 activeTempCreationPending = baseTempCreationPending;
4258 * In normal mode, arrange for a callback on any syscache invalidation
4259 * of pg_namespace rows.
4261 CacheRegisterSyscacheCallback(NAMESPACEOID,
4264 /* Force search path to be recomputed on next use */
4265 baseSearchPathValid = false;
4271 * Syscache inval callback function
4274 NamespaceCallback(Datum arg, int cacheid, uint32 hashvalue)
4276 /* Force search path to be recomputed on next use */
4277 baseSearchPathValid = false;
4281 * Fetch the active search path. The return value is a palloc'ed list
4282 * of OIDs; the caller is responsible for freeing this storage as
4285 * The returned list includes the implicitly-prepended namespaces only if
4286 * includeImplicit is true.
4288 * Note: calling this may result in a CommandCounterIncrement operation,
4289 * if we have to create or clean out the temp namespace.
4292 fetch_search_path(bool includeImplicit)
4296 recomputeNamespacePath();
4299 * If the temp namespace should be first, force it to exist. This is so
4300 * that callers can trust the result to reflect the actual default
4301 * creation namespace. It's a bit bogus to do this here, since
4302 * current_schema() is supposedly a stable function without side-effects,
4303 * but the alternatives seem worse.
4305 if (activeTempCreationPending)
4307 AccessTempTableNamespace(true);
4308 recomputeNamespacePath();
4311 result = list_copy(activeSearchPath);
4312 if (!includeImplicit)
4314 while (result && linitial_oid(result) != activeCreationNamespace)
4315 result = list_delete_first(result);
4322 * Fetch the active search path into a caller-allocated array of OIDs.
4323 * Returns the number of path entries. (If this is more than sarray_len,
4324 * then the data didn't fit and is not all stored.)
4326 * The returned list always includes the implicitly-prepended namespaces,
4327 * but never includes the temp namespace. (This is suitable for existing
4328 * users, which would want to ignore the temp namespace anyway.) This
4329 * definition allows us to not worry about initializing the temp namespace.
4332 fetch_search_path_array(Oid *sarray, int sarray_len)
4337 recomputeNamespacePath();
4339 foreach(l, activeSearchPath)
4341 Oid namespaceId = lfirst_oid(l);
4343 if (namespaceId == myTempNamespace)
4344 continue; /* do not include temp namespace */
4346 if (count < sarray_len)
4347 sarray[count] = namespaceId;
4356 * Export the FooIsVisible functions as SQL-callable functions.
4358 * Note: as of Postgres 8.4, these will silently return NULL if called on
4359 * a nonexistent object OID, rather than failing. This is to avoid race
4360 * condition errors when a query that's scanning a catalog using an MVCC
4361 * snapshot uses one of these functions. The underlying IsVisible functions
4362 * always use an up-to-date snapshot and so might see the object as already
4363 * gone when it's still visible to the transaction snapshot. (There is no race
4364 * condition in the current coding because we don't accept sinval messages
4365 * between the SearchSysCacheExists test and the subsequent lookup.)
4369 pg_table_is_visible(PG_FUNCTION_ARGS)
4371 Oid oid = PG_GETARG_OID(0);
4373 if (!SearchSysCacheExists1(RELOID, ObjectIdGetDatum(oid)))
4376 PG_RETURN_BOOL(RelationIsVisible(oid));
4380 pg_type_is_visible(PG_FUNCTION_ARGS)
4382 Oid oid = PG_GETARG_OID(0);
4384 if (!SearchSysCacheExists1(TYPEOID, ObjectIdGetDatum(oid)))
4387 PG_RETURN_BOOL(TypeIsVisible(oid));
4391 pg_function_is_visible(PG_FUNCTION_ARGS)
4393 Oid oid = PG_GETARG_OID(0);
4395 if (!SearchSysCacheExists1(PROCOID, ObjectIdGetDatum(oid)))
4398 PG_RETURN_BOOL(FunctionIsVisible(oid));
4402 pg_operator_is_visible(PG_FUNCTION_ARGS)
4404 Oid oid = PG_GETARG_OID(0);
4406 if (!SearchSysCacheExists1(OPEROID, ObjectIdGetDatum(oid)))
4409 PG_RETURN_BOOL(OperatorIsVisible(oid));
4413 pg_opclass_is_visible(PG_FUNCTION_ARGS)
4415 Oid oid = PG_GETARG_OID(0);
4417 if (!SearchSysCacheExists1(CLAOID, ObjectIdGetDatum(oid)))
4420 PG_RETURN_BOOL(OpclassIsVisible(oid));
4424 pg_opfamily_is_visible(PG_FUNCTION_ARGS)
4426 Oid oid = PG_GETARG_OID(0);
4428 if (!SearchSysCacheExists1(OPFAMILYOID, ObjectIdGetDatum(oid)))
4431 PG_RETURN_BOOL(OpfamilyIsVisible(oid));
4435 pg_collation_is_visible(PG_FUNCTION_ARGS)
4437 Oid oid = PG_GETARG_OID(0);
4439 if (!SearchSysCacheExists1(COLLOID, ObjectIdGetDatum(oid)))
4442 PG_RETURN_BOOL(CollationIsVisible(oid));
4446 pg_conversion_is_visible(PG_FUNCTION_ARGS)
4448 Oid oid = PG_GETARG_OID(0);
4450 if (!SearchSysCacheExists1(CONVOID, ObjectIdGetDatum(oid)))
4453 PG_RETURN_BOOL(ConversionIsVisible(oid));
4457 pg_statistics_obj_is_visible(PG_FUNCTION_ARGS)
4459 Oid oid = PG_GETARG_OID(0);
4461 if (!SearchSysCacheExists1(STATEXTOID, ObjectIdGetDatum(oid)))
4464 PG_RETURN_BOOL(StatisticsObjIsVisible(oid));
4468 pg_ts_parser_is_visible(PG_FUNCTION_ARGS)
4470 Oid oid = PG_GETARG_OID(0);
4472 if (!SearchSysCacheExists1(TSPARSEROID, ObjectIdGetDatum(oid)))
4475 PG_RETURN_BOOL(TSParserIsVisible(oid));
4479 pg_ts_dict_is_visible(PG_FUNCTION_ARGS)
4481 Oid oid = PG_GETARG_OID(0);
4483 if (!SearchSysCacheExists1(TSDICTOID, ObjectIdGetDatum(oid)))
4486 PG_RETURN_BOOL(TSDictionaryIsVisible(oid));
4490 pg_ts_template_is_visible(PG_FUNCTION_ARGS)
4492 Oid oid = PG_GETARG_OID(0);
4494 if (!SearchSysCacheExists1(TSTEMPLATEOID, ObjectIdGetDatum(oid)))
4497 PG_RETURN_BOOL(TSTemplateIsVisible(oid));
4501 pg_ts_config_is_visible(PG_FUNCTION_ARGS)
4503 Oid oid = PG_GETARG_OID(0);
4505 if (!SearchSysCacheExists1(TSCONFIGOID, ObjectIdGetDatum(oid)))
4508 PG_RETURN_BOOL(TSConfigIsVisible(oid));
4512 pg_my_temp_schema(PG_FUNCTION_ARGS)
4514 PG_RETURN_OID(myTempNamespace);
4518 pg_is_other_temp_schema(PG_FUNCTION_ARGS)
4520 Oid oid = PG_GETARG_OID(0);
4522 PG_RETURN_BOOL(isOtherTempNamespace(oid));