PostgreSQL Source Code  git master
index.h File Reference
Include dependency graph for index.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  ValidateIndexState
 

Macros

#define DEFAULT_INDEX_TYPE   "btree"
 
#define INDEX_CREATE_IS_PRIMARY   (1 << 0)
 
#define INDEX_CREATE_ADD_CONSTRAINT   (1 << 1)
 
#define INDEX_CREATE_SKIP_BUILD   (1 << 2)
 
#define INDEX_CREATE_CONCURRENT   (1 << 3)
 
#define INDEX_CREATE_IF_NOT_EXISTS   (1 << 4)
 
#define INDEX_CREATE_PARTITIONED   (1 << 5)
 
#define INDEX_CREATE_INVALID   (1 << 6)
 
#define INDEX_CONSTR_CREATE_MARK_AS_PRIMARY   (1 << 0)
 
#define INDEX_CONSTR_CREATE_DEFERRABLE   (1 << 1)
 
#define INDEX_CONSTR_CREATE_INIT_DEFERRED   (1 << 2)
 
#define INDEX_CONSTR_CREATE_UPDATE_INDEX   (1 << 3)
 
#define INDEX_CONSTR_CREATE_REMOVE_OLD_DEPS   (1 << 4)
 
#define REINDEX_REL_PROCESS_TOAST   0x01
 
#define REINDEX_REL_SUPPRESS_INDEX_USE   0x02
 
#define REINDEX_REL_CHECK_CONSTRAINTS   0x04
 
#define REINDEX_REL_FORCE_INDEXES_UNLOGGED   0x08
 
#define REINDEX_REL_FORCE_INDEXES_PERMANENT   0x10
 

Typedefs

typedef struct ValidateIndexState ValidateIndexState
 

Enumerations

enum  IndexStateFlagsAction { INDEX_CREATE_SET_READY, INDEX_CREATE_SET_VALID, INDEX_DROP_CLEAR_VALID, INDEX_DROP_SET_DEAD }
 

Functions

void index_check_primary_key (Relation heapRel, IndexInfo *indexInfo, bool is_alter_table, IndexStmt *stmt)
 
Oid index_create (Relation heapRelation, const char *indexRelationName, Oid indexRelationId, Oid parentIndexRelid, Oid parentConstraintId, Oid relFileNode, IndexInfo *indexInfo, List *indexColNames, Oid accessMethodObjectId, Oid tableSpaceId, Oid *collationObjectId, Oid *classObjectId, int16 *coloptions, Datum reloptions, bits16 flags, bits16 constr_flags, bool allow_system_table_mods, bool is_internal, Oid *constraintId)
 
Oid index_concurrently_create_copy (Relation heapRelation, Oid oldIndexId, const char *newName)
 
void index_concurrently_build (Oid heapRelationId, Oid indexRelationId)
 
void index_concurrently_swap (Oid newIndexId, Oid oldIndexId, const char *oldName)
 
void index_concurrently_set_dead (Oid heapId, Oid indexId)
 
ObjectAddress index_constraint_create (Relation heapRelation, Oid indexRelationId, Oid parentConstraintId, IndexInfo *indexInfo, const char *constraintName, char constraintType, bits16 constr_flags, bool allow_system_table_mods, bool is_internal)
 
void index_drop (Oid indexId, bool concurrent, bool concurrent_lock_mode)
 
IndexInfoBuildIndexInfo (Relation index)
 
bool CompareIndexInfo (IndexInfo *info1, IndexInfo *info2, Oid *collations1, Oid *collations2, Oid *opfamilies1, Oid *opfamilies2, AttrNumber *attmap, int maplen)
 
void BuildSpeculativeIndexInfo (Relation index, IndexInfo *ii)
 
void FormIndexDatum (IndexInfo *indexInfo, TupleTableSlot *slot, EState *estate, Datum *values, bool *isnull)
 
void index_build (Relation heapRelation, Relation indexRelation, IndexInfo *indexInfo, bool isreindex, bool parallel)
 
void validate_index (Oid heapId, Oid indexId, Snapshot snapshot)
 
void index_set_state_flags (Oid indexId, IndexStateFlagsAction action)
 
void reindex_index (Oid indexId, bool skip_constraint_checks, char relpersistence, int options)
 
bool reindex_relation (Oid relid, int flags, int options)
 
bool ReindexIsProcessingHeap (Oid heapOid)
 
bool ReindexIsProcessingIndex (Oid indexOid)
 
Oid IndexGetRelation (Oid indexId, bool missing_ok)
 
Size EstimateReindexStateSpace (void)
 
void SerializeReindexState (Size maxsize, char *start_address)
 
void RestoreReindexState (void *reindexstate)
 
void IndexSetParentIndex (Relation idx, Oid parentOid)
 
static int64 itemptr_encode (ItemPointer itemptr)
 
static void itemptr_decode (ItemPointer itemptr, int64 encoded)
 

Macro Definition Documentation

◆ DEFAULT_INDEX_TYPE

#define DEFAULT_INDEX_TYPE   "btree"

Definition at line 21 of file index.h.

Referenced by transformIndexConstraint().

◆ INDEX_CONSTR_CREATE_DEFERRABLE

#define INDEX_CONSTR_CREATE_DEFERRABLE   (1 << 1)

◆ INDEX_CONSTR_CREATE_INIT_DEFERRED

#define INDEX_CONSTR_CREATE_INIT_DEFERRED   (1 << 2)

Definition at line 77 of file index.h.

Referenced by ATExecAddIndexConstraint(), DefineIndex(), and index_constraint_create().

◆ INDEX_CONSTR_CREATE_MARK_AS_PRIMARY

#define INDEX_CONSTR_CREATE_MARK_AS_PRIMARY   (1 << 0)

Definition at line 75 of file index.h.

Referenced by ATExecAddIndexConstraint(), and index_constraint_create().

◆ INDEX_CONSTR_CREATE_REMOVE_OLD_DEPS

#define INDEX_CONSTR_CREATE_REMOVE_OLD_DEPS   (1 << 4)

Definition at line 79 of file index.h.

Referenced by ATExecAddIndexConstraint(), and index_constraint_create().

◆ INDEX_CONSTR_CREATE_UPDATE_INDEX

#define INDEX_CONSTR_CREATE_UPDATE_INDEX   (1 << 3)

Definition at line 78 of file index.h.

Referenced by ATExecAddIndexConstraint(), and index_constraint_create().

◆ INDEX_CREATE_ADD_CONSTRAINT

#define INDEX_CREATE_ADD_CONSTRAINT   (1 << 1)

Definition at line 48 of file index.h.

Referenced by DefineIndex(), and index_create().

◆ INDEX_CREATE_CONCURRENT

#define INDEX_CREATE_CONCURRENT   (1 << 3)

Definition at line 50 of file index.h.

Referenced by DefineIndex(), index_concurrently_create_copy(), and index_create().

◆ INDEX_CREATE_IF_NOT_EXISTS

#define INDEX_CREATE_IF_NOT_EXISTS   (1 << 4)

Definition at line 51 of file index.h.

Referenced by DefineIndex(), and index_create().

◆ INDEX_CREATE_INVALID

#define INDEX_CREATE_INVALID   (1 << 6)

Definition at line 53 of file index.h.

Referenced by DefineIndex(), and index_create().

◆ INDEX_CREATE_IS_PRIMARY

#define INDEX_CREATE_IS_PRIMARY   (1 << 0)

Definition at line 47 of file index.h.

Referenced by create_toast_table(), DefineIndex(), and index_create().

◆ INDEX_CREATE_PARTITIONED

#define INDEX_CREATE_PARTITIONED   (1 << 5)

Definition at line 52 of file index.h.

Referenced by DefineIndex(), and index_create().

◆ INDEX_CREATE_SKIP_BUILD

#define INDEX_CREATE_SKIP_BUILD   (1 << 2)

Definition at line 49 of file index.h.

Referenced by DefineIndex(), index_concurrently_create_copy(), and index_create().

◆ REINDEX_REL_CHECK_CONSTRAINTS

#define REINDEX_REL_CHECK_CONSTRAINTS   0x04

Definition at line 138 of file index.h.

Referenced by finish_heap_swap(), reindex_relation(), ReindexMultipleTables(), and ReindexTable().

◆ REINDEX_REL_FORCE_INDEXES_PERMANENT

#define REINDEX_REL_FORCE_INDEXES_PERMANENT   0x10

Definition at line 140 of file index.h.

Referenced by finish_heap_swap(), and reindex_relation().

◆ REINDEX_REL_FORCE_INDEXES_UNLOGGED

#define REINDEX_REL_FORCE_INDEXES_UNLOGGED   0x08

Definition at line 139 of file index.h.

Referenced by finish_heap_swap(), and reindex_relation().

◆ REINDEX_REL_PROCESS_TOAST

#define REINDEX_REL_PROCESS_TOAST   0x01

◆ REINDEX_REL_SUPPRESS_INDEX_USE

#define REINDEX_REL_SUPPRESS_INDEX_USE   0x02

Definition at line 137 of file index.h.

Referenced by finish_heap_swap(), and reindex_relation().

Typedef Documentation

◆ ValidateIndexState

Enumeration Type Documentation

◆ IndexStateFlagsAction

Enumerator
INDEX_CREATE_SET_READY 
INDEX_CREATE_SET_VALID 
INDEX_DROP_CLEAR_VALID 
INDEX_DROP_SET_DEAD 

Definition at line 24 of file index.h.

Function Documentation

◆ BuildIndexInfo()

IndexInfo* BuildIndexInfo ( Relation  index)

Definition at line 2275 of file index.c.

References elog, ERROR, i, IndexInfo::ii_ExclusionOps, IndexInfo::ii_ExclusionProcs, IndexInfo::ii_ExclusionStrats, IndexInfo::ii_IndexAttrNumbers, INDEX_MAX_KEYS, makeIndexInfo(), RelationData::rd_index, RelationData::rd_rel, RelationGetExclusionInfo(), RelationGetIndexExpressions(), RelationGetIndexPredicate(), and RelationGetRelid.

Referenced by _bt_parallel_scan_and_sort(), ATExecAddIndexConstraint(), ATExecAttachPartitionIdx(), AttachPartitionEnsureIndexes(), brinsummarize(), bt_check_every_level(), DefineIndex(), do_analyze_rel(), ExecOpenIndices(), index_concurrently_build(), index_concurrently_create_copy(), reindex_index(), RelationTruncateIndexes(), tuplesort_begin_cluster(), unique_key_recheck(), and validate_index().

2276 {
2277  IndexInfo *ii;
2278  Form_pg_index indexStruct = index->rd_index;
2279  int i;
2280  int numAtts;
2281 
2282  /* check the number of keys, and copy attr numbers into the IndexInfo */
2283  numAtts = indexStruct->indnatts;
2284  if (numAtts < 1 || numAtts > INDEX_MAX_KEYS)
2285  elog(ERROR, "invalid indnatts %d for index %u",
2286  numAtts, RelationGetRelid(index));
2287 
2288  /*
2289  * Create the node, fetching any expressions needed for expressional
2290  * indexes and index predicate if any.
2291  */
2292  ii = makeIndexInfo(indexStruct->indnatts,
2293  indexStruct->indnkeyatts,
2294  index->rd_rel->relam,
2297  indexStruct->indisunique,
2298  indexStruct->indisready,
2299  false);
2300 
2301  /* fill in attribute numbers */
2302  for (i = 0; i < numAtts; i++)
2303  ii->ii_IndexAttrNumbers[i] = indexStruct->indkey.values[i];
2304 
2305  /* fetch exclusion constraint info if any */
2306  if (indexStruct->indisexclusion)
2307  {
2309  &ii->ii_ExclusionOps,
2310  &ii->ii_ExclusionProcs,
2311  &ii->ii_ExclusionStrats);
2312  }
2313 
2314  return ii;
2315 }
void RelationGetExclusionInfo(Relation indexRelation, Oid **operators, Oid **procs, uint16 **strategies)
Definition: relcache.c:4965
Oid * ii_ExclusionProcs
Definition: execnodes.h:165
Form_pg_class rd_rel
Definition: rel.h:83
List * RelationGetIndexPredicate(Relation relation)
Definition: relcache.c:4644
Form_pg_index rd_index
Definition: rel.h:143
#define ERROR
Definition: elog.h:43
List * RelationGetIndexExpressions(Relation relation)
Definition: relcache.c:4582
IndexInfo * makeIndexInfo(int numattrs, int numkeyattrs, Oid amoid, List *expressions, List *predicates, bool unique, bool isready, bool concurrent)
Definition: makefuncs.c:740
FormData_pg_index * Form_pg_index
Definition: pg_index.h:66
#define INDEX_MAX_KEYS
Oid * ii_ExclusionOps
Definition: execnodes.h:164
#define elog(elevel,...)
Definition: elog.h:226
int i
AttrNumber ii_IndexAttrNumbers[INDEX_MAX_KEYS]
Definition: execnodes.h:159
uint16 * ii_ExclusionStrats
Definition: execnodes.h:166
#define RelationGetRelid(relation)
Definition: rel.h:419

◆ BuildSpeculativeIndexInfo()

void BuildSpeculativeIndexInfo ( Relation  index,
IndexInfo ii 
)

Definition at line 2447 of file index.c.

References Assert, BTEqualStrategyNumber, elog, ERROR, get_opcode(), get_opfamily_member(), i, IndexInfo::ii_Unique, IndexInfo::ii_UniqueOps, IndexInfo::ii_UniqueProcs, IndexInfo::ii_UniqueStrats, IndexRelationGetNumberOfKeyAttributes, OidIsValid, palloc(), RelationData::rd_opcintype, RelationData::rd_opfamily, and RelationData::rd_rel.

Referenced by ExecOpenIndices().

2448 {
2449  int indnkeyatts;
2450  int i;
2451 
2452  indnkeyatts = IndexRelationGetNumberOfKeyAttributes(index);
2453 
2454  /*
2455  * fetch info for checking unique indexes
2456  */
2457  Assert(ii->ii_Unique);
2458 
2459  if (index->rd_rel->relam != BTREE_AM_OID)
2460  elog(ERROR, "unexpected non-btree speculative unique index");
2461 
2462  ii->ii_UniqueOps = (Oid *) palloc(sizeof(Oid) * indnkeyatts);
2463  ii->ii_UniqueProcs = (Oid *) palloc(sizeof(Oid) * indnkeyatts);
2464  ii->ii_UniqueStrats = (uint16 *) palloc(sizeof(uint16) * indnkeyatts);
2465 
2466  /*
2467  * We have to look up the operator's strategy number. This provides a
2468  * cross-check that the operator does match the index.
2469  */
2470  /* We need the func OIDs and strategy numbers too */
2471  for (i = 0; i < indnkeyatts; i++)
2472  {
2474  ii->ii_UniqueOps[i] =
2475  get_opfamily_member(index->rd_opfamily[i],
2476  index->rd_opcintype[i],
2477  index->rd_opcintype[i],
2478  ii->ii_UniqueStrats[i]);
2479  if (!OidIsValid(ii->ii_UniqueOps[i]))
2480  elog(ERROR, "missing operator %d(%u,%u) in opfamily %u",
2481  ii->ii_UniqueStrats[i], index->rd_opcintype[i],
2482  index->rd_opcintype[i], index->rd_opfamily[i]);
2483  ii->ii_UniqueProcs[i] = get_opcode(ii->ii_UniqueOps[i]);
2484  }
2485 }
uint16 * ii_UniqueStrats
Definition: execnodes.h:169
Form_pg_class rd_rel
Definition: rel.h:83
unsigned int Oid
Definition: postgres_ext.h:31
#define OidIsValid(objectId)
Definition: c.h:638
Oid * ii_UniqueOps
Definition: execnodes.h:167
unsigned short uint16
Definition: c.h:357
#define ERROR
Definition: elog.h:43
Oid * ii_UniqueProcs
Definition: execnodes.h:168
Oid get_opfamily_member(Oid opfamily, Oid lefttype, Oid righttype, int16 strategy)
Definition: lsyscache.c:163
Oid * rd_opfamily
Definition: rel.h:158
#define IndexRelationGetNumberOfKeyAttributes(relation)
Definition: rel.h:438
RegProcedure get_opcode(Oid opno)
Definition: lsyscache.c:1092
bool ii_Unique
Definition: execnodes.h:170
#define Assert(condition)
Definition: c.h:732
void * palloc(Size size)
Definition: mcxt.c:949
#define elog(elevel,...)
Definition: elog.h:226
int i
Oid * rd_opcintype
Definition: rel.h:159
#define BTEqualStrategyNumber
Definition: stratnum.h:31

◆ CompareIndexInfo()

bool CompareIndexInfo ( IndexInfo info1,
IndexInfo info2,
Oid collations1,
Oid collations2,
Oid opfamilies1,
Oid opfamilies2,
AttrNumber attmap,
int  maplen 
)

Definition at line 2328 of file index.c.

References elog, equal(), ERROR, i, IndexInfo::ii_Am, IndexInfo::ii_ExclusionOps, IndexInfo::ii_Expressions, IndexInfo::ii_IndexAttrNumbers, IndexInfo::ii_NumIndexAttrs, IndexInfo::ii_NumIndexKeyAttrs, IndexInfo::ii_Predicate, IndexInfo::ii_Unique, InvalidAttrNumber, InvalidOid, map_variable_attnos(), and NIL.

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

2332 {
2333  int i;
2334 
2335  if (info1->ii_Unique != info2->ii_Unique)
2336  return false;
2337 
2338  /* indexes are only equivalent if they have the same access method */
2339  if (info1->ii_Am != info2->ii_Am)
2340  return false;
2341 
2342  /* and same number of attributes */
2343  if (info1->ii_NumIndexAttrs != info2->ii_NumIndexAttrs)
2344  return false;
2345 
2346  /* and same number of key attributes */
2347  if (info1->ii_NumIndexKeyAttrs != info2->ii_NumIndexKeyAttrs)
2348  return false;
2349 
2350  /*
2351  * and columns match through the attribute map (actual attribute numbers
2352  * might differ!) Note that this implies that index columns that are
2353  * expressions appear in the same positions. We will next compare the
2354  * expressions themselves.
2355  */
2356  for (i = 0; i < info1->ii_NumIndexAttrs; i++)
2357  {
2358  if (maplen < info2->ii_IndexAttrNumbers[i])
2359  elog(ERROR, "incorrect attribute map");
2360 
2361  /* ignore expressions at this stage */
2362  if ((info1->ii_IndexAttrNumbers[i] != InvalidAttrNumber) &&
2363  (attmap[info2->ii_IndexAttrNumbers[i] - 1] !=
2364  info1->ii_IndexAttrNumbers[i]))
2365  return false;
2366 
2367  /* collation and opfamily is not valid for including columns */
2368  if (i >= info1->ii_NumIndexKeyAttrs)
2369  continue;
2370 
2371  if (collations1[i] != collations2[i])
2372  return false;
2373  if (opfamilies1[i] != opfamilies2[i])
2374  return false;
2375  }
2376 
2377  /*
2378  * For expression indexes: either both are expression indexes, or neither
2379  * is; if they are, make sure the expressions match.
2380  */
2381  if ((info1->ii_Expressions != NIL) != (info2->ii_Expressions != NIL))
2382  return false;
2383  if (info1->ii_Expressions != NIL)
2384  {
2385  bool found_whole_row;
2386  Node *mapped;
2387 
2388  mapped = map_variable_attnos((Node *) info2->ii_Expressions,
2389  1, 0, attmap, maplen,
2390  InvalidOid, &found_whole_row);
2391  if (found_whole_row)
2392  {
2393  /*
2394  * we could throw an error here, but seems out of scope for this
2395  * routine.
2396  */
2397  return false;
2398  }
2399 
2400  if (!equal(info1->ii_Expressions, mapped))
2401  return false;
2402  }
2403 
2404  /* Partial index predicates must be identical, if they exist */
2405  if ((info1->ii_Predicate == NULL) != (info2->ii_Predicate == NULL))
2406  return false;
2407  if (info1->ii_Predicate != NULL)
2408  {
2409  bool found_whole_row;
2410  Node *mapped;
2411 
2412  mapped = map_variable_attnos((Node *) info2->ii_Predicate,
2413  1, 0, attmap, maplen,
2414  InvalidOid, &found_whole_row);
2415  if (found_whole_row)
2416  {
2417  /*
2418  * we could throw an error here, but seems out of scope for this
2419  * routine.
2420  */
2421  return false;
2422  }
2423  if (!equal(info1->ii_Predicate, mapped))
2424  return false;
2425  }
2426 
2427  /* No support currently for comparing exclusion indexes. */
2428  if (info1->ii_ExclusionOps != NULL || info2->ii_ExclusionOps != NULL)
2429  return false;
2430 
2431  return true;
2432 }
#define NIL
Definition: pg_list.h:65
List * ii_Predicate
Definition: execnodes.h:162
bool equal(const void *a, const void *b)
Definition: equalfuncs.c:3008
Definition: nodes.h:525
#define ERROR
Definition: elog.h:43
int ii_NumIndexKeyAttrs
Definition: execnodes.h:158
Node * map_variable_attnos(Node *node, int target_varno, int sublevels_up, const AttrNumber *attno_map, int map_length, Oid to_rowtype, bool *found_whole_row)
int ii_NumIndexAttrs
Definition: execnodes.h:157
#define InvalidOid
Definition: postgres_ext.h:36
bool ii_Unique
Definition: execnodes.h:170
List * ii_Expressions
Definition: execnodes.h:160
#define InvalidAttrNumber
Definition: attnum.h:23
Oid * ii_ExclusionOps
Definition: execnodes.h:164
#define elog(elevel,...)
Definition: elog.h:226
int i
AttrNumber ii_IndexAttrNumbers[INDEX_MAX_KEYS]
Definition: execnodes.h:159
Oid ii_Am
Definition: execnodes.h:175

◆ EstimateReindexStateSpace()

Size EstimateReindexStateSpace ( void  )

Definition at line 3820 of file index.c.

References list_length(), mul_size(), and offsetof.

Referenced by InitializeParallelDSM().

3821 {
3824 }
static List * pendingReindexedIndexes
Definition: index.c:3708
unsigned int Oid
Definition: postgres_ext.h:31
Size mul_size(Size s1, Size s2)
Definition: shmem.c:492
static int list_length(const List *l)
Definition: pg_list.h:169
#define offsetof(type, field)
Definition: c.h:655

◆ FormIndexDatum()

void FormIndexDatum ( IndexInfo indexInfo,
TupleTableSlot slot,
EState estate,
Datum values,
bool isnull 
)

Definition at line 2507 of file index.c.

References Assert, elog, ERROR, ExecEvalExprSwitchContext(), ExecPrepareExprList(), GetPerTupleExprContext, i, IndexInfo::ii_Expressions, IndexInfo::ii_ExpressionsState, IndexInfo::ii_IndexAttrNumbers, IndexInfo::ii_NumIndexAttrs, lfirst, list_head(), lnext(), NIL, slot_getattr(), and slot_getsysattr().

Referenced by CatalogIndexInsert(), check_exclusion_or_unique_constraint(), comparetup_cluster(), compute_index_stats(), ExecCheckIndexConstraints(), ExecInsertIndexTuples(), heapam_index_build_range_scan(), heapam_index_validate_scan(), IndexCheckExclusion(), and unique_key_recheck().

2512 {
2513  ListCell *indexpr_item;
2514  int i;
2515 
2516  if (indexInfo->ii_Expressions != NIL &&
2517  indexInfo->ii_ExpressionsState == NIL)
2518  {
2519  /* First time through, set up expression evaluation state */
2520  indexInfo->ii_ExpressionsState =
2521  ExecPrepareExprList(indexInfo->ii_Expressions, estate);
2522  /* Check caller has set up context correctly */
2523  Assert(GetPerTupleExprContext(estate)->ecxt_scantuple == slot);
2524  }
2525  indexpr_item = list_head(indexInfo->ii_ExpressionsState);
2526 
2527  for (i = 0; i < indexInfo->ii_NumIndexAttrs; i++)
2528  {
2529  int keycol = indexInfo->ii_IndexAttrNumbers[i];
2530  Datum iDatum;
2531  bool isNull;
2532 
2533  if (keycol < 0)
2534  iDatum = slot_getsysattr(slot, keycol, &isNull);
2535  else if (keycol != 0)
2536  {
2537  /*
2538  * Plain index column; get the value we need directly from the
2539  * heap tuple.
2540  */
2541  iDatum = slot_getattr(slot, keycol, &isNull);
2542  }
2543  else
2544  {
2545  /*
2546  * Index expression --- need to evaluate it.
2547  */
2548  if (indexpr_item == NULL)
2549  elog(ERROR, "wrong number of index expressions");
2550  iDatum = ExecEvalExprSwitchContext((ExprState *) lfirst(indexpr_item),
2551  GetPerTupleExprContext(estate),
2552  &isNull);
2553  indexpr_item = lnext(indexInfo->ii_ExpressionsState, indexpr_item);
2554  }
2555  values[i] = iDatum;
2556  isnull[i] = isNull;
2557  }
2558 
2559  if (indexpr_item != NULL)
2560  elog(ERROR, "wrong number of index expressions");
2561 }
#define NIL
Definition: pg_list.h:65
static Datum ExecEvalExprSwitchContext(ExprState *state, ExprContext *econtext, bool *isNull)
Definition: executor.h:300
static ListCell * lnext(const List *l, const ListCell *c)
Definition: pg_list.h:321
#define GetPerTupleExprContext(estate)
Definition: executor.h:501
List * ii_ExpressionsState
Definition: execnodes.h:161
#define ERROR
Definition: elog.h:43
static ListCell * list_head(const List *l)
Definition: pg_list.h:125
List * ExecPrepareExprList(List *nodes, EState *estate)
Definition: execExpr.c:564
uintptr_t Datum
Definition: postgres.h:367
int ii_NumIndexAttrs
Definition: execnodes.h:157
static Datum slot_getattr(TupleTableSlot *slot, int attnum, bool *isnull)
Definition: tuptable.h:382
List * ii_Expressions
Definition: execnodes.h:160
#define Assert(condition)
Definition: c.h:732
#define lfirst(lc)
Definition: pg_list.h:190
static Datum values[MAXATTR]
Definition: bootstrap.c:167
#define elog(elevel,...)
Definition: elog.h:226
int i
static Datum slot_getsysattr(TupleTableSlot *slot, int attnum, bool *isnull)
Definition: tuptable.h:403
AttrNumber ii_IndexAttrNumbers[INDEX_MAX_KEYS]
Definition: execnodes.h:159

◆ index_build()

void index_build ( Relation  heapRelation,
Relation  indexRelation,
IndexInfo indexInfo,
bool  isreindex,
bool  parallel 
)

Definition at line 2734 of file index.c.

References IndexAmRoutine::ambuild, IndexAmRoutine::ambuildempty, Assert, AtEOXact_GUC(), CatalogTupleUpdate(), CommandCounterIncrement(), DEBUG1, EarlyPruningEnabled, elog, ereport, errmsg(), errmsg_plural(), ERROR, GETSTRUCT, GetUserIdAndSecContext(), heap_freetuple(), IndexBuildResult::heap_tuples, HeapTupleIsValid, IndexInfo::ii_BrokenHotChain, IndexInfo::ii_Concurrent, IndexInfo::ii_ExclusionOps, IndexInfo::ii_ParallelWorkers, IndexBuildResult::index_tuples, index_update_stats(), IndexCheckExclusion(), INDEXRELID, INIT_FORKNUM, IsNormalProcessingMode, NewGUCNestLevel(), ObjectIdGetDatum, pgstat_progress_update_multi_param(), plan_create_index_workers(), PointerIsValid, PROGRESS_CREATEIDX_PHASE, PROGRESS_CREATEIDX_PHASE_BUILD, PROGRESS_CREATEIDX_SUBPHASE, PROGRESS_CREATEIDX_SUBPHASE_INITIALIZE, PROGRESS_CREATEIDX_TUPLES_DONE, PROGRESS_CREATEIDX_TUPLES_TOTAL, PROGRESS_SCAN_BLOCKS_DONE, PROGRESS_SCAN_BLOCKS_TOTAL, RelationData::rd_indam, RelationData::rd_rel, RelationData::rd_smgr, RelationGetRelationName, RelationGetRelid, RelationIsValid, RelationOpenSmgr, RowExclusiveLock, SearchSysCacheCopy1, SECURITY_RESTRICTED_OPERATION, SetUserIdAndSecContext(), smgrcreate(), smgrexists(), HeapTupleData::t_self, table_close(), table_open(), and val.

Referenced by build_indices(), index_concurrently_build(), index_create(), reindex_index(), and RelationTruncateIndexes().

2739 {
2740  IndexBuildResult *stats;
2741  Oid save_userid;
2742  int save_sec_context;
2743  int save_nestlevel;
2744 
2745  /*
2746  * sanity checks
2747  */
2748  Assert(RelationIsValid(indexRelation));
2749  Assert(PointerIsValid(indexRelation->rd_indam));
2750  Assert(PointerIsValid(indexRelation->rd_indam->ambuild));
2751  Assert(PointerIsValid(indexRelation->rd_indam->ambuildempty));
2752 
2753  /*
2754  * Determine worker process details for parallel CREATE INDEX. Currently,
2755  * only btree has support for parallel builds.
2756  *
2757  * Note that planner considers parallel safety for us.
2758  */
2759  if (parallel && IsNormalProcessingMode() &&
2760  indexRelation->rd_rel->relam == BTREE_AM_OID)
2761  indexInfo->ii_ParallelWorkers =
2763  RelationGetRelid(indexRelation));
2764 
2765  if (indexInfo->ii_ParallelWorkers == 0)
2766  ereport(DEBUG1,
2767  (errmsg("building index \"%s\" on table \"%s\" serially",
2768  RelationGetRelationName(indexRelation),
2769  RelationGetRelationName(heapRelation))));
2770  else
2771  ereport(DEBUG1,
2772  (errmsg_plural("building index \"%s\" on table \"%s\" with request for %d parallel worker",
2773  "building index \"%s\" on table \"%s\" with request for %d parallel workers",
2774  indexInfo->ii_ParallelWorkers,
2775  RelationGetRelationName(indexRelation),
2776  RelationGetRelationName(heapRelation),
2777  indexInfo->ii_ParallelWorkers)));
2778 
2779  /*
2780  * Switch to the table owner's userid, so that any index functions are run
2781  * as that user. Also lock down security-restricted operations and
2782  * arrange to make GUC variable changes local to this command.
2783  */
2784  GetUserIdAndSecContext(&save_userid, &save_sec_context);
2785  SetUserIdAndSecContext(heapRelation->rd_rel->relowner,
2786  save_sec_context | SECURITY_RESTRICTED_OPERATION);
2787  save_nestlevel = NewGUCNestLevel();
2788 
2789  /* Set up initial progress report status */
2790  {
2791  const int index[] = {
2798  };
2799  const int64 val[] = {
2802  0, 0, 0, 0
2803  };
2804 
2805  pgstat_progress_update_multi_param(6, index, val);
2806  }
2807 
2808  /*
2809  * Call the access method's build procedure
2810  */
2811  stats = indexRelation->rd_indam->ambuild(heapRelation, indexRelation,
2812  indexInfo);
2813  Assert(PointerIsValid(stats));
2814 
2815  /*
2816  * If this is an unlogged index, we may need to write out an init fork for
2817  * it -- but we must first check whether one already exists. If, for
2818  * example, an unlogged relation is truncated in the transaction that
2819  * created it, or truncated twice in a subsequent transaction, the
2820  * relfilenode won't change, and nothing needs to be done here.
2821  */
2822  if (indexRelation->rd_rel->relpersistence == RELPERSISTENCE_UNLOGGED &&
2823  !smgrexists(indexRelation->rd_smgr, INIT_FORKNUM))
2824  {
2825  RelationOpenSmgr(indexRelation);
2826  smgrcreate(indexRelation->rd_smgr, INIT_FORKNUM, false);
2827  indexRelation->rd_indam->ambuildempty(indexRelation);
2828  }
2829 
2830  /*
2831  * If we found any potentially broken HOT chains, mark the index as not
2832  * being usable until the current transaction is below the event horizon.
2833  * See src/backend/access/heap/README.HOT for discussion. Also set this
2834  * if early pruning/vacuuming is enabled for the heap relation. While it
2835  * might become safe to use the index earlier based on actual cleanup
2836  * activity and other active transactions, the test for that would be much
2837  * more complex and would require some form of blocking, so keep it simple
2838  * and fast by just using the current transaction.
2839  *
2840  * However, when reindexing an existing index, we should do nothing here.
2841  * Any HOT chains that are broken with respect to the index must predate
2842  * the index's original creation, so there is no need to change the
2843  * index's usability horizon. Moreover, we *must not* try to change the
2844  * index's pg_index entry while reindexing pg_index itself, and this
2845  * optimization nicely prevents that. The more complex rules needed for a
2846  * reindex are handled separately after this function returns.
2847  *
2848  * We also need not set indcheckxmin during a concurrent index build,
2849  * because we won't set indisvalid true until all transactions that care
2850  * about the broken HOT chains or early pruning/vacuuming are gone.
2851  *
2852  * Therefore, this code path can only be taken during non-concurrent
2853  * CREATE INDEX. Thus the fact that heap_update will set the pg_index
2854  * tuple's xmin doesn't matter, because that tuple was created in the
2855  * current transaction anyway. That also means we don't need to worry
2856  * about any concurrent readers of the tuple; no other transaction can see
2857  * it yet.
2858  */
2859  if ((indexInfo->ii_BrokenHotChain || EarlyPruningEnabled(heapRelation)) &&
2860  !isreindex &&
2861  !indexInfo->ii_Concurrent)
2862  {
2863  Oid indexId = RelationGetRelid(indexRelation);
2864  Relation pg_index;
2865  HeapTuple indexTuple;
2866  Form_pg_index indexForm;
2867 
2868  pg_index = table_open(IndexRelationId, RowExclusiveLock);
2869 
2870  indexTuple = SearchSysCacheCopy1(INDEXRELID,
2871  ObjectIdGetDatum(indexId));
2872  if (!HeapTupleIsValid(indexTuple))
2873  elog(ERROR, "cache lookup failed for index %u", indexId);
2874  indexForm = (Form_pg_index) GETSTRUCT(indexTuple);
2875 
2876  /* If it's a new index, indcheckxmin shouldn't be set ... */
2877  Assert(!indexForm->indcheckxmin);
2878 
2879  indexForm->indcheckxmin = true;
2880  CatalogTupleUpdate(pg_index, &indexTuple->t_self, indexTuple);
2881 
2882  heap_freetuple(indexTuple);
2883  table_close(pg_index, RowExclusiveLock);
2884  }
2885 
2886  /*
2887  * Update heap and index pg_class rows
2888  */
2889  index_update_stats(heapRelation,
2890  true,
2891  stats->heap_tuples);
2892 
2893  index_update_stats(indexRelation,
2894  false,
2895  stats->index_tuples);
2896 
2897  /* Make the updated catalog row versions visible */
2899 
2900  /*
2901  * If it's for an exclusion constraint, make a second pass over the heap
2902  * to verify that the constraint is satisfied. We must not do this until
2903  * the index is fully valid. (Broken HOT chains shouldn't matter, though;
2904  * see comments for IndexCheckExclusion.)
2905  */
2906  if (indexInfo->ii_ExclusionOps != NULL)
2907  IndexCheckExclusion(heapRelation, indexRelation, indexInfo);
2908 
2909  /* Roll back any GUC changes executed by index functions */
2910  AtEOXact_GUC(false, save_nestlevel);
2911 
2912  /* Restore userid and security context */
2913  SetUserIdAndSecContext(save_userid, save_sec_context);
2914 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:157
static void index_update_stats(Relation rel, bool hasindex, double reltuples)
Definition: index.c:2586
#define DEBUG1
Definition: elog.h:25
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:133
void smgrcreate(SMgrRelation reln, ForkNumber forknum, bool isRedo)
Definition: smgr.c:333
#define GETSTRUCT(TUP)
Definition: htup_details.h:655
#define SECURITY_RESTRICTED_OPERATION
Definition: miscadmin.h:300
void SetUserIdAndSecContext(Oid userid, int sec_context)
Definition: miscinit.c:492
int errmsg_plural(const char *fmt_singular, const char *fmt_plural, unsigned long n,...)
Definition: elog.c:837
struct SMgrRelationData * rd_smgr
Definition: rel.h:56
#define PROGRESS_CREATEIDX_TUPLES_TOTAL
Definition: progress.h:67
bool smgrexists(SMgrRelation reln, ForkNumber forknum)
Definition: smgr.c:247
Form_pg_class rd_rel
Definition: rel.h:83
void heap_freetuple(HeapTuple htup)
Definition: heaptuple.c:1338
unsigned int Oid
Definition: postgres_ext.h:31
Definition: type.h:89
#define RelationOpenSmgr(relation)
Definition: rel.h:476
#define EarlyPruningEnabled(rel)
Definition: snapmgr.h:45
#define ObjectIdGetDatum(X)
Definition: postgres.h:507
#define ERROR
Definition: elog.h:43
ambuild_function ambuild
Definition: amapi.h:210
#define RelationIsValid(relation)
Definition: rel.h:392
ItemPointerData t_self
Definition: htup.h:65
#define IsNormalProcessingMode()
Definition: miscadmin.h:376
void GetUserIdAndSecContext(Oid *userid, int *sec_context)
Definition: miscinit.c:485
#define RowExclusiveLock
Definition: lockdefs.h:38
void AtEOXact_GUC(bool isCommit, int nestLevel)
Definition: guc.c:5729
#define RelationGetRelationName(relation)
Definition: rel.h:453
bool ii_BrokenHotChain
Definition: execnodes.h:173
static void IndexCheckExclusion(Relation heapRelation, Relation indexRelation, IndexInfo *indexInfo)
Definition: index.c:2929
#define ereport(elevel, rest)
Definition: elog.h:141
#define PROGRESS_CREATEIDX_SUBPHASE_INITIALIZE
Definition: progress.h:87
FormData_pg_index * Form_pg_index
Definition: pg_index.h:66
#define PROGRESS_CREATEIDX_PHASE
Definition: progress.h:65
#define PROGRESS_SCAN_BLOCKS_DONE
Definition: progress.h:103
void CommandCounterIncrement(void)
Definition: xact.c:1003
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
#define Assert(condition)
Definition: c.h:732
#define PROGRESS_CREATEIDX_PHASE_BUILD
Definition: progress.h:75
void pgstat_progress_update_multi_param(int nparam, const int *index, const int64 *val)
Definition: pgstat.c:3242
int ii_ParallelWorkers
Definition: execnodes.h:174
void CatalogTupleUpdate(Relation heapRel, ItemPointer otid, HeapTuple tup)
Definition: indexing.c:224
int plan_create_index_workers(Oid tableOid, Oid indexOid)
Definition: planner.c:6244
#define PROGRESS_SCAN_BLOCKS_TOTAL
Definition: progress.h:102
bool ii_Concurrent
Definition: execnodes.h:172
#define SearchSysCacheCopy1(cacheId, key1)
Definition: syscache.h:174
int NewGUCNestLevel(void)
Definition: guc.c:5715
Oid * ii_ExclusionOps
Definition: execnodes.h:164
int errmsg(const char *fmt,...)
Definition: elog.c:784
#define PROGRESS_CREATEIDX_TUPLES_DONE
Definition: progress.h:68
#define elog(elevel,...)
Definition: elog.h:226
ambuildempty_function ambuildempty
Definition: amapi.h:211
#define PROGRESS_CREATEIDX_SUBPHASE
Definition: progress.h:66
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39
#define PointerIsValid(pointer)
Definition: c.h:626
#define RelationGetRelid(relation)
Definition: rel.h:419
long val
Definition: informix.c:684
double index_tuples
Definition: genam.h:33
double heap_tuples
Definition: genam.h:32

◆ index_check_primary_key()

void index_check_primary_key ( Relation  heapRel,
IndexInfo indexInfo,
bool  is_alter_table,
IndexStmt stmt 
)

Definition at line 201 of file index.c.

References ATTNUM, attnum, elog, ereport, errcode(), errmsg(), ERROR, GETSTRUCT, HeapTupleIsValid, i, IndexInfo::ii_IndexAttrNumbers, IndexInfo::ii_NumIndexKeyAttrs, Int16GetDatum, NameStr, ObjectIdGetDatum, RelationData::rd_rel, RelationGetRelationName, RelationGetRelid, relationHasPrimaryKey(), ReleaseSysCache(), and SearchSysCache2().

Referenced by ATExecAddIndexConstraint(), and DefineIndex().

205 {
206  int i;
207 
208  /*
209  * If ALTER TABLE or CREATE TABLE .. PARTITION OF, check that there isn't
210  * already a PRIMARY KEY. In CREATE TABLE for an ordinary relation, we
211  * have faith that the parser rejected multiple pkey clauses; and CREATE
212  * INDEX doesn't have a way to say PRIMARY KEY, so it's no problem either.
213  */
214  if ((is_alter_table || heapRel->rd_rel->relispartition) &&
215  relationHasPrimaryKey(heapRel))
216  {
217  ereport(ERROR,
218  (errcode(ERRCODE_INVALID_TABLE_DEFINITION),
219  errmsg("multiple primary keys for table \"%s\" are not allowed",
220  RelationGetRelationName(heapRel))));
221  }
222 
223  /*
224  * Check that all of the attributes in a primary key are marked as not
225  * null. (We don't really expect to see that; it'd mean the parser messed
226  * up. But it seems wise to check anyway.)
227  */
228  for (i = 0; i < indexInfo->ii_NumIndexKeyAttrs; i++)
229  {
230  AttrNumber attnum = indexInfo->ii_IndexAttrNumbers[i];
231  HeapTuple atttuple;
232  Form_pg_attribute attform;
233 
234  if (attnum == 0)
235  ereport(ERROR,
236  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
237  errmsg("primary keys cannot be expressions")));
238 
239  /* System attributes are never null, so no need to check */
240  if (attnum < 0)
241  continue;
242 
243  atttuple = SearchSysCache2(ATTNUM,
245  Int16GetDatum(attnum));
246  if (!HeapTupleIsValid(atttuple))
247  elog(ERROR, "cache lookup failed for attribute %d of relation %u",
248  attnum, RelationGetRelid(heapRel));
249  attform = (Form_pg_attribute) GETSTRUCT(atttuple);
250 
251  if (!attform->attnotnull)
252  ereport(ERROR,
253  (errcode(ERRCODE_INVALID_TABLE_DEFINITION),
254  errmsg("primary key column \"%s\" is not marked NOT NULL",
255  NameStr(attform->attname))));
256 
257  ReleaseSysCache(atttuple);
258  }
259 }
#define GETSTRUCT(TUP)
Definition: htup_details.h:655
#define Int16GetDatum(X)
Definition: postgres.h:451
int errcode(int sqlerrcode)
Definition: elog.c:570
Form_pg_class rd_rel
Definition: rel.h:83
#define ObjectIdGetDatum(X)
Definition: postgres.h:507
#define ERROR
Definition: elog.h:43
int ii_NumIndexKeyAttrs
Definition: execnodes.h:158
#define RelationGetRelationName(relation)
Definition: rel.h:453
FormData_pg_attribute * Form_pg_attribute
Definition: pg_attribute.h:200
#define ereport(elevel, rest)
Definition: elog.h:141
void ReleaseSysCache(HeapTuple tuple)
Definition: syscache.c:1172
static bool relationHasPrimaryKey(Relation rel)
Definition: index.c:147
int16 attnum
Definition: pg_attribute.h:79
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
HeapTuple SearchSysCache2(int cacheId, Datum key1, Datum key2)
Definition: syscache.c:1135
int errmsg(const char *fmt,...)
Definition: elog.c:784
#define elog(elevel,...)
Definition: elog.h:226
int i
#define NameStr(name)
Definition: c.h:609
AttrNumber ii_IndexAttrNumbers[INDEX_MAX_KEYS]
Definition: execnodes.h:159
int16 AttrNumber
Definition: attnum.h:21
#define RelationGetRelid(relation)
Definition: rel.h:419

◆ index_concurrently_build()

void index_concurrently_build ( Oid  heapRelationId,
Oid  indexRelationId 
)

Definition at line 1401 of file index.c.

References ActiveSnapshotSet(), Assert, BuildIndexInfo(), IndexInfo::ii_BrokenHotChain, IndexInfo::ii_Concurrent, IndexInfo::ii_ReadyForInserts, index_build(), index_close(), INDEX_CREATE_SET_READY, index_open(), index_set_state_flags(), NoLock, RowExclusiveLock, ShareUpdateExclusiveLock, table_close(), and table_open().

Referenced by DefineIndex(), and ReindexRelationConcurrently().

1403 {
1404  Relation heapRel;
1405  Relation indexRelation;
1406  IndexInfo *indexInfo;
1407 
1408  /* This had better make sure that a snapshot is active */
1410 
1411  /* Open and lock the parent heap relation */
1412  heapRel = table_open(heapRelationId, ShareUpdateExclusiveLock);
1413 
1414  /* And the target index relation */
1415  indexRelation = index_open(indexRelationId, RowExclusiveLock);
1416 
1417  /*
1418  * We have to re-build the IndexInfo struct, since it was lost in the
1419  * commit of the transaction where this concurrent index was created at
1420  * the catalog level.
1421  */
1422  indexInfo = BuildIndexInfo(indexRelation);
1423  Assert(!indexInfo->ii_ReadyForInserts);
1424  indexInfo->ii_Concurrent = true;
1425  indexInfo->ii_BrokenHotChain = false;
1426 
1427  /* Now build the index */
1428  index_build(heapRel, indexRelation, indexInfo, false, true);
1429 
1430  /* Close both the relations, but keep the locks */
1431  table_close(heapRel, NoLock);
1432  index_close(indexRelation, NoLock);
1433 
1434  /*
1435  * Update the pg_index row to mark the index as ready for inserts. Once we
1436  * commit this transaction, any new transactions that open the table must
1437  * insert new entries into the index for insertions and non-HOT updates.
1438  */
1440 }
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:133
void index_set_state_flags(Oid indexId, IndexStateFlagsAction action)
Definition: index.c:3241
IndexInfo * BuildIndexInfo(Relation index)
Definition: index.c:2275
#define NoLock
Definition: lockdefs.h:34
#define RowExclusiveLock
Definition: lockdefs.h:38
bool ii_BrokenHotChain
Definition: execnodes.h:173
bool ActiveSnapshotSet(void)
Definition: snapmgr.c:853
bool ii_ReadyForInserts
Definition: execnodes.h:171
#define ShareUpdateExclusiveLock
Definition: lockdefs.h:39
void index_build(Relation heapRelation, Relation indexRelation, IndexInfo *indexInfo, bool isreindex, bool parallel)
Definition: index.c:2734
#define Assert(condition)
Definition: c.h:732
bool ii_Concurrent
Definition: execnodes.h:172
void index_close(Relation relation, LOCKMODE lockmode)
Definition: indexam.c:152
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39
Relation index_open(Oid relationId, LOCKMODE lockmode)
Definition: indexam.c:126

◆ index_concurrently_create_copy()

Oid index_concurrently_create_copy ( Relation  heapRelation,
Oid  oldIndexId,
const char *  newName 
)

Definition at line 1242 of file index.c.

References Assert, BuildIndexInfo(), DatumGetPointer, elog, ereport, errcode(), errmsg(), ERROR, HeapTupleIsValid, i, IndexInfo::ii_Am, IndexInfo::ii_ExclusionOps, IndexInfo::ii_Expressions, IndexInfo::ii_IndexAttrNumbers, IndexInfo::ii_NumIndexAttrs, IndexInfo::ii_NumIndexKeyAttrs, IndexInfo::ii_Predicate, IndexInfo::ii_Unique, index_close(), index_create(), INDEX_CREATE_CONCURRENT, INDEX_CREATE_SKIP_BUILD, index_open(), INDEXRELID, InvalidOid, lappend(), make_ands_implicit(), makeIndexInfo(), NameStr, NIL, NoLock, ObjectIdGetDatum, pfree(), RelationData::rd_indcollation, RelationData::rd_rel, RelationGetDescr, ReleaseSysCache(), RELOID, RowExclusiveLock, SearchSysCache1(), stringToNode(), SysCacheGetAttr(), TextDatumGetCString, TupleDescAttr, int2vector::values, and oidvector::values.

Referenced by ReindexRelationConcurrently().

1243 {
1244  Relation indexRelation;
1245  IndexInfo *oldInfo,
1246  *newInfo;
1247  Oid newIndexId = InvalidOid;
1248  HeapTuple indexTuple,
1249  classTuple;
1250  Datum indclassDatum,
1251  colOptionDatum,
1252  optionDatum;
1253  oidvector *indclass;
1254  int2vector *indcoloptions;
1255  bool isnull;
1256  List *indexColNames = NIL;
1257  List *indexExprs = NIL;
1258  List *indexPreds = NIL;
1259 
1260  indexRelation = index_open(oldIndexId, RowExclusiveLock);
1261 
1262  /* The new index needs some information from the old index */
1263  oldInfo = BuildIndexInfo(indexRelation);
1264 
1265  /*
1266  * Concurrent build of an index with exclusion constraints is not
1267  * supported.
1268  */
1269  if (oldInfo->ii_ExclusionOps != NULL)
1270  ereport(ERROR,
1271  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1272  errmsg("concurrent index creation for exclusion constraints is not supported")));
1273 
1274  /* Get the array of class and column options IDs from index info */
1275  indexTuple = SearchSysCache1(INDEXRELID, ObjectIdGetDatum(oldIndexId));
1276  if (!HeapTupleIsValid(indexTuple))
1277  elog(ERROR, "cache lookup failed for index %u", oldIndexId);
1278  indclassDatum = SysCacheGetAttr(INDEXRELID, indexTuple,
1279  Anum_pg_index_indclass, &isnull);
1280  Assert(!isnull);
1281  indclass = (oidvector *) DatumGetPointer(indclassDatum);
1282 
1283  colOptionDatum = SysCacheGetAttr(INDEXRELID, indexTuple,
1284  Anum_pg_index_indoption, &isnull);
1285  Assert(!isnull);
1286  indcoloptions = (int2vector *) DatumGetPointer(colOptionDatum);
1287 
1288  /* Fetch options of index if any */
1289  classTuple = SearchSysCache1(RELOID, oldIndexId);
1290  if (!HeapTupleIsValid(classTuple))
1291  elog(ERROR, "cache lookup failed for relation %u", oldIndexId);
1292  optionDatum = SysCacheGetAttr(RELOID, classTuple,
1293  Anum_pg_class_reloptions, &isnull);
1294 
1295  /*
1296  * Fetch the list of expressions and predicates directly from the
1297  * catalogs. This cannot rely on the information from IndexInfo of the
1298  * old index as these have been flattened for the planner.
1299  */
1300  if (oldInfo->ii_Expressions != NIL)
1301  {
1302  Datum exprDatum;
1303  char *exprString;
1304 
1305  exprDatum = SysCacheGetAttr(INDEXRELID, indexTuple,
1306  Anum_pg_index_indexprs, &isnull);
1307  Assert(!isnull);
1308  exprString = TextDatumGetCString(exprDatum);
1309  indexExprs = (List *) stringToNode(exprString);
1310  pfree(exprString);
1311  }
1312  if (oldInfo->ii_Predicate != NIL)
1313  {
1314  Datum predDatum;
1315  char *predString;
1316 
1317  predDatum = SysCacheGetAttr(INDEXRELID, indexTuple,
1318  Anum_pg_index_indpred, &isnull);
1319  Assert(!isnull);
1320  predString = TextDatumGetCString(predDatum);
1321  indexPreds = (List *) stringToNode(predString);
1322 
1323  /* Also convert to implicit-AND format */
1324  indexPreds = make_ands_implicit((Expr *) indexPreds);
1325  pfree(predString);
1326  }
1327 
1328  /*
1329  * Build the index information for the new index. Note that rebuild of
1330  * indexes with exclusion constraints is not supported, hence there is no
1331  * need to fill all the ii_Exclusion* fields.
1332  */
1333  newInfo = makeIndexInfo(oldInfo->ii_NumIndexAttrs,
1334  oldInfo->ii_NumIndexKeyAttrs,
1335  oldInfo->ii_Am,
1336  indexExprs,
1337  indexPreds,
1338  oldInfo->ii_Unique,
1339  false, /* not ready for inserts */
1340  true);
1341 
1342  /*
1343  * Extract the list of column names and the column numbers for the new
1344  * index information. All this information will be used for the index
1345  * creation.
1346  */
1347  for (int i = 0; i < oldInfo->ii_NumIndexAttrs; i++)
1348  {
1349  TupleDesc indexTupDesc = RelationGetDescr(indexRelation);
1350  Form_pg_attribute att = TupleDescAttr(indexTupDesc, i);
1351 
1352  indexColNames = lappend(indexColNames, NameStr(att->attname));
1353  newInfo->ii_IndexAttrNumbers[i] = oldInfo->ii_IndexAttrNumbers[i];
1354  }
1355 
1356  /*
1357  * Now create the new index.
1358  *
1359  * For a partition index, we adjust the partition dependency later, to
1360  * ensure a consistent state at all times. That is why parentIndexRelid
1361  * is not set here.
1362  */
1363  newIndexId = index_create(heapRelation,
1364  newName,
1365  InvalidOid, /* indexRelationId */
1366  InvalidOid, /* parentIndexRelid */
1367  InvalidOid, /* parentConstraintId */
1368  InvalidOid, /* relFileNode */
1369  newInfo,
1370  indexColNames,
1371  indexRelation->rd_rel->relam,
1372  indexRelation->rd_rel->reltablespace,
1373  indexRelation->rd_indcollation,
1374  indclass->values,
1375  indcoloptions->values,
1376  optionDatum,
1378  0,
1379  true, /* allow table to be a system catalog? */
1380  false, /* is_internal? */
1381  NULL);
1382 
1383  /* Close the relations used and clean up */
1384  index_close(indexRelation, NoLock);
1385  ReleaseSysCache(indexTuple);
1386  ReleaseSysCache(classTuple);
1387 
1388  return newIndexId;
1389 }
#define NIL
Definition: pg_list.h:65
Definition: c.h:588
List * ii_Predicate
Definition: execnodes.h:162
#define RelationGetDescr(relation)
Definition: rel.h:445
#define TupleDescAttr(tupdesc, i)
Definition: tupdesc.h:92
int errcode(int sqlerrcode)
Definition: elog.c:570
void * stringToNode(const char *str)
Definition: read.c:89
IndexInfo * BuildIndexInfo(Relation index)
Definition: index.c:2275
Form_pg_class rd_rel
Definition: rel.h:83
unsigned int Oid
Definition: postgres_ext.h:31
Oid index_create(Relation heapRelation, const char *indexRelationName, Oid indexRelationId, Oid parentIndexRelid, Oid parentConstraintId, Oid relFileNode, IndexInfo *indexInfo, List *indexColNames, Oid accessMethodObjectId, Oid tableSpaceId, Oid *collationObjectId, Oid *classObjectId, int16 *coloptions, Datum reloptions, bits16 flags, bits16 constr_flags, bool allow_system_table_mods, bool is_internal, Oid *constraintId)
Definition: index.c:692
void pfree(void *pointer)
Definition: mcxt.c:1056
Oid * rd_indcollation
Definition: rel.h:168
#define ObjectIdGetDatum(X)
Definition: postgres.h:507
#define ERROR
Definition: elog.h:43
int ii_NumIndexKeyAttrs
Definition: execnodes.h:158
#define NoLock
Definition: lockdefs.h:34
Oid values[FLEXIBLE_ARRAY_MEMBER]
Definition: c.h:596
#define RowExclusiveLock
Definition: lockdefs.h:38
FormData_pg_attribute * Form_pg_attribute
Definition: pg_attribute.h:200
IndexInfo * makeIndexInfo(int numattrs, int numkeyattrs, Oid amoid, List *expressions, List *predicates, bool unique, bool isready, bool concurrent)
Definition: makefuncs.c:740
#define ereport(elevel, rest)
Definition: elog.h:141
List * lappend(List *list, void *datum)
Definition: list.c:322
HeapTuple SearchSysCache1(int cacheId, Datum key1)
Definition: syscache.c:1124
Definition: c.h:577
#define TextDatumGetCString(d)
Definition: builtins.h:84
uintptr_t Datum
Definition: postgres.h:367
void ReleaseSysCache(HeapTuple tuple)
Definition: syscache.c:1172
int ii_NumIndexAttrs
Definition: execnodes.h:157
List * make_ands_implicit(Expr *clause)
Definition: makefuncs.c:716
Datum SysCacheGetAttr(int cacheId, HeapTuple tup, AttrNumber attributeNumber, bool *isNull)
Definition: syscache.c:1385
#define InvalidOid
Definition: postgres_ext.h:36
#define INDEX_CREATE_CONCURRENT
Definition: index.h:50
bool ii_Unique
Definition: execnodes.h:170
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
List * ii_Expressions
Definition: execnodes.h:160
#define Assert(condition)
Definition: c.h:732
int16 values[FLEXIBLE_ARRAY_MEMBER]
Definition: c.h:585
void index_close(Relation relation, LOCKMODE lockmode)
Definition: indexam.c:152
#define DatumGetPointer(X)
Definition: postgres.h:549
#define INDEX_CREATE_SKIP_BUILD
Definition: index.h:49
Oid * ii_ExclusionOps
Definition: execnodes.h:164
int errmsg(const char *fmt,...)
Definition: elog.c:784
#define elog(elevel,...)
Definition: elog.h:226
int i
#define NameStr(name)
Definition: c.h:609
AttrNumber ii_IndexAttrNumbers[INDEX_MAX_KEYS]
Definition: execnodes.h:159
Definition: pg_list.h:50
Relation index_open(Oid relationId, LOCKMODE lockmode)
Definition: indexam.c:126
Oid ii_Am
Definition: execnodes.h:175

◆ index_concurrently_set_dead()

void index_concurrently_set_dead ( Oid  heapId,
Oid  indexId 
)

Definition at line 1721 of file index.c.

References CacheInvalidateRelcache(), index_close(), INDEX_DROP_SET_DEAD, index_open(), index_set_state_flags(), NoLock, ShareUpdateExclusiveLock, table_close(), table_open(), and TransferPredicateLocksToHeapRelation().

Referenced by index_drop(), and ReindexRelationConcurrently().

1722 {
1723  Relation userHeapRelation;
1724  Relation userIndexRelation;
1725 
1726  /*
1727  * No more predicate locks will be acquired on this index, and we're about
1728  * to stop doing inserts into the index which could show conflicts with
1729  * existing predicate locks, so now is the time to move them to the heap
1730  * relation.
1731  */
1732  userHeapRelation = table_open(heapId, ShareUpdateExclusiveLock);
1733  userIndexRelation = index_open(indexId, ShareUpdateExclusiveLock);
1734  TransferPredicateLocksToHeapRelation(userIndexRelation);
1735 
1736  /*
1737  * Now we are sure that nobody uses the index for queries; they just might
1738  * have it open for updating it. So now we can unset indisready and
1739  * indislive, then wait till nobody could be using it at all anymore.
1740  */
1742 
1743  /*
1744  * Invalidate the relcache for the table, so that after this commit all
1745  * sessions will refresh the table's index list. Forgetting just the
1746  * index's relcache entry is not enough.
1747  */
1748  CacheInvalidateRelcache(userHeapRelation);
1749 
1750  /*
1751  * Close the relations again, though still holding session lock.
1752  */
1753  table_close(userHeapRelation, NoLock);
1754  index_close(userIndexRelation, NoLock);
1755 }
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:133
void index_set_state_flags(Oid indexId, IndexStateFlagsAction action)
Definition: index.c:3241
#define NoLock
Definition: lockdefs.h:34
void TransferPredicateLocksToHeapRelation(Relation relation)
Definition: predicate.c:3097
#define ShareUpdateExclusiveLock
Definition: lockdefs.h:39
void index_close(Relation relation, LOCKMODE lockmode)
Definition: indexam.c:152
void CacheInvalidateRelcache(Relation relation)
Definition: inval.c:1270
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39
Relation index_open(Oid relationId, LOCKMODE lockmode)
Definition: indexam.c:126

◆ index_concurrently_swap()

void index_concurrently_swap ( Oid  newIndexId,
Oid  oldIndexId,
const char *  oldName 
)

Definition at line 1449 of file index.c.

References PgStat_StatTabEntry::blocks_fetched, PgStat_StatTabEntry::blocks_hit, BTEqualStrategyNumber, CatalogTupleUpdate(), changeDependenciesOf(), changeDependenciesOn(), CONSTROID, DeleteInheritsTuple(), DescriptionObjIndexId, elog, ERROR, get_index_constraint(), get_index_ref_constraints(), get_partition_ancestors(), get_rel_relispartition(), GETSTRUCT, heap_copytuple(), heap_freetuple(), heap_modify_tuple(), HeapTupleIsValid, INDEXRELID, Int32GetDatum, sort-test::key, lappend_oid(), lfirst_oid, linitial_oid, list_free(), NameStr, namestrcpy(), NIL, NoLock, PgStat_StatTabEntry::numscans, ObjectIdGetDatum, OidIsValid, pgstat_fetch_stat_tabentry(), RelationData::pgstat_info, relation_close(), relation_open(), RelationGetDescr, RELOID, RowExclusiveLock, ScanKeyInit(), SearchSysCacheCopy1, ShareUpdateExclusiveLock, StoreSingleInheritance(), systable_beginscan(), systable_endscan(), systable_getnext(), PgStat_TableCounts::t_blocks_fetched, PgStat_TableCounts::t_blocks_hit, PgStat_TableStatus::t_counts, PgStat_TableCounts::t_numscans, HeapTupleData::t_self, PgStat_TableCounts::t_tuples_fetched, PgStat_TableCounts::t_tuples_returned, table_close(), table_open(), TriggerConstraintIndexId, PgStat_StatTabEntry::tuples_fetched, PgStat_StatTabEntry::tuples_returned, and values.

Referenced by ReindexRelationConcurrently().

1450 {
1451  Relation pg_class,
1452  pg_index,
1453  pg_constraint,
1454  pg_trigger;
1455  Relation oldClassRel,
1456  newClassRel;
1457  HeapTuple oldClassTuple,
1458  newClassTuple;
1459  Form_pg_class oldClassForm,
1460  newClassForm;
1461  HeapTuple oldIndexTuple,
1462  newIndexTuple;
1463  Form_pg_index oldIndexForm,
1464  newIndexForm;
1465  Oid indexConstraintOid;
1466  List *constraintOids = NIL;
1467  ListCell *lc;
1468 
1469  /*
1470  * Take a necessary lock on the old and new index before swapping them.
1471  */
1472  oldClassRel = relation_open(oldIndexId, ShareUpdateExclusiveLock);
1473  newClassRel = relation_open(newIndexId, ShareUpdateExclusiveLock);
1474 
1475  /* Now swap names and dependencies of those indexes */
1476  pg_class = table_open(RelationRelationId, RowExclusiveLock);
1477 
1478  oldClassTuple = SearchSysCacheCopy1(RELOID,
1479  ObjectIdGetDatum(oldIndexId));
1480  if (!HeapTupleIsValid(oldClassTuple))
1481  elog(ERROR, "could not find tuple for relation %u", oldIndexId);
1482  newClassTuple = SearchSysCacheCopy1(RELOID,
1483  ObjectIdGetDatum(newIndexId));
1484  if (!HeapTupleIsValid(newClassTuple))
1485  elog(ERROR, "could not find tuple for relation %u", newIndexId);
1486 
1487  oldClassForm = (Form_pg_class) GETSTRUCT(oldClassTuple);
1488  newClassForm = (Form_pg_class) GETSTRUCT(newClassTuple);
1489 
1490  /* Swap the names */
1491  namestrcpy(&newClassForm->relname, NameStr(oldClassForm->relname));
1492  namestrcpy(&oldClassForm->relname, oldName);
1493 
1494  /* Copy partition flag to track inheritance properly */
1495  newClassForm->relispartition = oldClassForm->relispartition;
1496 
1497  CatalogTupleUpdate(pg_class, &oldClassTuple->t_self, oldClassTuple);
1498  CatalogTupleUpdate(pg_class, &newClassTuple->t_self, newClassTuple);
1499 
1500  heap_freetuple(oldClassTuple);
1501  heap_freetuple(newClassTuple);
1502 
1503  /* Now swap index info */
1504  pg_index = table_open(IndexRelationId, RowExclusiveLock);
1505 
1506  oldIndexTuple = SearchSysCacheCopy1(INDEXRELID,
1507  ObjectIdGetDatum(oldIndexId));
1508  if (!HeapTupleIsValid(oldIndexTuple))
1509  elog(ERROR, "could not find tuple for relation %u", oldIndexId);
1510  newIndexTuple = SearchSysCacheCopy1(INDEXRELID,
1511  ObjectIdGetDatum(newIndexId));
1512  if (!HeapTupleIsValid(newIndexTuple))
1513  elog(ERROR, "could not find tuple for relation %u", newIndexId);
1514 
1515  oldIndexForm = (Form_pg_index) GETSTRUCT(oldIndexTuple);
1516  newIndexForm = (Form_pg_index) GETSTRUCT(newIndexTuple);
1517 
1518  /*
1519  * Copy constraint flags from the old index. This is safe because the old
1520  * index guaranteed uniqueness.
1521  */
1522  newIndexForm->indisprimary = oldIndexForm->indisprimary;
1523  oldIndexForm->indisprimary = false;
1524  newIndexForm->indisexclusion = oldIndexForm->indisexclusion;
1525  oldIndexForm->indisexclusion = false;
1526  newIndexForm->indimmediate = oldIndexForm->indimmediate;
1527  oldIndexForm->indimmediate = true;
1528 
1529  /* Mark old index as valid and new as invalid as index_set_state_flags */
1530  newIndexForm->indisvalid = true;
1531  oldIndexForm->indisvalid = false;
1532  oldIndexForm->indisclustered = false;
1533 
1534  CatalogTupleUpdate(pg_index, &oldIndexTuple->t_self, oldIndexTuple);
1535  CatalogTupleUpdate(pg_index, &newIndexTuple->t_self, newIndexTuple);
1536 
1537  heap_freetuple(oldIndexTuple);
1538  heap_freetuple(newIndexTuple);
1539 
1540  /*
1541  * Move constraints and triggers over to the new index
1542  */
1543 
1544  constraintOids = get_index_ref_constraints(oldIndexId);
1545 
1546  indexConstraintOid = get_index_constraint(oldIndexId);
1547 
1548  if (OidIsValid(indexConstraintOid))
1549  constraintOids = lappend_oid(constraintOids, indexConstraintOid);
1550 
1551  pg_constraint = table_open(ConstraintRelationId, RowExclusiveLock);
1552  pg_trigger = table_open(TriggerRelationId, RowExclusiveLock);
1553 
1554  foreach(lc, constraintOids)
1555  {
1556  HeapTuple constraintTuple,
1557  triggerTuple;
1558  Form_pg_constraint conForm;
1559  ScanKeyData key[1];
1560  SysScanDesc scan;
1561  Oid constraintOid = lfirst_oid(lc);
1562 
1563  /* Move the constraint from the old to the new index */
1564  constraintTuple = SearchSysCacheCopy1(CONSTROID,
1565  ObjectIdGetDatum(constraintOid));
1566  if (!HeapTupleIsValid(constraintTuple))
1567  elog(ERROR, "could not find tuple for constraint %u", constraintOid);
1568 
1569  conForm = ((Form_pg_constraint) GETSTRUCT(constraintTuple));
1570 
1571  if (conForm->conindid == oldIndexId)
1572  {
1573  conForm->conindid = newIndexId;
1574 
1575  CatalogTupleUpdate(pg_constraint, &constraintTuple->t_self, constraintTuple);
1576  }
1577 
1578  heap_freetuple(constraintTuple);
1579 
1580  /* Search for trigger records */
1581  ScanKeyInit(&key[0],
1582  Anum_pg_trigger_tgconstraint,
1583  BTEqualStrategyNumber, F_OIDEQ,
1584  ObjectIdGetDatum(constraintOid));
1585 
1586  scan = systable_beginscan(pg_trigger, TriggerConstraintIndexId, true,
1587  NULL, 1, key);
1588 
1589  while (HeapTupleIsValid((triggerTuple = systable_getnext(scan))))
1590  {
1591  Form_pg_trigger tgForm = (Form_pg_trigger) GETSTRUCT(triggerTuple);
1592 
1593  if (tgForm->tgconstrindid != oldIndexId)
1594  continue;
1595 
1596  /* Make a modifiable copy */
1597  triggerTuple = heap_copytuple(triggerTuple);
1598  tgForm = (Form_pg_trigger) GETSTRUCT(triggerTuple);
1599 
1600  tgForm->tgconstrindid = newIndexId;
1601 
1602  CatalogTupleUpdate(pg_trigger, &triggerTuple->t_self, triggerTuple);
1603 
1604  heap_freetuple(triggerTuple);
1605  }
1606 
1607  systable_endscan(scan);
1608  }
1609 
1610  /*
1611  * Move comment if any
1612  */
1613  {
1614  Relation description;
1615  ScanKeyData skey[3];
1616  SysScanDesc sd;
1617  HeapTuple tuple;
1618  Datum values[Natts_pg_description] = {0};
1619  bool nulls[Natts_pg_description] = {0};
1620  bool replaces[Natts_pg_description] = {0};
1621 
1622  values[Anum_pg_description_objoid - 1] = ObjectIdGetDatum(newIndexId);
1623  replaces[Anum_pg_description_objoid - 1] = true;
1624 
1625  ScanKeyInit(&skey[0],
1626  Anum_pg_description_objoid,
1627  BTEqualStrategyNumber, F_OIDEQ,
1628  ObjectIdGetDatum(oldIndexId));
1629  ScanKeyInit(&skey[1],
1630  Anum_pg_description_classoid,
1631  BTEqualStrategyNumber, F_OIDEQ,
1632  ObjectIdGetDatum(RelationRelationId));
1633  ScanKeyInit(&skey[2],
1634  Anum_pg_description_objsubid,
1635  BTEqualStrategyNumber, F_INT4EQ,
1636  Int32GetDatum(0));
1637 
1638  description = table_open(DescriptionRelationId, RowExclusiveLock);
1639 
1640  sd = systable_beginscan(description, DescriptionObjIndexId, true,
1641  NULL, 3, skey);
1642 
1643  while ((tuple = systable_getnext(sd)) != NULL)
1644  {
1645  tuple = heap_modify_tuple(tuple, RelationGetDescr(description),
1646  values, nulls, replaces);
1647  CatalogTupleUpdate(description, &tuple->t_self, tuple);
1648 
1649  break; /* Assume there can be only one match */
1650  }
1651 
1652  systable_endscan(sd);
1653  table_close(description, NoLock);
1654  }
1655 
1656  /*
1657  * Swap inheritance relationship with parent index
1658  */
1659  if (get_rel_relispartition(oldIndexId))
1660  {
1661  List *ancestors = get_partition_ancestors(oldIndexId);
1662  Oid parentIndexRelid = linitial_oid(ancestors);
1663 
1664  DeleteInheritsTuple(oldIndexId, parentIndexRelid);
1665  StoreSingleInheritance(newIndexId, parentIndexRelid, 1);
1666 
1667  list_free(ancestors);
1668  }
1669 
1670  /*
1671  * Move all dependencies of and on the old index to the new one
1672  */
1673  changeDependenciesOf(RelationRelationId, oldIndexId, newIndexId);
1674  changeDependenciesOn(RelationRelationId, oldIndexId, newIndexId);
1675 
1676  /*
1677  * Copy over statistics from old to new index
1678  */
1679  {
1680  PgStat_StatTabEntry *tabentry;
1681 
1682  tabentry = pgstat_fetch_stat_tabentry(oldIndexId);
1683  if (tabentry)
1684  {
1685  if (newClassRel->pgstat_info)
1686  {
1687  newClassRel->pgstat_info->t_counts.t_numscans = tabentry->numscans;
1688  newClassRel->pgstat_info->t_counts.t_tuples_returned = tabentry->tuples_returned;
1689  newClassRel->pgstat_info->t_counts.t_tuples_fetched = tabentry->tuples_fetched;
1690  newClassRel->pgstat_info->t_counts.t_blocks_fetched = tabentry->blocks_fetched;
1691  newClassRel->pgstat_info->t_counts.t_blocks_hit = tabentry->blocks_hit;
1692 
1693  /*
1694  * The data will be sent by the next pgstat_report_stat()
1695  * call.
1696  */
1697  }
1698  }
1699  }
1700 
1701  /* Close relations */
1702  table_close(pg_class, RowExclusiveLock);
1703  table_close(pg_index, RowExclusiveLock);
1704  table_close(pg_constraint, RowExclusiveLock);
1705  table_close(pg_trigger, RowExclusiveLock);
1706 
1707  /* The lock taken previously is not released until the end of transaction */
1708  relation_close(oldClassRel, NoLock);
1709  relation_close(newClassRel, NoLock);
1710 }
HeapTuple heap_copytuple(HeapTuple tuple)
Definition: heaptuple.c:680
#define NIL
Definition: pg_list.h:65
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:133
void systable_endscan(SysScanDesc sysscan)
Definition: genam.c:525
#define GETSTRUCT(TUP)
Definition: htup_details.h:655
PgStat_Counter tuples_returned
Definition: pgstat.h:638
#define RelationGetDescr(relation)
Definition: rel.h:445
PgStat_Counter t_tuples_fetched
Definition: pgstat.h:102
bool DeleteInheritsTuple(Oid inhrelid, Oid inhparent)
Definition: pg_inherits.c:454
PgStat_Counter numscans
Definition: pgstat.h:636
PgStat_TableCounts t_counts
Definition: pgstat.h:158
void heap_freetuple(HeapTuple htup)
Definition: heaptuple.c:1338
unsigned int Oid
Definition: postgres_ext.h:31
int namestrcpy(Name name, const char *str)
Definition: name.c:250
List * lappend_oid(List *list, Oid datum)
Definition: list.c:358
#define OidIsValid(objectId)
Definition: c.h:638
PgStat_Counter t_tuples_returned
Definition: pgstat.h:101
SysScanDesc systable_beginscan(Relation heapRelation, Oid indexId, bool indexOK, Snapshot snapshot, int nkeys, ScanKey key)
Definition: genam.c:352
HeapTuple systable_getnext(SysScanDesc sysscan)
Definition: genam.c:444
#define ObjectIdGetDatum(X)
Definition: postgres.h:507
#define ERROR
Definition: elog.h:43
Relation relation_open(Oid relationId, LOCKMODE lockmode)
Definition: relation.c:48
ItemPointerData t_self
Definition: htup.h:65
PgStat_StatTabEntry * pgstat_fetch_stat_tabentry(Oid relid)
Definition: pgstat.c:2459
#define NoLock
Definition: lockdefs.h:34
#define RowExclusiveLock
Definition: lockdefs.h:38
PgStat_Counter tuples_fetched
Definition: pgstat.h:639
Oid get_index_constraint(Oid indexId)
Definition: pg_depend.c:873
#define TriggerConstraintIndexId
Definition: indexing.h:254
void StoreSingleInheritance(Oid relationId, Oid parentOid, int32 seqNumber)
Definition: pg_inherits.c:417
PgStat_Counter t_blocks_hit
Definition: pgstat.h:115
bool get_rel_relispartition(Oid relid)
Definition: lsyscache.c:1829
FormData_pg_index * Form_pg_index
Definition: pg_index.h:66
uintptr_t Datum
Definition: postgres.h:367
PgStat_Counter blocks_hit
Definition: pgstat.h:651
PgStat_Counter t_numscans
Definition: pgstat.h:99
long changeDependenciesOf(Oid classId, Oid oldObjectId, Oid newObjectId)
Definition: pg_depend.c:407
#define ShareUpdateExclusiveLock
Definition: lockdefs.h:39
FormData_pg_constraint * Form_pg_constraint
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
void relation_close(Relation relation, LOCKMODE lockmode)
Definition: relation.c:206
#define linitial_oid(l)
Definition: pg_list.h:197
void CatalogTupleUpdate(Relation heapRel, ItemPointer otid, HeapTuple tup)
Definition: indexing.c:224
struct PgStat_TableStatus * pgstat_info
Definition: rel.h:204
FormData_pg_trigger * Form_pg_trigger
Definition: pg_trigger.h:71
List * get_index_ref_constraints(Oid indexId)
Definition: pg_depend.c:929
static Datum values[MAXATTR]
Definition: bootstrap.c:167
FormData_pg_class * Form_pg_class
Definition: pg_class.h:150
#define SearchSysCacheCopy1(cacheId, key1)
Definition: syscache.h:174
#define Int32GetDatum(X)
Definition: postgres.h:479
void list_free(List *list)
Definition: list.c:1377
#define elog(elevel,...)
Definition: elog.h:226
#define NameStr(name)
Definition: c.h:609
void ScanKeyInit(ScanKey entry, AttrNumber attributeNumber, StrategyNumber strategy, RegProcedure procedure, Datum argument)
Definition: scankey.c:76
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39
HeapTuple heap_modify_tuple(HeapTuple tuple, TupleDesc tupleDesc, Datum *replValues, bool *replIsnull, bool *doReplace)
Definition: heaptuple.c:1113
PgStat_Counter blocks_fetched
Definition: pgstat.h:650
Definition: pg_list.h:50
long changeDependenciesOn(Oid refClassId, Oid oldRefObjectId, Oid newRefObjectId)
Definition: pg_depend.c:463
List * get_partition_ancestors(Oid relid)
Definition: partition.c:116
#define BTEqualStrategyNumber
Definition: stratnum.h:31
PgStat_Counter t_blocks_fetched
Definition: pgstat.h:114
#define lfirst_oid(lc)
Definition: pg_list.h:192
#define DescriptionObjIndexId
Definition: indexing.h:154

◆ index_constraint_create()

ObjectAddress index_constraint_create ( Relation  heapRelation,
Oid  indexRelationId,
Oid  parentConstraintId,
IndexInfo indexInfo,
const char *  constraintName,
char  constraintType,
bits16  constr_flags,
bool  allow_system_table_mods,
bool  is_internal 
)

Definition at line 1782 of file index.c.

References CreateTrigStmt::args, Assert, CatalogTupleUpdate(), CreateTrigStmt::columns, CreateTrigStmt::constrrel, CreateConstraintEntry(), CreateTrigger(), CreateTrigStmt::deferrable, deleteDependencyRecordsForClass(), DEPENDENCY_AUTO, DEPENDENCY_INTERNAL, DEPENDENCY_PARTITION_PRI, DEPENDENCY_PARTITION_SEC, elog, ereport, errcode(), errmsg(), ERROR, CreateTrigStmt::events, CreateTrigStmt::funcname, GETSTRUCT, heap_freetuple(), HeapTupleIsValid, IndexInfo::ii_ExclusionOps, IndexInfo::ii_Expressions, IndexInfo::ii_IndexAttrNumbers, IndexInfo::ii_NumIndexAttrs, IndexInfo::ii_NumIndexKeyAttrs, INDEX_CONSTR_CREATE_DEFERRABLE, INDEX_CONSTR_CREATE_INIT_DEFERRED, INDEX_CONSTR_CREATE_MARK_AS_PRIMARY, INDEX_CONSTR_CREATE_REMOVE_OLD_DEPS, INDEX_CONSTR_CREATE_UPDATE_INDEX, INDEXRELID, CreateTrigStmt::initdeferred, InvalidOid, InvokeObjectPostAlterHookArg, IsBootstrapProcessingMode, CreateTrigStmt::isconstraint, IsNormalProcessingMode, IsSystemRelation(), makeNode, NIL, ObjectAddressSet, ObjectIdGetDatum, OidIsValid, recordDependencyOn(), CreateTrigStmt::relation, RelationGetNamespace, RelationGetRelid, CreateTrigStmt::row, RowExclusiveLock, SearchSysCacheCopy1, SystemFuncName(), HeapTupleData::t_self, table_close(), table_open(), CreateTrigStmt::timing, CreateTrigStmt::trigname, and CreateTrigStmt::whenClause.

Referenced by ATExecAddIndexConstraint(), and index_create().

1791 {
1792  Oid namespaceId = RelationGetNamespace(heapRelation);
1793  ObjectAddress myself,
1794  idxaddr;
1795  Oid conOid;
1796  bool deferrable;
1797  bool initdeferred;
1798  bool mark_as_primary;
1799  bool islocal;
1800  bool noinherit;
1801  int inhcount;
1802 
1803  deferrable = (constr_flags & INDEX_CONSTR_CREATE_DEFERRABLE) != 0;
1804  initdeferred = (constr_flags & INDEX_CONSTR_CREATE_INIT_DEFERRED) != 0;
1805  mark_as_primary = (constr_flags & INDEX_CONSTR_CREATE_MARK_AS_PRIMARY) != 0;
1806 
1807  /* constraint creation support doesn't work while bootstrapping */
1809 
1810  /* enforce system-table restriction */
1811  if (!allow_system_table_mods &&
1812  IsSystemRelation(heapRelation) &&
1814  ereport(ERROR,
1815  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1816  errmsg("user-defined indexes on system catalog tables are not supported")));
1817 
1818  /* primary/unique constraints shouldn't have any expressions */
1819  if (indexInfo->ii_Expressions &&
1820  constraintType != CONSTRAINT_EXCLUSION)
1821  elog(ERROR, "constraints cannot have index expressions");
1822 
1823  /*
1824  * If we're manufacturing a constraint for a pre-existing index, we need
1825  * to get rid of the existing auto dependencies for the index (the ones
1826  * that index_create() would have made instead of calling this function).
1827  *
1828  * Note: this code would not necessarily do the right thing if the index
1829  * has any expressions or predicate, but we'd never be turning such an
1830  * index into a UNIQUE or PRIMARY KEY constraint.
1831  */
1832  if (constr_flags & INDEX_CONSTR_CREATE_REMOVE_OLD_DEPS)
1833  deleteDependencyRecordsForClass(RelationRelationId, indexRelationId,
1834  RelationRelationId, DEPENDENCY_AUTO);
1835 
1836  if (OidIsValid(parentConstraintId))
1837  {
1838  islocal = false;
1839  inhcount = 1;
1840  noinherit = false;
1841  }
1842  else
1843  {
1844  islocal = true;
1845  inhcount = 0;
1846  noinherit = true;
1847  }
1848 
1849  /*
1850  * Construct a pg_constraint entry.
1851  */
1852  conOid = CreateConstraintEntry(constraintName,
1853  namespaceId,
1854  constraintType,
1855  deferrable,
1856  initdeferred,
1857  true,
1858  parentConstraintId,
1859  RelationGetRelid(heapRelation),
1860  indexInfo->ii_IndexAttrNumbers,
1861  indexInfo->ii_NumIndexKeyAttrs,
1862  indexInfo->ii_NumIndexAttrs,
1863  InvalidOid, /* no domain */
1864  indexRelationId, /* index OID */
1865  InvalidOid, /* no foreign key */
1866  NULL,
1867  NULL,
1868  NULL,
1869  NULL,
1870  0,
1871  ' ',
1872  ' ',
1873  ' ',
1874  indexInfo->ii_ExclusionOps,
1875  NULL, /* no check constraint */
1876  NULL,
1877  islocal,
1878  inhcount,
1879  noinherit,
1880  is_internal);
1881 
1882  /*
1883  * Register the index as internally dependent on the constraint.
1884  *
1885  * Note that the constraint has a dependency on the table, so we don't
1886  * need (or want) any direct dependency from the index to the table.
1887  */
1888  ObjectAddressSet(myself, ConstraintRelationId, conOid);
1889  ObjectAddressSet(idxaddr, RelationRelationId, indexRelationId);
1890  recordDependencyOn(&idxaddr, &myself, DEPENDENCY_INTERNAL);
1891 
1892  /*
1893  * Also, if this is a constraint on a partition, give it partition-type
1894  * dependencies on the parent constraint as well as the table.
1895  */
1896  if (OidIsValid(parentConstraintId))
1897  {
1898  ObjectAddress referenced;
1899 
1900  ObjectAddressSet(referenced, ConstraintRelationId, parentConstraintId);
1901  recordDependencyOn(&myself, &referenced, DEPENDENCY_PARTITION_PRI);
1902  ObjectAddressSet(referenced, RelationRelationId,
1903  RelationGetRelid(heapRelation));
1904  recordDependencyOn(&myself, &referenced, DEPENDENCY_PARTITION_SEC);
1905  }
1906 
1907  /*
1908  * If the constraint is deferrable, create the deferred uniqueness
1909  * checking trigger. (The trigger will be given an internal dependency on
1910  * the constraint by CreateTrigger.)
1911  */
1912  if (deferrable)
1913  {
1914  CreateTrigStmt *trigger;
1915 
1916  trigger = makeNode(CreateTrigStmt);
1917  trigger->trigname = (constraintType == CONSTRAINT_PRIMARY) ?
1918  "PK_ConstraintTrigger" :
1919  "Unique_ConstraintTrigger";
1920  trigger->relation = NULL;
1921  trigger->funcname = SystemFuncName("unique_key_recheck");
1922  trigger->args = NIL;
1923  trigger->row = true;
1924  trigger->timing = TRIGGER_TYPE_AFTER;
1925  trigger->events = TRIGGER_TYPE_INSERT | TRIGGER_TYPE_UPDATE;
1926  trigger->columns = NIL;
1927  trigger->whenClause = NULL;
1928  trigger->isconstraint = true;
1929  trigger->deferrable = true;
1930  trigger->initdeferred = initdeferred;
1931  trigger->constrrel = NULL;
1932 
1933  (void) CreateTrigger(trigger, NULL, RelationGetRelid(heapRelation),
1934  InvalidOid, conOid, indexRelationId, InvalidOid,
1935  InvalidOid, NULL, true, false);
1936  }
1937 
1938  /*
1939  * If needed, mark the index as primary and/or deferred in pg_index.
1940  *
1941  * Note: When making an existing index into a constraint, caller must have
1942  * a table lock that prevents concurrent table updates; otherwise, there
1943  * is a risk that concurrent readers of the table will miss seeing this
1944  * index at all.
1945  */
1946  if ((constr_flags & INDEX_CONSTR_CREATE_UPDATE_INDEX) &&
1947  (mark_as_primary || deferrable))
1948  {
1949  Relation pg_index;
1950  HeapTuple indexTuple;
1951  Form_pg_index indexForm;
1952  bool dirty = false;
1953 
1954  pg_index = table_open(IndexRelationId, RowExclusiveLock);
1955 
1956  indexTuple = SearchSysCacheCopy1(INDEXRELID,
1957  ObjectIdGetDatum(indexRelationId));
1958  if (!HeapTupleIsValid(indexTuple))
1959  elog(ERROR, "cache lookup failed for index %u", indexRelationId);
1960  indexForm = (Form_pg_index) GETSTRUCT(indexTuple);
1961 
1962  if (mark_as_primary && !indexForm->indisprimary)
1963  {
1964  indexForm->indisprimary = true;
1965  dirty = true;
1966  }
1967 
1968  if (deferrable && indexForm->indimmediate)
1969  {
1970  indexForm->indimmediate = false;
1971  dirty = true;
1972  }
1973 
1974  if (dirty)
1975  {
1976  CatalogTupleUpdate(pg_index, &indexTuple->t_self, indexTuple);
1977 
1978  InvokeObjectPostAlterHookArg(IndexRelationId, indexRelationId, 0,
1979  InvalidOid, is_internal);
1980  }
1981 
1982  heap_freetuple(indexTuple);
1983  table_close(pg_index, RowExclusiveLock);
1984  }
1985 
1986  return myself;
1987 }
#define NIL
Definition: pg_list.h:65
List * SystemFuncName(char *name)
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:133
#define GETSTRUCT(TUP)
Definition: htup_details.h:655
bool IsSystemRelation(Relation relation)
Definition: catalog.c:70
Node * whenClause
Definition: parsenodes.h:2417
Oid CreateConstraintEntry(const char *constraintName, Oid constraintNamespace, char constraintType, bool isDeferrable, bool isDeferred, bool isValidated, Oid parentConstrId, Oid relId, const int16 *constraintKey, int constraintNKeys, int constraintNTotalKeys, Oid domainId, Oid indexRelId, Oid foreignRelId, const int16 *foreignKey, const Oid *pfEqOp, const Oid *ppEqOp, const Oid *ffEqOp, int foreignNKeys, char foreignUpdateType, char foreignDeleteType, char foreignMatchType, const Oid *exclOp, Node *conExpr, const char *conBin, bool conIsLocal, int conInhCount, bool conNoInherit, bool is_internal)
Definition: pg_constraint.c:51
int errcode(int sqlerrcode)
Definition: elog.c:570
void recordDependencyOn(const ObjectAddress *depender, const ObjectAddress *referenced, DependencyType behavior)
Definition: pg_depend.c:43
#define INDEX_CONSTR_CREATE_REMOVE_OLD_DEPS
Definition: index.h:79
void heap_freetuple(HeapTuple htup)
Definition: heaptuple.c:1338
unsigned int Oid
Definition: postgres_ext.h:31
#define OidIsValid(objectId)
Definition: c.h:638
#define InvokeObjectPostAlterHookArg(classId, objectId, subId, auxiliaryId, is_internal)
Definition: objectaccess.h:166
#define INDEX_CONSTR_CREATE_INIT_DEFERRED
Definition: index.h:77
RangeVar * constrrel
Definition: parsenodes.h:2424
#define ObjectIdGetDatum(X)
Definition: postgres.h:507
#define ERROR
Definition: elog.h:43
int ii_NumIndexKeyAttrs
Definition: execnodes.h:158
ItemPointerData t_self
Definition: htup.h:65
#define IsNormalProcessingMode()
Definition: miscadmin.h:376
#define RowExclusiveLock
Definition: lockdefs.h:38
#define ereport(elevel, rest)
Definition: elog.h:141
FormData_pg_index * Form_pg_index
Definition: pg_index.h:66
int ii_NumIndexAttrs
Definition: execnodes.h:157
long deleteDependencyRecordsForClass(Oid classId, Oid objectId, Oid refclassId, char deptype)
Definition: pg_depend.c:240
#define InvalidOid
Definition: postgres_ext.h:36
#define makeNode(_type_)
Definition: nodes.h:573
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
List * ii_Expressions
Definition: execnodes.h:160
#define Assert(condition)
Definition: c.h:732
void CatalogTupleUpdate(Relation heapRel, ItemPointer otid, HeapTuple tup)
Definition: indexing.c:224
#define INDEX_CONSTR_CREATE_UPDATE_INDEX
Definition: index.h:78
#define ObjectAddressSet(addr, class_id, object_id)
Definition: objectaddress.h:40
#define IsBootstrapProcessingMode()
Definition: miscadmin.h:374
#define SearchSysCacheCopy1(cacheId, key1)
Definition: syscache.h:174
Oid * ii_ExclusionOps
Definition: execnodes.h:164
int errmsg(const char *fmt,...)
Definition: elog.c:784
#define elog(elevel,...)
Definition: elog.h:226
RangeVar * relation
Definition: parsenodes.h:2408
ObjectAddress CreateTrigger(CreateTrigStmt *stmt, const char *queryString, Oid relOid, Oid refRelOid, Oid constraintOid, Oid indexOid, Oid funcoid, Oid parentTriggerOid, Node *whenClause, bool isInternal, bool in_partition)
Definition: trigger.c:162
AttrNumber ii_IndexAttrNumbers[INDEX_MAX_KEYS]
Definition: execnodes.h:159
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39
#define RelationGetRelid(relation)
Definition: rel.h:419
#define INDEX_CONSTR_CREATE_DEFERRABLE
Definition: index.h:76
#define INDEX_CONSTR_CREATE_MARK_AS_PRIMARY
Definition: index.h:75
#define RelationGetNamespace(relation)
Definition: rel.h:460

◆ index_create()

Oid index_create ( Relation  heapRelation,
const char *  indexRelationName,
Oid  indexRelationId,
Oid  parentIndexRelid,
Oid  parentConstraintId,
Oid  relFileNode,
IndexInfo indexInfo,
List indexColNames,
Oid  accessMethodObjectId,
Oid  tableSpaceId,
Oid collationObjectId,
Oid classObjectId,
int16 coloptions,
Datum  reloptions,
bits16  flags,
bits16  constr_flags,
bool  allow_system_table_mods,
bool  is_internal,
Oid constraintId 
)

Definition at line 692 of file index.c.

References AccessExclusiveLock, AppendAttributeTuples(), Assert, binary_upgrade_next_index_pg_class_oid, CacheInvalidateRelcache(), CLAOID, ObjectAddress::classId, CommandCounterIncrement(), CONSTRAINT_RELATION, ConstraintNameIsUsed(), ConstructTupleDescriptor(), DEPENDENCY_AUTO, DEPENDENCY_NORMAL, DEPENDENCY_PARTITION_PRI, DEPENDENCY_PARTITION_SEC, elog, ereport, errcode(), ERRCODE_DUPLICATE_OBJECT, errmsg(), ERROR, get_collation_isdeterministic(), get_relname_relid(), GetNewRelFileNode(), GETSTRUCT, heap_create(), HeapTupleIsValid, i, IndexInfo::ii_ExclusionOps, IndexInfo::ii_Expressions, IndexInfo::ii_IndexAttrNumbers, IndexInfo::ii_NumIndexAttrs, IndexInfo::ii_NumIndexKeyAttrs, IndexInfo::ii_Predicate, IndexInfo::ii_Unique, index_build(), index_close(), INDEX_CONSTR_CREATE_DEFERRABLE, index_constraint_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_SKIP_BUILD, index_register(), index_update_stats(), InitializeAttributeOids(), InsertPgClassTuple(), InvalidMultiXactId, InvalidOid, InvalidTransactionId, InvokeObjectPostCreateHookArg, IsBinaryUpgrade, IsBootstrapProcessingMode, IsCatalogRelation(), IsNormalProcessingMode, IsSystemRelation(), LockRelation(), NameStr, NoLock, NOTICE, ObjectAddress::objectId, ObjectIdGetDatum, ObjectAddress::objectSubId, OidIsValid, RelationData::rd_index, RelationData::rd_indexcxt, RelationData::rd_rel, recordDependencyOn(), recordDependencyOnSingleRelExpr(), RelationGetNamespace, RelationGetRelationName, RelationGetRelid, RelationInitIndexAccessInfo(), RelationIsMapped, ReleaseSysCache(), relfrozenxid, relkind, relminmxid, relpersistence, RowExclusiveLock, SearchSysCache1(), SetRelationHasSubclass(), StoreSingleInheritance(), table_close(), table_open(), and UpdateIndexRelation().

Referenced by create_toast_table(), DefineIndex(), and index_concurrently_create_copy().

711 {
712  Oid heapRelationId = RelationGetRelid(heapRelation);
713  Relation pg_class;
714  Relation indexRelation;
715  TupleDesc indexTupDesc;
716  bool shared_relation;
717  bool mapped_relation;
718  bool is_exclusion;
719  Oid namespaceId;
720  int i;
721  char relpersistence;
722  bool isprimary = (flags & INDEX_CREATE_IS_PRIMARY) != 0;
723  bool invalid = (flags & INDEX_CREATE_INVALID) != 0;
724  bool concurrent = (flags & INDEX_CREATE_CONCURRENT) != 0;
725  bool partitioned = (flags & INDEX_CREATE_PARTITIONED) != 0;
726  char relkind;
729 
730  /* constraint flags can only be set when a constraint is requested */
731  Assert((constr_flags == 0) ||
732  ((flags & INDEX_CREATE_ADD_CONSTRAINT) != 0));
733  /* partitioned indexes must never be "built" by themselves */
734  Assert(!partitioned || (flags & INDEX_CREATE_SKIP_BUILD));
735 
736  relkind = partitioned ? RELKIND_PARTITIONED_INDEX : RELKIND_INDEX;
737  is_exclusion = (indexInfo->ii_ExclusionOps != NULL);
738 
739  pg_class = table_open(RelationRelationId, RowExclusiveLock);
740 
741  /*
742  * The index will be in the same namespace as its parent table, and is
743  * shared across databases if and only if the parent is. Likewise, it
744  * will use the relfilenode map if and only if the parent does; and it
745  * inherits the parent's relpersistence.
746  */
747  namespaceId = RelationGetNamespace(heapRelation);
748  shared_relation = heapRelation->rd_rel->relisshared;
749  mapped_relation = RelationIsMapped(heapRelation);
750  relpersistence = heapRelation->rd_rel->relpersistence;
751 
752  /*
753  * check parameters
754  */
755  if (indexInfo->ii_NumIndexAttrs < 1)
756  elog(ERROR, "must index at least one column");
757 
758  if (!allow_system_table_mods &&
759  IsSystemRelation(heapRelation) &&
761  ereport(ERROR,
762  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
763  errmsg("user-defined indexes on system catalog tables are not supported")));
764 
765  /*
766  * Btree text_pattern_ops uses text_eq as the equality operator, which is
767  * fine as long as the collation is deterministic; text_eq then reduces to
768  * bitwise equality and so it is semantically compatible with the other
769  * operators and functions in that opclass. But with a nondeterministic
770  * collation, text_eq could yield results that are incompatible with the
771  * actual behavior of the index (which is determined by the opclass's
772  * comparison function). We prevent such problems by refusing creation of
773  * an index with that opclass and a nondeterministic collation.
774  *
775  * The same applies to varchar_pattern_ops and bpchar_pattern_ops. If we
776  * find more cases, we might decide to create a real mechanism for marking
777  * opclasses as incompatible with nondeterminism; but for now, this small
778  * hack suffices.
779  *
780  * Another solution is to use a special operator, not text_eq, as the
781  * equality opclass member; but that is undesirable because it would
782  * prevent index usage in many queries that work fine today.
783  */
784  for (i = 0; i < indexInfo->ii_NumIndexKeyAttrs; i++)
785  {
786  Oid collation = collationObjectId[i];
787  Oid opclass = classObjectId[i];
788 
789  if (collation)
790  {
791  if ((opclass == TEXT_BTREE_PATTERN_OPS_OID ||
792  opclass == VARCHAR_BTREE_PATTERN_OPS_OID ||
793  opclass == BPCHAR_BTREE_PATTERN_OPS_OID) &&
794  !get_collation_isdeterministic(collation))
795  {
796  HeapTuple classtup;
797 
798  classtup = SearchSysCache1(CLAOID, ObjectIdGetDatum(opclass));
799  if (!HeapTupleIsValid(classtup))
800  elog(ERROR, "cache lookup failed for operator class %u", opclass);
801  ereport(ERROR,
802  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
803  errmsg("nondeterministic collations are not supported for operator class \"%s\"",
804  NameStr(((Form_pg_opclass) GETSTRUCT(classtup))->opcname))));
805  ReleaseSysCache(classtup);
806  }
807  }
808  }
809 
810  /*
811  * Concurrent index build on a system catalog is unsafe because we tend to
812  * release locks before committing in catalogs.
813  */
814  if (concurrent &&
815  IsCatalogRelation(heapRelation))
816  ereport(ERROR,
817  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
818  errmsg("concurrent index creation on system catalog tables is not supported")));
819 
820  /*
821  * This case is currently not supported. There's no way to ask for it in
822  * the grammar with CREATE INDEX, but it can happen with REINDEX.
823  */
824  if (concurrent && is_exclusion)
825  ereport(ERROR,
826  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
827  errmsg("concurrent index creation for exclusion constraints is not supported")));
828 
829  /*
830  * We cannot allow indexing a shared relation after initdb (because
831  * there's no way to make the entry in other databases' pg_class).
832  */
833  if (shared_relation && !IsBootstrapProcessingMode())
834  ereport(ERROR,
835  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
836  errmsg("shared indexes cannot be created after initdb")));
837 
838  /*
839  * Shared relations must be in pg_global, too (last-ditch check)
840  */
841  if (shared_relation && tableSpaceId != GLOBALTABLESPACE_OID)
842  elog(ERROR, "shared relations must be placed in pg_global tablespace");
843 
844  /*
845  * Check for duplicate name (both as to the index, and as to the
846  * associated constraint if any). Such cases would fail on the relevant
847  * catalogs' unique indexes anyway, but we prefer to give a friendlier
848  * error message.
849  */
850  if (get_relname_relid(indexRelationName, namespaceId))
851  {
852  if ((flags & INDEX_CREATE_IF_NOT_EXISTS) != 0)
853  {
854  ereport(NOTICE,
855  (errcode(ERRCODE_DUPLICATE_TABLE),
856  errmsg("relation \"%s\" already exists, skipping",
857  indexRelationName)));
858  table_close(pg_class, RowExclusiveLock);
859  return InvalidOid;
860  }
861 
862  ereport(ERROR,
863  (errcode(ERRCODE_DUPLICATE_TABLE),
864  errmsg("relation \"%s\" already exists",
865  indexRelationName)));
866  }
867 
868  if ((flags & INDEX_CREATE_ADD_CONSTRAINT) != 0 &&
870  indexRelationName))
871  {
872  /*
873  * INDEX_CREATE_IF_NOT_EXISTS does not apply here, since the
874  * conflicting constraint is not an index.
875  */
876  ereport(ERROR,
878  errmsg("constraint \"%s\" for relation \"%s\" already exists",
879  indexRelationName, RelationGetRelationName(heapRelation))));
880  }
881 
882  /*
883  * construct tuple descriptor for index tuples
884  */
885  indexTupDesc = ConstructTupleDescriptor(heapRelation,
886  indexInfo,
887  indexColNames,
888  accessMethodObjectId,
889  collationObjectId,
890  classObjectId);
891 
892  /*
893  * Allocate an OID for the index, unless we were told what to use.
894  *
895  * The OID will be the relfilenode as well, so make sure it doesn't
896  * collide with either pg_class OIDs or existing physical files.
897  */
898  if (!OidIsValid(indexRelationId))
899  {
900  /* Use binary-upgrade override for pg_class.oid/relfilenode? */
901  if (IsBinaryUpgrade)
902  {
904  ereport(ERROR,
905  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
906  errmsg("pg_class index OID value not set when in binary upgrade mode")));
907 
908  indexRelationId = binary_upgrade_next_index_pg_class_oid;
910  }
911  else
912  {
913  indexRelationId =
914  GetNewRelFileNode(tableSpaceId, pg_class, relpersistence);
915  }
916  }
917 
918  /*
919  * create the index relation's relcache entry and, if necessary, the
920  * physical disk file. (If we fail further down, it's the smgr's
921  * responsibility to remove the disk file again, if any.)
922  */
923  indexRelation = heap_create(indexRelationName,
924  namespaceId,
925  tableSpaceId,
926  indexRelationId,
927  relFileNode,
928  accessMethodObjectId,
929  indexTupDesc,
930  relkind,
931  relpersistence,
932  shared_relation,
933  mapped_relation,
934  allow_system_table_mods,
935  &relfrozenxid,
936  &relminmxid);
937 
938  Assert(relfrozenxid == InvalidTransactionId);
939  Assert(relminmxid == InvalidMultiXactId);
940  Assert(indexRelationId == RelationGetRelid(indexRelation));
941 
942  /*
943  * Obtain exclusive lock on it. Although no other transactions can see it
944  * until we commit, this prevents deadlock-risk complaints from lock
945  * manager in cases such as CLUSTER.
946  */
947  LockRelation(indexRelation, AccessExclusiveLock);
948 
949  /*
950  * Fill in fields of the index's pg_class entry that are not set correctly
951  * by heap_create.
952  *
953  * XXX should have a cleaner way to create cataloged indexes
954  */
955  indexRelation->rd_rel->relowner = heapRelation->rd_rel->relowner;
956  indexRelation->rd_rel->relam = accessMethodObjectId;
957  indexRelation->rd_rel->relispartition = OidIsValid(parentIndexRelid);
958 
959  /*
960  * store index's pg_class entry
961  */
962  InsertPgClassTuple(pg_class, indexRelation,
963  RelationGetRelid(indexRelation),
964  (Datum) 0,
965  reloptions);
966 
967  /* done with pg_class */
968  table_close(pg_class, RowExclusiveLock);
969 
970  /*
971  * now update the object id's of all the attribute tuple forms in the
972  * index relation's tuple descriptor
973  */
974  InitializeAttributeOids(indexRelation,
975  indexInfo->ii_NumIndexAttrs,
976  indexRelationId);
977 
978  /*
979  * append ATTRIBUTE tuples for the index
980  */
981  AppendAttributeTuples(indexRelation, indexInfo->ii_NumIndexAttrs);
982 
983  /* ----------------
984  * update pg_index
985  * (append INDEX tuple)
986  *
987  * Note that this stows away a representation of "predicate".
988  * (Or, could define a rule to maintain the predicate) --Nels, Feb '92
989  * ----------------
990  */
991  UpdateIndexRelation(indexRelationId, heapRelationId, parentIndexRelid,
992  indexInfo,
993  collationObjectId, classObjectId, coloptions,
994  isprimary, is_exclusion,
995  (constr_flags & INDEX_CONSTR_CREATE_DEFERRABLE) == 0,
996  !concurrent && !invalid,
997  !concurrent);
998 
999  /*
1000  * Register relcache invalidation on the indexes' heap relation, to
1001  * maintain consistency of its index list
1002  */
1003  CacheInvalidateRelcache(heapRelation);
1004 
1005  /* update pg_inherits and the parent's relhassubclass, if needed */
1006  if (OidIsValid(parentIndexRelid))
1007  {
1008  StoreSingleInheritance(indexRelationId, parentIndexRelid, 1);
1009  SetRelationHasSubclass(parentIndexRelid, true);
1010  }
1011 
1012  /*
1013  * Register constraint and dependencies for the index.
1014  *
1015  * If the index is from a CONSTRAINT clause, construct a pg_constraint
1016  * entry. The index will be linked to the constraint, which in turn is
1017  * linked to the table. If it's not a CONSTRAINT, we need to make a
1018  * dependency directly on the table.
1019  *
1020  * We don't need a dependency on the namespace, because there'll be an
1021  * indirect dependency via our parent table.
1022  *
1023  * During bootstrap we can't register any dependencies, and we don't try
1024  * to make a constraint either.
1025  */
1027  {
1028  ObjectAddress myself,
1029  referenced;
1030 
1031  myself.classId = RelationRelationId;
1032  myself.objectId = indexRelationId;
1033  myself.objectSubId = 0;
1034 
1035  if ((flags & INDEX_CREATE_ADD_CONSTRAINT) != 0)
1036  {
1037  char constraintType;
1038  ObjectAddress localaddr;
1039 
1040  if (isprimary)
1041  constraintType = CONSTRAINT_PRIMARY;
1042  else if (indexInfo->ii_Unique)
1043  constraintType = CONSTRAINT_UNIQUE;
1044  else if (is_exclusion)
1045  constraintType = CONSTRAINT_EXCLUSION;
1046  else
1047  {
1048  elog(ERROR, "constraint must be PRIMARY, UNIQUE or EXCLUDE");
1049  constraintType = 0; /* keep compiler quiet */
1050  }
1051 
1052  localaddr = index_constraint_create(heapRelation,
1053  indexRelationId,
1054  parentConstraintId,
1055  indexInfo,
1056  indexRelationName,
1057  constraintType,
1058  constr_flags,
1059  allow_system_table_mods,
1060  is_internal);
1061  if (constraintId)
1062  *constraintId = localaddr.objectId;
1063  }
1064  else
1065  {
1066  bool have_simple_col = false;
1067 
1068  /* Create auto dependencies on simply-referenced columns */
1069  for (i = 0; i < indexInfo->ii_NumIndexAttrs; i++)
1070  {
1071  if (indexInfo->ii_IndexAttrNumbers[i] != 0)
1072  {
1073  referenced.classId = RelationRelationId;
1074  referenced.objectId = heapRelationId;
1075  referenced.objectSubId = indexInfo->ii_IndexAttrNumbers[i];
1076 
1077  recordDependencyOn(&myself, &referenced, DEPENDENCY_AUTO);
1078 
1079  have_simple_col = true;
1080  }
1081  }
1082 
1083  /*
1084  * If there are no simply-referenced columns, give the index an
1085  * auto dependency on the whole table. In most cases, this will
1086  * be redundant, but it might not be if the index expressions and
1087  * predicate contain no Vars or only whole-row Vars.
1088  */
1089  if (!have_simple_col)
1090  {
1091  referenced.classId = RelationRelationId;
1092  referenced.objectId = heapRelationId;
1093  referenced.objectSubId = 0;
1094 
1095  recordDependencyOn(&myself, &referenced, DEPENDENCY_AUTO);
1096  }
1097  }
1098 
1099  /*
1100  * If this is an index partition, create partition dependencies on
1101  * both the parent index and the table. (Note: these must be *in
1102  * addition to*, not instead of, all other dependencies. Otherwise
1103  * we'll be short some dependencies after DETACH PARTITION.)
1104  */
1105  if (OidIsValid(parentIndexRelid))
1106  {
1107  referenced.classId = RelationRelationId;
1108  referenced.objectId = parentIndexRelid;
1109  referenced.objectSubId = 0;
1110 
1111  recordDependencyOn(&myself, &referenced, DEPENDENCY_PARTITION_PRI);
1112 
1113  referenced.classId = RelationRelationId;
1114  referenced.objectId = heapRelationId;
1115  referenced.objectSubId = 0;
1116 
1117  recordDependencyOn(&myself, &referenced, DEPENDENCY_PARTITION_SEC);
1118  }
1119 
1120  /* Store dependency on collations */
1121  /* The default collation is pinned, so don't bother recording it */
1122  for (i = 0; i < indexInfo->ii_NumIndexKeyAttrs; i++)
1123  {
1124  if (OidIsValid(collationObjectId[i]) &&
1125  collationObjectId[i] != DEFAULT_COLLATION_OID)
1126  {
1127  referenced.classId = CollationRelationId;
1128  referenced.objectId = collationObjectId[i];
1129  referenced.objectSubId = 0;
1130 
1131  recordDependencyOn(&myself, &referenced, DEPENDENCY_NORMAL);
1132  }
1133  }
1134 
1135  /* Store dependency on operator classes */
1136  for (i = 0; i < indexInfo->ii_NumIndexKeyAttrs; i++)
1137  {
1138  referenced.classId = OperatorClassRelationId;
1139  referenced.objectId = classObjectId[i];
1140  referenced.objectSubId = 0;
1141 
1142  recordDependencyOn(&myself, &referenced, DEPENDENCY_NORMAL);
1143  }
1144 
1145  /* Store dependencies on anything mentioned in index expressions */
1146  if (indexInfo->ii_Expressions)
1147  {
1149  (Node *) indexInfo->ii_Expressions,
1150  heapRelationId,
1152  DEPENDENCY_AUTO, false);
1153  }
1154 
1155  /* Store dependencies on anything mentioned in predicate */
1156  if (indexInfo->ii_Predicate)
1157  {
1159  (Node *) indexInfo->ii_Predicate,
1160  heapRelationId,
1162  DEPENDENCY_AUTO, false);
1163  }
1164  }
1165  else
1166  {
1167  /* Bootstrap mode - assert we weren't asked for constraint support */
1168  Assert((flags & INDEX_CREATE_ADD_CONSTRAINT) == 0);
1169  }
1170 
1171  /* Post creation hook for new index */
1172  InvokeObjectPostCreateHookArg(RelationRelationId,
1173  indexRelationId, 0, is_internal);
1174 
1175  /*
1176  * Advance the command counter so that we can see the newly-entered
1177  * catalog tuples for the index.
1178  */
1180 
1181  /*
1182  * In bootstrap mode, we have to fill in the index strategy structure with
1183  * information from the catalogs. If we aren't bootstrapping, then the
1184  * relcache entry has already been rebuilt thanks to sinval update during
1185  * CommandCounterIncrement.
1186  */
1188  RelationInitIndexAccessInfo(indexRelation);
1189  else
1190  Assert(indexRelation->rd_indexcxt != NULL);
1191 
1192  indexRelation->rd_index->indnkeyatts = indexInfo->ii_NumIndexKeyAttrs;
1193 
1194  /*
1195  * If this is bootstrap (initdb) time, then we don't actually fill in the
1196  * index yet. We'll be creating more indexes and classes later, so we
1197  * delay filling them in until just before we're done with bootstrapping.
1198  * Similarly, if the caller specified to skip the build then filling the
1199  * index is delayed till later (ALTER TABLE can save work in some cases
1200  * with this). Otherwise, we call the AM routine that constructs the
1201  * index.
1202  */
1204  {
1205  index_register(heapRelationId, indexRelationId, indexInfo);
1206  }
1207  else if ((flags & INDEX_CREATE_SKIP_BUILD) != 0)
1208  {
1209  /*
1210  * Caller is responsible for filling the index later on. However,
1211  * we'd better make sure that the heap relation is correctly marked as
1212  * having an index.
1213  */
1214  index_update_stats(heapRelation,
1215  true,
1216  -1.0);
1217  /* Make the above update visible */
1219  }
1220  else
1221  {
1222  index_build(heapRelation, indexRelation, indexInfo, false, true);
1223  }
1224 
1225  /*
1226  * Close the index; but we keep the lock that we acquired above until end
1227  * of transaction. Closing the heap is caller's responsibility.
1228  */
1229  index_close(indexRelation, NoLock);
1230 
1231  return indexRelationId;
1232 }
bool IsCatalogRelation(Relation relation)
Definition: catalog.c:100
static void index_update_stats(Relation rel, bool hasindex, double reltuples)
Definition: index.c:2586
bool ConstraintNameIsUsed(ConstraintCategory conCat, Oid objId, const char *conname)
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:133
#define GETSTRUCT(TUP)
Definition: htup_details.h:655
static void UpdateIndexRelation(Oid indexoid, Oid heapoid, Oid parentIndexId, IndexInfo *indexInfo, Oid *collationOids, Oid *classOids, int16 *coloptions, bool primary, bool isexclusion, bool immediate, bool isvalid, bool isready)
Definition: index.c:529
List * ii_Predicate
Definition: execnodes.h:162
bool IsSystemRelation(Relation relation)
Definition: catalog.c:70
uint32 TransactionId
Definition: c.h:507
#define INDEX_CREATE_IF_NOT_EXISTS
Definition: index.h:51
#define INDEX_CREATE_INVALID
Definition: index.h:53
static void InitializeAttributeOids(Relation indexRelation, int numatts, Oid indexoid)
Definition: index.c:471
Oid binary_upgrade_next_index_pg_class_oid
Definition: index.c:85
Definition: nodes.h:525
bool get_collation_isdeterministic(Oid colloid)
Definition: lsyscache.c:942
int errcode(int sqlerrcode)
Definition: elog.c:570
void recordDependencyOn(const ObjectAddress *depender, const ObjectAddress *referenced, DependencyType behavior)
Definition: pg_depend.c:43
Form_pg_class rd_rel
Definition: rel.h:83
unsigned int Oid
Definition: postgres_ext.h:31
#define OidIsValid(objectId)
Definition: c.h:638
bool IsBinaryUpgrade
Definition: globals.c:110
char relkind
Definition: pg_class.h:81
void SetRelationHasSubclass(Oid relationId, bool relhassubclass)
Definition: tablecmds.c:2832
void InsertPgClassTuple(Relation pg_class_desc, Relation new_rel_desc, Oid new_rel_oid, Datum relacl, Datum reloptions)
Definition: heap.c:848
Form_pg_index rd_index
Definition: rel.h:143
#define ObjectIdGetDatum(X)
Definition: postgres.h:507
#define ERROR
Definition: elog.h:43
int ii_NumIndexKeyAttrs
Definition: execnodes.h:158
char relpersistence
Definition: pg_class.h:78
Oid get_relname_relid(const char *relname, Oid relnamespace)
Definition: lsyscache.c:1687
#define NoLock
Definition: lockdefs.h:34
#define IsNormalProcessingMode()
Definition: miscadmin.h:376
#define RowExclusiveLock
Definition: lockdefs.h:38
#define InvalidTransactionId
Definition: transam.h:31
#define RelationGetRelationName(relation)
Definition: rel.h:453
static TupleDesc ConstructTupleDescriptor(Relation heapRelation, IndexInfo *indexInfo, List *indexColNames, Oid accessMethodObjectId, Oid *collationObjectId, Oid *classObjectId)
Definition: index.c:267
void StoreSingleInheritance(Oid relationId, Oid parentOid, int32 seqNumber)
Definition: pg_inherits.c:417
void index_register(Oid heap, Oid ind, IndexInfo *indexInfo)
Definition: bootstrap.c:1077
#define ereport(elevel, rest)
Definition: elog.h:141
static void AppendAttributeTuples(Relation indexRelation, int numatts)
Definition: index.c:489
#define RelationIsMapped(relation)
Definition: rel.h:468
HeapTuple SearchSysCache1(int cacheId, Datum key1)
Definition: syscache.c:1124
uintptr_t Datum
Definition: postgres.h:367
void CommandCounterIncrement(void)
Definition: xact.c:1003
void ReleaseSysCache(HeapTuple tuple)
Definition: syscache.c:1172
int ii_NumIndexAttrs
Definition: execnodes.h:157
#define InvalidMultiXactId
Definition: multixact.h:23
#define InvokeObjectPostCreateHookArg(classId, objectId, subId, is_internal)
Definition: objectaccess.h:147
#define INDEX_CREATE_IS_PRIMARY
Definition: index.h:47
#define InvalidOid
Definition: postgres_ext.h:36
#define INDEX_CREATE_CONCURRENT
Definition: index.h:50
TransactionId relminmxid
Definition: pg_class.h:126
#define NOTICE
Definition: elog.h:37
TransactionId MultiXactId
Definition: c.h:517
bool ii_Unique
Definition: execnodes.h:170
void index_build(Relation heapRelation, Relation indexRelation, IndexInfo *indexInfo, bool isreindex, bool parallel)
Definition: index.c:2734
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
List * ii_Expressions
Definition: execnodes.h:160
#define Assert(condition)
Definition: c.h:732
void recordDependencyOnSingleRelExpr(const ObjectAddress *depender, Node *expr, Oid relId, DependencyType behavior, DependencyType self_behavior, bool reverse_self)
Definition: dependency.c:1629
Relation heap_create(const char *relname, Oid relnamespace, Oid reltablespace, Oid relid, Oid relfilenode, Oid accessmtd, TupleDesc tupDesc, char relkind, char relpersistence, bool shared_relation, bool mapped_relation, bool allow_system_table_mods, TransactionId *relfrozenxid, MultiXactId *relminmxid)
Definition: heap.c:295
Oid GetNewRelFileNode(Oid reltablespace, Relation pg_class, char relpersistence)
Definition: catalog.c:386
void index_close(Relation relation, LOCKMODE lockmode)
Definition: indexam.c:152
void CacheInvalidateRelcache(Relation relation)
Definition: inval.c:1270
void RelationInitIndexAccessInfo(Relation relation)
Definition: relcache.c:1362
#define IsBootstrapProcessingMode()
Definition: miscadmin.h:374
#define INDEX_CREATE_SKIP_BUILD
Definition: index.h:49
#define AccessExclusiveLock
Definition: lockdefs.h:45
#define INDEX_CREATE_PARTITIONED
Definition: index.h:52
Oid * ii_ExclusionOps
Definition: execnodes.h:164
int errmsg(const char *fmt,...)
Definition: elog.c:784
TransactionId relfrozenxid
Definition: pg_class.h:123
#define elog(elevel,...)
Definition: elog.h:226
MemoryContext rd_indexcxt
Definition: rel.h:155
int i
void LockRelation(Relation relation, LOCKMODE lockmode)
Definition: lmgr.c:216
#define NameStr(name)
Definition: c.h:609
AttrNumber ii_IndexAttrNumbers[INDEX_MAX_KEYS]
Definition: execnodes.h:159
#define INDEX_CREATE_ADD_CONSTRAINT
Definition: index.h:48
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39
FormData_pg_opclass * Form_pg_opclass
Definition: pg_opclass.h:83
#define ERRCODE_DUPLICATE_OBJECT
Definition: streamutil.c:33
#define RelationGetRelid(relation)
Definition: rel.h:419
#define INDEX_CONSTR_CREATE_DEFERRABLE
Definition: index.h:76
ObjectAddress index_constraint_create(Relation heapRelation, Oid indexRelationId, Oid parentConstraintId, IndexInfo *indexInfo, const char *constraintName, char constraintType, bits16 constr_flags, bool allow_system_table_mods, bool is_internal)
Definition: index.c:1782
#define RelationGetNamespace(relation)
Definition: rel.h:460

◆ index_drop()

void index_drop ( Oid  indexId,
bool  concurrent,
bool  concurrent_lock_mode 
)

Definition at line 2001 of file index.c.

References AccessExclusiveLock, CacheInvalidateRelcache(), CatalogTupleDelete(), CheckTableNotInUse(), CommitTransactionCommand(), LockRelId::dbId, DeleteAttributeTuples(), DeleteInheritsTuple(), DeleteRelationTuple(), elog, ereport, errcode(), errmsg(), ERROR, GetTopTransactionIdIfAny(), heap_attisnull(), HeapTupleIsValid, index_close(), index_concurrently_set_dead(), INDEX_DROP_CLEAR_VALID, index_open(), index_set_state_flags(), IndexGetRelation(), INDEXRELID, InvalidOid, InvalidTransactionId, LockRelationIdForSession(), LockInfoData::lockRelId, NoLock, ObjectIdGetDatum, PopActiveSnapshot(), RelationData::rd_lockInfo, RelationData::rd_rel, RelationDropStorage(), RelationForgetRelation(), RelationGetDescr, ReleaseSysCache(), LockRelId::relId, RemoveStatistics(), RowExclusiveLock, SearchSysCache1(), SET_LOCKTAG_RELATION, ShareUpdateExclusiveLock, StartTransactionCommand(), HeapTupleData::t_self, table_close(), table_open(), TransferPredicateLocksToHeapRelation(), UnlockRelationIdForSession(), and WaitForLockers().

Referenced by doDeletion().

2002 {
2003  Oid heapId;
2004  Relation userHeapRelation;
2005  Relation userIndexRelation;
2006  Relation indexRelation;
2007  HeapTuple tuple;
2008  bool hasexprs;
2009  LockRelId heaprelid,
2010  indexrelid;
2011  LOCKTAG heaplocktag;
2012  LOCKMODE lockmode;
2013 
2014  /*
2015  * To drop an index safely, we must grab exclusive lock on its parent
2016  * table. Exclusive lock on the index alone is insufficient because
2017  * another backend might be about to execute a query on the parent table.
2018  * If it relies on a previously cached list of index OIDs, then it could
2019  * attempt to access the just-dropped index. We must therefore take a
2020  * table lock strong enough to prevent all queries on the table from
2021  * proceeding until we commit and send out a shared-cache-inval notice
2022  * that will make them update their index lists.
2023  *
2024  * In the concurrent case we avoid this requirement by disabling index use
2025  * in multiple steps and waiting out any transactions that might be using
2026  * the index, so we don't need exclusive lock on the parent table. Instead
2027  * we take ShareUpdateExclusiveLock, to ensure that two sessions aren't
2028  * doing CREATE/DROP INDEX CONCURRENTLY on the same index. (We will get
2029  * AccessExclusiveLock on the index below, once we're sure nobody else is
2030  * using it.)
2031  */
2032  heapId = IndexGetRelation(indexId, false);
2033  lockmode = (concurrent || concurrent_lock_mode) ? ShareUpdateExclusiveLock : AccessExclusiveLock;
2034  userHeapRelation = table_open(heapId, lockmode);
2035  userIndexRelation = index_open(indexId, lockmode);
2036 
2037  /*
2038  * We might still have open queries using it in our own session, which the
2039  * above locking won't prevent, so test explicitly.
2040  */
2041  CheckTableNotInUse(userIndexRelation, "DROP INDEX");
2042 
2043  /*
2044  * Drop Index Concurrently is more or less the reverse process of Create
2045  * Index Concurrently.
2046  *
2047  * First we unset indisvalid so queries starting afterwards don't use the
2048  * index to answer queries anymore. We have to keep indisready = true so
2049  * transactions that are still scanning the index can continue to see
2050  * valid index contents. For instance, if they are using READ COMMITTED
2051  * mode, and another transaction makes changes and commits, they need to
2052  * see those new tuples in the index.
2053  *
2054  * After all transactions that could possibly have used the index for
2055  * queries end, we can unset indisready and indislive, then wait till
2056  * nobody could be touching it anymore. (Note: we need indislive because
2057  * this state must be distinct from the initial state during CREATE INDEX
2058  * CONCURRENTLY, which has indislive true while indisready and indisvalid
2059  * are false. That's because in that state, transactions must examine the
2060  * index for HOT-safety decisions, while in this state we don't want them
2061  * to open it at all.)
2062  *
2063  * Since all predicate locks on the index are about to be made invalid, we
2064  * must promote them to predicate locks on the heap. In the
2065  * non-concurrent case we can just do that now. In the concurrent case
2066  * it's a bit trickier. The predicate locks must be moved when there are
2067  * no index scans in progress on the index and no more can subsequently
2068  * start, so that no new predicate locks can be made on the index. Also,
2069  * they must be moved before heap inserts stop maintaining the index, else
2070  * the conflict with the predicate lock on the index gap could be missed
2071  * before the lock on the heap relation is in place to detect a conflict
2072  * based on the heap tuple insert.
2073  */
2074  if (concurrent)
2075  {
2076  /*
2077  * We must commit our transaction in order to make the first pg_index
2078  * state update visible to other sessions. If the DROP machinery has
2079  * already performed any other actions (removal of other objects,
2080  * pg_depend entries, etc), the commit would make those actions
2081  * permanent, which would leave us with inconsistent catalog state if
2082  * we fail partway through the following sequence. Since DROP INDEX
2083  * CONCURRENTLY is restricted to dropping just one index that has no
2084  * dependencies, we should get here before anything's been done ---
2085  * but let's check that to be sure. We can verify that the current
2086  * transaction has not executed any transactional updates by checking
2087  * that no XID has been assigned.
2088  */
2090  ereport(ERROR,
2091  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
2092  errmsg("DROP INDEX CONCURRENTLY must be first action in transaction")));
2093 
2094  /*
2095  * Mark index invalid by updating its pg_index entry
2096  */
2098 
2099  /*
2100  * Invalidate the relcache for the table, so that after this commit
2101  * all sessions will refresh any cached plans that might reference the
2102  * index.
2103  */
2104  CacheInvalidateRelcache(userHeapRelation);
2105 
2106  /* save lockrelid and locktag for below, then close but keep locks */
2107  heaprelid = userHeapRelation->rd_lockInfo.lockRelId;
2108  SET_LOCKTAG_RELATION(heaplocktag, heaprelid.dbId, heaprelid.relId);
2109  indexrelid = userIndexRelation->rd_lockInfo.lockRelId;
2110 
2111  table_close(userHeapRelation, NoLock);
2112  index_close(userIndexRelation, NoLock);
2113 
2114  /*
2115  * We must commit our current transaction so that the indisvalid
2116  * update becomes visible to other transactions; then start another.
2117  * Note that any previously-built data structures are lost in the
2118  * commit. The only data we keep past here are the relation IDs.
2119  *
2120  * Before committing, get a session-level lock on the table, to ensure
2121  * that neither it nor the index can be dropped before we finish. This
2122  * cannot block, even if someone else is waiting for access, because
2123  * we already have the same lock within our transaction.
2124  */
2127 
2131 
2132  /*
2133  * Now we must wait until no running transaction could be using the
2134  * index for a query. Use AccessExclusiveLock here to check for
2135  * running transactions that hold locks of any kind on the table. Note
2136  * we do not need to worry about xacts that open the table for reading
2137  * after this point; they will see the index as invalid when they open
2138  * the relation.
2139  *
2140  * Note: the reason we use actual lock acquisition here, rather than
2141  * just checking the ProcArray and sleeping, is that deadlock is
2142  * possible if one of the transactions in question is blocked trying
2143  * to acquire an exclusive lock on our table. The lock code will
2144  * detect deadlock and error out properly.
2145  */
2146  WaitForLockers(heaplocktag, AccessExclusiveLock, true);
2147 
2148  /* Finish invalidation of index and mark it as dead */
2149  index_concurrently_set_dead(heapId, indexId);
2150 
2151  /*
2152  * Again, commit the transaction to make the pg_index update visible
2153  * to other sessions.
2154  */
2157 
2158  /*
2159  * Wait till every transaction that saw the old index state has
2160  * finished.
2161  */
2162  WaitForLockers(heaplocktag, AccessExclusiveLock, true);
2163 
2164  /*
2165  * Re-open relations to allow us to complete our actions.
2166  *
2167  * At this point, nothing should be accessing the index, but lets
2168  * leave nothing to chance and grab AccessExclusiveLock on the index
2169  * before the physical deletion.
2170  */
2171  userHeapRelation = table_open(heapId, ShareUpdateExclusiveLock);
2172  userIndexRelation = index_open(indexId, AccessExclusiveLock);
2173  }
2174  else
2175  {
2176  /* Not concurrent, so just transfer predicate locks and we're good */
2177  TransferPredicateLocksToHeapRelation(userIndexRelation);
2178  }
2179 
2180  /*
2181  * Schedule physical removal of the files (if any)
2182  */
2183  if (userIndexRelation->rd_rel->relkind != RELKIND_PARTITIONED_INDEX)
2184  RelationDropStorage(userIndexRelation);
2185 
2186  /*
2187  * Close and flush the index's relcache entry, to ensure relcache doesn't
2188  * try to rebuild it while we're deleting catalog entries. We keep the
2189  * lock though.
2190  */
2191  index_close(userIndexRelation, NoLock);
2192 
2193  RelationForgetRelation(indexId);
2194 
2195  /*
2196  * fix INDEX relation, and check for expressional index
2197  */
2198  indexRelation = table_open(IndexRelationId, RowExclusiveLock);
2199 
2200  tuple = SearchSysCache1(INDEXRELID, ObjectIdGetDatum(indexId));
2201  if (!HeapTupleIsValid(tuple))
2202  elog(ERROR, "cache lookup failed for index %u", indexId);
2203 
2204  hasexprs = !heap_attisnull(tuple, Anum_pg_index_indexprs,
2205  RelationGetDescr(indexRelation));
2206 
2207  CatalogTupleDelete(indexRelation, &tuple->t_self);
2208 
2209  ReleaseSysCache(tuple);
2210  table_close(indexRelation, RowExclusiveLock);
2211 
2212  /*
2213  * if it has any expression columns, we might have stored statistics about
2214  * them.
2215  */
2216  if (hasexprs)
2217  RemoveStatistics(indexId, 0);
2218 
2219  /*
2220  * fix ATTRIBUTE relation
2221  */
2222  DeleteAttributeTuples(indexId);
2223 
2224  /*
2225  * fix RELATION relation
2226  */
2227  DeleteRelationTuple(indexId);
2228 
2229  /*
2230  * fix INHERITS relation
2231  */
2232  DeleteInheritsTuple(indexId, InvalidOid);
2233 
2234  /*
2235  * We are presently too lazy to attempt to compute the new correct value
2236  * of relhasindex (the next VACUUM will fix it if necessary). So there is
2237  * no need to update the pg_class tuple for the owning relation. But we
2238  * must send out a shared-cache-inval notice on the owning relation to
2239  * ensure other backends update their relcache lists of indexes. (In the
2240  * concurrent case, this is redundant but harmless.)
2241  */
2242  CacheInvalidateRelcache(userHeapRelation);
2243 
2244  /*
2245  * Close owning rel, but keep lock
2246  */
2247  table_close(userHeapRelation, NoLock);
2248 
2249  /*
2250  * Release the session locks before we go.
2251  */
2252  if (concurrent)
2253  {
2256  }
2257 }
void WaitForLockers(LOCKTAG heaplocktag, LOCKMODE lockmode, bool progress)
Definition: lmgr.c:942
Oid IndexGetRelation(Oid indexId, bool missing_ok)
Definition: index.c:3320
LockRelId lockRelId
Definition: rel.h:43
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:133
#define RelationGetDescr(relation)
Definition: rel.h:445
int LOCKMODE
Definition: lockdefs.h:26
void index_set_state_flags(Oid indexId, IndexStateFlagsAction action)
Definition: index.c:3241
void CommitTransactionCommand(void)
Definition: xact.c:2895
Oid dbId
Definition: rel.h:38
Definition: lock.h:164
bool DeleteInheritsTuple(Oid inhrelid, Oid inhparent)
Definition: pg_inherits.c:454
int errcode(int sqlerrcode)
Definition: elog.c:570
bool heap_attisnull(HeapTuple tup, int attnum, TupleDesc tupleDesc)
Definition: heaptuple.c:359
void RelationForgetRelation(Oid rid)
Definition: relcache.c:2703
void PopActiveSnapshot(void)
Definition: snapmgr.c:814
void CatalogTupleDelete(Relation heapRel, ItemPointer tid)
Definition: indexing.c:269
Form_pg_class rd_rel
Definition: rel.h:83
unsigned int Oid
Definition: postgres_ext.h:31
void UnlockRelationIdForSession(LockRelId *relid, LOCKMODE lockmode)
Definition: lmgr.c:382
#define ObjectIdGetDatum(X)
Definition: postgres.h:507
#define ERROR
Definition: elog.h:43
Definition: rel.h:35
void LockRelationIdForSession(LockRelId *relid, LOCKMODE lockmode)
Definition: lmgr.c:369
ItemPointerData t_self
Definition: htup.h:65
#define SET_LOCKTAG_RELATION(locktag, dboid, reloid)
Definition: lock.h:181
#define NoLock
Definition: lockdefs.h:34
LockInfoData rd_lockInfo
Definition: rel.h:86
#define RowExclusiveLock
Definition: lockdefs.h:38
#define InvalidTransactionId
Definition: transam.h:31
TransactionId GetTopTransactionIdIfAny(void)
Definition: xact.c:410
void CheckTableNotInUse(Relation rel, const char *stmt)
Definition: tablecmds.c:3416
#define ereport(elevel, rest)
Definition: elog.h:141
void TransferPredicateLocksToHeapRelation(Relation relation)
Definition: predicate.c:3097
HeapTuple SearchSysCache1(int cacheId, Datum key1)
Definition: syscache.c:1124
void RelationDropStorage(Relation rel)
Definition: storage.c:148
void ReleaseSysCache(HeapTuple tuple)
Definition: syscache.c:1172
#define InvalidOid
Definition: postgres_ext.h:36
void DeleteRelationTuple(Oid relid)
Definition: heap.c:1472
#define ShareUpdateExclusiveLock
Definition: lockdefs.h:39
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
void StartTransactionCommand(void)
Definition: xact.c:2794
void DeleteAttributeTuples(Oid relid)
Definition: heap.c:1501
void index_close(Relation relation, LOCKMODE lockmode)
Definition: indexam.c:152
void CacheInvalidateRelcache(Relation relation)
Definition: inval.c:1270
void RemoveStatistics(Oid relid, AttrNumber attnum)
Definition: heap.c:3090
#define AccessExclusiveLock
Definition: lockdefs.h:45
int errmsg(const char *fmt,...)
Definition: elog.c:784
#define elog(elevel,...)
Definition: elog.h:226
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39
void index_concurrently_set_dead(Oid heapId, Oid indexId)
Definition: index.c:1721
Relation index_open(Oid relationId, LOCKMODE lockmode)
Definition: indexam.c:126
Oid relId
Definition: rel.h:37

◆ index_set_state_flags()

void index_set_state_flags ( Oid  indexId,
IndexStateFlagsAction  action 
)

Definition at line 3241 of file index.c.

References Assert, elog, ERROR, GETSTRUCT, GetTopTransactionIdIfAny(), heap_inplace_update(), HeapTupleIsValid, INDEX_CREATE_SET_READY, INDEX_CREATE_SET_VALID, INDEX_DROP_CLEAR_VALID, INDEX_DROP_SET_DEAD, INDEXRELID, InvalidTransactionId, ObjectIdGetDatum, RowExclusiveLock, SearchSysCacheCopy1, table_close(), and table_open().

Referenced by DefineIndex(), index_concurrently_build(), index_concurrently_set_dead(), and index_drop().

3242 {
3243  Relation pg_index;
3244  HeapTuple indexTuple;
3245  Form_pg_index indexForm;
3246 
3247  /* Assert that current xact hasn't done any transactional updates */
3249 
3250  /* Open pg_index and fetch a writable copy of the index's tuple */
3251  pg_index = table_open(IndexRelationId, RowExclusiveLock);
3252 
3253  indexTuple = SearchSysCacheCopy1(INDEXRELID,
3254  ObjectIdGetDatum(indexId));
3255  if (!HeapTupleIsValid(indexTuple))
3256  elog(ERROR, "cache lookup failed for index %u", indexId);
3257  indexForm = (Form_pg_index) GETSTRUCT(indexTuple);
3258 
3259  /* Perform the requested state change on the copy */
3260  switch (action)
3261  {
3263  /* Set indisready during a CREATE INDEX CONCURRENTLY sequence */
3264  Assert(indexForm->indislive);
3265  Assert(!indexForm->indisready);
3266  Assert(!indexForm->indisvalid);
3267  indexForm->indisready = true;
3268  break;
3270  /* Set indisvalid during a CREATE INDEX CONCURRENTLY sequence */
3271  Assert(indexForm->indislive);
3272  Assert(indexForm->indisready);
3273  Assert(!indexForm->indisvalid);
3274  indexForm->indisvalid = true;
3275  break;
3277 
3278  /*
3279  * Clear indisvalid during a DROP INDEX CONCURRENTLY sequence
3280  *
3281  * If indisready == true we leave it set so the index still gets
3282  * maintained by active transactions. We only need to ensure that
3283  * indisvalid is false. (We don't assert that either is initially
3284  * true, though, since we want to be able to retry a DROP INDEX
3285  * CONCURRENTLY that failed partway through.)
3286  *
3287  * Note: the CLUSTER logic assumes that indisclustered cannot be
3288  * set on any invalid index, so clear that flag too.
3289  */
3290  indexForm->indisvalid = false;
3291  indexForm->indisclustered = false;
3292  break;
3293  case INDEX_DROP_SET_DEAD:
3294 
3295  /*
3296  * Clear indisready/indislive during DROP INDEX CONCURRENTLY
3297  *
3298  * We clear both indisready and indislive, because we not only
3299  * want to stop updates, we want to prevent sessions from touching
3300  * the index at all.
3301  */
3302  Assert(!indexForm->indisvalid);
3303  indexForm->indisready = false;
3304  indexForm->indislive = false;
3305  break;
3306  }
3307 
3308  /* ... and write it back in-place */
3309  heap_inplace_update(pg_index, indexTuple);
3310 
3311  table_close(pg_index, RowExclusiveLock);
3312 }
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:133
#define GETSTRUCT(TUP)
Definition: htup_details.h:655
#define ObjectIdGetDatum(X)
Definition: postgres.h:507
#define ERROR
Definition: elog.h:43
#define RowExclusiveLock
Definition: lockdefs.h:38
#define InvalidTransactionId
Definition: transam.h:31
TransactionId GetTopTransactionIdIfAny(void)
Definition: xact.c:410
FormData_pg_index * Form_pg_index
Definition: pg_index.h:66
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
#define Assert(condition)
Definition: c.h:732
#define SearchSysCacheCopy1(cacheId, key1)
Definition: syscache.h:174
void heap_inplace_update(Relation relation, HeapTuple tuple)
Definition: heapam.c:5707
#define elog(elevel,...)
Definition: elog.h:226
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39

◆ IndexGetRelation()

Oid IndexGetRelation ( Oid  indexId,
bool  missing_ok 
)

Definition at line 3320 of file index.c.

References Assert, elog, ERROR, GETSTRUCT, HeapTupleIsValid, INDEXRELID, InvalidOid, ObjectIdGetDatum, ReleaseSysCache(), and SearchSysCache1().

Referenced by ATExecDetachPartition(), ATPostAlterTypeCleanup(), brin_desummarize_range(), brin_summarize_range(), bringetbitmap(), brinvacuumcleanup(), bt_index_check_internal(), CheckIndexCompatible(), CreateTrigger(), index_drop(), RangeVarCallbackForAttachIndex(), RangeVarCallbackForDropRelation(), RangeVarCallbackForReindexIndex(), reindex_index(), and ReindexRelationConcurrently().

3321 {
3322  HeapTuple tuple;
3324  Oid result;
3325 
3326  tuple = SearchSysCache1(INDEXRELID, ObjectIdGetDatum(indexId));
3327  if (!HeapTupleIsValid(tuple))
3328  {
3329  if (missing_ok)
3330  return InvalidOid;
3331  elog(ERROR, "cache lookup failed for index %u", indexId);
3332  }
3333  index = (Form_pg_index) GETSTRUCT(tuple);
3334  Assert(index->indexrelid == indexId);
3335 
3336  result = index->indrelid;
3337  ReleaseSysCache(tuple);
3338  return result;
3339 }
#define GETSTRUCT(TUP)
Definition: htup_details.h:655
unsigned int Oid
Definition: postgres_ext.h:31
Definition: type.h:89
#define ObjectIdGetDatum(X)
Definition: postgres.h:507
#define ERROR
Definition: elog.h:43
FormData_pg_index * Form_pg_index
Definition: pg_index.h:66
HeapTuple SearchSysCache1(int cacheId, Datum key1)
Definition: syscache.c:1124
void ReleaseSysCache(HeapTuple tuple)
Definition: syscache.c:1172
#define InvalidOid
Definition: postgres_ext.h:36
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
#define Assert(condition)
Definition: c.h:732
#define elog(elevel,...)
Definition: elog.h:226

◆ IndexSetParentIndex()

void IndexSetParentIndex ( Relation  idx,
Oid  parentOid 
)

Definition at line 3339 of file indexcmds.c.

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

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

3340 {
3341  Relation pg_inherits;
3342  ScanKeyData key[2];
3343  SysScanDesc scan;
3344  Oid partRelid = RelationGetRelid(partitionIdx);
3345  HeapTuple tuple;
3346  bool fix_dependencies;
3347 
3348  /* Make sure this is an index */
3349  Assert(partitionIdx->rd_rel->relkind == RELKIND_INDEX ||
3350  partitionIdx->rd_rel->relkind == RELKIND_PARTITIONED_INDEX);
3351 
3352  /*
3353  * Scan pg_inherits for rows linking our index to some parent.
3354  */
3355  pg_inherits = relation_open(InheritsRelationId, RowExclusiveLock);
3356  ScanKeyInit(&key[0],
3357  Anum_pg_inherits_inhrelid,
3358  BTEqualStrategyNumber, F_OIDEQ,
3359  ObjectIdGetDatum(partRelid));
3360  ScanKeyInit(&key[1],
3361  Anum_pg_inherits_inhseqno,
3362  BTEqualStrategyNumber, F_INT4EQ,
3363  Int32GetDatum(1));
3364  scan = systable_beginscan(pg_inherits, InheritsRelidSeqnoIndexId, true,
3365  NULL, 2, key);
3366  tuple = systable_getnext(scan);
3367 
3368  if (!HeapTupleIsValid(tuple))
3369  {
3370  if (parentOid == InvalidOid)
3371  {
3372  /*
3373  * No pg_inherits row, and no parent wanted: nothing to do in this
3374  * case.
3375  */
3376  fix_dependencies = false;
3377  }
3378  else
3379  {
3380  Datum values[Natts_pg_inherits];
3381  bool isnull[Natts_pg_inherits];
3382 
3383  /*
3384  * No pg_inherits row exists, and we want a parent for this index,
3385  * so insert it.
3386  */
3387  values[Anum_pg_inherits_inhrelid - 1] = ObjectIdGetDatum(partRelid);
3388  values[Anum_pg_inherits_inhparent - 1] =
3389  ObjectIdGetDatum(parentOid);
3390  values[Anum_pg_inherits_inhseqno - 1] = Int32GetDatum(1);
3391  memset(isnull, false, sizeof(isnull));
3392 
3393  tuple = heap_form_tuple(RelationGetDescr(pg_inherits),
3394  values, isnull);
3395  CatalogTupleInsert(pg_inherits, tuple);
3396 
3397  fix_dependencies = true;
3398  }
3399  }
3400  else
3401  {
3402  Form_pg_inherits inhForm = (Form_pg_inherits) GETSTRUCT(tuple);
3403 
3404  if (parentOid == InvalidOid)
3405  {
3406  /*
3407  * There exists a pg_inherits row, which we want to clear; do so.
3408  */
3409  CatalogTupleDelete(pg_inherits, &tuple->t_self);
3410  fix_dependencies = true;
3411  }
3412  else
3413  {
3414  /*
3415  * A pg_inherits row exists. If it's the same we want, then we're
3416  * good; if it differs, that amounts to a corrupt catalog and
3417  * should not happen.
3418  */
3419  if (inhForm->inhparent != parentOid)
3420  {
3421  /* unexpected: we should not get called in this case */
3422  elog(ERROR, "bogus pg_inherit row: inhrelid %u inhparent %u",
3423  inhForm->inhrelid, inhForm->inhparent);
3424  }
3425 
3426  /* already in the right state */
3427  fix_dependencies = false;
3428  }
3429  }
3430 
3431  /* done with pg_inherits */
3432  systable_endscan(scan);
3433  relation_close(pg_inherits, RowExclusiveLock);
3434 
3435  /* set relhassubclass if an index partition has been added to the parent */
3436  if (OidIsValid(parentOid))
3437  SetRelationHasSubclass(parentOid, true);
3438 
3439  /* set relispartition correctly on the partition */
3440  update_relispartition(partRelid, OidIsValid(parentOid));
3441 
3442  if (fix_dependencies)
3443  {
3444  /*
3445  * Insert/delete pg_depend rows. If setting a parent, add PARTITION
3446  * dependencies on the parent index and the table; if removing a
3447  * parent, delete PARTITION dependencies.
3448  */
3449  if (OidIsValid(parentOid))
3450  {
3451  ObjectAddress partIdx;
3452  ObjectAddress parentIdx;
3453  ObjectAddress partitionTbl;
3454 
3455  ObjectAddressSet(partIdx, RelationRelationId, partRelid);
3456  ObjectAddressSet(parentIdx, RelationRelationId, parentOid);
3457  ObjectAddressSet(partitionTbl, RelationRelationId,
3458  partitionIdx->rd_index->indrelid);
3459  recordDependencyOn(&partIdx, &parentIdx,
3461  recordDependencyOn(&partIdx, &partitionTbl,
3463  }
3464  else
3465  {
3466  deleteDependencyRecordsForClass(RelationRelationId, partRelid,
3467  RelationRelationId,
3469  deleteDependencyRecordsForClass(RelationRelationId, partRelid,
3470  RelationRelationId,
3472  }
3473 
3474  /* make our updates visible */
3476  }
3477 }
void systable_endscan(SysScanDesc sysscan)
Definition: genam.c:525
#define GETSTRUCT(TUP)
Definition: htup_details.h:655
#define RelationGetDescr(relation)
Definition: rel.h:445
void CatalogTupleDelete(Relation heapRel, ItemPointer tid)
Definition: indexing.c:269
void recordDependencyOn(const ObjectAddress *depender, const ObjectAddress *referenced, DependencyType behavior)
Definition: pg_depend.c:43
HeapTuple heap_form_tuple(TupleDesc tupleDescriptor, Datum *values, bool *isnull)
Definition: heaptuple.c:1020
unsigned int Oid
Definition: postgres_ext.h:31
#define OidIsValid(objectId)
Definition: c.h:638
SysScanDesc systable_beginscan(Relation heapRelation, Oid indexId, bool indexOK, Snapshot snapshot, int nkeys, ScanKey key)
Definition: genam.c:352
void SetRelationHasSubclass(Oid relationId, bool relhassubclass)
Definition: tablecmds.c:2832
HeapTuple systable_getnext(SysScanDesc sysscan)
Definition: genam.c:444
#define ObjectIdGetDatum(X)
Definition: postgres.h:507
#define ERROR
Definition: elog.h:43
Relation relation_open(Oid relationId, LOCKMODE lockmode)
Definition: relation.c:48
ItemPointerData t_self
Definition: htup.h:65
static void update_relispartition(Oid relationId, bool newval)
Definition: indexcmds.c:3484
#define RowExclusiveLock
Definition: lockdefs.h:38
uintptr_t Datum
Definition: postgres.h:367
void CommandCounterIncrement(void)
Definition: xact.c:1003
static void fix_dependencies(ArchiveHandle *AH)
long deleteDependencyRecordsForClass(Oid classId, Oid objectId, Oid refclassId, char deptype)
Definition: pg_depend.c:240
#define InvalidOid
Definition: postgres_ext.h:36
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
void relation_close(Relation relation, LOCKMODE lockmode)
Definition: relation.c:206
#define Assert(condition)
Definition: c.h:732
#define InheritsRelidSeqnoIndexId
Definition: indexing.h:171
FormData_pg_inherits * Form_pg_inherits
Definition: pg_inherits.h:44
#define ObjectAddressSet(addr, class_id, object_id)
Definition: objectaddress.h:40
static Datum values[MAXATTR]
Definition: bootstrap.c:167
#define Int32GetDatum(X)
Definition: postgres.h:479
#define elog(elevel,...)
Definition: elog.h:226
void ScanKeyInit(ScanKey entry, AttrNumber attributeNumber, StrategyNumber strategy, RegProcedure procedure, Datum argument)
Definition: scankey.c:76
#define RelationGetRelid(relation)
Definition: rel.h:419
void CatalogTupleInsert(Relation heapRel, HeapTuple tup)
Definition: indexing.c:183
#define BTEqualStrategyNumber
Definition: stratnum.h:31

◆ itemptr_decode()

static void itemptr_decode ( ItemPointer  itemptr,
int64  encoded 
)
inlinestatic

Definition at line 187 of file index.h.

References ItemPointerSet.

Referenced by heapam_index_validate_scan().

188 {
189  BlockNumber block = (BlockNumber) (encoded >> 16);
190  OffsetNumber offset = (OffsetNumber) (encoded & 0xFFFF);
191 
192  ItemPointerSet(itemptr, block, offset);
193 }
uint32 BlockNumber
Definition: block.h:31
uint16 OffsetNumber
Definition: off.h:24
#define ItemPointerSet(pointer, blockNumber, offNum)
Definition: itemptr.h:127

◆ itemptr_encode()

static int64 itemptr_encode ( ItemPointer  itemptr)
inlinestatic

Definition at line 166 of file index.h.

References ItemPointerGetBlockNumber, and ItemPointerGetOffsetNumber.

Referenced by validate_index_callback().

167 {
168  BlockNumber block = ItemPointerGetBlockNumber(itemptr);
169  OffsetNumber offset = ItemPointerGetOffsetNumber(itemptr);
170  int64 encoded;
171 
172  /*
173  * Use the 16 least significant bits for the offset. 32 adjacent bits are
174  * used for the block number. Since remaining bits are unused, there
175  * cannot be negative encoded values (We assume a two's complement
176  * representation).
177  */
178  encoded = ((uint64) block << 16) | (uint16) offset;
179 
180  return encoded;
181 }
uint32 BlockNumber
Definition: block.h:31
uint16 OffsetNumber
Definition: off.h:24
unsigned short uint16
Definition: c.h:357
#define ItemPointerGetOffsetNumber(pointer)
Definition: itemptr.h:117
#define ItemPointerGetBlockNumber(pointer)
Definition: itemptr.h:98

◆ reindex_index()

void reindex_index ( Oid  indexId,
bool  skip_constraint_checks,
char  relpersistence,
int  options 
)

Definition at line 3345 of file index.c.

References AccessExclusiveLock, BuildIndexInfo(), CacheInvalidateRelcache(), CatalogTupleUpdate(), CheckTableNotInUse(), EarlyPruningEnabled, elog, ereport, errcode(), errdetail_internal(), errmsg(), ERROR, get_rel_name(), GETSTRUCT, HeapTupleIsValid, IndexInfo::ii_BrokenHotChain, IndexInfo::ii_ExclusionOps, IndexInfo::ii_ExclusionProcs, IndexInfo::ii_ExclusionStrats, IndexInfo::ii_Unique, index_build(), index_close(), index_open(), IndexGetRelation(), INDEXRELID, INFO, NoLock, ObjectIdGetDatum, PG_CATCH, PG_END_TRY, PG_RE_THROW, pg_rusage_init(), pg_rusage_show(), PG_TRY, pgstat_progress_end_command(), pgstat_progress_start_command(), pgstat_progress_update_param(), progress, PROGRESS_COMMAND_CREATE_INDEX, PROGRESS_CREATEIDX_ACCESS_METHOD_OID, PROGRESS_CREATEIDX_COMMAND, PROGRESS_CREATEIDX_COMMAND_REINDEX, PROGRESS_CREATEIDX_INDEX_OID, RelationData::rd_rel, REINDEXOPT_REPORT_PROGRESS, REINDEXOPT_VERBOSE, RELATION_IS_OTHER_TEMP, RelationGetRelationName, RelationSetNewRelfilenode(), ResetReindexProcessing(), RowExclusiveLock, SearchSysCacheCopy1, SetReindexProcessing(), ShareLock, HeapTupleData::t_self, table_close(), table_open(), and TransferPredicateLocksToHeapRelation().

Referenced by reindex_relation(), and ReindexIndex().

3347 {
3348  Relation iRel,
3349  heapRelation;
3350  Oid heapId;
3351  IndexInfo *indexInfo;
3352  volatile bool skipped_constraint = false;
3353  PGRUsage ru0;
3355 
3356  pg_rusage_init(&ru0);
3357 
3358  /*
3359  * Open and lock the parent heap relation. ShareLock is sufficient since
3360  * we only need to be sure no schema or data changes are going on.
3361  */
3362  heapId = IndexGetRelation(indexId, false);
3363  heapRelation = table_open(heapId, ShareLock);
3364 
3365  if (progress)
3366  {
3368  heapId);
3372  indexId);
3373  }
3374 
3375  /*
3376  * Open the target index relation and get an exclusive lock on it, to
3377  * ensure that no one else is touching this particular index.
3378  */
3379  iRel = index_open(indexId, AccessExclusiveLock);
3380 
3381  if (progress)
3383  iRel->rd_rel->relam);
3384 
3385  /*
3386  * The case of reindexing partitioned tables and indexes is handled
3387  * differently by upper layers, so this case shouldn't arise.
3388  */
3389  if (iRel->rd_rel->relkind == RELKIND_PARTITIONED_INDEX)
3390  elog(ERROR, "unsupported relation kind for index \"%s\"",
3391  RelationGetRelationName(iRel));
3392 
3393  /*
3394  * Don't allow reindex on temp tables of other backends ... their local
3395  * buffer manager is not going to cope.
3396  */
3397  if (RELATION_IS_OTHER_TEMP(iRel))
3398  ereport(ERROR,
3399  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
3400  errmsg("cannot reindex temporary tables of other sessions")));
3401 
3402  /*
3403  * Also check for active uses of the index in the current transaction; we
3404  * don't want to reindex underneath an open indexscan.
3405  */
3406  CheckTableNotInUse(iRel, "REINDEX INDEX");
3407 
3408  /*
3409  * All predicate locks on the index are about to be made invalid. Promote
3410  * them to relation locks on the heap.
3411  */
3413 
3414  /* Fetch info needed for index_build */
3415  indexInfo = BuildIndexInfo(iRel);
3416 
3417  /* If requested, skip checking uniqueness/exclusion constraints */
3418  if (skip_constraint_checks)
3419  {
3420  if (indexInfo->ii_Unique || indexInfo->ii_ExclusionOps != NULL)
3421  skipped_constraint = true;
3422  indexInfo->ii_Unique = false;
3423  indexInfo->ii_ExclusionOps = NULL;
3424  indexInfo->ii_ExclusionProcs = NULL;
3425  indexInfo->ii_ExclusionStrats = NULL;
3426  }
3427 
3428  /* ensure SetReindexProcessing state isn't leaked */
3429  PG_TRY();
3430  {
3431  /* Suppress use of the target index while rebuilding it */
3432  SetReindexProcessing(heapId, indexId);
3433 
3434  /* Create a new physical relation for the index */
3435  RelationSetNewRelfilenode(iRel, persistence);
3436 
3437  /* Initialize the index and rebuild */
3438  /* Note: we do not need to re-establish pkey setting */
3439  index_build(heapRelation, iRel, indexInfo, true, true);
3440  }
3441  PG_CATCH();
3442  {
3443  /* Make sure flag gets cleared on error exit */
3445  PG_RE_THROW();
3446  }
3447  PG_END_TRY();
3449 
3450  /*
3451  * If the index is marked invalid/not-ready/dead (ie, it's from a failed
3452  * CREATE INDEX CONCURRENTLY, or a DROP INDEX CONCURRENTLY failed midway),
3453  * and we didn't skip a uniqueness check, we can now mark it valid. This
3454  * allows REINDEX to be used to clean up in such cases.
3455  *
3456  * We can also reset indcheckxmin, because we have now done a
3457  * non-concurrent index build, *except* in the case where index_build
3458  * found some still-broken HOT chains. If it did, and we don't have to
3459  * change any of the other flags, we just leave indcheckxmin alone (note
3460  * that index_build won't have changed it, because this is a reindex).
3461  * This is okay and desirable because not updating the tuple leaves the
3462  * index's usability horizon (recorded as the tuple's xmin value) the same
3463  * as it was.
3464  *
3465  * But, if the index was invalid/not-ready/dead and there were broken HOT
3466  * chains, we had better force indcheckxmin true, because the normal
3467  * argument that the HOT chains couldn't conflict with the index is
3468  * suspect for an invalid index. (A conflict is definitely possible if
3469  * the index was dead. It probably shouldn't happen otherwise, but let's
3470  * be conservative.) In this case advancing the usability horizon is
3471  * appropriate.
3472  *
3473  * Another reason for avoiding unnecessary updates here is that while
3474  * reindexing pg_index itself, we must not try to update tuples in it.
3475  * pg_index's indexes should always have these flags in their clean state,
3476  * so that won't happen.
3477  *
3478  * If early pruning/vacuuming is enabled for the heap relation, the
3479  * usability horizon must be advanced to the current transaction on every
3480  * build or rebuild. pg_index is OK in this regard because catalog tables
3481  * are not subject to early cleanup.
3482  */
3483  if (!skipped_constraint)
3484  {
3485  Relation pg_index;
3486  HeapTuple indexTuple;
3487  Form_pg_index indexForm;
3488  bool index_bad;
3489  bool early_pruning_enabled = EarlyPruningEnabled(heapRelation);
3490 
3491  pg_index = table_open(IndexRelationId, RowExclusiveLock);
3492 
3493  indexTuple = SearchSysCacheCopy1(INDEXRELID,
3494  ObjectIdGetDatum(indexId));
3495  if (!HeapTupleIsValid(indexTuple))
3496  elog(ERROR, "cache lookup failed for index %u", indexId);
3497  indexForm = (Form_pg_index) GETSTRUCT(indexTuple);
3498 
3499  index_bad = (!indexForm->indisvalid ||
3500  !indexForm->indisready ||
3501  !indexForm->indislive);
3502  if (index_bad ||
3503  (indexForm->indcheckxmin && !indexInfo->ii_BrokenHotChain) ||
3504  early_pruning_enabled)
3505  {
3506  if (!indexInfo->ii_BrokenHotChain && !early_pruning_enabled)
3507  indexForm->indcheckxmin = false;
3508  else if (index_bad || early_pruning_enabled)
3509  indexForm->indcheckxmin = true;
3510  indexForm->indisvalid = true;
3511  indexForm->indisready = true;
3512  indexForm->indislive = true;
3513  CatalogTupleUpdate(pg_index, &indexTuple->t_self, indexTuple);
3514 
3515  /*
3516  * Invalidate the relcache for the table, so that after we commit
3517  * all sessions will refresh the table's index list. This ensures
3518  * that if anyone misses seeing the pg_index row during this
3519  * update, they'll refresh their list before attempting any update
3520  * on the table.
3521  */
3522  CacheInvalidateRelcache(heapRelation);
3523  }
3524 
3525  table_close(pg_index, RowExclusiveLock);
3526  }
3527 
3528  /* Log what we did */
3530  ereport(INFO,
3531  (errmsg("index \"%s\" was reindexed",
3532  get_rel_name(indexId)),
3533  errdetail_internal("%s",
3534  pg_rusage_show(&ru0))));
3535 
3536  if (progress)
3538 
3539  /* Close rels, but keep locks */
3540  index_close(iRel, NoLock);
3541  table_close(heapRelation, NoLock);
3542 }
Oid IndexGetRelation(Oid indexId, bool missing_ok)
Definition: index.c:3320
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:133
#define GETSTRUCT(TUP)
Definition: htup_details.h:655
void pgstat_progress_start_command(ProgressCommandType cmdtype, Oid relid)
Definition: pgstat.c:3199
static void SetReindexProcessing(Oid heapOid, Oid indexOid)
Definition: index.c:3749
void pgstat_progress_update_param(int index, int64 val)
Definition: pgstat.c:3220
#define REINDEXOPT_REPORT_PROGRESS
Definition: parsenodes.h:3316
Oid * ii_ExclusionProcs
Definition: execnodes.h:165
int errcode(int sqlerrcode)
Definition: elog.c:570
#define INFO
Definition: elog.h:33
IndexInfo * BuildIndexInfo(Relation index)
Definition: index.c:2275
Form_pg_class rd_rel
Definition: rel.h:83
unsigned int Oid
Definition: postgres_ext.h:31
#define REINDEXOPT_VERBOSE
Definition: parsenodes.h:3315
int errdetail_internal(const char *fmt,...)
Definition: elog.c:887
static void ResetReindexProcessing(void)
Definition: index.c:3766
void pg_rusage_init(PGRUsage *ru0)
Definition: pg_rusage.c:27
void RelationSetNewRelfilenode(Relation relation, char persistence)
Definition: relcache.c:3418
#define EarlyPruningEnabled(rel)
Definition: snapmgr.h:45
#define ObjectIdGetDatum(X)
Definition: postgres.h:507
#define ERROR
Definition: elog.h:43
ItemPointerData t_self
Definition: htup.h:65
#define NoLock
Definition: lockdefs.h:34
#define RowExclusiveLock
Definition: lockdefs.h:38
#define PROGRESS_CREATEIDX_INDEX_OID
Definition: progress.h:63
const char * pg_rusage_show(const PGRUsage *ru0)
Definition: pg_rusage.c:40
#define RelationGetRelationName(relation)
Definition: rel.h:453
bool ii_BrokenHotChain
Definition: execnodes.h:173
void CheckTableNotInUse(Relation rel, const char *stmt)
Definition: tablecmds.c:3416
#define ereport(elevel, rest)
Definition: elog.h:141
void TransferPredicateLocksToHeapRelation(Relation relation)
Definition: predicate.c:3097
FormData_pg_index * Form_pg_index
Definition: pg_index.h:66
int progress
Definition: pgbench.c:232
void pgstat_progress_end_command(void)
Definition: pgstat.c:3271
#define PROGRESS_CREATEIDX_COMMAND_REINDEX
Definition: progress.h:93
bool ii_Unique
Definition: execnodes.h:170
#define PG_CATCH()
Definition: elog.h:310
void index_build(Relation heapRelation, Relation indexRelation, IndexInfo *indexInfo, bool isreindex, bool parallel)
Definition: index.c:2734
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
#define RELATION_IS_OTHER_TEMP(relation)
Definition: rel.h:549
void CatalogTupleUpdate(Relation heapRel, ItemPointer otid, HeapTuple tup)
Definition: indexing.c:224
#define PG_RE_THROW()
Definition: elog.h:331
void index_close(Relation relation, LOCKMODE lockmode)
Definition: indexam.c:152
void CacheInvalidateRelcache(Relation relation)
Definition: inval.c:1270
#define SearchSysCacheCopy1(cacheId, key1)
Definition: syscache.h:174
#define AccessExclusiveLock
Definition: lockdefs.h:45
Oid * ii_ExclusionOps
Definition: execnodes.h:164
int errmsg(const char *fmt,...)
Definition: elog.c:784
#define elog(elevel,...)
Definition: elog.h:226
#define ShareLock
Definition: lockdefs.h:41
uint16 * ii_ExclusionStrats
Definition: execnodes.h:166
#define PG_TRY()
Definition: elog.h:301
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39
char * get_rel_name(Oid relid)
Definition: lsyscache.c:1730
#define PROGRESS_CREATEIDX_COMMAND
Definition: progress.h:62
Relation index_open(Oid relationId, LOCKMODE lockmode)
Definition: indexam.c:126
#define PG_END_TRY()
Definition: elog.h:317
#define PROGRESS_CREATEIDX_ACCESS_METHOD_OID
Definition: progress.h:64

◆ reindex_relation()

bool reindex_relation ( Oid  relid,
int  flags,
int  options 
)

Definition at line 3580 of file index.c.

References Assert, CommandCounterIncrement(), ereport, errcode(), errmsg(), i, lfirst_oid, NIL, NoLock, OidIsValid, PG_CATCH, PG_END_TRY, PG_RE_THROW, PG_TRY, pgstat_progress_update_param(), PROGRESS_CLUSTER_INDEX_REBUILD_COUNT, RelationData::rd_rel, reindex_index(), REINDEX_REL_CHECK_CONSTRAINTS, REINDEX_REL_FORCE_INDEXES_PERMANENT, REINDEX_REL_FORCE_INDEXES_UNLOGGED, REINDEX_REL_PROCESS_TOAST, REINDEX_REL_SUPPRESS_INDEX_USE, reindex_relation(), ReindexIsProcessingIndex(), RelationGetIndexList(), RelationGetRelationName, ResetReindexPending(), SetReindexPending(), ShareLock, table_close(), table_open(), and WARNING.

Referenced by ExecuteTruncateGuts(), finish_heap_swap(), reindex_relation(), ReindexMultipleTables(), and ReindexTable().

3581 {
3582  Relation rel;
3583  Oid toast_relid;
3584  List *indexIds;
3585  bool result;
3586  int i;
3587 
3588  /*
3589  * Open and lock the relation. ShareLock is sufficient since we only need
3590  * to prevent schema and data changes in it. The lock level used here
3591  * should match ReindexTable().
3592  */
3593  rel = table_open(relid, ShareLock);
3594 
3595  /*
3596  * This may be useful when implemented someday; but that day is not today.
3597  * For now, avoid erroring out when called in a multi-table context
3598  * (REINDEX SCHEMA) and happen to come across a partitioned table. The
3599  * partitions may be reindexed on their own anyway.
3600  */
3601  if (rel->rd_rel->relkind == RELKIND_PARTITIONED_TABLE)
3602  {
3603  ereport(WARNING,
3604  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
3605  errmsg("REINDEX of partitioned tables is not yet implemented, skipping \"%s\"",
3606  RelationGetRelationName(rel))));
3607  table_close(rel, ShareLock);
3608  return false;
3609  }
3610 
3611  toast_relid = rel->rd_rel->reltoastrelid;
3612 
3613  /*
3614  * Get the list of index OIDs for this relation. (We trust to the
3615  * relcache to get this with a sequential scan if ignoring system
3616  * indexes.)
3617  */
3618  indexIds = RelationGetIndexList(rel);
3619 
3620  PG_TRY();
3621  {
3622  ListCell *indexId;
3623  char persistence;
3624 
3625  if (flags & REINDEX_REL_SUPPRESS_INDEX_USE)
3626  {
3627  /* Suppress use of all the indexes until they are rebuilt */
3628  SetReindexPending(indexIds);
3629 
3630  /*
3631  * Make the new heap contents visible --- now things might be
3632  * inconsistent!
3633  */
3635  }
3636 
3637  /*
3638  * Compute persistence of indexes: same as that of owning rel, unless
3639  * caller specified otherwise.
3640  */
3642  persistence = RELPERSISTENCE_UNLOGGED;
3643  else if (flags & REINDEX_REL_FORCE_INDEXES_PERMANENT)
3644  persistence = RELPERSISTENCE_PERMANENT;
3645  else
3646  persistence = rel->rd_rel->relpersistence;
3647 
3648  /* Reindex all the indexes. */
3649  i = 1;
3650  foreach(indexId, indexIds)
3651  {
3652  Oid indexOid = lfirst_oid(indexId);
3653 
3654  reindex_index(indexOid, !(flags & REINDEX_REL_CHECK_CONSTRAINTS),
3655  persistence, options);
3656 
3658 
3659  /* Index should no longer be in the pending list */
3660  Assert(!ReindexIsProcessingIndex(indexOid));
3661 
3662  /* Set index rebuild count */
3664  i);
3665  i++;
3666  }
3667  }
3668  PG_CATCH();
3669  {
3670  /* Make sure list gets cleared on error exit */
3672  PG_RE_THROW();
3673  }
3674  PG_END_TRY();
3676 
3677  /*
3678  * Close rel, but continue to hold the lock.
3679  */
3680  table_close(rel, NoLock);
3681 
3682  result = (indexIds != NIL);
3683 
3684  /*
3685  * If the relation has a secondary toast rel, reindex that too while we
3686  * still hold the lock on the master table.
3687  */
3688  if ((flags & REINDEX_REL_PROCESS_TOAST) && OidIsValid(toast_relid))
3689  result |= reindex_relation(toast_relid, flags, options);
3690 
3691  return result;
3692 }
#define NIL
Definition: pg_list.h:65
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:133
static void SetReindexPending(List *indexes)
Definition: index.c:3781
void pgstat_progress_update_param(int index, int64 val)
Definition: pgstat.c:3220
static void ResetReindexPending(void)
Definition: index.c:3809
int errcode(int sqlerrcode)
Definition: elog.c:570
#define REINDEX_REL_SUPPRESS_INDEX_USE
Definition: index.h:137
Form_pg_class rd_rel
Definition: rel.h:83
unsigned int Oid
Definition: postgres_ext.h:31
#define OidIsValid(objectId)
Definition: c.h:638
#define NoLock
Definition: lockdefs.h:34
#define RelationGetRelationName(relation)
Definition: rel.h:453
#define ereport(elevel, rest)
Definition: elog.h:141
#define WARNING
Definition: elog.h:40
void CommandCounterIncrement(void)
Definition: xact.c:1003
#define PG_CATCH()
Definition: elog.h:310
#define REINDEX_REL_FORCE_INDEXES_UNLOGGED
Definition: index.h:139
#define Assert(condition)
Definition: c.h:732
#define REINDEX_REL_CHECK_CONSTRAINTS
Definition: index.h:138
#define PG_RE_THROW()
Definition: elog.h:331
List * RelationGetIndexList(Relation relation)
Definition: relcache.c:4348
void reindex_index(Oid indexId, bool skip_constraint_checks, char persistence, int options)
Definition: index.c:3345
int errmsg(const char *fmt,...)
Definition: elog.c:784
#define ShareLock
Definition: lockdefs.h:41
int i
#define PROGRESS_CLUSTER_INDEX_REBUILD_COUNT
Definition: progress.h:45
#define REINDEX_REL_FORCE_INDEXES_PERMANENT
Definition: index.h:140
#define REINDEX_REL_PROCESS_TOAST
Definition: index.h:136
#define PG_TRY()
Definition: elog.h:301
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39
bool ReindexIsProcessingIndex(Oid indexOid)
Definition: index.c:3736
bool reindex_relation(Oid relid, int flags, int options)
Definition: index.c:3580
Definition: pg_list.h:50
#define PG_END_TRY()
Definition: elog.h:317
#define lfirst_oid(lc)
Definition: pg_list.h:192

◆ ReindexIsProcessingHeap()

bool ReindexIsProcessingHeap ( Oid  heapOid)

Definition at line 3715 of file index.c.

References currentlyReindexedHeap.

Referenced by index_update_stats().

3716 {
3717  return heapOid == currentlyReindexedHeap;
3718 }
static Oid currentlyReindexedHeap
Definition: index.c:3706

◆ ReindexIsProcessingIndex()

bool ReindexIsProcessingIndex ( Oid  indexOid)

Definition at line 3736 of file index.c.

References currentlyReindexedIndex, and list_member_oid().

Referenced by CatalogIndexInsert(), reindex_relation(), systable_beginscan(), and systable_beginscan_ordered().

3737 {
3738  return indexOid == currentlyReindexedIndex ||
3740 }
static List * pendingReindexedIndexes
Definition: index.c:3708
static Oid currentlyReindexedIndex
Definition: index.c:3707
bool list_member_oid(const List *list, Oid datum)
Definition: list.c:675

◆ RestoreReindexState()

void RestoreReindexState ( void *  reindexstate)

Definition at line 3849 of file index.c.

References Assert, SerializedReindexState::currentlyReindexedHeap, currentlyReindexedHeap, SerializedReindexState::currentlyReindexedIndex, currentlyReindexedIndex, lappend_oid(), MemoryContextSwitchTo(), NIL, SerializedReindexState::numPendingReindexedIndexes, SerializedReindexState::pendingReindexedIndexes, and TopMemoryContext.

Referenced by ParallelWorkerMain().

3850 {
3851  SerializedReindexState *sistate = (SerializedReindexState *) reindexstate;
3852  int c = 0;
3853  MemoryContext oldcontext;
3854 
3857 
3860  for (c = 0; c < sistate->numPendingReindexedIndexes; ++c)
3863  sistate->pendingReindexedIndexes[c]);
3864  MemoryContextSwitchTo(oldcontext);
3865 }
#define NIL
Definition: pg_list.h:65
static Oid currentlyReindexedHeap
Definition: index.c:3706
Oid currentlyReindexedIndex
Definition: index.c:94
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
static List * pendingReindexedIndexes
Definition: index.c:3708
Oid pendingReindexedIndexes[FLEXIBLE_ARRAY_MEMBER]
Definition: index.c:96
List * lappend_oid(List *list, Oid datum)
Definition: list.c:358
char * c
MemoryContext TopMemoryContext
Definition: mcxt.c:44
int numPendingReindexedIndexes
Definition: index.c:95
static Oid currentlyReindexedIndex
Definition: index.c:3707
#define Assert(condition)
Definition: c.h:732
Oid currentlyReindexedHeap
Definition: index.c:93

◆ SerializeReindexState()

void SerializeReindexState ( Size  maxsize,
char *  start_address 
)

Definition at line 3831 of file index.c.

References SerializedReindexState::currentlyReindexedHeap, currentlyReindexedHeap, SerializedReindexState::currentlyReindexedIndex, currentlyReindexedIndex, lfirst_oid, list_length(), SerializedReindexState::numPendingReindexedIndexes, and SerializedReindexState::pendingReindexedIndexes.

Referenced by InitializeParallelDSM().

3832 {
3833  SerializedReindexState *sistate = (SerializedReindexState *) start_address;
3834  int c = 0;
3835  ListCell *lc;
3836 
3840  foreach(lc, pendingReindexedIndexes)
3841  sistate->pendingReindexedIndexes[c++] = lfirst_oid(lc);
3842 }
static Oid currentlyReindexedHeap
Definition: index.c:3706
Oid currentlyReindexedIndex
Definition: index.c:94
static List * pendingReindexedIndexes
Definition: index.c:3708
Oid pendingReindexedIndexes[FLEXIBLE_ARRAY_MEMBER]
Definition: index.c:96
char * c
int numPendingReindexedIndexes
Definition: index.c:95
static Oid currentlyReindexedIndex
Definition: index.c:3707
static int list_length(const List *l)
Definition: pg_list.h:169
Oid currentlyReindexedHeap
Definition: index.c:93
#define lfirst_oid(lc)
Definition: pg_list.h:192

◆ validate_index()

void validate_index ( Oid  heapId,
Oid  indexId,
Snapshot  snapshot 
)

Definition at line 3085 of file index.c.

References IndexVacuumInfo::analyze_only, AtEOXact_GUC(), BuildIndexInfo(), DEBUG2, elog, IndexVacuumInfo::estimated_count, GetUserIdAndSecContext(), ValidateIndexState::htups, IndexInfo::ii_Concurrent, IndexVacuumInfo::index, index_bulk_delete(), index_close(), index_open(), InvalidOid, ValidateIndexState::itups, maintenance_work_mem, IndexVacuumInfo::message_level, NewGUCNestLevel(), NoLock, IndexVacuumInfo::num_heap_tuples, pgstat_progress_update_multi_param(), pgstat_progress_update_param(), PROGRESS_CREATEIDX_PHASE, PROGRESS_CREATEIDX_PHASE_VALIDATE_IDXSCAN, PROGRESS_CREATEIDX_PHASE_VALIDATE_SORT, PROGRESS_CREATEIDX_PHASE_VALIDATE_TABLESCAN, PROGRESS_CREATEIDX_TUPLES_DONE, PROGRESS_CREATEIDX_TUPLES_TOTAL, PROGRESS_SCAN_BLOCKS_DONE, PROGRESS_SCAN_BLOCKS_TOTAL, RelationData::rd_rel, IndexVacuumInfo::report_progress, RowExclusiveLock, SECURITY_RESTRICTED_OPERATION, SetUserIdAndSecContext(), ShareUpdateExclusiveLock, IndexVacuumInfo::strategy, table_close(), table_index_validate_scan(), table_open(), ValidateIndexState::tuplesort, tuplesort_begin_datum(), tuplesort_end(), tuplesort_performsort(), ValidateIndexState::tups_inserted, val, and validate_index_callback().

Referenced by DefineIndex(), and ReindexRelationConcurrently().

3086 {
3087  Relation heapRelation,
3088  indexRelation;
3089  IndexInfo *indexInfo;
3090  IndexVacuumInfo ivinfo;
3092  Oid save_userid;
3093  int save_sec_context;
3094  int save_nestlevel;
3095 
3096  {
3097  const int index[] = {
3103  };
3104  const int64 val[] = {
3106  0, 0, 0, 0
3107  };
3108 
3109  pgstat_progress_update_multi_param(5, index, val);
3110  }
3111 
3112  /* Open and lock the parent heap relation */
3113  heapRelation = table_open(heapId, ShareUpdateExclusiveLock);
3114  /* And the target index relation */
3115  indexRelation = index_open(indexId, RowExclusiveLock);
3116 
3117  /*
3118  * Fetch info needed for index_insert. (You might think this should be
3119  * passed in from DefineIndex, but its copy is long gone due to having
3120  * been built in a previous transaction.)
3121  */
3122  indexInfo = BuildIndexInfo(indexRelation);
3123 
3124  /* mark build is concurrent just for consistency */
3125  indexInfo->ii_Concurrent = true;
3126 
3127  /*
3128  * Switch to the table owner's userid, so that any index functions are run
3129  * as that user. Also lock down security-restricted operations and
3130  * arrange to make GUC variable changes local to this command.
3131  */
3132  GetUserIdAndSecContext(&save_userid, &save_sec_context);
3133  SetUserIdAndSecContext(heapRelation->rd_rel->relowner,
3134  save_sec_context | SECURITY_RESTRICTED_OPERATION);
3135  save_nestlevel = NewGUCNestLevel();
3136 
3137  /*
3138  * Scan the index and gather up all the TIDs into a tuplesort object.
3139  */
3140  ivinfo.index = indexRelation;
3141  ivinfo.analyze_only = false;
3142  ivinfo.report_progress = true;
3143  ivinfo.estimated_count = true;
3144  ivinfo.message_level = DEBUG2;
3145  ivinfo.num_heap_tuples = heapRelation->rd_rel->reltuples;
3146  ivinfo.strategy = NULL;
3147 
3148  /*
3149  * Encode TIDs as int8 values for the sort, rather than directly sorting
3150  * item pointers. This can be significantly faster, primarily because TID
3151  * is a pass-by-reference type on all platforms, whereas int8 is
3152  * pass-by-value on most platforms.
3153  */
3154  state.tuplesort = tuplesort_begin_datum(INT8OID, Int8LessOperator,
3155  InvalidOid, false,
3157  NULL, false);
3158  state.htups = state.itups = state.tups_inserted = 0;
3159 
3160  /* ambulkdelete updates progress metrics */
3161  (void) index_bulk_delete(&ivinfo, NULL,
3162  validate_index_callback, (void *) &state);
3163 
3164  /* Execute the sort */
3165  {
3166  const int index[] = {
3170  };
3171  const int64 val[] = {
3173  0, 0
3174  };
3175 
3176  pgstat_progress_update_multi_param(3, index, val);
3177  }
3179 
3180  /*
3181  * Now scan the heap and "merge" it with the index
3182  */
3185  table_index_validate_scan(heapRelation,
3186  indexRelation,
3187  indexInfo,
3188  snapshot,
3189  &state);
3190 
3191  /* Done with tuplesort object */
3192  tuplesort_end(state.tuplesort);
3193 
3194  elog(DEBUG2,
3195  "validate_index found %.0f heap tuples, %.0f index tuples; inserted %.0f missing tuples",
3196  state.htups, state.itups, state.tups_inserted);
3197 
3198  /* Roll back any GUC changes executed by index functions */
3199  AtEOXact_GUC(false, save_nestlevel);
3200 
3201  /* Restore userid and security context */
3202  SetUserIdAndSecContext(save_userid, save_sec_context);
3203 
3204  /* Close rels, but keep locks */
3205  index_close(indexRelation, NoLock);
3206  table_close(heapRelation, NoLock);
3207 }
#define PROGRESS_CREATEIDX_PHASE_VALIDATE_SORT
Definition: progress.h:78
void tuplesort_performsort(Tuplesortstate *state)
Definition: tuplesort.c:1791
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:133
Tuplesortstate * tuplesort_begin_datum(Oid datumType, Oid sortOperator, Oid sortCollation, bool nullsFirstFlag, int workMem, SortCoordinate coordinate, bool randomAccess)
Definition: tuplesort.c:1099
#define SECURITY_RESTRICTED_OPERATION
Definition: miscadmin.h:300
void SetUserIdAndSecContext(Oid userid, int sec_context)
Definition: miscinit.c:492
void pgstat_progress_update_param(int index, int64 val)
Definition: pgstat.c:3220
bool analyze_only
Definition: genam.h:47
bool report_progress
Definition: genam.h:48
BufferAccessStrategy strategy
Definition: genam.h:52
Relation index
Definition: genam.h:46
#define PROGRESS_CREATEIDX_TUPLES_TOTAL
Definition: progress.h:67
IndexInfo * BuildIndexInfo(Relation index)
Definition: index.c:2275
Form_pg_class rd_rel
Definition: rel.h:83
unsigned int Oid
Definition: postgres_ext.h:31
double itups
Definition: index.h:37
Definition: type.h:89
#define DEBUG2
Definition: elog.h:24
Tuplesortstate * tuplesort
Definition: index.h:35
#define NoLock
Definition: lockdefs.h:34
void GetUserIdAndSecContext(Oid *userid, int *sec_context)
Definition: miscinit.c:485
#define RowExclusiveLock
Definition: lockdefs.h:38
void AtEOXact_GUC(bool isCommit, int nestLevel)
Definition: guc.c:5729
#define PROGRESS_CREATEIDX_PHASE
Definition: progress.h:65
#define PROGRESS_SCAN_BLOCKS_DONE
Definition: progress.h:103
IndexBulkDeleteResult * index_bulk_delete(IndexVacuumInfo *info, IndexBulkDeleteResult *stats, IndexBulkDeleteCallback callback, void *callback_state)
Definition: indexam.c:682
#define InvalidOid
Definition: postgres_ext.h:36
int maintenance_work_mem
Definition: globals.c:122
int message_level
Definition: genam.h:50
double num_heap_tuples
Definition: genam.h:51
#define ShareUpdateExclusiveLock
Definition: lockdefs.h:39
Definition: regguts.h:298
double tups_inserted
Definition: index.h:37
#define PROGRESS_CREATEIDX_PHASE_VALIDATE_TABLESCAN
Definition: progress.h:79
void pgstat_progress_update_multi_param(int nparam, const int *index, const int64 *val)
Definition: pgstat.c:3242
#define PROGRESS_SCAN_BLOCKS_TOTAL
Definition: progress.h:102
bool ii_Concurrent
Definition: execnodes.h:172
void index_close(Relation relation, LOCKMODE lockmode)
Definition: indexam.c:152
double htups
Definition: index.h:37
#define PROGRESS_CREATEIDX_PHASE_VALIDATE_IDXSCAN
Definition: progress.h:77
int NewGUCNestLevel(void)
Definition: guc.c:5715
static void table_index_validate_scan(Relation table_rel, Relation index_rel, struct IndexInfo *index_info, Snapshot snapshot, struct ValidateIndexState *state)
Definition: tableam.h:1563
#define PROGRESS_CREATEIDX_TUPLES_DONE
Definition: progress.h:68
#define elog(elevel,...)
Definition: elog.h:226
void tuplesort_end(Tuplesortstate *state)
Definition: tuplesort.c:1236
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39
static bool validate_index_callback(ItemPointer itemptr, void *opaque)
Definition: index.c:3213
long val
Definition: informix.c:684
Relation index_open(Oid relationId, LOCKMODE lockmode)
Definition: indexam.c:126
bool estimated_count
Definition: genam.h:49