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)
 
IndexInfoBuildDummyIndexInfo (Relation index)
 
bool CompareIndexInfo (IndexInfo *info1, IndexInfo *info2, Oid *collations1, Oid *collations2, Oid *opfamilies1, Oid *opfamilies2, AttrMap *attmap)
 
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 140 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 142 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 141 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 139 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

◆ BuildDummyIndexInfo()

IndexInfo* BuildDummyIndexInfo ( Relation  index)

Definition at line 2341 of file index.c.

References elog, ERROR, i, IndexInfo::ii_IndexAttrNumbers, INDEX_MAX_KEYS, makeIndexInfo(), NIL, RelationData::rd_index, RelationData::rd_rel, RelationGetDummyIndexExpressions(), and RelationGetRelid.

Referenced by RelationTruncateIndexes().

2342 {
2343  IndexInfo *ii;
2344  Form_pg_index indexStruct = index->rd_index;
2345  int i;
2346  int numAtts;
2347 
2348  /* check the number of keys, and copy attr numbers into the IndexInfo */
2349  numAtts = indexStruct->indnatts;
2350  if (numAtts < 1 || numAtts > INDEX_MAX_KEYS)
2351  elog(ERROR, "invalid indnatts %d for index %u",
2352  numAtts, RelationGetRelid(index));
2353 
2354  /*
2355  * Create the node, using dummy index expressions, and pretending there is
2356  * no predicate.
2357  */
2358  ii = makeIndexInfo(indexStruct->indnatts,
2359  indexStruct->indnkeyatts,
2360  index->rd_rel->relam,
2362  NIL,
2363  indexStruct->indisunique,
2364  indexStruct->indisready,
2365  false);
2366 
2367  /* fill in attribute numbers */
2368  for (i = 0; i < numAtts; i++)
2369  ii->ii_IndexAttrNumbers[i] = indexStruct->indkey.values[i];
2370 
2371  /* We ignore the exclusion constraint if any */
2372 
2373  return ii;
2374 }
#define NIL
Definition: pg_list.h:65
List * RelationGetDummyIndexExpressions(Relation relation)
Definition: relcache.c:4623
Form_pg_class rd_rel
Definition: rel.h:84
Form_pg_index rd_index
Definition: rel.h:149
#define ERROR
Definition: elog.h:43
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
#define elog(elevel,...)
Definition: elog.h:228
int i
AttrNumber ii_IndexAttrNumbers[INDEX_MAX_KEYS]
Definition: execnodes.h:158
#define RelationGetRelid(relation)
Definition: rel.h:428

◆ BuildIndexInfo()

IndexInfo* BuildIndexInfo ( Relation  index)

Definition at line 2284 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(), tuplesort_begin_cluster(), unique_key_recheck(), and validate_index().

2285 {
2286  IndexInfo *ii;
2287  Form_pg_index indexStruct = index->rd_index;
2288  int i;
2289  int numAtts;
2290 
2291  /* check the number of keys, and copy attr numbers into the IndexInfo */
2292  numAtts = indexStruct->indnatts;
2293  if (numAtts < 1 || numAtts > INDEX_MAX_KEYS)
2294  elog(ERROR, "invalid indnatts %d for index %u",
2295  numAtts, RelationGetRelid(index));
2296 
2297  /*
2298  * Create the node, fetching any expressions needed for expressional
2299  * indexes and index predicate if any.
2300  */
2301  ii = makeIndexInfo(indexStruct->indnatts,
2302  indexStruct->indnkeyatts,
2303  index->rd_rel->relam,
2306  indexStruct->indisunique,
2307  indexStruct->indisready,
2308  false);
2309 
2310  /* fill in attribute numbers */
2311  for (i = 0; i < numAtts; i++)
2312  ii->ii_IndexAttrNumbers[i] = indexStruct->indkey.values[i];
2313 
2314  /* fetch exclusion constraint info if any */
2315  if (indexStruct->indisexclusion)
2316  {
2318  &ii->ii_ExclusionOps,
2319  &ii->ii_ExclusionProcs,
2320  &ii->ii_ExclusionStrats);
2321  }
2322 
2323  return ii;
2324 }
void RelationGetExclusionInfo(Relation indexRelation, Oid **operators, Oid **procs, uint16 **strategies)
Definition: relcache.c:4998
Oid * ii_ExclusionProcs
Definition: execnodes.h:164
Form_pg_class rd_rel
Definition: rel.h:84
List * RelationGetIndexPredicate(Relation relation)
Definition: relcache.c:4677
Form_pg_index rd_index
Definition: rel.h:149
#define ERROR
Definition: elog.h:43
List * RelationGetIndexExpressions(Relation relation)
Definition: relcache.c:4564
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:163
#define elog(elevel,...)
Definition: elog.h:228
int i
AttrNumber ii_IndexAttrNumbers[INDEX_MAX_KEYS]
Definition: execnodes.h:158
uint16 * ii_ExclusionStrats
Definition: execnodes.h:165
#define RelationGetRelid(relation)
Definition: rel.h:428

◆ BuildSpeculativeIndexInfo()

void BuildSpeculativeIndexInfo ( Relation  index,
IndexInfo ii 
)

Definition at line 2506 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().

2507 {
2508  int indnkeyatts;
2509  int i;
2510 
2511  indnkeyatts = IndexRelationGetNumberOfKeyAttributes(index);
2512 
2513  /*
2514  * fetch info for checking unique indexes
2515  */
2516  Assert(ii->ii_Unique);
2517 
2518  if (index->rd_rel->relam != BTREE_AM_OID)
2519  elog(ERROR, "unexpected non-btree speculative unique index");
2520 
2521  ii->ii_UniqueOps = (Oid *) palloc(sizeof(Oid) * indnkeyatts);
2522  ii->ii_UniqueProcs = (Oid *) palloc(sizeof(Oid) * indnkeyatts);
2523  ii->ii_UniqueStrats = (uint16 *) palloc(sizeof(uint16) * indnkeyatts);
2524 
2525  /*
2526  * We have to look up the operator's strategy number. This provides a
2527  * cross-check that the operator does match the index.
2528  */
2529  /* We need the func OIDs and strategy numbers too */
2530  for (i = 0; i < indnkeyatts; i++)
2531  {
2533  ii->ii_UniqueOps[i] =
2534  get_opfamily_member(index->rd_opfamily[i],
2535  index->rd_opcintype[i],
2536  index->rd_opcintype[i],
2537  ii->ii_UniqueStrats[i]);
2538  if (!OidIsValid(ii->ii_UniqueOps[i]))
2539  elog(ERROR, "missing operator %d(%u,%u) in opfamily %u",
2540  ii->ii_UniqueStrats[i], index->rd_opcintype[i],
2541  index->rd_opcintype[i], index->rd_opfamily[i]);
2542  ii->ii_UniqueProcs[i] = get_opcode(ii->ii_UniqueOps[i]);
2543  }
2544 }
uint16 * ii_UniqueStrats
Definition: execnodes.h:168
Form_pg_class rd_rel
Definition: rel.h:84
unsigned int Oid
Definition: postgres_ext.h:31
#define OidIsValid(objectId)
Definition: c.h:645
Oid * ii_UniqueOps
Definition: execnodes.h:166
unsigned short uint16
Definition: c.h:358
#define ERROR
Definition: elog.h:43
Oid * ii_UniqueProcs
Definition: execnodes.h:167
Oid get_opfamily_member(Oid opfamily, Oid lefttype, Oid righttype, int16 strategy)
Definition: lsyscache.c:163
Oid * rd_opfamily
Definition: rel.h:164
#define IndexRelationGetNumberOfKeyAttributes(relation)
Definition: rel.h:447
RegProcedure get_opcode(Oid opno)
Definition: lsyscache.c:1092
bool ii_Unique
Definition: execnodes.h:169
#define Assert(condition)
Definition: c.h:739
void * palloc(Size size)
Definition: mcxt.c:949
#define elog(elevel,...)
Definition: elog.h:228
int i
Oid * rd_opcintype
Definition: rel.h:165
#define BTEqualStrategyNumber
Definition: stratnum.h:31

◆ CompareIndexInfo()

bool CompareIndexInfo ( IndexInfo info1,
IndexInfo info2,
Oid collations1,
Oid collations2,
Oid opfamilies1,
Oid opfamilies2,
AttrMap attmap 
)

Definition at line 2387 of file index.c.

References AttrMap::attnums, 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(), AttrMap::maplen, and NIL.

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

2391 {
2392  int i;
2393 
2394  if (info1->ii_Unique != info2->ii_Unique)
2395  return false;
2396 
2397  /* indexes are only equivalent if they have the same access method */
2398  if (info1->ii_Am != info2->ii_Am)
2399  return false;
2400 
2401  /* and same number of attributes */
2402  if (info1->ii_NumIndexAttrs != info2->ii_NumIndexAttrs)
2403  return false;
2404 
2405  /* and same number of key attributes */
2406  if (info1->ii_NumIndexKeyAttrs != info2->ii_NumIndexKeyAttrs)
2407  return false;
2408 
2409  /*
2410  * and columns match through the attribute map (actual attribute numbers
2411  * might differ!) Note that this implies that index columns that are
2412  * expressions appear in the same positions. We will next compare the
2413  * expressions themselves.
2414  */
2415  for (i = 0; i < info1->ii_NumIndexAttrs; i++)
2416  {
2417  if (attmap->maplen < info2->ii_IndexAttrNumbers[i])
2418  elog(ERROR, "incorrect attribute map");
2419 
2420  /* ignore expressions at this stage */
2421  if ((info1->ii_IndexAttrNumbers[i] != InvalidAttrNumber) &&
2422  (attmap->attnums[info2->ii_IndexAttrNumbers[i] - 1] !=
2423  info1->ii_IndexAttrNumbers[i]))
2424  return false;
2425 
2426  /* collation and opfamily is not valid for including columns */
2427  if (i >= info1->ii_NumIndexKeyAttrs)
2428  continue;
2429 
2430  if (collations1[i] != collations2[i])
2431  return false;
2432  if (opfamilies1[i] != opfamilies2[i])
2433  return false;
2434  }
2435 
2436  /*
2437  * For expression indexes: either both are expression indexes, or neither
2438  * is; if they are, make sure the expressions match.
2439  */
2440  if ((info1->ii_Expressions != NIL) != (info2->ii_Expressions != NIL))
2441  return false;
2442  if (info1->ii_Expressions != NIL)
2443  {
2444  bool found_whole_row;
2445  Node *mapped;
2446 
2447  mapped = map_variable_attnos((Node *) info2->ii_Expressions,
2448  1, 0, attmap,
2449  InvalidOid, &found_whole_row);
2450  if (found_whole_row)
2451  {
2452  /*
2453  * we could throw an error here, but seems out of scope for this
2454  * routine.
2455  */
2456  return false;
2457  }
2458 
2459  if (!equal(info1->ii_Expressions, mapped))
2460  return false;
2461  }
2462 
2463  /* Partial index predicates must be identical, if they exist */
2464  if ((info1->ii_Predicate == NULL) != (info2->ii_Predicate == NULL))
2465  return false;
2466  if (info1->ii_Predicate != NULL)
2467  {
2468  bool found_whole_row;
2469  Node *mapped;
2470 
2471  mapped = map_variable_attnos((Node *) info2->ii_Predicate,
2472  1, 0, attmap,
2473  InvalidOid, &found_whole_row);
2474  if (found_whole_row)
2475  {
2476  /*
2477  * we could throw an error here, but seems out of scope for this
2478  * routine.
2479  */
2480  return false;
2481  }
2482  if (!equal(info1->ii_Predicate, mapped))
2483  return false;
2484  }
2485 
2486  /* No support currently for comparing exclusion indexes. */
2487  if (info1->ii_ExclusionOps != NULL || info2->ii_ExclusionOps != NULL)
2488  return false;
2489 
2490  return true;
2491 }
#define NIL
Definition: pg_list.h:65
List * ii_Predicate
Definition: execnodes.h:161
bool equal(const void *a, const void *b)
Definition: equalfuncs.c:3018
int maplen
Definition: attmap.h:37
Definition: nodes.h:525
Node * map_variable_attnos(Node *node, int target_varno, int sublevels_up, const AttrMap *attno_map, Oid to_rowtype, bool *found_whole_row)
#define ERROR
Definition: elog.h:43
int ii_NumIndexKeyAttrs
Definition: execnodes.h:157
int ii_NumIndexAttrs
Definition: execnodes.h:156
#define InvalidOid
Definition: postgres_ext.h:36
bool ii_Unique
Definition: execnodes.h:169
List * ii_Expressions
Definition: execnodes.h:159
AttrNumber * attnums
Definition: attmap.h:36
#define InvalidAttrNumber
Definition: attnum.h:23
Oid * ii_ExclusionOps
Definition: execnodes.h:163
#define elog(elevel,...)
Definition: elog.h:228
int i
AttrNumber ii_IndexAttrNumbers[INDEX_MAX_KEYS]
Definition: execnodes.h:158
Oid ii_Am
Definition: execnodes.h:174

◆ EstimateReindexStateSpace()

Size EstimateReindexStateSpace ( void  )

Definition at line 3875 of file index.c.

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

Referenced by InitializeParallelDSM().

3876 {
3879 }
static List * pendingReindexedIndexes
Definition: index.c:3763
unsigned int Oid
Definition: postgres_ext.h:31
Size mul_size(Size s1, Size s2)
Definition: shmem.c:515
static int list_length(const List *l)
Definition: pg_list.h:169
#define offsetof(type, field)
Definition: c.h:662

◆ FormIndexDatum()

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

Definition at line 2566 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().

2571 {
2572  ListCell *indexpr_item;
2573  int i;
2574 
2575  if (indexInfo->ii_Expressions != NIL &&
2576  indexInfo->ii_ExpressionsState == NIL)
2577  {
2578  /* First time through, set up expression evaluation state */
2579  indexInfo->ii_ExpressionsState =
2580  ExecPrepareExprList(indexInfo->ii_Expressions, estate);
2581  /* Check caller has set up context correctly */
2582  Assert(GetPerTupleExprContext(estate)->ecxt_scantuple == slot);
2583  }
2584  indexpr_item = list_head(indexInfo->ii_ExpressionsState);
2585 
2586  for (i = 0; i < indexInfo->ii_NumIndexAttrs; i++)
2587  {
2588  int keycol = indexInfo->ii_IndexAttrNumbers[i];
2589  Datum iDatum;
2590  bool isNull;
2591 
2592  if (keycol < 0)
2593  iDatum = slot_getsysattr(slot, keycol, &isNull);
2594  else if (keycol != 0)
2595  {
2596  /*
2597  * Plain index column; get the value we need directly from the
2598  * heap tuple.
2599  */
2600  iDatum = slot_getattr(slot, keycol, &isNull);
2601  }
2602  else
2603  {
2604  /*
2605  * Index expression --- need to evaluate it.
2606  */
2607  if (indexpr_item == NULL)
2608  elog(ERROR, "wrong number of index expressions");
2609  iDatum = ExecEvalExprSwitchContext((ExprState *) lfirst(indexpr_item),
2610  GetPerTupleExprContext(estate),
2611  &isNull);
2612  indexpr_item = lnext(indexInfo->ii_ExpressionsState, indexpr_item);
2613  }
2614  values[i] = iDatum;
2615  isnull[i] = isNull;
2616  }
2617 
2618  if (indexpr_item != NULL)
2619  elog(ERROR, "wrong number of index expressions");
2620 }
#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:160
#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:156
static Datum slot_getattr(TupleTableSlot *slot, int attnum, bool *isnull)
Definition: tuptable.h:381
List * ii_Expressions
Definition: execnodes.h:159
#define Assert(condition)
Definition: c.h:739
#define lfirst(lc)
Definition: pg_list.h:190
static Datum values[MAXATTR]
Definition: bootstrap.c:167
#define elog(elevel,...)
Definition: elog.h:228
int i
static Datum slot_getsysattr(TupleTableSlot *slot, int attnum, bool *isnull)
Definition: tuptable.h:402
AttrNumber ii_IndexAttrNumbers[INDEX_MAX_KEYS]
Definition: execnodes.h:158

◆ index_build()

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

Definition at line 2793 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().

2798 {
2799  IndexBuildResult *stats;
2800  Oid save_userid;
2801  int save_sec_context;
2802  int save_nestlevel;
2803 
2804  /*
2805  * sanity checks
2806  */
2807  Assert(RelationIsValid(indexRelation));
2808  Assert(PointerIsValid(indexRelation->rd_indam));
2809  Assert(PointerIsValid(indexRelation->rd_indam->ambuild));
2810  Assert(PointerIsValid(indexRelation->rd_indam->ambuildempty));
2811 
2812  /*
2813  * Determine worker process details for parallel CREATE INDEX. Currently,
2814  * only btree has support for parallel builds.
2815  *
2816  * Note that planner considers parallel safety for us.
2817  */
2818  if (parallel && IsNormalProcessingMode() &&
2819  indexRelation->rd_rel->relam == BTREE_AM_OID)
2820  indexInfo->ii_ParallelWorkers =
2822  RelationGetRelid(indexRelation));
2823 
2824  if (indexInfo->ii_ParallelWorkers == 0)
2825  ereport(DEBUG1,
2826  (errmsg("building index \"%s\" on table \"%s\" serially",
2827  RelationGetRelationName(indexRelation),
2828  RelationGetRelationName(heapRelation))));
2829  else
2830  ereport(DEBUG1,
2831  (errmsg_plural("building index \"%s\" on table \"%s\" with request for %d parallel worker",
2832  "building index \"%s\" on table \"%s\" with request for %d parallel workers",
2833  indexInfo->ii_ParallelWorkers,
2834  RelationGetRelationName(indexRelation),
2835  RelationGetRelationName(heapRelation),
2836  indexInfo->ii_ParallelWorkers)));
2837 
2838  /*
2839  * Switch to the table owner's userid, so that any index functions are run
2840  * as that user. Also lock down security-restricted operations and
2841  * arrange to make GUC variable changes local to this command.
2842  */
2843  GetUserIdAndSecContext(&save_userid, &save_sec_context);
2844  SetUserIdAndSecContext(heapRelation->rd_rel->relowner,
2845  save_sec_context | SECURITY_RESTRICTED_OPERATION);
2846  save_nestlevel = NewGUCNestLevel();
2847 
2848  /* Set up initial progress report status */
2849  {
2850  const int index[] = {
2857  };
2858  const int64 val[] = {
2861  0, 0, 0, 0
2862  };
2863 
2864  pgstat_progress_update_multi_param(6, index, val);
2865  }
2866 
2867  /*
2868  * Call the access method's build procedure
2869  */
2870  stats = indexRelation->rd_indam->ambuild(heapRelation, indexRelation,
2871  indexInfo);
2872  Assert(PointerIsValid(stats));
2873 
2874  /*
2875  * If this is an unlogged index, we may need to write out an init fork for
2876  * it -- but we must first check whether one already exists. If, for
2877  * example, an unlogged relation is truncated in the transaction that
2878  * created it, or truncated twice in a subsequent transaction, the
2879  * relfilenode won't change, and nothing needs to be done here.
2880  */
2881  if (indexRelation->rd_rel->relpersistence == RELPERSISTENCE_UNLOGGED &&
2882  !smgrexists(indexRelation->rd_smgr, INIT_FORKNUM))
2883  {
2884  RelationOpenSmgr(indexRelation);
2885  smgrcreate(indexRelation->rd_smgr, INIT_FORKNUM, false);
2886  indexRelation->rd_indam->ambuildempty(indexRelation);
2887  }
2888 
2889  /*
2890  * If we found any potentially broken HOT chains, mark the index as not
2891  * being usable until the current transaction is below the event horizon.
2892  * See src/backend/access/heap/README.HOT for discussion. Also set this
2893  * if early pruning/vacuuming is enabled for the heap relation. While it
2894  * might become safe to use the index earlier based on actual cleanup
2895  * activity and other active transactions, the test for that would be much
2896  * more complex and would require some form of blocking, so keep it simple
2897  * and fast by just using the current transaction.
2898  *
2899  * However, when reindexing an existing index, we should do nothing here.
2900  * Any HOT chains that are broken with respect to the index must predate
2901  * the index's original creation, so there is no need to change the
2902  * index's usability horizon. Moreover, we *must not* try to change the
2903  * index's pg_index entry while reindexing pg_index itself, and this
2904  * optimization nicely prevents that. The more complex rules needed for a
2905  * reindex are handled separately after this function returns.
2906  *
2907  * We also need not set indcheckxmin during a concurrent index build,
2908  * because we won't set indisvalid true until all transactions that care
2909  * about the broken HOT chains or early pruning/vacuuming are gone.
2910  *
2911  * Therefore, this code path can only be taken during non-concurrent
2912  * CREATE INDEX. Thus the fact that heap_update will set the pg_index
2913  * tuple's xmin doesn't matter, because that tuple was created in the
2914  * current transaction anyway. That also means we don't need to worry
2915  * about any concurrent readers of the tuple; no other transaction can see
2916  * it yet.
2917  */
2918  if ((indexInfo->ii_BrokenHotChain || EarlyPruningEnabled(heapRelation)) &&
2919  !isreindex &&
2920  !indexInfo->ii_Concurrent)
2921  {
2922  Oid indexId = RelationGetRelid(indexRelation);
2923  Relation pg_index;
2924  HeapTuple indexTuple;
2925  Form_pg_index indexForm;
2926 
2927  pg_index = table_open(IndexRelationId, RowExclusiveLock);
2928 
2929  indexTuple = SearchSysCacheCopy1(INDEXRELID,
2930  ObjectIdGetDatum(indexId));
2931  if (!HeapTupleIsValid(indexTuple))
2932  elog(ERROR, "cache lookup failed for index %u", indexId);
2933  indexForm = (Form_pg_index) GETSTRUCT(indexTuple);
2934 
2935  /* If it's a new index, indcheckxmin shouldn't be set ... */
2936  Assert(!indexForm->indcheckxmin);
2937 
2938  indexForm->indcheckxmin = true;
2939  CatalogTupleUpdate(pg_index, &indexTuple->t_self, indexTuple);
2940 
2941  heap_freetuple(indexTuple);
2942  table_close(pg_index, RowExclusiveLock);
2943  }
2944 
2945  /*
2946  * Update heap and index pg_class rows
2947  */
2948  index_update_stats(heapRelation,
2949  true,
2950  stats->heap_tuples);
2951 
2952  index_update_stats(indexRelation,
2953  false,
2954  stats->index_tuples);
2955 
2956  /* Make the updated catalog row versions visible */
2958 
2959  /*
2960  * If it's for an exclusion constraint, make a second pass over the heap
2961  * to verify that the constraint is satisfied. We must not do this until
2962  * the index is fully valid. (Broken HOT chains shouldn't matter, though;
2963  * see comments for IndexCheckExclusion.)
2964  */
2965  if (indexInfo->ii_ExclusionOps != NULL)
2966  IndexCheckExclusion(heapRelation, indexRelation, indexInfo);
2967 
2968  /* Roll back any GUC changes executed by index functions */
2969  AtEOXact_GUC(false, save_nestlevel);
2970 
2971  /* Restore userid and security context */
2972  SetUserIdAndSecContext(save_userid, save_sec_context);
2973 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:163
static void index_update_stats(Relation rel, bool hasindex, double reltuples)
Definition: index.c:2645
#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:298
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:932
struct SMgrRelationData * rd_smgr
Definition: rel.h:57
#define PROGRESS_CREATEIDX_TUPLES_TOTAL
Definition: progress.h:84
bool smgrexists(SMgrRelation reln, ForkNumber forknum)
Definition: smgr.c:247
Form_pg_class rd_rel
Definition: rel.h:84
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:485
#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:214
#define RelationIsValid(relation)
Definition: rel.h:401
ItemPointerData t_self
Definition: htup.h:65
#define IsNormalProcessingMode()
Definition: miscadmin.h:374
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:5805
#define RelationGetRelationName(relation)
Definition: rel.h:462
bool ii_BrokenHotChain
Definition: execnodes.h:172
static void IndexCheckExclusion(Relation heapRelation, Relation indexRelation, IndexInfo *indexInfo)
Definition: index.c:2988
#define ereport(elevel, rest)
Definition: elog.h:141
#define PROGRESS_CREATEIDX_SUBPHASE_INITIALIZE
Definition: progress.h:104
FormData_pg_index * Form_pg_index
Definition: pg_index.h:66
#define PROGRESS_CREATEIDX_PHASE
Definition: progress.h:82
#define PROGRESS_SCAN_BLOCKS_DONE
Definition: progress.h:120
void CommandCounterIncrement(void)
Definition: xact.c:1005
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
#define Assert(condition)
Definition: c.h:739
#define PROGRESS_CREATEIDX_PHASE_BUILD
Definition: progress.h:92
void pgstat_progress_update_multi_param(int nparam, const int *index, const int64 *val)
Definition: pgstat.c:3235
int ii_ParallelWorkers
Definition: execnodes.h:173
void CatalogTupleUpdate(Relation heapRel, ItemPointer otid, HeapTuple tup)
Definition: indexing.c:224
int plan_create_index_workers(Oid tableOid, Oid indexOid)
Definition: planner.c:6249
#define PROGRESS_SCAN_BLOCKS_TOTAL
Definition: progress.h:119
bool ii_Concurrent
Definition: execnodes.h:171
#define SearchSysCacheCopy1(cacheId, key1)
Definition: syscache.h:174
int NewGUCNestLevel(void)
Definition: guc.c:5791
Oid * ii_ExclusionOps
Definition: execnodes.h:163
int errmsg(const char *fmt,...)
Definition: elog.c:822
#define PROGRESS_CREATEIDX_TUPLES_DONE
Definition: progress.h:85
#define elog(elevel,...)
Definition: elog.h:228
ambuildempty_function ambuildempty
Definition: amapi.h:215
#define PROGRESS_CREATEIDX_SUBPHASE
Definition: progress.h:83
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39
#define PointerIsValid(pointer)
Definition: c.h:633
#define RelationGetRelid(relation)
Definition: rel.h:428
long val
Definition: informix.c:664
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 200 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().

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

◆ index_concurrently_build()

void index_concurrently_build ( Oid  heapRelationId,
Oid  indexRelationId 
)

Definition at line 1399 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().

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

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

◆ index_concurrently_set_dead()

void index_concurrently_set_dead ( Oid  heapId,
Oid  indexId 
)

Definition at line 1726 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().

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

References PgStat_StatTabEntry::blocks_fetched, PgStat_StatTabEntry::blocks_hit, BTEqualStrategyNumber, CatalogTupleUpdate(), changeDependenciesOf(), changeDependenciesOn(), CONSTROID, deleteDependencyRecordsFor(), 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().

1448 {
1449  Relation pg_class,
1450  pg_index,
1451  pg_constraint,
1452  pg_trigger;
1453  Relation oldClassRel,
1454  newClassRel;
1455  HeapTuple oldClassTuple,
1456  newClassTuple;
1457  Form_pg_class oldClassForm,
1458  newClassForm;
1459  HeapTuple oldIndexTuple,
1460  newIndexTuple;
1461  Form_pg_index oldIndexForm,
1462  newIndexForm;
1463  bool isPartition;
1464  Oid indexConstraintOid;
1465  List *constraintOids = NIL;
1466  ListCell *lc;
1467 
1468  /*
1469  * Take a necessary lock on the old and new index before swapping them.
1470  */
1471  oldClassRel = relation_open(oldIndexId, ShareUpdateExclusiveLock);
1472  newClassRel = relation_open(newIndexId, ShareUpdateExclusiveLock);
1473 
1474  /* Now swap names and dependencies of those indexes */
1475  pg_class = table_open(RelationRelationId, RowExclusiveLock);
1476 
1477  oldClassTuple = SearchSysCacheCopy1(RELOID,
1478  ObjectIdGetDatum(oldIndexId));
1479  if (!HeapTupleIsValid(oldClassTuple))
1480  elog(ERROR, "could not find tuple for relation %u", oldIndexId);
1481  newClassTuple = SearchSysCacheCopy1(RELOID,
1482  ObjectIdGetDatum(newIndexId));
1483  if (!HeapTupleIsValid(newClassTuple))
1484  elog(ERROR, "could not find tuple for relation %u", newIndexId);
1485 
1486  oldClassForm = (Form_pg_class) GETSTRUCT(oldClassTuple);
1487  newClassForm = (Form_pg_class) GETSTRUCT(newClassTuple);
1488 
1489  /* Swap the names */
1490  namestrcpy(&newClassForm->relname, NameStr(oldClassForm->relname));
1491  namestrcpy(&oldClassForm->relname, oldName);
1492 
1493  /* Swap the partition flags to track inheritance properly */
1494  isPartition = newClassForm->relispartition;
1495  newClassForm->relispartition = oldClassForm->relispartition;
1496  oldClassForm->relispartition = isPartition;
1497 
1498  CatalogTupleUpdate(pg_class, &oldClassTuple->t_self, oldClassTuple);
1499  CatalogTupleUpdate(pg_class, &newClassTuple->t_self, newClassTuple);
1500 
1501  heap_freetuple(oldClassTuple);
1502  heap_freetuple(newClassTuple);
1503 
1504  /* Now swap index info */
1505  pg_index = table_open(IndexRelationId, RowExclusiveLock);
1506 
1507  oldIndexTuple = SearchSysCacheCopy1(INDEXRELID,
1508  ObjectIdGetDatum(oldIndexId));
1509  if (!HeapTupleIsValid(oldIndexTuple))
1510  elog(ERROR, "could not find tuple for relation %u", oldIndexId);
1511  newIndexTuple = SearchSysCacheCopy1(INDEXRELID,
1512  ObjectIdGetDatum(newIndexId));
1513  if (!HeapTupleIsValid(newIndexTuple))
1514  elog(ERROR, "could not find tuple for relation %u", newIndexId);
1515 
1516  oldIndexForm = (Form_pg_index) GETSTRUCT(oldIndexTuple);
1517  newIndexForm = (Form_pg_index) GETSTRUCT(newIndexTuple);
1518 
1519  /*
1520  * Copy constraint flags from the old index. This is safe because the old
1521  * index guaranteed uniqueness.
1522  */
1523  newIndexForm->indisprimary = oldIndexForm->indisprimary;
1524  oldIndexForm->indisprimary = false;
1525  newIndexForm->indisexclusion = oldIndexForm->indisexclusion;
1526  oldIndexForm->indisexclusion = false;
1527  newIndexForm->indimmediate = oldIndexForm->indimmediate;
1528  oldIndexForm->indimmediate = true;
1529 
1530  /* Mark old index as valid and new as invalid as index_set_state_flags */
1531  newIndexForm->indisvalid = true;
1532  oldIndexForm->indisvalid = false;
1533  oldIndexForm->indisclustered = false;
1534 
1535  CatalogTupleUpdate(pg_index, &oldIndexTuple->t_self, oldIndexTuple);
1536  CatalogTupleUpdate(pg_index, &newIndexTuple->t_self, newIndexTuple);
1537 
1538  heap_freetuple(oldIndexTuple);
1539  heap_freetuple(newIndexTuple);
1540 
1541  /*
1542  * Move constraints and triggers over to the new index
1543  */
1544 
1545  constraintOids = get_index_ref_constraints(oldIndexId);
1546 
1547  indexConstraintOid = get_index_constraint(oldIndexId);
1548 
1549  if (OidIsValid(indexConstraintOid))
1550  constraintOids = lappend_oid(constraintOids, indexConstraintOid);
1551 
1552  pg_constraint = table_open(ConstraintRelationId, RowExclusiveLock);
1553  pg_trigger = table_open(TriggerRelationId, RowExclusiveLock);
1554 
1555  foreach(lc, constraintOids)
1556  {
1557  HeapTuple constraintTuple,
1558  triggerTuple;
1559  Form_pg_constraint conForm;
1560  ScanKeyData key[1];
1561  SysScanDesc scan;
1562  Oid constraintOid = lfirst_oid(lc);
1563 
1564  /* Move the constraint from the old to the new index */
1565  constraintTuple = SearchSysCacheCopy1(CONSTROID,
1566  ObjectIdGetDatum(constraintOid));
1567  if (!HeapTupleIsValid(constraintTuple))
1568  elog(ERROR, "could not find tuple for constraint %u", constraintOid);
1569 
1570  conForm = ((Form_pg_constraint) GETSTRUCT(constraintTuple));
1571 
1572  if (conForm->conindid == oldIndexId)
1573  {
1574  conForm->conindid = newIndexId;
1575 
1576  CatalogTupleUpdate(pg_constraint, &constraintTuple->t_self, constraintTuple);
1577  }
1578 
1579  heap_freetuple(constraintTuple);
1580 
1581  /* Search for trigger records */
1582  ScanKeyInit(&key[0],
1583  Anum_pg_trigger_tgconstraint,
1584  BTEqualStrategyNumber, F_OIDEQ,
1585  ObjectIdGetDatum(constraintOid));
1586 
1587  scan = systable_beginscan(pg_trigger, TriggerConstraintIndexId, true,
1588  NULL, 1, key);
1589 
1590  while (HeapTupleIsValid((triggerTuple = systable_getnext(scan))))
1591  {
1592  Form_pg_trigger tgForm = (Form_pg_trigger) GETSTRUCT(triggerTuple);
1593 
1594  if (tgForm->tgconstrindid != oldIndexId)
1595  continue;
1596 
1597  /* Make a modifiable copy */
1598  triggerTuple = heap_copytuple(triggerTuple);
1599  tgForm = (Form_pg_trigger) GETSTRUCT(triggerTuple);
1600 
1601  tgForm->tgconstrindid = newIndexId;
1602 
1603  CatalogTupleUpdate(pg_trigger, &triggerTuple->t_self, triggerTuple);
1604 
1605  heap_freetuple(triggerTuple);
1606  }
1607 
1608  systable_endscan(scan);
1609  }
1610 
1611  /*
1612  * Move comment if any
1613  */
1614  {
1615  Relation description;
1616  ScanKeyData skey[3];
1617  SysScanDesc sd;
1618  HeapTuple tuple;
1619  Datum values[Natts_pg_description] = {0};
1620  bool nulls[Natts_pg_description] = {0};
1621  bool replaces[Natts_pg_description] = {0};
1622 
1623  values[Anum_pg_description_objoid - 1] = ObjectIdGetDatum(newIndexId);
1624  replaces[Anum_pg_description_objoid - 1] = true;
1625 
1626  ScanKeyInit(&skey[0],
1627  Anum_pg_description_objoid,
1628  BTEqualStrategyNumber, F_OIDEQ,
1629  ObjectIdGetDatum(oldIndexId));
1630  ScanKeyInit(&skey[1],
1631  Anum_pg_description_classoid,
1632  BTEqualStrategyNumber, F_OIDEQ,
1633  ObjectIdGetDatum(RelationRelationId));
1634  ScanKeyInit(&skey[2],
1635  Anum_pg_description_objsubid,
1636  BTEqualStrategyNumber, F_INT4EQ,
1637  Int32GetDatum(0));
1638 
1639  description = table_open(DescriptionRelationId, RowExclusiveLock);
1640 
1641  sd = systable_beginscan(description, DescriptionObjIndexId, true,
1642  NULL, 3, skey);
1643 
1644  while ((tuple = systable_getnext(sd)) != NULL)
1645  {
1646  tuple = heap_modify_tuple(tuple, RelationGetDescr(description),
1647  values, nulls, replaces);
1648  CatalogTupleUpdate(description, &tuple->t_self, tuple);
1649 
1650  break; /* Assume there can be only one match */
1651  }
1652 
1653  systable_endscan(sd);
1654  table_close(description, NoLock);
1655  }
1656 
1657  /*
1658  * Swap inheritance relationship with parent index
1659  */
1660  if (get_rel_relispartition(oldIndexId))
1661  {
1662  List *ancestors = get_partition_ancestors(oldIndexId);
1663  Oid parentIndexRelid = linitial_oid(ancestors);
1664 
1665  DeleteInheritsTuple(oldIndexId, parentIndexRelid);
1666  StoreSingleInheritance(newIndexId, parentIndexRelid, 1);
1667 
1668  list_free(ancestors);
1669  }
1670 
1671  /*
1672  * Move all dependencies of and on the old index to the new one. First
1673  * remove any dependencies that the new index may have to provide an
1674  * initial clean state for the dependency switch, and then move all the
1675  * dependencies from the old index to the new one.
1676  */
1677  deleteDependencyRecordsFor(RelationRelationId, newIndexId, false);
1678  changeDependenciesOf(RelationRelationId, oldIndexId, newIndexId);
1679  changeDependenciesOn(RelationRelationId, oldIndexId, newIndexId);
1680 
1681  /*
1682  * Copy over statistics from old to new index
1683  */
1684  {
1685  PgStat_StatTabEntry *tabentry;
1686 
1687  tabentry = pgstat_fetch_stat_tabentry(oldIndexId);
1688  if (tabentry)
1689  {
1690  if (newClassRel->pgstat_info)
1691  {
1692  newClassRel->pgstat_info->t_counts.t_numscans = tabentry->numscans;
1693  newClassRel->pgstat_info->t_counts.t_tuples_returned = tabentry->tuples_returned;
1694  newClassRel->pgstat_info->t_counts.t_tuples_fetched = tabentry->tuples_fetched;
1695  newClassRel->pgstat_info->t_counts.t_blocks_fetched = tabentry->blocks_fetched;
1696  newClassRel->pgstat_info->t_counts.t_blocks_hit = tabentry->blocks_hit;
1697 
1698  /*
1699  * The data will be sent by the next pgstat_report_stat()
1700  * call.
1701  */
1702  }
1703  }
1704  }
1705 
1706  /* Close relations */
1707  table_close(pg_class, RowExclusiveLock);
1708  table_close(pg_index, RowExclusiveLock);
1709  table_close(pg_constraint, RowExclusiveLock);
1710  table_close(pg_trigger, RowExclusiveLock);
1711 
1712  /* The lock taken previously is not released until the end of transaction */
1713  relation_close(oldClassRel, NoLock);
1714  relation_close(newClassRel, NoLock);
1715 }
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:454
PgStat_Counter t_tuples_fetched
Definition: pgstat.h:102
long deleteDependencyRecordsFor(Oid classId, Oid objectId, bool skipExtensionDeps)
Definition: pg_depend.c:190
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:645
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:2452
#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:210
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:228
#define NameStr(name)
Definition: c.h:616
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:115
#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 1787 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().

1796 {
1797  Oid namespaceId = RelationGetNamespace(heapRelation);
1798  ObjectAddress myself,
1799  idxaddr;
1800  Oid conOid;
1801  bool deferrable;
1802  bool initdeferred;
1803  bool mark_as_primary;
1804  bool islocal;
1805  bool noinherit;
1806  int inhcount;
1807 
1808  deferrable = (constr_flags & INDEX_CONSTR_CREATE_DEFERRABLE) != 0;
1809  initdeferred = (constr_flags & INDEX_CONSTR_CREATE_INIT_DEFERRED) != 0;
1810  mark_as_primary = (constr_flags & INDEX_CONSTR_CREATE_MARK_AS_PRIMARY) != 0;
1811 
1812  /* constraint creation support doesn't work while bootstrapping */
1814 
1815  /* enforce system-table restriction */
1816  if (!allow_system_table_mods &&
1817  IsSystemRelation(heapRelation) &&
1819  ereport(ERROR,
1820  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1821  errmsg("user-defined indexes on system catalog tables are not supported")));
1822 
1823  /* primary/unique constraints shouldn't have any expressions */
1824  if (indexInfo->ii_Expressions &&
1825  constraintType != CONSTRAINT_EXCLUSION)
1826  elog(ERROR, "constraints cannot have index expressions");
1827 
1828  /*
1829  * If we're manufacturing a constraint for a pre-existing index, we need
1830  * to get rid of the existing auto dependencies for the index (the ones
1831  * that index_create() would have made instead of calling this function).
1832  *
1833  * Note: this code would not necessarily do the right thing if the index
1834  * has any expressions or predicate, but we'd never be turning such an
1835  * index into a UNIQUE or PRIMARY KEY constraint.
1836  */
1837  if (constr_flags & INDEX_CONSTR_CREATE_REMOVE_OLD_DEPS)
1838  deleteDependencyRecordsForClass(RelationRelationId, indexRelationId,
1839  RelationRelationId, DEPENDENCY_AUTO);
1840 
1841  if (OidIsValid(parentConstraintId))
1842  {
1843  islocal = false;
1844  inhcount = 1;
1845  noinherit = false;
1846  }
1847  else
1848  {
1849  islocal = true;
1850  inhcount = 0;
1851  noinherit = true;
1852  }
1853 
1854  /*
1855  * Construct a pg_constraint entry.
1856  */
1857  conOid = CreateConstraintEntry(constraintName,
1858  namespaceId,
1859  constraintType,
1860  deferrable,
1861  initdeferred,
1862  true,
1863  parentConstraintId,
1864  RelationGetRelid(heapRelation),
1865  indexInfo->ii_IndexAttrNumbers,
1866  indexInfo->ii_NumIndexKeyAttrs,
1867  indexInfo->ii_NumIndexAttrs,
1868  InvalidOid, /* no domain */
1869  indexRelationId, /* index OID */
1870  InvalidOid, /* no foreign key */
1871  NULL,
1872  NULL,
1873  NULL,
1874  NULL,
1875  0,
1876  ' ',
1877  ' ',
1878  ' ',
1879  indexInfo->ii_ExclusionOps,
1880  NULL, /* no check constraint */
1881  NULL,
1882  islocal,
1883  inhcount,
1884  noinherit,
1885  is_internal);
1886 
1887  /*
1888  * Register the index as internally dependent on the constraint.
1889  *
1890  * Note that the constraint has a dependency on the table, so we don't
1891  * need (or want) any direct dependency from the index to the table.
1892  */
1893  ObjectAddressSet(myself, ConstraintRelationId, conOid);
1894  ObjectAddressSet(idxaddr, RelationRelationId, indexRelationId);
1895  recordDependencyOn(&idxaddr, &myself, DEPENDENCY_INTERNAL);
1896 
1897  /*
1898  * Also, if this is a constraint on a partition, give it partition-type
1899  * dependencies on the parent constraint as well as the table.
1900  */
1901  if (OidIsValid(parentConstraintId))
1902  {
1903  ObjectAddress referenced;
1904 
1905  ObjectAddressSet(referenced, ConstraintRelationId, parentConstraintId);
1906  recordDependencyOn(&myself, &referenced, DEPENDENCY_PARTITION_PRI);
1907  ObjectAddressSet(referenced, RelationRelationId,
1908  RelationGetRelid(heapRelation));
1909  recordDependencyOn(&myself, &referenced, DEPENDENCY_PARTITION_SEC);
1910  }
1911 
1912  /*
1913  * If the constraint is deferrable, create the deferred uniqueness
1914  * checking trigger. (The trigger will be given an internal dependency on
1915  * the constraint by CreateTrigger.)
1916  */
1917  if (deferrable)
1918  {
1919  CreateTrigStmt *trigger;
1920 
1921  trigger = makeNode(CreateTrigStmt);
1922  trigger->trigname = (constraintType == CONSTRAINT_PRIMARY) ?
1923  "PK_ConstraintTrigger" :
1924  "Unique_ConstraintTrigger";
1925  trigger->relation = NULL;
1926  trigger->funcname = SystemFuncName("unique_key_recheck");
1927  trigger->args = NIL;
1928  trigger->row = true;
1929  trigger->timing = TRIGGER_TYPE_AFTER;
1930  trigger->events = TRIGGER_TYPE_INSERT | TRIGGER_TYPE_UPDATE;
1931  trigger->columns = NIL;
1932  trigger->whenClause = NULL;
1933  trigger->isconstraint = true;
1934  trigger->deferrable = true;
1935  trigger->initdeferred = initdeferred;
1936  trigger->constrrel = NULL;
1937 
1938  (void) CreateTrigger(trigger, NULL, RelationGetRelid(heapRelation),
1939  InvalidOid, conOid, indexRelationId, InvalidOid,
1940  InvalidOid, NULL, true, false);
1941  }
1942 
1943  /*
1944  * If needed, mark the index as primary and/or deferred in pg_index.
1945  *
1946  * Note: When making an existing index into a constraint, caller must have
1947  * a table lock that prevents concurrent table updates; otherwise, there
1948  * is a risk that concurrent readers of the table will miss seeing this
1949  * index at all.
1950  */
1951  if ((constr_flags & INDEX_CONSTR_CREATE_UPDATE_INDEX) &&
1952  (mark_as_primary || deferrable))
1953  {
1954  Relation pg_index;
1955  HeapTuple indexTuple;
1956  Form_pg_index indexForm;
1957  bool dirty = false;
1958 
1959  pg_index = table_open(IndexRelationId, RowExclusiveLock);
1960 
1961  indexTuple = SearchSysCacheCopy1(INDEXRELID,
1962  ObjectIdGetDatum(indexRelationId));
1963  if (!HeapTupleIsValid(indexTuple))
1964  elog(ERROR, "cache lookup failed for index %u", indexRelationId);
1965  indexForm = (Form_pg_index) GETSTRUCT(indexTuple);
1966 
1967  if (mark_as_primary && !indexForm->indisprimary)
1968  {
1969  indexForm->indisprimary = true;
1970  dirty = true;
1971  }
1972 
1973  if (deferrable && indexForm->indimmediate)
1974  {
1975  indexForm->indimmediate = false;
1976  dirty = true;
1977  }
1978 
1979  if (dirty)
1980  {
1981  CatalogTupleUpdate(pg_index, &indexTuple->t_self, indexTuple);
1982 
1983  InvokeObjectPostAlterHookArg(IndexRelationId, indexRelationId, 0,
1984  InvalidOid, is_internal);
1985  }
1986 
1987  heap_freetuple(indexTuple);
1988  table_close(pg_index, RowExclusiveLock);
1989  }
1990 
1991  return myself;
1992 }
#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:69
Node * whenClause
Definition: parsenodes.h:2437
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:50
int errcode(int sqlerrcode)
Definition: elog.c:608
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:645
#define InvokeObjectPostAlterHookArg(classId, objectId, subId, auxiliaryId, is_internal)
Definition: objectaccess.h:178
#define INDEX_CONSTR_CREATE_INIT_DEFERRED
Definition: index.h:77
RangeVar * constrrel
Definition: parsenodes.h:2444
#define ObjectIdGetDatum(X)
Definition: postgres.h:507
#define ERROR
Definition: elog.h:43
int ii_NumIndexKeyAttrs
Definition: execnodes.h:157
ItemPointerData t_self
Definition: htup.h:65
#define IsNormalProcessingMode()
Definition: miscadmin.h:374
#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:156
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:159
#define Assert(condition)
Definition: c.h:739
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:372
#define SearchSysCacheCopy1(cacheId, key1)
Definition: syscache.h:174
Oid * ii_ExclusionOps
Definition: execnodes.h:163
int errmsg(const char *fmt,...)
Definition: elog.c:822
#define elog(elevel,...)
Definition: elog.h:228
RangeVar * relation
Definition: parsenodes.h:2428
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:158
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39
#define RelationGetRelid(relation)
Definition: rel.h:428
#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:469

◆ 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 690 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().

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

◆ index_drop()

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

Definition at line 2006 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().

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

◆ index_set_state_flags()

void index_set_state_flags ( Oid  indexId,
IndexStateFlagsAction  action 
)

Definition at line 3300 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().

3301 {
3302  Relation pg_index;
3303  HeapTuple indexTuple;
3304  Form_pg_index indexForm;
3305 
3306  /* Assert that current xact hasn't done any transactional updates */
3308 
3309  /* Open pg_index and fetch a writable copy of the index's tuple */
3310  pg_index = table_open(IndexRelationId, RowExclusiveLock);
3311 
3312  indexTuple = SearchSysCacheCopy1(INDEXRELID,
3313  ObjectIdGetDatum(indexId));
3314  if (!HeapTupleIsValid(indexTuple))
3315  elog(ERROR, "cache lookup failed for index %u", indexId);
3316  indexForm = (Form_pg_index) GETSTRUCT(indexTuple);
3317 
3318  /* Perform the requested state change on the copy */
3319  switch (action)
3320  {
3322  /* Set indisready during a CREATE INDEX CONCURRENTLY sequence */
3323  Assert(indexForm->indislive);
3324  Assert(!indexForm->indisready);
3325  Assert(!indexForm->indisvalid);
3326  indexForm->indisready = true;
3327  break;
3329  /* Set indisvalid during a CREATE INDEX CONCURRENTLY sequence */
3330  Assert(indexForm->indislive);
3331  Assert(indexForm->indisready);
3332  Assert(!indexForm->indisvalid);
3333  indexForm->indisvalid = true;
3334  break;
3336 
3337  /*
3338  * Clear indisvalid during a DROP INDEX CONCURRENTLY sequence
3339  *
3340  * If indisready == true we leave it set so the index still gets
3341  * maintained by active transactions. We only need to ensure that
3342  * indisvalid is false. (We don't assert that either is initially
3343  * true, though, since we want to be able to retry a DROP INDEX
3344  * CONCURRENTLY that failed partway through.)
3345  *
3346  * Note: the CLUSTER logic assumes that indisclustered cannot be
3347  * set on any invalid index, so clear that flag too.
3348  */
3349  indexForm->indisvalid = false;
3350  indexForm->indisclustered = false;
3351  break;
3352  case INDEX_DROP_SET_DEAD:
3353 
3354  /*
3355  * Clear indisready/indislive during DROP INDEX CONCURRENTLY
3356  *
3357  * We clear both indisready and indislive, because we not only
3358  * want to stop updates, we want to prevent sessions from touching
3359  * the index at all.
3360  */
3361  Assert(!indexForm->indisvalid);
3362  indexForm->indisready = false;
3363  indexForm->indislive = false;
3364  break;
3365  }
3366 
3367  /* ... and write it back in-place */
3368  heap_inplace_update(pg_index, indexTuple);
3369 
3370  table_close(pg_index, RowExclusiveLock);
3371 }
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:409
FormData_pg_index * Form_pg_index
Definition: pg_index.h:66
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
#define Assert(condition)
Definition: c.h:739
#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:228
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39

◆ IndexGetRelation()

Oid IndexGetRelation ( Oid  indexId,
bool  missing_ok 
)

Definition at line 3379 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().

3380 {
3381  HeapTuple tuple;
3383  Oid result;
3384 
3385  tuple = SearchSysCache1(INDEXRELID, ObjectIdGetDatum(indexId));
3386  if (!HeapTupleIsValid(tuple))
3387  {
3388  if (missing_ok)
3389  return InvalidOid;
3390  elog(ERROR, "cache lookup failed for index %u", indexId);
3391  }
3392  index = (Form_pg_index) GETSTRUCT(tuple);
3393  Assert(index->indexrelid == indexId);
3394 
3395  result = index->indrelid;
3396  ReleaseSysCache(tuple);
3397  return result;
3398 }
#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:1116
void ReleaseSysCache(HeapTuple tuple)
Definition: syscache.c:1164
#define InvalidOid
Definition: postgres_ext.h:36
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
#define Assert(condition)
Definition: c.h:739
#define elog(elevel,...)
Definition: elog.h:228

◆ IndexSetParentIndex()

void IndexSetParentIndex ( Relation  idx,
Oid  parentOid 
)

Definition at line 3361 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().

3362 {
3363  Relation pg_inherits;
3364  ScanKeyData key[2];
3365  SysScanDesc scan;
3366  Oid partRelid = RelationGetRelid(partitionIdx);
3367  HeapTuple tuple;
3368  bool fix_dependencies;
3369 
3370  /* Make sure this is an index */
3371  Assert(partitionIdx->rd_rel->relkind == RELKIND_INDEX ||
3372  partitionIdx->rd_rel->relkind == RELKIND_PARTITIONED_INDEX);
3373 
3374  /*
3375  * Scan pg_inherits for rows linking our index to some parent.
3376  */
3377  pg_inherits = relation_open(InheritsRelationId, RowExclusiveLock);
3378  ScanKeyInit(&key[0],
3379  Anum_pg_inherits_inhrelid,
3380  BTEqualStrategyNumber, F_OIDEQ,
3381  ObjectIdGetDatum(partRelid));
3382  ScanKeyInit(&key[1],
3383  Anum_pg_inherits_inhseqno,
3384  BTEqualStrategyNumber, F_INT4EQ,
3385  Int32GetDatum(1));
3386  scan = systable_beginscan(pg_inherits, InheritsRelidSeqnoIndexId, true,
3387  NULL, 2, key);
3388  tuple = systable_getnext(scan);
3389 
3390  if (!HeapTupleIsValid(tuple))
3391  {
3392  if (parentOid == InvalidOid)
3393  {
3394  /*
3395  * No pg_inherits row, and no parent wanted: nothing to do in this
3396  * case.
3397  */
3398  fix_dependencies = false;
3399  }
3400  else
3401  {
3402  Datum values[Natts_pg_inherits];
3403  bool isnull[Natts_pg_inherits];
3404 
3405  /*
3406  * No pg_inherits row exists, and we want a parent for this index,
3407  * so insert it.
3408  */
3409  values[Anum_pg_inherits_inhrelid - 1] = ObjectIdGetDatum(partRelid);
3410  values[Anum_pg_inherits_inhparent - 1] =
3411  ObjectIdGetDatum(parentOid);
3412  values[Anum_pg_inherits_inhseqno - 1] = Int32GetDatum(1);
3413  memset(isnull, false, sizeof(isnull));
3414 
3415  tuple = heap_form_tuple(RelationGetDescr(pg_inherits),
3416  values, isnull);
3417  CatalogTupleInsert(pg_inherits, tuple);
3418 
3419  fix_dependencies = true;
3420  }
3421  }
3422  else
3423  {
3424  Form_pg_inherits inhForm = (Form_pg_inherits) GETSTRUCT(tuple);
3425 
3426  if (parentOid == InvalidOid)
3427  {
3428  /*
3429  * There exists a pg_inherits row, which we want to clear; do so.
3430  */
3431  CatalogTupleDelete(pg_inherits, &tuple->t_self);
3432  fix_dependencies = true;
3433  }
3434  else
3435  {
3436  /*
3437  * A pg_inherits row exists. If it's the same we want, then we're
3438  * good; if it differs, that amounts to a corrupt catalog and
3439  * should not happen.
3440  */
3441  if (inhForm->inhparent != parentOid)
3442  {
3443  /* unexpected: we should not get called in this case */
3444  elog(ERROR, "bogus pg_inherit row: inhrelid %u inhparent %u",
3445  inhForm->inhrelid, inhForm->inhparent);
3446  }
3447 
3448  /* already in the right state */
3449  fix_dependencies = false;
3450  }
3451  }
3452 
3453  /* done with pg_inherits */
3454  systable_endscan(scan);
3455  relation_close(pg_inherits, RowExclusiveLock);
3456 
3457  /* set relhassubclass if an index partition has been added to the parent */
3458  if (OidIsValid(parentOid))
3459  SetRelationHasSubclass(parentOid, true);
3460 
3461  /* set relispartition correctly on the partition */
3462  update_relispartition(partRelid, OidIsValid(parentOid));
3463 
3464  if (fix_dependencies)
3465  {
3466  /*
3467  * Insert/delete pg_depend rows. If setting a parent, add PARTITION
3468  * dependencies on the parent index and the table; if removing a
3469  * parent, delete PARTITION dependencies.
3470  */
3471  if (OidIsValid(parentOid))
3472  {
3473  ObjectAddress partIdx;
3474  ObjectAddress parentIdx;
3475  ObjectAddress partitionTbl;
3476 
3477  ObjectAddressSet(partIdx, RelationRelationId, partRelid);
3478  ObjectAddressSet(parentIdx, RelationRelationId, parentOid);
3479  ObjectAddressSet(partitionTbl, RelationRelationId,
3480  partitionIdx->rd_index->indrelid);
3481  recordDependencyOn(&partIdx, &parentIdx,
3483  recordDependencyOn(&partIdx, &partitionTbl,
3485  }
3486  else
3487  {
3488  deleteDependencyRecordsForClass(RelationRelationId, partRelid,
3489  RelationRelationId,
3491  deleteDependencyRecordsForClass(RelationRelationId, partRelid,
3492  RelationRelationId,
3494  }
3495 
3496  /* make our updates visible */
3498  }
3499 }
void systable_endscan(SysScanDesc sysscan)
Definition: genam.c:525
#define GETSTRUCT(TUP)
Definition: htup_details.h:655
#define RelationGetDescr(relation)
Definition: rel.h:454
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:645
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:2861
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:3506
#define RowExclusiveLock
Definition: lockdefs.h:38
uintptr_t Datum
Definition: postgres.h:367
void CommandCounterIncrement(void)
Definition: xact.c:1005
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:739
#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:228
void ScanKeyInit(ScanKey entry, AttrNumber attributeNumber, StrategyNumber strategy, RegProcedure procedure, Datum argument)
Definition: scankey.c:76
#define RelationGetRelid(relation)
Definition: rel.h:428
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 189 of file index.h.

References ItemPointerSet.

Referenced by heapam_index_validate_scan().

190 {
191  BlockNumber block = (BlockNumber) (encoded >> 16);
192  OffsetNumber offset = (OffsetNumber) (encoded & 0xFFFF);
193 
194  ItemPointerSet(itemptr, block, offset);
195 }
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 168 of file index.h.

References ItemPointerGetBlockNumber, and ItemPointerGetOffsetNumber.

Referenced by validate_index_callback().

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

3406 {
3407  Relation iRel,
3408  heapRelation;
3409  Oid heapId;
3410  IndexInfo *indexInfo;
3411  volatile bool skipped_constraint = false;
3412  PGRUsage ru0;
3414 
3415  pg_rusage_init(&ru0);
3416 
3417  /*
3418  * Open and lock the parent heap relation. ShareLock is sufficient since
3419  * we only need to be sure no schema or data changes are going on.
3420  */
3421  heapId = IndexGetRelation(indexId, false);
3422  heapRelation = table_open(heapId, ShareLock);
3423 
3424  if (progress)
3425  {
3427  heapId);
3431  indexId);
3432  }
3433 
3434  /*
3435  * Open the target index relation and get an exclusive lock on it, to
3436  * ensure that no one else is touching this particular index.
3437  */
3438  iRel = index_open(indexId, AccessExclusiveLock);
3439 
3440  if (progress)
3442  iRel->rd_rel->relam);
3443 
3444  /*
3445  * The case of reindexing partitioned tables and indexes is handled
3446  * differently by upper layers, so this case shouldn't arise.
3447  */
3448  if (iRel->rd_rel->relkind == RELKIND_PARTITIONED_INDEX)
3449  elog(ERROR, "unsupported relation kind for index \"%s\"",
3450  RelationGetRelationName(iRel));
3451 
3452  /*
3453  * Don't allow reindex on temp tables of other backends ... their local
3454  * buffer manager is not going to cope.
3455  */
3456  if (RELATION_IS_OTHER_TEMP(iRel))
3457  ereport(ERROR,
3458  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
3459  errmsg("cannot reindex temporary tables of other sessions")));
3460 
3461  /*
3462  * Also check for active uses of the index in the current transaction; we
3463  * don't want to reindex underneath an open indexscan.
3464  */
3465  CheckTableNotInUse(iRel, "REINDEX INDEX");
3466 
3467  /*
3468  * All predicate locks on the index are about to be made invalid. Promote
3469  * them to relation locks on the heap.
3470  */
3472 
3473  /* Fetch info needed for index_build */
3474  indexInfo = BuildIndexInfo(iRel);
3475 
3476  /* If requested, skip checking uniqueness/exclusion constraints */
3477  if (skip_constraint_checks)
3478  {
3479  if (indexInfo->ii_Unique || indexInfo->ii_ExclusionOps != NULL)
3480  skipped_constraint = true;
3481  indexInfo->ii_Unique = false;
3482  indexInfo->ii_ExclusionOps = NULL;
3483  indexInfo->ii_ExclusionProcs = NULL;
3484  indexInfo->ii_ExclusionStrats = NULL;
3485  }
3486 
3487  /* ensure SetReindexProcessing state isn't leaked */
3488  PG_TRY();
3489  {
3490  /* Suppress use of the target index while rebuilding it */
3491  SetReindexProcessing(heapId, indexId);
3492 
3493  /* Create a new physical relation for the index */
3494  RelationSetNewRelfilenode(iRel, persistence);
3495 
3496  /* Initialize the index and rebuild */
3497  /* Note: we do not need to re-establish pkey setting */
3498  index_build(heapRelation, iRel, indexInfo, true, true);
3499  }
3500  PG_FINALLY();
3501  {
3502  /* Make sure flag gets cleared on error exit */
3504  }
3505  PG_END_TRY();
3506 
3507  /*
3508  * If the index is marked invalid/not-ready/dead (ie, it's from a failed
3509  * CREATE INDEX CONCURRENTLY, or a DROP INDEX CONCURRENTLY failed midway),
3510  * and we didn't skip a uniqueness check, we can now mark it valid. This
3511  * allows REINDEX to be used to clean up in such cases.
3512  *
3513  * We can also reset indcheckxmin, because we have now done a
3514  * non-concurrent index build, *except* in the case where index_build
3515  * found some still-broken HOT chains. If it did, and we don't have to
3516  * change any of the other flags, we just leave indcheckxmin alone (note
3517  * that index_build won't have changed it, because this is a reindex).
3518  * This is okay and desirable because not updating the tuple leaves the
3519  * index's usability horizon (recorded as the tuple's xmin value) the same
3520  * as it was.
3521  *
3522  * But, if the index was invalid/not-ready/dead and there were broken HOT
3523  * chains, we had better force indcheckxmin true, because the normal
3524  * argument that the HOT chains couldn't conflict with the index is
3525  * suspect for an invalid index. (A conflict is definitely possible if
3526  * the index was dead. It probably shouldn't happen otherwise, but let's
3527  * be conservative.) In this case advancing the usability horizon is
3528  * appropriate.
3529  *
3530  * Another reason for avoiding unnecessary updates here is that while
3531  * reindexing pg_index itself, we must not try to update tuples in it.
3532  * pg_index's indexes should always have these flags in their clean state,
3533  * so that won't happen.
3534  *
3535  * If early pruning/vacuuming is enabled for the heap relation, the
3536  * usability horizon must be advanced to the current transaction on every
3537  * build or rebuild. pg_index is OK in this regard because catalog tables
3538  * are not subject to early cleanup.
3539  */
3540  if (!skipped_constraint)
3541  {
3542  Relation pg_index;
3543  HeapTuple indexTuple;
3544  Form_pg_index indexForm;
3545  bool index_bad;
3546  bool early_pruning_enabled = EarlyPruningEnabled(heapRelation);
3547 
3548  pg_index = table_open(IndexRelationId, RowExclusiveLock);
3549 
3550  indexTuple = SearchSysCacheCopy1(INDEXRELID,
3551  ObjectIdGetDatum(indexId));
3552  if (!HeapTupleIsValid(indexTuple))
3553  elog(ERROR, "cache lookup failed for index %u", indexId);
3554  indexForm = (Form_pg_index) GETSTRUCT(indexTuple);
3555 
3556  index_bad = (!indexForm->indisvalid ||
3557  !indexForm->indisready ||
3558  !indexForm->indislive);
3559  if (index_bad ||
3560  (indexForm->indcheckxmin && !indexInfo->ii_BrokenHotChain) ||
3561  early_pruning_enabled)
3562  {
3563  if (!indexInfo->ii_BrokenHotChain && !early_pruning_enabled)
3564  indexForm->indcheckxmin = false;
3565  else if (index_bad || early_pruning_enabled)
3566  indexForm->indcheckxmin = true;
3567  indexForm->indisvalid = true;
3568  indexForm->indisready = true;
3569  indexForm->indislive = true;
3570  CatalogTupleUpdate(pg_index, &indexTuple->t_self, indexTuple);
3571 
3572  /*
3573  * Invalidate the relcache for the table, so that after we commit
3574  * all sessions will refresh the table's index list. This ensures
3575  * that if anyone misses seeing the pg_index row during this
3576  * update, they'll refresh their list before attempting any update
3577  * on the table.
3578  */
3579  CacheInvalidateRelcache(heapRelation);
3580  }
3581 
3582  table_close(pg_index, RowExclusiveLock);
3583  }
3584 
3585  /* Log what we did */
3587  ereport(INFO,
3588  (errmsg("index \"%s\" was reindexed",
3589  get_rel_name(indexId)),
3590  errdetail_internal("%s",
3591  pg_rusage_show(&ru0))));
3592 
3593  if (progress)
3595 
3596  /* Close rels, but keep locks */
3597  index_close(iRel, NoLock);
3598  table_close(heapRelation, NoLock);
3599 }
Oid IndexGetRelation(Oid indexId, bool missing_ok)
Definition: index.c:3379
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:3192
static void SetReindexProcessing(Oid heapOid, Oid indexOid)
Definition: index.c:3804
void pgstat_progress_update_param(int index, int64 val)
Definition: pgstat.c:3213
#define REINDEXOPT_REPORT_PROGRESS
Definition: parsenodes.h:3337
Oid * ii_ExclusionProcs
Definition: execnodes.h:164
int errcode(int sqlerrcode)
Definition: elog.c:608
#define INFO
Definition: elog.h:33
IndexInfo * BuildIndexInfo(Relation index)
Definition: index.c:2284
Form_pg_class rd_rel
Definition: rel.h:84
unsigned int Oid
Definition: postgres_ext.h:31
#define REINDEXOPT_VERBOSE
Definition: parsenodes.h:3336
int errdetail_internal(const char *fmt,...)
Definition: elog.c:982
static void ResetReindexProcessing(void)
Definition: index.c:3821
void pg_rusage_init(PGRUsage *ru0)
Definition: pg_rusage.c:27
void RelationSetNewRelfilenode(Relation relation, char persistence)
Definition: relcache.c:3420
#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:80
const char * pg_rusage_show(const PGRUsage *ru0)
Definition: pg_rusage.c:40
#define RelationGetRelationName(relation)
Definition: rel.h:462
bool ii_BrokenHotChain
Definition: execnodes.h:172
void CheckTableNotInUse(Relation rel, const char *stmt)
Definition: tablecmds.c:3445
#define ereport(elevel, rest)
Definition: elog.h:141
void TransferPredicateLocksToHeapRelation(Relation relation)
Definition: predicate.c:3081
FormData_pg_index * Form_pg_index
Definition: pg_index.h:66
int progress
Definition: pgbench.c:234
#define PG_FINALLY()
Definition: elog.h:339
void pgstat_progress_end_command(void)
Definition: pgstat.c:3264
#define PROGRESS_CREATEIDX_COMMAND_REINDEX
Definition: progress.h:110
bool ii_Unique
Definition: execnodes.h:169
void index_build(Relation heapRelation, Relation indexRelation, IndexInfo *indexInfo, bool isreindex, bool parallel)
Definition: index.c:2793
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
#define RELATION_IS_OTHER_TEMP(relation)
Definition: rel.h:558
void CatalogTupleUpdate(Relation heapRel, ItemPointer otid, HeapTuple tup)
Definition: indexing.c:224
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:163
int errmsg(const char *fmt,...)
Definition: elog.c:822
#define elog(elevel,...)
Definition: elog.h:228
#define ShareLock
Definition: lockdefs.h:41
uint16 * ii_ExclusionStrats
Definition: execnodes.h:165
#define PG_TRY()
Definition: elog.h:322
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:79
Relation index_open(Oid relationId, LOCKMODE lockmode)
Definition: indexam.c:126
#define PG_END_TRY()
Definition: elog.h:347
#define PROGRESS_CREATEIDX_ACCESS_METHOD_OID
Definition: progress.h:81

◆ reindex_relation()

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

Definition at line 3637 of file index.c.

References Assert, CommandCounterIncrement(), ereport, errcode(), errmsg(), i, lfirst_oid, NIL, NoLock, OidIsValid, PG_END_TRY, PG_FINALLY, 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().

3638 {
3639  Relation rel;
3640  Oid toast_relid;
3641  List *indexIds;
3642  bool result;
3643  int i;
3644 
3645  /*
3646  * Open and lock the relation. ShareLock is sufficient since we only need
3647  * to prevent schema and data changes in it. The lock level used here
3648  * should match ReindexTable().
3649  */
3650  rel = table_open(relid, ShareLock);
3651 
3652  /*
3653  * This may be useful when implemented someday; but that day is not today.
3654  * For now, avoid erroring out when called in a multi-table context
3655  * (REINDEX SCHEMA) and happen to come across a partitioned table. The
3656  * partitions may be reindexed on their own anyway.
3657  */
3658  if (rel->rd_rel->relkind == RELKIND_PARTITIONED_TABLE)
3659  {
3660  ereport(WARNING,
3661  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
3662  errmsg("REINDEX of partitioned tables is not yet implemented, skipping \"%s\"",
3663  RelationGetRelationName(rel))));
3664  table_close(rel, ShareLock);
3665  return false;
3666  }
3667 
3668  toast_relid = rel->rd_rel->reltoastrelid;
3669 
3670  /*
3671  * Get the list of index OIDs for this relation. (We trust to the
3672  * relcache to get this with a sequential scan if ignoring system
3673  * indexes.)
3674  */
3675  indexIds = RelationGetIndexList(rel);
3676 
3677  PG_TRY();
3678  {
3679  ListCell *indexId;
3680  char persistence;
3681 
3682  if (flags & REINDEX_REL_SUPPRESS_INDEX_USE)
3683  {
3684  /* Suppress use of all the indexes until they are rebuilt */
3685  SetReindexPending(indexIds);
3686 
3687  /*
3688  * Make the new heap contents visible --- now things might be
3689  * inconsistent!
3690  */
3692  }
3693 
3694  /*
3695  * Compute persistence of indexes: same as that of owning rel, unless
3696  * caller specified otherwise.
3697  */
3699  persistence = RELPERSISTENCE_UNLOGGED;
3700  else if (flags & REINDEX_REL_FORCE_INDEXES_PERMANENT)
3701  persistence = RELPERSISTENCE_PERMANENT;
3702  else
3703  persistence = rel->rd_rel->relpersistence;
3704 
3705  /* Reindex all the indexes. */
3706  i = 1;
3707  foreach(indexId, indexIds)
3708  {
3709  Oid indexOid = lfirst_oid(indexId);
3710 
3711  reindex_index(indexOid, !(flags & REINDEX_REL_CHECK_CONSTRAINTS),
3712  persistence, options);
3713 
3715 
3716  /* Index should no longer be in the pending list */
3717  Assert(!ReindexIsProcessingIndex(indexOid));
3718 
3719  /* Set index rebuild count */
3721  i);
3722  i++;
3723  }
3724  }
3725  PG_FINALLY();
3726  {
3727  /* Make sure list gets cleared on error exit */
3729  }
3730  PG_END_TRY();
3731 
3732  /*
3733  * Close rel, but continue to hold the lock.
3734  */
3735  table_close(rel, NoLock);
3736 
3737  result = (indexIds != NIL);
3738 
3739  /*
3740  * If the relation has a secondary toast rel, reindex that too while we
3741  * still hold the lock on the master table.
3742  */
3743  if ((flags & REINDEX_REL_PROCESS_TOAST) && OidIsValid(toast_relid))
3744  result |= reindex_relation(toast_relid, flags, options);
3745 
3746  return result;
3747 }
#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:3836
void pgstat_progress_update_param(int index, int64 val)
Definition: pgstat.c:3213
static void ResetReindexPending(void)
Definition: index.c:3864
int errcode(int sqlerrcode)
Definition: elog.c:608
#define REINDEX_REL_SUPPRESS_INDEX_USE
Definition: index.h:139
Form_pg_class rd_rel
Definition: rel.h:84
unsigned int Oid
Definition: postgres_ext.h:31
#define OidIsValid(objectId)
Definition: c.h:645
#define NoLock
Definition: lockdefs.h:34
#define RelationGetRelationName(relation)
Definition: rel.h:462
#define ereport(elevel, rest)
Definition: elog.h:141
#define WARNING
Definition: elog.h:40
#define PG_FINALLY()
Definition: elog.h:339
void CommandCounterIncrement(void)
Definition: xact.c:1005
#define REINDEX_REL_FORCE_INDEXES_UNLOGGED
Definition: index.h:141
#define Assert(condition)
Definition: c.h:739
#define REINDEX_REL_CHECK_CONSTRAINTS
Definition: index.h:140
List * RelationGetIndexList(Relation relation)
Definition: relcache.c:4330
void reindex_index(Oid indexId, bool skip_constraint_checks, char persistence, int options)
Definition: index.c:3404
int errmsg(const char *fmt,...)
Definition: elog.c:822
#define ShareLock
Definition: lockdefs.h:41
int i
#define PROGRESS_CLUSTER_INDEX_REBUILD_COUNT
Definition: progress.h:62
#define REINDEX_REL_FORCE_INDEXES_PERMANENT
Definition: index.h:142
#define REINDEX_REL_PROCESS_TOAST
Definition: index.h:138
#define PG_TRY()
Definition: elog.h:322
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39
bool ReindexIsProcessingIndex(Oid indexOid)
Definition: index.c:3791
bool reindex_relation(Oid relid, int flags, int options)
Definition: index.c:3637
Definition: pg_list.h:50
#define PG_END_TRY()
Definition: elog.h:347
#define lfirst_oid(lc)
Definition: pg_list.h:192

◆ ReindexIsProcessingHeap()

bool ReindexIsProcessingHeap ( Oid  heapOid)

Definition at line 3770 of file index.c.

References currentlyReindexedHeap.

Referenced by index_update_stats().

3771 {
3772  return heapOid == currentlyReindexedHeap;
3773 }
static Oid currentlyReindexedHeap
Definition: index.c:3761

◆ ReindexIsProcessingIndex()

bool ReindexIsProcessingIndex ( Oid  indexOid)

Definition at line 3791 of file index.c.

References currentlyReindexedIndex, and list_member_oid().

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

3792 {
3793  return indexOid == currentlyReindexedIndex ||
3795 }
static List * pendingReindexedIndexes
Definition: index.c:3763
static Oid currentlyReindexedIndex
Definition: index.c:3762
bool list_member_oid(const List *list, Oid datum)
Definition: list.c:675

◆ RestoreReindexState()

void RestoreReindexState ( void *  reindexstate)

Definition at line 3904 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().

3905 {
3906  SerializedReindexState *sistate = (SerializedReindexState *) reindexstate;
3907  int c = 0;
3908  MemoryContext oldcontext;
3909 
3912 
3915  for (c = 0; c < sistate->numPendingReindexedIndexes; ++c)
3918  sistate->pendingReindexedIndexes[c]);
3919  MemoryContextSwitchTo(oldcontext);
3920 }
#define NIL
Definition: pg_list.h:65
static Oid currentlyReindexedHeap
Definition: index.c:3761
Oid currentlyReindexedIndex
Definition: index.c:93
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
static List * pendingReindexedIndexes
Definition: index.c:3763
Oid pendingReindexedIndexes[FLEXIBLE_ARRAY_MEMBER]
Definition: index.c:95
List * lappend_oid(List *list, Oid datum)
Definition: list.c:358
char * c
MemoryContext TopMemoryContext
Definition: mcxt.c:44
int numPendingReindexedIndexes
Definition: index.c:94
static Oid currentlyReindexedIndex
Definition: index.c:3762
#define Assert(condition)
Definition: c.h:739
Oid currentlyReindexedHeap
Definition: index.c:92

◆ SerializeReindexState()

void SerializeReindexState ( Size  maxsize,
char *  start_address 
)

Definition at line 3886 of file index.c.

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

Referenced by InitializeParallelDSM().

3887 {
3888  SerializedReindexState *sistate = (SerializedReindexState *) start_address;
3889  int c = 0;
3890  ListCell *lc;
3891 
3895  foreach(lc, pendingReindexedIndexes)
3896  sistate->pendingReindexedIndexes[c++] = lfirst_oid(lc);
3897 }
static Oid currentlyReindexedHeap
Definition: index.c:3761
Oid currentlyReindexedIndex
Definition: index.c:93
static List * pendingReindexedIndexes
Definition: index.c:3763
Oid pendingReindexedIndexes[FLEXIBLE_ARRAY_MEMBER]
Definition: index.c:95
char * c
int numPendingReindexedIndexes
Definition: index.c:94
static Oid currentlyReindexedIndex
Definition: index.c:3762
static int list_length(const List *l)
Definition: pg_list.h:169
Oid currentlyReindexedHeap
Definition: index.c:92
#define lfirst_oid(lc)
Definition: pg_list.h:192

◆ validate_index()

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

Definition at line 3144 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().

3145 {
3146  Relation heapRelation,
3147  indexRelation;
3148  IndexInfo *indexInfo;
3149  IndexVacuumInfo ivinfo;
3151  Oid save_userid;
3152  int save_sec_context;
3153  int save_nestlevel;
3154 
3155  {
3156  const int index[] = {
3162  };
3163  const int64 val[] = {
3165  0, 0, 0, 0
3166  };
3167 
3168  pgstat_progress_update_multi_param(5, index, val);
3169  }
3170 
3171  /* Open and lock the parent heap relation */
3172  heapRelation = table_open(heapId, ShareUpdateExclusiveLock);
3173  /* And the target index relation */
3174  indexRelation = index_open(indexId, RowExclusiveLock);
3175 
3176  /*
3177  * Fetch info needed for index_insert. (You might think this should be
3178  * passed in from DefineIndex, but its copy is long gone due to having
3179  * been built in a previous transaction.)
3180  */
3181  indexInfo = BuildIndexInfo(indexRelation);
3182 
3183  /* mark build is concurrent just for consistency */
3184  indexInfo->ii_Concurrent = true;
3185 
3186  /*
3187  * Switch to the table owner's userid, so that any index functions are run
3188  * as that user. Also lock down security-restricted operations and
3189  * arrange to make GUC variable changes local to this command.
3190  */
3191  GetUserIdAndSecContext(&save_userid, &save_sec_context);
3192  SetUserIdAndSecContext(heapRelation->rd_rel->relowner,
3193  save_sec_context | SECURITY_RESTRICTED_OPERATION);
3194  save_nestlevel = NewGUCNestLevel();
3195 
3196  /*
3197  * Scan the index and gather up all the TIDs into a tuplesort object.
3198  */
3199  ivinfo.index = indexRelation;
3200  ivinfo.analyze_only = false;
3201  ivinfo.report_progress = true;
3202  ivinfo.estimated_count = true;
3203  ivinfo.message_level = DEBUG2;
3204  ivinfo.num_heap_tuples = heapRelation->rd_rel->reltuples;
3205  ivinfo.strategy = NULL;
3206 
3207  /*
3208  * Encode TIDs as int8 values for the sort, rather than directly sorting
3209  * item pointers. This can be significantly faster, primarily because TID
3210  * is a pass-by-reference type on all platforms, whereas int8 is
3211  * pass-by-value on most platforms.
3212  */
3213  state.tuplesort = tuplesort_begin_datum(INT8OID, Int8LessOperator,
3214  InvalidOid, false,
3216  NULL, false);
3217  state.htups = state.itups = state.tups_inserted = 0;
3218 
3219  /* ambulkdelete updates progress metrics */
3220  (void) index_bulk_delete(&ivinfo, NULL,
3221  validate_index_callback, (void *) &state);
3222 
3223  /* Execute the sort */
3224  {
3225  const int index[] = {
3229  };
3230  const int64 val[] = {
3232  0, 0
3233  };
3234 
3235  pgstat_progress_update_multi_param(3, index, val);
3236  }
3238 
3239  /*
3240  * Now scan the heap and "merge" it with the index
3241  */
3244  table_index_validate_scan(heapRelation,
3245  indexRelation,
3246  indexInfo,
3247  snapshot,
3248  &state);
3249 
3250  /* Done with tuplesort object */
3251  tuplesort_end(state.tuplesort);
3252 
3253  elog(DEBUG2,
3254  "validate_index found %.0f heap tuples, %.0f index tuples; inserted %.0f missing tuples",
3255  state.htups, state.itups, state.tups_inserted);
3256 
3257  /* Roll back any GUC changes executed by index functions */
3258  AtEOXact_GUC(false, save_nestlevel);
3259 
3260  /* Restore userid and security context */
3261  SetUserIdAndSecContext(save_userid, save_sec_context);
3262 
3263  /* Close rels, but keep locks */
3264  index_close(indexRelation, NoLock);
3265  table_close(heapRelation, NoLock);
3266 }
#define PROGRESS_CREATEIDX_PHASE_VALIDATE_SORT
Definition: progress.h:95
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:298
void SetUserIdAndSecContext(Oid userid, int sec_context)
Definition: miscinit.c:492
void pgstat_progress_update_param(int index, int64 val)
Definition: pgstat.c:3213
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:84
IndexInfo * BuildIndexInfo(Relation index)
Definition: index.c:2284
Form_pg_class rd_rel
Definition: rel.h:84
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:5805
#define PROGRESS_CREATEIDX_PHASE
Definition: progress.h:82
#define PROGRESS_SCAN_BLOCKS_DONE
Definition: progress.h:120
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:96
void pgstat_progress_update_multi_param(int nparam, const int *index, const int64 *val)
Definition: pgstat.c:3235
#define PROGRESS_SCAN_BLOCKS_TOTAL
Definition: progress.h:119
bool ii_Concurrent
Definition: execnodes.h:171
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:94
int NewGUCNestLevel(void)
Definition: guc.c:5791
static void table_index_validate_scan(Relation table_rel, Relation index_rel, struct IndexInfo *index_info, Snapshot snapshot, struct ValidateIndexState *state)
Definition: tableam.h:1581
#define PROGRESS_CREATEIDX_TUPLES_DONE
Definition: progress.h:85
#define elog(elevel,...)
Definition: elog.h:228
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:3272
long val
Definition: informix.c:664
Relation index_open(Oid relationId, LOCKMODE lockmode)
Definition: indexam.c:126
bool estimated_count
Definition: genam.h:49