PostgreSQL Source Code  git master
indexcmds.c File Reference
#include "postgres.h"
#include "access/amapi.h"
#include "access/gist.h"
#include "access/heapam.h"
#include "access/htup_details.h"
#include "access/reloptions.h"
#include "access/sysattr.h"
#include "access/tableam.h"
#include "access/xact.h"
#include "catalog/catalog.h"
#include "catalog/index.h"
#include "catalog/indexing.h"
#include "catalog/namespace.h"
#include "catalog/pg_am.h"
#include "catalog/pg_authid.h"
#include "catalog/pg_constraint.h"
#include "catalog/pg_database.h"
#include "catalog/pg_inherits.h"
#include "catalog/pg_namespace.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/event_trigger.h"
#include "commands/progress.h"
#include "commands/tablecmds.h"
#include "commands/tablespace.h"
#include "mb/pg_wchar.h"
#include "miscadmin.h"
#include "nodes/makefuncs.h"
#include "nodes/nodeFuncs.h"
#include "optimizer/optimizer.h"
#include "parser/parse_coerce.h"
#include "parser/parse_oper.h"
#include "partitioning/partdesc.h"
#include "pgstat.h"
#include "rewrite/rewriteManip.h"
#include "storage/lmgr.h"
#include "storage/proc.h"
#include "storage/procarray.h"
#include "storage/sinvaladt.h"
#include "utils/acl.h"
#include "utils/builtins.h"
#include "utils/fmgroids.h"
#include "utils/guc.h"
#include "utils/inval.h"
#include "utils/lsyscache.h"
#include "utils/memutils.h"
#include "utils/partcache.h"
#include "utils/pg_rusage.h"
#include "utils/regproc.h"
#include "utils/snapmgr.h"
#include "utils/syscache.h"
Include dependency graph for indexcmds.c:

Go to the source code of this file.

Data Structures

struct  ReindexIndexCallbackState
 
struct  ReindexErrorInfo
 

Typedefs

typedef struct ReindexErrorInfo ReindexErrorInfo
 

Functions

static bool CompareOpclassOptions (const Datum *opts1, const Datum *opts2, int natts)
 
static void CheckPredicate (Expr *predicate)
 
static void ComputeIndexAttrs (IndexInfo *indexInfo, Oid *typeOids, Oid *collationOids, Oid *opclassOids, Datum *opclassOptions, int16 *colOptions, const List *attList, const List *exclusionOpNames, Oid relId, const char *accessMethodName, Oid accessMethodId, bool amcanorder, bool isconstraint, bool iswithoutoverlaps, Oid ddl_userid, int ddl_sec_context, int *ddl_save_nestlevel)
 
static char * ChooseIndexName (const char *tabname, Oid namespaceId, const List *colnames, const List *exclusionOpNames, bool primary, bool isconstraint)
 
static char * ChooseIndexNameAddition (const List *colnames)
 
static ListChooseIndexColumnNames (const List *indexElems)
 
static void ReindexIndex (const ReindexStmt *stmt, const ReindexParams *params, bool isTopLevel)
 
static void RangeVarCallbackForReindexIndex (const RangeVar *relation, Oid relId, Oid oldRelId, void *arg)
 
static Oid ReindexTable (const ReindexStmt *stmt, const ReindexParams *params, bool isTopLevel)
 
static void ReindexMultipleTables (const ReindexStmt *stmt, const ReindexParams *params)
 
static void reindex_error_callback (void *arg)
 
static void ReindexPartitions (const ReindexStmt *stmt, Oid relid, const ReindexParams *params, bool isTopLevel)
 
static void ReindexMultipleInternal (const ReindexStmt *stmt, const List *relids, const ReindexParams *params)
 
static bool ReindexRelationConcurrently (const ReindexStmt *stmt, Oid relationOid, const ReindexParams *params)
 
static void update_relispartition (Oid relationId, bool newval)
 
static void set_indexsafe_procflags (void)
 
bool CheckIndexCompatible (Oid oldId, const char *accessMethodName, const List *attributeList, const List *exclusionOpNames, bool isWithoutOverlaps)
 
void WaitForOlderSnapshots (TransactionId limitXmin, bool progress)
 
ObjectAddress DefineIndex (Oid tableId, IndexStmt *stmt, Oid indexRelationId, Oid parentIndexId, Oid parentConstraintId, int total_parts, bool is_alter_table, bool check_rights, bool check_not_in_use, bool skip_build, bool quiet)
 
Oid ResolveOpClass (const List *opclass, Oid attrType, const char *accessMethodName, Oid accessMethodId)
 
Oid GetDefaultOpClass (Oid type_id, Oid am_id)
 
void GetOperatorFromWellKnownStrategy (Oid opclass, Oid rhstype, Oid *opid, StrategyNumber *strat)
 
char * makeObjectName (const char *name1, const char *name2, const char *label)
 
char * ChooseRelationName (const char *name1, const char *name2, const char *label, Oid namespaceid, bool isconstraint)
 
void ExecReindex (ParseState *pstate, const ReindexStmt *stmt, bool isTopLevel)
 
void IndexSetParentIndex (Relation partitionIdx, Oid parentOid)
 

Typedef Documentation

◆ ReindexErrorInfo

Function Documentation

◆ CheckIndexCompatible()

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

Definition at line 177 of file indexcmds.c.

182 {
183  bool isconstraint;
184  Oid *typeIds;
185  Oid *collationIds;
186  Oid *opclassIds;
187  Datum *opclassOptions;
188  Oid accessMethodId;
189  Oid relationId;
190  HeapTuple tuple;
191  Form_pg_index indexForm;
192  Form_pg_am accessMethodForm;
193  IndexAmRoutine *amRoutine;
194  bool amcanorder;
195  bool amsummarizing;
196  int16 *coloptions;
197  IndexInfo *indexInfo;
198  int numberOfAttributes;
199  int old_natts;
200  bool ret = true;
201  oidvector *old_indclass;
202  oidvector *old_indcollation;
203  Relation irel;
204  int i;
205  Datum d;
206 
207  /* Caller should already have the relation locked in some way. */
208  relationId = IndexGetRelation(oldId, false);
209 
210  /*
211  * We can pretend isconstraint = false unconditionally. It only serves to
212  * decide the text of an error message that should never happen for us.
213  */
214  isconstraint = false;
215 
216  numberOfAttributes = list_length(attributeList);
217  Assert(numberOfAttributes > 0);
218  Assert(numberOfAttributes <= INDEX_MAX_KEYS);
219 
220  /* look up the access method */
221  tuple = SearchSysCache1(AMNAME, PointerGetDatum(accessMethodName));
222  if (!HeapTupleIsValid(tuple))
223  ereport(ERROR,
224  (errcode(ERRCODE_UNDEFINED_OBJECT),
225  errmsg("access method \"%s\" does not exist",
226  accessMethodName)));
227  accessMethodForm = (Form_pg_am) GETSTRUCT(tuple);
228  accessMethodId = accessMethodForm->oid;
229  amRoutine = GetIndexAmRoutine(accessMethodForm->amhandler);
230  ReleaseSysCache(tuple);
231 
232  amcanorder = amRoutine->amcanorder;
233  amsummarizing = amRoutine->amsummarizing;
234 
235  /*
236  * Compute the operator classes, collations, and exclusion operators for
237  * the new index, so we can test whether it's compatible with the existing
238  * one. Note that ComputeIndexAttrs might fail here, but that's OK:
239  * DefineIndex would have failed later. Our attributeList contains only
240  * key attributes, thus we're filling ii_NumIndexAttrs and
241  * ii_NumIndexKeyAttrs with same value.
242  */
243  indexInfo = makeIndexInfo(numberOfAttributes, numberOfAttributes,
244  accessMethodId, NIL, NIL, false, false,
245  false, false, amsummarizing);
246  typeIds = palloc_array(Oid, numberOfAttributes);
247  collationIds = palloc_array(Oid, numberOfAttributes);
248  opclassIds = palloc_array(Oid, numberOfAttributes);
249  opclassOptions = palloc_array(Datum, numberOfAttributes);
250  coloptions = palloc_array(int16, numberOfAttributes);
251  ComputeIndexAttrs(indexInfo,
252  typeIds, collationIds, opclassIds, opclassOptions,
253  coloptions, attributeList,
254  exclusionOpNames, relationId,
255  accessMethodName, accessMethodId,
256  amcanorder, isconstraint, isWithoutOverlaps, InvalidOid,
257  0, NULL);
258 
259  /* Get the soon-obsolete pg_index tuple. */
260  tuple = SearchSysCache1(INDEXRELID, ObjectIdGetDatum(oldId));
261  if (!HeapTupleIsValid(tuple))
262  elog(ERROR, "cache lookup failed for index %u", oldId);
263  indexForm = (Form_pg_index) GETSTRUCT(tuple);
264 
265  /*
266  * We don't assess expressions or predicates; assume incompatibility.
267  * Also, if the index is invalid for any reason, treat it as incompatible.
268  */
269  if (!(heap_attisnull(tuple, Anum_pg_index_indpred, NULL) &&
270  heap_attisnull(tuple, Anum_pg_index_indexprs, NULL) &&
271  indexForm->indisvalid))
272  {
273  ReleaseSysCache(tuple);
274  return false;
275  }
276 
277  /* Any change in operator class or collation breaks compatibility. */
278  old_natts = indexForm->indnkeyatts;
279  Assert(old_natts == numberOfAttributes);
280 
281  d = SysCacheGetAttrNotNull(INDEXRELID, tuple, Anum_pg_index_indcollation);
282  old_indcollation = (oidvector *) DatumGetPointer(d);
283 
284  d = SysCacheGetAttrNotNull(INDEXRELID, tuple, Anum_pg_index_indclass);
285  old_indclass = (oidvector *) DatumGetPointer(d);
286 
287  ret = (memcmp(old_indclass->values, opclassIds, old_natts * sizeof(Oid)) == 0 &&
288  memcmp(old_indcollation->values, collationIds, old_natts * sizeof(Oid)) == 0);
289 
290  ReleaseSysCache(tuple);
291 
292  if (!ret)
293  return false;
294 
295  /* For polymorphic opcintype, column type changes break compatibility. */
296  irel = index_open(oldId, AccessShareLock); /* caller probably has a lock */
297  for (i = 0; i < old_natts; i++)
298  {
299  if (IsPolymorphicType(get_opclass_input_type(opclassIds[i])) &&
300  TupleDescAttr(irel->rd_att, i)->atttypid != typeIds[i])
301  {
302  ret = false;
303  break;
304  }
305  }
306 
307  /* Any change in opclass options break compatibility. */
308  if (ret)
309  {
310  Datum *oldOpclassOptions = palloc_array(Datum, old_natts);
311 
312  for (i = 0; i < old_natts; i++)
313  oldOpclassOptions[i] = get_attoptions(oldId, i + 1);
314 
315  ret = CompareOpclassOptions(oldOpclassOptions, opclassOptions, old_natts);
316 
317  pfree(oldOpclassOptions);
318  }
319 
320  /* Any change in exclusion operator selections breaks compatibility. */
321  if (ret && indexInfo->ii_ExclusionOps != NULL)
322  {
323  Oid *old_operators,
324  *old_procs;
325  uint16 *old_strats;
326 
327  RelationGetExclusionInfo(irel, &old_operators, &old_procs, &old_strats);
328  ret = memcmp(old_operators, indexInfo->ii_ExclusionOps,
329  old_natts * sizeof(Oid)) == 0;
330 
331  /* Require an exact input type match for polymorphic operators. */
332  if (ret)
333  {
334  for (i = 0; i < old_natts && ret; i++)
335  {
336  Oid left,
337  right;
338 
339  op_input_types(indexInfo->ii_ExclusionOps[i], &left, &right);
340  if ((IsPolymorphicType(left) || IsPolymorphicType(right)) &&
341  TupleDescAttr(irel->rd_att, i)->atttypid != typeIds[i])
342  {
343  ret = false;
344  break;
345  }
346  }
347  }
348  }
349 
350  index_close(irel, NoLock);
351  return ret;
352 }
IndexAmRoutine * GetIndexAmRoutine(Oid amhandler)
Definition: amapi.c:33
unsigned short uint16
Definition: c.h:505
signed short int16
Definition: c.h:493
#define Assert(condition)
Definition: c.h:858
int errcode(int sqlerrcode)
Definition: elog.c:859
int errmsg(const char *fmt,...)
Definition: elog.c:1072
#define ERROR
Definition: elog.h:39
#define elog(elevel,...)
Definition: elog.h:224
#define ereport(elevel,...)
Definition: elog.h:149
#define palloc_array(type, count)
Definition: fe_memutils.h:64
bool heap_attisnull(HeapTuple tup, int attnum, TupleDesc tupleDesc)
Definition: heaptuple.c:455
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
#define GETSTRUCT(TUP)
Definition: htup_details.h:653
Oid IndexGetRelation(Oid indexId, bool missing_ok)
Definition: index.c:3527
void index_close(Relation relation, LOCKMODE lockmode)
Definition: indexam.c:177
Relation index_open(Oid relationId, LOCKMODE lockmode)
Definition: indexam.c:133
static void ComputeIndexAttrs(IndexInfo *indexInfo, Oid *typeOids, Oid *collationOids, Oid *opclassOids, Datum *opclassOptions, int16 *colOptions, const List *attList, const List *exclusionOpNames, Oid relId, const char *accessMethodName, Oid accessMethodId, bool amcanorder, bool isconstraint, bool iswithoutoverlaps, Oid ddl_userid, int ddl_sec_context, int *ddl_save_nestlevel)
Definition: indexcmds.c:1858
static bool CompareOpclassOptions(const Datum *opts1, const Datum *opts2, int natts)
Definition: indexcmds.c:361
int i
Definition: isn.c:73
#define NoLock
Definition: lockdefs.h:34
#define AccessShareLock
Definition: lockdefs.h:36
Oid get_opclass_input_type(Oid opclass)
Definition: lsyscache.c:1212
Datum get_attoptions(Oid relid, int16 attnum)
Definition: lsyscache.c:970
void op_input_types(Oid opno, Oid *lefttype, Oid *righttype)
Definition: lsyscache.c:1358
IndexInfo * makeIndexInfo(int numattrs, int numkeyattrs, Oid amoid, List *expressions, List *predicates, bool unique, bool nulls_not_distinct, bool isready, bool concurrent, bool summarizing)
Definition: makefuncs.c:761
void pfree(void *pointer)
Definition: mcxt.c:1520
FormData_pg_am * Form_pg_am
Definition: pg_am.h:48
#define INDEX_MAX_KEYS
FormData_pg_index * Form_pg_index
Definition: pg_index.h:70
static int list_length(const List *l)
Definition: pg_list.h:152
#define NIL
Definition: pg_list.h:68
static Datum PointerGetDatum(const void *X)
Definition: postgres.h:322
uintptr_t Datum
Definition: postgres.h:64
static Datum ObjectIdGetDatum(Oid X)
Definition: postgres.h:252
static Pointer DatumGetPointer(Datum X)
Definition: postgres.h:312
#define InvalidOid
Definition: postgres_ext.h:36
unsigned int Oid
Definition: postgres_ext.h:31
void RelationGetExclusionInfo(Relation indexRelation, Oid **operators, Oid **procs, uint16 **strategies)
Definition: relcache.c:5581
bool amsummarizing
Definition: amapi.h:254
bool amcanorder
Definition: amapi.h:224
Oid * ii_ExclusionOps
Definition: execnodes.h:191
TupleDesc rd_att
Definition: rel.h:112
Definition: c.h:726
Oid values[FLEXIBLE_ARRAY_MEMBER]
Definition: c.h:733
void ReleaseSysCache(HeapTuple tuple)
Definition: syscache.c:266
HeapTuple SearchSysCache1(int cacheId, Datum key1)
Definition: syscache.c:218
Datum SysCacheGetAttrNotNull(int cacheId, HeapTuple tup, AttrNumber attributeNumber)
Definition: syscache.c:510
#define TupleDescAttr(tupdesc, i)
Definition: tupdesc.h:92

References AccessShareLock, IndexAmRoutine::amcanorder, IndexAmRoutine::amsummarizing, Assert, CompareOpclassOptions(), ComputeIndexAttrs(), DatumGetPointer(), elog, ereport, errcode(), errmsg(), ERROR, get_attoptions(), get_opclass_input_type(), GetIndexAmRoutine(), GETSTRUCT, heap_attisnull(), HeapTupleIsValid, i, IndexInfo::ii_ExclusionOps, index_close(), INDEX_MAX_KEYS, index_open(), IndexGetRelation(), InvalidOid, list_length(), makeIndexInfo(), NIL, NoLock, ObjectIdGetDatum(), op_input_types(), palloc_array, pfree(), PointerGetDatum(), RelationData::rd_att, RelationGetExclusionInfo(), ReleaseSysCache(), SearchSysCache1(), SysCacheGetAttrNotNull(), TupleDescAttr, and oidvector::values.

Referenced by TryReuseIndex().

◆ CheckPredicate()

static void CheckPredicate ( Expr predicate)
static

Definition at line 1831 of file indexcmds.c.

1832 {
1833  /*
1834  * transformExpr() should have already rejected subqueries, aggregates,
1835  * and window functions, based on the EXPR_KIND_ for a predicate.
1836  */
1837 
1838  /*
1839  * A predicate using mutable functions is probably wrong, for the same
1840  * reasons that we don't allow an index expression to use one.
1841  */
1843  ereport(ERROR,
1844  (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
1845  errmsg("functions in index predicate must be marked IMMUTABLE")));
1846 }
bool contain_mutable_functions_after_planning(Expr *expr)
Definition: clauses.c:490

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

Referenced by DefineIndex().

◆ ChooseIndexColumnNames()

static List * ChooseIndexColumnNames ( const List indexElems)
static

Definition at line 2740 of file indexcmds.c.

2741 {
2742  List *result = NIL;
2743  ListCell *lc;
2744 
2745  foreach(lc, indexElems)
2746  {
2747  IndexElem *ielem = (IndexElem *) lfirst(lc);
2748  const char *origname;
2749  const char *curname;
2750  int i;
2751  char buf[NAMEDATALEN];
2752 
2753  /* Get the preliminary name from the IndexElem */
2754  if (ielem->indexcolname)
2755  origname = ielem->indexcolname; /* caller-specified name */
2756  else if (ielem->name)
2757  origname = ielem->name; /* simple column reference */
2758  else
2759  origname = "expr"; /* default name for expression */
2760 
2761  /* If it conflicts with any previous column, tweak it */
2762  curname = origname;
2763  for (i = 1;; i++)
2764  {
2765  ListCell *lc2;
2766  char nbuf[32];
2767  int nlen;
2768 
2769  foreach(lc2, result)
2770  {
2771  if (strcmp(curname, (char *) lfirst(lc2)) == 0)
2772  break;
2773  }
2774  if (lc2 == NULL)
2775  break; /* found nonconflicting name */
2776 
2777  sprintf(nbuf, "%d", i);
2778 
2779  /* Ensure generated names are shorter than NAMEDATALEN */
2780  nlen = pg_mbcliplen(origname, strlen(origname),
2781  NAMEDATALEN - 1 - strlen(nbuf));
2782  memcpy(buf, origname, nlen);
2783  strcpy(buf + nlen, nbuf);
2784  curname = buf;
2785  }
2786 
2787  /* And attach to the result list */
2788  result = lappend(result, pstrdup(curname));
2789  }
2790  return result;
2791 }
List * lappend(List *list, void *datum)
Definition: list.c:339
int pg_mbcliplen(const char *mbstr, int len, int limit)
Definition: mbutils.c:1083
char * pstrdup(const char *in)
Definition: mcxt.c:1695
#define NAMEDATALEN
#define lfirst(lc)
Definition: pg_list.h:172
static char * buf
Definition: pg_test_fsync.c:73
#define sprintf
Definition: port.h:240
char * indexcolname
Definition: parsenodes.h:785
char * name
Definition: parsenodes.h:783
Definition: pg_list.h:54

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

Referenced by DefineIndex().

◆ ChooseIndexName()

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

Definition at line 2651 of file indexcmds.c.

2654 {
2655  char *indexname;
2656 
2657  if (primary)
2658  {
2659  /* the primary key's name does not depend on the specific column(s) */
2660  indexname = ChooseRelationName(tabname,
2661  NULL,
2662  "pkey",
2663  namespaceId,
2664  true);
2665  }
2666  else if (exclusionOpNames != NIL)
2667  {
2668  indexname = ChooseRelationName(tabname,
2669  ChooseIndexNameAddition(colnames),
2670  "excl",
2671  namespaceId,
2672  true);
2673  }
2674  else if (isconstraint)
2675  {
2676  indexname = ChooseRelationName(tabname,
2677  ChooseIndexNameAddition(colnames),
2678  "key",
2679  namespaceId,
2680  true);
2681  }
2682  else
2683  {
2684  indexname = ChooseRelationName(tabname,
2685  ChooseIndexNameAddition(colnames),
2686  "idx",
2687  namespaceId,
2688  false);
2689  }
2690 
2691  return indexname;
2692 }
static char * ChooseIndexNameAddition(const List *colnames)
Definition: indexcmds.c:2706
char * ChooseRelationName(const char *name1, const char *name2, const char *label, Oid namespaceid, bool isconstraint)
Definition: indexcmds.c:2615

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

Referenced by DefineIndex().

◆ ChooseIndexNameAddition()

static char * ChooseIndexNameAddition ( const List colnames)
static

Definition at line 2706 of file indexcmds.c.

2707 {
2708  char buf[NAMEDATALEN * 2];
2709  int buflen = 0;
2710  ListCell *lc;
2711 
2712  buf[0] = '\0';
2713  foreach(lc, colnames)
2714  {
2715  const char *name = (const char *) lfirst(lc);
2716 
2717  if (buflen > 0)
2718  buf[buflen++] = '_'; /* insert _ between names */
2719 
2720  /*
2721  * At this point we have buflen <= NAMEDATALEN. name should be less
2722  * than NAMEDATALEN already, but use strlcpy for paranoia.
2723  */
2724  strlcpy(buf + buflen, name, NAMEDATALEN);
2725  buflen += strlen(buf + buflen);
2726  if (buflen >= NAMEDATALEN)
2727  break;
2728  }
2729  return pstrdup(buf);
2730 }
size_t strlcpy(char *dst, const char *src, size_t siz)
Definition: strlcpy.c:45
const char * name

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

Referenced by ChooseIndexName().

◆ ChooseRelationName()

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

Definition at line 2615 of file indexcmds.c.

2618 {
2619  int pass = 0;
2620  char *relname = NULL;
2621  char modlabel[NAMEDATALEN];
2622 
2623  /* try the unmodified label first */
2624  strlcpy(modlabel, label, sizeof(modlabel));
2625 
2626  for (;;)
2627  {
2628  relname = makeObjectName(name1, name2, modlabel);
2629 
2630  if (!OidIsValid(get_relname_relid(relname, namespaceid)))
2631  {
2632  if (!isconstraint ||
2633  !ConstraintNameExists(relname, namespaceid))
2634  break;
2635  }
2636 
2637  /* found a conflict, so try a new name component */
2638  pfree(relname);
2639  snprintf(modlabel, sizeof(modlabel), "%s%d", label, ++pass);
2640  }
2641 
2642  return relname;
2643 }
#define OidIsValid(objectId)
Definition: c.h:775
char * makeObjectName(const char *name1, const char *name2, const char *label)
Definition: indexcmds.c:2529
Oid get_relname_relid(const char *relname, Oid relnamespace)
Definition: lsyscache.c:1885
static char * label
NameData relname
Definition: pg_class.h:38
bool ConstraintNameExists(const char *conname, Oid namespaceid)
#define snprintf
Definition: port.h:238

References ConstraintNameExists(), get_relname_relid(), label, makeObjectName(), NAMEDATALEN, OidIsValid, pfree(), relname, snprintf, and strlcpy().

Referenced by ChooseIndexName(), generateSerialExtraStmts(), and ReindexRelationConcurrently().

◆ CompareOpclassOptions()

static bool CompareOpclassOptions ( const Datum opts1,
const Datum opts2,
int  natts 
)
static

Definition at line 361 of file indexcmds.c.

362 {
363  int i;
364 
365  if (!opts1 && !opts2)
366  return true;
367 
368  for (i = 0; i < natts; i++)
369  {
370  Datum opt1 = opts1 ? opts1[i] : (Datum) 0;
371  Datum opt2 = opts2 ? opts2[i] : (Datum) 0;
372 
373  if (opt1 == (Datum) 0)
374  {
375  if (opt2 == (Datum) 0)
376  continue;
377  else
378  return false;
379  }
380  else if (opt2 == (Datum) 0)
381  return false;
382 
383  /* Compare non-NULL text[] datums. */
384  if (!DatumGetBool(DirectFunctionCall2(array_eq, opt1, opt2)))
385  return false;
386  }
387 
388  return true;
389 }
Datum array_eq(PG_FUNCTION_ARGS)
Definition: arrayfuncs.c:3795
#define DirectFunctionCall2(func, arg1, arg2)
Definition: fmgr.h:644
static bool DatumGetBool(Datum X)
Definition: postgres.h:90

References array_eq(), DatumGetBool(), DirectFunctionCall2, and i.

Referenced by CheckIndexCompatible().

◆ ComputeIndexAttrs()

static void ComputeIndexAttrs ( IndexInfo indexInfo,
Oid typeOids,
Oid collationOids,
Oid opclassOids,
Datum opclassOptions,
int16 colOptions,
const List attList,
const List exclusionOpNames,
Oid  relId,
const char *  accessMethodName,
Oid  accessMethodId,
bool  amcanorder,
bool  isconstraint,
bool  iswithoutoverlaps,
Oid  ddl_userid,
int  ddl_sec_context,
int *  ddl_save_nestlevel 
)
static

Definition at line 1858 of file indexcmds.c.

1875 {
1876  ListCell *nextExclOp;
1877  ListCell *lc;
1878  int attn;
1879  int nkeycols = indexInfo->ii_NumIndexKeyAttrs;
1880  Oid save_userid;
1881  int save_sec_context;
1882 
1883  /* Allocate space for exclusion operator info, if needed */
1884  if (exclusionOpNames)
1885  {
1886  Assert(list_length(exclusionOpNames) == nkeycols);
1887  indexInfo->ii_ExclusionOps = palloc_array(Oid, nkeycols);
1888  indexInfo->ii_ExclusionProcs = palloc_array(Oid, nkeycols);
1889  indexInfo->ii_ExclusionStrats = palloc_array(uint16, nkeycols);
1890  nextExclOp = list_head(exclusionOpNames);
1891  }
1892  else
1893  nextExclOp = NULL;
1894 
1895  /* exclusionOpNames can be non-NIL if we are creating a partition */
1896  if (iswithoutoverlaps && exclusionOpNames == NIL)
1897  {
1898  indexInfo->ii_ExclusionOps = palloc_array(Oid, nkeycols);
1899  indexInfo->ii_ExclusionProcs = palloc_array(Oid, nkeycols);
1900  indexInfo->ii_ExclusionStrats = palloc_array(uint16, nkeycols);
1901  }
1902 
1903  if (OidIsValid(ddl_userid))
1904  GetUserIdAndSecContext(&save_userid, &save_sec_context);
1905 
1906  /*
1907  * process attributeList
1908  */
1909  attn = 0;
1910  foreach(lc, attList)
1911  {
1912  IndexElem *attribute = (IndexElem *) lfirst(lc);
1913  Oid atttype;
1914  Oid attcollation;
1915 
1916  /*
1917  * Process the column-or-expression to be indexed.
1918  */
1919  if (attribute->name != NULL)
1920  {
1921  /* Simple index attribute */
1922  HeapTuple atttuple;
1923  Form_pg_attribute attform;
1924 
1925  Assert(attribute->expr == NULL);
1926  atttuple = SearchSysCacheAttName(relId, attribute->name);
1927  if (!HeapTupleIsValid(atttuple))
1928  {
1929  /* difference in error message spellings is historical */
1930  if (isconstraint)
1931  ereport(ERROR,
1932  (errcode(ERRCODE_UNDEFINED_COLUMN),
1933  errmsg("column \"%s\" named in key does not exist",
1934  attribute->name)));
1935  else
1936  ereport(ERROR,
1937  (errcode(ERRCODE_UNDEFINED_COLUMN),
1938  errmsg("column \"%s\" does not exist",
1939  attribute->name)));
1940  }
1941  attform = (Form_pg_attribute) GETSTRUCT(atttuple);
1942  indexInfo->ii_IndexAttrNumbers[attn] = attform->attnum;
1943  atttype = attform->atttypid;
1944  attcollation = attform->attcollation;
1945  ReleaseSysCache(atttuple);
1946  }
1947  else
1948  {
1949  /* Index expression */
1950  Node *expr = attribute->expr;
1951 
1952  Assert(expr != NULL);
1953 
1954  if (attn >= nkeycols)
1955  ereport(ERROR,
1956  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1957  errmsg("expressions are not supported in included columns")));
1958  atttype = exprType(expr);
1959  attcollation = exprCollation(expr);
1960 
1961  /*
1962  * Strip any top-level COLLATE clause. This ensures that we treat
1963  * "x COLLATE y" and "(x COLLATE y)" alike.
1964  */
1965  while (IsA(expr, CollateExpr))
1966  expr = (Node *) ((CollateExpr *) expr)->arg;
1967 
1968  if (IsA(expr, Var) &&
1969  ((Var *) expr)->varattno != InvalidAttrNumber)
1970  {
1971  /*
1972  * User wrote "(column)" or "(column COLLATE something)".
1973  * Treat it like simple attribute anyway.
1974  */
1975  indexInfo->ii_IndexAttrNumbers[attn] = ((Var *) expr)->varattno;
1976  }
1977  else
1978  {
1979  indexInfo->ii_IndexAttrNumbers[attn] = 0; /* marks expression */
1980  indexInfo->ii_Expressions = lappend(indexInfo->ii_Expressions,
1981  expr);
1982 
1983  /*
1984  * transformExpr() should have already rejected subqueries,
1985  * aggregates, and window functions, based on the EXPR_KIND_
1986  * for an index expression.
1987  */
1988 
1989  /*
1990  * An expression using mutable functions is probably wrong,
1991  * since if you aren't going to get the same result for the
1992  * same data every time, it's not clear what the index entries
1993  * mean at all.
1994  */
1996  ereport(ERROR,
1997  (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
1998  errmsg("functions in index expression must be marked IMMUTABLE")));
1999  }
2000  }
2001 
2002  typeOids[attn] = atttype;
2003 
2004  /*
2005  * Included columns have no collation, no opclass and no ordering
2006  * options.
2007  */
2008  if (attn >= nkeycols)
2009  {
2010  if (attribute->collation)
2011  ereport(ERROR,
2012  (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
2013  errmsg("including column does not support a collation")));
2014  if (attribute->opclass)
2015  ereport(ERROR,
2016  (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
2017  errmsg("including column does not support an operator class")));
2018  if (attribute->ordering != SORTBY_DEFAULT)
2019  ereport(ERROR,
2020  (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
2021  errmsg("including column does not support ASC/DESC options")));
2022  if (attribute->nulls_ordering != SORTBY_NULLS_DEFAULT)
2023  ereport(ERROR,
2024  (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
2025  errmsg("including column does not support NULLS FIRST/LAST options")));
2026 
2027  opclassOids[attn] = InvalidOid;
2028  opclassOptions[attn] = (Datum) 0;
2029  colOptions[attn] = 0;
2030  collationOids[attn] = InvalidOid;
2031  attn++;
2032 
2033  continue;
2034  }
2035 
2036  /*
2037  * Apply collation override if any. Use of ddl_userid is necessary
2038  * due to ACL checks therein, and it's safe because collations don't
2039  * contain opaque expressions (or non-opaque expressions).
2040  */
2041  if (attribute->collation)
2042  {
2043  if (OidIsValid(ddl_userid))
2044  {
2045  AtEOXact_GUC(false, *ddl_save_nestlevel);
2046  SetUserIdAndSecContext(ddl_userid, ddl_sec_context);
2047  }
2048  attcollation = get_collation_oid(attribute->collation, false);
2049  if (OidIsValid(ddl_userid))
2050  {
2051  SetUserIdAndSecContext(save_userid, save_sec_context);
2052  *ddl_save_nestlevel = NewGUCNestLevel();
2053  }
2054  }
2055 
2056  /*
2057  * Check we have a collation iff it's a collatable type. The only
2058  * expected failures here are (1) COLLATE applied to a noncollatable
2059  * type, or (2) index expression had an unresolved collation. But we
2060  * might as well code this to be a complete consistency check.
2061  */
2062  if (type_is_collatable(atttype))
2063  {
2064  if (!OidIsValid(attcollation))
2065  ereport(ERROR,
2066  (errcode(ERRCODE_INDETERMINATE_COLLATION),
2067  errmsg("could not determine which collation to use for index expression"),
2068  errhint("Use the COLLATE clause to set the collation explicitly.")));
2069  }
2070  else
2071  {
2072  if (OidIsValid(attcollation))
2073  ereport(ERROR,
2074  (errcode(ERRCODE_DATATYPE_MISMATCH),
2075  errmsg("collations are not supported by type %s",
2076  format_type_be(atttype))));
2077  }
2078 
2079  collationOids[attn] = attcollation;
2080 
2081  /*
2082  * Identify the opclass to use. Use of ddl_userid is necessary due to
2083  * ACL checks therein. This is safe despite opclasses containing
2084  * opaque expressions (specifically, functions), because only
2085  * superusers can define opclasses.
2086  */
2087  if (OidIsValid(ddl_userid))
2088  {
2089  AtEOXact_GUC(false, *ddl_save_nestlevel);
2090  SetUserIdAndSecContext(ddl_userid, ddl_sec_context);
2091  }
2092  opclassOids[attn] = ResolveOpClass(attribute->opclass,
2093  atttype,
2094  accessMethodName,
2095  accessMethodId);
2096  if (OidIsValid(ddl_userid))
2097  {
2098  SetUserIdAndSecContext(save_userid, save_sec_context);
2099  *ddl_save_nestlevel = NewGUCNestLevel();
2100  }
2101 
2102  /*
2103  * Identify the exclusion operator, if any.
2104  */
2105  if (nextExclOp)
2106  {
2107  List *opname = (List *) lfirst(nextExclOp);
2108  Oid opid;
2109  Oid opfamily;
2110  int strat;
2111 
2112  /*
2113  * Find the operator --- it must accept the column datatype
2114  * without runtime coercion (but binary compatibility is OK).
2115  * Operators contain opaque expressions (specifically, functions).
2116  * compatible_oper_opid() boils down to oper() and
2117  * IsBinaryCoercible(). PostgreSQL would have security problems
2118  * elsewhere if oper() started calling opaque expressions.
2119  */
2120  if (OidIsValid(ddl_userid))
2121  {
2122  AtEOXact_GUC(false, *ddl_save_nestlevel);
2123  SetUserIdAndSecContext(ddl_userid, ddl_sec_context);
2124  }
2125  opid = compatible_oper_opid(opname, atttype, atttype, false);
2126  if (OidIsValid(ddl_userid))
2127  {
2128  SetUserIdAndSecContext(save_userid, save_sec_context);
2129  *ddl_save_nestlevel = NewGUCNestLevel();
2130  }
2131 
2132  /*
2133  * Only allow commutative operators to be used in exclusion
2134  * constraints. If X conflicts with Y, but Y does not conflict
2135  * with X, bad things will happen.
2136  */
2137  if (get_commutator(opid) != opid)
2138  ereport(ERROR,
2139  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
2140  errmsg("operator %s is not commutative",
2141  format_operator(opid)),
2142  errdetail("Only commutative operators can be used in exclusion constraints.")));
2143 
2144  /*
2145  * Operator must be a member of the right opfamily, too
2146  */
2147  opfamily = get_opclass_family(opclassOids[attn]);
2148  strat = get_op_opfamily_strategy(opid, opfamily);
2149  if (strat == 0)
2150  {
2151  HeapTuple opftuple;
2152  Form_pg_opfamily opfform;
2153 
2154  /*
2155  * attribute->opclass might not explicitly name the opfamily,
2156  * so fetch the name of the selected opfamily for use in the
2157  * error message.
2158  */
2159  opftuple = SearchSysCache1(OPFAMILYOID,
2160  ObjectIdGetDatum(opfamily));
2161  if (!HeapTupleIsValid(opftuple))
2162  elog(ERROR, "cache lookup failed for opfamily %u",
2163  opfamily);
2164  opfform = (Form_pg_opfamily) GETSTRUCT(opftuple);
2165 
2166  ereport(ERROR,
2167  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
2168  errmsg("operator %s is not a member of operator family \"%s\"",
2169  format_operator(opid),
2170  NameStr(opfform->opfname)),
2171  errdetail("The exclusion operator must be related to the index operator class for the constraint.")));
2172  }
2173 
2174  indexInfo->ii_ExclusionOps[attn] = opid;
2175  indexInfo->ii_ExclusionProcs[attn] = get_opcode(opid);
2176  indexInfo->ii_ExclusionStrats[attn] = strat;
2177  nextExclOp = lnext(exclusionOpNames, nextExclOp);
2178  }
2179  else if (iswithoutoverlaps)
2180  {
2181  StrategyNumber strat;
2182  Oid opid;
2183 
2184  if (attn == nkeycols - 1)
2185  strat = RTOverlapStrategyNumber;
2186  else
2187  strat = RTEqualStrategyNumber;
2188  GetOperatorFromWellKnownStrategy(opclassOids[attn], InvalidOid,
2189  &opid, &strat);
2190  indexInfo->ii_ExclusionOps[attn] = opid;
2191  indexInfo->ii_ExclusionProcs[attn] = get_opcode(opid);
2192  indexInfo->ii_ExclusionStrats[attn] = strat;
2193  }
2194 
2195  /*
2196  * Set up the per-column options (indoption field). For now, this is
2197  * zero for any un-ordered index, while ordered indexes have DESC and
2198  * NULLS FIRST/LAST options.
2199  */
2200  colOptions[attn] = 0;
2201  if (amcanorder)
2202  {
2203  /* default ordering is ASC */
2204  if (attribute->ordering == SORTBY_DESC)
2205  colOptions[attn] |= INDOPTION_DESC;
2206  /* default null ordering is LAST for ASC, FIRST for DESC */
2207  if (attribute->nulls_ordering == SORTBY_NULLS_DEFAULT)
2208  {
2209  if (attribute->ordering == SORTBY_DESC)
2210  colOptions[attn] |= INDOPTION_NULLS_FIRST;
2211  }
2212  else if (attribute->nulls_ordering == SORTBY_NULLS_FIRST)
2213  colOptions[attn] |= INDOPTION_NULLS_FIRST;
2214  }
2215  else
2216  {
2217  /* index AM does not support ordering */
2218  if (attribute->ordering != SORTBY_DEFAULT)
2219  ereport(ERROR,
2220  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
2221  errmsg("access method \"%s\" does not support ASC/DESC options",
2222  accessMethodName)));
2223  if (attribute->nulls_ordering != SORTBY_NULLS_DEFAULT)
2224  ereport(ERROR,
2225  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
2226  errmsg("access method \"%s\" does not support NULLS FIRST/LAST options",
2227  accessMethodName)));
2228  }
2229 
2230  /* Set up the per-column opclass options (attoptions field). */
2231  if (attribute->opclassopts)
2232  {
2233  Assert(attn < nkeycols);
2234 
2235  opclassOptions[attn] =
2236  transformRelOptions((Datum) 0, attribute->opclassopts,
2237  NULL, NULL, false, false);
2238  }
2239  else
2240  opclassOptions[attn] = (Datum) 0;
2241 
2242  attn++;
2243  }
2244 }
#define InvalidAttrNumber
Definition: attnum.h:23
#define NameStr(name)
Definition: c.h:746
int errdetail(const char *fmt,...)
Definition: elog.c:1205
int errhint(const char *fmt,...)
Definition: elog.c:1319
char * format_type_be(Oid type_oid)
Definition: format_type.c:343
int NewGUCNestLevel(void)
Definition: guc.c:2237
void AtEOXact_GUC(bool isCommit, int nestLevel)
Definition: guc.c:2264
void GetOperatorFromWellKnownStrategy(Oid opclass, Oid rhstype, Oid *opid, StrategyNumber *strat)
Definition: indexcmds.c:2441
Oid ResolveOpClass(const List *opclass, Oid attrType, const char *accessMethodName, Oid accessMethodId)
Definition: indexcmds.c:2253
Oid get_opclass_family(Oid opclass)
Definition: lsyscache.c:1190
RegProcedure get_opcode(Oid opno)
Definition: lsyscache.c:1285
int get_op_opfamily_strategy(Oid opno, Oid opfamily)
Definition: lsyscache.c:83
bool type_is_collatable(Oid typid)
Definition: lsyscache.c:3081
Oid get_commutator(Oid opno)
Definition: lsyscache.c:1509
void GetUserIdAndSecContext(Oid *userid, int *sec_context)
Definition: miscinit.c:635
void SetUserIdAndSecContext(Oid userid, int sec_context)
Definition: miscinit.c:642
Oid get_collation_oid(List *collname, bool missing_ok)
Definition: namespace.c:3956
Oid exprType(const Node *expr)
Definition: nodeFuncs.c:42
Oid exprCollation(const Node *expr)
Definition: nodeFuncs.c:816
#define IsA(nodeptr, _type_)
Definition: nodes.h:158
Oid compatible_oper_opid(List *op, Oid arg1, Oid arg2, bool noError)
Definition: parse_oper.c:487
@ SORTBY_NULLS_DEFAULT
Definition: parsenodes.h:54
@ SORTBY_NULLS_FIRST
Definition: parsenodes.h:55
@ SORTBY_DESC
Definition: parsenodes.h:48
@ SORTBY_DEFAULT
Definition: parsenodes.h:46
FormData_pg_attribute * Form_pg_attribute
Definition: pg_attribute.h:209
void * arg
static ListCell * list_head(const List *l)
Definition: pg_list.h:128
static ListCell * lnext(const List *l, const ListCell *c)
Definition: pg_list.h:343
FormData_pg_opfamily * Form_pg_opfamily
Definition: pg_opfamily.h:51
char * format_operator(Oid operator_oid)
Definition: regproc.c:793
Datum transformRelOptions(Datum oldOptions, List *defList, const char *namspace, char *validnsps[], bool acceptOidsOff, bool isReset)
Definition: reloptions.c:1156
uint16 StrategyNumber
Definition: stratnum.h:22
#define RTOverlapStrategyNumber
Definition: stratnum.h:53
#define RTEqualStrategyNumber
Definition: stratnum.h:68
Node * expr
Definition: parsenodes.h:784
SortByDir ordering
Definition: parsenodes.h:789
List * opclassopts
Definition: parsenodes.h:788
SortByNulls nulls_ordering
Definition: parsenodes.h:790
List * opclass
Definition: parsenodes.h:787
List * collation
Definition: parsenodes.h:786
uint16 * ii_ExclusionStrats
Definition: execnodes.h:193
int ii_NumIndexKeyAttrs
Definition: execnodes.h:185
List * ii_Expressions
Definition: execnodes.h:187
Oid * ii_ExclusionProcs
Definition: execnodes.h:192
AttrNumber ii_IndexAttrNumbers[INDEX_MAX_KEYS]
Definition: execnodes.h:186
Definition: nodes.h:129
Definition: primnodes.h:248
HeapTuple SearchSysCacheAttName(Oid relid, const char *attname)
Definition: syscache.c:359

References arg, Assert, AtEOXact_GUC(), IndexElem::collation, compatible_oper_opid(), contain_mutable_functions_after_planning(), 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(), GetOperatorFromWellKnownStrategy(), GETSTRUCT, GetUserIdAndSecContext(), HeapTupleIsValid, IndexInfo::ii_ExclusionOps, IndexInfo::ii_ExclusionProcs, IndexInfo::ii_ExclusionStrats, IndexInfo::ii_Expressions, IndexInfo::ii_IndexAttrNumbers, IndexInfo::ii_NumIndexKeyAttrs, InvalidAttrNumber, InvalidOid, IsA, lappend(), lfirst, list_head(), list_length(), lnext(), IndexElem::name, NameStr, NewGUCNestLevel(), NIL, IndexElem::nulls_ordering, ObjectIdGetDatum(), OidIsValid, IndexElem::opclass, IndexElem::opclassopts, IndexElem::ordering, palloc_array, ReleaseSysCache(), ResolveOpClass(), RTEqualStrategyNumber, RTOverlapStrategyNumber, SearchSysCache1(), SearchSysCacheAttName(), SetUserIdAndSecContext(), SORTBY_DEFAULT, SORTBY_DESC, SORTBY_NULLS_DEFAULT, SORTBY_NULLS_FIRST, transformRelOptions(), and type_is_collatable().

Referenced by CheckIndexCompatible(), and DefineIndex().

◆ DefineIndex()

ObjectAddress DefineIndex ( Oid  tableId,
IndexStmt stmt,
Oid  indexRelationId,
Oid  parentIndexId,
Oid  parentConstraintId,
int  total_parts,
bool  is_alter_table,
bool  check_rights,
bool  check_not_in_use,
bool  skip_build,
bool  quiet 
)

Definition at line 535 of file indexcmds.c.

546 {
547  bool concurrent;
548  char *indexRelationName;
549  char *accessMethodName;
550  Oid *typeIds;
551  Oid *collationIds;
552  Oid *opclassIds;
553  Datum *opclassOptions;
554  Oid accessMethodId;
555  Oid namespaceId;
556  Oid tablespaceId;
557  Oid createdConstraintId = InvalidOid;
558  List *indexColNames;
559  List *allIndexParams;
560  Relation rel;
561  HeapTuple tuple;
562  Form_pg_am accessMethodForm;
563  IndexAmRoutine *amRoutine;
564  bool amcanorder;
565  bool amissummarizing;
566  amoptions_function amoptions;
567  bool exclusion;
568  bool partitioned;
569  bool safe_index;
570  Datum reloptions;
571  int16 *coloptions;
572  IndexInfo *indexInfo;
573  bits16 flags;
574  bits16 constr_flags;
575  int numberOfAttributes;
576  int numberOfKeyAttributes;
577  TransactionId limitXmin;
578  ObjectAddress address;
579  LockRelId heaprelid;
580  LOCKTAG heaplocktag;
581  LOCKMODE lockmode;
582  Snapshot snapshot;
583  Oid root_save_userid;
584  int root_save_sec_context;
585  int root_save_nestlevel;
586 
587  root_save_nestlevel = NewGUCNestLevel();
588 
590 
591  /*
592  * Some callers need us to run with an empty default_tablespace; this is a
593  * necessary hack to be able to reproduce catalog state accurately when
594  * recreating indexes after table-rewriting ALTER TABLE.
595  */
596  if (stmt->reset_default_tblspc)
597  (void) set_config_option("default_tablespace", "",
599  GUC_ACTION_SAVE, true, 0, false);
600 
601  /*
602  * Force non-concurrent build on temporary relations, even if CONCURRENTLY
603  * was requested. Other backends can't access a temporary relation, so
604  * there's no harm in grabbing a stronger lock, and a non-concurrent DROP
605  * is more efficient. Do this before any use of the concurrent option is
606  * done.
607  */
608  if (stmt->concurrent && get_rel_persistence(tableId) != RELPERSISTENCE_TEMP)
609  concurrent = true;
610  else
611  concurrent = false;
612 
613  /*
614  * Start progress report. If we're building a partition, this was already
615  * done.
616  */
617  if (!OidIsValid(parentIndexId))
618  {
621  concurrent ?
624  }
625 
626  /*
627  * No index OID to report yet
628  */
630  InvalidOid);
631 
632  /*
633  * count key attributes in index
634  */
635  numberOfKeyAttributes = list_length(stmt->indexParams);
636 
637  /*
638  * Calculate the new list of index columns including both key columns and
639  * INCLUDE columns. Later we can determine which of these are key
640  * columns, and which are just part of the INCLUDE list by checking the
641  * list position. A list item in a position less than ii_NumIndexKeyAttrs
642  * is part of the key columns, and anything equal to and over is part of
643  * the INCLUDE columns.
644  */
645  allIndexParams = list_concat_copy(stmt->indexParams,
646  stmt->indexIncludingParams);
647  numberOfAttributes = list_length(allIndexParams);
648 
649  if (numberOfKeyAttributes <= 0)
650  ereport(ERROR,
651  (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
652  errmsg("must specify at least one column")));
653  if (numberOfAttributes > INDEX_MAX_KEYS)
654  ereport(ERROR,
655  (errcode(ERRCODE_TOO_MANY_COLUMNS),
656  errmsg("cannot use more than %d columns in an index",
657  INDEX_MAX_KEYS)));
658 
659  /*
660  * Only SELECT ... FOR UPDATE/SHARE are allowed while doing a standard
661  * index build; but for concurrent builds we allow INSERT/UPDATE/DELETE
662  * (but not VACUUM).
663  *
664  * NB: Caller is responsible for making sure that tableId refers to the
665  * relation on which the index should be built; except in bootstrap mode,
666  * this will typically require the caller to have already locked the
667  * relation. To avoid lock upgrade hazards, that lock should be at least
668  * as strong as the one we take here.
669  *
670  * NB: If the lock strength here ever changes, code that is run by
671  * parallel workers under the control of certain particular ambuild
672  * functions will need to be updated, too.
673  */
674  lockmode = concurrent ? ShareUpdateExclusiveLock : ShareLock;
675  rel = table_open(tableId, lockmode);
676 
677  /*
678  * Switch to the table owner's userid, so that any index functions are run
679  * as that user. Also lock down security-restricted operations. We
680  * already arranged to make GUC variable changes local to this command.
681  */
682  GetUserIdAndSecContext(&root_save_userid, &root_save_sec_context);
683  SetUserIdAndSecContext(rel->rd_rel->relowner,
684  root_save_sec_context | SECURITY_RESTRICTED_OPERATION);
685 
686  namespaceId = RelationGetNamespace(rel);
687 
688  /*
689  * It has exclusion constraint behavior if it's an EXCLUDE constraint or a
690  * temporal PRIMARY KEY/UNIQUE constraint
691  */
692  exclusion = stmt->excludeOpNames || stmt->iswithoutoverlaps;
693 
694  /* Ensure that it makes sense to index this kind of relation */
695  switch (rel->rd_rel->relkind)
696  {
697  case RELKIND_RELATION:
698  case RELKIND_MATVIEW:
699  case RELKIND_PARTITIONED_TABLE:
700  /* OK */
701  break;
702  default:
703  ereport(ERROR,
704  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
705  errmsg("cannot create index on relation \"%s\"",
707  errdetail_relkind_not_supported(rel->rd_rel->relkind)));
708  break;
709  }
710 
711  /*
712  * Establish behavior for partitioned tables, and verify sanity of
713  * parameters.
714  *
715  * We do not build an actual index in this case; we only create a few
716  * catalog entries. The actual indexes are built by recursing for each
717  * partition.
718  */
719  partitioned = rel->rd_rel->relkind == RELKIND_PARTITIONED_TABLE;
720  if (partitioned)
721  {
722  /*
723  * Note: we check 'stmt->concurrent' rather than 'concurrent', so that
724  * the error is thrown also for temporary tables. Seems better to be
725  * consistent, even though we could do it on temporary table because
726  * we're not actually doing it concurrently.
727  */
728  if (stmt->concurrent)
729  ereport(ERROR,
730  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
731  errmsg("cannot create index on partitioned table \"%s\" concurrently",
732  RelationGetRelationName(rel))));
733  }
734 
735  /*
736  * Don't try to CREATE INDEX on temp tables of other backends.
737  */
738  if (RELATION_IS_OTHER_TEMP(rel))
739  ereport(ERROR,
740  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
741  errmsg("cannot create indexes on temporary tables of other sessions")));
742 
743  /*
744  * Unless our caller vouches for having checked this already, insist that
745  * the table not be in use by our own session, either. Otherwise we might
746  * fail to make entries in the new index (for instance, if an INSERT or
747  * UPDATE is in progress and has already made its list of target indexes).
748  */
749  if (check_not_in_use)
750  CheckTableNotInUse(rel, "CREATE INDEX");
751 
752  /*
753  * Verify we (still) have CREATE rights in the rel's namespace.
754  * (Presumably we did when the rel was created, but maybe not anymore.)
755  * Skip check if caller doesn't want it. Also skip check if
756  * bootstrapping, since permissions machinery may not be working yet.
757  */
758  if (check_rights && !IsBootstrapProcessingMode())
759  {
760  AclResult aclresult;
761 
762  aclresult = object_aclcheck(NamespaceRelationId, namespaceId, root_save_userid,
763  ACL_CREATE);
764  if (aclresult != ACLCHECK_OK)
765  aclcheck_error(aclresult, OBJECT_SCHEMA,
766  get_namespace_name(namespaceId));
767  }
768 
769  /*
770  * Select tablespace to use. If not specified, use default tablespace
771  * (which may in turn default to database's default).
772  */
773  if (stmt->tableSpace)
774  {
775  tablespaceId = get_tablespace_oid(stmt->tableSpace, false);
776  if (partitioned && tablespaceId == MyDatabaseTableSpace)
777  ereport(ERROR,
778  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
779  errmsg("cannot specify default tablespace for partitioned relations")));
780  }
781  else
782  {
783  tablespaceId = GetDefaultTablespace(rel->rd_rel->relpersistence,
784  partitioned);
785  /* note InvalidOid is OK in this case */
786  }
787 
788  /* Check tablespace permissions */
789  if (check_rights &&
790  OidIsValid(tablespaceId) && tablespaceId != MyDatabaseTableSpace)
791  {
792  AclResult aclresult;
793 
794  aclresult = object_aclcheck(TableSpaceRelationId, tablespaceId, root_save_userid,
795  ACL_CREATE);
796  if (aclresult != ACLCHECK_OK)
798  get_tablespace_name(tablespaceId));
799  }
800 
801  /*
802  * Force shared indexes into the pg_global tablespace. This is a bit of a
803  * hack but seems simpler than marking them in the BKI commands. On the
804  * other hand, if it's not shared, don't allow it to be placed there.
805  */
806  if (rel->rd_rel->relisshared)
807  tablespaceId = GLOBALTABLESPACE_OID;
808  else if (tablespaceId == GLOBALTABLESPACE_OID)
809  ereport(ERROR,
810  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
811  errmsg("only shared relations can be placed in pg_global tablespace")));
812 
813  /*
814  * Choose the index column names.
815  */
816  indexColNames = ChooseIndexColumnNames(allIndexParams);
817 
818  /*
819  * Select name for index if caller didn't specify
820  */
821  indexRelationName = stmt->idxname;
822  if (indexRelationName == NULL)
823  indexRelationName = ChooseIndexName(RelationGetRelationName(rel),
824  namespaceId,
825  indexColNames,
826  stmt->excludeOpNames,
827  stmt->primary,
828  stmt->isconstraint);
829 
830  /*
831  * look up the access method, verify it can handle the requested features
832  */
833  accessMethodName = stmt->accessMethod;
834  tuple = SearchSysCache1(AMNAME, PointerGetDatum(accessMethodName));
835  if (!HeapTupleIsValid(tuple))
836  {
837  /*
838  * Hack to provide more-or-less-transparent updating of old RTREE
839  * indexes to GiST: if RTREE is requested and not found, use GIST.
840  */
841  if (strcmp(accessMethodName, "rtree") == 0)
842  {
843  ereport(NOTICE,
844  (errmsg("substituting access method \"gist\" for obsolete method \"rtree\"")));
845  accessMethodName = "gist";
846  tuple = SearchSysCache1(AMNAME, PointerGetDatum(accessMethodName));
847  }
848 
849  if (!HeapTupleIsValid(tuple))
850  ereport(ERROR,
851  (errcode(ERRCODE_UNDEFINED_OBJECT),
852  errmsg("access method \"%s\" does not exist",
853  accessMethodName)));
854  }
855  accessMethodForm = (Form_pg_am) GETSTRUCT(tuple);
856  accessMethodId = accessMethodForm->oid;
857  amRoutine = GetIndexAmRoutine(accessMethodForm->amhandler);
858 
860  accessMethodId);
861 
862  if (stmt->unique && !stmt->iswithoutoverlaps && !amRoutine->amcanunique)
863  ereport(ERROR,
864  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
865  errmsg("access method \"%s\" does not support unique indexes",
866  accessMethodName)));
867  if (stmt->indexIncludingParams != NIL && !amRoutine->amcaninclude)
868  ereport(ERROR,
869  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
870  errmsg("access method \"%s\" does not support included columns",
871  accessMethodName)));
872  if (numberOfKeyAttributes > 1 && !amRoutine->amcanmulticol)
873  ereport(ERROR,
874  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
875  errmsg("access method \"%s\" does not support multicolumn indexes",
876  accessMethodName)));
877  if (exclusion && amRoutine->amgettuple == NULL)
878  ereport(ERROR,
879  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
880  errmsg("access method \"%s\" does not support exclusion constraints",
881  accessMethodName)));
882 
883  amcanorder = amRoutine->amcanorder;
884  amoptions = amRoutine->amoptions;
885  amissummarizing = amRoutine->amsummarizing;
886 
887  pfree(amRoutine);
888  ReleaseSysCache(tuple);
889 
890  /*
891  * Validate predicate, if given
892  */
893  if (stmt->whereClause)
894  CheckPredicate((Expr *) stmt->whereClause);
895 
896  /*
897  * Parse AM-specific options, convert to text array form, validate.
898  */
899  reloptions = transformRelOptions((Datum) 0, stmt->options,
900  NULL, NULL, false, false);
901 
902  (void) index_reloptions(amoptions, reloptions, true);
903 
904  /*
905  * Prepare arguments for index_create, primarily an IndexInfo structure.
906  * Note that predicates must be in implicit-AND format. In a concurrent
907  * build, mark it not-ready-for-inserts.
908  */
909  indexInfo = makeIndexInfo(numberOfAttributes,
910  numberOfKeyAttributes,
911  accessMethodId,
912  NIL, /* expressions, NIL for now */
913  make_ands_implicit((Expr *) stmt->whereClause),
914  stmt->unique,
915  stmt->nulls_not_distinct,
916  !concurrent,
917  concurrent,
918  amissummarizing);
919 
920  typeIds = palloc_array(Oid, numberOfAttributes);
921  collationIds = palloc_array(Oid, numberOfAttributes);
922  opclassIds = palloc_array(Oid, numberOfAttributes);
923  opclassOptions = palloc_array(Datum, numberOfAttributes);
924  coloptions = palloc_array(int16, numberOfAttributes);
925  ComputeIndexAttrs(indexInfo,
926  typeIds, collationIds, opclassIds, opclassOptions,
927  coloptions, allIndexParams,
928  stmt->excludeOpNames, tableId,
929  accessMethodName, accessMethodId,
930  amcanorder, stmt->isconstraint, stmt->iswithoutoverlaps,
931  root_save_userid, root_save_sec_context,
932  &root_save_nestlevel);
933 
934  /*
935  * Extra checks when creating a PRIMARY KEY index.
936  */
937  if (stmt->primary)
938  index_check_primary_key(rel, indexInfo, is_alter_table, stmt);
939 
940  /*
941  * If this table is partitioned and we're creating a unique index, primary
942  * key, or exclusion constraint, make sure that the partition key is a
943  * subset of the index's columns. Otherwise it would be possible to
944  * violate uniqueness by putting values that ought to be unique in
945  * different partitions.
946  *
947  * We could lift this limitation if we had global indexes, but those have
948  * their own problems, so this is a useful feature combination.
949  */
950  if (partitioned && (stmt->unique || exclusion))
951  {
953  const char *constraint_type;
954  int i;
955 
956  if (stmt->primary)
957  constraint_type = "PRIMARY KEY";
958  else if (stmt->unique)
959  constraint_type = "UNIQUE";
960  else if (stmt->excludeOpNames)
961  constraint_type = "EXCLUDE";
962  else
963  {
964  elog(ERROR, "unknown constraint type");
965  constraint_type = NULL; /* keep compiler quiet */
966  }
967 
968  /*
969  * Verify that all the columns in the partition key appear in the
970  * unique key definition, with the same notion of equality.
971  */
972  for (i = 0; i < key->partnatts; i++)
973  {
974  bool found = false;
975  int eq_strategy;
976  Oid ptkey_eqop;
977  int j;
978 
979  /*
980  * Identify the equality operator associated with this partkey
981  * column. For list and range partitioning, partkeys use btree
982  * operator classes; hash partitioning uses hash operator classes.
983  * (Keep this in sync with ComputePartitionAttrs!)
984  */
985  if (key->strategy == PARTITION_STRATEGY_HASH)
986  eq_strategy = HTEqualStrategyNumber;
987  else
988  eq_strategy = BTEqualStrategyNumber;
989 
990  ptkey_eqop = get_opfamily_member(key->partopfamily[i],
991  key->partopcintype[i],
992  key->partopcintype[i],
993  eq_strategy);
994  if (!OidIsValid(ptkey_eqop))
995  elog(ERROR, "missing operator %d(%u,%u) in partition opfamily %u",
996  eq_strategy, key->partopcintype[i], key->partopcintype[i],
997  key->partopfamily[i]);
998 
999  /*
1000  * We'll need to be able to identify the equality operators
1001  * associated with index columns, too. We know what to do with
1002  * btree opclasses; if there are ever any other index types that
1003  * support unique indexes, this logic will need extension. But if
1004  * we have an exclusion constraint (or a temporal PK), it already
1005  * knows the operators, so we don't have to infer them.
1006  */
1007  if (stmt->unique && !stmt->iswithoutoverlaps && accessMethodId != BTREE_AM_OID)
1008  ereport(ERROR,
1009  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1010  errmsg("cannot match partition key to an index using access method \"%s\"",
1011  accessMethodName)));
1012 
1013  /*
1014  * It may be possible to support UNIQUE constraints when partition
1015  * keys are expressions, but is it worth it? Give up for now.
1016  */
1017  if (key->partattrs[i] == 0)
1018  ereport(ERROR,
1019  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1020  errmsg("unsupported %s constraint with partition key definition",
1021  constraint_type),
1022  errdetail("%s constraints cannot be used when partition keys include expressions.",
1023  constraint_type)));
1024 
1025  /* Search the index column(s) for a match */
1026  for (j = 0; j < indexInfo->ii_NumIndexKeyAttrs; j++)
1027  {
1028  if (key->partattrs[i] == indexInfo->ii_IndexAttrNumbers[j])
1029  {
1030  /*
1031  * Matched the column, now what about the collation and
1032  * equality op?
1033  */
1034  Oid idx_opfamily;
1035  Oid idx_opcintype;
1036 
1037  if (key->partcollation[i] != collationIds[j])
1038  continue;
1039 
1040  if (get_opclass_opfamily_and_input_type(opclassIds[j],
1041  &idx_opfamily,
1042  &idx_opcintype))
1043  {
1044  Oid idx_eqop = InvalidOid;
1045 
1046  if (stmt->unique && !stmt->iswithoutoverlaps)
1047  idx_eqop = get_opfamily_member(idx_opfamily,
1048  idx_opcintype,
1049  idx_opcintype,
1051  else if (exclusion)
1052  idx_eqop = indexInfo->ii_ExclusionOps[j];
1053  Assert(idx_eqop);
1054 
1055  if (ptkey_eqop == idx_eqop)
1056  {
1057  found = true;
1058  break;
1059  }
1060  else if (exclusion)
1061  {
1062  /*
1063  * We found a match, but it's not an equality
1064  * operator. Instead of failing below with an
1065  * error message about a missing column, fail now
1066  * and explain that the operator is wrong.
1067  */
1068  Form_pg_attribute att = TupleDescAttr(RelationGetDescr(rel), key->partattrs[i] - 1);
1069 
1070  ereport(ERROR,
1071  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1072  errmsg("cannot match partition key to index on column \"%s\" using non-equal operator \"%s\"",
1073  NameStr(att->attname),
1074  get_opname(indexInfo->ii_ExclusionOps[j]))));
1075  }
1076  }
1077  }
1078  }
1079 
1080  if (!found)
1081  {
1082  Form_pg_attribute att;
1083 
1084  att = TupleDescAttr(RelationGetDescr(rel),
1085  key->partattrs[i] - 1);
1086  ereport(ERROR,
1087  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1088  errmsg("unique constraint on partitioned table must include all partitioning columns"),
1089  errdetail("%s constraint on table \"%s\" lacks column \"%s\" which is part of the partition key.",
1090  constraint_type, RelationGetRelationName(rel),
1091  NameStr(att->attname))));
1092  }
1093  }
1094  }
1095 
1096 
1097  /*
1098  * We disallow indexes on system columns. They would not necessarily get
1099  * updated correctly, and they don't seem useful anyway.
1100  */
1101  for (int i = 0; i < indexInfo->ii_NumIndexAttrs; i++)
1102  {
1103  AttrNumber attno = indexInfo->ii_IndexAttrNumbers[i];
1104 
1105  if (attno < 0)
1106  ereport(ERROR,
1107  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1108  errmsg("index creation on system columns is not supported")));
1109  }
1110 
1111  /*
1112  * Also check for system columns used in expressions or predicates.
1113  */
1114  if (indexInfo->ii_Expressions || indexInfo->ii_Predicate)
1115  {
1116  Bitmapset *indexattrs = NULL;
1117 
1118  pull_varattnos((Node *) indexInfo->ii_Expressions, 1, &indexattrs);
1119  pull_varattnos((Node *) indexInfo->ii_Predicate, 1, &indexattrs);
1120 
1121  for (int i = FirstLowInvalidHeapAttributeNumber + 1; i < 0; i++)
1122  {
1124  indexattrs))
1125  ereport(ERROR,
1126  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1127  errmsg("index creation on system columns is not supported")));
1128  }
1129  }
1130 
1131  /* Is index safe for others to ignore? See set_indexsafe_procflags() */
1132  safe_index = indexInfo->ii_Expressions == NIL &&
1133  indexInfo->ii_Predicate == NIL;
1134 
1135  /*
1136  * Report index creation if appropriate (delay this till after most of the
1137  * error checks)
1138  */
1139  if (stmt->isconstraint && !quiet)
1140  {
1141  const char *constraint_type;
1142 
1143  if (stmt->primary)
1144  constraint_type = "PRIMARY KEY";
1145  else if (stmt->unique)
1146  constraint_type = "UNIQUE";
1147  else if (stmt->excludeOpNames)
1148  constraint_type = "EXCLUDE";
1149  else
1150  {
1151  elog(ERROR, "unknown constraint type");
1152  constraint_type = NULL; /* keep compiler quiet */
1153  }
1154 
1155  ereport(DEBUG1,
1156  (errmsg_internal("%s %s will create implicit index \"%s\" for table \"%s\"",
1157  is_alter_table ? "ALTER TABLE / ADD" : "CREATE TABLE /",
1158  constraint_type,
1159  indexRelationName, RelationGetRelationName(rel))));
1160  }
1161 
1162  /*
1163  * A valid stmt->oldNumber implies that we already have a built form of
1164  * the index. The caller should also decline any index build.
1165  */
1166  Assert(!RelFileNumberIsValid(stmt->oldNumber) || (skip_build && !concurrent));
1167 
1168  /*
1169  * Make the catalog entries for the index, including constraints. This
1170  * step also actually builds the index, except if caller requested not to
1171  * or in concurrent mode, in which case it'll be done later, or doing a
1172  * partitioned index (because those don't have storage).
1173  */
1174  flags = constr_flags = 0;
1175  if (stmt->isconstraint)
1176  flags |= INDEX_CREATE_ADD_CONSTRAINT;
1177  if (skip_build || concurrent || partitioned)
1178  flags |= INDEX_CREATE_SKIP_BUILD;
1179  if (stmt->if_not_exists)
1180  flags |= INDEX_CREATE_IF_NOT_EXISTS;
1181  if (concurrent)
1182  flags |= INDEX_CREATE_CONCURRENT;
1183  if (partitioned)
1184  flags |= INDEX_CREATE_PARTITIONED;
1185  if (stmt->primary)
1186  flags |= INDEX_CREATE_IS_PRIMARY;
1187 
1188  /*
1189  * If the table is partitioned, and recursion was declined but partitions
1190  * exist, mark the index as invalid.
1191  */
1192  if (partitioned && stmt->relation && !stmt->relation->inh)
1193  {
1194  PartitionDesc pd = RelationGetPartitionDesc(rel, true);
1195 
1196  if (pd->nparts != 0)
1197  flags |= INDEX_CREATE_INVALID;
1198  }
1199 
1200  if (stmt->deferrable)
1201  constr_flags |= INDEX_CONSTR_CREATE_DEFERRABLE;
1202  if (stmt->initdeferred)
1203  constr_flags |= INDEX_CONSTR_CREATE_INIT_DEFERRED;
1204  if (stmt->iswithoutoverlaps)
1205  constr_flags |= INDEX_CONSTR_CREATE_WITHOUT_OVERLAPS;
1206 
1207  indexRelationId =
1208  index_create(rel, indexRelationName, indexRelationId, parentIndexId,
1209  parentConstraintId,
1210  stmt->oldNumber, indexInfo, indexColNames,
1211  accessMethodId, tablespaceId,
1212  collationIds, opclassIds, opclassOptions,
1213  coloptions, NULL, reloptions,
1214  flags, constr_flags,
1215  allowSystemTableMods, !check_rights,
1216  &createdConstraintId);
1217 
1218  ObjectAddressSet(address, RelationRelationId, indexRelationId);
1219 
1220  if (!OidIsValid(indexRelationId))
1221  {
1222  /*
1223  * Roll back any GUC changes executed by index functions. Also revert
1224  * to original default_tablespace if we changed it above.
1225  */
1226  AtEOXact_GUC(false, root_save_nestlevel);
1227 
1228  /* Restore userid and security context */
1229  SetUserIdAndSecContext(root_save_userid, root_save_sec_context);
1230 
1231  table_close(rel, NoLock);
1232 
1233  /* If this is the top-level index, we're done */
1234  if (!OidIsValid(parentIndexId))
1236 
1237  return address;
1238  }
1239 
1240  /*
1241  * Roll back any GUC changes executed by index functions, and keep
1242  * subsequent changes local to this command. This is essential if some
1243  * index function changed a behavior-affecting GUC, e.g. search_path.
1244  */
1245  AtEOXact_GUC(false, root_save_nestlevel);
1246  root_save_nestlevel = NewGUCNestLevel();
1247 
1248  /* Add any requested comment */
1249  if (stmt->idxcomment != NULL)
1250  CreateComments(indexRelationId, RelationRelationId, 0,
1251  stmt->idxcomment);
1252 
1253  if (partitioned)
1254  {
1255  PartitionDesc partdesc;
1256 
1257  /*
1258  * Unless caller specified to skip this step (via ONLY), process each
1259  * partition to make sure they all contain a corresponding index.
1260  *
1261  * If we're called internally (no stmt->relation), recurse always.
1262  */
1263  partdesc = RelationGetPartitionDesc(rel, true);
1264  if ((!stmt->relation || stmt->relation->inh) && partdesc->nparts > 0)
1265  {
1266  int nparts = partdesc->nparts;
1267  Oid *part_oids = palloc_array(Oid, nparts);
1268  bool invalidate_parent = false;
1269  Relation parentIndex;
1270  TupleDesc parentDesc;
1271 
1272  /*
1273  * Report the total number of partitions at the start of the
1274  * command; don't update it when being called recursively.
1275  */
1276  if (!OidIsValid(parentIndexId))
1277  {
1278  /*
1279  * When called by ProcessUtilitySlow, the number of partitions
1280  * is passed in as an optimization; but other callers pass -1
1281  * since they don't have the value handy. This should count
1282  * partitions the same way, ie one less than the number of
1283  * relations find_all_inheritors reports.
1284  *
1285  * We assume we needn't ask find_all_inheritors to take locks,
1286  * because that should have happened already for all callers.
1287  * Even if it did not, this is safe as long as we don't try to
1288  * touch the partitions here; the worst consequence would be a
1289  * bogus progress-reporting total.
1290  */
1291  if (total_parts < 0)
1292  {
1293  List *children = find_all_inheritors(tableId, NoLock, NULL);
1294 
1295  total_parts = list_length(children) - 1;
1296  list_free(children);
1297  }
1298 
1300  total_parts);
1301  }
1302 
1303  /* Make a local copy of partdesc->oids[], just for safety */
1304  memcpy(part_oids, partdesc->oids, sizeof(Oid) * nparts);
1305 
1306  /*
1307  * We'll need an IndexInfo describing the parent index. The one
1308  * built above is almost good enough, but not quite, because (for
1309  * example) its predicate expression if any hasn't been through
1310  * expression preprocessing. The most reliable way to get an
1311  * IndexInfo that will match those for child indexes is to build
1312  * it the same way, using BuildIndexInfo().
1313  */
1314  parentIndex = index_open(indexRelationId, lockmode);
1315  indexInfo = BuildIndexInfo(parentIndex);
1316 
1317  parentDesc = RelationGetDescr(rel);
1318 
1319  /*
1320  * For each partition, scan all existing indexes; if one matches
1321  * our index definition and is not already attached to some other
1322  * parent index, attach it to the one we just created.
1323  *
1324  * If none matches, build a new index by calling ourselves
1325  * recursively with the same options (except for the index name).
1326  */
1327  for (int i = 0; i < nparts; i++)
1328  {
1329  Oid childRelid = part_oids[i];
1330  Relation childrel;
1331  Oid child_save_userid;
1332  int child_save_sec_context;
1333  int child_save_nestlevel;
1334  List *childidxs;
1335  ListCell *cell;
1336  AttrMap *attmap;
1337  bool found = false;
1338 
1339  childrel = table_open(childRelid, lockmode);
1340 
1341  GetUserIdAndSecContext(&child_save_userid,
1342  &child_save_sec_context);
1343  SetUserIdAndSecContext(childrel->rd_rel->relowner,
1344  child_save_sec_context | SECURITY_RESTRICTED_OPERATION);
1345  child_save_nestlevel = NewGUCNestLevel();
1347 
1348  /*
1349  * Don't try to create indexes on foreign tables, though. Skip
1350  * those if a regular index, or fail if trying to create a
1351  * constraint index.
1352  */
1353  if (childrel->rd_rel->relkind == RELKIND_FOREIGN_TABLE)
1354  {
1355  if (stmt->unique || stmt->primary)
1356  ereport(ERROR,
1357  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
1358  errmsg("cannot create unique index on partitioned table \"%s\"",
1360  errdetail("Table \"%s\" contains partitions that are foreign tables.",
1361  RelationGetRelationName(rel))));
1362 
1363  AtEOXact_GUC(false, child_save_nestlevel);
1364  SetUserIdAndSecContext(child_save_userid,
1365  child_save_sec_context);
1366  table_close(childrel, lockmode);
1367  continue;
1368  }
1369 
1370  childidxs = RelationGetIndexList(childrel);
1371  attmap =
1373  parentDesc,
1374  false);
1375 
1376  foreach(cell, childidxs)
1377  {
1378  Oid cldidxid = lfirst_oid(cell);
1379  Relation cldidx;
1380  IndexInfo *cldIdxInfo;
1381 
1382  /* this index is already partition of another one */
1383  if (has_superclass(cldidxid))
1384  continue;
1385 
1386  cldidx = index_open(cldidxid, lockmode);
1387  cldIdxInfo = BuildIndexInfo(cldidx);
1388  if (CompareIndexInfo(cldIdxInfo, indexInfo,
1389  cldidx->rd_indcollation,
1390  parentIndex->rd_indcollation,
1391  cldidx->rd_opfamily,
1392  parentIndex->rd_opfamily,
1393  attmap))
1394  {
1395  Oid cldConstrOid = InvalidOid;
1396 
1397  /*
1398  * Found a match.
1399  *
1400  * If this index is being created in the parent
1401  * because of a constraint, then the child needs to
1402  * have a constraint also, so look for one. If there
1403  * is no such constraint, this index is no good, so
1404  * keep looking.
1405  */
1406  if (createdConstraintId != InvalidOid)
1407  {
1408  cldConstrOid =
1410  cldidxid);
1411  if (cldConstrOid == InvalidOid)
1412  {
1413  index_close(cldidx, lockmode);
1414  continue;
1415  }
1416  }
1417 
1418  /* Attach index to parent and we're done. */
1419  IndexSetParentIndex(cldidx, indexRelationId);
1420  if (createdConstraintId != InvalidOid)
1421  ConstraintSetParentConstraint(cldConstrOid,
1422  createdConstraintId,
1423  childRelid);
1424 
1425  if (!cldidx->rd_index->indisvalid)
1426  invalidate_parent = true;
1427 
1428  found = true;
1429 
1430  /*
1431  * Report this partition as processed. Note that if
1432  * the partition has children itself, we'd ideally
1433  * count the children and update the progress report
1434  * for all of them; but that seems unduly expensive.
1435  * Instead, the progress report will act like all such
1436  * indirect children were processed in zero time at
1437  * the end of the command.
1438  */
1440 
1441  /* keep lock till commit */
1442  index_close(cldidx, NoLock);
1443  break;
1444  }
1445 
1446  index_close(cldidx, lockmode);
1447  }
1448 
1449  list_free(childidxs);
1450  AtEOXact_GUC(false, child_save_nestlevel);
1451  SetUserIdAndSecContext(child_save_userid,
1452  child_save_sec_context);
1453  table_close(childrel, NoLock);
1454 
1455  /*
1456  * If no matching index was found, create our own.
1457  */
1458  if (!found)
1459  {
1460  IndexStmt *childStmt = copyObject(stmt);
1461  bool found_whole_row;
1462  ListCell *lc;
1463  ObjectAddress childAddr;
1464 
1465  /*
1466  * We can't use the same index name for the child index,
1467  * so clear idxname to let the recursive invocation choose
1468  * a new name. Likewise, the existing target relation
1469  * field is wrong, and if indexOid or oldNumber are set,
1470  * they mustn't be applied to the child either.
1471  */
1472  childStmt->idxname = NULL;
1473  childStmt->relation = NULL;
1474  childStmt->indexOid = InvalidOid;
1475  childStmt->oldNumber = InvalidRelFileNumber;
1478 
1479  /*
1480  * Adjust any Vars (both in expressions and in the index's
1481  * WHERE clause) to match the partition's column numbering
1482  * in case it's different from the parent's.
1483  */
1484  foreach(lc, childStmt->indexParams)
1485  {
1486  IndexElem *ielem = lfirst(lc);
1487 
1488  /*
1489  * If the index parameter is an expression, we must
1490  * translate it to contain child Vars.
1491  */
1492  if (ielem->expr)
1493  {
1494  ielem->expr =
1495  map_variable_attnos((Node *) ielem->expr,
1496  1, 0, attmap,
1497  InvalidOid,
1498  &found_whole_row);
1499  if (found_whole_row)
1500  elog(ERROR, "cannot convert whole-row table reference");
1501  }
1502  }
1503  childStmt->whereClause =
1504  map_variable_attnos(stmt->whereClause, 1, 0,
1505  attmap,
1506  InvalidOid, &found_whole_row);
1507  if (found_whole_row)
1508  elog(ERROR, "cannot convert whole-row table reference");
1509 
1510  /*
1511  * Recurse as the starting user ID. Callee will use that
1512  * for permission checks, then switch again.
1513  */
1514  Assert(GetUserId() == child_save_userid);
1515  SetUserIdAndSecContext(root_save_userid,
1516  root_save_sec_context);
1517  childAddr =
1518  DefineIndex(childRelid, childStmt,
1519  InvalidOid, /* no predefined OID */
1520  indexRelationId, /* this is our child */
1521  createdConstraintId,
1522  -1,
1523  is_alter_table, check_rights,
1524  check_not_in_use,
1525  skip_build, quiet);
1526  SetUserIdAndSecContext(child_save_userid,
1527  child_save_sec_context);
1528 
1529  /*
1530  * Check if the index just created is valid or not, as it
1531  * could be possible that it has been switched as invalid
1532  * when recursing across multiple partition levels.
1533  */
1534  if (!get_index_isvalid(childAddr.objectId))
1535  invalidate_parent = true;
1536  }
1537 
1538  free_attrmap(attmap);
1539  }
1540 
1541  index_close(parentIndex, lockmode);
1542 
1543  /*
1544  * The pg_index row we inserted for this index was marked
1545  * indisvalid=true. But if we attached an existing index that is
1546  * invalid, this is incorrect, so update our row to invalid too.
1547  */
1548  if (invalidate_parent)
1549  {
1550  Relation pg_index = table_open(IndexRelationId, RowExclusiveLock);
1551  HeapTuple tup,
1552  newtup;
1553 
1554  tup = SearchSysCache1(INDEXRELID,
1555  ObjectIdGetDatum(indexRelationId));
1556  if (!HeapTupleIsValid(tup))
1557  elog(ERROR, "cache lookup failed for index %u",
1558  indexRelationId);
1559  newtup = heap_copytuple(tup);
1560  ((Form_pg_index) GETSTRUCT(newtup))->indisvalid = false;
1561  CatalogTupleUpdate(pg_index, &tup->t_self, newtup);
1562  ReleaseSysCache(tup);
1563  table_close(pg_index, RowExclusiveLock);
1564  heap_freetuple(newtup);
1565 
1566  /*
1567  * CCI here to make this update visible, in case this recurses
1568  * across multiple partition levels.
1569  */
1571  }
1572  }
1573 
1574  /*
1575  * Indexes on partitioned tables are not themselves built, so we're
1576  * done here.
1577  */
1578  AtEOXact_GUC(false, root_save_nestlevel);
1579  SetUserIdAndSecContext(root_save_userid, root_save_sec_context);
1580  table_close(rel, NoLock);
1581  if (!OidIsValid(parentIndexId))
1583  else
1584  {
1585  /* Update progress for an intermediate partitioned index itself */
1587  }
1588 
1589  return address;
1590  }
1591 
1592  AtEOXact_GUC(false, root_save_nestlevel);
1593  SetUserIdAndSecContext(root_save_userid, root_save_sec_context);
1594 
1595  if (!concurrent)
1596  {
1597  /* Close the heap and we're done, in the non-concurrent case */
1598  table_close(rel, NoLock);
1599 
1600  /*
1601  * If this is the top-level index, the command is done overall;
1602  * otherwise, increment progress to report one child index is done.
1603  */
1604  if (!OidIsValid(parentIndexId))
1606  else
1608 
1609  return address;
1610  }
1611 
1612  /* save lockrelid and locktag for below, then close rel */
1613  heaprelid = rel->rd_lockInfo.lockRelId;
1614  SET_LOCKTAG_RELATION(heaplocktag, heaprelid.dbId, heaprelid.relId);
1615  table_close(rel, NoLock);
1616 
1617  /*
1618  * For a concurrent build, it's important to make the catalog entries
1619  * visible to other transactions before we start to build the index. That
1620  * will prevent them from making incompatible HOT updates. The new index
1621  * will be marked not indisready and not indisvalid, so that no one else
1622  * tries to either insert into it or use it for queries.
1623  *
1624  * We must commit our current transaction so that the index becomes
1625  * visible; then start another. Note that all the data structures we just
1626  * built are lost in the commit. The only data we keep past here are the
1627  * relation IDs.
1628  *
1629  * Before committing, get a session-level lock on the table, to ensure
1630  * that neither it nor the index can be dropped before we finish. This
1631  * cannot block, even if someone else is waiting for access, because we
1632  * already have the same lock within our transaction.
1633  *
1634  * Note: we don't currently bother with a session lock on the index,
1635  * because there are no operations that could change its state while we
1636  * hold lock on the parent table. This might need to change later.
1637  */
1639 
1643 
1644  /* Tell concurrent index builds to ignore us, if index qualifies */
1645  if (safe_index)
1647 
1648  /*
1649  * The index is now visible, so we can report the OID. While on it,
1650  * include the report for the beginning of phase 2.
1651  */
1652  {
1653  const int progress_cols[] = {
1656  };
1657  const int64 progress_vals[] = {
1658  indexRelationId,
1660  };
1661 
1662  pgstat_progress_update_multi_param(2, progress_cols, progress_vals);
1663  }
1664 
1665  /*
1666  * Phase 2 of concurrent index build (see comments for validate_index()
1667  * for an overview of how this works)
1668  *
1669  * Now we must wait until no running transaction could have the table open
1670  * with the old list of indexes. Use ShareLock to consider running
1671  * transactions that hold locks that permit writing to the table. Note we
1672  * do not need to worry about xacts that open the table for writing after
1673  * this point; they will see the new index when they open it.
1674  *
1675  * Note: the reason we use actual lock acquisition here, rather than just
1676  * checking the ProcArray and sleeping, is that deadlock is possible if
1677  * one of the transactions in question is blocked trying to acquire an
1678  * exclusive lock on our table. The lock code will detect deadlock and
1679  * error out properly.
1680  */
1681  WaitForLockers(heaplocktag, ShareLock, true);
1682 
1683  /*
1684  * At this moment we are sure that there are no transactions with the
1685  * table open for write that don't have this new index in their list of
1686  * indexes. We have waited out all the existing transactions and any new
1687  * transaction will have the new index in its list, but the index is still
1688  * marked as "not-ready-for-inserts". The index is consulted while
1689  * deciding HOT-safety though. This arrangement ensures that no new HOT
1690  * chains can be created where the new tuple and the old tuple in the
1691  * chain have different index keys.
1692  *
1693  * We now take a new snapshot, and build the index using all tuples that
1694  * are visible in this snapshot. We can be sure that any HOT updates to
1695  * these tuples will be compatible with the index, since any updates made
1696  * by transactions that didn't know about the index are now committed or
1697  * rolled back. Thus, each visible tuple is either the end of its
1698  * HOT-chain or the extension of the chain is HOT-safe for this index.
1699  */
1700 
1701  /* Set ActiveSnapshot since functions in the indexes may need it */
1703 
1704  /* Perform concurrent build of index */
1705  index_concurrently_build(tableId, indexRelationId);
1706 
1707  /* we can do away with our snapshot */
1709 
1710  /*
1711  * Commit this transaction to make the indisready update visible.
1712  */
1715 
1716  /* Tell concurrent index builds to ignore us, if index qualifies */
1717  if (safe_index)
1719 
1720  /*
1721  * Phase 3 of concurrent index build
1722  *
1723  * We once again wait until no transaction can have the table open with
1724  * the index marked as read-only for updates.
1725  */
1728  WaitForLockers(heaplocktag, ShareLock, true);
1729 
1730  /*
1731  * Now take the "reference snapshot" that will be used by validate_index()
1732  * to filter candidate tuples. Beware! There might still be snapshots in
1733  * use that treat some transaction as in-progress that our reference
1734  * snapshot treats as committed. If such a recently-committed transaction
1735  * deleted tuples in the table, we will not include them in the index; yet
1736  * those transactions which see the deleting one as still-in-progress will
1737  * expect such tuples to be there once we mark the index as valid.
1738  *
1739  * We solve this by waiting for all endangered transactions to exit before
1740  * we mark the index as valid.
1741  *
1742  * We also set ActiveSnapshot to this snap, since functions in indexes may
1743  * need a snapshot.
1744  */
1746  PushActiveSnapshot(snapshot);
1747 
1748  /*
1749  * Scan the index and the heap, insert any missing index entries.
1750  */
1751  validate_index(tableId, indexRelationId, snapshot);
1752 
1753  /*
1754  * Drop the reference snapshot. We must do this before waiting out other
1755  * snapshot holders, else we will deadlock against other processes also
1756  * doing CREATE INDEX CONCURRENTLY, which would see our snapshot as one
1757  * they must wait for. But first, save the snapshot's xmin to use as
1758  * limitXmin for GetCurrentVirtualXIDs().
1759  */
1760  limitXmin = snapshot->xmin;
1761 
1763  UnregisterSnapshot(snapshot);
1764 
1765  /*
1766  * The snapshot subsystem could still contain registered snapshots that
1767  * are holding back our process's advertised xmin; in particular, if
1768  * default_transaction_isolation = serializable, there is a transaction
1769  * snapshot that is still active. The CatalogSnapshot is likewise a
1770  * hazard. To ensure no deadlocks, we must commit and start yet another
1771  * transaction, and do our wait before any snapshot has been taken in it.
1772  */
1775 
1776  /* Tell concurrent index builds to ignore us, if index qualifies */
1777  if (safe_index)
1779 
1780  /* We should now definitely not be advertising any xmin. */
1782 
1783  /*
1784  * The index is now valid in the sense that it contains all currently
1785  * interesting tuples. But since it might not contain tuples deleted just
1786  * before the reference snap was taken, we have to wait out any
1787  * transactions that might have older snapshots.
1788  */
1791  WaitForOlderSnapshots(limitXmin, true);
1792 
1793  /*
1794  * Index can now be marked valid -- update its pg_index entry
1795  */
1797 
1798  /*
1799  * The pg_index update will cause backends (including this one) to update
1800  * relcache entries for the index itself, but we should also send a
1801  * relcache inval on the parent table to force replanning of cached plans.
1802  * Otherwise existing sessions might fail to use the new index where it
1803  * would be useful. (Note that our earlier commits did not create reasons
1804  * to replan; so relcache flush on the index itself was sufficient.)
1805  */
1807 
1808  /*
1809  * Last thing to do is release the session-level lock on the parent table.
1810  */
1812 
1814 
1815  return address;
1816 }
AclResult
Definition: acl.h:182
@ ACLCHECK_OK
Definition: acl.h:183
void aclcheck_error(AclResult aclerr, ObjectType objtype, const char *objectname)
Definition: aclchk.c:2688
AclResult object_aclcheck(Oid classid, Oid objectid, Oid roleid, AclMode mode)
Definition: aclchk.c:3876
bytea *(* amoptions_function)(Datum reloptions, bool validate)
Definition: amapi.h:144
void free_attrmap(AttrMap *map)
Definition: attmap.c:56
AttrMap * build_attrmap_by_name(TupleDesc indesc, TupleDesc outdesc, bool missing_ok)
Definition: attmap.c:177
int16 AttrNumber
Definition: attnum.h:21
char * get_tablespace_name(Oid spc_oid)
Definition: tablespace.c:1472
Oid get_tablespace_oid(const char *tablespacename, bool missing_ok)
Definition: tablespace.c:1426
Oid GetDefaultTablespace(char relpersistence, bool partitioned)
Definition: tablespace.c:1143
void pgstat_progress_start_command(ProgressCommandType cmdtype, Oid relid)
void pgstat_progress_incr_param(int index, int64 incr)
void pgstat_progress_update_param(int index, int64 val)
void pgstat_progress_update_multi_param(int nparam, const int *index, const int64 *val)
void pgstat_progress_end_command(void)
@ PROGRESS_COMMAND_CREATE_INDEX
bool bms_is_member(int x, const Bitmapset *a)
Definition: bitmapset.c:510
uint16 bits16
Definition: c.h:514
#define InvalidSubTransactionId
Definition: c.h:658
uint32 TransactionId
Definition: c.h:652
void CreateComments(Oid oid, Oid classoid, int32 subid, const char *comment)
Definition: comment.c:143
int errmsg_internal(const char *fmt,...)
Definition: elog.c:1159
#define DEBUG1
Definition: elog.h:30
#define NOTICE
Definition: elog.h:35
bool allowSystemTableMods
Definition: globals.c:127
Oid MyDatabaseTableSpace
Definition: globals.c:93
void RestrictSearchPath(void)
Definition: guc.c:2248
int set_config_option(const char *name, const char *value, GucContext context, GucSource source, GucAction action, bool changeVal, int elevel, bool is_reload)
Definition: guc.c:3333
@ GUC_ACTION_SAVE
Definition: guc.h:201
@ PGC_S_SESSION
Definition: guc.h:122
@ PGC_USERSET
Definition: guc.h:75
HeapTuple heap_copytuple(HeapTuple tuple)
Definition: heaptuple.c:776
void heap_freetuple(HeapTuple htup)
Definition: heaptuple.c:1434
#define stmt
Definition: indent_codes.h:59
void validate_index(Oid heapId, Oid indexId, Snapshot snapshot)
Definition: index.c:3294
Oid index_create(Relation heapRelation, const char *indexRelationName, Oid indexRelationId, Oid parentIndexRelid, Oid parentConstraintId, RelFileNumber relFileNumber, IndexInfo *indexInfo, const List *indexColNames, Oid accessMethodId, Oid tableSpaceId, const Oid *collationIds, const Oid *opclassIds, const Datum *opclassOptions, const int16 *coloptions, const NullableDatum *stattargets, Datum reloptions, bits16 flags, bits16 constr_flags, bool allow_system_table_mods, bool is_internal, Oid *constraintId)
Definition: index.c:724
void index_set_state_flags(Oid indexId, IndexStateFlagsAction action)
Definition: index.c:3447
bool CompareIndexInfo(const IndexInfo *info1, const IndexInfo *info2, const Oid *collations1, const Oid *collations2, const Oid *opfamilies1, const Oid *opfamilies2, const AttrMap *attmap)
Definition: index.c:2514
void index_check_primary_key(Relation heapRel, const IndexInfo *indexInfo, bool is_alter_table, const IndexStmt *stmt)
Definition: index.c:201
void index_concurrently_build(Oid heapRelationId, Oid indexRelationId)
Definition: index.c:1481
IndexInfo * BuildIndexInfo(Relation index)
Definition: index.c:2407
#define INDEX_CREATE_IS_PRIMARY
Definition: index.h:61
#define INDEX_CREATE_IF_NOT_EXISTS
Definition: index.h:65
#define INDEX_CREATE_PARTITIONED
Definition: index.h:66
#define INDEX_CREATE_INVALID
Definition: index.h:67
#define INDEX_CONSTR_CREATE_WITHOUT_OVERLAPS
Definition: index.h:96
#define INDEX_CREATE_ADD_CONSTRAINT
Definition: index.h:62
#define INDEX_CREATE_SKIP_BUILD
Definition: index.h:63
#define INDEX_CONSTR_CREATE_DEFERRABLE
Definition: index.h:92
@ INDEX_CREATE_SET_VALID
Definition: index.h:27
#define INDEX_CONSTR_CREATE_INIT_DEFERRED
Definition: index.h:93
#define INDEX_CREATE_CONCURRENT
Definition: index.h:64
ObjectAddress DefineIndex(Oid tableId, IndexStmt *stmt, Oid indexRelationId, Oid parentIndexId, Oid parentConstraintId, int total_parts, bool is_alter_table, bool check_rights, bool check_not_in_use, bool skip_build, bool quiet)
Definition: indexcmds.c:535
static void set_indexsafe_procflags(void)
Definition: indexcmds.c:4560
void IndexSetParentIndex(Relation partitionIdx, Oid parentOid)
Definition: indexcmds.c:4396
void WaitForOlderSnapshots(TransactionId limitXmin, bool progress)
Definition: indexcmds.c:428
static void CheckPredicate(Expr *predicate)
Definition: indexcmds.c:1831
static List * ChooseIndexColumnNames(const List *indexElems)
Definition: indexcmds.c:2740
static char * ChooseIndexName(const char *tabname, Oid namespaceId, const List *colnames, const List *exclusionOpNames, bool primary, bool isconstraint)
Definition: indexcmds.c:2651
void CatalogTupleUpdate(Relation heapRel, ItemPointer otid, HeapTuple tup)
Definition: indexing.c:313
void CacheInvalidateRelcacheByRelid(Oid relid)
Definition: inval.c:1419
int j
Definition: isn.c:74
void list_free(List *list)
Definition: list.c:1546
List * list_concat_copy(const List *list1, const List *list2)
Definition: list.c:598
void LockRelationIdForSession(LockRelId *relid, LOCKMODE lockmode)
Definition: lmgr.c:397
void WaitForLockers(LOCKTAG heaplocktag, LOCKMODE lockmode, bool progress)
Definition: lmgr.c:985
void UnlockRelationIdForSession(LockRelId *relid, LOCKMODE lockmode)
Definition: lmgr.c:410
#define SET_LOCKTAG_RELATION(locktag, dboid, reloid)
Definition: lock.h:181
int LOCKMODE
Definition: lockdefs.h:26
#define ShareUpdateExclusiveLock
Definition: lockdefs.h:39
#define ShareLock
Definition: lockdefs.h:40
#define RowExclusiveLock
Definition: lockdefs.h:38
char get_rel_persistence(Oid relid)
Definition: lsyscache.c:2078
char * get_opname(Oid opno)
Definition: lsyscache.c:1310
bool get_index_isvalid(Oid index_oid)
Definition: lsyscache.c:3578
char * get_namespace_name(Oid nspid)
Definition: lsyscache.c:3366
bool get_opclass_opfamily_and_input_type(Oid opclass, Oid *opfamily, Oid *opcintype)
Definition: lsyscache.c:1235
Oid get_opfamily_member(Oid opfamily, Oid lefttype, Oid righttype, int16 strategy)
Definition: lsyscache.c:166
List * make_ands_implicit(Expr *clause)
Definition: makefuncs.c:737
#define IsBootstrapProcessingMode()
Definition: miscadmin.h:454
#define SECURITY_RESTRICTED_OPERATION
Definition: miscadmin.h:315
Oid GetUserId(void)
Definition: miscinit.c:514
#define copyObject(obj)
Definition: nodes.h:224
#define ObjectAddressSet(addr, class_id, object_id)
Definition: objectaddress.h:40
@ PARTITION_STRATEGY_HASH
Definition: parsenodes.h:874
@ OBJECT_SCHEMA
Definition: parsenodes.h:2299
@ OBJECT_TABLESPACE
Definition: parsenodes.h:2305
#define ACL_CREATE
Definition: parsenodes.h:85
PartitionKey RelationGetPartitionKey(Relation rel)
Definition: partcache.c:51
PartitionDesc RelationGetPartitionDesc(Relation rel, bool omit_detached)
Definition: partdesc.c:70
int errdetail_relkind_not_supported(char relkind)
Definition: pg_class.c:24
Oid get_relation_idx_constraint_oid(Oid relationId, Oid indexId)
void ConstraintSetParentConstraint(Oid childConstrId, Oid parentConstrId, Oid childTableId)
List * find_all_inheritors(Oid parentrelId, LOCKMODE lockmode, List **numparents)
Definition: pg_inherits.c:255
bool has_superclass(Oid relationId)
Definition: pg_inherits.c:377
#define lfirst_oid(lc)
Definition: pg_list.h:174
#define PROGRESS_CREATEIDX_PARTITIONS_DONE
Definition: progress.h:89
#define PROGRESS_CREATEIDX_PHASE_WAIT_1
Definition: progress.h:93
#define PROGRESS_CREATEIDX_COMMAND_CREATE_CONCURRENTLY
Definition: progress.h:111
#define PROGRESS_CREATEIDX_ACCESS_METHOD_OID
Definition: progress.h:83
#define PROGRESS_CREATEIDX_PHASE_WAIT_3
Definition: progress.h:99
#define PROGRESS_CREATEIDX_COMMAND_CREATE
Definition: progress.h:110
#define PROGRESS_CREATEIDX_PHASE_WAIT_2
Definition: progress.h:95
#define PROGRESS_CREATEIDX_PHASE
Definition: progress.h:84
#define PROGRESS_CREATEIDX_INDEX_OID
Definition: progress.h:82
#define PROGRESS_CREATEIDX_PARTITIONS_TOTAL
Definition: progress.h:88
#define PROGRESS_CREATEIDX_COMMAND
Definition: progress.h:81
#define RelationGetDescr(relation)
Definition: rel.h:531
#define RelationGetRelationName(relation)
Definition: rel.h:539
#define RELATION_IS_OTHER_TEMP(relation)
Definition: rel.h:658
#define RelationGetNamespace(relation)
Definition: rel.h:546
List * RelationGetIndexList(Relation relation)
Definition: relcache.c:4760
bytea * index_reloptions(amoptions_function amoptions, Datum reloptions, bool validate)
Definition: reloptions.c:2054
#define InvalidRelFileNumber
Definition: relpath.h:26
#define RelFileNumberIsValid(relnumber)
Definition: relpath.h:27
Node * map_variable_attnos(Node *node, int target_varno, int sublevels_up, const AttrMap *attno_map, Oid to_rowtype, bool *found_whole_row)
Snapshot GetTransactionSnapshot(void)
Definition: snapmgr.c:216
void UnregisterSnapshot(Snapshot snapshot)
Definition: snapmgr.c:836
void PushActiveSnapshot(Snapshot snapshot)
Definition: snapmgr.c:648
Snapshot RegisterSnapshot(Snapshot snapshot)
Definition: snapmgr.c:794
void PopActiveSnapshot(void)
Definition: snapmgr.c:743
PGPROC * MyProc
Definition: proc.c:66
#define HTEqualStrategyNumber
Definition: stratnum.h:41
#define BTEqualStrategyNumber
Definition: stratnum.h:31
Definition: attmap.h:35
ItemPointerData t_self
Definition: htup.h:65
amoptions_function amoptions
Definition: amapi.h:275
amgettuple_function amgettuple
Definition: amapi.h:282
bool amcanunique
Definition: amapi.h:230
bool amcanmulticol
Definition: amapi.h:232
bool amcaninclude
Definition: amapi.h:250
int ii_NumIndexAttrs
Definition: execnodes.h:184
List * ii_Predicate
Definition: execnodes.h:189
List * indexParams
Definition: parsenodes.h:3366
Oid indexOid
Definition: parsenodes.h:3373
RangeVar * relation
Definition: parsenodes.h:3363
SubTransactionId oldFirstRelfilelocatorSubid
Definition: parsenodes.h:3376
SubTransactionId oldCreateSubid
Definition: parsenodes.h:3375
char * idxname
Definition: parsenodes.h:3362
Node * whereClause
Definition: parsenodes.h:3370
RelFileNumber oldNumber
Definition: parsenodes.h:3374
Definition: lock.h:165
LockRelId lockRelId
Definition: rel.h:46
Definition: rel.h:39
Oid relId
Definition: rel.h:40
Oid dbId
Definition: rel.h:41
TransactionId xmin
Definition: proc.h:173
LockInfoData rd_lockInfo
Definition: rel.h:114
Form_pg_index rd_index
Definition: rel.h:192
Oid * rd_opfamily
Definition: rel.h:207
Oid * rd_indcollation
Definition: rel.h:217
Form_pg_class rd_rel
Definition: rel.h:111
TransactionId xmin
Definition: snapshot.h:157
#define FirstLowInvalidHeapAttributeNumber
Definition: sysattr.h:27
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:126
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:40
void CheckTableNotInUse(Relation rel, const char *stmt)
Definition: tablecmds.c:4346
#define InvalidTransactionId
Definition: transam.h:31
void pull_varattnos(Node *node, Index varno, Bitmapset **varattnos)
Definition: var.c:291
void CommandCounterIncrement(void)
Definition: xact.c:1097
void StartTransactionCommand(void)
Definition: xact.c:2995
void CommitTransactionCommand(void)
Definition: xact.c:3093

References ACL_CREATE, aclcheck_error(), ACLCHECK_OK, allowSystemTableMods, IndexAmRoutine::amcaninclude, IndexAmRoutine::amcanmulticol, IndexAmRoutine::amcanorder, IndexAmRoutine::amcanunique, IndexAmRoutine::amgettuple, IndexAmRoutine::amoptions, IndexAmRoutine::amsummarizing, Assert, AtEOXact_GUC(), bms_is_member(), BTEqualStrategyNumber, build_attrmap_by_name(), BuildIndexInfo(), CacheInvalidateRelcacheByRelid(), CatalogTupleUpdate(), CheckPredicate(), CheckTableNotInUse(), ChooseIndexColumnNames(), ChooseIndexName(), CommandCounterIncrement(), CommitTransactionCommand(), CompareIndexInfo(), ComputeIndexAttrs(), ConstraintSetParentConstraint(), copyObject, CreateComments(), LockRelId::dbId, DEBUG1, elog, ereport, errcode(), errdetail(), errdetail_relkind_not_supported(), errmsg(), errmsg_internal(), ERROR, IndexElem::expr, find_all_inheritors(), FirstLowInvalidHeapAttributeNumber, free_attrmap(), get_index_isvalid(), get_namespace_name(), get_opclass_opfamily_and_input_type(), get_opfamily_member(), get_opname(), get_rel_persistence(), get_relation_idx_constraint_oid(), get_tablespace_name(), get_tablespace_oid(), GetDefaultTablespace(), GetIndexAmRoutine(), GETSTRUCT, GetTransactionSnapshot(), GetUserId(), GetUserIdAndSecContext(), GUC_ACTION_SAVE, has_superclass(), heap_copytuple(), heap_freetuple(), HeapTupleIsValid, HTEqualStrategyNumber, i, IndexStmt::idxname, IndexInfo::ii_ExclusionOps, IndexInfo::ii_Expressions, IndexInfo::ii_IndexAttrNumbers, IndexInfo::ii_NumIndexAttrs, IndexInfo::ii_NumIndexKeyAttrs, IndexInfo::ii_Predicate, index_check_primary_key(), index_close(), index_concurrently_build(), INDEX_CONSTR_CREATE_DEFERRABLE, INDEX_CONSTR_CREATE_INIT_DEFERRED, INDEX_CONSTR_CREATE_WITHOUT_OVERLAPS, index_create(), INDEX_CREATE_ADD_CONSTRAINT, INDEX_CREATE_CONCURRENT, INDEX_CREATE_IF_NOT_EXISTS, INDEX_CREATE_INVALID, INDEX_CREATE_IS_PRIMARY, INDEX_CREATE_PARTITIONED, INDEX_CREATE_SET_VALID, INDEX_CREATE_SKIP_BUILD, INDEX_MAX_KEYS, index_open(), index_reloptions(), index_set_state_flags(), IndexStmt::indexOid, IndexStmt::indexParams, IndexSetParentIndex(), InvalidOid, InvalidRelFileNumber, InvalidSubTransactionId, InvalidTransactionId, IsBootstrapProcessingMode, j, sort-test::key, lfirst, lfirst_oid, list_concat_copy(), list_free(), list_length(), LockRelationIdForSession(), LockInfoData::lockRelId, make_ands_implicit(), makeIndexInfo(), map_variable_attnos(), MyDatabaseTableSpace, MyProc, NameStr, NewGUCNestLevel(), NIL, NoLock, NOTICE, PartitionDescData::nparts, object_aclcheck(), OBJECT_SCHEMA, OBJECT_TABLESPACE, ObjectAddressSet, ObjectAddress::objectId, ObjectIdGetDatum(), OidIsValid, PartitionDescData::oids, IndexStmt::oldCreateSubid, IndexStmt::oldFirstRelfilelocatorSubid, IndexStmt::oldNumber, palloc_array, PARTITION_STRATEGY_HASH, pfree(), PGC_S_SESSION, PGC_USERSET, pgstat_progress_end_command(), pgstat_progress_incr_param(), pgstat_progress_start_command(), pgstat_progress_update_multi_param(), pgstat_progress_update_param(), PointerGetDatum(), PopActiveSnapshot(), PROGRESS_COMMAND_CREATE_INDEX, PROGRESS_CREATEIDX_ACCESS_METHOD_OID, PROGRESS_CREATEIDX_COMMAND, PROGRESS_CREATEIDX_COMMAND_CREATE, PROGRESS_CREATEIDX_COMMAND_CREATE_CONCURRENTLY, PROGRESS_CREATEIDX_INDEX_OID, PROGRESS_CREATEIDX_PARTITIONS_DONE, PROGRESS_CREATEIDX_PARTITIONS_TOTAL, PROGRESS_CREATEIDX_PHASE, PROGRESS_CREATEIDX_PHASE_WAIT_1, PROGRESS_CREATEIDX_PHASE_WAIT_2, PROGRESS_CREATEIDX_PHASE_WAIT_3, pull_varattnos(), PushActiveSnapshot(), RelationData::rd_indcollation, RelationData::rd_index, RelationData::rd_lockInfo, RelationData::rd_opfamily, RelationData::rd_rel, RegisterSnapshot(), IndexStmt::relation, RELATION_IS_OTHER_TEMP, RelationGetDescr, RelationGetIndexList(), RelationGetNamespace, RelationGetPartitionDesc(), RelationGetPartitionKey(), RelationGetRelationName, ReleaseSysCache(), RelFileNumberIsValid, LockRelId::relId, RestrictSearchPath(), RowExclusiveLock, SearchSysCache1(), SECURITY_RESTRICTED_OPERATION, set_config_option(), set_indexsafe_procflags(), SET_LOCKTAG_RELATION, SetUserIdAndSecContext(), ShareLock, ShareUpdateExclusiveLock, StartTransactionCommand(), stmt, HeapTupleData::t_self, table_close(), table_open(), transformRelOptions(), TupleDescAttr, UnlockRelationIdForSession(), UnregisterSnapshot(), validate_index(), WaitForLockers(), WaitForOlderSnapshots(), IndexStmt::whereClause, PGPROC::xmin, and SnapshotData::xmin.

Referenced by ATExecAddIndex(), AttachPartitionEnsureIndexes(), DefineRelation(), and ProcessUtilitySlow().

◆ ExecReindex()

void ExecReindex ( ParseState pstate,
const ReindexStmt stmt,
bool  isTopLevel 
)

Definition at line 2801 of file indexcmds.c.

2802 {
2803  ReindexParams params = {0};
2804  ListCell *lc;
2805  bool concurrently = false;
2806  bool verbose = false;
2807  char *tablespacename = NULL;
2808 
2809  /* Parse option list */
2810  foreach(lc, stmt->params)
2811  {
2812  DefElem *opt = (DefElem *) lfirst(lc);
2813 
2814  if (strcmp(opt->defname, "verbose") == 0)
2815  verbose = defGetBoolean(opt);
2816  else if (strcmp(opt->defname, "concurrently") == 0)
2817  concurrently = defGetBoolean(opt);
2818  else if (strcmp(opt->defname, "tablespace") == 0)
2819  tablespacename = defGetString(opt);
2820  else
2821  ereport(ERROR,
2822  (errcode(ERRCODE_SYNTAX_ERROR),
2823  errmsg("unrecognized REINDEX option \"%s\"",
2824  opt->defname),
2825  parser_errposition(pstate, opt->location)));
2826  }
2827 
2828  if (concurrently)
2829  PreventInTransactionBlock(isTopLevel,
2830  "REINDEX CONCURRENTLY");
2831 
2832  params.options =
2833  (verbose ? REINDEXOPT_VERBOSE : 0) |
2834  (concurrently ? REINDEXOPT_CONCURRENTLY : 0);
2835 
2836  /*
2837  * Assign the tablespace OID to move indexes to, with InvalidOid to do
2838  * nothing.
2839  */
2840  if (tablespacename != NULL)
2841  {
2842  params.tablespaceOid = get_tablespace_oid(tablespacename, false);
2843 
2844  /* Check permissions except when moving to database's default */
2845  if (OidIsValid(params.tablespaceOid) &&
2847  {
2848  AclResult aclresult;
2849 
2850  aclresult = object_aclcheck(TableSpaceRelationId, params.tablespaceOid,
2851  GetUserId(), ACL_CREATE);
2852  if (aclresult != ACLCHECK_OK)
2853  aclcheck_error(aclresult, OBJECT_TABLESPACE,
2855  }
2856  }
2857  else
2858  params.tablespaceOid = InvalidOid;
2859 
2860  switch (stmt->kind)
2861  {
2862  case REINDEX_OBJECT_INDEX:
2863  ReindexIndex(stmt, &params, isTopLevel);
2864  break;
2865  case REINDEX_OBJECT_TABLE:
2866  ReindexTable(stmt, &params, isTopLevel);
2867  break;
2868  case REINDEX_OBJECT_SCHEMA:
2869  case REINDEX_OBJECT_SYSTEM:
2871 
2872  /*
2873  * This cannot run inside a user transaction block; if we were
2874  * inside a transaction, then its commit- and
2875  * start-transaction-command calls would not have the intended
2876  * effect!
2877  */
2878  PreventInTransactionBlock(isTopLevel,
2879  (stmt->kind == REINDEX_OBJECT_SCHEMA) ? "REINDEX SCHEMA" :
2880  (stmt->kind == REINDEX_OBJECT_SYSTEM) ? "REINDEX SYSTEM" :
2881  "REINDEX DATABASE");
2882  ReindexMultipleTables(stmt, &params);
2883  break;
2884  default:
2885  elog(ERROR, "unrecognized object type: %d",
2886  (int) stmt->kind);
2887  break;
2888  }
2889 }
bool defGetBoolean(DefElem *def)
Definition: define.c:107
char * defGetString(DefElem *def)
Definition: define.c:48
int verbose
#define REINDEXOPT_CONCURRENTLY
Definition: index.h:44
#define REINDEXOPT_VERBOSE
Definition: index.h:41
static void ReindexIndex(const ReindexStmt *stmt, const ReindexParams *params, bool isTopLevel)
Definition: indexcmds.c:2896
static void ReindexMultipleTables(const ReindexStmt *stmt, const ReindexParams *params)
Definition: indexcmds.c:3085
static Oid ReindexTable(const ReindexStmt *stmt, const ReindexParams *params, bool isTopLevel)
Definition: indexcmds.c:3026
int parser_errposition(ParseState *pstate, int location)
Definition: parse_node.c:106
@ REINDEX_OBJECT_DATABASE
Definition: parsenodes.h:3983
@ REINDEX_OBJECT_INDEX
Definition: parsenodes.h:3979
@ REINDEX_OBJECT_SCHEMA
Definition: parsenodes.h:3981
@ REINDEX_OBJECT_SYSTEM
Definition: parsenodes.h:3982
@ REINDEX_OBJECT_TABLE
Definition: parsenodes.h:3980
char * defname
Definition: parsenodes.h:815
ParseLoc location
Definition: parsenodes.h:819
Oid tablespaceOid
Definition: index.h:36
bits32 options
Definition: index.h:35
void PreventInTransactionBlock(bool isTopLevel, const char *stmtType)
Definition: xact.c:3584

References ACL_CREATE, aclcheck_error(), ACLCHECK_OK, defGetBoolean(), defGetString(), DefElem::defname, elog, ereport, errcode(), errmsg(), ERROR, get_tablespace_name(), get_tablespace_oid(), GetUserId(), InvalidOid, lfirst, DefElem::location, MyDatabaseTableSpace, object_aclcheck(), OBJECT_TABLESPACE, OidIsValid, ReindexParams::options, parser_errposition(), PreventInTransactionBlock(), REINDEX_OBJECT_DATABASE, REINDEX_OBJECT_INDEX, REINDEX_OBJECT_SCHEMA, REINDEX_OBJECT_SYSTEM, REINDEX_OBJECT_TABLE, ReindexIndex(), ReindexMultipleTables(), REINDEXOPT_CONCURRENTLY, REINDEXOPT_VERBOSE, ReindexTable(), stmt, ReindexParams::tablespaceOid, and verbose.

Referenced by ProcessUtilitySlow().

◆ GetDefaultOpClass()

Oid GetDefaultOpClass ( Oid  type_id,
Oid  am_id 
)

Definition at line 2338 of file indexcmds.c.

2339 {
2340  Oid result = InvalidOid;
2341  int nexact = 0;
2342  int ncompatible = 0;
2343  int ncompatiblepreferred = 0;
2344  Relation rel;
2345  ScanKeyData skey[1];
2346  SysScanDesc scan;
2347  HeapTuple tup;
2348  TYPCATEGORY tcategory;
2349 
2350  /* If it's a domain, look at the base type instead */
2351  type_id = getBaseType(type_id);
2352 
2353  tcategory = TypeCategory(type_id);
2354 
2355  /*
2356  * We scan through all the opclasses available for the access method,
2357  * looking for one that is marked default and matches the target type
2358  * (either exactly or binary-compatibly, but prefer an exact match).
2359  *
2360  * We could find more than one binary-compatible match. If just one is
2361  * for a preferred type, use that one; otherwise we fail, forcing the user
2362  * to specify which one he wants. (The preferred-type special case is a
2363  * kluge for varchar: it's binary-compatible to both text and bpchar, so
2364  * we need a tiebreaker.) If we find more than one exact match, then
2365  * someone put bogus entries in pg_opclass.
2366  */
2367  rel = table_open(OperatorClassRelationId, AccessShareLock);
2368 
2369  ScanKeyInit(&skey[0],
2370  Anum_pg_opclass_opcmethod,
2371  BTEqualStrategyNumber, F_OIDEQ,
2372  ObjectIdGetDatum(am_id));
2373 
2374  scan = systable_beginscan(rel, OpclassAmNameNspIndexId, true,
2375  NULL, 1, skey);
2376 
2377  while (HeapTupleIsValid(tup = systable_getnext(scan)))
2378  {
2379  Form_pg_opclass opclass = (Form_pg_opclass) GETSTRUCT(tup);
2380 
2381  /* ignore altogether if not a default opclass */
2382  if (!opclass->opcdefault)
2383  continue;
2384  if (opclass->opcintype == type_id)
2385  {
2386  nexact++;
2387  result = opclass->oid;
2388  }
2389  else if (nexact == 0 &&
2390  IsBinaryCoercible(type_id, opclass->opcintype))
2391  {
2392  if (IsPreferredType(tcategory, opclass->opcintype))
2393  {
2394  ncompatiblepreferred++;
2395  result = opclass->oid;
2396  }
2397  else if (ncompatiblepreferred == 0)
2398  {
2399  ncompatible++;
2400  result = opclass->oid;
2401  }
2402  }
2403  }
2404 
2405  systable_endscan(scan);
2406 
2408 
2409  /* raise error if pg_opclass contains inconsistent data */
2410  if (nexact > 1)
2411  ereport(ERROR,
2413  errmsg("there are multiple default operator classes for data type %s",
2414  format_type_be(type_id))));
2415 
2416  if (nexact == 1 ||
2417  ncompatiblepreferred == 1 ||
2418  (ncompatiblepreferred == 0 && ncompatible == 1))
2419  return result;
2420 
2421  return InvalidOid;
2422 }
void systable_endscan(SysScanDesc sysscan)
Definition: genam.c:596
HeapTuple systable_getnext(SysScanDesc sysscan)
Definition: genam.c:503
SysScanDesc systable_beginscan(Relation heapRelation, Oid indexId, bool indexOK, Snapshot snapshot, int nkeys, ScanKey key)
Definition: genam.c:384
Oid getBaseType(Oid typid)
Definition: lsyscache.c:2521
TYPCATEGORY TypeCategory(Oid type)
bool IsBinaryCoercible(Oid srctype, Oid targettype)
bool IsPreferredType(TYPCATEGORY category, Oid type)
char TYPCATEGORY
Definition: parse_coerce.h:21
FormData_pg_opclass * Form_pg_opclass
Definition: pg_opclass.h:83
void ScanKeyInit(ScanKey entry, AttrNumber attributeNumber, StrategyNumber strategy, RegProcedure procedure, Datum argument)
Definition: scankey.c:76
#define ERRCODE_DUPLICATE_OBJECT
Definition: streamutil.c:32

References AccessShareLock, BTEqualStrategyNumber, ereport, errcode(), ERRCODE_DUPLICATE_OBJECT, errmsg(), ERROR, format_type_be(), getBaseType(), GETSTRUCT, HeapTupleIsValid, InvalidOid, IsBinaryCoercible(), IsPreferredType(), ObjectIdGetDatum(), ScanKeyInit(), systable_beginscan(), systable_endscan(), systable_getnext(), table_close(), table_open(), and TypeCategory().

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

◆ GetOperatorFromWellKnownStrategy()

void GetOperatorFromWellKnownStrategy ( Oid  opclass,
Oid  rhstype,
Oid opid,
StrategyNumber strat 
)

Definition at line 2441 of file indexcmds.c.

2443 {
2444  Oid opfamily;
2445  Oid opcintype;
2446  StrategyNumber instrat = *strat;
2447 
2448  Assert(instrat == RTEqualStrategyNumber || instrat == RTOverlapStrategyNumber || instrat == RTContainedByStrategyNumber);
2449 
2450  *opid = InvalidOid;
2451 
2452  if (get_opclass_opfamily_and_input_type(opclass, &opfamily, &opcintype))
2453  {
2454  /*
2455  * Ask the opclass to translate to its internal stratnum
2456  *
2457  * For now we only need GiST support, but this could support other
2458  * indexams if we wanted.
2459  */
2460  *strat = GistTranslateStratnum(opclass, instrat);
2461  if (*strat == InvalidStrategy)
2462  {
2463  HeapTuple tuple;
2464 
2465  tuple = SearchSysCache1(CLAOID, ObjectIdGetDatum(opclass));
2466  if (!HeapTupleIsValid(tuple))
2467  elog(ERROR, "cache lookup failed for operator class %u", opclass);
2468 
2469  ereport(ERROR,
2470  errcode(ERRCODE_UNDEFINED_OBJECT),
2471  instrat == RTEqualStrategyNumber ? errmsg("could not identify an equality operator for type %s", format_type_be(opcintype)) :
2472  instrat == RTOverlapStrategyNumber ? errmsg("could not identify an overlaps operator for type %s", format_type_be(opcintype)) :
2473  instrat == RTContainedByStrategyNumber ? errmsg("could not identify a contained-by operator for type %s", format_type_be(opcintype)) : 0,
2474  errdetail("Could not translate strategy number %d for operator class \"%s\" for access method \"%s\".",
2475  instrat, NameStr(((Form_pg_opclass) GETSTRUCT(tuple))->opcname), "gist"));
2476  }
2477 
2478  /*
2479  * We parameterize rhstype so foreign keys can ask for a <@ operator
2480  * whose rhs matches the aggregate function. For example range_agg
2481  * returns anymultirange.
2482  */
2483  if (!OidIsValid(rhstype))
2484  rhstype = opcintype;
2485  *opid = get_opfamily_member(opfamily, opcintype, rhstype, *strat);
2486  }
2487 
2488  if (!OidIsValid(*opid))
2489  {
2490  HeapTuple tuple;
2491 
2492  tuple = SearchSysCache1(OPFAMILYOID, ObjectIdGetDatum(opfamily));
2493  if (!HeapTupleIsValid(tuple))
2494  elog(ERROR, "cache lookup failed for operator family %u", opfamily);
2495 
2496  ereport(ERROR,
2497  errcode(ERRCODE_UNDEFINED_OBJECT),
2498  instrat == RTEqualStrategyNumber ? errmsg("could not identify an equality operator for type %s", format_type_be(opcintype)) :
2499  instrat == RTOverlapStrategyNumber ? errmsg("could not identify an overlaps operator for type %s", format_type_be(opcintype)) :
2500  instrat == RTContainedByStrategyNumber ? errmsg("could not identify a contained-by operator for type %s", format_type_be(opcintype)) : 0,
2501  errdetail("There is no suitable operator in operator family \"%s\" for access method \"%s\".",
2502  NameStr(((Form_pg_opfamily) GETSTRUCT(tuple))->opfname), "gist"));
2503  }
2504 }
StrategyNumber GistTranslateStratnum(Oid opclass, StrategyNumber strat)
Definition: gistutil.c:1081
#define InvalidStrategy
Definition: stratnum.h:24
#define RTContainedByStrategyNumber
Definition: stratnum.h:58

References Assert, elog, ereport, errcode(), errdetail(), errmsg(), ERROR, format_type_be(), get_opclass_opfamily_and_input_type(), get_opfamily_member(), GETSTRUCT, GistTranslateStratnum(), HeapTupleIsValid, InvalidOid, InvalidStrategy, NameStr, ObjectIdGetDatum(), OidIsValid, RTContainedByStrategyNumber, RTEqualStrategyNumber, RTOverlapStrategyNumber, and SearchSysCache1().

Referenced by ComputeIndexAttrs(), and FindFKPeriodOpers().

◆ IndexSetParentIndex()

void IndexSetParentIndex ( Relation  partitionIdx,
Oid  parentOid 
)

Definition at line 4396 of file indexcmds.c.

4397 {
4398  Relation pg_inherits;
4399  ScanKeyData key[2];
4400  SysScanDesc scan;
4401  Oid partRelid = RelationGetRelid(partitionIdx);
4402  HeapTuple tuple;
4403  bool fix_dependencies;
4404 
4405  /* Make sure this is an index */
4406  Assert(partitionIdx->rd_rel->relkind == RELKIND_INDEX ||
4407  partitionIdx->rd_rel->relkind == RELKIND_PARTITIONED_INDEX);
4408 
4409  /*
4410  * Scan pg_inherits for rows linking our index to some parent.
4411  */
4412  pg_inherits = relation_open(InheritsRelationId, RowExclusiveLock);
4413  ScanKeyInit(&key[0],
4414  Anum_pg_inherits_inhrelid,
4415  BTEqualStrategyNumber, F_OIDEQ,
4416  ObjectIdGetDatum(partRelid));
4417  ScanKeyInit(&key[1],
4418  Anum_pg_inherits_inhseqno,
4419  BTEqualStrategyNumber, F_INT4EQ,
4420  Int32GetDatum(1));
4421  scan = systable_beginscan(pg_inherits, InheritsRelidSeqnoIndexId, true,
4422  NULL, 2, key);
4423  tuple = systable_getnext(scan);
4424 
4425  if (!HeapTupleIsValid(tuple))
4426  {
4427  if (parentOid == InvalidOid)
4428  {
4429  /*
4430  * No pg_inherits row, and no parent wanted: nothing to do in this
4431  * case.
4432  */
4433  fix_dependencies = false;
4434  }
4435  else
4436  {
4437  StoreSingleInheritance(partRelid, parentOid, 1);
4438  fix_dependencies = true;
4439  }
4440  }
4441  else
4442  {
4443  Form_pg_inherits inhForm = (Form_pg_inherits) GETSTRUCT(tuple);
4444 
4445  if (parentOid == InvalidOid)
4446  {
4447  /*
4448  * There exists a pg_inherits row, which we want to clear; do so.
4449  */
4450  CatalogTupleDelete(pg_inherits, &tuple->t_self);
4451  fix_dependencies = true;
4452  }
4453  else
4454  {
4455  /*
4456  * A pg_inherits row exists. If it's the same we want, then we're
4457  * good; if it differs, that amounts to a corrupt catalog and
4458  * should not happen.
4459  */
4460  if (inhForm->inhparent != parentOid)
4461  {
4462  /* unexpected: we should not get called in this case */
4463  elog(ERROR, "bogus pg_inherit row: inhrelid %u inhparent %u",
4464  inhForm->inhrelid, inhForm->inhparent);
4465  }
4466 
4467  /* already in the right state */
4468  fix_dependencies = false;
4469  }
4470  }
4471 
4472  /* done with pg_inherits */
4473  systable_endscan(scan);
4474  relation_close(pg_inherits, RowExclusiveLock);
4475 
4476  /* set relhassubclass if an index partition has been added to the parent */
4477  if (OidIsValid(parentOid))
4478  SetRelationHasSubclass(parentOid, true);
4479 
4480  /* set relispartition correctly on the partition */
4481  update_relispartition(partRelid, OidIsValid(parentOid));
4482 
4483  if (fix_dependencies)
4484  {
4485  /*
4486  * Insert/delete pg_depend rows. If setting a parent, add PARTITION
4487  * dependencies on the parent index and the table; if removing a
4488  * parent, delete PARTITION dependencies.
4489  */
4490  if (OidIsValid(parentOid))
4491  {
4492  ObjectAddress partIdx;
4493  ObjectAddress parentIdx;
4494  ObjectAddress partitionTbl;
4495 
4496  ObjectAddressSet(partIdx, RelationRelationId, partRelid);
4497  ObjectAddressSet(parentIdx, RelationRelationId, parentOid);
4498  ObjectAddressSet(partitionTbl, RelationRelationId,
4499  partitionIdx->rd_index->indrelid);
4500  recordDependencyOn(&partIdx, &parentIdx,
4502  recordDependencyOn(&partIdx, &partitionTbl,
4504  }
4505  else
4506  {
4507  deleteDependencyRecordsForClass(RelationRelationId, partRelid,
4508  RelationRelationId,
4510  deleteDependencyRecordsForClass(RelationRelationId, partRelid,
4511  RelationRelationId,
4513  }
4514 
4515  /* make our updates visible */
4517  }
4518 }
@ DEPENDENCY_PARTITION_PRI
Definition: dependency.h:36
@ DEPENDENCY_PARTITION_SEC
Definition: dependency.h:37
static void update_relispartition(Oid relationId, bool newval)
Definition: indexcmds.c:4525
void CatalogTupleDelete(Relation heapRel, ItemPointer tid)
Definition: indexing.c:365
static void fix_dependencies(ArchiveHandle *AH)
void recordDependencyOn(const ObjectAddress *depender, const ObjectAddress *referenced, DependencyType behavior)
Definition: pg_depend.c:44
long deleteDependencyRecordsForClass(Oid classId, Oid objectId, Oid refclassId, char deptype)
Definition: pg_depend.c:350
void StoreSingleInheritance(Oid relationId, Oid parentOid, int32 seqNumber)
Definition: pg_inherits.c:508
FormData_pg_inherits * Form_pg_inherits
Definition: pg_inherits.h:45
static Datum Int32GetDatum(int32 X)
Definition: postgres.h:212
#define RelationGetRelid(relation)
Definition: rel.h:505
void relation_close(Relation relation, LOCKMODE lockmode)
Definition: relation.c:205
Relation relation_open(Oid relationId, LOCKMODE lockmode)
Definition: relation.c:47
void SetRelationHasSubclass(Oid relationId, bool relhassubclass)
Definition: tablecmds.c:3588

References Assert, BTEqualStrategyNumber, CatalogTupleDelete(), CommandCounterIncrement(), deleteDependencyRecordsForClass(), DEPENDENCY_PARTITION_PRI, DEPENDENCY_PARTITION_SEC, elog, ERROR, fix_dependencies(), GETSTRUCT, HeapTupleIsValid, Int32GetDatum(), InvalidOid, sort-test::key, ObjectAddressSet, ObjectIdGetDatum(), OidIsValid, RelationData::rd_index, RelationData::rd_rel, recordDependencyOn(), relation_close(), relation_open(), RelationGetRelid, RowExclusiveLock, ScanKeyInit(), SetRelationHasSubclass(), StoreSingleInheritance(), systable_beginscan(), systable_endscan(), systable_getnext(), HeapTupleData::t_self, and update_relispartition().

Referenced by ATExecAttachPartitionIdx(), AttachPartitionEnsureIndexes(), DefineIndex(), and DetachPartitionFinalize().

◆ makeObjectName()

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

Definition at line 2529 of file indexcmds.c.

2530 {
2531  char *name;
2532  int overhead = 0; /* chars needed for label and underscores */
2533  int availchars; /* chars available for name(s) */
2534  int name1chars; /* chars allocated to name1 */
2535  int name2chars; /* chars allocated to name2 */
2536  int ndx;
2537 
2538  name1chars = strlen(name1);
2539  if (name2)
2540  {
2541  name2chars = strlen(name2);
2542  overhead++; /* allow for separating underscore */
2543  }
2544  else
2545  name2chars = 0;
2546  if (label)
2547  overhead += strlen(label) + 1;
2548 
2549  availchars = NAMEDATALEN - 1 - overhead;
2550  Assert(availchars > 0); /* else caller chose a bad label */
2551 
2552  /*
2553  * If we must truncate, preferentially truncate the longer name. This
2554  * logic could be expressed without a loop, but it's simple and obvious as
2555  * a loop.
2556  */
2557  while (name1chars + name2chars > availchars)
2558  {
2559  if (name1chars > name2chars)
2560  name1chars--;
2561  else
2562  name2chars--;
2563  }
2564 
2565  name1chars = pg_mbcliplen(name1, name1chars, name1chars);
2566  if (name2)
2567  name2chars = pg_mbcliplen(name2, name2chars, name2chars);
2568 
2569  /* Now construct the string using the chosen lengths */
2570  name = palloc(name1chars + name2chars + overhead + 1);
2571  memcpy(name, name1, name1chars);
2572  ndx = name1chars;
2573  if (name2)
2574  {
2575  name[ndx++] = '_';
2576  memcpy(name + ndx, name2, name2chars);
2577  ndx += name2chars;
2578  }
2579  if (label)
2580  {
2581  name[ndx++] = '_';
2582  strcpy(name + ndx, label);
2583  }
2584  else
2585  name[ndx] = '\0';
2586 
2587  return name;
2588 }
void * palloc(Size size)
Definition: mcxt.c:1316

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

Referenced by ChooseConstraintName(), ChooseExtendedStatisticName(), ChooseRelationName(), and makeArrayTypeName().

◆ RangeVarCallbackForReindexIndex()

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

Definition at line 2950 of file indexcmds.c.

2952 {
2953  char relkind;
2955  LOCKMODE table_lockmode;
2956  Oid table_oid;
2957 
2958  /*
2959  * Lock level here should match table lock in reindex_index() for
2960  * non-concurrent case and table locks used by index_concurrently_*() for
2961  * concurrent case.
2962  */
2963  table_lockmode = (state->params.options & REINDEXOPT_CONCURRENTLY) != 0 ?
2965 
2966  /*
2967  * If we previously locked some other index's heap, and the name we're
2968  * looking up no longer refers to that relation, release the now-useless
2969  * lock.
2970  */
2971  if (relId != oldRelId && OidIsValid(oldRelId))
2972  {
2973  UnlockRelationOid(state->locked_table_oid, table_lockmode);
2974  state->locked_table_oid = InvalidOid;
2975  }
2976 
2977  /* If the relation does not exist, there's nothing more to do. */
2978  if (!OidIsValid(relId))
2979  return;
2980 
2981  /*
2982  * If the relation does exist, check whether it's an index. But note that
2983  * the relation might have been dropped between the time we did the name
2984  * lookup and now. In that case, there's nothing to do.
2985  */
2986  relkind = get_rel_relkind(relId);
2987  if (!relkind)
2988  return;
2989  if (relkind != RELKIND_INDEX &&
2990  relkind != RELKIND_PARTITIONED_INDEX)
2991  ereport(ERROR,
2992  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
2993  errmsg("\"%s\" is not an index", relation->relname)));
2994 
2995  /* Check permissions */
2996  table_oid = IndexGetRelation(relId, true);
2997  if (OidIsValid(table_oid))
2998  {
2999  AclResult aclresult;
3000 
3001  aclresult = pg_class_aclcheck(table_oid, GetUserId(), ACL_MAINTAIN);
3002  if (aclresult != ACLCHECK_OK)
3003  aclcheck_error(aclresult, OBJECT_INDEX, relation->relname);
3004  }
3005 
3006  /* Lock heap before index to avoid deadlock. */
3007  if (relId != oldRelId)
3008  {
3009  /*
3010  * If the OID isn't valid, it means the index was concurrently
3011  * dropped, which is not a problem for us; just return normally.
3012  */
3013  if (OidIsValid(table_oid))
3014  {
3015  LockRelationOid(table_oid, table_lockmode);
3016  state->locked_table_oid = table_oid;
3017  }
3018  }
3019 }
AclResult pg_class_aclcheck(Oid table_oid, Oid roleid, AclMode mode)
Definition: aclchk.c:4079
void UnlockRelationOid(Oid relid, LOCKMODE lockmode)
Definition: lmgr.c:227
void LockRelationOid(Oid relid, LOCKMODE lockmode)
Definition: lmgr.c:108
char get_rel_relkind(Oid relid)
Definition: lsyscache.c:2003
#define ACL_MAINTAIN
Definition: parsenodes.h:90
@ OBJECT_INDEX
Definition: parsenodes.h:2283
char * relname
Definition: primnodes.h:82
Definition: regguts.h:323

References ACL_MAINTAIN, aclcheck_error(), ACLCHECK_OK, arg, ereport, errcode(), errmsg(), ERROR, get_rel_relkind(), GetUserId(), IndexGetRelation(), InvalidOid, LockRelationOid(), OBJECT_INDEX, OidIsValid, pg_class_aclcheck(), REINDEXOPT_CONCURRENTLY, RangeVar::relname, ShareLock, ShareUpdateExclusiveLock, and UnlockRelationOid().

Referenced by ReindexIndex().

◆ reindex_error_callback()

static void reindex_error_callback ( void *  arg)
static

Definition at line 3304 of file indexcmds.c.

3305 {
3306  ReindexErrorInfo *errinfo = (ReindexErrorInfo *) arg;
3307 
3308  Assert(RELKIND_HAS_PARTITIONS(errinfo->relkind));
3309 
3310  if (errinfo->relkind == RELKIND_PARTITIONED_TABLE)
3311  errcontext("while reindexing partitioned table \"%s.%s\"",
3312  errinfo->relnamespace, errinfo->relname);
3313  else if (errinfo->relkind == RELKIND_PARTITIONED_INDEX)
3314  errcontext("while reindexing partitioned index \"%s.%s\"",
3315  errinfo->relnamespace, errinfo->relname);
3316 }
#define errcontext
Definition: elog.h:196
char * relnamespace
Definition: indexcmds.c:134

References arg, Assert, errcontext, ReindexErrorInfo::relkind, ReindexErrorInfo::relname, and ReindexErrorInfo::relnamespace.

Referenced by ReindexPartitions().

◆ ReindexIndex()

static void ReindexIndex ( const ReindexStmt stmt,
const ReindexParams params,
bool  isTopLevel 
)
static

Definition at line 2896 of file indexcmds.c.

2897 {
2898  const RangeVar *indexRelation = stmt->relation;
2900  Oid indOid;
2901  char persistence;
2902  char relkind;
2903 
2904  /*
2905  * Find and lock index, and check permissions on table; use callback to
2906  * obtain lock on table first, to avoid deadlock hazard. The lock level
2907  * used here must match the index lock obtained in reindex_index().
2908  *
2909  * If it's a temporary index, we will perform a non-concurrent reindex,
2910  * even if CONCURRENTLY was requested. In that case, reindex_index() will
2911  * upgrade the lock, but that's OK, because other sessions can't hold
2912  * locks on our temporary table.
2913  */
2914  state.params = *params;
2915  state.locked_table_oid = InvalidOid;
2916  indOid = RangeVarGetRelidExtended(indexRelation,
2919  0,
2921  &state);
2922 
2923  /*
2924  * Obtain the current persistence and kind of the existing index. We
2925  * already hold a lock on the index.
2926  */
2927  persistence = get_rel_persistence(indOid);
2928  relkind = get_rel_relkind(indOid);
2929 
2930  if (relkind == RELKIND_PARTITIONED_INDEX)
2931  ReindexPartitions(stmt, indOid, params, isTopLevel);
2932  else if ((params->options & REINDEXOPT_CONCURRENTLY) != 0 &&
2933  persistence != RELPERSISTENCE_TEMP)
2935  else
2936  {
2937  ReindexParams newparams = *params;
2938 
2939  newparams.options |= REINDEXOPT_REPORT_PROGRESS;
2940  reindex_index(stmt, indOid, false, persistence, &newparams);
2941  }
2942 }
void reindex_index(const ReindexStmt *stmt, Oid indexId, bool skip_constraint_checks, char persistence, const ReindexParams *params)
Definition: index.c:3552
#define REINDEXOPT_REPORT_PROGRESS
Definition: index.h:42
static bool ReindexRelationConcurrently(const ReindexStmt *stmt, Oid relationOid, const ReindexParams *params)
Definition: indexcmds.c:3545
static void ReindexPartitions(const ReindexStmt *stmt, Oid relid, const ReindexParams *params, bool isTopLevel)
Definition: indexcmds.c:3325
static void RangeVarCallbackForReindexIndex(const RangeVar *relation, Oid relId, Oid oldRelId, void *arg)
Definition: indexcmds.c:2950
#define AccessExclusiveLock
Definition: lockdefs.h:43
Oid RangeVarGetRelidExtended(const RangeVar *relation, LOCKMODE lockmode, uint32 flags, RangeVarGetRelidCallback callback, void *callback_arg)
Definition: namespace.c:426
ReindexParams params
Definition: indexcmds.c:124

References AccessExclusiveLock, get_rel_persistence(), get_rel_relkind(), InvalidOid, ReindexParams::options, ReindexIndexCallbackState::params, RangeVarCallbackForReindexIndex(), RangeVarGetRelidExtended(), reindex_index(), REINDEXOPT_CONCURRENTLY, REINDEXOPT_REPORT_PROGRESS, ReindexPartitions(), ReindexRelationConcurrently(), ShareUpdateExclusiveLock, and stmt.

Referenced by ExecReindex().

◆ ReindexMultipleInternal()

static void ReindexMultipleInternal ( const ReindexStmt stmt,
const List relids,
const ReindexParams params 
)
static

Definition at line 3419 of file indexcmds.c.

3420 {
3421  ListCell *l;
3422 
3425 
3426  foreach(l, relids)
3427  {
3428  Oid relid = lfirst_oid(l);
3429  char relkind;
3430  char relpersistence;
3431 
3433 
3434  /* functions in indexes may want a snapshot set */
3436 
3437  /* check if the relation still exists */
3438  if (!SearchSysCacheExists1(RELOID, ObjectIdGetDatum(relid)))
3439  {
3442  continue;
3443  }
3444 
3445  /*
3446  * Check permissions except when moving to database's default if a new
3447  * tablespace is chosen. Note that this check also happens in
3448  * ExecReindex(), but we do an extra check here as this runs across
3449  * multiple transactions.
3450  */
3451  if (OidIsValid(params->tablespaceOid) &&
3453  {
3454  AclResult aclresult;
3455 
3456  aclresult = object_aclcheck(TableSpaceRelationId, params->tablespaceOid,
3457  GetUserId(), ACL_CREATE);
3458  if (aclresult != ACLCHECK_OK)
3459  aclcheck_error(aclresult, OBJECT_TABLESPACE,
3461  }
3462 
3463  relkind = get_rel_relkind(relid);
3464  relpersistence = get_rel_persistence(relid);
3465 
3466  /*
3467  * Partitioned tables and indexes can never be processed directly, and
3468  * a list of their leaves should be built first.
3469  */
3470  Assert(!RELKIND_HAS_PARTITIONS(relkind));
3471 
3472  if ((params->options & REINDEXOPT_CONCURRENTLY) != 0 &&
3473  relpersistence != RELPERSISTENCE_TEMP)
3474  {
3475  ReindexParams newparams = *params;
3476 
3477  newparams.options |= REINDEXOPT_MISSING_OK;
3478  (void) ReindexRelationConcurrently(stmt, relid, &newparams);
3479  if (ActiveSnapshotSet())
3481  /* ReindexRelationConcurrently() does the verbose output */
3482  }
3483  else if (relkind == RELKIND_INDEX)
3484  {
3485  ReindexParams newparams = *params;
3486 
3487  newparams.options |=
3489  reindex_index(stmt, relid, false, relpersistence, &newparams);
3491  /* reindex_index() does the verbose output */
3492  }
3493  else
3494  {
3495  bool result;
3496  ReindexParams newparams = *params;
3497 
3498  newparams.options |=
3500  result = reindex_relation(stmt, relid,
3503  &newparams);
3504 
3505  if (result && (params->options & REINDEXOPT_VERBOSE) != 0)
3506  ereport(INFO,
3507  (errmsg("table \"%s.%s\" was reindexed",
3509  get_rel_name(relid))));
3510 
3512  }
3513 
3515  }
3516 
3518 }
#define INFO
Definition: elog.h:34
bool reindex_relation(const ReindexStmt *stmt, Oid relid, int flags, const ReindexParams *params)
Definition: index.c:3892
#define REINDEX_REL_PROCESS_TOAST
Definition: index.h:159
#define REINDEXOPT_MISSING_OK
Definition: index.h:43
#define REINDEX_REL_CHECK_CONSTRAINTS
Definition: index.h:161
Oid get_rel_namespace(Oid relid)
Definition: lsyscache.c:1952
char * get_rel_name(Oid relid)
Definition: lsyscache.c:1928
bool ActiveSnapshotSet(void)
Definition: snapmgr.c:782
#define SearchSysCacheExists1(cacheId, key1)
Definition: syscache.h:95

References ACL_CREATE, aclcheck_error(), ACLCHECK_OK, ActiveSnapshotSet(), Assert, CommitTransactionCommand(), ereport, errmsg(), get_namespace_name(), get_rel_name(), get_rel_namespace(), get_rel_persistence(), get_rel_relkind(), get_tablespace_name(), GetTransactionSnapshot(), GetUserId(), INFO, lfirst_oid, MyDatabaseTableSpace, object_aclcheck(), OBJECT_TABLESPACE, ObjectIdGetDatum(), OidIsValid, ReindexParams::options, ReindexIndexCallbackState::params, PopActiveSnapshot(), PushActiveSnapshot(), reindex_index(), REINDEX_REL_CHECK_CONSTRAINTS, REINDEX_REL_PROCESS_TOAST, reindex_relation(), REINDEXOPT_CONCURRENTLY, REINDEXOPT_MISSING_OK, REINDEXOPT_REPORT_PROGRESS, REINDEXOPT_VERBOSE, ReindexRelationConcurrently(), SearchSysCacheExists1, StartTransactionCommand(), stmt, and ReindexParams::tablespaceOid.

Referenced by ReindexMultipleTables(), and ReindexPartitions().

◆ ReindexMultipleTables()

static void ReindexMultipleTables ( const ReindexStmt stmt,
const ReindexParams params 
)
static

Definition at line 3085 of file indexcmds.c.

3086 {
3087 
3088  Oid objectOid;
3089  Relation relationRelation;
3090  TableScanDesc scan;
3091  ScanKeyData scan_keys[1];
3092  HeapTuple tuple;
3093  MemoryContext private_context;
3094  MemoryContext old;
3095  List *relids = NIL;
3096  int num_keys;
3097  bool concurrent_warning = false;
3098  bool tablespace_warning = false;
3099  const char *objectName = stmt->name;
3100  const ReindexObjectType objectKind = stmt->kind;
3101 
3102  Assert(objectKind == REINDEX_OBJECT_SCHEMA ||
3103  objectKind == REINDEX_OBJECT_SYSTEM ||
3104  objectKind == REINDEX_OBJECT_DATABASE);
3105 
3106  /*
3107  * This matches the options enforced by the grammar, where the object name
3108  * is optional for DATABASE and SYSTEM.
3109  */
3110  Assert(objectName || objectKind != REINDEX_OBJECT_SCHEMA);
3111 
3112  if (objectKind == REINDEX_OBJECT_SYSTEM &&
3113  (params->options & REINDEXOPT_CONCURRENTLY) != 0)
3114  ereport(ERROR,
3115  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
3116  errmsg("cannot reindex system catalogs concurrently")));
3117 
3118  /*
3119  * Get OID of object to reindex, being the database currently being used
3120  * by session for a database or for system catalogs, or the schema defined
3121  * by caller. At the same time do permission checks that need different
3122  * processing depending on the object type.
3123  */
3124  if (objectKind == REINDEX_OBJECT_SCHEMA)
3125  {
3126  objectOid = get_namespace_oid(objectName, false);
3127 
3128  if (!object_ownercheck(NamespaceRelationId, objectOid, GetUserId()) &&
3129  !has_privs_of_role(GetUserId(), ROLE_PG_MAINTAIN))
3131  objectName);
3132  }
3133  else
3134  {
3135  objectOid = MyDatabaseId;
3136 
3137  if (objectName && strcmp(objectName, get_database_name(objectOid)) != 0)
3138  ereport(ERROR,
3139  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
3140  errmsg("can only reindex the currently open database")));
3141  if (!object_ownercheck(DatabaseRelationId, objectOid, GetUserId()) &&
3142  !has_privs_of_role(GetUserId(), ROLE_PG_MAINTAIN))
3144  get_database_name(objectOid));
3145  }
3146 
3147  /*
3148  * Create a memory context that will survive forced transaction commits we
3149  * do below. Since it is a child of PortalContext, it will go away
3150  * eventually even if we suffer an error; there's no need for special
3151  * abort cleanup logic.
3152  */
3153  private_context = AllocSetContextCreate(PortalContext,
3154  "ReindexMultipleTables",
3156 
3157  /*
3158  * Define the search keys to find the objects to reindex. For a schema, we
3159  * select target relations using relnamespace, something not necessary for
3160  * a database-wide operation.
3161  */
3162  if (objectKind == REINDEX_OBJECT_SCHEMA)
3163  {
3164  num_keys = 1;
3165  ScanKeyInit(&scan_keys[0],
3166  Anum_pg_class_relnamespace,
3167  BTEqualStrategyNumber, F_OIDEQ,
3168  ObjectIdGetDatum(objectOid));
3169  }
3170  else
3171  num_keys = 0;
3172 
3173  /*
3174  * Scan pg_class to build a list of the relations we need to reindex.
3175  *
3176  * We only consider plain relations and materialized views here (toast
3177  * rels will be processed indirectly by reindex_relation).
3178  */
3179  relationRelation = table_open(RelationRelationId, AccessShareLock);
3180  scan = table_beginscan_catalog(relationRelation, num_keys, scan_keys);
3181  while ((tuple = heap_getnext(scan, ForwardScanDirection)) != NULL)
3182  {
3183  Form_pg_class classtuple = (Form_pg_class) GETSTRUCT(tuple);
3184  Oid relid = classtuple->oid;
3185 
3186  /*
3187  * Only regular tables and matviews can have indexes, so ignore any
3188  * other kind of relation.
3189  *
3190  * Partitioned tables/indexes are skipped but matching leaf partitions
3191  * are processed.
3192  */
3193  if (classtuple->relkind != RELKIND_RELATION &&
3194  classtuple->relkind != RELKIND_MATVIEW)
3195  continue;
3196 
3197  /* Skip temp tables of other backends; we can't reindex them at all */
3198  if (classtuple->relpersistence == RELPERSISTENCE_TEMP &&
3199  !isTempNamespace(classtuple->relnamespace))
3200  continue;
3201 
3202  /*
3203  * Check user/system classification. SYSTEM processes all the
3204  * catalogs, and DATABASE processes everything that's not a catalog.
3205  */
3206  if (objectKind == REINDEX_OBJECT_SYSTEM &&
3207  !IsCatalogRelationOid(relid))
3208  continue;
3209  else if (objectKind == REINDEX_OBJECT_DATABASE &&
3210  IsCatalogRelationOid(relid))
3211  continue;
3212 
3213  /*
3214  * We already checked privileges on the database or schema, but we
3215  * further restrict reindexing shared catalogs to roles with the
3216  * MAINTAIN privilege on the relation.
3217  */
3218  if (classtuple->relisshared &&
3220  continue;
3221 
3222  /*
3223  * Skip system tables, since index_create() would reject indexing them
3224  * concurrently (and it would likely fail if we tried).
3225  */
3226  if ((params->options & REINDEXOPT_CONCURRENTLY) != 0 &&
3227  IsCatalogRelationOid(relid))
3228  {
3229  if (!concurrent_warning)
3230  ereport(WARNING,
3231  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
3232  errmsg("cannot reindex system catalogs concurrently, skipping all")));
3233  concurrent_warning = true;
3234  continue;
3235  }
3236 
3237  /*
3238  * If a new tablespace is set, check if this relation has to be
3239  * skipped.
3240  */
3241  if (OidIsValid(params->tablespaceOid))
3242  {
3243  bool skip_rel = false;
3244 
3245  /*
3246  * Mapped relations cannot be moved to different tablespaces (in
3247  * particular this eliminates all shared catalogs.).
3248  */
3249  if (RELKIND_HAS_STORAGE(classtuple->relkind) &&
3250  !RelFileNumberIsValid(classtuple->relfilenode))
3251  skip_rel = true;
3252 
3253  /*
3254  * A system relation is always skipped, even with
3255  * allow_system_table_mods enabled.
3256  */
3257  if (IsSystemClass(relid, classtuple))
3258  skip_rel = true;
3259 
3260  if (skip_rel)
3261  {
3262  if (!tablespace_warning)
3263  ereport(WARNING,
3264  (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
3265  errmsg("cannot move system relations, skipping all")));
3266  tablespace_warning = true;
3267  continue;
3268  }
3269  }
3270 
3271  /* Save the list of relation OIDs in private context */
3272  old = MemoryContextSwitchTo(private_context);
3273 
3274  /*
3275  * We always want to reindex pg_class first if it's selected to be
3276  * reindexed. This ensures that if there is any corruption in
3277  * pg_class' indexes, they will be fixed before we process any other
3278  * tables. This is critical because reindexing itself will try to
3279  * update pg_class.
3280  */
3281  if (relid == RelationRelationId)
3282  relids = lcons_oid(relid, relids);
3283  else
3284  relids = lappend_oid(relids, relid);
3285 
3286  MemoryContextSwitchTo(old);
3287  }
3288  table_endscan(scan);
3289  table_close(relationRelation, AccessShareLock);
3290 
3291  /*
3292  * Process each relation listed in a separate transaction. Note that this
3293  * commits and then starts a new transaction immediately.
3294  */
3295  ReindexMultipleInternal(stmt, relids, params);
3296 
3297  MemoryContextDelete(private_context);
3298 }
bool has_privs_of_role(Oid member, Oid role)
Definition: acl.c:5128
@ ACLCHECK_NOT_OWNER
Definition: acl.h:185
bool object_ownercheck(Oid classid, Oid objectid, Oid roleid)
Definition: aclchk.c:4130
bool IsCatalogRelationOid(Oid relid)
Definition: catalog.c:120
bool IsSystemClass(Oid relid, Form_pg_class reltuple)
Definition: catalog.c:85
char * get_database_name(Oid dbid)
Definition: dbcommands.c:3153
#define WARNING
Definition: elog.h:36
Oid MyDatabaseId
Definition: globals.c:91
HeapTuple heap_getnext(TableScanDesc sscan, ScanDirection direction)
Definition: heapam.c:1248
static void ReindexMultipleInternal(const ReindexStmt *stmt, const List *relids, const ReindexParams *params)
Definition: indexcmds.c:3419
List * lappend_oid(List *list, Oid datum)
Definition: list.c:375
List * lcons_oid(Oid datum, List *list)
Definition: list.c:531
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:454
MemoryContext PortalContext
Definition: mcxt.c:158
#define AllocSetContextCreate
Definition: memutils.h:129
#define ALLOCSET_SMALL_SIZES
Definition: memutils.h:170
bool isTempNamespace(Oid namespaceId)
Definition: namespace.c:3634
Oid get_namespace_oid(const char *nspname, bool missing_ok)
Definition: namespace.c:3520
@ OBJECT_DATABASE
Definition: parsenodes.h:2272
ReindexObjectType
Definition: parsenodes.h:3978
FormData_pg_class * Form_pg_class
Definition: pg_class.h:153
MemoryContextSwitchTo(old_ctx)
@ ForwardScanDirection
Definition: sdir.h:28
TableScanDesc table_beginscan_catalog(Relation relation, int nkeys, struct ScanKeyData *key)
Definition: tableam.c:112
static void table_endscan(TableScanDesc scan)
Definition: tableam.h:1029

References AccessShareLock, ACL_MAINTAIN, aclcheck_error(), ACLCHECK_NOT_OWNER, ACLCHECK_OK, ALLOCSET_SMALL_SIZES, AllocSetContextCreate, Assert, BTEqualStrategyNumber, ereport, errcode(), errmsg(), ERROR, ForwardScanDirection, get_database_name(), get_namespace_oid(), GETSTRUCT, GetUserId(), has_privs_of_role(), heap_getnext(), IsCatalogRelationOid(), IsSystemClass(), isTempNamespace(), lappend_oid(), lcons_oid(), MemoryContextDelete(), MemoryContextSwitchTo(), MyDatabaseId, NIL, OBJECT_DATABASE, object_ownercheck(), OBJECT_SCHEMA, ObjectIdGetDatum(), OidIsValid, ReindexParams::options, ReindexIndexCallbackState::params, pg_class_aclcheck(), PortalContext, REINDEX_OBJECT_DATABASE, REINDEX_OBJECT_SCHEMA, REINDEX_OBJECT_SYSTEM, ReindexMultipleInternal(), REINDEXOPT_CONCURRENTLY, RelFileNumberIsValid, ScanKeyInit(), stmt, table_beginscan_catalog(), table_close(), table_endscan(), table_open(), ReindexParams::tablespaceOid, and WARNING.

Referenced by ExecReindex().

◆ ReindexPartitions()

static void ReindexPartitions ( const ReindexStmt stmt,
Oid  relid,
const ReindexParams params,
bool  isTopLevel 
)
static

Definition at line 3325 of file indexcmds.c.

3326 {
3327  List *partitions = NIL;
3328  char relkind = get_rel_relkind(relid);
3329  char *relname = get_rel_name(relid);
3330  char *relnamespace = get_namespace_name(get_rel_namespace(relid));
3331  MemoryContext reindex_context;
3332  List *inhoids;
3333  ListCell *lc;
3334  ErrorContextCallback errcallback;
3335  ReindexErrorInfo errinfo;
3336 
3337  Assert(RELKIND_HAS_PARTITIONS(relkind));
3338 
3339  /*
3340  * Check if this runs in a transaction block, with an error callback to
3341  * provide more context under which a problem happens.
3342  */
3343  errinfo.relname = pstrdup(relname);
3344  errinfo.relnamespace = pstrdup(relnamespace);
3345  errinfo.relkind = relkind;
3346  errcallback.callback = reindex_error_callback;
3347  errcallback.arg = (void *) &errinfo;
3348  errcallback.previous = error_context_stack;
3349  error_context_stack = &errcallback;
3350 
3351  PreventInTransactionBlock(isTopLevel,
3352  relkind == RELKIND_PARTITIONED_TABLE ?
3353  "REINDEX TABLE" : "REINDEX INDEX");
3354 
3355  /* Pop the error context stack */
3356  error_context_stack = errcallback.previous;
3357 
3358  /*
3359  * Create special memory context for cross-transaction storage.
3360  *
3361  * Since it is a child of PortalContext, it will go away eventually even
3362  * if we suffer an error so there is no need for special abort cleanup
3363  * logic.
3364  */
3365  reindex_context = AllocSetContextCreate(PortalContext, "Reindex",
3367 
3368  /* ShareLock is enough to prevent schema modifications */
3369  inhoids = find_all_inheritors(relid, ShareLock, NULL);
3370 
3371  /*
3372  * The list of relations to reindex are the physical partitions of the
3373  * tree so discard any partitioned table or index.
3374  */
3375  foreach(lc, inhoids)
3376  {
3377  Oid partoid = lfirst_oid(lc);
3378  char partkind = get_rel_relkind(partoid);
3379  MemoryContext old_context;
3380 
3381  /*
3382  * This discards partitioned tables, partitioned indexes and foreign
3383  * tables.
3384  */
3385  if (!RELKIND_HAS_STORAGE(partkind))
3386  continue;
3387 
3388  Assert(partkind == RELKIND_INDEX ||
3389  partkind == RELKIND_RELATION);
3390 
3391  /* Save partition OID */
3392  old_context = MemoryContextSwitchTo(reindex_context);
3393  partitions = lappend_oid(partitions, partoid);
3394  MemoryContextSwitchTo(old_context);
3395  }
3396 
3397  /*
3398  * Process each partition listed in a separate transaction. Note that
3399  * this commits and then starts a new transaction immediately.
3400  */
3402 
3403  /*
3404  * Clean up working storage --- note we must do this after
3405  * StartTransactionCommand, else we might be trying to delete the active
3406  * context!
3407  */
3408  MemoryContextDelete(reindex_context);
3409 }
ErrorContextCallback * error_context_stack
Definition: elog.c:94
static void reindex_error_callback(void *arg)
Definition: indexcmds.c:3304
#define ALLOCSET_DEFAULT_SIZES
Definition: memutils.h:160
static int partitions
Definition: pgbench.c:223
struct ErrorContextCallback * previous
Definition: elog.h:295
void(* callback)(void *arg)
Definition: elog.h:296

References ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate, ErrorContextCallback::arg, Assert, ErrorContextCallback::callback, error_context_stack, find_all_inheritors(), get_namespace_name(), get_rel_name(), get_rel_namespace(), get_rel_relkind(), lappend_oid(), lfirst_oid, MemoryContextDelete(), MemoryContextSwitchTo(), NIL, ReindexIndexCallbackState::params, partitions, PortalContext, PreventInTransactionBlock(), ErrorContextCallback::previous, pstrdup(), reindex_error_callback(), ReindexMultipleInternal(), ReindexErrorInfo::relkind, ReindexErrorInfo::relname, relname, ReindexErrorInfo::relnamespace, ShareLock, and stmt.

Referenced by ReindexIndex(), and ReindexTable().

◆ ReindexRelationConcurrently()

static bool ReindexRelationConcurrently ( const ReindexStmt stmt,
Oid  relationOid,
const ReindexParams params 
)
static

Definition at line 3545 of file indexcmds.c.

3546 {
3547  typedef struct ReindexIndexInfo
3548  {
3549  Oid indexId;
3550  Oid tableId;
3551  Oid amId;
3552  bool safe; /* for set_indexsafe_procflags */
3553  } ReindexIndexInfo;
3554  List *heapRelationIds = NIL;
3555  List *indexIds = NIL;
3556  List *newIndexIds = NIL;
3557  List *relationLocks = NIL;
3558  List *lockTags = NIL;
3559  ListCell *lc,
3560  *lc2;
3561  MemoryContext private_context;
3562  MemoryContext oldcontext;
3563  char relkind;
3564  char *relationName = NULL;
3565  char *relationNamespace = NULL;
3566  PGRUsage ru0;
3567  const int progress_index[] = {
3572  };
3573  int64 progress_vals[4];
3574 
3575  /*
3576  * Create a memory context that will survive forced transaction commits we
3577  * do below. Since it is a child of PortalContext, it will go away
3578  * eventually even if we suffer an error; there's no need for special
3579  * abort cleanup logic.
3580  */
3581  private_context = AllocSetContextCreate(PortalContext,
3582  "ReindexConcurrent",
3584 
3585  if ((params->options & REINDEXOPT_VERBOSE) != 0)
3586  {
3587  /* Save data needed by REINDEX VERBOSE in private context */
3588  oldcontext = MemoryContextSwitchTo(private_context);
3589 
3590  relationName = get_rel_name(relationOid);
3591  relationNamespace = get_namespace_name(get_rel_namespace(relationOid));
3592 
3593  pg_rusage_init(&ru0);
3594 
3595  MemoryContextSwitchTo(oldcontext);
3596  }
3597 
3598  relkind = get_rel_relkind(relationOid);
3599 
3600  /*
3601  * Extract the list of indexes that are going to be rebuilt based on the
3602  * relation Oid given by caller.
3603  */
3604  switch (relkind)
3605  {
3606  case RELKIND_RELATION:
3607  case RELKIND_MATVIEW:
3608  case RELKIND_TOASTVALUE:
3609  {
3610  /*
3611  * In the case of a relation, find all its indexes including
3612  * toast indexes.
3613  */
3614  Relation heapRelation;
3615 
3616  /* Save the list of relation OIDs in private context */
3617  oldcontext = MemoryContextSwitchTo(private_context);
3618 
3619  /* Track this relation for session locks */
3620  heapRelationIds = lappend_oid(heapRelationIds, relationOid);
3621 
3622  MemoryContextSwitchTo(oldcontext);
3623 
3624  if (IsCatalogRelationOid(relationOid))
3625  ereport(ERROR,
3626  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
3627  errmsg("cannot reindex system catalogs concurrently")));
3628 
3629  /* Open relation to get its indexes */
3630  if ((params->options & REINDEXOPT_MISSING_OK) != 0)
3631  {
3632  heapRelation = try_table_open(relationOid,
3634  /* leave if relation does not exist */
3635  if (!heapRelation)
3636  break;
3637  }
3638  else
3639  heapRelation = table_open(relationOid,
3641 
3642  if (OidIsValid(params->tablespaceOid) &&
3643  IsSystemRelation(heapRelation))
3644  ereport(ERROR,
3645  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
3646  errmsg("cannot move system relation \"%s\"",
3647  RelationGetRelationName(heapRelation))));
3648 
3649  /* Add all the valid indexes of relation to list */
3650  foreach(lc, RelationGetIndexList(heapRelation))
3651  {
3652  Oid cellOid = lfirst_oid(lc);
3653  Relation indexRelation = index_open(cellOid,
3655 
3656  if (!indexRelation->rd_index->indisvalid)
3657  ereport(WARNING,
3658  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
3659  errmsg("skipping reindex of invalid index \"%s.%s\"",
3661  get_rel_name(cellOid)),
3662  errhint("Use DROP INDEX or REINDEX INDEX.")));
3663  else if (indexRelation->rd_index->indisexclusion)
3664  ereport(WARNING,
3665  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
3666  errmsg("cannot reindex exclusion constraint index \"%s.%s\" concurrently, skipping",
3668  get_rel_name(cellOid))));
3669  else
3670  {
3671  ReindexIndexInfo *idx;
3672 
3673  /* Save the list of relation OIDs in private context */
3674  oldcontext = MemoryContextSwitchTo(private_context);
3675 
3676  idx = palloc_object(ReindexIndexInfo);
3677  idx->indexId = cellOid;
3678  /* other fields set later */
3679 
3680  indexIds = lappend(indexIds, idx);
3681 
3682  MemoryContextSwitchTo(oldcontext);
3683  }
3684 
3685  index_close(indexRelation, NoLock);
3686  }
3687 
3688  /* Also add the toast indexes */
3689  if (OidIsValid(heapRelation->rd_rel->reltoastrelid))
3690  {
3691  Oid toastOid = heapRelation->rd_rel->reltoastrelid;
3692  Relation toastRelation = table_open(toastOid,
3694 
3695  /* Save the list of relation OIDs in private context */
3696  oldcontext = MemoryContextSwitchTo(private_context);
3697 
3698  /* Track this relation for session locks */
3699  heapRelationIds = lappend_oid(heapRelationIds, toastOid);
3700 
3701  MemoryContextSwitchTo(oldcontext);
3702 
3703  foreach(lc2, RelationGetIndexList(toastRelation))
3704  {
3705  Oid cellOid = lfirst_oid(lc2);
3706  Relation indexRelation = index_open(cellOid,
3708 
3709  if (!indexRelation->rd_index->indisvalid)
3710  ereport(WARNING,
3711  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
3712  errmsg("skipping reindex of invalid index \"%s.%s\"",
3714  get_rel_name(cellOid)),
3715  errhint("Use DROP INDEX or REINDEX INDEX.")));
3716  else
3717  {
3718  ReindexIndexInfo *idx;
3719 
3720  /*
3721  * Save the list of relation OIDs in private
3722  * context
3723  */
3724  oldcontext = MemoryContextSwitchTo(private_context);
3725 
3726  idx = palloc_object(ReindexIndexInfo);
3727  idx->indexId = cellOid;
3728  indexIds = lappend(indexIds, idx);
3729  /* other fields set later */
3730 
3731  MemoryContextSwitchTo(oldcontext);
3732  }
3733 
3734  index_close(indexRelation, NoLock);
3735  }
3736 
3737  table_close(toastRelation, NoLock);
3738  }
3739 
3740  table_close(heapRelation, NoLock);
3741  break;
3742  }
3743  case RELKIND_INDEX:
3744  {
3745  Oid heapId = IndexGetRelation(relationOid,
3746  (params->options & REINDEXOPT_MISSING_OK) != 0);
3747  Relation heapRelation;
3748  ReindexIndexInfo *idx;
3749 
3750  /* if relation is missing, leave */
3751  if (!OidIsValid(heapId))
3752  break;
3753 
3754  if (IsCatalogRelationOid(heapId))
3755  ereport(ERROR,
3756  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
3757  errmsg("cannot reindex system catalogs concurrently")));
3758 
3759  /*
3760  * Don't allow reindex for an invalid index on TOAST table, as
3761  * if rebuilt it would not be possible to drop it. Match
3762  * error message in reindex_index().
3763  */
3764  if (IsToastNamespace(get_rel_namespace(relationOid)) &&
3765  !get_index_isvalid(relationOid))
3766  ereport(ERROR,
3767  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
3768  errmsg("cannot reindex invalid index on TOAST table")));
3769 
3770  /*
3771  * Check if parent relation can be locked and if it exists,
3772  * this needs to be done at this stage as the list of indexes
3773  * to rebuild is not complete yet, and REINDEXOPT_MISSING_OK
3774  * should not be used once all the session locks are taken.
3775  */
3776  if ((params->options & REINDEXOPT_MISSING_OK) != 0)
3777  {
3778  heapRelation = try_table_open(heapId,
3780  /* leave if relation does not exist */
3781  if (!heapRelation)
3782  break;
3783  }
3784  else
3785  heapRelation = table_open(heapId,
3787 
3788  if (OidIsValid(params->tablespaceOid) &&
3789  IsSystemRelation(heapRelation))
3790  ereport(ERROR,
3791  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
3792  errmsg("cannot move system relation \"%s\"",
3793  get_rel_name(relationOid))));
3794 
3795  table_close(heapRelation, NoLock);
3796 
3797  /* Save the list of relation OIDs in private context */
3798  oldcontext = MemoryContextSwitchTo(private_context);
3799 
3800  /* Track the heap relation of this index for session locks */
3801  heapRelationIds = list_make1_oid(heapId);
3802 
3803  /*
3804  * Save the list of relation OIDs in private context. Note
3805  * that invalid indexes are allowed here.
3806  */
3807  idx = palloc_object(ReindexIndexInfo);
3808  idx->indexId = relationOid;
3809  indexIds = lappend(indexIds, idx);
3810  /* other fields set later */
3811 
3812  MemoryContextSwitchTo(oldcontext);
3813  break;
3814  }
3815 
3816  case RELKIND_PARTITIONED_TABLE:
3817  case RELKIND_PARTITIONED_INDEX:
3818  default:
3819  /* Return error if type of relation is not supported */
3820  ereport(ERROR,
3821  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
3822  errmsg("cannot reindex this type of relation concurrently")));
3823  break;
3824  }
3825 
3826  /*
3827  * Definitely no indexes, so leave. Any checks based on
3828  * REINDEXOPT_MISSING_OK should be done only while the list of indexes to
3829  * work on is built as the session locks taken before this transaction
3830  * commits will make sure that they cannot be dropped by a concurrent
3831  * session until this operation completes.
3832  */
3833  if (indexIds == NIL)
3834  return false;
3835 
3836  /* It's not a shared catalog, so refuse to move it to shared tablespace */
3837  if (params->tablespaceOid == GLOBALTABLESPACE_OID)
3838  ereport(ERROR,
3839  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
3840  errmsg("cannot move non-shared relation to tablespace \"%s\"",
3841  get_tablespace_name(params->tablespaceOid))));
3842 
3843  Assert(heapRelationIds != NIL);
3844 
3845  /*-----
3846  * Now we have all the indexes we want to process in indexIds.
3847  *
3848  * The phases now are:
3849  *
3850  * 1. create new indexes in the catalog
3851  * 2. build new indexes
3852  * 3. let new indexes catch up with tuples inserted in the meantime
3853  * 4. swap index names
3854  * 5. mark old indexes as dead
3855  * 6. drop old indexes
3856  *
3857  * We process each phase for all indexes before moving to the next phase,
3858  * for efficiency.
3859  */
3860 
3861  /*
3862  * Phase 1 of REINDEX CONCURRENTLY
3863  *
3864  * Create a new index with the same properties as the old one, but it is
3865  * only registered in catalogs and will be built later. Then get session
3866  * locks on all involved tables. See analogous code in DefineIndex() for
3867  * more detailed comments.
3868  */
3869 
3870  foreach(lc, indexIds)
3871  {
3872  char *concurrentName;
3873  ReindexIndexInfo *idx = lfirst(lc);
3874  ReindexIndexInfo *newidx;
3875  Oid newIndexId;
3876  Relation indexRel;
3877  Relation heapRel;
3878  Oid save_userid;
3879  int save_sec_context;
3880  int save_nestlevel;
3881  Relation newIndexRel;
3882  LockRelId *lockrelid;
3883  Oid tablespaceid;
3884 
3885  indexRel = index_open(idx->indexId, ShareUpdateExclusiveLock);
3886  heapRel = table_open(indexRel->rd_index->indrelid,
3888 
3889  /*
3890  * Switch to the table owner's userid, so that any index functions are
3891  * run as that user. Also lock down security-restricted operations
3892  * and arrange to make GUC variable changes local to this command.
3893  */
3894  GetUserIdAndSecContext(&save_userid, &save_sec_context);
3895  SetUserIdAndSecContext(heapRel->rd_rel->relowner,
3896  save_sec_context | SECURITY_RESTRICTED_OPERATION);
3897  save_nestlevel = NewGUCNestLevel();
3899 
3900  /* determine safety of this index for set_indexsafe_procflags */
3901  idx->safe = (indexRel->rd_indexprs == NIL &&
3902  indexRel->rd_indpred == NIL);
3903  idx->tableId = RelationGetRelid(heapRel);
3904  idx->amId = indexRel->rd_rel->relam;
3905 
3906  /* This function shouldn't be called for temporary relations. */
3907  if (indexRel->rd_rel->relpersistence == RELPERSISTENCE_TEMP)
3908  elog(ERROR, "cannot reindex a temporary table concurrently");
3909 
3911 
3913  progress_vals[1] = 0; /* initializing */
3914  progress_vals[2] = idx->indexId;
3915  progress_vals[3] = idx->amId;
3916  pgstat_progress_update_multi_param(4, progress_index, progress_vals);
3917 
3918  /* Choose a temporary relation name for the new index */
3919  concurrentName = ChooseRelationName(get_rel_name(idx->indexId),
3920  NULL,
3921  "ccnew",
3922  get_rel_namespace(indexRel->rd_index->indrelid),
3923  false);
3924 
3925  /* Choose the new tablespace, indexes of toast tables are not moved */
3926  if (OidIsValid(params->tablespaceOid) &&
3927  heapRel->rd_rel->relkind != RELKIND_TOASTVALUE)
3928  tablespaceid = params->tablespaceOid;
3929  else
3930  tablespaceid = indexRel->rd_rel->reltablespace;
3931 
3932  /* Create new index definition based on given index */
3933  newIndexId = index_concurrently_create_copy(heapRel,
3934  idx->indexId,
3935  tablespaceid,
3936  concurrentName);
3937 
3938  /*
3939  * Now open the relation of the new index, a session-level lock is
3940  * also needed on it.
3941  */
3942  newIndexRel = index_open(newIndexId, ShareUpdateExclusiveLock);
3943 
3944  /*
3945  * Save the list of OIDs and locks in private context
3946  */
3947  oldcontext = MemoryContextSwitchTo(private_context);
3948 
3949  newidx = palloc_object(ReindexIndexInfo);
3950  newidx->indexId = newIndexId;
3951  newidx->safe = idx->safe;
3952  newidx->tableId = idx->tableId;
3953  newidx->amId = idx->amId;
3954 
3955  newIndexIds = lappend(newIndexIds, newidx);
3956 
3957  /*
3958  * Save lockrelid to protect each relation from drop then close
3959  * relations. The lockrelid on parent relation is not taken here to
3960  * avoid multiple locks taken on the same relation, instead we rely on
3961  * parentRelationIds built earlier.
3962  */
3963  lockrelid = palloc_object(LockRelId);
3964  *lockrelid = indexRel->rd_lockInfo.lockRelId;
3965  relationLocks = lappend(relationLocks, lockrelid);
3966  lockrelid = palloc_object(LockRelId);
3967  *lockrelid = newIndexRel->rd_lockInfo.lockRelId;
3968  relationLocks = lappend(relationLocks, lockrelid);
3969 
3970  MemoryContextSwitchTo(oldcontext);
3971 
3972  index_close(indexRel, NoLock);
3973  index_close(newIndexRel, NoLock);
3974 
3975  /* Roll back any GUC changes executed by index functions */
3976  AtEOXact_GUC(false, save_nestlevel);
3977 
3978  /* Restore userid and security context */
3979  SetUserIdAndSecContext(save_userid, save_sec_context);
3980 
3981  table_close(heapRel, NoLock);
3982 
3983  /*
3984  * If a statement is available, telling that this comes from a REINDEX
3985  * command, collect the new index for event triggers.
3986  */
3987  if (stmt)
3988  {
3989  ObjectAddress address;
3990 
3991  ObjectAddressSet(address, RelationRelationId, newIndexId);
3994  (Node *) stmt);
3995  }
3996  }
3997 
3998  /*
3999  * Save the heap lock for following visibility checks with other backends
4000  * might conflict with this session.
4001  */
4002  foreach(lc, heapRelationIds)
4003  {
4005  LockRelId *lockrelid;
4006  LOCKTAG *heaplocktag;
4007 
4008  /* Save the list of locks in private context */
4009  oldcontext = MemoryContextSwitchTo(private_context);
4010 
4011  /* Add lockrelid of heap relation to the list of locked relations */
4012  lockrelid = palloc_object(LockRelId);
4013  *lockrelid = heapRelation->rd_lockInfo.lockRelId;
4014  relationLocks = lappend(relationLocks, lockrelid);
4015 
4016  heaplocktag = palloc_object(LOCKTAG);
4017 
4018  /* Save the LOCKTAG for this parent relation for the wait phase */
4019  SET_LOCKTAG_RELATION(*heaplocktag, lockrelid->dbId, lockrelid->relId);
4020  lockTags = lappend(lockTags, heaplocktag);
4021 
4022  MemoryContextSwitchTo(oldcontext);
4023 
4024  /* Close heap relation */
4025  table_close(heapRelation, NoLock);
4026  }
4027 
4028  /* Get a session-level lock on each table. */
4029  foreach(lc, relationLocks)
4030  {
4031  LockRelId *lockrelid = (LockRelId *) lfirst(lc);
4032 
4034  }
4035 
4039 
4040  /*
4041  * Because we don't take a snapshot in this transaction, there's no need
4042  * to set the PROC_IN_SAFE_IC flag here.
4043  */
4044 
4045  /*
4046  * Phase 2 of REINDEX CONCURRENTLY
4047  *
4048  * Build the new indexes in a separate transaction for each index to avoid
4049  * having open transactions for an unnecessary long time. But before
4050  * doing that, wait until no running transactions could have the table of
4051  * the index open with the old list of indexes. See "phase 2" in
4052  * DefineIndex() for more details.
4053  */
4054 
4057  WaitForLockersMultiple(lockTags, ShareLock, true);
4059 
4060  foreach(lc, newIndexIds)
4061  {
4062  ReindexIndexInfo *newidx = lfirst(lc);
4063 
4064  /* Start new transaction for this index's concurrent build */
4066 
4067  /*
4068  * Check for user-requested abort. This is inside a transaction so as
4069  * xact.c does not issue a useless WARNING, and ensures that
4070  * session-level locks are cleaned up on abort.
4071  */
4073 
4074  /* Tell concurrent indexing to ignore us, if index qualifies */
4075  if (newidx->safe)
4077 
4078  /* Set ActiveSnapshot since functions in the indexes may need it */
4080 
4081  /*
4082  * Update progress for the index to build, with the correct parent
4083  * table involved.
4084  */
4087  progress_vals[1] = PROGRESS_CREATEIDX_PHASE_BUILD;
4088  progress_vals[2] = newidx->indexId;
4089  progress_vals[3] = newidx->amId;
4090  pgstat_progress_update_multi_param(4, progress_index, progress_vals);
4091 
4092  /* Perform concurrent build of new index */
4093  index_concurrently_build(newidx->tableId, newidx->indexId);
4094 
4097  }
4098 
4100 
4101  /*
4102  * Because we don't take a snapshot or Xid in this transaction, there's no
4103  * need to set the PROC_IN_SAFE_IC flag here.
4104  */
4105 
4106  /*
4107  * Phase 3 of REINDEX CONCURRENTLY
4108  *
4109  * During this phase the old indexes catch up with any new tuples that
4110  * were created during the previous phase. See "phase 3" in DefineIndex()
4111  * for more details.
4112  */
4113 
4116  WaitForLockersMultiple(lockTags, ShareLock, true);
4118 
4119  foreach(lc, newIndexIds)
4120  {
4121  ReindexIndexInfo *newidx = lfirst(lc);
4122  TransactionId limitXmin;
4123  Snapshot snapshot;
4124 
4126 
4127  /*
4128  * Check for user-requested abort. This is inside a transaction so as
4129  * xact.c does not issue a useless WARNING, and ensures that
4130  * session-level locks are cleaned up on abort.
4131  */
4133 
4134  /* Tell concurrent indexing to ignore us, if index qualifies */
4135  if (newidx->safe)
4137 
4138  /*
4139  * Take the "reference snapshot" that will be used by validate_index()
4140  * to filter candidate tuples.
4141  */
4143  PushActiveSnapshot(snapshot);
4144 
4145  /*
4146  * Update progress for the index to build, with the correct parent
4147  * table involved.
4148  */
4151  progress_vals[1] = PROGRESS_CREATEIDX_PHASE_VALIDATE_IDXSCAN;
4152  progress_vals[2] = newidx->indexId;
4153  progress_vals[3] = newidx->amId;
4154  pgstat_progress_update_multi_param(4, progress_index, progress_vals);
4155 
4156  validate_index(newidx->tableId, newidx->indexId, snapshot);
4157 
4158  /*
4159  * We can now do away with our active snapshot, we still need to save
4160  * the xmin limit to wait for older snapshots.
4161  */
4162  limitXmin = snapshot->xmin;
4163 
4165  UnregisterSnapshot(snapshot);
4166 
4167  /*
4168  * To ensure no deadlocks, we must commit and start yet another
4169  * transaction, and do our wait before any snapshot has been taken in
4170  * it.
4171  */
4174 
4175  /*
4176  * The index is now valid in the sense that it contains all currently
4177  * interesting tuples. But since it might not contain tuples deleted
4178  * just before the reference snap was taken, we have to wait out any
4179  * transactions that might have older snapshots.
4180  *
4181  * Because we don't take a snapshot or Xid in this transaction,
4182  * there's no need to set the PROC_IN_SAFE_IC flag here.
4183  */
4186  WaitForOlderSnapshots(limitXmin, true);
4187 
4189  }
4190 
4191  /*
4192  * Phase 4 of REINDEX CONCURRENTLY
4193  *
4194  * Now that the new indexes have been validated, swap each new index with
4195  * its corresponding old index.
4196  *
4197  * We mark the new indexes as valid and the old indexes as not valid at
4198  * the same time to make sure we only get constraint violations from the
4199  * indexes with the correct names.
4200  */
4201 
4203 
4204  /*
4205  * Because this transaction only does catalog manipulations and doesn't do
4206  * any index operations, we can set the PROC_IN_SAFE_IC flag here
4207  * unconditionally.
4208  */
4210 
4211  forboth(lc, indexIds, lc2, newIndexIds)
4212  {
4213  ReindexIndexInfo *oldidx = lfirst(lc);
4214  ReindexIndexInfo *newidx = lfirst(lc2);
4215  char *oldName;
4216 
4217  /*
4218  * Check for user-requested abort. This is inside a transaction so as
4219  * xact.c does not issue a useless WARNING, and ensures that
4220  * session-level locks are cleaned up on abort.
4221  */
4223 
4224  /* Choose a relation name for old index */
4225  oldName = ChooseRelationName(get_rel_name(oldidx->indexId),
4226  NULL,
4227  "ccold",
4228  get_rel_namespace(oldidx->tableId),
4229  false);
4230 
4231  /*
4232  * Swap old index with the new one. This also marks the new one as
4233  * valid and the old one as not valid.
4234  */
4235  index_concurrently_swap(newidx->indexId, oldidx->indexId, oldName);
4236 
4237  /*
4238  * Invalidate the relcache for the table, so that after this commit
4239  * all sessions will refresh any cached plans that might reference the
4240  * index.
4241  */
4242  CacheInvalidateRelcacheByRelid(oldidx->tableId);
4243 
4244  /*
4245  * CCI here so that subsequent iterations see the oldName in the
4246  * catalog and can choose a nonconflicting name for their oldName.
4247  * Otherwise, this could lead to conflicts if a table has two indexes
4248  * whose names are equal for the first NAMEDATALEN-minus-a-few
4249  * characters.
4250  */
4252  }
4253 
4254  /* Commit this transaction and make index swaps visible */
4257 
4258  /*
4259  * While we could set PROC_IN_SAFE_IC if all indexes qualified, there's no
4260  * real need for that, because we only acquire an Xid after the wait is
4261  * done, and that lasts for a very short period.
4262  */
4263 
4264  /*
4265  * Phase 5 of REINDEX CONCURRENTLY
4266  *
4267  * Mark the old indexes as dead. First we must wait until no running
4268  * transaction could be using the index for a query. See also
4269  * index_drop() for more details.
4270  */
4271 
4275 
4276  foreach(lc, indexIds)
4277  {
4278  ReindexIndexInfo *oldidx = lfirst(lc);
4279 
4280  /*
4281  * Check for user-requested abort. This is inside a transaction so as
4282  * xact.c does not issue a useless WARNING, and ensures that
4283  * session-level locks are cleaned up on abort.
4284  */
4286 
4287  index_concurrently_set_dead(oldidx->tableId, oldidx->indexId);
4288  }
4289 
4290  /* Commit this transaction to make the updates visible. */
4293 
4294  /*
4295  * While we could set PROC_IN_SAFE_IC if all indexes qualified, there's no
4296  * real need for that, because we only acquire an Xid after the wait is
4297  * done, and that lasts for a very short period.
4298  */
4299 
4300  /*
4301  * Phase 6 of REINDEX CONCURRENTLY
4302  *
4303  * Drop the old indexes.
4304  */
4305 
4309 
4311 
4312  {
4314 
4315  foreach(lc, indexIds)
4316  {
4317  ReindexIndexInfo *idx = lfirst(lc);
4318  ObjectAddress object;
4319 
4320  object.classId = RelationRelationId;
4321  object.objectId = idx->indexId;
4322  object.objectSubId = 0;
4323 
4324  add_exact_object_address(&object, objects);
4325  }
4326 
4327  /*
4328  * Use PERFORM_DELETION_CONCURRENT_LOCK so that index_drop() uses the
4329  * right lock level.
4330  */
4333  }
4334 
4337 
4338  /*
4339  * Finally, release the session-level lock on the table.
4340  */
4341  foreach(lc, relationLocks)
4342  {
4343  LockRelId *lockrelid = (LockRelId *) lfirst(lc);
4344 
4346  }
4347 
4348  /* Start a new transaction to finish process properly */
4350 
4351  /* Log what we did */
4352  if ((params->options & REINDEXOPT_VERBOSE) != 0)
4353  {
4354  if (relkind == RELKIND_INDEX)
4355  ereport(INFO,
4356  (errmsg("index \"%s.%s\" was reindexed",
4357  relationNamespace, relationName),
4358  errdetail("%s.",
4359  pg_rusage_show(&ru0))));
4360  else
4361  {
4362  foreach(lc, newIndexIds)
4363  {
4364  ReindexIndexInfo *idx = lfirst(lc);
4365  Oid indOid = idx->indexId;
4366 
4367  ereport(INFO,
4368  (errmsg("index \"%s.%s\" was reindexed",
4370  get_rel_name(indOid))));
4371  /* Don't show rusage here, since it's not per index. */
4372  }
4373 
4374  ereport(INFO,
4375  (errmsg("table \"%s.%s\" was reindexed",
4376  relationNamespace, relationName),
4377  errdetail("%s.",
4378  pg_rusage_show(&ru0))));
4379  }
4380  }
4381 
4382  MemoryContextDelete(private_context);
4383 
4385 
4386  return true;
4387 }
Datum idx(PG_FUNCTION_ARGS)
Definition: _int_op.c:259
bool IsToastNamespace(Oid namespaceId)
Definition: catalog.c:200
bool IsSystemRelation(Relation relation)
Definition: catalog.c:73
void performMultipleDeletions(const ObjectAddresses *objects, DropBehavior behavior, int flags)
Definition: dependency.c:332
ObjectAddresses * new_object_addresses(void)
Definition: dependency.c:2485
void add_exact_object_address(const ObjectAddress *object, ObjectAddresses *addrs)
Definition: dependency.c:2531
#define PERFORM_DELETION_CONCURRENT_LOCK
Definition: dependency.h:90
#define PERFORM_DELETION_INTERNAL
Definition: dependency.h:85
void EventTriggerCollectSimpleCommand(ObjectAddress address, ObjectAddress secondaryObject, Node *parsetree)
#define palloc_object(type)
Definition: fe_memutils.h:62
void index_concurrently_set_dead(Oid heapId, Oid indexId)
Definition: index.c:1819
void index_concurrently_swap(Oid newIndexId, Oid oldIndexId, const char *oldName)
Definition: index.c:1548
Oid index_concurrently_create_copy(Relation heapRelation, Oid oldIndexId, Oid tablespaceOid, const char *newName)
Definition: index.c:1297
void WaitForLockersMultiple(List *locktags, LOCKMODE lockmode, bool progress)
Definition: lmgr.c:907
#define CHECK_FOR_INTERRUPTS()
Definition: miscadmin.h:122
const ObjectAddress InvalidObjectAddress
@ DROP_RESTRICT
Definition: parsenodes.h:2336
#define forboth(cell1, list1, cell2, list2)
Definition: pg_list.h:518
#define list_make1_oid(x1)
Definition: pg_list.h:242
const char * pg_rusage_show(const PGRUsage *ru0)
Definition: pg_rusage.c:40
void pg_rusage_init(PGRUsage *ru0)
Definition: pg_rusage.c:27
#define PROGRESS_CREATEIDX_PHASE_WAIT_4
Definition: progress.h:100
#define PROGRESS_CREATEIDX_PHASE_BUILD
Definition: progress.h:94
#define PROGRESS_CREATEIDX_COMMAND_REINDEX_CONCURRENTLY
Definition: progress.h:113
#define PROGRESS_CREATEIDX_PHASE_VALIDATE_IDXSCAN
Definition: progress.h:96
#define PROGRESS_CREATEIDX_PHASE_WAIT_5
Definition: progress.h:101
List * rd_indpred
Definition: rel.h:213
List * rd_indexprs
Definition: rel.h:212
Relation try_table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:60

References AccessExclusiveLock, add_exact_object_address(), ALLOCSET_SMALL_SIZES, AllocSetContextCreate, Assert, AtEOXact_GUC(), CacheInvalidateRelcacheByRelid(), CHECK_FOR_INTERRUPTS, ChooseRelationName(), ObjectAddress::classId, CommandCounterIncrement(), CommitTransactionCommand(), LockRelId::dbId, DROP_RESTRICT, elog, ereport, errcode(), errdetail(), errhint(), errmsg(), ERROR, EventTriggerCollectSimpleCommand(), forboth, get_index_isvalid(), get_namespace_name(), get_rel_name(), get_rel_namespace(), get_rel_relkind(), get_tablespace_name(), GetTransactionSnapshot(), GetUserIdAndSecContext(), idx(), index_close(), index_concurrently_build(), index_concurrently_create_copy(), index_concurrently_set_dead(), index_concurrently_swap(), index_open(), IndexGetRelation(), INFO, InvalidObjectAddress, IsCatalogRelationOid(), IsSystemRelation(), IsToastNamespace(), lappend(), lappend_oid(), lfirst, lfirst_oid, list_make1_oid, LockRelationIdForSession(), LockInfoData::lockRelId, MemoryContextDelete(), MemoryContextSwitchTo(), new_object_addresses(), NewGUCNestLevel(), NIL, NoLock, ObjectAddressSet, OidIsValid, ReindexParams::options, palloc_object, PERFORM_DELETION_CONCURRENT_LOCK, PERFORM_DELETION_INTERNAL, performMultipleDeletions(), pg_rusage_init(), pg_rusage_show(), pgstat_progress_end_command(), pgstat_progress_start_command(), pgstat_progress_update_multi_param(), pgstat_progress_update_param(), PopActiveSnapshot(), PortalContext, PROGRESS_COMMAND_CREATE_INDEX, PROGRESS_CREATEIDX_ACCESS_METHOD_OID, PROGRESS_CREATEIDX_COMMAND, PROGRESS_CREATEIDX_COMMAND_REINDEX_CONCURRENTLY, PROGRESS_CREATEIDX_INDEX_OID, PROGRESS_CREATEIDX_PHASE, PROGRESS_CREATEIDX_PHASE_BUILD, PROGRESS_CREATEIDX_PHASE_VALIDATE_IDXSCAN, PROGRESS_CREATEIDX_PHASE_WAIT_1, PROGRESS_CREATEIDX_PHASE_WAIT_2, PROGRESS_CREATEIDX_PHASE_WAIT_3, PROGRESS_CREATEIDX_PHASE_WAIT_4, PROGRESS_CREATEIDX_PHASE_WAIT_5, PushActiveSnapshot(), RelationData::rd_index, RelationData::rd_indexprs, RelationData::rd_indpred, RelationData::rd_lockInfo, RelationData::rd_rel, RegisterSnapshot(), REINDEXOPT_MISSING_OK, REINDEXOPT_VERBOSE, RelationGetIndexList(), RelationGetRelationName, RelationGetRelid, LockRelId::relId, RestrictSearchPath(), SECURITY_RESTRICTED_OPERATION, set_indexsafe_procflags(), SET_LOCKTAG_RELATION, SetUserIdAndSecContext(), ShareLock, ShareUpdateExclusiveLock, StartTransactionCommand(), stmt, table_close(), table_open(), ReindexParams::tablespaceOid, try_table_open(), UnlockRelationIdForSession(), UnregisterSnapshot(), validate_index(), WaitForLockersMultiple(), WaitForOlderSnapshots(), WARNING, and SnapshotData::xmin.

Referenced by ReindexIndex(), ReindexMultipleInternal(), and ReindexTable().

◆ ReindexTable()

static Oid ReindexTable ( const ReindexStmt stmt,
const ReindexParams params,
bool  isTopLevel 
)
static

Definition at line 3026 of file indexcmds.c.

3027 {
3028  Oid heapOid;
3029  bool result;
3030  const RangeVar *relation = stmt->relation;
3031 
3032  /*
3033  * The lock level used here should match reindex_relation().
3034  *
3035  * If it's a temporary table, we will perform a non-concurrent reindex,
3036  * even if CONCURRENTLY was requested. In that case, reindex_relation()
3037  * will upgrade the lock, but that's OK, because other sessions can't hold
3038  * locks on our temporary table.
3039  */
3040  heapOid = RangeVarGetRelidExtended(relation,
3041  (params->options & REINDEXOPT_CONCURRENTLY) != 0 ?
3043  0,
3045 
3046  if (get_rel_relkind(heapOid) == RELKIND_PARTITIONED_TABLE)
3047  ReindexPartitions(stmt, heapOid, params, isTopLevel);
3048  else if ((params->options & REINDEXOPT_CONCURRENTLY) != 0 &&
3049  get_rel_persistence(heapOid) != RELPERSISTENCE_TEMP)
3050  {
3051  result = ReindexRelationConcurrently(stmt, heapOid, params);
3052 
3053  if (!result)
3054  ereport(NOTICE,
3055  (errmsg("table \"%s\" has no indexes that can be reindexed concurrently",
3056  relation->relname)));
3057  }
3058  else
3059  {
3060  ReindexParams newparams = *params;
3061 
3062  newparams.options |= REINDEXOPT_REPORT_PROGRESS;
3063  result = reindex_relation(stmt, heapOid,
3066  &newparams);
3067  if (!result)
3068  ereport(NOTICE,
3069  (errmsg("table \"%s\" has no indexes to reindex",
3070  relation->relname)));
3071  }
3072 
3073  return heapOid;
3074 }
void RangeVarCallbackMaintainsTable(const RangeVar *relation, Oid relId, Oid oldRelId, void *arg)
Definition: tablecmds.c:18414

References ereport, errmsg(), get_rel_persistence(), get_rel_relkind(), NOTICE, ReindexParams::options, ReindexIndexCallbackState::params, RangeVarCallbackMaintainsTable(), RangeVarGetRelidExtended(), REINDEX_REL_CHECK_CONSTRAINTS, REINDEX_REL_PROCESS_TOAST, reindex_relation(), REINDEXOPT_CONCURRENTLY, REINDEXOPT_REPORT_PROGRESS, ReindexPartitions(), ReindexRelationConcurrently(), RangeVar::relname, ShareLock, ShareUpdateExclusiveLock, and stmt.

Referenced by ExecReindex().

◆ ResolveOpClass()

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

Definition at line 2253 of file indexcmds.c.

2255 {
2256  char *schemaname;
2257  char *opcname;
2258  HeapTuple tuple;
2259  Form_pg_opclass opform;
2260  Oid opClassId,
2261  opInputType;
2262 
2263  if (opclass == NIL)
2264  {
2265  /* no operator class specified, so find the default */
2266  opClassId = GetDefaultOpClass(attrType, accessMethodId);
2267  if (!OidIsValid(opClassId))
2268  ereport(ERROR,
2269  (errcode(ERRCODE_UNDEFINED_OBJECT),
2270  errmsg("data type %s has no default operator class for access method \"%s\"",
2271  format_type_be(attrType), accessMethodName),
2272  errhint("You must specify an operator class for the index or define a default operator class for the data type.")));
2273  return opClassId;
2274  }
2275 
2276  /*
2277  * Specific opclass name given, so look up the opclass.
2278  */
2279 
2280  /* deconstruct the name list */
2281  DeconstructQualifiedName(opclass, &schemaname, &opcname);
2282 
2283  if (schemaname)
2284  {
2285  /* Look in specific schema only */
2286  Oid namespaceId;
2287 
2288  namespaceId = LookupExplicitNamespace(schemaname, false);
2289  tuple = SearchSysCache3(CLAAMNAMENSP,
2290  ObjectIdGetDatum(accessMethodId),
2291  PointerGetDatum(opcname),
2292  ObjectIdGetDatum(namespaceId));
2293  }
2294  else
2295  {
2296  /* Unqualified opclass name, so search the search path */
2297  opClassId = OpclassnameGetOpcid(accessMethodId, opcname);
2298  if (!OidIsValid(opClassId))
2299  ereport(ERROR,
2300  (errcode(ERRCODE_UNDEFINED_OBJECT),
2301  errmsg("operator class \"%s\" does not exist for access method \"%s\"",
2302  opcname, accessMethodName)));
2303  tuple = SearchSysCache1(CLAOID, ObjectIdGetDatum(opClassId));
2304  }
2305 
2306  if (!HeapTupleIsValid(tuple))
2307  ereport(ERROR,
2308  (errcode(ERRCODE_UNDEFINED_OBJECT),
2309  errmsg("operator class \"%s\" does not exist for access method \"%s\"",
2310  NameListToString(opclass), accessMethodName)));
2311 
2312  /*
2313  * Verify that the index operator class accepts this datatype. Note we
2314  * will accept binary compatibility.
2315  */
2316  opform = (Form_pg_opclass) GETSTRUCT(tuple);
2317  opClassId = opform->oid;
2318  opInputType = opform->opcintype;
2319 
2320  if (!IsBinaryCoercible(attrType, opInputType))
2321  ereport(ERROR,
2322  (errcode(ERRCODE_DATATYPE_MISMATCH),
2323  errmsg("operator class \"%s\" does not accept data type %s",
2324  NameListToString(opclass), format_type_be(attrType))));
2325 
2326  ReleaseSysCache(tuple);
2327 
2328  return opClassId;
2329 }
Oid GetDefaultOpClass(Oid type_id, Oid am_id)
Definition: indexcmds.c:2338
Oid OpclassnameGetOpcid(Oid amid, const char *opcname)
Definition: namespace.c:2106
Oid LookupExplicitNamespace(const char *nspname, bool missing_ok)
Definition: namespace.c:3370
void DeconstructQualifiedName(const List *names, char **nspname_p, char **objname_p)
Definition: namespace.c:3286
char * NameListToString(const List *names)
Definition: namespace.c:3579
HeapTuple SearchSysCache3(int cacheId, Datum key1, Datum key2, Datum key3)
Definition: syscache.c:240

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

Referenced by ComputeIndexAttrs(), and ComputePartitionAttrs().

◆ set_indexsafe_procflags()

static void set_indexsafe_procflags ( void  )
inlinestatic

Definition at line 4560 of file indexcmds.c.

4561 {
4562  /*
4563  * This should only be called before installing xid or xmin in MyProc;
4564  * otherwise, concurrent processes could see an Xmin that moves backwards.
4565  */
4568 
4569  LWLockAcquire(ProcArrayLock, LW_EXCLUSIVE);
4572  LWLockRelease(ProcArrayLock);
4573 }
bool LWLockAcquire(LWLock *lock, LWLockMode mode)
Definition: lwlock.c:1170
void LWLockRelease(LWLock *lock)
Definition: lwlock.c:1783
@ LW_EXCLUSIVE
Definition: lwlock.h:114
#define PROC_IN_SAFE_IC
Definition: proc.h:59
PROC_HDR * ProcGlobal
Definition: proc.c:78
uint8 statusFlags
Definition: proc.h:238
int pgxactoff
Definition: proc.h:180
TransactionId xid
Definition: proc.h:168
uint8 * statusFlags
Definition: proc.h:395

References Assert, InvalidTransactionId, LW_EXCLUSIVE, LWLockAcquire(), LWLockRelease(), MyProc, PGPROC::pgxactoff, PROC_IN_SAFE_IC, ProcGlobal, PGPROC::statusFlags, PROC_HDR::statusFlags, PGPROC::xid, and PGPROC::xmin.

Referenced by DefineIndex(), and ReindexRelationConcurrently().

◆ update_relispartition()

static void update_relispartition ( Oid  relationId,
bool  newval 
)
static

Definition at line 4525 of file indexcmds.c.

4526 {
4527  HeapTuple tup;
4528  Relation classRel;
4529 
4530  classRel = table_open(RelationRelationId, RowExclusiveLock);
4531  tup = SearchSysCacheCopy1(RELOID, ObjectIdGetDatum(relationId));
4532  if (!HeapTupleIsValid(tup))
4533  elog(ERROR, "cache lookup failed for relation %u", relationId);
4534  Assert(((Form_pg_class) GETSTRUCT(tup))->relispartition != newval);
4535  ((Form_pg_class) GETSTRUCT(tup))->relispartition = newval;
4536  CatalogTupleUpdate(classRel, &tup->t_self, tup);
4537  heap_freetuple(tup);
4538  table_close(classRel, RowExclusiveLock);
4539 }
#define newval
#define SearchSysCacheCopy1(cacheId, key1)
Definition: syscache.h:86

References Assert, CatalogTupleUpdate(), elog, ERROR, GETSTRUCT, heap_freetuple(), HeapTupleIsValid, newval, ObjectIdGetDatum(), RowExclusiveLock, SearchSysCacheCopy1, HeapTupleData::t_self, table_close(), and table_open().

Referenced by IndexSetParentIndex().

◆ WaitForOlderSnapshots()

void WaitForOlderSnapshots ( TransactionId  limitXmin,
bool  progress 
)

Definition at line 428 of file indexcmds.c.

429 {
430  int n_old_snapshots;
431  int i;
432  VirtualTransactionId *old_snapshots;
433 
434  old_snapshots = GetCurrentVirtualXIDs(limitXmin, true, false,
436  | PROC_IN_SAFE_IC,
437  &n_old_snapshots);
438  if (progress)
440 
441  for (i = 0; i < n_old_snapshots; i++)
442  {
443  if (!VirtualTransactionIdIsValid(old_snapshots[i]))
444  continue; /* found uninteresting in previous cycle */
445 
446  if (i > 0)
447  {
448  /* see if anything's changed ... */
449  VirtualTransactionId *newer_snapshots;
450  int n_newer_snapshots;
451  int j;
452  int k;
453 
454  newer_snapshots = GetCurrentVirtualXIDs(limitXmin,
455  true, false,
457  | PROC_IN_SAFE_IC,
458  &n_newer_snapshots);
459  for (j = i; j < n_old_snapshots; j++)
460  {
461  if (!VirtualTransactionIdIsValid(old_snapshots[j]))
462  continue; /* found uninteresting in previous cycle */
463  for (k = 0; k < n_newer_snapshots; k++)
464  {
465  if (VirtualTransactionIdEquals(old_snapshots[j],
466  newer_snapshots[k]))
467  break;
468  }
469  if (k >= n_newer_snapshots) /* not there anymore */
470  SetInvalidVirtualTransactionId(old_snapshots[j]);
471  }
472  pfree(newer_snapshots);
473  }
474 
475  if (VirtualTransactionIdIsValid(old_snapshots[i]))
476  {
477  /* If requested, publish who we're going to wait for. */
478  if (progress)
479  {
480  PGPROC *holder = ProcNumberGetProc(old_snapshots[i].procNumber);
481 
482  if (holder)
484  holder->pid);
485  }
486  VirtualXactLock(old_snapshots[i], true);
487  }
488 
489  if (progress)
491  }
492 }
bool VirtualXactLock(VirtualTransactionId vxid, bool wait)
Definition: lock.c:4528
#define VirtualTransactionIdIsValid(vxid)
Definition: lock.h:67
#define VirtualTransactionIdEquals(vxid1, vxid2)
Definition: lock.h:71
#define SetInvalidVirtualTransactionId(vxid)
Definition: lock.h:74
int progress
Definition: pgbench.c:261
#define PROC_IN_VACUUM
Definition: proc.h:58
#define PROC_IS_AUTOVACUUM
Definition: proc.h:57
PGPROC * ProcNumberGetProc(ProcNumber procNumber)
Definition: procarray.c:3125
VirtualTransactionId * GetCurrentVirtualXIDs(TransactionId limitXmin, bool excludeXmin0, bool allDbs, int excludeVacuum, int *nvxids)
Definition: procarray.c:3311
#define PROGRESS_WAITFOR_DONE
Definition: progress.h:117