PostgreSQL Source Code  git master
indexcmds.c File Reference
#include "postgres.h"
#include "access/amapi.h"
#include "access/htup_details.h"
#include "access/reloptions.h"
#include "access/sysattr.h"
#include "access/xact.h"
#include "catalog/catalog.h"
#include "catalog/index.h"
#include "catalog/indexing.h"
#include "catalog/pg_am.h"
#include "catalog/pg_opclass.h"
#include "catalog/pg_opfamily.h"
#include "catalog/pg_tablespace.h"
#include "catalog/pg_type.h"
#include "commands/comment.h"
#include "commands/dbcommands.h"
#include "commands/defrem.h"
#include "commands/tablecmds.h"
#include "commands/tablespace.h"
#include "mb/pg_wchar.h"
#include "miscadmin.h"
#include "nodes/nodeFuncs.h"
#include "optimizer/clauses.h"
#include "optimizer/planner.h"
#include "optimizer/var.h"
#include "parser/parse_coerce.h"
#include "parser/parse_func.h"
#include "parser/parse_oper.h"
#include "storage/lmgr.h"
#include "storage/proc.h"
#include "storage/procarray.h"
#include "utils/acl.h"
#include "utils/builtins.h"
#include "utils/fmgroids.h"
#include "utils/inval.h"
#include "utils/lsyscache.h"
#include "utils/memutils.h"
#include "utils/regproc.h"
#include "utils/snapmgr.h"
#include "utils/syscache.h"
#include "utils/tqual.h"
Include dependency graph for indexcmds.c:

Go to the source code of this file.

Functions

static void CheckPredicate (Expr *predicate)
 
static void ComputeIndexAttrs (IndexInfo *indexInfo, Oid *typeOidP, Oid *collationOidP, Oid *classOidP, int16 *colOptionP, List *attList, List *exclusionOpNames, Oid relId, const char *accessMethodName, Oid accessMethodId, bool amcanorder, bool isconstraint)
 
static char * ChooseIndexName (const char *tabname, Oid namespaceId, List *colnames, List *exclusionOpNames, bool primary, bool isconstraint)
 
static char * ChooseIndexNameAddition (List *colnames)
 
static ListChooseIndexColumnNames (List *indexElems)
 
static void RangeVarCallbackForReindexIndex (const RangeVar *relation, Oid relId, Oid oldRelId, void *arg)
 
bool CheckIndexCompatible (Oid oldId, const char *accessMethodName, List *attributeList, List *exclusionOpNames)
 
ObjectAddress DefineIndex (Oid relationId, IndexStmt *stmt, Oid indexRelationId, bool is_alter_table, bool check_rights, bool check_not_in_use, bool skip_build, bool quiet)
 
static bool CheckMutability (Expr *expr)
 
Oid ResolveOpClass (List *opclass, Oid attrType, const char *accessMethodName, Oid accessMethodId)
 
Oid GetDefaultOpClass (Oid type_id, Oid am_id)
 
char * makeObjectName (const char *name1, const char *name2, const char *label)
 
char * ChooseRelationName (const char *name1, const char *name2, const char *label, Oid namespaceid)
 
Oid ReindexIndex (RangeVar *indexRelation, int options)
 
Oid ReindexTable (RangeVar *relation, int options)
 
void ReindexMultipleTables (const char *objectName, ReindexObjectType objectKind, int options)
 

Function Documentation

◆ CheckIndexCompatible()

bool CheckIndexCompatible ( Oid  oldId,
const char *  accessMethodName,
List attributeList,
List exclusionOpNames 
)

Definition at line 117 of file indexcmds.c.

References AccessShareLock, IndexAmRoutine::amcanorder, AMNAME, Anum_pg_index_indclass, Anum_pg_index_indcollation, Anum_pg_index_indexprs, Anum_pg_index_indpred, Assert, ComputeIndexAttrs(), CurrentMemoryContext, DatumGetPointer, elog, ereport, errcode(), errmsg(), ERROR, get_opclass_input_type(), GetIndexAmRoutine(), GETSTRUCT, heap_attisnull(), HeapTupleGetOid, HeapTupleIsValid, i, IndexInfo::ii_AmCache, IndexInfo::ii_Context, IndexInfo::ii_ExclusionOps, IndexInfo::ii_ExclusionProcs, IndexInfo::ii_ExclusionStrats, IndexInfo::ii_Expressions, IndexInfo::ii_ExpressionsState, IndexInfo::ii_PredicateState, index_close(), INDEX_MAX_KEYS, index_open(), IndexGetRelation(), IndexIsValid, INDEXRELID, IsPolymorphicType, list_length(), makeNode, NIL, NoLock, ObjectIdGetDatum, op_input_types(), palloc(), PointerGetDatum, RelationData::rd_att, RelationGetExclusionInfo(), ReleaseSysCache(), SearchSysCache1(), SysCacheGetAttr(), TupleDescAttr, and oidvector::values.

Referenced by TryReuseIndex().

121 {
122  bool isconstraint;
123  Oid *typeObjectId;
124  Oid *collationObjectId;
125  Oid *classObjectId;
126  Oid accessMethodId;
127  Oid relationId;
128  HeapTuple tuple;
129  Form_pg_index indexForm;
130  Form_pg_am accessMethodForm;
131  IndexAmRoutine *amRoutine;
132  bool amcanorder;
133  int16 *coloptions;
134  IndexInfo *indexInfo;
135  int numberOfAttributes;
136  int old_natts;
137  bool isnull;
138  bool ret = true;
139  oidvector *old_indclass;
140  oidvector *old_indcollation;
141  Relation irel;
142  int i;
143  Datum d;
144 
145  /* Caller should already have the relation locked in some way. */
146  relationId = IndexGetRelation(oldId, false);
147 
148  /*
149  * We can pretend isconstraint = false unconditionally. It only serves to
150  * decide the text of an error message that should never happen for us.
151  */
152  isconstraint = false;
153 
154  numberOfAttributes = list_length(attributeList);
155  Assert(numberOfAttributes > 0);
156  Assert(numberOfAttributes <= INDEX_MAX_KEYS);
157 
158  /* look up the access method */
159  tuple = SearchSysCache1(AMNAME, PointerGetDatum(accessMethodName));
160  if (!HeapTupleIsValid(tuple))
161  ereport(ERROR,
162  (errcode(ERRCODE_UNDEFINED_OBJECT),
163  errmsg("access method \"%s\" does not exist",
164  accessMethodName)));
165  accessMethodId = HeapTupleGetOid(tuple);
166  accessMethodForm = (Form_pg_am) GETSTRUCT(tuple);
167  amRoutine = GetIndexAmRoutine(accessMethodForm->amhandler);
168  ReleaseSysCache(tuple);
169 
170  amcanorder = amRoutine->amcanorder;
171 
172  /*
173  * Compute the operator classes, collations, and exclusion operators for
174  * the new index, so we can test whether it's compatible with the existing
175  * one. Note that ComputeIndexAttrs might fail here, but that's OK:
176  * DefineIndex would have called this function with the same arguments
177  * later on, and it would have failed then anyway.
178  */
179  indexInfo = makeNode(IndexInfo);
180  indexInfo->ii_Expressions = NIL;
181  indexInfo->ii_ExpressionsState = NIL;
182  indexInfo->ii_PredicateState = NULL;
183  indexInfo->ii_ExclusionOps = NULL;
184  indexInfo->ii_ExclusionProcs = NULL;
185  indexInfo->ii_ExclusionStrats = NULL;
186  indexInfo->ii_AmCache = NULL;
187  indexInfo->ii_Context = CurrentMemoryContext;
188  typeObjectId = (Oid *) palloc(numberOfAttributes * sizeof(Oid));
189  collationObjectId = (Oid *) palloc(numberOfAttributes * sizeof(Oid));
190  classObjectId = (Oid *) palloc(numberOfAttributes * sizeof(Oid));
191  coloptions = (int16 *) palloc(numberOfAttributes * sizeof(int16));
192  ComputeIndexAttrs(indexInfo,
193  typeObjectId, collationObjectId, classObjectId,
194  coloptions, attributeList,
195  exclusionOpNames, relationId,
196  accessMethodName, accessMethodId,
197  amcanorder, isconstraint);
198 
199 
200  /* Get the soon-obsolete pg_index tuple. */
202  if (!HeapTupleIsValid(tuple))
203  elog(ERROR, "cache lookup failed for index %u", oldId);
204  indexForm = (Form_pg_index) GETSTRUCT(tuple);
205 
206  /*
207  * We don't assess expressions or predicates; assume incompatibility.
208  * Also, if the index is invalid for any reason, treat it as incompatible.
209  */
210  if (!(heap_attisnull(tuple, Anum_pg_index_indpred) &&
212  IndexIsValid(indexForm)))
213  {
214  ReleaseSysCache(tuple);
215  return false;
216  }
217 
218  /* Any change in operator class or collation breaks compatibility. */
219  old_natts = indexForm->indnatts;
220  Assert(old_natts == numberOfAttributes);
221 
223  Assert(!isnull);
224  old_indcollation = (oidvector *) DatumGetPointer(d);
225 
226  d = SysCacheGetAttr(INDEXRELID, tuple, Anum_pg_index_indclass, &isnull);
227  Assert(!isnull);
228  old_indclass = (oidvector *) DatumGetPointer(d);
229 
230  ret = (memcmp(old_indclass->values, classObjectId,
231  old_natts * sizeof(Oid)) == 0 &&
232  memcmp(old_indcollation->values, collationObjectId,
233  old_natts * sizeof(Oid)) == 0);
234 
235  ReleaseSysCache(tuple);
236 
237  if (!ret)
238  return false;
239 
240  /* For polymorphic opcintype, column type changes break compatibility. */
241  irel = index_open(oldId, AccessShareLock); /* caller probably has a lock */
242  for (i = 0; i < old_natts; i++)
243  {
244  if (IsPolymorphicType(get_opclass_input_type(classObjectId[i])) &&
245  TupleDescAttr(irel->rd_att, i)->atttypid != typeObjectId[i])
246  {
247  ret = false;
248  break;
249  }
250  }
251 
252  /* Any change in exclusion operator selections breaks compatibility. */
253  if (ret && indexInfo->ii_ExclusionOps != NULL)
254  {
255  Oid *old_operators,
256  *old_procs;
257  uint16 *old_strats;
258 
259  RelationGetExclusionInfo(irel, &old_operators, &old_procs, &old_strats);
260  ret = memcmp(old_operators, indexInfo->ii_ExclusionOps,
261  old_natts * sizeof(Oid)) == 0;
262 
263  /* Require an exact input type match for polymorphic operators. */
264  if (ret)
265  {
266  for (i = 0; i < old_natts && ret; i++)
267  {
268  Oid left,
269  right;
270 
271  op_input_types(indexInfo->ii_ExclusionOps[i], &left, &right);
272  if ((IsPolymorphicType(left) || IsPolymorphicType(right)) &&
273  TupleDescAttr(irel->rd_att, i)->atttypid != typeObjectId[i])
274  {
275  ret = false;
276  break;
277  }
278  }
279  }
280  }
281 
282  index_close(irel, NoLock);
283  return ret;
284 }
signed short int16
Definition: c.h:283
#define NIL
Definition: pg_list.h:69
Definition: c.h:526
MemoryContext ii_Context
Definition: execnodes.h:152
Oid IndexGetRelation(Oid indexId, bool missing_ok)
Definition: index.c:3284
void RelationGetExclusionInfo(Relation indexRelation, Oid **operators, Oid **procs, uint16 **strategies)
Definition: relcache.c:5069
#define GETSTRUCT(TUP)
Definition: htup_details.h:661
#define IndexIsValid(indexForm)
Definition: pg_index.h:107
#define PointerGetDatum(X)
Definition: postgres.h:562
#define TupleDescAttr(tupdesc, i)
Definition: tupdesc.h:90
ExprState * ii_PredicateState
Definition: execnodes.h:140
#define Anum_pg_index_indclass
Definition: pg_index.h:89
#define AccessShareLock
Definition: lockdefs.h:36
Oid * ii_ExclusionProcs
Definition: execnodes.h:142
int errcode(int sqlerrcode)
Definition: elog.c:575
unsigned int Oid
Definition: postgres_ext.h:31
List * ii_ExpressionsState
Definition: execnodes.h:138
unsigned short uint16
Definition: c.h:295
#define ObjectIdGetDatum(X)
Definition: postgres.h:513
#define ERROR
Definition: elog.h:43
#define IsPolymorphicType(typid)
Definition: pg_type.h:745
IndexAmRoutine * GetIndexAmRoutine(Oid amhandler)
Definition: amapi.c:33
#define NoLock
Definition: lockdefs.h:34
Oid values[FLEXIBLE_ARRAY_MEMBER]
Definition: c.h:534
bool heap_attisnull(HeapTuple tup, int attnum)
Definition: heaptuple.c:296
void op_input_types(Oid opno, Oid *lefttype, Oid *righttype)
Definition: lsyscache.c:1167
MemoryContext CurrentMemoryContext
Definition: mcxt.c:37
#define ereport(elevel, rest)
Definition: elog.h:122
void * ii_AmCache
Definition: execnodes.h:151
FormData_pg_index * Form_pg_index
Definition: pg_index.h:67
HeapTuple SearchSysCache1(int cacheId, Datum key1)
Definition: syscache.c:1112
uintptr_t Datum
Definition: postgres.h:372
void ReleaseSysCache(HeapTuple tuple)
Definition: syscache.c:1160
Datum SysCacheGetAttr(int cacheId, HeapTuple tup, AttrNumber attributeNumber, bool *isNull)
Definition: syscache.c:1368
TupleDesc rd_att
Definition: rel.h:115
#define Anum_pg_index_indpred
Definition: pg_index.h:92
#define makeNode(_type_)
Definition: nodes.h:560
#define HeapTupleIsValid(tuple)
Definition: htup.h:77
List * ii_Expressions
Definition: execnodes.h:137
#define Assert(condition)
Definition: c.h:670
#define INDEX_MAX_KEYS
static int list_length(const List *l)
Definition: pg_list.h:89
bool amcanorder
Definition: amapi.h:171
void index_close(Relation relation, LOCKMODE lockmode)
Definition: indexam.c:176
#define DatumGetPointer(X)
Definition: postgres.h:555
#define Anum_pg_index_indcollation
Definition: pg_index.h:88
Oid * ii_ExclusionOps
Definition: execnodes.h:141
FormData_pg_am * Form_pg_am
Definition: pg_am.h:46
void * palloc(Size size)
Definition: mcxt.c:848
int errmsg(const char *fmt,...)
Definition: elog.c:797
int i
static void ComputeIndexAttrs(IndexInfo *indexInfo, Oid *typeOidP, Oid *collationOidP, Oid *classOidP, int16 *colOptionP, List *attList, List *exclusionOpNames, Oid relId, const char *accessMethodName, Oid accessMethodId, bool amcanorder, bool isconstraint)
Definition: indexcmds.c:1023
#define elog
Definition: elog.h:219
#define HeapTupleGetOid(tuple)
Definition: htup_details.h:700
uint16 * ii_ExclusionStrats
Definition: execnodes.h:143
Relation index_open(Oid relationId, LOCKMODE lockmode)
Definition: indexam.c:151
#define Anum_pg_index_indexprs
Definition: pg_index.h:91
Oid get_opclass_input_type(Oid opclass)
Definition: lsyscache.c:1069

◆ CheckMutability()

static bool CheckMutability ( Expr expr)
static

Definition at line 967 of file indexcmds.c.

References contain_mutable_functions(), and expression_planner().

Referenced by CheckPredicate(), and ComputeIndexAttrs().

968 {
969  /*
970  * First run the expression through the planner. This has a couple of
971  * important consequences. First, function default arguments will get
972  * inserted, which may affect volatility (consider "default now()").
973  * Second, inline-able functions will get inlined, which may allow us to
974  * conclude that the function is really less volatile than it's marked. As
975  * an example, polymorphic functions must be marked with the most volatile
976  * behavior that they have for any input type, but once we inline the
977  * function we may be able to conclude that it's not so volatile for the
978  * particular input type we're dealing with.
979  *
980  * We assume here that expression_planner() won't scribble on its input.
981  */
982  expr = expression_planner(expr);
983 
984  /* Now we can search for non-immutable functions */
985  return contain_mutable_functions((Node *) expr);
986 }
Expr * expression_planner(Expr *expr)
Definition: planner.c:6026
Definition: nodes.h:512
bool contain_mutable_functions(Node *clause)
Definition: clauses.c:878

◆ CheckPredicate()

static void CheckPredicate ( Expr predicate)
static

Definition at line 1001 of file indexcmds.c.

References CheckMutability(), ereport, errcode(), errmsg(), and ERROR.

Referenced by DefineIndex().

1002 {
1003  /*
1004  * transformExpr() should have already rejected subqueries, aggregates,
1005  * and window functions, based on the EXPR_KIND_ for a predicate.
1006  */
1007 
1008  /*
1009  * A predicate using mutable functions is probably wrong, for the same
1010  * reasons that we don't allow an index expression to use one.
1011  */
1012  if (CheckMutability(predicate))
1013  ereport(ERROR,
1014  (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
1015  errmsg("functions in index predicate must be marked IMMUTABLE")));
1016 }
static bool CheckMutability(Expr *expr)
Definition: indexcmds.c:967
int errcode(int sqlerrcode)
Definition: elog.c:575
#define ERROR
Definition: elog.h:43
#define ereport(elevel, rest)
Definition: elog.h:122
int errmsg(const char *fmt,...)
Definition: elog.c:797

◆ ChooseIndexColumnNames()

static List * ChooseIndexColumnNames ( List indexElems)
static

Definition at line 1708 of file indexcmds.c.

References buf, i, IndexElem::indexcolname, lappend(), lfirst, IndexElem::name, NAMEDATALEN, NIL, pg_mbcliplen(), and pstrdup().

Referenced by DefineIndex().

1709 {
1710  List *result = NIL;
1711  ListCell *lc;
1712 
1713  foreach(lc, indexElems)
1714  {
1715  IndexElem *ielem = (IndexElem *) lfirst(lc);
1716  const char *origname;
1717  const char *curname;
1718  int i;
1719  char buf[NAMEDATALEN];
1720 
1721  /* Get the preliminary name from the IndexElem */
1722  if (ielem->indexcolname)
1723  origname = ielem->indexcolname; /* caller-specified name */
1724  else if (ielem->name)
1725  origname = ielem->name; /* simple column reference */
1726  else
1727  origname = "expr"; /* default name for expression */
1728 
1729  /* If it conflicts with any previous column, tweak it */
1730  curname = origname;
1731  for (i = 1;; i++)
1732  {
1733  ListCell *lc2;
1734  char nbuf[32];
1735  int nlen;
1736 
1737  foreach(lc2, result)
1738  {
1739  if (strcmp(curname, (char *) lfirst(lc2)) == 0)
1740  break;
1741  }
1742  if (lc2 == NULL)
1743  break; /* found nonconflicting name */
1744 
1745  sprintf(nbuf, "%d", i);
1746 
1747  /* Ensure generated names are shorter than NAMEDATALEN */
1748  nlen = pg_mbcliplen(origname, strlen(origname),
1749  NAMEDATALEN - 1 - strlen(nbuf));
1750  memcpy(buf, origname, nlen);
1751  strcpy(buf + nlen, nbuf);
1752  curname = buf;
1753  }
1754 
1755  /* And attach to the result list */
1756  result = lappend(result, pstrdup(curname));
1757  }
1758  return result;
1759 }
#define NIL
Definition: pg_list.h:69
char * pstrdup(const char *in)
Definition: mcxt.c:1076
#define NAMEDATALEN
int pg_mbcliplen(const char *mbstr, int len, int limit)
Definition: mbutils.c:820
static char * buf
Definition: pg_test_fsync.c:67
char * indexcolname
Definition: parsenodes.h:690
List * lappend(List *list, void *datum)
Definition: list.c:128
#define lfirst(lc)
Definition: pg_list.h:106
char * name
Definition: parsenodes.h:688
int i
Definition: pg_list.h:45

◆ ChooseIndexName()

static char * ChooseIndexName ( const char *  tabname,
Oid  namespaceId,
List colnames,
List exclusionOpNames,
bool  primary,
bool  isconstraint 
)
static

Definition at line 1626 of file indexcmds.c.

References ChooseIndexNameAddition(), ChooseRelationName(), and NIL.

Referenced by DefineIndex().

1629 {
1630  char *indexname;
1631 
1632  if (primary)
1633  {
1634  /* the primary key's name does not depend on the specific column(s) */
1635  indexname = ChooseRelationName(tabname,
1636  NULL,
1637  "pkey",
1638  namespaceId);
1639  }
1640  else if (exclusionOpNames != NIL)
1641  {
1642  indexname = ChooseRelationName(tabname,
1643  ChooseIndexNameAddition(colnames),
1644  "excl",
1645  namespaceId);
1646  }
1647  else if (isconstraint)
1648  {
1649  indexname = ChooseRelationName(tabname,
1650  ChooseIndexNameAddition(colnames),
1651  "key",
1652  namespaceId);
1653  }
1654  else
1655  {
1656  indexname = ChooseRelationName(tabname,
1657  ChooseIndexNameAddition(colnames),
1658  "idx",
1659  namespaceId);
1660  }
1661 
1662  return indexname;
1663 }
#define NIL
Definition: pg_list.h:69
static char * ChooseIndexNameAddition(List *colnames)
Definition: indexcmds.c:1674
char * ChooseRelationName(const char *name1, const char *name2, const char *label, Oid namespaceid)
Definition: indexcmds.c:1595

◆ ChooseIndexNameAddition()

static char * ChooseIndexNameAddition ( List colnames)
static

Definition at line 1674 of file indexcmds.c.

References buf, lfirst, name, NAMEDATALEN, pstrdup(), and strlcpy().

Referenced by ChooseIndexName().

1675 {
1676  char buf[NAMEDATALEN * 2];
1677  int buflen = 0;
1678  ListCell *lc;
1679 
1680  buf[0] = '\0';
1681  foreach(lc, colnames)
1682  {
1683  const char *name = (const char *) lfirst(lc);
1684 
1685  if (buflen > 0)
1686  buf[buflen++] = '_'; /* insert _ between names */
1687 
1688  /*
1689  * At this point we have buflen <= NAMEDATALEN. name should be less
1690  * than NAMEDATALEN already, but use strlcpy for paranoia.
1691  */
1692  strlcpy(buf + buflen, name, NAMEDATALEN);
1693  buflen += strlen(buf + buflen);
1694  if (buflen >= NAMEDATALEN)
1695  break;
1696  }
1697  return pstrdup(buf);
1698 }
char * pstrdup(const char *in)
Definition: mcxt.c:1076
#define NAMEDATALEN
static char * buf
Definition: pg_test_fsync.c:67
size_t strlcpy(char *dst, const char *src, size_t siz)
Definition: strlcpy.c:45
#define lfirst(lc)
Definition: pg_list.h:106
const char * name
Definition: encode.c:521

◆ ChooseRelationName()

char* ChooseRelationName ( const char *  name1,
const char *  name2,
const char *  label,
Oid  namespaceid 
)

Definition at line 1595 of file indexcmds.c.

References get_relname_relid(), makeObjectName(), NAMEDATALEN, OidIsValid, pfree(), snprintf(), and StrNCpy.

Referenced by ChooseIndexName(), and generateSerialExtraStmts().

1597 {
1598  int pass = 0;
1599  char *relname = NULL;
1600  char modlabel[NAMEDATALEN];
1601 
1602  /* try the unmodified label first */
1603  StrNCpy(modlabel, label, sizeof(modlabel));
1604 
1605  for (;;)
1606  {
1607  relname = makeObjectName(name1, name2, modlabel);
1608 
1609  if (!OidIsValid(get_relname_relid(relname, namespaceid)))
1610  break;
1611 
1612  /* found a conflict, so try a new name component */
1613  pfree(relname);
1614  snprintf(modlabel, sizeof(modlabel), "%s%d", label, ++pass);
1615  }
1616 
1617  return relname;
1618 }
int snprintf(char *str, size_t count, const char *fmt,...) pg_attribute_printf(3
#define OidIsValid(objectId)
Definition: c.h:576
char * makeObjectName(const char *name1, const char *name2, const char *label)
Definition: indexcmds.c:1515
#define NAMEDATALEN
void pfree(void *pointer)
Definition: mcxt.c:949
Oid get_relname_relid(const char *relname, Oid relnamespace)
Definition: lsyscache.c:1702
static char * label
Definition: pg_basebackup.c:82
#define StrNCpy(dst, src, len)
Definition: c.h:826

◆ ComputeIndexAttrs()

static void ComputeIndexAttrs ( IndexInfo indexInfo,
Oid typeOidP,
Oid collationOidP,
Oid classOidP,
int16 colOptionP,
List attList,
List exclusionOpNames,
Oid  relId,
const char *  accessMethodName,
Oid  accessMethodId,
bool  amcanorder,
bool  isconstraint 
)
static

Definition at line 1023 of file indexcmds.c.

References arg, Assert, CheckMutability(), IndexElem::collation, compatible_oper_opid(), elog, ereport, errcode(), errdetail(), errhint(), errmsg(), ERROR, IndexElem::expr, exprCollation(), exprType(), format_operator(), format_type_be(), get_collation_oid(), get_commutator(), get_op_opfamily_strategy(), get_opclass_family(), get_opcode(), GETSTRUCT, HeapTupleIsValid, IndexInfo::ii_ExclusionOps, IndexInfo::ii_ExclusionProcs, IndexInfo::ii_ExclusionStrats, IndexInfo::ii_Expressions, IndexInfo::ii_KeyAttrNumbers, INDOPTION_DESC, INDOPTION_NULLS_FIRST, InvalidAttrNumber, IsA, lappend(), lfirst, list_head(), list_length(), lnext, IndexElem::name, NameStr, IndexElem::nulls_ordering, ObjectIdGetDatum, OidIsValid, IndexElem::opclass, OPFAMILYOID, IndexElem::ordering, palloc(), ReleaseSysCache(), ResolveOpClass(), SearchSysCache1(), SearchSysCacheAttName(), SORTBY_DEFAULT, SORTBY_DESC, SORTBY_NULLS_DEFAULT, SORTBY_NULLS_FIRST, and type_is_collatable().

Referenced by CheckIndexCompatible(), and DefineIndex().

1035 {
1036  ListCell *nextExclOp;
1037  ListCell *lc;
1038  int attn;
1039 
1040  /* Allocate space for exclusion operator info, if needed */
1041  if (exclusionOpNames)
1042  {
1043  int ncols = list_length(attList);
1044 
1045  Assert(list_length(exclusionOpNames) == ncols);
1046  indexInfo->ii_ExclusionOps = (Oid *) palloc(sizeof(Oid) * ncols);
1047  indexInfo->ii_ExclusionProcs = (Oid *) palloc(sizeof(Oid) * ncols);
1048  indexInfo->ii_ExclusionStrats = (uint16 *) palloc(sizeof(uint16) * ncols);
1049  nextExclOp = list_head(exclusionOpNames);
1050  }
1051  else
1052  nextExclOp = NULL;
1053 
1054  /*
1055  * process attributeList
1056  */
1057  attn = 0;
1058  foreach(lc, attList)
1059  {
1060  IndexElem *attribute = (IndexElem *) lfirst(lc);
1061  Oid atttype;
1062  Oid attcollation;
1063 
1064  /*
1065  * Process the column-or-expression to be indexed.
1066  */
1067  if (attribute->name != NULL)
1068  {
1069  /* Simple index attribute */
1070  HeapTuple atttuple;
1071  Form_pg_attribute attform;
1072 
1073  Assert(attribute->expr == NULL);
1074  atttuple = SearchSysCacheAttName(relId, attribute->name);
1075  if (!HeapTupleIsValid(atttuple))
1076  {
1077  /* difference in error message spellings is historical */
1078  if (isconstraint)
1079  ereport(ERROR,
1080  (errcode(ERRCODE_UNDEFINED_COLUMN),
1081  errmsg("column \"%s\" named in key does not exist",
1082  attribute->name)));
1083  else
1084  ereport(ERROR,
1085  (errcode(ERRCODE_UNDEFINED_COLUMN),
1086  errmsg("column \"%s\" does not exist",
1087  attribute->name)));
1088  }
1089  attform = (Form_pg_attribute) GETSTRUCT(atttuple);
1090  indexInfo->ii_KeyAttrNumbers[attn] = attform->attnum;
1091  atttype = attform->atttypid;
1092  attcollation = attform->attcollation;
1093  ReleaseSysCache(atttuple);
1094  }
1095  else
1096  {
1097  /* Index expression */
1098  Node *expr = attribute->expr;
1099 
1100  Assert(expr != NULL);
1101  atttype = exprType(expr);
1102  attcollation = exprCollation(expr);
1103 
1104  /*
1105  * Strip any top-level COLLATE clause. This ensures that we treat
1106  * "x COLLATE y" and "(x COLLATE y)" alike.
1107  */
1108  while (IsA(expr, CollateExpr))
1109  expr = (Node *) ((CollateExpr *) expr)->arg;
1110 
1111  if (IsA(expr, Var) &&
1112  ((Var *) expr)->varattno != InvalidAttrNumber)
1113  {
1114  /*
1115  * User wrote "(column)" or "(column COLLATE something)".
1116  * Treat it like simple attribute anyway.
1117  */
1118  indexInfo->ii_KeyAttrNumbers[attn] = ((Var *) expr)->varattno;
1119  }
1120  else
1121  {
1122  indexInfo->ii_KeyAttrNumbers[attn] = 0; /* marks expression */
1123  indexInfo->ii_Expressions = lappend(indexInfo->ii_Expressions,
1124  expr);
1125 
1126  /*
1127  * transformExpr() should have already rejected subqueries,
1128  * aggregates, and window functions, based on the EXPR_KIND_
1129  * for an index expression.
1130  */
1131 
1132  /*
1133  * An expression using mutable functions is probably wrong,
1134  * since if you aren't going to get the same result for the
1135  * same data every time, it's not clear what the index entries
1136  * mean at all.
1137  */
1138  if (CheckMutability((Expr *) expr))
1139  ereport(ERROR,
1140  (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
1141  errmsg("functions in index expression must be marked IMMUTABLE")));
1142  }
1143  }
1144 
1145  typeOidP[attn] = atttype;
1146 
1147  /*
1148  * Apply collation override if any
1149  */
1150  if (attribute->collation)
1151  attcollation = get_collation_oid(attribute->collation, false);
1152 
1153  /*
1154  * Check we have a collation iff it's a collatable type. The only
1155  * expected failures here are (1) COLLATE applied to a noncollatable
1156  * type, or (2) index expression had an unresolved collation. But we
1157  * might as well code this to be a complete consistency check.
1158  */
1159  if (type_is_collatable(atttype))
1160  {
1161  if (!OidIsValid(attcollation))
1162  ereport(ERROR,
1163  (errcode(ERRCODE_INDETERMINATE_COLLATION),
1164  errmsg("could not determine which collation to use for index expression"),
1165  errhint("Use the COLLATE clause to set the collation explicitly.")));
1166  }
1167  else
1168  {
1169  if (OidIsValid(attcollation))
1170  ereport(ERROR,
1171  (errcode(ERRCODE_DATATYPE_MISMATCH),
1172  errmsg("collations are not supported by type %s",
1173  format_type_be(atttype))));
1174  }
1175 
1176  collationOidP[attn] = attcollation;
1177 
1178  /*
1179  * Identify the opclass to use.
1180  */
1181  classOidP[attn] = ResolveOpClass(attribute->opclass,
1182  atttype,
1183  accessMethodName,
1184  accessMethodId);
1185 
1186  /*
1187  * Identify the exclusion operator, if any.
1188  */
1189  if (nextExclOp)
1190  {
1191  List *opname = (List *) lfirst(nextExclOp);
1192  Oid opid;
1193  Oid opfamily;
1194  int strat;
1195 
1196  /*
1197  * Find the operator --- it must accept the column datatype
1198  * without runtime coercion (but binary compatibility is OK)
1199  */
1200  opid = compatible_oper_opid(opname, atttype, atttype, false);
1201 
1202  /*
1203  * Only allow commutative operators to be used in exclusion
1204  * constraints. If X conflicts with Y, but Y does not conflict
1205  * with X, bad things will happen.
1206  */
1207  if (get_commutator(opid) != opid)
1208  ereport(ERROR,
1209  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
1210  errmsg("operator %s is not commutative",
1211  format_operator(opid)),
1212  errdetail("Only commutative operators can be used in exclusion constraints.")));
1213 
1214  /*
1215  * Operator must be a member of the right opfamily, too
1216  */
1217  opfamily = get_opclass_family(classOidP[attn]);
1218  strat = get_op_opfamily_strategy(opid, opfamily);
1219  if (strat == 0)
1220  {
1221  HeapTuple opftuple;
1222  Form_pg_opfamily opfform;
1223 
1224  /*
1225  * attribute->opclass might not explicitly name the opfamily,
1226  * so fetch the name of the selected opfamily for use in the
1227  * error message.
1228  */
1229  opftuple = SearchSysCache1(OPFAMILYOID,
1230  ObjectIdGetDatum(opfamily));
1231  if (!HeapTupleIsValid(opftuple))
1232  elog(ERROR, "cache lookup failed for opfamily %u",
1233  opfamily);
1234  opfform = (Form_pg_opfamily) GETSTRUCT(opftuple);
1235 
1236  ereport(ERROR,
1237  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
1238  errmsg("operator %s is not a member of operator family \"%s\"",
1239  format_operator(opid),
1240  NameStr(opfform->opfname)),
1241  errdetail("The exclusion operator must be related to the index operator class for the constraint.")));
1242  }
1243 
1244  indexInfo->ii_ExclusionOps[attn] = opid;
1245  indexInfo->ii_ExclusionProcs[attn] = get_opcode(opid);
1246  indexInfo->ii_ExclusionStrats[attn] = strat;
1247  nextExclOp = lnext(nextExclOp);
1248  }
1249 
1250  /*
1251  * Set up the per-column options (indoption field). For now, this is
1252  * zero for any un-ordered index, while ordered indexes have DESC and
1253  * NULLS FIRST/LAST options.
1254  */
1255  colOptionP[attn] = 0;
1256  if (amcanorder)
1257  {
1258  /* default ordering is ASC */
1259  if (attribute->ordering == SORTBY_DESC)
1260  colOptionP[attn] |= INDOPTION_DESC;
1261  /* default null ordering is LAST for ASC, FIRST for DESC */
1262  if (attribute->nulls_ordering == SORTBY_NULLS_DEFAULT)
1263  {
1264  if (attribute->ordering == SORTBY_DESC)
1265  colOptionP[attn] |= INDOPTION_NULLS_FIRST;
1266  }
1267  else if (attribute->nulls_ordering == SORTBY_NULLS_FIRST)
1268  colOptionP[attn] |= INDOPTION_NULLS_FIRST;
1269  }
1270  else
1271  {
1272  /* index AM does not support ordering */
1273  if (attribute->ordering != SORTBY_DEFAULT)
1274  ereport(ERROR,
1275  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1276  errmsg("access method \"%s\" does not support ASC/DESC options",
1277  accessMethodName)));
1278  if (attribute->nulls_ordering != SORTBY_NULLS_DEFAULT)
1279  ereport(ERROR,
1280  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1281  errmsg("access method \"%s\" does not support NULLS FIRST/LAST options",
1282  accessMethodName)));
1283  }
1284 
1285  attn++;
1286  }
1287 }
#define INDOPTION_NULLS_FIRST
Definition: pg_index.h:100
#define IsA(nodeptr, _type_)
Definition: nodes.h:563
static bool CheckMutability(Expr *expr)
Definition: indexcmds.c:967
Oid get_commutator(Oid opno)
Definition: lsyscache.c:1313
int errhint(const char *fmt,...)
Definition: elog.c:987
SortByDir ordering
Definition: parsenodes.h:693
#define GETSTRUCT(TUP)
Definition: htup_details.h:661
Definition: nodes.h:512
Oid * ii_ExclusionProcs
Definition: execnodes.h:142
int errcode(int sqlerrcode)
Definition: elog.c:575
char * format_type_be(Oid type_oid)
Definition: format_type.c:94
char * format_operator(Oid operator_oid)
Definition: regproc.c:820
unsigned int Oid
Definition: postgres_ext.h:31
Definition: primnodes.h:163
#define OidIsValid(objectId)
Definition: c.h:576
Node * expr
Definition: parsenodes.h:689
unsigned short uint16
Definition: c.h:295
SortByNulls nulls_ordering
Definition: parsenodes.h:694
#define ObjectIdGetDatum(X)
Definition: postgres.h:513
#define ERROR
Definition: elog.h:43
Oid ResolveOpClass(List *opclass, Oid attrType, const char *accessMethodName, Oid accessMethodId)
Definition: indexcmds.c:1296
int errdetail(const char *fmt,...)
Definition: elog.c:873
static ListCell * list_head(const List *l)
Definition: pg_list.h:77
FormData_pg_attribute * Form_pg_attribute
Definition: pg_attribute.h:187
#define lnext(lc)
Definition: pg_list.h:105
#define ereport(elevel, rest)
Definition: elog.h:122
List * lappend(List *list, void *datum)
Definition: list.c:128
HeapTuple SearchSysCache1(int cacheId, Datum key1)
Definition: syscache.c:1112
FormData_pg_opfamily * Form_pg_opfamily
Definition: pg_opfamily.h:44
void ReleaseSysCache(HeapTuple tuple)
Definition: syscache.c:1160
RegProcedure get_opcode(Oid opno)
Definition: lsyscache.c:1094
List * opclass
Definition: parsenodes.h:692
#define HeapTupleIsValid(tuple)
Definition: htup.h:77
List * ii_Expressions
Definition: execnodes.h:137
#define Assert(condition)
Definition: c.h:670
#define lfirst(lc)
Definition: pg_list.h:106
#define INDOPTION_DESC
Definition: pg_index.h:99
Oid exprType(const Node *expr)
Definition: nodeFuncs.c:42
static int list_length(const List *l)
Definition: pg_list.h:89
Oid exprCollation(const Node *expr)
Definition: nodeFuncs.c:720
AttrNumber ii_KeyAttrNumbers[INDEX_MAX_KEYS]
Definition: execnodes.h:136
char * name
Definition: parsenodes.h:688
HeapTuple SearchSysCacheAttName(Oid relid, const char *attname)
Definition: syscache.c:1248
Oid get_opclass_family(Oid opclass)
Definition: lsyscache.c:1047
#define InvalidAttrNumber
Definition: attnum.h:23
int get_op_opfamily_strategy(Oid opno, Oid opfamily)
Definition: lsyscache.c:80
Oid * ii_ExclusionOps
Definition: execnodes.h:141
void * palloc(Size size)
Definition: mcxt.c:848
int errmsg(const char *fmt,...)
Definition: elog.c:797
Oid compatible_oper_opid(List *op, Oid arg1, Oid arg2, bool noError)
Definition: parse_oper.c:494
#define NameStr(name)
Definition: c.h:547
void * arg
List * collation
Definition: parsenodes.h:691
#define elog
Definition: elog.h:219
uint16 * ii_ExclusionStrats
Definition: execnodes.h:143
bool type_is_collatable(Oid typid)
Definition: lsyscache.c:2839
Definition: pg_list.h:45
Oid get_collation_oid(List *name, bool missing_ok)
Definition: namespace.c:3493

◆ DefineIndex()

ObjectAddress DefineIndex ( Oid  relationId,
IndexStmt stmt,
Oid  indexRelationId,
bool  is_alter_table,
bool  check_rights,
bool  check_not_in_use,
bool  skip_build,
bool  quiet 
)

Definition at line 308 of file indexcmds.c.

References IndexStmt::accessMethod, ACL_CREATE, ACL_KIND_NAMESPACE, ACL_KIND_TABLESPACE, aclcheck_error(), ACLCHECK_OK, allowSystemTableMods, IndexAmRoutine::amcanmulticol, IndexAmRoutine::amcanorder, IndexAmRoutine::amcanunique, IndexAmRoutine::amgettuple, AMNAME, IndexAmRoutine::amoptions, Assert, bms_is_member(), BuildIndexInfo(), CacheInvalidateRelcacheByRelid(), CheckPredicate(), CheckTableNotInUse(), ChooseIndexColumnNames(), ChooseIndexName(), CommitTransactionCommand(), ComputeIndexAttrs(), IndexStmt::concurrent, CreateComments(), CurrentMemoryContext, LockRelId::dbId, DEBUG1, IndexStmt::deferrable, elog, ereport, errcode(), errmsg(), ERROR, IndexStmt::excludeOpNames, FirstLowInvalidHeapAttributeNumber, get_namespace_name(), get_tablespace_name(), get_tablespace_oid(), GetCurrentVirtualXIDs(), GetDefaultTablespace(), GetIndexAmRoutine(), GETSTRUCT, GetTransactionSnapshot(), GetUserId(), GLOBALTABLESPACE_OID, heap_close, heap_open(), heap_openrv(), HeapTupleGetOid, HeapTupleIsValid, i, IndexStmt::idxcomment, IndexStmt::idxname, IndexStmt::if_not_exists, IndexInfo::ii_AmCache, IndexInfo::ii_BrokenHotChain, IndexInfo::ii_Concurrent, IndexInfo::ii_Context, IndexInfo::ii_ExclusionOps, IndexInfo::ii_ExclusionProcs, IndexInfo::ii_ExclusionStrats, IndexInfo::ii_Expressions, IndexInfo::ii_ExpressionsState, IndexInfo::ii_KeyAttrNumbers, IndexInfo::ii_NumIndexAttrs, IndexInfo::ii_Predicate, IndexInfo::ii_PredicateState, IndexInfo::ii_ReadyForInserts, IndexInfo::ii_Unique, index_build(), index_check_primary_key(), index_close(), INDEX_CONSTR_CREATE_DEFERRABLE, INDEX_CONSTR_CREATE_INIT_DEFERRED, index_create(), INDEX_CREATE_ADD_CONSTRAINT, INDEX_CREATE_CONCURRENT, INDEX_CREATE_IF_NOT_EXISTS, INDEX_CREATE_IS_PRIMARY, INDEX_CREATE_SET_READY, INDEX_CREATE_SET_VALID, INDEX_CREATE_SKIP_BUILD, INDEX_MAX_KEYS, index_open(), index_reloptions(), index_set_state_flags(), IndexStmt::indexParams, IndexStmt::initdeferred, IsBootstrapProcessingMode, IndexStmt::isconstraint, list_length(), LockRelationIdForSession(), LockInfoData::lockRelId, make_ands_implicit(), makeNode, MyDatabaseTableSpace, NIL, NoLock, NOTICE, ObjectAddressSet, ObjectIdAttributeNumber, OidIsValid, IndexStmt::oldNode, IndexStmt::options, palloc(), pfree(), pg_namespace_aclcheck(), pg_tablespace_aclcheck(), PointerGetDatum, PopActiveSnapshot(), IndexStmt::primary, PROC_IN_VACUUM, PROC_IS_AUTOVACUUM, pull_varattnos(), PushActiveSnapshot(), RelationData::rd_lockInfo, RelationData::rd_rel, RegisterSnapshot(), IndexStmt::relation, RELATION_IS_OTHER_TEMP, RelationGetNamespace, RelationGetRelationName, RelationGetRelid, RelationRelationId, ReleaseSysCache(), LockRelId::relId, RELKIND_FOREIGN_TABLE, RELKIND_MATVIEW, RELKIND_PARTITIONED_TABLE, RELKIND_RELATION, RowExclusiveLock, SearchSysCache1(), SET_LOCKTAG_RELATION, SetInvalidVirtualTransactionId, ShareLock, ShareUpdateExclusiveLock, StartTransactionCommand(), IndexStmt::tableSpace, transformRelOptions(), IndexStmt::unique, UnlockRelationIdForSession(), UnregisterSnapshot(), validate_index(), VirtualTransactionIdEquals, VirtualTransactionIdIsValid, VirtualXactLock(), WaitForLockers(), IndexStmt::whereClause, and SnapshotData::xmin.

Referenced by ATExecAddIndex(), and ProcessUtilitySlow().

316 {
317  char *indexRelationName;
318  char *accessMethodName;
319  Oid *typeObjectId;
320  Oid *collationObjectId;
321  Oid *classObjectId;
322  Oid accessMethodId;
323  Oid namespaceId;
324  Oid tablespaceId;
325  List *indexColNames;
326  Relation rel;
327  Relation indexRelation;
328  HeapTuple tuple;
329  Form_pg_am accessMethodForm;
330  IndexAmRoutine *amRoutine;
331  bool amcanorder;
332  amoptions_function amoptions;
333  Datum reloptions;
334  int16 *coloptions;
335  IndexInfo *indexInfo;
336  bits16 flags;
337  bits16 constr_flags;
338  int numberOfAttributes;
339  TransactionId limitXmin;
340  VirtualTransactionId *old_snapshots;
341  ObjectAddress address;
342  int n_old_snapshots;
343  LockRelId heaprelid;
344  LOCKTAG heaplocktag;
345  LOCKMODE lockmode;
346  Snapshot snapshot;
347  int i;
348 
349  /*
350  * count attributes in index
351  */
352  numberOfAttributes = list_length(stmt->indexParams);
353  if (numberOfAttributes <= 0)
354  ereport(ERROR,
355  (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
356  errmsg("must specify at least one column")));
357  if (numberOfAttributes > INDEX_MAX_KEYS)
358  ereport(ERROR,
359  (errcode(ERRCODE_TOO_MANY_COLUMNS),
360  errmsg("cannot use more than %d columns in an index",
361  INDEX_MAX_KEYS)));
362 
363  /*
364  * Only SELECT ... FOR UPDATE/SHARE are allowed while doing a standard
365  * index build; but for concurrent builds we allow INSERT/UPDATE/DELETE
366  * (but not VACUUM).
367  *
368  * NB: Caller is responsible for making sure that relationId refers to the
369  * relation on which the index should be built; except in bootstrap mode,
370  * this will typically require the caller to have already locked the
371  * relation. To avoid lock upgrade hazards, that lock should be at least
372  * as strong as the one we take here.
373  */
374  lockmode = stmt->concurrent ? ShareUpdateExclusiveLock : ShareLock;
375  rel = heap_open(relationId, lockmode);
376 
377  relationId = RelationGetRelid(rel);
378  namespaceId = RelationGetNamespace(rel);
379 
380  /* Ensure that it makes sense to index this kind of relation */
381  switch (rel->rd_rel->relkind)
382  {
383  case RELKIND_RELATION:
384  case RELKIND_MATVIEW:
385  /* OK */
386  break;
388  ereport(ERROR,
389  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
390  errmsg("cannot create index on foreign table \"%s\"",
391  RelationGetRelationName(rel))));
393  ereport(ERROR,
394  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
395  errmsg("cannot create index on partitioned table \"%s\"",
396  RelationGetRelationName(rel))));
397  default:
398  ereport(ERROR,
399  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
400  errmsg("\"%s\" is not a table or materialized view",
401  RelationGetRelationName(rel))));
402  }
403 
404  /*
405  * Don't try to CREATE INDEX on temp tables of other backends.
406  */
407  if (RELATION_IS_OTHER_TEMP(rel))
408  ereport(ERROR,
409  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
410  errmsg("cannot create indexes on temporary tables of other sessions")));
411 
412  /*
413  * Unless our caller vouches for having checked this already, insist that
414  * the table not be in use by our own session, either. Otherwise we might
415  * fail to make entries in the new index (for instance, if an INSERT or
416  * UPDATE is in progress and has already made its list of target indexes).
417  */
418  if (check_not_in_use)
419  CheckTableNotInUse(rel, "CREATE INDEX");
420 
421  /*
422  * Verify we (still) have CREATE rights in the rel's namespace.
423  * (Presumably we did when the rel was created, but maybe not anymore.)
424  * Skip check if caller doesn't want it. Also skip check if
425  * bootstrapping, since permissions machinery may not be working yet.
426  */
427  if (check_rights && !IsBootstrapProcessingMode())
428  {
429  AclResult aclresult;
430 
431  aclresult = pg_namespace_aclcheck(namespaceId, GetUserId(),
432  ACL_CREATE);
433  if (aclresult != ACLCHECK_OK)
435  get_namespace_name(namespaceId));
436  }
437 
438  /*
439  * Select tablespace to use. If not specified, use default tablespace
440  * (which may in turn default to database's default).
441  */
442  if (stmt->tableSpace)
443  {
444  tablespaceId = get_tablespace_oid(stmt->tableSpace, false);
445  }
446  else
447  {
448  tablespaceId = GetDefaultTablespace(rel->rd_rel->relpersistence);
449  /* note InvalidOid is OK in this case */
450  }
451 
452  /* Check tablespace permissions */
453  if (check_rights &&
454  OidIsValid(tablespaceId) && tablespaceId != MyDatabaseTableSpace)
455  {
456  AclResult aclresult;
457 
458  aclresult = pg_tablespace_aclcheck(tablespaceId, GetUserId(),
459  ACL_CREATE);
460  if (aclresult != ACLCHECK_OK)
462  get_tablespace_name(tablespaceId));
463  }
464 
465  /*
466  * Force shared indexes into the pg_global tablespace. This is a bit of a
467  * hack but seems simpler than marking them in the BKI commands. On the
468  * other hand, if it's not shared, don't allow it to be placed there.
469  */
470  if (rel->rd_rel->relisshared)
471  tablespaceId = GLOBALTABLESPACE_OID;
472  else if (tablespaceId == GLOBALTABLESPACE_OID)
473  ereport(ERROR,
474  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
475  errmsg("only shared relations can be placed in pg_global tablespace")));
476 
477  /*
478  * Choose the index column names.
479  */
480  indexColNames = ChooseIndexColumnNames(stmt->indexParams);
481 
482  /*
483  * Select name for index if caller didn't specify
484  */
485  indexRelationName = stmt->idxname;
486  if (indexRelationName == NULL)
487  indexRelationName = ChooseIndexName(RelationGetRelationName(rel),
488  namespaceId,
489  indexColNames,
490  stmt->excludeOpNames,
491  stmt->primary,
492  stmt->isconstraint);
493 
494  /*
495  * look up the access method, verify it can handle the requested features
496  */
497  accessMethodName = stmt->accessMethod;
498  tuple = SearchSysCache1(AMNAME, PointerGetDatum(accessMethodName));
499  if (!HeapTupleIsValid(tuple))
500  {
501  /*
502  * Hack to provide more-or-less-transparent updating of old RTREE
503  * indexes to GiST: if RTREE is requested and not found, use GIST.
504  */
505  if (strcmp(accessMethodName, "rtree") == 0)
506  {
507  ereport(NOTICE,
508  (errmsg("substituting access method \"gist\" for obsolete method \"rtree\"")));
509  accessMethodName = "gist";
510  tuple = SearchSysCache1(AMNAME, PointerGetDatum(accessMethodName));
511  }
512 
513  if (!HeapTupleIsValid(tuple))
514  ereport(ERROR,
515  (errcode(ERRCODE_UNDEFINED_OBJECT),
516  errmsg("access method \"%s\" does not exist",
517  accessMethodName)));
518  }
519  accessMethodId = HeapTupleGetOid(tuple);
520  accessMethodForm = (Form_pg_am) GETSTRUCT(tuple);
521  amRoutine = GetIndexAmRoutine(accessMethodForm->amhandler);
522 
523  if (stmt->unique && !amRoutine->amcanunique)
524  ereport(ERROR,
525  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
526  errmsg("access method \"%s\" does not support unique indexes",
527  accessMethodName)));
528  if (numberOfAttributes > 1 && !amRoutine->amcanmulticol)
529  ereport(ERROR,
530  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
531  errmsg("access method \"%s\" does not support multicolumn indexes",
532  accessMethodName)));
533  if (stmt->excludeOpNames && amRoutine->amgettuple == NULL)
534  ereport(ERROR,
535  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
536  errmsg("access method \"%s\" does not support exclusion constraints",
537  accessMethodName)));
538 
539  amcanorder = amRoutine->amcanorder;
540  amoptions = amRoutine->amoptions;
541 
542  pfree(amRoutine);
543  ReleaseSysCache(tuple);
544 
545  /*
546  * Validate predicate, if given
547  */
548  if (stmt->whereClause)
549  CheckPredicate((Expr *) stmt->whereClause);
550 
551  /*
552  * Parse AM-specific options, convert to text array form, validate.
553  */
554  reloptions = transformRelOptions((Datum) 0, stmt->options,
555  NULL, NULL, false, false);
556 
557  (void) index_reloptions(amoptions, reloptions, true);
558 
559  /*
560  * Prepare arguments for index_create, primarily an IndexInfo structure.
561  * Note that ii_Predicate must be in implicit-AND format.
562  */
563  indexInfo = makeNode(IndexInfo);
564  indexInfo->ii_NumIndexAttrs = numberOfAttributes;
565  indexInfo->ii_Expressions = NIL; /* for now */
566  indexInfo->ii_ExpressionsState = NIL;
567  indexInfo->ii_Predicate = make_ands_implicit((Expr *) stmt->whereClause);
568  indexInfo->ii_PredicateState = NULL;
569  indexInfo->ii_ExclusionOps = NULL;
570  indexInfo->ii_ExclusionProcs = NULL;
571  indexInfo->ii_ExclusionStrats = NULL;
572  indexInfo->ii_Unique = stmt->unique;
573  /* In a concurrent build, mark it not-ready-for-inserts */
574  indexInfo->ii_ReadyForInserts = !stmt->concurrent;
575  indexInfo->ii_Concurrent = stmt->concurrent;
576  indexInfo->ii_BrokenHotChain = false;
577  indexInfo->ii_AmCache = NULL;
578  indexInfo->ii_Context = CurrentMemoryContext;
579 
580  typeObjectId = (Oid *) palloc(numberOfAttributes * sizeof(Oid));
581  collationObjectId = (Oid *) palloc(numberOfAttributes * sizeof(Oid));
582  classObjectId = (Oid *) palloc(numberOfAttributes * sizeof(Oid));
583  coloptions = (int16 *) palloc(numberOfAttributes * sizeof(int16));
584  ComputeIndexAttrs(indexInfo,
585  typeObjectId, collationObjectId, classObjectId,
586  coloptions, stmt->indexParams,
587  stmt->excludeOpNames, relationId,
588  accessMethodName, accessMethodId,
589  amcanorder, stmt->isconstraint);
590 
591  /*
592  * Extra checks when creating a PRIMARY KEY index.
593  */
594  if (stmt->primary)
595  index_check_primary_key(rel, indexInfo, is_alter_table);
596 
597  /*
598  * We disallow indexes on system columns other than OID. They would not
599  * necessarily get updated correctly, and they don't seem useful anyway.
600  */
601  for (i = 0; i < indexInfo->ii_NumIndexAttrs; i++)
602  {
603  AttrNumber attno = indexInfo->ii_KeyAttrNumbers[i];
604 
605  if (attno < 0 && attno != ObjectIdAttributeNumber)
606  ereport(ERROR,
607  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
608  errmsg("index creation on system columns is not supported")));
609  }
610 
611  /*
612  * Also check for system columns used in expressions or predicates.
613  */
614  if (indexInfo->ii_Expressions || indexInfo->ii_Predicate)
615  {
616  Bitmapset *indexattrs = NULL;
617 
618  pull_varattnos((Node *) indexInfo->ii_Expressions, 1, &indexattrs);
619  pull_varattnos((Node *) indexInfo->ii_Predicate, 1, &indexattrs);
620 
621  for (i = FirstLowInvalidHeapAttributeNumber + 1; i < 0; i++)
622  {
623  if (i != ObjectIdAttributeNumber &&
625  indexattrs))
626  ereport(ERROR,
627  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
628  errmsg("index creation on system columns is not supported")));
629  }
630  }
631 
632  /*
633  * Report index creation if appropriate (delay this till after most of the
634  * error checks)
635  */
636  if (stmt->isconstraint && !quiet)
637  {
638  const char *constraint_type;
639 
640  if (stmt->primary)
641  constraint_type = "PRIMARY KEY";
642  else if (stmt->unique)
643  constraint_type = "UNIQUE";
644  else if (stmt->excludeOpNames != NIL)
645  constraint_type = "EXCLUDE";
646  else
647  {
648  elog(ERROR, "unknown constraint type");
649  constraint_type = NULL; /* keep compiler quiet */
650  }
651 
652  ereport(DEBUG1,
653  (errmsg("%s %s will create implicit index \"%s\" for table \"%s\"",
654  is_alter_table ? "ALTER TABLE / ADD" : "CREATE TABLE /",
655  constraint_type,
656  indexRelationName, RelationGetRelationName(rel))));
657  }
658 
659  /*
660  * A valid stmt->oldNode implies that we already have a built form of the
661  * index. The caller should also decline any index build.
662  */
663  Assert(!OidIsValid(stmt->oldNode) || (skip_build && !stmt->concurrent));
664 
665  /*
666  * Make the catalog entries for the index, including constraints. This
667  * step also actually builds the index, except if caller requested not to
668  * or in concurrent mode, in which case it'll be done later.
669  */
670  flags = constr_flags = 0;
671  if (stmt->isconstraint)
673  if (skip_build || stmt->concurrent)
674  flags |= INDEX_CREATE_SKIP_BUILD;
675  if (stmt->if_not_exists)
677  if (stmt->concurrent)
678  flags |= INDEX_CREATE_CONCURRENT;
679  if (stmt->primary)
680  flags |= INDEX_CREATE_IS_PRIMARY;
681 
682  if (stmt->deferrable)
683  constr_flags |= INDEX_CONSTR_CREATE_DEFERRABLE;
684  if (stmt->initdeferred)
685  constr_flags |= INDEX_CONSTR_CREATE_INIT_DEFERRED;
686 
687  indexRelationId =
688  index_create(rel, indexRelationName, indexRelationId, stmt->oldNode,
689  indexInfo, indexColNames,
690  accessMethodId, tablespaceId,
691  collationObjectId, classObjectId,
692  coloptions, reloptions,
693  flags, constr_flags,
694  allowSystemTableMods, !check_rights);
695 
696  ObjectAddressSet(address, RelationRelationId, indexRelationId);
697 
698  if (!OidIsValid(indexRelationId))
699  {
700  heap_close(rel, NoLock);
701  return address;
702  }
703 
704  /* Add any requested comment */
705  if (stmt->idxcomment != NULL)
706  CreateComments(indexRelationId, RelationRelationId, 0,
707  stmt->idxcomment);
708 
709  if (!stmt->concurrent)
710  {
711  /* Close the heap and we're done, in the non-concurrent case */
712  heap_close(rel, NoLock);
713  return address;
714  }
715 
716  /* save lockrelid and locktag for below, then close rel */
717  heaprelid = rel->rd_lockInfo.lockRelId;
718  SET_LOCKTAG_RELATION(heaplocktag, heaprelid.dbId, heaprelid.relId);
719  heap_close(rel, NoLock);
720 
721  /*
722  * For a concurrent build, it's important to make the catalog entries
723  * visible to other transactions before we start to build the index. That
724  * will prevent them from making incompatible HOT updates. The new index
725  * will be marked not indisready and not indisvalid, so that no one else
726  * tries to either insert into it or use it for queries.
727  *
728  * We must commit our current transaction so that the index becomes
729  * visible; then start another. Note that all the data structures we just
730  * built are lost in the commit. The only data we keep past here are the
731  * relation IDs.
732  *
733  * Before committing, get a session-level lock on the table, to ensure
734  * that neither it nor the index can be dropped before we finish. This
735  * cannot block, even if someone else is waiting for access, because we
736  * already have the same lock within our transaction.
737  *
738  * Note: we don't currently bother with a session lock on the index,
739  * because there are no operations that could change its state while we
740  * hold lock on the parent table. This might need to change later.
741  */
743 
747 
748  /*
749  * Phase 2 of concurrent index build (see comments for validate_index()
750  * for an overview of how this works)
751  *
752  * Now we must wait until no running transaction could have the table open
753  * with the old list of indexes. Use ShareLock to consider running
754  * transactions that hold locks that permit writing to the table. Note we
755  * do not need to worry about xacts that open the table for writing after
756  * this point; they will see the new index when they open it.
757  *
758  * Note: the reason we use actual lock acquisition here, rather than just
759  * checking the ProcArray and sleeping, is that deadlock is possible if
760  * one of the transactions in question is blocked trying to acquire an
761  * exclusive lock on our table. The lock code will detect deadlock and
762  * error out properly.
763  */
764  WaitForLockers(heaplocktag, ShareLock);
765 
766  /*
767  * At this moment we are sure that there are no transactions with the
768  * table open for write that don't have this new index in their list of
769  * indexes. We have waited out all the existing transactions and any new
770  * transaction will have the new index in its list, but the index is still
771  * marked as "not-ready-for-inserts". The index is consulted while
772  * deciding HOT-safety though. This arrangement ensures that no new HOT
773  * chains can be created where the new tuple and the old tuple in the
774  * chain have different index keys.
775  *
776  * We now take a new snapshot, and build the index using all tuples that
777  * are visible in this snapshot. We can be sure that any HOT updates to
778  * these tuples will be compatible with the index, since any updates made
779  * by transactions that didn't know about the index are now committed or
780  * rolled back. Thus, each visible tuple is either the end of its
781  * HOT-chain or the extension of the chain is HOT-safe for this index.
782  */
783 
784  /* Open and lock the parent heap relation */
786 
787  /* And the target index relation */
788  indexRelation = index_open(indexRelationId, RowExclusiveLock);
789 
790  /* Set ActiveSnapshot since functions in the indexes may need it */
792 
793  /* We have to re-build the IndexInfo struct, since it was lost in commit */
794  indexInfo = BuildIndexInfo(indexRelation);
795  Assert(!indexInfo->ii_ReadyForInserts);
796  indexInfo->ii_Concurrent = true;
797  indexInfo->ii_BrokenHotChain = false;
798 
799  /* Now build the index */
800  index_build(rel, indexRelation, indexInfo, stmt->primary, false);
801 
802  /* Close both the relations, but keep the locks */
803  heap_close(rel, NoLock);
804  index_close(indexRelation, NoLock);
805 
806  /*
807  * Update the pg_index row to mark the index as ready for inserts. Once we
808  * commit this transaction, any new transactions that open the table must
809  * insert new entries into the index for insertions and non-HOT updates.
810  */
812 
813  /* we can do away with our snapshot */
815 
816  /*
817  * Commit this transaction to make the indisready update visible.
818  */
821 
822  /*
823  * Phase 3 of concurrent index build
824  *
825  * We once again wait until no transaction can have the table open with
826  * the index marked as read-only for updates.
827  */
828  WaitForLockers(heaplocktag, ShareLock);
829 
830  /*
831  * Now take the "reference snapshot" that will be used by validate_index()
832  * to filter candidate tuples. Beware! There might still be snapshots in
833  * use that treat some transaction as in-progress that our reference
834  * snapshot treats as committed. If such a recently-committed transaction
835  * deleted tuples in the table, we will not include them in the index; yet
836  * those transactions which see the deleting one as still-in-progress will
837  * expect such tuples to be there once we mark the index as valid.
838  *
839  * We solve this by waiting for all endangered transactions to exit before
840  * we mark the index as valid.
841  *
842  * We also set ActiveSnapshot to this snap, since functions in indexes may
843  * need a snapshot.
844  */
846  PushActiveSnapshot(snapshot);
847 
848  /*
849  * Scan the index and the heap, insert any missing index entries.
850  */
851  validate_index(relationId, indexRelationId, snapshot);
852 
853  /*
854  * Drop the reference snapshot. We must do this before waiting out other
855  * snapshot holders, else we will deadlock against other processes also
856  * doing CREATE INDEX CONCURRENTLY, which would see our snapshot as one
857  * they must wait for. But first, save the snapshot's xmin to use as
858  * limitXmin for GetCurrentVirtualXIDs().
859  */
860  limitXmin = snapshot->xmin;
861 
863  UnregisterSnapshot(snapshot);
864 
865  /*
866  * The index is now valid in the sense that it contains all currently
867  * interesting tuples. But since it might not contain tuples deleted just
868  * before the reference snap was taken, we have to wait out any
869  * transactions that might have older snapshots. Obtain a list of VXIDs
870  * of such transactions, and wait for them individually.
871  *
872  * We can exclude any running transactions that have xmin > the xmin of
873  * our reference snapshot; their oldest snapshot must be newer than ours.
874  * We can also exclude any transactions that have xmin = zero, since they
875  * evidently have no live snapshot at all (and any one they might be in
876  * process of taking is certainly newer than ours). Transactions in other
877  * DBs can be ignored too, since they'll never even be able to see this
878  * index.
879  *
880  * We can also exclude autovacuum processes and processes running manual
881  * lazy VACUUMs, because they won't be fazed by missing index entries
882  * either. (Manual ANALYZEs, however, can't be excluded because they
883  * might be within transactions that are going to do arbitrary operations
884  * later.)
885  *
886  * Also, GetCurrentVirtualXIDs never reports our own vxid, so we need not
887  * check for that.
888  *
889  * If a process goes idle-in-transaction with xmin zero, we do not need to
890  * wait for it anymore, per the above argument. We do not have the
891  * infrastructure right now to stop waiting if that happens, but we can at
892  * least avoid the folly of waiting when it is idle at the time we would
893  * begin to wait. We do this by repeatedly rechecking the output of
894  * GetCurrentVirtualXIDs. If, during any iteration, a particular vxid
895  * doesn't show up in the output, we know we can forget about it.
896  */
897  old_snapshots = GetCurrentVirtualXIDs(limitXmin, true, false,
899  &n_old_snapshots);
900 
901  for (i = 0; i < n_old_snapshots; i++)
902  {
903  if (!VirtualTransactionIdIsValid(old_snapshots[i]))
904  continue; /* found uninteresting in previous cycle */
905 
906  if (i > 0)
907  {
908  /* see if anything's changed ... */
909  VirtualTransactionId *newer_snapshots;
910  int n_newer_snapshots;
911  int j;
912  int k;
913 
914  newer_snapshots = GetCurrentVirtualXIDs(limitXmin,
915  true, false,
917  &n_newer_snapshots);
918  for (j = i; j < n_old_snapshots; j++)
919  {
920  if (!VirtualTransactionIdIsValid(old_snapshots[j]))
921  continue; /* found uninteresting in previous cycle */
922  for (k = 0; k < n_newer_snapshots; k++)
923  {
924  if (VirtualTransactionIdEquals(old_snapshots[j],
925  newer_snapshots[k]))
926  break;
927  }
928  if (k >= n_newer_snapshots) /* not there anymore */
929  SetInvalidVirtualTransactionId(old_snapshots[j]);
930  }
931  pfree(newer_snapshots);
932  }
933 
934  if (VirtualTransactionIdIsValid(old_snapshots[i]))
935  VirtualXactLock(old_snapshots[i], true);
936  }
937 
938  /*
939  * Index can now be marked valid -- update its pg_index entry
940  */
942 
943  /*
944  * The pg_index update will cause backends (including this one) to update
945  * relcache entries for the index itself, but we should also send a
946  * relcache inval on the parent table to force replanning of cached plans.
947  * Otherwise existing sessions might fail to use the new index where it
948  * would be useful. (Note that our earlier commits did not create reasons
949  * to replan; so relcache flush on the index itself was sufficient.)
950  */
952 
953  /*
954  * Last thing to do is release the session-level lock on the parent table.
955  */
957 
958  return address;
959 }
bool deferrable
Definition: parsenodes.h:2724
signed short int16
Definition: c.h:283
#define NIL
Definition: pg_list.h:69
bool primary
Definition: parsenodes.h:2722
VirtualTransactionId * GetCurrentVirtualXIDs(TransactionId limitXmin, bool excludeXmin0, bool allDbs, int excludeVacuum, int *nvxids)
Definition: procarray.c:2474
Oid get_tablespace_oid(const char *tablespacename, bool missing_ok)
Definition: tablespace.c:1380
MemoryContext ii_Context
Definition: execnodes.h:152
void CreateComments(Oid oid, Oid classoid, int32 subid, const char *comment)
Definition: comment.c:142
LockRelId lockRelId
Definition: rel.h:44
bool amcanmulticol
Definition: amapi.h:179
AclResult pg_tablespace_aclcheck(Oid spc_oid, Oid roleid, AclMode mode)
Definition: aclchk.c:4554
#define DEBUG1
Definition: elog.h:25
#define GETSTRUCT(TUP)
Definition: htup_details.h:661
List * ii_Predicate
Definition: execnodes.h:139
List * options
Definition: parsenodes.h:2715
uint32 TransactionId
Definition: c.h:445
#define INDEX_CREATE_IF_NOT_EXISTS
Definition: index.h:49
Snapshot RegisterSnapshot(Snapshot snapshot)
Definition: snapmgr.c:863
amgettuple_function amgettuple
Definition: amapi.h:210
int LOCKMODE
Definition: lockdefs.h:26
Oid GetUserId(void)
Definition: miscinit.c:284
#define ObjectIdAttributeNumber
Definition: sysattr.h:22
void index_set_state_flags(Oid indexId, IndexStateFlagsAction action)
Definition: index.c:3205
uint16 bits16
Definition: c.h:304
#define PointerGetDatum(X)
Definition: postgres.h:562
char * tableSpace
Definition: parsenodes.h:2713
ExprState * ii_PredicateState
Definition: execnodes.h:140
void CommitTransactionCommand(void)
Definition: xact.c:2744
#define RelationRelationId
Definition: pg_class.h:29
Oid dbId
Definition: rel.h:39
#define RELKIND_MATVIEW
Definition: pg_class.h:165
Node * whereClause
Definition: parsenodes.h:2716
Definition: lock.h:178
#define GLOBALTABLESPACE_OID
Definition: pg_tablespace.h:64
void index_check_primary_key(Relation heapRel, IndexInfo *indexInfo, bool is_alter_table)
Definition: index.c:195
Definition: nodes.h:512
Oid * ii_ExclusionProcs
Definition: execnodes.h:142
int errcode(int sqlerrcode)
Definition: elog.c:575
#define FirstLowInvalidHeapAttributeNumber
Definition: sysattr.h:28
void PopActiveSnapshot(void)
Definition: snapmgr.c:812
#define heap_close(r, l)
Definition: heapam.h:97
IndexInfo * BuildIndexInfo(Relation index)
Definition: index.c:1645
static List * ChooseIndexColumnNames(List *indexElems)
Definition: indexcmds.c:1708
Form_pg_class rd_rel
Definition: rel.h:114
unsigned int Oid
Definition: postgres_ext.h:31
Snapshot GetTransactionSnapshot(void)
Definition: snapmgr.c:304
#define OidIsValid(objectId)
Definition: c.h:576
AclResult pg_namespace_aclcheck(Oid nsp_oid, Oid roleid, AclMode mode)
Definition: aclchk.c:4542
void pull_varattnos(Node *node, Index varno, Bitmapset **varattnos)
Definition: var.c:219
Datum transformRelOptions(Datum oldOptions, List *defList, const char *namspace, char *validnsps[], bool ignoreOids, bool isReset)
Definition: reloptions.c:755
Oid GetDefaultTablespace(char relpersistence)
Definition: tablespace.c:1111
Oid MyDatabaseTableSpace
Definition: globals.c:79
#define INDEX_CONSTR_CREATE_INIT_DEFERRED
Definition: index.h:70
bool VirtualXactLock(VirtualTransactionId vxid, bool wait)
Definition: lock.c:4291
#define VirtualTransactionIdEquals(vxid1, vxid2)
Definition: lock.h:74
RangeVar * relation
Definition: parsenodes.h:2711
List * ii_ExpressionsState
Definition: execnodes.h:138
void pfree(void *pointer)
Definition: mcxt.c:949
#define PROC_IN_VACUUM
Definition: proc.h:54
List * make_ands_implicit(Expr *clause)
Definition: clauses.c:378
void UnlockRelationIdForSession(LockRelId *relid, LOCKMODE lockmode)
Definition: lmgr.c:312
#define ERROR
Definition: elog.h:43
Definition: rel.h:36
#define ACL_CREATE
Definition: parsenodes.h:82
void LockRelationIdForSession(LockRelId *relid, LOCKMODE lockmode)
Definition: lmgr.c:299
amoptions_function amoptions
Definition: amapi.h:205
IndexAmRoutine * GetIndexAmRoutine(Oid amhandler)
Definition: amapi.c:33
bool amcanunique
Definition: amapi.h:177
#define SET_LOCKTAG_RELATION(locktag, dboid, reloid)
Definition: lock.h:193
char * get_namespace_name(Oid nspid)
Definition: lsyscache.c:3066
#define NoLock
Definition: lockdefs.h:34
LockInfoData rd_lockInfo
Definition: rel.h:117
void PushActiveSnapshot(Snapshot snap)
Definition: snapmgr.c:733
void aclcheck_error(AclResult aclerr, AclObjectKind objectkind, const char *objectname)
Definition: aclchk.c:3457
#define RowExclusiveLock
Definition: lockdefs.h:38
void CacheInvalidateRelcacheByRelid(Oid relid)
Definition: inval.c:1292
#define RelationGetRelationName(relation)
Definition: rel.h:445
bool ii_BrokenHotChain
Definition: execnodes.h:150
#define RELKIND_FOREIGN_TABLE
Definition: pg_class.h:167
TransactionId xmin
Definition: snapshot.h:68
MemoryContext CurrentMemoryContext
Definition: mcxt.c:37
void CheckTableNotInUse(Relation rel, const char *stmt)
Definition: tablecmds.c:3063
bool ii_ReadyForInserts
Definition: execnodes.h:148
#define ereport(elevel, rest)
Definition: elog.h:122
void UnregisterSnapshot(Snapshot snapshot)
Definition: snapmgr.c:905
void * ii_AmCache
Definition: execnodes.h:151
char * idxname
Definition: parsenodes.h:2710
void index_build(Relation heapRelation, Relation indexRelation, IndexInfo *indexInfo, bool isprimary, bool isreindex)
Definition: index.c:2009
#define VirtualTransactionIdIsValid(vxid)
Definition: lock.h:71
void validate_index(Oid heapId, Oid indexId, Snapshot snapshot)
Definition: index.c:2808
HeapTuple SearchSysCache1(int cacheId, Datum key1)
Definition: syscache.c:1112
#define RELKIND_PARTITIONED_TABLE
Definition: pg_class.h:168
bool if_not_exists
Definition: parsenodes.h:2728
AclResult
Definition: acl.h:178
uintptr_t Datum
Definition: postgres.h:372
void ReleaseSysCache(HeapTuple tuple)
Definition: syscache.c:1160
int ii_NumIndexAttrs
Definition: execnodes.h:135
bool unique
Definition: parsenodes.h:2721
Relation heap_open(Oid relationId, LOCKMODE lockmode)
Definition: heapam.c:1290
char * accessMethod
Definition: parsenodes.h:2712
#define INDEX_CREATE_IS_PRIMARY
Definition: index.h:45
void WaitForLockers(LOCKTAG heaplocktag, LOCKMODE lockmode)
Definition: lmgr.c:811
Relation heap_openrv(const RangeVar *relation, LOCKMODE lockmode)
Definition: heapam.c:1318
bool allowSystemTableMods
Definition: globals.c:112
#define INDEX_CREATE_CONCURRENT
Definition: index.h:48
bytea * index_reloptions(amoptions_function amoptions, Datum reloptions, bool validate)
Definition: reloptions.c:1459
#define NOTICE
Definition: elog.h:37
bool ii_Unique
Definition: execnodes.h:147
#define makeNode(_type_)
Definition: nodes.h:560
#define ShareUpdateExclusiveLock
Definition: lockdefs.h:39
#define HeapTupleIsValid(tuple)
Definition: htup.h:77
List * ii_Expressions
Definition: execnodes.h:137
#define Assert(condition)
Definition: c.h:670
Oid index_create(Relation heapRelation, const char *indexRelationName, Oid indexRelationId, Oid relFileNode, IndexInfo *indexInfo, List *indexColNames, Oid accessMethodObjectId, Oid tableSpaceId, Oid *collationObjectId, Oid *classObjectId, int16 *coloptions, Datum reloptions, bits16 flags, bits16 constr_flags, bool allow_system_table_mods, bool is_internal)
Definition: index.c:706
#define RELATION_IS_OTHER_TEMP(relation)
Definition: rel.h:542
void StartTransactionCommand(void)
Definition: xact.c:2673
#define SetInvalidVirtualTransactionId(vxid)
Definition: lock.h:77
List * indexParams
Definition: parsenodes.h:2714
static void CheckPredicate(Expr *predicate)
Definition: indexcmds.c:1001
#define INDEX_MAX_KEYS
List * excludeOpNames
Definition: parsenodes.h:2717
static int list_length(const List *l)
Definition: pg_list.h:89
AttrNumber ii_KeyAttrNumbers[INDEX_MAX_KEYS]
Definition: execnodes.h:136
bool initdeferred
Definition: parsenodes.h:2725
bool amcanorder
Definition: amapi.h:171
char * idxcomment
Definition: parsenodes.h:2718
bool ii_Concurrent
Definition: execnodes.h:149
#define ObjectAddressSet(addr, class_id, object_id)
Definition: objectaddress.h:40
void index_close(Relation relation, LOCKMODE lockmode)
Definition: indexam.c:176
#define IsBootstrapProcessingMode()
Definition: miscadmin.h:367
#define INDEX_CREATE_SKIP_BUILD
Definition: index.h:47
bool concurrent
Definition: parsenodes.h:2727
bool isconstraint
Definition: parsenodes.h:2723
Oid * ii_ExclusionOps
Definition: execnodes.h:141
FormData_pg_am * Form_pg_am
Definition: pg_am.h:46
void * palloc(Size size)
Definition: mcxt.c:848
int errmsg(const char *fmt,...)
Definition: elog.c:797
char * get_tablespace_name(Oid spc_oid)
Definition: tablespace.c:1426
#define ShareLock
Definition: lockdefs.h:41
int i
static void ComputeIndexAttrs(IndexInfo *indexInfo, Oid *typeOidP, Oid *collationOidP, Oid *classOidP, int16 *colOptionP, List *attList, List *exclusionOpNames, Oid relId, const char *accessMethodName, Oid accessMethodId, bool amcanorder, bool isconstraint)
Definition: indexcmds.c:1023
static char * ChooseIndexName(const char *tabname, Oid namespaceId, List *colnames, List *exclusionOpNames, bool primary, bool isconstraint)
Definition: indexcmds.c:1626
bytea *(* amoptions_function)(Datum reloptions, bool validate)
Definition: amapi.h:102
#define elog
Definition: elog.h:219
#define HeapTupleGetOid(tuple)
Definition: htup_details.h:700
uint16 * ii_ExclusionStrats
Definition: execnodes.h:143
#define INDEX_CREATE_ADD_CONSTRAINT
Definition: index.h:46
#define RELKIND_RELATION
Definition: pg_class.h:160
Definition: pg_list.h:45
bool bms_is_member(int x, const Bitmapset *a)
Definition: bitmapset.c:420
int16 AttrNumber
Definition: attnum.h:21
#define RelationGetRelid(relation)
Definition: rel.h:425
#define INDEX_CONSTR_CREATE_DEFERRABLE
Definition: index.h:69
Relation index_open(Oid relationId, LOCKMODE lockmode)
Definition: indexam.c:151
#define PROC_IS_AUTOVACUUM
Definition: proc.h:53
Oid relId
Definition: rel.h:38
#define RelationGetNamespace(relation)
Definition: rel.h:452

◆ GetDefaultOpClass()

Oid GetDefaultOpClass ( Oid  type_id,
Oid  am_id 
)

Definition at line 1407 of file indexcmds.c.

References AccessShareLock, Anum_pg_opclass_opcmethod, BTEqualStrategyNumber, ereport, errcode(), ERRCODE_DUPLICATE_OBJECT, errmsg(), ERROR, format_type_be(), getBaseType(), GETSTRUCT, heap_close, heap_open(), HeapTupleGetOid, HeapTupleIsValid, InvalidOid, IsBinaryCoercible(), IsPreferredType(), ObjectIdGetDatum, OpclassAmNameNspIndexId, OperatorClassRelationId, ScanKeyInit(), systable_beginscan(), systable_endscan(), systable_getnext(), and TypeCategory().

Referenced by ComputePartitionAttrs(), findRangeSubOpclass(), get_opclass(), get_opclass_name(), lookup_type_cache(), ResolveOpClass(), and transformIndexConstraint().

1408 {
1409  Oid result = InvalidOid;
1410  int nexact = 0;
1411  int ncompatible = 0;
1412  int ncompatiblepreferred = 0;
1413  Relation rel;
1414  ScanKeyData skey[1];
1415  SysScanDesc scan;
1416  HeapTuple tup;
1417  TYPCATEGORY tcategory;
1418 
1419  /* If it's a domain, look at the base type instead */
1420  type_id = getBaseType(type_id);
1421 
1422  tcategory = TypeCategory(type_id);
1423 
1424  /*
1425  * We scan through all the opclasses available for the access method,
1426  * looking for one that is marked default and matches the target type
1427  * (either exactly or binary-compatibly, but prefer an exact match).
1428  *
1429  * We could find more than one binary-compatible match. If just one is
1430  * for a preferred type, use that one; otherwise we fail, forcing the user
1431  * to specify which one he wants. (The preferred-type special case is a
1432  * kluge for varchar: it's binary-compatible to both text and bpchar, so
1433  * we need a tiebreaker.) If we find more than one exact match, then
1434  * someone put bogus entries in pg_opclass.
1435  */
1437 
1438  ScanKeyInit(&skey[0],
1440  BTEqualStrategyNumber, F_OIDEQ,
1441  ObjectIdGetDatum(am_id));
1442 
1443  scan = systable_beginscan(rel, OpclassAmNameNspIndexId, true,
1444  NULL, 1, skey);
1445 
1446  while (HeapTupleIsValid(tup = systable_getnext(scan)))
1447  {
1448  Form_pg_opclass opclass = (Form_pg_opclass) GETSTRUCT(tup);
1449 
1450  /* ignore altogether if not a default opclass */
1451  if (!opclass->opcdefault)
1452  continue;
1453  if (opclass->opcintype == type_id)
1454  {
1455  nexact++;
1456  result = HeapTupleGetOid(tup);
1457  }
1458  else if (nexact == 0 &&
1459  IsBinaryCoercible(type_id, opclass->opcintype))
1460  {
1461  if (IsPreferredType(tcategory, opclass->opcintype))
1462  {
1463  ncompatiblepreferred++;
1464  result = HeapTupleGetOid(tup);
1465  }
1466  else if (ncompatiblepreferred == 0)
1467  {
1468  ncompatible++;
1469  result = HeapTupleGetOid(tup);
1470  }
1471  }
1472  }
1473 
1474  systable_endscan(scan);
1475 
1477 
1478  /* raise error if pg_opclass contains inconsistent data */
1479  if (nexact > 1)
1480  ereport(ERROR,
1482  errmsg("there are multiple default operator classes for data type %s",
1483  format_type_be(type_id))));
1484 
1485  if (nexact == 1 ||
1486  ncompatiblepreferred == 1 ||
1487  (ncompatiblepreferred == 0 && ncompatible == 1))
1488  return result;
1489 
1490  return InvalidOid;
1491 }
#define Anum_pg_opclass_opcmethod
Definition: pg_opclass.h:75
void systable_endscan(SysScanDesc sysscan)
Definition: genam.c:499
#define GETSTRUCT(TUP)
Definition: htup_details.h:661
#define AccessShareLock
Definition: lockdefs.h:36
#define OperatorClassRelationId
Definition: pg_opclass.h:49
int errcode(int sqlerrcode)
Definition: elog.c:575
char * format_type_be(Oid type_oid)
Definition: format_type.c:94
#define heap_close(r, l)
Definition: heapam.h:97
unsigned int Oid
Definition: postgres_ext.h:31
SysScanDesc systable_beginscan(Relation heapRelation, Oid indexId, bool indexOK, Snapshot snapshot, int nkeys, ScanKey key)
Definition: genam.c:328
#define OpclassAmNameNspIndexId
Definition: indexing.h:198
bool IsPreferredType(TYPCATEGORY category, Oid type)
char TYPCATEGORY
Definition: parse_coerce.h:21
HeapTuple systable_getnext(SysScanDesc sysscan)
Definition: genam.c:416
#define ObjectIdGetDatum(X)
Definition: postgres.h:513
#define ERROR
Definition: elog.h:43
#define ereport(elevel, rest)
Definition: elog.h:122
bool IsBinaryCoercible(Oid srctype, Oid targettype)
Relation heap_open(Oid relationId, LOCKMODE lockmode)
Definition: heapam.c:1290
#define InvalidOid
Definition: postgres_ext.h:36
TYPCATEGORY TypeCategory(Oid type)
#define HeapTupleIsValid(tuple)
Definition: htup.h:77
int errmsg(const char *fmt,...)
Definition: elog.c:797
void ScanKeyInit(ScanKey entry, AttrNumber attributeNumber, StrategyNumber strategy, RegProcedure procedure, Datum argument)
Definition: scankey.c:76
#define HeapTupleGetOid(tuple)
Definition: htup_details.h:700
Oid getBaseType(Oid typid)
Definition: lsyscache.c:2290
FormData_pg_opclass * Form_pg_opclass
Definition: pg_opclass.h:68
#define ERRCODE_DUPLICATE_OBJECT
Definition: streamutil.c:30
#define BTEqualStrategyNumber
Definition: stratnum.h:31

◆ makeObjectName()

char* makeObjectName ( const char *  name1,
const char *  name2,
const char *  label 
)

Definition at line 1515 of file indexcmds.c.

References Assert, name, NAMEDATALEN, palloc(), and pg_mbcliplen().

Referenced by ChooseConstraintName(), and ChooseRelationName().

1516 {
1517  char *name;
1518  int overhead = 0; /* chars needed for label and underscores */
1519  int availchars; /* chars available for name(s) */
1520  int name1chars; /* chars allocated to name1 */
1521  int name2chars; /* chars allocated to name2 */
1522  int ndx;
1523 
1524  name1chars = strlen(name1);
1525  if (name2)
1526  {
1527  name2chars = strlen(name2);
1528  overhead++; /* allow for separating underscore */
1529  }
1530  else
1531  name2chars = 0;
1532  if (label)
1533  overhead += strlen(label) + 1;
1534 
1535  availchars = NAMEDATALEN - 1 - overhead;
1536  Assert(availchars > 0); /* else caller chose a bad label */
1537 
1538  /*
1539  * If we must truncate, preferentially truncate the longer name. This
1540  * logic could be expressed without a loop, but it's simple and obvious as
1541  * a loop.
1542  */
1543  while (name1chars + name2chars > availchars)
1544  {
1545  if (name1chars > name2chars)
1546  name1chars--;
1547  else
1548  name2chars--;
1549  }
1550 
1551  name1chars = pg_mbcliplen(name1, name1chars, name1chars);
1552  if (name2)
1553  name2chars = pg_mbcliplen(name2, name2chars, name2chars);
1554 
1555  /* Now construct the string using the chosen lengths */
1556  name = palloc(name1chars + name2chars + overhead + 1);
1557  memcpy(name, name1, name1chars);
1558  ndx = name1chars;
1559  if (name2)
1560  {
1561  name[ndx++] = '_';
1562  memcpy(name + ndx, name2, name2chars);
1563  ndx += name2chars;
1564  }
1565  if (label)
1566  {
1567  name[ndx++] = '_';
1568  strcpy(name + ndx, label);
1569  }
1570  else
1571  name[ndx] = '\0';
1572 
1573  return name;
1574 }
#define NAMEDATALEN
int pg_mbcliplen(const char *mbstr, int len, int limit)
Definition: mbutils.c:820
static char * label
Definition: pg_basebackup.c:82
#define Assert(condition)
Definition: c.h:670
const char * name
Definition: encode.c:521
void * palloc(Size size)
Definition: mcxt.c:848

◆ RangeVarCallbackForReindexIndex()

static void RangeVarCallbackForReindexIndex ( const RangeVar relation,
Oid  relId,
Oid  oldRelId,
void *  arg 
)
static

Definition at line 1802 of file indexcmds.c.

References ACL_KIND_CLASS, aclcheck_error(), ACLCHECK_NOT_OWNER, ereport, errcode(), errmsg(), ERROR, get_rel_relkind(), GetUserId(), IndexGetRelation(), InvalidOid, LockRelationOid(), OidIsValid, pg_class_ownercheck(), RELKIND_INDEX, RangeVar::relname, ShareLock, and UnlockRelationOid().

Referenced by ReindexIndex().

1804 {
1805  char relkind;
1806  Oid *heapOid = (Oid *) arg;
1807 
1808  /*
1809  * If we previously locked some other index's heap, and the name we're
1810  * looking up no longer refers to that relation, release the now-useless
1811  * lock.
1812  */
1813  if (relId != oldRelId && OidIsValid(oldRelId))
1814  {
1815  /* lock level here should match reindex_index() heap lock */
1816  UnlockRelationOid(*heapOid, ShareLock);
1817  *heapOid = InvalidOid;
1818  }
1819 
1820  /* If the relation does not exist, there's nothing more to do. */
1821  if (!OidIsValid(relId))
1822  return;
1823 
1824  /*
1825  * If the relation does exist, check whether it's an index. But note that
1826  * the relation might have been dropped between the time we did the name
1827  * lookup and now. In that case, there's nothing to do.
1828  */
1829  relkind = get_rel_relkind(relId);
1830  if (!relkind)
1831  return;
1832  if (relkind != RELKIND_INDEX)
1833  ereport(ERROR,
1834  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
1835  errmsg("\"%s\" is not an index", relation->relname)));
1836 
1837  /* Check permissions */
1838  if (!pg_class_ownercheck(relId, GetUserId()))
1840 
1841  /* Lock heap before index to avoid deadlock. */
1842  if (relId != oldRelId)
1843  {
1844  /*
1845  * Lock level here should match reindex_index() heap lock. If the OID
1846  * isn't valid, it means the index as concurrently dropped, which is
1847  * not a problem for us; just return normally.
1848  */
1849  *heapOid = IndexGetRelation(relId, true);
1850  if (OidIsValid(*heapOid))
1851  LockRelationOid(*heapOid, ShareLock);
1852  }
1853 }
Oid IndexGetRelation(Oid indexId, bool missing_ok)
Definition: index.c:3284
Oid GetUserId(void)
Definition: miscinit.c:284
void UnlockRelationOid(Oid relid, LOCKMODE lockmode)
Definition: lmgr.c:182
char get_rel_relkind(Oid relid)
Definition: lsyscache.c:1820
int errcode(int sqlerrcode)
Definition: elog.c:575
unsigned int Oid
Definition: postgres_ext.h:31
#define OidIsValid(objectId)
Definition: c.h:576
char * relname
Definition: primnodes.h:68
#define ERROR
Definition: elog.h:43
void aclcheck_error(AclResult aclerr, AclObjectKind objectkind, const char *objectname)
Definition: aclchk.c:3457
#define ereport(elevel, rest)
Definition: elog.h:122
#define InvalidOid
Definition: postgres_ext.h:36
bool pg_class_ownercheck(Oid class_oid, Oid roleid)
Definition: aclchk.c:4604
int errmsg(const char *fmt,...)
Definition: elog.c:797
#define ShareLock
Definition: lockdefs.h:41
#define RELKIND_INDEX
Definition: pg_class.h:161
void * arg
void LockRelationOid(Oid relid, LOCKMODE lockmode)
Definition: lmgr.c:105

◆ ReindexIndex()

Oid ReindexIndex ( RangeVar indexRelation,
int  options 
)

Definition at line 1766 of file indexcmds.c.

References AccessExclusiveLock, index_close(), index_open(), InvalidOid, NoLock, RangeVarCallbackForReindexIndex(), RangeVarGetRelidExtended(), RelationData::rd_rel, and reindex_index().

Referenced by standard_ProcessUtility().

1767 {
1768  Oid indOid;
1769  Oid heapOid = InvalidOid;
1770  Relation irel;
1771  char persistence;
1772 
1773  /*
1774  * Find and lock index, and check permissions on table; use callback to
1775  * obtain lock on table first, to avoid deadlock hazard. The lock level
1776  * used here must match the index lock obtained in reindex_index().
1777  */
1778  indOid = RangeVarGetRelidExtended(indexRelation, AccessExclusiveLock,
1779  false, false,
1781  (void *) &heapOid);
1782 
1783  /*
1784  * Obtain the current persistence of the existing index. We already hold
1785  * lock on the index.
1786  */
1787  irel = index_open(indOid, NoLock);
1788  persistence = irel->rd_rel->relpersistence;
1789  index_close(irel, NoLock);
1790 
1791  reindex_index(indOid, false, persistence, options);
1792 
1793  return indOid;
1794 }
Oid RangeVarGetRelidExtended(const RangeVar *relation, LOCKMODE lockmode, bool missing_ok, bool nowait, RangeVarGetRelidCallback callback, void *callback_arg)
Definition: namespace.c:218
Form_pg_class rd_rel
Definition: rel.h:114
unsigned int Oid
Definition: postgres_ext.h:31
#define NoLock
Definition: lockdefs.h:34
static void RangeVarCallbackForReindexIndex(const RangeVar *relation, Oid relId, Oid oldRelId, void *arg)
Definition: indexcmds.c:1802
#define InvalidOid
Definition: postgres_ext.h:36
void reindex_index(Oid indexId, bool skip_constraint_checks, char persistence, int options)
Definition: index.c:3309
void index_close(Relation relation, LOCKMODE lockmode)
Definition: indexam.c:176
#define AccessExclusiveLock
Definition: lockdefs.h:45
Relation index_open(Oid relationId, LOCKMODE lockmode)
Definition: indexam.c:151

◆ ReindexMultipleTables()

void ReindexMultipleTables ( const char *  objectName,
ReindexObjectType  objectKind,
int  options 
)

Definition at line 1888 of file indexcmds.c.

References AccessShareLock, ACL_KIND_DATABASE, ACL_KIND_NAMESPACE, aclcheck_error(), ACLCHECK_NOT_OWNER, ALLOCSET_SMALL_SIZES, AllocSetContextCreate(), Anum_pg_class_relnamespace, Assert, AssertArg, BTEqualStrategyNumber, CommitTransactionCommand(), ereport, errcode(), errmsg(), ERROR, ForwardScanDirection, get_database_name(), get_namespace_name(), get_namespace_oid(), get_rel_name(), get_rel_namespace(), GETSTRUCT, GetTransactionSnapshot(), GetUserId(), heap_beginscan_catalog(), heap_close, heap_endscan(), heap_getnext(), heap_open(), HeapTupleGetOid, INFO, IsSystemClass(), isTempNamespace(), lappend_oid(), lcons_oid(), lfirst_oid, MemoryContextDelete(), MemoryContextSwitchTo(), MyDatabaseId, NIL, ObjectIdGetDatum, pg_database_ownercheck(), pg_namespace_ownercheck(), PopActiveSnapshot(), PortalContext, PushActiveSnapshot(), REINDEX_OBJECT_DATABASE, REINDEX_OBJECT_SCHEMA, REINDEX_OBJECT_SYSTEM, REINDEX_REL_CHECK_CONSTRAINTS, REINDEX_REL_PROCESS_TOAST, reindex_relation(), REINDEXOPT_VERBOSE, RelationRelationId, RELKIND_MATVIEW, RELKIND_RELATION, RELPERSISTENCE_TEMP, ScanKeyInit(), and StartTransactionCommand().

Referenced by standard_ProcessUtility().

1890 {
1891  Oid objectOid;
1892  Relation relationRelation;
1893  HeapScanDesc scan;
1894  ScanKeyData scan_keys[1];
1895  HeapTuple tuple;
1896  MemoryContext private_context;
1897  MemoryContext old;
1898  List *relids = NIL;
1899  ListCell *l;
1900  int num_keys;
1901 
1902  AssertArg(objectName);
1903  Assert(objectKind == REINDEX_OBJECT_SCHEMA ||
1904  objectKind == REINDEX_OBJECT_SYSTEM ||
1905  objectKind == REINDEX_OBJECT_DATABASE);
1906 
1907  /*
1908  * Get OID of object to reindex, being the database currently being used
1909  * by session for a database or for system catalogs, or the schema defined
1910  * by caller. At the same time do permission checks that need different
1911  * processing depending on the object type.
1912  */
1913  if (objectKind == REINDEX_OBJECT_SCHEMA)
1914  {
1915  objectOid = get_namespace_oid(objectName, false);
1916 
1917  if (!pg_namespace_ownercheck(objectOid, GetUserId()))
1919  objectName);
1920  }
1921  else
1922  {
1923  objectOid = MyDatabaseId;
1924 
1925  if (strcmp(objectName, get_database_name(objectOid)) != 0)
1926  ereport(ERROR,
1927  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1928  errmsg("can only reindex the currently open database")));
1929  if (!pg_database_ownercheck(objectOid, GetUserId()))
1931  objectName);
1932  }
1933 
1934  /*
1935  * Create a memory context that will survive forced transaction commits we
1936  * do below. Since it is a child of PortalContext, it will go away
1937  * eventually even if we suffer an error; there's no need for special
1938  * abort cleanup logic.
1939  */
1940  private_context = AllocSetContextCreate(PortalContext,
1941  "ReindexMultipleTables",
1943 
1944  /*
1945  * Define the search keys to find the objects to reindex. For a schema, we
1946  * select target relations using relnamespace, something not necessary for
1947  * a database-wide operation.
1948  */
1949  if (objectKind == REINDEX_OBJECT_SCHEMA)
1950  {
1951  num_keys = 1;
1952  ScanKeyInit(&scan_keys[0],
1954  BTEqualStrategyNumber, F_OIDEQ,
1955  ObjectIdGetDatum(objectOid));
1956  }
1957  else
1958  num_keys = 0;
1959 
1960  /*
1961  * Scan pg_class to build a list of the relations we need to reindex.
1962  *
1963  * We only consider plain relations and materialized views here (toast
1964  * rels will be processed indirectly by reindex_relation).
1965  */
1966  relationRelation = heap_open(RelationRelationId, AccessShareLock);
1967  scan = heap_beginscan_catalog(relationRelation, num_keys, scan_keys);
1968  while ((tuple = heap_getnext(scan, ForwardScanDirection)) != NULL)
1969  {
1970  Form_pg_class classtuple = (Form_pg_class) GETSTRUCT(tuple);
1971  Oid relid = HeapTupleGetOid(tuple);
1972 
1973  /*
1974  * Only regular tables and matviews can have indexes, so ignore any
1975  * other kind of relation.
1976  */
1977  if (classtuple->relkind != RELKIND_RELATION &&
1978  classtuple->relkind != RELKIND_MATVIEW)
1979  continue;
1980 
1981  /* Skip temp tables of other backends; we can't reindex them at all */
1982  if (classtuple->relpersistence == RELPERSISTENCE_TEMP &&
1983  !isTempNamespace(classtuple->relnamespace))
1984  continue;
1985 
1986  /* Check user/system classification, and optionally skip */
1987  if (objectKind == REINDEX_OBJECT_SYSTEM &&
1988  !IsSystemClass(relid, classtuple))
1989  continue;
1990 
1991  /* Save the list of relation OIDs in private context */
1992  old = MemoryContextSwitchTo(private_context);
1993 
1994  /*
1995  * We always want to reindex pg_class first if it's selected to be
1996  * reindexed. This ensures that if there is any corruption in
1997  * pg_class' indexes, they will be fixed before we process any other
1998  * tables. This is critical because reindexing itself will try to
1999  * update pg_class.
2000  */
2001  if (relid == RelationRelationId)
2002  relids = lcons_oid(relid, relids);
2003  else
2004  relids = lappend_oid(relids, relid);
2005 
2006  MemoryContextSwitchTo(old);
2007  }
2008  heap_endscan(scan);
2009  heap_close(relationRelation, AccessShareLock);
2010 
2011  /* Now reindex each rel in a separate transaction */
2014  foreach(l, relids)
2015  {
2016  Oid relid = lfirst_oid(l);
2017 
2019  /* functions in indexes may want a snapshot set */
2021  if (reindex_relation(relid,
2024  options))
2025 
2027  ereport(INFO,
2028  (errmsg("table \"%s.%s\" was reindexed",
2030  get_rel_name(relid))));
2033  }
2035 
2036  MemoryContextDelete(private_context);
2037 }
#define NIL
Definition: pg_list.h:69
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:200
Oid get_namespace_oid(const char *nspname, bool missing_ok)
Definition: namespace.c:3005
#define GETSTRUCT(TUP)
Definition: htup_details.h:661
void heap_endscan(HeapScanDesc scan)
Definition: heapam.c:1565
Oid GetUserId(void)
Definition: miscinit.c:284
void CommitTransactionCommand(void)
Definition: xact.c:2744
#define RelationRelationId
Definition: pg_class.h:29
#define ALLOCSET_SMALL_SIZES
Definition: memutils.h:180
Oid get_rel_namespace(Oid relid)
Definition: lsyscache.c:1769
#define RELKIND_MATVIEW
Definition: pg_class.h:165
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
#define AccessShareLock
Definition: lockdefs.h:36
int errcode(int sqlerrcode)
Definition: elog.c:575
#define INFO
Definition: elog.h:33
void PopActiveSnapshot(void)
Definition: snapmgr.c:812
bool pg_namespace_ownercheck(Oid nsp_oid, Oid roleid)
Definition: aclchk.c:4780
List * lcons_oid(Oid datum, List *list)
Definition: list.c:295
#define heap_close(r, l)
Definition: heapam.h:97
unsigned int Oid
Definition: postgres_ext.h:31
List * lappend_oid(List *list, Oid datum)
Definition: list.c:164
Snapshot GetTransactionSnapshot(void)
Definition: snapmgr.c:304
#define Anum_pg_class_relnamespace
Definition: pg_class.h:104
#define REINDEXOPT_VERBOSE
Definition: parsenodes.h:3253
bool IsSystemClass(Oid relid, Form_pg_class reltuple)
Definition: catalog.c:75
MemoryContext PortalContext
Definition: mcxt.c:52
#define ObjectIdGetDatum(X)
Definition: postgres.h:513
#define ERROR
Definition: elog.h:43
char * get_database_name(Oid dbid)
Definition: dbcommands.c:2056
char * get_namespace_name(Oid nspid)
Definition: lsyscache.c:3066
void PushActiveSnapshot(Snapshot snap)
Definition: snapmgr.c:733
void aclcheck_error(AclResult aclerr, AclObjectKind objectkind, const char *objectname)
Definition: aclchk.c:3457
bool isTempNamespace(Oid namespaceId)
Definition: namespace.c:3118
HeapScanDesc heap_beginscan_catalog(Relation relation, int nkeys, ScanKey key)
Definition: heapam.c:1405
#define ereport(elevel, rest)
Definition: elog.h:122
#define AssertArg(condition)
Definition: c.h:672
bool pg_database_ownercheck(Oid db_oid, Oid roleid)
Definition: aclchk.c:5022
MemoryContext AllocSetContextCreate(MemoryContext parent, const char *name, Size minContextSize, Size initBlockSize, Size maxBlockSize)
Definition: aset.c:342
Oid MyDatabaseId
Definition: globals.c:77
HeapTuple heap_getnext(HeapScanDesc scan, ScanDirection direction)
Definition: heapam.c:1808
Relation heap_open(Oid relationId, LOCKMODE lockmode)
Definition: heapam.c:1290
#define Assert(condition)
Definition: c.h:670
void StartTransactionCommand(void)
Definition: xact.c:2673
#define REINDEX_REL_CHECK_CONSTRAINTS
Definition: index.h:127
FormData_pg_class * Form_pg_class
Definition: pg_class.h:95
int errmsg(const char *fmt,...)
Definition: elog.c:797
void ScanKeyInit(ScanKey entry, AttrNumber attributeNumber, StrategyNumber strategy, RegProcedure procedure, Datum argument)
Definition: scankey.c:76
#define REINDEX_REL_PROCESS_TOAST
Definition: index.h:125
#define HeapTupleGetOid(tuple)
Definition: htup_details.h:700
#define RELPERSISTENCE_TEMP
Definition: pg_class.h:172
#define RELKIND_RELATION
Definition: pg_class.h:160
bool reindex_relation(Oid relid, int flags, int options)
Definition: index.c:3518
Definition: pg_list.h:45
char * get_rel_name(Oid relid)
Definition: lsyscache.c:1745
#define BTEqualStrategyNumber
Definition: stratnum.h:31
#define lfirst_oid(lc)
Definition: pg_list.h:108

◆ ReindexTable()

Oid ReindexTable ( RangeVar relation,
int  options 
)

Definition at line 1860 of file indexcmds.c.

References ereport, errmsg(), NOTICE, RangeVarCallbackOwnsTable(), RangeVarGetRelidExtended(), REINDEX_REL_CHECK_CONSTRAINTS, REINDEX_REL_PROCESS_TOAST, reindex_relation(), RangeVar::relname, and ShareLock.

Referenced by standard_ProcessUtility().

1861 {
1862  Oid heapOid;
1863 
1864  /* The lock level used here should match reindex_relation(). */
1865  heapOid = RangeVarGetRelidExtended(relation, ShareLock, false, false,
1867 
1868  if (!reindex_relation(heapOid,
1871  options))
1872  ereport(NOTICE,
1873  (errmsg("table \"%s\" has no indexes",
1874  relation->relname)));
1875 
1876  return heapOid;
1877 }
void RangeVarCallbackOwnsTable(const RangeVar *relation, Oid relId, Oid oldRelId, void *arg)
Definition: tablecmds.c:13138
Oid RangeVarGetRelidExtended(const RangeVar *relation, LOCKMODE lockmode, bool missing_ok, bool nowait, RangeVarGetRelidCallback callback, void *callback_arg)
Definition: namespace.c:218
unsigned int Oid
Definition: postgres_ext.h:31
char * relname
Definition: primnodes.h:68
#define ereport(elevel, rest)
Definition: elog.h:122
#define NOTICE
Definition: elog.h:37
#define REINDEX_REL_CHECK_CONSTRAINTS
Definition: index.h:127
int errmsg(const char *fmt,...)
Definition: elog.c:797
#define ShareLock
Definition: lockdefs.h:41
#define REINDEX_REL_PROCESS_TOAST
Definition: index.h:125
bool reindex_relation(Oid relid, int flags, int options)
Definition: index.c:3518

◆ ResolveOpClass()

Oid ResolveOpClass ( List opclass,
Oid  attrType,
const char *  accessMethodName,
Oid  accessMethodId 
)

Definition at line 1296 of file indexcmds.c.

References CLAAMNAMENSP, CLAOID, DeconstructQualifiedName(), ereport, errcode(), errhint(), errmsg(), ERROR, format_type_be(), GetDefaultOpClass(), GETSTRUCT, HeapTupleGetOid, HeapTupleIsValid, IsBinaryCoercible(), linitial, list_length(), LookupExplicitNamespace(), NameListToString(), NIL, ObjectIdGetDatum, OidIsValid, OpclassnameGetOpcid(), PointerGetDatum, ReleaseSysCache(), SearchSysCache1(), SearchSysCache3(), and strVal.

Referenced by ComputeIndexAttrs(), and ComputePartitionAttrs().

1298 {
1299  char *schemaname;
1300  char *opcname;
1301  HeapTuple tuple;
1302  Oid opClassId,
1303  opInputType;
1304 
1305  /*
1306  * Release 7.0 removed network_ops, timespan_ops, and datetime_ops, so we
1307  * ignore those opclass names so the default *_ops is used. This can be
1308  * removed in some later release. bjm 2000/02/07
1309  *
1310  * Release 7.1 removes lztext_ops, so suppress that too for a while. tgl
1311  * 2000/07/30
1312  *
1313  * Release 7.2 renames timestamp_ops to timestamptz_ops, so suppress that
1314  * too for awhile. I'm starting to think we need a better approach. tgl
1315  * 2000/10/01
1316  *
1317  * Release 8.0 removes bigbox_ops (which was dead code for a long while
1318  * anyway). tgl 2003/11/11
1319  */
1320  if (list_length(opclass) == 1)
1321  {
1322  char *claname = strVal(linitial(opclass));
1323 
1324  if (strcmp(claname, "network_ops") == 0 ||
1325  strcmp(claname, "timespan_ops") == 0 ||
1326  strcmp(claname, "datetime_ops") == 0 ||
1327  strcmp(claname, "lztext_ops") == 0 ||
1328  strcmp(claname, "timestamp_ops") == 0 ||
1329  strcmp(claname, "bigbox_ops") == 0)
1330  opclass = NIL;
1331  }
1332 
1333  if (opclass == NIL)
1334  {
1335  /* no operator class specified, so find the default */
1336  opClassId = GetDefaultOpClass(attrType, accessMethodId);
1337  if (!OidIsValid(opClassId))
1338  ereport(ERROR,
1339  (errcode(ERRCODE_UNDEFINED_OBJECT),
1340  errmsg("data type %s has no default operator class for access method \"%s\"",
1341  format_type_be(attrType), accessMethodName),
1342  errhint("You must specify an operator class for the index or define a default operator class for the data type.")));
1343  return opClassId;
1344  }
1345 
1346  /*
1347  * Specific opclass name given, so look up the opclass.
1348  */
1349 
1350  /* deconstruct the name list */
1351  DeconstructQualifiedName(opclass, &schemaname, &opcname);
1352 
1353  if (schemaname)
1354  {
1355  /* Look in specific schema only */
1356  Oid namespaceId;
1357 
1358  namespaceId = LookupExplicitNamespace(schemaname, false);
1359  tuple = SearchSysCache3(CLAAMNAMENSP,
1360  ObjectIdGetDatum(accessMethodId),
1361  PointerGetDatum(opcname),
1362  ObjectIdGetDatum(namespaceId));
1363  }
1364  else
1365  {
1366  /* Unqualified opclass name, so search the search path */
1367  opClassId = OpclassnameGetOpcid(accessMethodId, opcname);
1368  if (!OidIsValid(opClassId))
1369  ereport(ERROR,
1370  (errcode(ERRCODE_UNDEFINED_OBJECT),
1371  errmsg("operator class \"%s\" does not exist for access method \"%s\"",
1372  opcname, accessMethodName)));
1373  tuple = SearchSysCache1(CLAOID, ObjectIdGetDatum(opClassId));
1374  }
1375 
1376  if (!HeapTupleIsValid(tuple))
1377  ereport(ERROR,
1378  (errcode(ERRCODE_UNDEFINED_OBJECT),
1379  errmsg("operator class \"%s\" does not exist for access method \"%s\"",
1380  NameListToString(opclass), accessMethodName)));
1381 
1382  /*
1383  * Verify that the index operator class accepts this datatype. Note we
1384  * will accept binary compatibility.
1385  */
1386  opClassId = HeapTupleGetOid(tuple);
1387  opInputType = ((Form_pg_opclass) GETSTRUCT(tuple))->opcintype;
1388 
1389  if (!IsBinaryCoercible(attrType, opInputType))
1390  ereport(ERROR,
1391  (errcode(ERRCODE_DATATYPE_MISMATCH),
1392  errmsg("operator class \"%s\" does not accept data type %s",
1393  NameListToString(opclass), format_type_be(attrType))));
1394 
1395  ReleaseSysCache(tuple);
1396 
1397  return opClassId;
1398 }
#define NIL
Definition: pg_list.h:69
Oid LookupExplicitNamespace(const char *nspname, bool missing_ok)
Definition: namespace.c:2853
int errhint(const char *fmt,...)
Definition: elog.c:987
Oid GetDefaultOpClass(Oid type_id, Oid am_id)
Definition: indexcmds.c:1407
#define GETSTRUCT(TUP)
Definition: htup_details.h:661
#define PointerGetDatum(X)
Definition: postgres.h:562
#define strVal(v)
Definition: value.h:54
int errcode(int sqlerrcode)
Definition: elog.c:575
char * format_type_be(Oid type_oid)
Definition: format_type.c:94
void DeconstructQualifiedName(List *names, char **nspname_p, char **objname_p)
Definition: namespace.c:2769
unsigned int Oid
Definition: postgres_ext.h:31
Oid OpclassnameGetOpcid(Oid amid, const char *opcname)
Definition: namespace.c:1760
#define OidIsValid(objectId)
Definition: c.h:576
#define linitial(l)
Definition: pg_list.h:111
#define ObjectIdGetDatum(X)
Definition: postgres.h:513
#define ERROR
Definition: elog.h:43
HeapTuple SearchSysCache3(int cacheId, Datum key1, Datum key2, Datum key3)
Definition: syscache.c:1134
#define ereport(elevel, rest)
Definition: elog.h:122
bool IsBinaryCoercible(Oid srctype, Oid targettype)
HeapTuple SearchSysCache1(int cacheId, Datum key1)
Definition: syscache.c:1112
char * NameListToString(List *names)
Definition: namespace.c:3063
void ReleaseSysCache(HeapTuple tuple)
Definition: syscache.c:1160
#define HeapTupleIsValid(tuple)
Definition: htup.h:77
static int list_length(const List *l)
Definition: pg_list.h:89
int errmsg(const char *fmt,...)
Definition: elog.c:797
#define HeapTupleGetOid(tuple)
Definition: htup_details.h:700
FormData_pg_opclass * Form_pg_opclass
Definition: pg_opclass.h:68