1 /*-------------------------------------------------------------------------
4 * POSTGRES define and remove index code.
6 * Portions Copyright (c) 1996-2002, PostgreSQL Global Development Group
7 * Portions Copyright (c) 1994, Regents of the University of California
11 * $Header: /cvsroot/pgsql/src/backend/commands/indexcmds.c,v 1.94 2002/12/13 19:45:50 tgl Exp $
13 *-------------------------------------------------------------------------
18 #include "access/heapam.h"
19 #include "catalog/catalog.h"
20 #include "catalog/catname.h"
21 #include "catalog/dependency.h"
22 #include "catalog/index.h"
23 #include "catalog/namespace.h"
24 #include "catalog/pg_opclass.h"
25 #include "catalog/pg_proc.h"
26 #include "commands/defrem.h"
27 #include "executor/executor.h"
28 #include "miscadmin.h"
29 #include "optimizer/clauses.h"
30 #include "optimizer/planmain.h"
31 #include "optimizer/prep.h"
32 #include "parser/parsetree.h"
33 #include "parser/parse_coerce.h"
34 #include "parser/parse_func.h"
35 #include "utils/acl.h"
36 #include "utils/builtins.h"
37 #include "utils/lsyscache.h"
38 #include "utils/syscache.h"
41 #define IsFuncIndex(ATTR_LIST) (((IndexElem*)lfirst(ATTR_LIST))->funcname != NIL)
43 /* non-export function prototypes */
44 static void CheckPredicate(List *predList, List *rangeTable, Oid baseRelOid);
45 static void FuncIndexArgs(IndexInfo *indexInfo, Oid *classOidP,
48 char *accessMethodName, Oid accessMethodId);
49 static void NormIndexAttrs(IndexInfo *indexInfo, Oid *classOidP,
52 char *accessMethodName, Oid accessMethodId);
53 static Oid GetAttrOpClass(IndexElem *attribute, Oid attrType,
54 char *accessMethodName, Oid accessMethodId);
55 static Oid GetDefaultOpClass(Oid attrType, Oid accessMethodId);
59 * Creates a new index.
61 * 'attributeList' is a list of IndexElem specifying either a functional
62 * index or a list of attributes to index on.
63 * 'predicate' is the qual specified in the where clause.
64 * 'rangetable' is needed to interpret the predicate.
67 DefineIndex(RangeVar *heapRelation,
68 char *indexRelationName,
69 char *accessMethodName,
83 Form_pg_am accessMethodForm;
85 int numberOfAttributes;
89 * count attributes in index
91 numberOfAttributes = length(attributeList);
92 if (numberOfAttributes <= 0)
93 elog(ERROR, "DefineIndex: must specify at least one attribute");
94 if (numberOfAttributes > INDEX_MAX_KEYS)
95 elog(ERROR, "Cannot use more than %d attributes in an index",
99 * Open heap relation, acquire a suitable lock on it, remember its OID
101 rel = heap_openrv(heapRelation, ShareLock);
103 /* Note: during bootstrap may see uncataloged relation */
104 if (rel->rd_rel->relkind != RELKIND_RELATION &&
105 rel->rd_rel->relkind != RELKIND_UNCATALOGED)
106 elog(ERROR, "DefineIndex: relation \"%s\" is not a table",
107 heapRelation->relname);
109 relationId = RelationGetRelid(rel);
110 namespaceId = RelationGetNamespace(rel);
112 if (!IsBootstrapProcessingMode() &&
113 IsSystemRelation(rel) &&
114 !IndexesAreActive(rel))
115 elog(ERROR, "Existing indexes are inactive. REINDEX first");
117 heap_close(rel, NoLock);
120 * Verify we (still) have CREATE rights in the rel's namespace.
121 * (Presumably we did when the rel was created, but maybe not
122 * anymore.) Skip check if bootstrapping, since permissions machinery
123 * may not be working yet.
125 if (!IsBootstrapProcessingMode())
129 aclresult = pg_namespace_aclcheck(namespaceId, GetUserId(),
131 if (aclresult != ACLCHECK_OK)
132 aclcheck_error(aclresult, get_namespace_name(namespaceId));
136 * look up the access method, verify it can handle the requested
139 tuple = SearchSysCache(AMNAME,
140 PointerGetDatum(accessMethodName),
142 if (!HeapTupleIsValid(tuple))
143 elog(ERROR, "DefineIndex: access method \"%s\" not found",
145 accessMethodId = HeapTupleGetOid(tuple);
146 accessMethodForm = (Form_pg_am) GETSTRUCT(tuple);
148 if (unique && !accessMethodForm->amcanunique)
149 elog(ERROR, "DefineIndex: access method \"%s\" does not support UNIQUE indexes",
151 if (numberOfAttributes > 1 && !accessMethodForm->amcanmulticol)
152 elog(ERROR, "DefineIndex: access method \"%s\" does not support multi-column indexes",
155 ReleaseSysCache(tuple);
158 * Convert the partial-index predicate from parsetree form to an
159 * implicit-AND qual expression, for easier evaluation at runtime.
160 * While we are at it, we reduce it to a canonical (CNF or DNF) form
161 * to simplify the task of proving implications.
165 cnfPred = canonicalize_qual((Expr *) copyObject(predicate), true);
166 fix_opfuncids((Node *) cnfPred);
167 CheckPredicate(cnfPred, rangetable, relationId);
171 * Prepare arguments for index_create, primarily an IndexInfo
174 indexInfo = makeNode(IndexInfo);
175 indexInfo->ii_Predicate = cnfPred;
176 indexInfo->ii_PredicateState = (List *)
177 ExecInitExpr((Expr *) cnfPred, NULL);
178 indexInfo->ii_FuncOid = InvalidOid;
179 indexInfo->ii_Unique = unique;
181 if (IsFuncIndex(attributeList))
183 IndexElem *funcIndex = (IndexElem *) lfirst(attributeList);
186 /* Parser should have given us only one list item, but check */
187 if (numberOfAttributes != 1)
188 elog(ERROR, "Functional index can only have one attribute");
190 nargs = length(funcIndex->args);
191 if (nargs > INDEX_MAX_KEYS)
192 elog(ERROR, "Index function can take at most %d arguments",
195 indexInfo->ii_NumIndexAttrs = 1;
196 indexInfo->ii_NumKeyAttrs = nargs;
198 classObjectId = (Oid *) palloc(sizeof(Oid));
200 FuncIndexArgs(indexInfo, classObjectId, funcIndex,
201 relationId, accessMethodName, accessMethodId);
205 indexInfo->ii_NumIndexAttrs = numberOfAttributes;
206 indexInfo->ii_NumKeyAttrs = numberOfAttributes;
208 classObjectId = (Oid *) palloc(numberOfAttributes * sizeof(Oid));
210 NormIndexAttrs(indexInfo, classObjectId, attributeList,
211 relationId, accessMethodName, accessMethodId);
214 index_create(relationId, indexRelationName,
215 indexInfo, accessMethodId, classObjectId,
216 primary, isconstraint, allowSystemTableMods);
219 * We update the relation's pg_class tuple even if it already has
220 * relhasindex = true. This is needed to cause a shared-cache-inval
221 * message to be sent for the pg_class tuple, which will cause other
222 * backends to flush their relcache entries and in particular their
223 * cached lists of the indexes for this relation.
225 setRelhasindex(relationId, true, primary, InvalidOid);
231 * Checks that the given list of partial-index predicates refer
232 * (via the given range table) only to the given base relation oid.
234 * This used to also constrain the form of the predicate to forms that
235 * indxpath.c could do something with. However, that seems overly
236 * restrictive. One useful application of partial indexes is to apply
237 * a UNIQUE constraint across a subset of a table, and in that scenario
238 * any evaluatable predicate will work. So accept any predicate here
239 * (except ones requiring a plan), and let indxpath.c fend for itself.
243 CheckPredicate(List *predList, List *rangeTable, Oid baseRelOid)
245 if (length(rangeTable) != 1 || getrelid(1, rangeTable) != baseRelOid)
247 "Partial-index predicates may refer only to the base relation");
250 * We don't currently support generation of an actual query plan for a
251 * predicate, only simple scalar expressions; hence these
254 if (contain_subplans((Node *) predList))
255 elog(ERROR, "Cannot use subselect in index predicate");
256 if (contain_agg_clause((Node *) predList))
257 elog(ERROR, "Cannot use aggregate in index predicate");
260 * A predicate using mutable functions is probably wrong, for the same
261 * reasons that we don't allow a functional index to use one.
263 if (contain_mutable_functions((Node *) predList))
264 elog(ERROR, "Functions in index predicate must be marked isImmutable");
269 FuncIndexArgs(IndexInfo *indexInfo,
271 IndexElem *funcIndex,
273 char *accessMethodName,
276 Oid argTypes[FUNC_MAX_ARGS];
280 FuncDetailCode fdresult;
287 * process the function arguments, which are a list of T_String
288 * (someday ought to allow more general expressions?)
290 * Note caller already checked that list is not too long.
292 MemSet(argTypes, 0, sizeof(argTypes));
294 foreach(arglist, funcIndex->args)
296 char *arg = strVal(lfirst(arglist));
298 Form_pg_attribute att;
300 tuple = SearchSysCacheAttName(relId, arg);
301 if (!HeapTupleIsValid(tuple))
302 elog(ERROR, "DefineIndex: attribute \"%s\" not found", arg);
303 att = (Form_pg_attribute) GETSTRUCT(tuple);
304 indexInfo->ii_KeyAttrNumbers[nargs] = att->attnum;
305 argTypes[nargs] = att->atttypid;
306 ReleaseSysCache(tuple);
311 * Lookup the function procedure to get its OID and result type.
313 * We rely on parse_func.c to find the correct function in the possible
314 * presence of binary-compatible types. However, parse_func may do
315 * too much: it will accept a function that requires run-time coercion
316 * of input types, and the executor is not currently set up to support
317 * that. So, check to make sure that the selected function has
318 * exact-match or binary-compatible input types.
320 fdresult = func_get_detail(funcIndex->funcname, funcIndex->args,
322 &funcid, &rettype, &retset,
324 if (fdresult != FUNCDETAIL_NORMAL)
326 if (fdresult == FUNCDETAIL_AGGREGATE)
327 elog(ERROR, "DefineIndex: functional index may not use an aggregate function");
328 else if (fdresult == FUNCDETAIL_COERCION)
329 elog(ERROR, "DefineIndex: functional index must use a real function, not a type coercion"
330 "\n\tTry specifying the index opclass you want to use, instead");
332 func_error("DefineIndex", funcIndex->funcname, nargs, argTypes,
337 elog(ERROR, "DefineIndex: cannot index on a function returning a set");
339 for (i = 0; i < nargs; i++)
341 if (!IsBinaryCoercible(argTypes[i], true_typeids[i]))
342 func_error("DefineIndex", funcIndex->funcname, nargs, true_typeids,
343 "Index function must be binary-compatible with table datatype");
347 * Require that the function be marked immutable. Using a mutable
348 * function for a functional index is highly questionable, since if
349 * you aren't going to get the same result for the same data every
350 * time, it's not clear what the index entries mean at all.
352 if (func_volatile(funcid) != PROVOLATILE_IMMUTABLE)
353 elog(ERROR, "DefineIndex: index function must be marked isImmutable");
355 /* Process opclass, using func return type as default type */
357 classOidP[0] = GetAttrOpClass(funcIndex, rettype,
358 accessMethodName, accessMethodId);
360 /* OK, return results */
362 indexInfo->ii_FuncOid = funcid;
363 /* Need to do the fmgr function lookup now, too */
364 fmgr_info(funcid, &indexInfo->ii_FuncInfo);
368 NormIndexAttrs(IndexInfo *indexInfo,
370 List *attList, /* list of IndexElem's */
372 char *accessMethodName,
379 * process attributeList
381 foreach(rest, attList)
383 IndexElem *attribute = (IndexElem *) lfirst(rest);
385 Form_pg_attribute attform;
387 if (attribute->name == NULL)
388 elog(ERROR, "missing attribute for define index");
390 atttuple = SearchSysCacheAttName(relId, attribute->name);
391 if (!HeapTupleIsValid(atttuple))
392 elog(ERROR, "DefineIndex: attribute \"%s\" not found",
394 attform = (Form_pg_attribute) GETSTRUCT(atttuple);
396 indexInfo->ii_KeyAttrNumbers[attn] = attform->attnum;
398 classOidP[attn] = GetAttrOpClass(attribute, attform->atttypid,
399 accessMethodName, accessMethodId);
401 ReleaseSysCache(atttuple);
407 GetAttrOpClass(IndexElem *attribute, Oid attrType,
408 char *accessMethodName, Oid accessMethodId)
416 if (attribute->opclass == NIL)
418 /* no operator class specified, so find the default */
419 opClassId = GetDefaultOpClass(attrType, accessMethodId);
420 if (!OidIsValid(opClassId))
421 elog(ERROR, "data type %s has no default operator class for access method \"%s\""
422 "\n\tYou must specify an operator class for the index or define a"
423 "\n\tdefault operator class for the data type",
424 format_type_be(attrType), accessMethodName);
429 * Specific opclass name given, so look up the opclass.
432 /* deconstruct the name list */
433 DeconstructQualifiedName(attribute->opclass, &schemaname, &opcname);
437 /* Look in specific schema only */
440 namespaceId = LookupExplicitNamespace(schemaname);
441 tuple = SearchSysCache(CLAAMNAMENSP,
442 ObjectIdGetDatum(accessMethodId),
443 PointerGetDatum(opcname),
444 ObjectIdGetDatum(namespaceId),
449 /* Unqualified opclass name, so search the search path */
450 opClassId = OpclassnameGetOpcid(accessMethodId, opcname);
451 if (!OidIsValid(opClassId))
452 elog(ERROR, "DefineIndex: operator class \"%s\" not supported by access method \"%s\"",
453 opcname, accessMethodName);
454 tuple = SearchSysCache(CLAOID,
455 ObjectIdGetDatum(opClassId),
459 if (!HeapTupleIsValid(tuple))
460 elog(ERROR, "DefineIndex: operator class \"%s\" not supported by access method \"%s\"",
461 NameListToString(attribute->opclass), accessMethodName);
464 * Verify that the index operator class accepts this datatype. Note
465 * we will accept binary compatibility.
467 opClassId = HeapTupleGetOid(tuple);
468 opInputType = ((Form_pg_opclass) GETSTRUCT(tuple))->opcintype;
470 if (!IsBinaryCoercible(attrType, opInputType))
471 elog(ERROR, "operator class \"%s\" does not accept data type %s",
472 NameListToString(attribute->opclass), format_type_be(attrType));
474 ReleaseSysCache(tuple);
480 GetDefaultOpClass(Oid attrType, Oid accessMethodId)
482 OpclassCandidateList opclass;
485 Oid exactOid = InvalidOid;
486 Oid compatibleOid = InvalidOid;
488 /* If it's a domain, look at the base type instead */
489 attrType = getBaseType(attrType);
492 * We scan through all the opclasses available for the access method,
493 * looking for one that is marked default and matches the target type
494 * (either exactly or binary-compatibly, but prefer an exact match).
496 * We could find more than one binary-compatible match, in which case we
497 * require the user to specify which one he wants. If we find more
498 * than one exact match, then someone put bogus entries in pg_opclass.
500 * The initial search is done by namespace.c so that we only consider
501 * opclasses visible in the current namespace search path.
503 for (opclass = OpclassGetCandidates(accessMethodId);
505 opclass = opclass->next)
507 if (opclass->opcdefault)
509 if (opclass->opcintype == attrType)
512 exactOid = opclass->oid;
514 else if (IsBinaryCoercible(attrType, opclass->opcintype))
517 compatibleOid = opclass->oid;
525 elog(ERROR, "pg_opclass contains multiple default opclasses for data type %s",
526 format_type_be(attrType));
527 if (ncompatible == 1)
528 return compatibleOid;
538 RemoveIndex(RangeVar *relation, DropBehavior behavior)
542 ObjectAddress object;
544 indOid = RangeVarGetRelid(relation, false);
545 relkind = get_rel_relkind(indOid);
546 if (relkind != RELKIND_INDEX)
547 elog(ERROR, "relation \"%s\" is of type \"%c\"",
548 relation->relname, relkind);
550 object.classId = RelOid_pg_class;
551 object.objectId = indOid;
552 object.objectSubId = 0;
554 performDeletion(&object, behavior);
562 ReindexIndex(RangeVar *indexRelation, bool force /* currently unused */ )
568 /* Choose in-place-or-not mode */
569 overwrite = IsIgnoringSystemIndexes();
571 indOid = RangeVarGetRelid(indexRelation, false);
572 tuple = SearchSysCache(RELOID,
573 ObjectIdGetDatum(indOid),
575 if (!HeapTupleIsValid(tuple))
576 elog(ERROR, "index \"%s\" does not exist", indexRelation->relname);
578 if (((Form_pg_class) GETSTRUCT(tuple))->relkind != RELKIND_INDEX)
579 elog(ERROR, "relation \"%s\" is of type \"%c\"",
580 indexRelation->relname,
581 ((Form_pg_class) GETSTRUCT(tuple))->relkind);
583 if (IsSystemClass((Form_pg_class) GETSTRUCT(tuple)) &&
584 !IsToastClass((Form_pg_class) GETSTRUCT(tuple)))
586 if (!allowSystemTableMods)
587 elog(ERROR, "\"%s\" is a system index. call REINDEX under standalone postgres with -O -P options",
588 indexRelation->relname);
589 if (!IsIgnoringSystemIndexes())
590 elog(ERROR, "\"%s\" is a system index. call REINDEX under standalone postgres with -P -O options",
591 indexRelation->relname);
594 ReleaseSysCache(tuple);
597 * In-place REINDEX within a transaction block is dangerous, because
598 * if the transaction is later rolled back we have no way to undo
599 * truncation of the index's physical file. Disallow it.
602 PreventTransactionChain((void *) indexRelation, "REINDEX");
604 if (!reindex_index(indOid, force, overwrite))
605 elog(WARNING, "index \"%s\" wasn't reindexed", indexRelation->relname);
610 * Recreate indexes of a table.
613 ReindexTable(RangeVar *relation, bool force)
618 heapOid = RangeVarGetRelid(relation, false);
619 relkind = get_rel_relkind(heapOid);
621 if (relkind != RELKIND_RELATION && relkind != RELKIND_TOASTVALUE)
622 elog(ERROR, "relation \"%s\" is of type \"%c\"",
623 relation->relname, relkind);
626 * In-place REINDEX within a transaction block is dangerous, because
627 * if the transaction is later rolled back we have no way to undo
628 * truncation of the index's physical file. Disallow it.
630 * XXX we assume that in-place reindex will only be done if
631 * IsIgnoringSystemIndexes() is true.
633 if (IsIgnoringSystemIndexes())
634 PreventTransactionChain((void *) relation, "REINDEX");
636 if (!reindex_relation(heapOid, force))
637 elog(WARNING, "table \"%s\" wasn't reindexed", relation->relname);
642 * Recreate indexes of a database.
645 ReindexDatabase(const char *dbname, bool force, bool all)
647 Relation relationRelation;
650 MemoryContext private_context;
656 Oid *relids = (Oid *) NULL;
660 if (strcmp(dbname, DatabaseName) != 0)
661 elog(ERROR, "REINDEX DATABASE: Can be executed only on the currently open database.");
663 if (!(superuser() || is_dbadmin(MyDatabaseId)))
664 elog(ERROR, "REINDEX DATABASE: Permission denied.");
666 if (!allowSystemTableMods)
667 elog(ERROR, "must be called under standalone postgres with -O -P options");
668 if (!IsIgnoringSystemIndexes())
669 elog(ERROR, "must be called under standalone postgres with -P -O options");
672 * We cannot run inside a user transaction block; if we were inside a
673 * transaction, then our commit- and start-transaction-command calls
674 * would not have the intended effect!
676 PreventTransactionChain((void *) dbname, "REINDEX");
679 * Create a memory context that will survive forced transaction
680 * commits we do below. Since it is a child of QueryContext, it will
681 * go away eventually even if we suffer an error; there's no need for
682 * special abort cleanup logic.
684 private_context = AllocSetContextCreate(QueryContext,
686 ALLOCSET_DEFAULT_MINSIZE,
687 ALLOCSET_DEFAULT_INITSIZE,
688 ALLOCSET_DEFAULT_MAXSIZE);
691 * Scan pg_class to build a list of the relations we need to reindex.
693 relationRelation = heap_openr(RelationRelationName, AccessShareLock);
694 scan = heap_beginscan(relationRelation, SnapshotNow, 0, NULL);
696 while ((tuple = heap_getnext(scan, ForwardScanDirection)) != NULL)
702 if (!(IsSystemClass((Form_pg_class) GETSTRUCT(tuple)) &&
703 !IsToastClass((Form_pg_class) GETSTRUCT(tuple))))
706 relkind = ((Form_pg_class) GETSTRUCT(tuple))->relkind;
707 if (relkind == RELKIND_RELATION || relkind == RELKIND_TOASTVALUE)
709 old = MemoryContextSwitchTo(private_context);
713 relids = palloc(sizeof(Oid) * relalc);
715 else if (relcnt >= relalc)
718 relids = repalloc(relids, sizeof(Oid) * relalc);
720 MemoryContextSwitchTo(old);
721 relids[relcnt] = HeapTupleGetOid(tuple);
726 heap_close(relationRelation, AccessShareLock);
728 /* Now reindex each rel in a separate transaction */
729 CommitTransactionCommand(true);
730 for (i = 0; i < relcnt; i++)
732 StartTransactionCommand(true);
733 SetQuerySnapshot(); /* might be needed for functional index */
734 if (reindex_relation(relids[i], force))
735 elog(NOTICE, "relation %u was reindexed", relids[i]);
736 CommitTransactionCommand(true);
738 /* Tell xact.c not to chain the upcoming commit */
739 StartTransactionCommand(true);
741 MemoryContextDelete(private_context);