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)
 
Oid IndexGetRelation (Oid indexId, bool missing_ok)
 
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)
 
void ResetReindexState (int nestLevel)
 
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 142 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 144 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 143 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 141 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 2374 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().

2375 {
2376  IndexInfo *ii;
2377  Form_pg_index indexStruct = index->rd_index;
2378  int i;
2379  int numAtts;
2380 
2381  /* check the number of keys, and copy attr numbers into the IndexInfo */
2382  numAtts = indexStruct->indnatts;
2383  if (numAtts < 1 || numAtts > INDEX_MAX_KEYS)
2384  elog(ERROR, "invalid indnatts %d for index %u",
2385  numAtts, RelationGetRelid(index));
2386 
2387  /*
2388  * Create the node, using dummy index expressions, and pretending there is
2389  * no predicate.
2390  */
2391  ii = makeIndexInfo(indexStruct->indnatts,
2392  indexStruct->indnkeyatts,
2393  index->rd_rel->relam,
2395  NIL,
2396  indexStruct->indisunique,
2397  indexStruct->indisready,
2398  false);
2399 
2400  /* fill in attribute numbers */
2401  for (i = 0; i < numAtts; i++)
2402  ii->ii_IndexAttrNumbers[i] = indexStruct->indkey.values[i];
2403 
2404  /* We ignore the exclusion constraint if any */
2405 
2406  return ii;
2407 }
#define NIL
Definition: pg_list.h:65
List * RelationGetDummyIndexExpressions(Relation relation)
Definition: relcache.c:4799
Form_pg_class rd_rel
Definition: rel.h:109
Form_pg_index rd_index
Definition: rel.h:174
#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:214
int i
AttrNumber ii_IndexAttrNumbers[INDEX_MAX_KEYS]
Definition: execnodes.h:160
#define RelationGetRelid(relation)
Definition: rel.h:456

◆ BuildIndexInfo()

IndexInfo* BuildIndexInfo ( Relation  index)

Definition at line 2315 of file index.c.

References elog, ERROR, i, IndexInfo::ii_ExclusionOps, IndexInfo::ii_ExclusionProcs, IndexInfo::ii_ExclusionStrats, IndexInfo::ii_IndexAttrNumbers, IndexInfo::ii_OpclassOptions, INDEX_MAX_KEYS, makeIndexInfo(), RelationData::rd_index, RelationData::rd_rel, RelationGetExclusionInfo(), RelationGetIndexExpressions(), RelationGetIndexPredicate(), RelationGetIndexRawAttOptions(), 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().

2316 {
2317  IndexInfo *ii;
2318  Form_pg_index indexStruct = index->rd_index;
2319  int i;
2320  int numAtts;
2321 
2322  /* check the number of keys, and copy attr numbers into the IndexInfo */
2323  numAtts = indexStruct->indnatts;
2324  if (numAtts < 1 || numAtts > INDEX_MAX_KEYS)
2325  elog(ERROR, "invalid indnatts %d for index %u",
2326  numAtts, RelationGetRelid(index));
2327 
2328  /*
2329  * Create the node, fetching any expressions needed for expressional
2330  * indexes and index predicate if any.
2331  */
2332  ii = makeIndexInfo(indexStruct->indnatts,
2333  indexStruct->indnkeyatts,
2334  index->rd_rel->relam,
2337  indexStruct->indisunique,
2338  indexStruct->indisready,
2339  false);
2340 
2341  /* fill in attribute numbers */
2342  for (i = 0; i < numAtts; i++)
2343  ii->ii_IndexAttrNumbers[i] = indexStruct->indkey.values[i];
2344 
2345  /* fetch exclusion constraint info if any */
2346  if (indexStruct->indisexclusion)
2347  {
2349  &ii->ii_ExclusionOps,
2350  &ii->ii_ExclusionProcs,
2351  &ii->ii_ExclusionStrats);
2352  }
2353 
2355 
2356  return ii;
2357 }
void RelationGetExclusionInfo(Relation indexRelation, Oid **operators, Oid **procs, uint16 **strategies)
Definition: relcache.c:5174
Oid * ii_ExclusionProcs
Definition: execnodes.h:166
Form_pg_class rd_rel
Definition: rel.h:109
List * RelationGetIndexPredicate(Relation relation)
Definition: relcache.c:4853
Form_pg_index rd_index
Definition: rel.h:174
#define ERROR
Definition: elog.h:43
List * RelationGetIndexExpressions(Relation relation)
Definition: relcache.c:4740
IndexInfo * makeIndexInfo(int numattrs, int numkeyattrs, Oid amoid, List *expressions, List *predicates, bool unique, bool isready, bool concurrent)
Definition: makefuncs.c:740
Datum * RelationGetIndexRawAttOptions(Relation indexrel)
Definition: relcache.c:5382
FormData_pg_index * Form_pg_index
Definition: pg_index.h:66
#define INDEX_MAX_KEYS
Oid * ii_ExclusionOps
Definition: execnodes.h:165
#define elog(elevel,...)
Definition: elog.h:214
int i
AttrNumber ii_IndexAttrNumbers[INDEX_MAX_KEYS]
Definition: execnodes.h:160
uint16 * ii_ExclusionStrats
Definition: execnodes.h:167
#define RelationGetRelid(relation)
Definition: rel.h:456
Datum * ii_OpclassOptions
Definition: execnodes.h:171

◆ BuildSpeculativeIndexInfo()

void BuildSpeculativeIndexInfo ( Relation  index,
IndexInfo ii 
)

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

2540 {
2541  int indnkeyatts;
2542  int i;
2543 
2544  indnkeyatts = IndexRelationGetNumberOfKeyAttributes(index);
2545 
2546  /*
2547  * fetch info for checking unique indexes
2548  */
2549  Assert(ii->ii_Unique);
2550 
2551  if (index->rd_rel->relam != BTREE_AM_OID)
2552  elog(ERROR, "unexpected non-btree speculative unique index");
2553 
2554  ii->ii_UniqueOps = (Oid *) palloc(sizeof(Oid) * indnkeyatts);
2555  ii->ii_UniqueProcs = (Oid *) palloc(sizeof(Oid) * indnkeyatts);
2556  ii->ii_UniqueStrats = (uint16 *) palloc(sizeof(uint16) * indnkeyatts);
2557 
2558  /*
2559  * We have to look up the operator's strategy number. This provides a
2560  * cross-check that the operator does match the index.
2561  */
2562  /* We need the func OIDs and strategy numbers too */
2563  for (i = 0; i < indnkeyatts; i++)
2564  {
2566  ii->ii_UniqueOps[i] =
2567  get_opfamily_member(index->rd_opfamily[i],
2568  index->rd_opcintype[i],
2569  index->rd_opcintype[i],
2570  ii->ii_UniqueStrats[i]);
2571  if (!OidIsValid(ii->ii_UniqueOps[i]))
2572  elog(ERROR, "missing operator %d(%u,%u) in opfamily %u",
2573  ii->ii_UniqueStrats[i], index->rd_opcintype[i],
2574  index->rd_opcintype[i], index->rd_opfamily[i]);
2575  ii->ii_UniqueProcs[i] = get_opcode(ii->ii_UniqueOps[i]);
2576  }
2577 }
uint16 * ii_UniqueStrats
Definition: execnodes.h:170
Form_pg_class rd_rel
Definition: rel.h:109
unsigned int Oid
Definition: postgres_ext.h:31
#define OidIsValid(objectId)
Definition: c.h:644
Oid * ii_UniqueOps
Definition: execnodes.h:168
unsigned short uint16
Definition: c.h:366
#define ERROR
Definition: elog.h:43
Oid * ii_UniqueProcs
Definition: execnodes.h:169
Oid get_opfamily_member(Oid opfamily, Oid lefttype, Oid righttype, int16 strategy)
Definition: lsyscache.c:164
Oid * rd_opfamily
Definition: rel.h:189
#define IndexRelationGetNumberOfKeyAttributes(relation)
Definition: rel.h:475
RegProcedure get_opcode(Oid opno)
Definition: lsyscache.c:1202
bool ii_Unique
Definition: execnodes.h:172
#define Assert(condition)
Definition: c.h:738
void * palloc(Size size)
Definition: mcxt.c:949
#define elog(elevel,...)
Definition: elog.h:214
int i
Oid * rd_opcintype
Definition: rel.h:190
#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 2420 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().

2424 {
2425  int i;
2426 
2427  if (info1->ii_Unique != info2->ii_Unique)
2428  return false;
2429 
2430  /* indexes are only equivalent if they have the same access method */
2431  if (info1->ii_Am != info2->ii_Am)
2432  return false;
2433 
2434  /* and same number of attributes */
2435  if (info1->ii_NumIndexAttrs != info2->ii_NumIndexAttrs)
2436  return false;
2437 
2438  /* and same number of key attributes */
2439  if (info1->ii_NumIndexKeyAttrs != info2->ii_NumIndexKeyAttrs)
2440  return false;
2441 
2442  /*
2443  * and columns match through the attribute map (actual attribute numbers
2444  * might differ!) Note that this implies that index columns that are
2445  * expressions appear in the same positions. We will next compare the
2446  * expressions themselves.
2447  */
2448  for (i = 0; i < info1->ii_NumIndexAttrs; i++)
2449  {
2450  if (attmap->maplen < info2->ii_IndexAttrNumbers[i])
2451  elog(ERROR, "incorrect attribute map");
2452 
2453  /* ignore expressions at this stage */
2454  if ((info1->ii_IndexAttrNumbers[i] != InvalidAttrNumber) &&
2455  (attmap->attnums[info2->ii_IndexAttrNumbers[i] - 1] !=
2456  info1->ii_IndexAttrNumbers[i]))
2457  return false;
2458 
2459  /* collation and opfamily is not valid for including columns */
2460  if (i >= info1->ii_NumIndexKeyAttrs)
2461  continue;
2462 
2463  if (collations1[i] != collations2[i])
2464  return false;
2465  if (opfamilies1[i] != opfamilies2[i])
2466  return false;
2467  }
2468 
2469  /*
2470  * For expression indexes: either both are expression indexes, or neither
2471  * is; if they are, make sure the expressions match.
2472  */
2473  if ((info1->ii_Expressions != NIL) != (info2->ii_Expressions != NIL))
2474  return false;
2475  if (info1->ii_Expressions != NIL)
2476  {
2477  bool found_whole_row;
2478  Node *mapped;
2479 
2480  mapped = map_variable_attnos((Node *) info2->ii_Expressions,
2481  1, 0, attmap,
2482  InvalidOid, &found_whole_row);
2483  if (found_whole_row)
2484  {
2485  /*
2486  * we could throw an error here, but seems out of scope for this
2487  * routine.
2488  */
2489  return false;
2490  }
2491 
2492  if (!equal(info1->ii_Expressions, mapped))
2493  return false;
2494  }
2495 
2496  /* Partial index predicates must be identical, if they exist */
2497  if ((info1->ii_Predicate == NULL) != (info2->ii_Predicate == NULL))
2498  return false;
2499  if (info1->ii_Predicate != NULL)
2500  {
2501  bool found_whole_row;
2502  Node *mapped;
2503 
2504  mapped = map_variable_attnos((Node *) info2->ii_Predicate,
2505  1, 0, attmap,
2506  InvalidOid, &found_whole_row);
2507  if (found_whole_row)
2508  {
2509  /*
2510  * we could throw an error here, but seems out of scope for this
2511  * routine.
2512  */
2513  return false;
2514  }
2515  if (!equal(info1->ii_Predicate, mapped))
2516  return false;
2517  }
2518 
2519  /* No support currently for comparing exclusion indexes. */
2520  if (info1->ii_ExclusionOps != NULL || info2->ii_ExclusionOps != NULL)
2521  return false;
2522 
2523  return true;
2524 }
#define NIL
Definition: pg_list.h:65
List * ii_Predicate
Definition: execnodes.h:163
bool equal(const void *a, const void *b)
Definition: equalfuncs.c:3033
int maplen
Definition: attmap.h:37
Definition: nodes.h:529
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:159
int ii_NumIndexAttrs
Definition: execnodes.h:158
#define InvalidOid
Definition: postgres_ext.h:36
bool ii_Unique
Definition: execnodes.h:172
List * ii_Expressions
Definition: execnodes.h:161
AttrNumber * attnums
Definition: attmap.h:36
#define InvalidAttrNumber
Definition: attnum.h:23
Oid * ii_ExclusionOps
Definition: execnodes.h:165
#define elog(elevel,...)
Definition: elog.h:214
int i
AttrNumber ii_IndexAttrNumbers[INDEX_MAX_KEYS]
Definition: execnodes.h:160
Oid ii_Am
Definition: execnodes.h:177

◆ EstimateReindexStateSpace()

Size EstimateReindexStateSpace ( void  )

Definition at line 3938 of file index.c.

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

Referenced by InitializeParallelDSM().

3939 {
3942 }
static List * pendingReindexedIndexes
Definition: index.c:3807
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:661

◆ FormIndexDatum()

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

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

2604 {
2605  ListCell *indexpr_item;
2606  int i;
2607 
2608  if (indexInfo->ii_Expressions != NIL &&
2609  indexInfo->ii_ExpressionsState == NIL)
2610  {
2611  /* First time through, set up expression evaluation state */
2612  indexInfo->ii_ExpressionsState =
2613  ExecPrepareExprList(indexInfo->ii_Expressions, estate);
2614  /* Check caller has set up context correctly */
2615  Assert(GetPerTupleExprContext(estate)->ecxt_scantuple == slot);
2616  }
2617  indexpr_item = list_head(indexInfo->ii_ExpressionsState);
2618 
2619  for (i = 0; i < indexInfo->ii_NumIndexAttrs; i++)
2620  {
2621  int keycol = indexInfo->ii_IndexAttrNumbers[i];
2622  Datum iDatum;
2623  bool isNull;
2624 
2625  if (keycol < 0)
2626  iDatum = slot_getsysattr(slot, keycol, &isNull);
2627  else if (keycol != 0)
2628  {
2629  /*
2630  * Plain index column; get the value we need directly from the
2631  * heap tuple.
2632  */
2633  iDatum = slot_getattr(slot, keycol, &isNull);
2634  }
2635  else
2636  {
2637  /*
2638  * Index expression --- need to evaluate it.
2639  */
2640  if (indexpr_item == NULL)
2641  elog(ERROR, "wrong number of index expressions");
2642  iDatum = ExecEvalExprSwitchContext((ExprState *) lfirst(indexpr_item),
2643  GetPerTupleExprContext(estate),
2644  &isNull);
2645  indexpr_item = lnext(indexInfo->ii_ExpressionsState, indexpr_item);
2646  }
2647  values[i] = iDatum;
2648  isnull[i] = isNull;
2649  }
2650 
2651  if (indexpr_item != NULL)
2652  elog(ERROR, "wrong number of index expressions");
2653 }
#define NIL
Definition: pg_list.h:65
static Datum ExecEvalExprSwitchContext(ExprState *state, ExprContext *econtext, bool *isNull)
Definition: executor.h:305
static ListCell * lnext(const List *l, const ListCell *c)
Definition: pg_list.h:321
#define GetPerTupleExprContext(estate)
Definition: executor.h:507
List * ii_ExpressionsState
Definition: execnodes.h:162
#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:566
uintptr_t Datum
Definition: postgres.h:367
int ii_NumIndexAttrs
Definition: execnodes.h:158
static Datum slot_getattr(TupleTableSlot *slot, int attnum, bool *isnull)
Definition: tuptable.h:381
List * ii_Expressions
Definition: execnodes.h:161
#define Assert(condition)
Definition: c.h:738
#define lfirst(lc)
Definition: pg_list.h:190
static Datum values[MAXATTR]
Definition: bootstrap.c:167
#define elog(elevel,...)
Definition: elog.h:214
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:160

◆ index_build()

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

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

2831 {
2832  IndexBuildResult *stats;
2833  Oid save_userid;
2834  int save_sec_context;
2835  int save_nestlevel;
2836 
2837  /*
2838  * sanity checks
2839  */
2840  Assert(RelationIsValid(indexRelation));
2841  Assert(PointerIsValid(indexRelation->rd_indam));
2842  Assert(PointerIsValid(indexRelation->rd_indam->ambuild));
2843  Assert(PointerIsValid(indexRelation->rd_indam->ambuildempty));
2844 
2845  /*
2846  * Determine worker process details for parallel CREATE INDEX. Currently,
2847  * only btree has support for parallel builds.
2848  *
2849  * Note that planner considers parallel safety for us.
2850  */
2851  if (parallel && IsNormalProcessingMode() &&
2852  indexRelation->rd_rel->relam == BTREE_AM_OID)
2853  indexInfo->ii_ParallelWorkers =
2855  RelationGetRelid(indexRelation));
2856 
2857  if (indexInfo->ii_ParallelWorkers == 0)
2858  ereport(DEBUG1,
2859  (errmsg("building index \"%s\" on table \"%s\" serially",
2860  RelationGetRelationName(indexRelation),
2861  RelationGetRelationName(heapRelation))));
2862  else
2863  ereport(DEBUG1,
2864  (errmsg_plural("building index \"%s\" on table \"%s\" with request for %d parallel worker",
2865  "building index \"%s\" on table \"%s\" with request for %d parallel workers",
2866  indexInfo->ii_ParallelWorkers,
2867  RelationGetRelationName(indexRelation),
2868  RelationGetRelationName(heapRelation),
2869  indexInfo->ii_ParallelWorkers)));
2870 
2871  /*
2872  * Switch to the table owner's userid, so that any index functions are run
2873  * as that user. Also lock down security-restricted operations and
2874  * arrange to make GUC variable changes local to this command.
2875  */
2876  GetUserIdAndSecContext(&save_userid, &save_sec_context);
2877  SetUserIdAndSecContext(heapRelation->rd_rel->relowner,
2878  save_sec_context | SECURITY_RESTRICTED_OPERATION);
2879  save_nestlevel = NewGUCNestLevel();
2880 
2881  /* Set up initial progress report status */
2882  {
2883  const int index[] = {
2890  };
2891  const int64 val[] = {
2894  0, 0, 0, 0
2895  };
2896 
2897  pgstat_progress_update_multi_param(6, index, val);
2898  }
2899 
2900  /*
2901  * Call the access method's build procedure
2902  */
2903  stats = indexRelation->rd_indam->ambuild(heapRelation, indexRelation,
2904  indexInfo);
2905  Assert(PointerIsValid(stats));
2906 
2907  /*
2908  * If this is an unlogged index, we may need to write out an init fork for
2909  * it -- but we must first check whether one already exists. If, for
2910  * example, an unlogged relation is truncated in the transaction that
2911  * created it, or truncated twice in a subsequent transaction, the
2912  * relfilenode won't change, and nothing needs to be done here.
2913  */
2914  if (indexRelation->rd_rel->relpersistence == RELPERSISTENCE_UNLOGGED &&
2915  !smgrexists(indexRelation->rd_smgr, INIT_FORKNUM))
2916  {
2917  RelationOpenSmgr(indexRelation);
2918  smgrcreate(indexRelation->rd_smgr, INIT_FORKNUM, false);
2919  indexRelation->rd_indam->ambuildempty(indexRelation);
2920  }
2921 
2922  /*
2923  * If we found any potentially broken HOT chains, mark the index as not
2924  * being usable until the current transaction is below the event horizon.
2925  * See src/backend/access/heap/README.HOT for discussion. Also set this
2926  * if early pruning/vacuuming is enabled for the heap relation. While it
2927  * might become safe to use the index earlier based on actual cleanup
2928  * activity and other active transactions, the test for that would be much
2929  * more complex and would require some form of blocking, so keep it simple
2930  * and fast by just using the current transaction.
2931  *
2932  * However, when reindexing an existing index, we should do nothing here.
2933  * Any HOT chains that are broken with respect to the index must predate
2934  * the index's original creation, so there is no need to change the
2935  * index's usability horizon. Moreover, we *must not* try to change the
2936  * index's pg_index entry while reindexing pg_index itself, and this
2937  * optimization nicely prevents that. The more complex rules needed for a
2938  * reindex are handled separately after this function returns.
2939  *
2940  * We also need not set indcheckxmin during a concurrent index build,
2941  * because we won't set indisvalid true until all transactions that care
2942  * about the broken HOT chains or early pruning/vacuuming are gone.
2943  *
2944  * Therefore, this code path can only be taken during non-concurrent
2945  * CREATE INDEX. Thus the fact that heap_update will set the pg_index
2946  * tuple's xmin doesn't matter, because that tuple was created in the
2947  * current transaction anyway. That also means we don't need to worry
2948  * about any concurrent readers of the tuple; no other transaction can see
2949  * it yet.
2950  */
2951  if ((indexInfo->ii_BrokenHotChain || EarlyPruningEnabled(heapRelation)) &&
2952  !isreindex &&
2953  !indexInfo->ii_Concurrent)
2954  {
2955  Oid indexId = RelationGetRelid(indexRelation);
2956  Relation pg_index;
2957  HeapTuple indexTuple;
2958  Form_pg_index indexForm;
2959 
2960  pg_index = table_open(IndexRelationId, RowExclusiveLock);
2961 
2962  indexTuple = SearchSysCacheCopy1(INDEXRELID,
2963  ObjectIdGetDatum(indexId));
2964  if (!HeapTupleIsValid(indexTuple))
2965  elog(ERROR, "cache lookup failed for index %u", indexId);
2966  indexForm = (Form_pg_index) GETSTRUCT(indexTuple);
2967 
2968  /* If it's a new index, indcheckxmin shouldn't be set ... */
2969  Assert(!indexForm->indcheckxmin);
2970 
2971  indexForm->indcheckxmin = true;
2972  CatalogTupleUpdate(pg_index, &indexTuple->t_self, indexTuple);
2973 
2974  heap_freetuple(indexTuple);
2975  table_close(pg_index, RowExclusiveLock);
2976  }
2977 
2978  /*
2979  * Update heap and index pg_class rows
2980  */
2981  index_update_stats(heapRelation,
2982  true,
2983  stats->heap_tuples);
2984 
2985  index_update_stats(indexRelation,
2986  false,
2987  stats->index_tuples);
2988 
2989  /* Make the updated catalog row versions visible */
2991 
2992  /*
2993  * If it's for an exclusion constraint, make a second pass over the heap
2994  * to verify that the constraint is satisfied. We must not do this until
2995  * the index is fully valid. (Broken HOT chains shouldn't matter, though;
2996  * see comments for IndexCheckExclusion.)
2997  */
2998  if (indexInfo->ii_ExclusionOps != NULL)
2999  IndexCheckExclusion(heapRelation, indexRelation, indexInfo);
3000 
3001  /* Roll back any GUC changes executed by index functions */
3002  AtEOXact_GUC(false, save_nestlevel);
3003 
3004  /* Restore userid and security context */
3005  SetUserIdAndSecContext(save_userid, save_sec_context);
3006 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:188
static void index_update_stats(Relation rel, bool hasindex, double reltuples)
Definition: index.c:2678
#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:560
int errmsg_plural(const char *fmt_singular, const char *fmt_plural, unsigned long n,...)
Definition: elog.c:934
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:109
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:513
#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:216
#define RelationIsValid(relation)
Definition: rel.h:429
ItemPointerData t_self
Definition: htup.h:65
#define IsNormalProcessingMode()
Definition: miscadmin.h:394
void GetUserIdAndSecContext(Oid *userid, int *sec_context)
Definition: miscinit.c:553
#define RowExclusiveLock
Definition: lockdefs.h:38
void AtEOXact_GUC(bool isCommit, int nestLevel)
Definition: guc.c:5948
#define RelationGetRelationName(relation)
Definition: rel.h:490
bool ii_BrokenHotChain
Definition: execnodes.h:175
static void IndexCheckExclusion(Relation heapRelation, Relation indexRelation, IndexInfo *indexInfo)
Definition: index.c:3021
#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:1006
#define ereport(elevel,...)
Definition: elog.h:144
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
#define Assert(condition)
Definition: c.h:738
#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:3257
int ii_ParallelWorkers
Definition: execnodes.h:176
void CatalogTupleUpdate(Relation heapRel, ItemPointer otid, HeapTuple tup)
Definition: indexing.c:224
int plan_create_index_workers(Oid tableOid, Oid indexOid)
Definition: planner.c:6355
#define PROGRESS_SCAN_BLOCKS_TOTAL
Definition: progress.h:119
bool ii_Concurrent
Definition: execnodes.h:174
#define SearchSysCacheCopy1(cacheId, key1)
Definition: syscache.h:174
int NewGUCNestLevel(void)
Definition: guc.c:5934
Oid * ii_ExclusionOps
Definition: execnodes.h:165
int errmsg(const char *fmt,...)
Definition: elog.c:824
#define PROGRESS_CREATEIDX_TUPLES_DONE
Definition: progress.h:85
#define elog(elevel,...)
Definition: elog.h:214
ambuildempty_function ambuildempty
Definition: amapi.h:217
#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:632
#define RelationGetRelid(relation)
Definition: rel.h:456
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 201 of file index.c.

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

Referenced by ATExecAddIndexConstraint(), and DefineIndex().

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

◆ index_concurrently_build()

void index_concurrently_build ( Oid  heapRelationId,
Oid  indexRelationId 
)

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

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

◆ index_concurrently_create_copy()

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

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

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

◆ index_concurrently_set_dead()

void index_concurrently_set_dead ( Oid  heapId,
Oid  indexId 
)

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

1749 {
1750  Relation userHeapRelation;
1751  Relation userIndexRelation;
1752 
1753  /*
1754  * No more predicate locks will be acquired on this index, and we're about
1755  * to stop doing inserts into the index which could show conflicts with
1756  * existing predicate locks, so now is the time to move them to the heap
1757  * relation.
1758  */
1759  userHeapRelation = table_open(heapId, ShareUpdateExclusiveLock);
1760  userIndexRelation = index_open(indexId, ShareUpdateExclusiveLock);
1761  TransferPredicateLocksToHeapRelation(userIndexRelation);
1762 
1763  /*
1764  * Now we are sure that nobody uses the index for queries; they just might
1765  * have it open for updating it. So now we can unset indisready and
1766  * indislive, then wait till nobody could be using it at all anymore.
1767  */
1769 
1770  /*
1771  * Invalidate the relcache for the table, so that after this commit all
1772  * sessions will refresh the table's index list. Forgetting just the
1773  * index's relcache entry is not enough.
1774  */
1775  CacheInvalidateRelcache(userHeapRelation);
1776 
1777  /*
1778  * Close the relations again, though still holding session lock.
1779  */
1780  table_close(userHeapRelation, NoLock);
1781  index_close(userIndexRelation, NoLock);
1782 }
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:133
void index_set_state_flags(Oid indexId, IndexStateFlagsAction action)
Definition: index.c:3333
#define NoLock
Definition: lockdefs.h:34
void TransferPredicateLocksToHeapRelation(Relation relation)
Definition: predicate.c:3077
#define ShareUpdateExclusiveLock
Definition: lockdefs.h:39
void index_close(Relation relation, LOCKMODE lockmode)
Definition: indexam.c:158
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:132

◆ index_concurrently_swap()

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

Definition at line 1458 of file index.c.

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

Referenced by ReindexRelationConcurrently().

1459 {
1460  Relation pg_class,
1461  pg_index,
1462  pg_constraint,
1463  pg_trigger;
1464  Relation oldClassRel,
1465  newClassRel;
1466  HeapTuple oldClassTuple,
1467  newClassTuple;
1468  Form_pg_class oldClassForm,
1469  newClassForm;
1470  HeapTuple oldIndexTuple,
1471  newIndexTuple;
1472  Form_pg_index oldIndexForm,
1473  newIndexForm;
1474  bool isPartition;
1475  Oid indexConstraintOid;
1476  List *constraintOids = NIL;
1477  ListCell *lc;
1478 
1479  /*
1480  * Take a necessary lock on the old and new index before swapping them.
1481  */
1482  oldClassRel = relation_open(oldIndexId, ShareUpdateExclusiveLock);
1483  newClassRel = relation_open(newIndexId, ShareUpdateExclusiveLock);
1484 
1485  /* Now swap names and dependencies of those indexes */
1486  pg_class = table_open(RelationRelationId, RowExclusiveLock);
1487 
1488  oldClassTuple = SearchSysCacheCopy1(RELOID,
1489  ObjectIdGetDatum(oldIndexId));
1490  if (!HeapTupleIsValid(oldClassTuple))
1491  elog(ERROR, "could not find tuple for relation %u", oldIndexId);
1492  newClassTuple = SearchSysCacheCopy1(RELOID,
1493  ObjectIdGetDatum(newIndexId));
1494  if (!HeapTupleIsValid(newClassTuple))
1495  elog(ERROR, "could not find tuple for relation %u", newIndexId);
1496 
1497  oldClassForm = (Form_pg_class) GETSTRUCT(oldClassTuple);
1498  newClassForm = (Form_pg_class) GETSTRUCT(newClassTuple);
1499 
1500  /* Swap the names */
1501  namestrcpy(&newClassForm->relname, NameStr(oldClassForm->relname));
1502  namestrcpy(&oldClassForm->relname, oldName);
1503 
1504  /* Swap the partition flags to track inheritance properly */
1505  isPartition = newClassForm->relispartition;
1506  newClassForm->relispartition = oldClassForm->relispartition;
1507  oldClassForm->relispartition = isPartition;
1508 
1509  CatalogTupleUpdate(pg_class, &oldClassTuple->t_self, oldClassTuple);
1510  CatalogTupleUpdate(pg_class, &newClassTuple->t_self, newClassTuple);
1511 
1512  heap_freetuple(oldClassTuple);
1513  heap_freetuple(newClassTuple);
1514 
1515  /* Now swap index info */
1516  pg_index = table_open(IndexRelationId, RowExclusiveLock);
1517 
1518  oldIndexTuple = SearchSysCacheCopy1(INDEXRELID,
1519  ObjectIdGetDatum(oldIndexId));
1520  if (!HeapTupleIsValid(oldIndexTuple))
1521  elog(ERROR, "could not find tuple for relation %u", oldIndexId);
1522  newIndexTuple = SearchSysCacheCopy1(INDEXRELID,
1523  ObjectIdGetDatum(newIndexId));
1524  if (!HeapTupleIsValid(newIndexTuple))
1525  elog(ERROR, "could not find tuple for relation %u", newIndexId);
1526 
1527  oldIndexForm = (Form_pg_index) GETSTRUCT(oldIndexTuple);
1528  newIndexForm = (Form_pg_index) GETSTRUCT(newIndexTuple);
1529 
1530  /*
1531  * Copy constraint flags from the old index. This is safe because the old
1532  * index guaranteed uniqueness.
1533  */
1534  newIndexForm->indisprimary = oldIndexForm->indisprimary;
1535  oldIndexForm->indisprimary = false;
1536  newIndexForm->indisexclusion = oldIndexForm->indisexclusion;
1537  oldIndexForm->indisexclusion = false;
1538  newIndexForm->indimmediate = oldIndexForm->indimmediate;
1539  oldIndexForm->indimmediate = true;
1540 
1541  /* Preserve indisreplident in the new index */
1542  newIndexForm->indisreplident = oldIndexForm->indisreplident;
1543  oldIndexForm->indisreplident = false;
1544 
1545  /* Preserve indisclustered in the new index */
1546  newIndexForm->indisclustered = oldIndexForm->indisclustered;
1547 
1548  /*
1549  * Mark the new index as valid, and the old index as invalid similarly to
1550  * what index_set_state_flags() does.
1551  */
1552  newIndexForm->indisvalid = true;
1553  oldIndexForm->indisvalid = false;
1554  oldIndexForm->indisclustered = false;
1555 
1556  CatalogTupleUpdate(pg_index, &oldIndexTuple->t_self, oldIndexTuple);
1557  CatalogTupleUpdate(pg_index, &newIndexTuple->t_self, newIndexTuple);
1558 
1559  heap_freetuple(oldIndexTuple);
1560  heap_freetuple(newIndexTuple);
1561 
1562  /*
1563  * Move constraints and triggers over to the new index
1564  */
1565 
1566  constraintOids = get_index_ref_constraints(oldIndexId);
1567 
1568  indexConstraintOid = get_index_constraint(oldIndexId);
1569 
1570  if (OidIsValid(indexConstraintOid))
1571  constraintOids = lappend_oid(constraintOids, indexConstraintOid);
1572 
1573  pg_constraint = table_open(ConstraintRelationId, RowExclusiveLock);
1574  pg_trigger = table_open(TriggerRelationId, RowExclusiveLock);
1575 
1576  foreach(lc, constraintOids)
1577  {
1578  HeapTuple constraintTuple,
1579  triggerTuple;
1580  Form_pg_constraint conForm;
1581  ScanKeyData key[1];
1582  SysScanDesc scan;
1583  Oid constraintOid = lfirst_oid(lc);
1584 
1585  /* Move the constraint from the old to the new index */
1586  constraintTuple = SearchSysCacheCopy1(CONSTROID,
1587  ObjectIdGetDatum(constraintOid));
1588  if (!HeapTupleIsValid(constraintTuple))
1589  elog(ERROR, "could not find tuple for constraint %u", constraintOid);
1590 
1591  conForm = ((Form_pg_constraint) GETSTRUCT(constraintTuple));
1592 
1593  if (conForm->conindid == oldIndexId)
1594  {
1595  conForm->conindid = newIndexId;
1596 
1597  CatalogTupleUpdate(pg_constraint, &constraintTuple->t_self, constraintTuple);
1598  }
1599 
1600  heap_freetuple(constraintTuple);
1601 
1602  /* Search for trigger records */
1603  ScanKeyInit(&key[0],
1604  Anum_pg_trigger_tgconstraint,
1605  BTEqualStrategyNumber, F_OIDEQ,
1606  ObjectIdGetDatum(constraintOid));
1607 
1608  scan = systable_beginscan(pg_trigger, TriggerConstraintIndexId, true,
1609  NULL, 1, key);
1610 
1611  while (HeapTupleIsValid((triggerTuple = systable_getnext(scan))))
1612  {
1613  Form_pg_trigger tgForm = (Form_pg_trigger) GETSTRUCT(triggerTuple);
1614 
1615  if (tgForm->tgconstrindid != oldIndexId)
1616  continue;
1617 
1618  /* Make a modifiable copy */
1619  triggerTuple = heap_copytuple(triggerTuple);
1620  tgForm = (Form_pg_trigger) GETSTRUCT(triggerTuple);
1621 
1622  tgForm->tgconstrindid = newIndexId;
1623 
1624  CatalogTupleUpdate(pg_trigger, &triggerTuple->t_self, triggerTuple);
1625 
1626  heap_freetuple(triggerTuple);
1627  }
1628 
1629  systable_endscan(scan);
1630  }
1631 
1632  /*
1633  * Move comment if any
1634  */
1635  {
1636  Relation description;
1637  ScanKeyData skey[3];
1638  SysScanDesc sd;
1639  HeapTuple tuple;
1640  Datum values[Natts_pg_description] = {0};
1641  bool nulls[Natts_pg_description] = {0};
1642  bool replaces[Natts_pg_description] = {0};
1643 
1644  values[Anum_pg_description_objoid - 1] = ObjectIdGetDatum(newIndexId);
1645  replaces[Anum_pg_description_objoid - 1] = true;
1646 
1647  ScanKeyInit(&skey[0],
1648  Anum_pg_description_objoid,
1649  BTEqualStrategyNumber, F_OIDEQ,
1650  ObjectIdGetDatum(oldIndexId));
1651  ScanKeyInit(&skey[1],
1652  Anum_pg_description_classoid,
1653  BTEqualStrategyNumber, F_OIDEQ,
1654  ObjectIdGetDatum(RelationRelationId));
1655  ScanKeyInit(&skey[2],
1656  Anum_pg_description_objsubid,
1657  BTEqualStrategyNumber, F_INT4EQ,
1658  Int32GetDatum(0));
1659 
1660  description = table_open(DescriptionRelationId, RowExclusiveLock);
1661 
1662  sd = systable_beginscan(description, DescriptionObjIndexId, true,
1663  NULL, 3, skey);
1664 
1665  while ((tuple = systable_getnext(sd)) != NULL)
1666  {
1667  tuple = heap_modify_tuple(tuple, RelationGetDescr(description),
1668  values, nulls, replaces);
1669  CatalogTupleUpdate(description, &tuple->t_self, tuple);
1670 
1671  break; /* Assume there can be only one match */
1672  }
1673 
1674  systable_endscan(sd);
1675  table_close(description, NoLock);
1676  }
1677 
1678  /*
1679  * Swap inheritance relationship with parent index
1680  */
1681  if (get_rel_relispartition(oldIndexId))
1682  {
1683  List *ancestors = get_partition_ancestors(oldIndexId);
1684  Oid parentIndexRelid = linitial_oid(ancestors);
1685 
1686  DeleteInheritsTuple(oldIndexId, parentIndexRelid);
1687  StoreSingleInheritance(newIndexId, parentIndexRelid, 1);
1688 
1689  list_free(ancestors);
1690  }
1691 
1692  /*
1693  * Swap all dependencies of and on the old index to the new one, and
1694  * vice-versa. Note that a call to CommandCounterIncrement() would cause
1695  * duplicate entries in pg_depend, so this should not be done.
1696  */
1697  changeDependenciesOf(RelationRelationId, newIndexId, oldIndexId);
1698  changeDependenciesOn(RelationRelationId, newIndexId, oldIndexId);
1699 
1700  changeDependenciesOf(RelationRelationId, oldIndexId, newIndexId);
1701  changeDependenciesOn(RelationRelationId, oldIndexId, newIndexId);
1702 
1703  /*
1704  * Copy over statistics from old to new index
1705  */
1706  {
1707  PgStat_StatTabEntry *tabentry;
1708 
1709  tabentry = pgstat_fetch_stat_tabentry(oldIndexId);
1710  if (tabentry)
1711  {
1712  if (newClassRel->pgstat_info)
1713  {
1714  newClassRel->pgstat_info->t_counts.t_numscans = tabentry->numscans;
1715  newClassRel->pgstat_info->t_counts.t_tuples_returned = tabentry->tuples_returned;
1716  newClassRel->pgstat_info->t_counts.t_tuples_fetched = tabentry->tuples_fetched;
1717  newClassRel->pgstat_info->t_counts.t_blocks_fetched = tabentry->blocks_fetched;
1718  newClassRel->pgstat_info->t_counts.t_blocks_hit = tabentry->blocks_hit;
1719 
1720  /*
1721  * The data will be sent by the next pgstat_report_stat()
1722  * call.
1723  */
1724  }
1725  }
1726  }
1727 
1728  /* Close relations */
1729  table_close(pg_class, RowExclusiveLock);
1730  table_close(pg_index, RowExclusiveLock);
1731  table_close(pg_constraint, RowExclusiveLock);
1732  table_close(pg_trigger, RowExclusiveLock);
1733 
1734  /* The lock taken previously is not released until the end of transaction */
1735  relation_close(oldClassRel, NoLock);
1736  relation_close(newClassRel, NoLock);
1737 }
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:529
#define GETSTRUCT(TUP)
Definition: htup_details.h:655
PgStat_Counter tuples_returned
Definition: pgstat.h:671
#define RelationGetDescr(relation)
Definition: rel.h:482
PgStat_Counter t_tuples_fetched
Definition: pgstat.h:105
bool DeleteInheritsTuple(Oid inhrelid, Oid inhparent)
Definition: pg_inherits.c:454
PgStat_Counter numscans
Definition: pgstat.h:669
PgStat_TableCounts t_counts
Definition: pgstat.h:161
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:357
#define OidIsValid(objectId)
Definition: c.h:644
PgStat_Counter t_tuples_returned
Definition: pgstat.h:104
SysScanDesc systable_beginscan(Relation heapRelation, Oid indexId, bool indexOK, Snapshot snapshot, int nkeys, ScanKey key)
Definition: genam.c:356
HeapTuple systable_getnext(SysScanDesc sysscan)
Definition: genam.c:448
#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:2512
#define NoLock
Definition: lockdefs.h:34
#define RowExclusiveLock
Definition: lockdefs.h:38
PgStat_Counter tuples_fetched
Definition: pgstat.h:672
Oid get_index_constraint(Oid indexId)
Definition: pg_depend.c:965
#define TriggerConstraintIndexId
Definition: indexing.h:251
void StoreSingleInheritance(Oid relationId, Oid parentOid, int32 seqNumber)
Definition: pg_inherits.c:417
PgStat_Counter t_blocks_hit
Definition: pgstat.h:118
bool get_rel_relispartition(Oid relid)
Definition: lsyscache.c:1939
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:685
PgStat_Counter t_numscans
Definition: pgstat.h:102
long changeDependenciesOf(Oid classId, Oid oldObjectId, Oid newObjectId)
Definition: pg_depend.c:456
#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:236
FormData_pg_trigger * Form_pg_trigger
Definition: pg_trigger.h:72
List * get_index_ref_constraints(Oid indexId)
Definition: pg_depend.c:1021
static Datum values[MAXATTR]
Definition: bootstrap.c:167
FormData_pg_class * Form_pg_class
Definition: pg_class.h:153
#define SearchSysCacheCopy1(cacheId, key1)
Definition: syscache.h:174
#define Int32GetDatum(X)
Definition: postgres.h:479
void list_free(List *list)
Definition: list.c:1376
#define elog(elevel,...)
Definition: elog.h:214
#define NameStr(name)
Definition: c.h:615
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:684
Definition: pg_list.h:50
long changeDependenciesOn(Oid refClassId, Oid oldRefObjectId, Oid newRefObjectId)
Definition: pg_depend.c:512
List * get_partition_ancestors(Oid relid)
Definition: partition.c:115
#define BTEqualStrategyNumber
Definition: stratnum.h:31
PgStat_Counter t_blocks_fetched
Definition: pgstat.h:117
#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 1809 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().

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

◆ 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 693 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_OpclassOptions, 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_opclass_options(), 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(), RowExclusiveLock, SearchSysCache1(), SetRelationHasSubclass(), StoreSingleInheritance(), table_close(), table_open(), and UpdateIndexRelation().

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

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

◆ index_drop()

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

Definition at line 2028 of file index.c.

References AccessExclusiveLock, Assert, CacheInvalidateRelcache(), CatalogTupleDelete(), CheckTableNotInUse(), CommitTransactionCommand(), LockRelId::dbId, DeleteAttributeTuples(), DeleteInheritsTuple(), DeleteRelationTuple(), elog, ereport, errcode(), errmsg(), ERROR, get_rel_persistence(), 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().

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

◆ index_set_state_flags()

void index_set_state_flags ( Oid  indexId,
IndexStateFlagsAction  action 
)

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

3334 {
3335  Relation pg_index;
3336  HeapTuple indexTuple;
3337  Form_pg_index indexForm;
3338 
3339  /* Assert that current xact hasn't done any transactional updates */
3341 
3342  /* Open pg_index and fetch a writable copy of the index's tuple */
3343  pg_index = table_open(IndexRelationId, RowExclusiveLock);
3344 
3345  indexTuple = SearchSysCacheCopy1(INDEXRELID,
3346  ObjectIdGetDatum(indexId));
3347  if (!HeapTupleIsValid(indexTuple))
3348  elog(ERROR, "cache lookup failed for index %u", indexId);
3349  indexForm = (Form_pg_index) GETSTRUCT(indexTuple);
3350 
3351  /* Perform the requested state change on the copy */
3352  switch (action)
3353  {
3355  /* Set indisready during a CREATE INDEX CONCURRENTLY sequence */
3356  Assert(indexForm->indislive);
3357  Assert(!indexForm->indisready);
3358  Assert(!indexForm->indisvalid);
3359  indexForm->indisready = true;
3360  break;
3362  /* Set indisvalid during a CREATE INDEX CONCURRENTLY sequence */
3363  Assert(indexForm->indislive);
3364  Assert(indexForm->indisready);
3365  Assert(!indexForm->indisvalid);
3366  indexForm->indisvalid = true;
3367  break;
3369 
3370  /*
3371  * Clear indisvalid during a DROP INDEX CONCURRENTLY sequence
3372  *
3373  * If indisready == true we leave it set so the index still gets
3374  * maintained by active transactions. We only need to ensure that
3375  * indisvalid is false. (We don't assert that either is initially
3376  * true, though, since we want to be able to retry a DROP INDEX
3377  * CONCURRENTLY that failed partway through.)
3378  *
3379  * Note: the CLUSTER logic assumes that indisclustered cannot be
3380  * set on any invalid index, so clear that flag too.
3381  */
3382  indexForm->indisvalid = false;
3383  indexForm->indisclustered = false;
3384  break;
3385  case INDEX_DROP_SET_DEAD:
3386 
3387  /*
3388  * Clear indisready/indislive during DROP INDEX CONCURRENTLY
3389  *
3390  * We clear both indisready and indislive, because we not only
3391  * want to stop updates, we want to prevent sessions from touching
3392  * the index at all.
3393  */
3394  Assert(!indexForm->indisvalid);
3395  indexForm->indisready = false;
3396  indexForm->indislive = false;
3397  break;
3398  }
3399 
3400  /* ... and write it back in-place */
3401  heap_inplace_update(pg_index, indexTuple);
3402 
3403  table_close(pg_index, RowExclusiveLock);
3404 }
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:133
#define GETSTRUCT(TUP)
Definition: htup_details.h:655
#define ObjectIdGetDatum(X)
Definition: postgres.h:507
#define ERROR
Definition: elog.h:43
#define RowExclusiveLock
Definition: lockdefs.h:38
#define InvalidTransactionId
Definition: transam.h:31
TransactionId GetTopTransactionIdIfAny(void)
Definition: xact.c:410
FormData_pg_index * Form_pg_index
Definition: pg_index.h:66
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
#define Assert(condition)
Definition: c.h:738
#define SearchSysCacheCopy1(cacheId, key1)
Definition: syscache.h:174
void heap_inplace_update(Relation relation, HeapTuple tuple)
Definition: heapam.c:5686
#define elog(elevel,...)
Definition: elog.h:214
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39

◆ IndexGetRelation()

Oid IndexGetRelation ( Oid  indexId,
bool  missing_ok 
)

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

3413 {
3414  HeapTuple tuple;
3416  Oid result;
3417 
3418  tuple = SearchSysCache1(INDEXRELID, ObjectIdGetDatum(indexId));
3419  if (!HeapTupleIsValid(tuple))
3420  {
3421  if (missing_ok)
3422  return InvalidOid;
3423  elog(ERROR, "cache lookup failed for index %u", indexId);
3424  }
3425  index = (Form_pg_index) GETSTRUCT(tuple);
3426  Assert(index->indexrelid == indexId);
3427 
3428  result = index->indrelid;
3429  ReleaseSysCache(tuple);
3430  return result;
3431 }
#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:738
#define elog(elevel,...)
Definition: elog.h:214

◆ IndexSetParentIndex()

void IndexSetParentIndex ( Relation  idx,
Oid  parentOid 
)

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

3502 {
3503  Relation pg_inherits;
3504  ScanKeyData key[2];
3505  SysScanDesc scan;
3506  Oid partRelid = RelationGetRelid(partitionIdx);
3507  HeapTuple tuple;
3508  bool fix_dependencies;
3509 
3510  /* Make sure this is an index */
3511  Assert(partitionIdx->rd_rel->relkind == RELKIND_INDEX ||
3512  partitionIdx->rd_rel->relkind == RELKIND_PARTITIONED_INDEX);
3513 
3514  /*
3515  * Scan pg_inherits for rows linking our index to some parent.
3516  */
3517  pg_inherits = relation_open(InheritsRelationId, RowExclusiveLock);
3518  ScanKeyInit(&key[0],
3519  Anum_pg_inherits_inhrelid,
3520  BTEqualStrategyNumber, F_OIDEQ,
3521  ObjectIdGetDatum(partRelid));
3522  ScanKeyInit(&key[1],
3523  Anum_pg_inherits_inhseqno,
3524  BTEqualStrategyNumber, F_INT4EQ,
3525  Int32GetDatum(1));
3526  scan = systable_beginscan(pg_inherits, InheritsRelidSeqnoIndexId, true,
3527  NULL, 2, key);
3528  tuple = systable_getnext(scan);
3529 
3530  if (!HeapTupleIsValid(tuple))
3531  {
3532  if (parentOid == InvalidOid)
3533  {
3534  /*
3535  * No pg_inherits row, and no parent wanted: nothing to do in this
3536  * case.
3537  */
3538  fix_dependencies = false;
3539  }
3540  else
3541  {
3542  Datum values[Natts_pg_inherits];
3543  bool isnull[Natts_pg_inherits];
3544 
3545  /*
3546  * No pg_inherits row exists, and we want a parent for this index,
3547  * so insert it.
3548  */
3549  values[Anum_pg_inherits_inhrelid - 1] = ObjectIdGetDatum(partRelid);
3550  values[Anum_pg_inherits_inhparent - 1] =
3551  ObjectIdGetDatum(parentOid);
3552  values[Anum_pg_inherits_inhseqno - 1] = Int32GetDatum(1);
3553  memset(isnull, false, sizeof(isnull));
3554 
3555  tuple = heap_form_tuple(RelationGetDescr(pg_inherits),
3556  values, isnull);
3557  CatalogTupleInsert(pg_inherits, tuple);
3558 
3559  fix_dependencies = true;
3560  }
3561  }
3562  else
3563  {
3564  Form_pg_inherits inhForm = (Form_pg_inherits) GETSTRUCT(tuple);
3565 
3566  if (parentOid == InvalidOid)
3567  {
3568  /*
3569  * There exists a pg_inherits row, which we want to clear; do so.
3570  */
3571  CatalogTupleDelete(pg_inherits, &tuple->t_self);
3572  fix_dependencies = true;
3573  }
3574  else
3575  {
3576  /*
3577  * A pg_inherits row exists. If it's the same we want, then we're
3578  * good; if it differs, that amounts to a corrupt catalog and
3579  * should not happen.
3580  */
3581  if (inhForm->inhparent != parentOid)
3582  {
3583  /* unexpected: we should not get called in this case */
3584  elog(ERROR, "bogus pg_inherit row: inhrelid %u inhparent %u",
3585  inhForm->inhrelid, inhForm->inhparent);
3586  }
3587 
3588  /* already in the right state */
3589  fix_dependencies = false;
3590  }
3591  }
3592 
3593  /* done with pg_inherits */
3594  systable_endscan(scan);
3595  relation_close(pg_inherits, RowExclusiveLock);
3596 
3597  /* set relhassubclass if an index partition has been added to the parent */
3598  if (OidIsValid(parentOid))
3599  SetRelationHasSubclass(parentOid, true);
3600 
3601  /* set relispartition correctly on the partition */
3602  update_relispartition(partRelid, OidIsValid(parentOid));
3603 
3604  if (fix_dependencies)
3605  {
3606  /*
3607  * Insert/delete pg_depend rows. If setting a parent, add PARTITION
3608  * dependencies on the parent index and the table; if removing a
3609  * parent, delete PARTITION dependencies.
3610  */
3611  if (OidIsValid(parentOid))
3612  {
3613  ObjectAddress partIdx;
3614  ObjectAddress parentIdx;
3615  ObjectAddress partitionTbl;
3616 
3617  ObjectAddressSet(partIdx, RelationRelationId, partRelid);
3618  ObjectAddressSet(parentIdx, RelationRelationId, parentOid);
3619  ObjectAddressSet(partitionTbl, RelationRelationId,
3620  partitionIdx->rd_index->indrelid);
3621  recordDependencyOn(&partIdx, &parentIdx,
3623  recordDependencyOn(&partIdx, &partitionTbl,
3625  }
3626  else
3627  {
3628  deleteDependencyRecordsForClass(RelationRelationId, partRelid,
3629  RelationRelationId,
3631  deleteDependencyRecordsForClass(RelationRelationId, partRelid,
3632  RelationRelationId,
3634  }
3635 
3636  /* make our updates visible */
3638  }
3639 }
void systable_endscan(SysScanDesc sysscan)
Definition: genam.c:529
#define GETSTRUCT(TUP)
Definition: htup_details.h:655
#define RelationGetDescr(relation)
Definition: rel.h:482
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:644
SysScanDesc systable_beginscan(Relation heapRelation, Oid indexId, bool indexOK, Snapshot snapshot, int nkeys, ScanKey key)
Definition: genam.c:356
void SetRelationHasSubclass(Oid relationId, bool relhassubclass)
Definition: tablecmds.c:2949
HeapTuple systable_getnext(SysScanDesc sysscan)
Definition: genam.c:448
#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:3646
#define RowExclusiveLock
Definition: lockdefs.h:38
uintptr_t Datum
Definition: postgres.h:367
void CommandCounterIncrement(void)
Definition: xact.c:1006
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:738
#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:214
void ScanKeyInit(ScanKey entry, AttrNumber attributeNumber, StrategyNumber strategy, RegProcedure procedure, Datum argument)
Definition: scankey.c:76
#define RelationGetRelid(relation)
Definition: rel.h:456
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 191 of file index.h.

References ItemPointerSet.

Referenced by heapam_index_validate_scan().

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

References ItemPointerGetBlockNumber, and ItemPointerGetOffsetNumber.

Referenced by validate_index_callback().

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

References AccessExclusiveLock, BuildIndexInfo(), CacheInvalidateRelcache(), CatalogTupleUpdate(), CheckTableNotInUse(), EarlyPruningEnabled, elog, ereport, errcode(), errdetail_internal(), errmsg(), ERROR, get_index_isvalid(), 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, IsToastNamespace(), NoLock, ObjectIdGetDatum, pg_rusage_init(), pg_rusage_show(), 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, RelationGetNamespace, RelationGetRelationName, RelationSetNewRelfilenode(), ResetReindexProcessing(), RowExclusiveLock, SearchSysCacheCopy1, SetReindexProcessing(), ShareLock, HeapTupleData::t_self, table_close(), table_open(), and TransferPredicateLocksToHeapRelation().

Referenced by reindex_relation(), and ReindexIndex().

3439 {
3440  Relation iRel,
3441  heapRelation;
3442  Oid heapId;
3443  IndexInfo *indexInfo;
3444  volatile bool skipped_constraint = false;
3445  PGRUsage ru0;
3447 
3448  pg_rusage_init(&ru0);
3449 
3450  /*
3451  * Open and lock the parent heap relation. ShareLock is sufficient since
3452  * we only need to be sure no schema or data changes are going on.
3453  */
3454  heapId = IndexGetRelation(indexId, false);
3455  heapRelation = table_open(heapId, ShareLock);
3456 
3457  if (progress)
3458  {
3460  heapId);
3464  indexId);
3465  }
3466 
3467  /*
3468  * Open the target index relation and get an exclusive lock on it, to
3469  * ensure that no one else is touching this particular index.
3470  */
3471  iRel = index_open(indexId, AccessExclusiveLock);
3472 
3473  if (progress)
3475  iRel->rd_rel->relam);
3476 
3477  /*
3478  * The case of reindexing partitioned tables and indexes is handled
3479  * differently by upper layers, so this case shouldn't arise.
3480  */
3481  if (iRel->rd_rel->relkind == RELKIND_PARTITIONED_INDEX)
3482  elog(ERROR, "unsupported relation kind for index \"%s\"",
3483  RelationGetRelationName(iRel));
3484 
3485  /*
3486  * Don't allow reindex on temp tables of other backends ... their local
3487  * buffer manager is not going to cope.
3488  */
3489  if (RELATION_IS_OTHER_TEMP(iRel))
3490  ereport(ERROR,
3491  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
3492  errmsg("cannot reindex temporary tables of other sessions")));
3493 
3494  /*
3495  * Don't allow reindex of an invalid index on TOAST table. This is a
3496  * leftover from a failed REINDEX CONCURRENTLY, and if rebuilt it would
3497  * not be possible to drop it anymore.
3498  */
3500  !get_index_isvalid(indexId))
3501  ereport(ERROR,
3502  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
3503  errmsg("cannot reindex invalid index on TOAST table")));
3504 
3505  /*
3506  * Also check for active uses of the index in the current transaction; we
3507  * don't want to reindex underneath an open indexscan.
3508  */
3509  CheckTableNotInUse(iRel, "REINDEX INDEX");
3510 
3511  /*
3512  * All predicate locks on the index are about to be made invalid. Promote
3513  * them to relation locks on the heap.
3514  */
3516 
3517  /* Fetch info needed for index_build */
3518  indexInfo = BuildIndexInfo(iRel);
3519 
3520  /* If requested, skip checking uniqueness/exclusion constraints */
3521  if (skip_constraint_checks)
3522  {
3523  if (indexInfo->ii_Unique || indexInfo->ii_ExclusionOps != NULL)
3524  skipped_constraint = true;
3525  indexInfo->ii_Unique = false;
3526  indexInfo->ii_ExclusionOps = NULL;
3527  indexInfo->ii_ExclusionProcs = NULL;
3528  indexInfo->ii_ExclusionStrats = NULL;
3529  }
3530 
3531  /* Suppress use of the target index while rebuilding it */
3532  SetReindexProcessing(heapId, indexId);
3533 
3534  /* Create a new physical relation for the index */
3535  RelationSetNewRelfilenode(iRel, persistence);
3536 
3537  /* Initialize the index and rebuild */
3538  /* Note: we do not need to re-establish pkey setting */
3539  index_build(heapRelation, iRel, indexInfo, true, true);
3540 
3541  /* Re-allow use of target index */
3543 
3544  /*
3545  * If the index is marked invalid/not-ready/dead (ie, it's from a failed
3546  * CREATE INDEX CONCURRENTLY, or a DROP INDEX CONCURRENTLY failed midway),
3547  * and we didn't skip a uniqueness check, we can now mark it valid. This
3548  * allows REINDEX to be used to clean up in such cases.
3549  *
3550  * We can also reset indcheckxmin, because we have now done a
3551  * non-concurrent index build, *except* in the case where index_build
3552  * found some still-broken HOT chains. If it did, and we don't have to
3553  * change any of the other flags, we just leave indcheckxmin alone (note
3554  * that index_build won't have changed it, because this is a reindex).
3555  * This is okay and desirable because not updating the tuple leaves the
3556  * index's usability horizon (recorded as the tuple's xmin value) the same
3557  * as it was.
3558  *
3559  * But, if the index was invalid/not-ready/dead and there were broken HOT
3560  * chains, we had better force indcheckxmin true, because the normal
3561  * argument that the HOT chains couldn't conflict with the index is
3562  * suspect for an invalid index. (A conflict is definitely possible if
3563  * the index was dead. It probably shouldn't happen otherwise, but let's
3564  * be conservative.) In this case advancing the usability horizon is
3565  * appropriate.
3566  *
3567  * Another reason for avoiding unnecessary updates here is that while
3568  * reindexing pg_index itself, we must not try to update tuples in it.
3569  * pg_index's indexes should always have these flags in their clean state,
3570  * so that won't happen.
3571  *
3572  * If early pruning/vacuuming is enabled for the heap relation, the
3573  * usability horizon must be advanced to the current transaction on every
3574  * build or rebuild. pg_index is OK in this regard because catalog tables
3575  * are not subject to early cleanup.
3576  */
3577  if (!skipped_constraint)
3578  {
3579  Relation pg_index;
3580  HeapTuple indexTuple;
3581  Form_pg_index indexForm;
3582  bool index_bad;
3583  bool early_pruning_enabled = EarlyPruningEnabled(heapRelation);
3584 
3585  pg_index = table_open(IndexRelationId, RowExclusiveLock);
3586 
3587  indexTuple = SearchSysCacheCopy1(INDEXRELID,
3588  ObjectIdGetDatum(indexId));
3589  if (!HeapTupleIsValid(indexTuple))
3590  elog(ERROR, "cache lookup failed for index %u", indexId);
3591  indexForm = (Form_pg_index) GETSTRUCT(indexTuple);
3592 
3593  index_bad = (!indexForm->indisvalid ||
3594  !indexForm->indisready ||
3595  !indexForm->indislive);
3596  if (index_bad ||
3597  (indexForm->indcheckxmin && !indexInfo->ii_BrokenHotChain) ||
3598  early_pruning_enabled)
3599  {
3600  if (!indexInfo->ii_BrokenHotChain && !early_pruning_enabled)
3601  indexForm->indcheckxmin = false;
3602  else if (index_bad || early_pruning_enabled)
3603  indexForm->indcheckxmin = true;
3604  indexForm->indisvalid = true;
3605  indexForm->indisready = true;
3606  indexForm->indislive = true;
3607  CatalogTupleUpdate(pg_index, &indexTuple->t_self, indexTuple);
3608 
3609  /*
3610  * Invalidate the relcache for the table, so that after we commit
3611  * all sessions will refresh the table's index list. This ensures
3612  * that if anyone misses seeing the pg_index row during this
3613  * update, they'll refresh their list before attempting any update
3614  * on the table.
3615  */
3616  CacheInvalidateRelcache(heapRelation);
3617  }
3618 
3619  table_close(pg_index, RowExclusiveLock);
3620  }
3621 
3622  /* Log what we did */
3624  ereport(INFO,
3625  (errmsg("index \"%s\" was reindexed",
3626  get_rel_name(indexId)),
3627  errdetail_internal("%s",
3628  pg_rusage_show(&ru0))));
3629 
3630  if (progress)
3632 
3633  /* Close rels, but keep locks */
3634  index_close(iRel, NoLock);
3635  table_close(heapRelation, NoLock);
3636 }
Oid IndexGetRelation(Oid indexId, bool missing_ok)
Definition: index.c:3412
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:3214
static void SetReindexProcessing(Oid heapOid, Oid indexOid)
Definition: index.c:3847
void pgstat_progress_update_param(int index, int64 val)
Definition: pgstat.c:3235
#define REINDEXOPT_REPORT_PROGRESS
Definition: parsenodes.h:3353
Oid * ii_ExclusionProcs
Definition: execnodes.h:166
int errcode(int sqlerrcode)
Definition: elog.c:610
#define INFO
Definition: elog.h:33
IndexInfo * BuildIndexInfo(Relation index)
Definition: index.c:2315
bool IsToastNamespace(Oid namespaceId)
Definition: catalog.c:195
Form_pg_class rd_rel
Definition: rel.h:109
unsigned int Oid
Definition: postgres_ext.h:31
#define REINDEXOPT_VERBOSE
Definition: parsenodes.h:3352
int errdetail_internal(const char *fmt,...)
Definition: elog.c:984
static void ResetReindexProcessing(void)
Definition: index.c:3866
void pg_rusage_init(PGRUsage *ru0)
Definition: pg_rusage.c:27
void RelationSetNewRelfilenode(Relation relation, char persistence)
Definition: relcache.c:3579
#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:490
bool ii_BrokenHotChain
Definition: execnodes.h:175
void CheckTableNotInUse(Relation rel, const char *stmt)
Definition: tablecmds.c:3533
void TransferPredicateLocksToHeapRelation(Relation relation)
Definition: predicate.c:3077
FormData_pg_index * Form_pg_index
Definition: pg_index.h:66
int progress
Definition: pgbench.c:234
void pgstat_progress_end_command(void)
Definition: pgstat.c:3286
#define PROGRESS_CREATEIDX_COMMAND_REINDEX
Definition: progress.h:110
#define ereport(elevel,...)
Definition: elog.h:144
bool ii_Unique
Definition: execnodes.h:172
void index_build(Relation heapRelation, Relation indexRelation, IndexInfo *indexInfo, bool isreindex, bool parallel)
Definition: index.c:2826
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
#define RELATION_IS_OTHER_TEMP(relation)
Definition: rel.h:593
void CatalogTupleUpdate(Relation heapRel, ItemPointer otid, HeapTuple tup)
Definition: indexing.c:224
bool get_index_isvalid(Oid index_oid)
Definition: lsyscache.c:3357
void index_close(Relation relation, LOCKMODE lockmode)
Definition: indexam.c:158
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:165
int errmsg(const char *fmt,...)
Definition: elog.c:824
#define elog(elevel,...)
Definition: elog.h:214
#define ShareLock
Definition: lockdefs.h:41
uint16 * ii_ExclusionStrats
Definition: execnodes.h:167
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39
char * get_rel_name(Oid relid)
Definition: lsyscache.c:1840
#define PROGRESS_CREATEIDX_COMMAND
Definition: progress.h:79
Relation index_open(Oid relationId, LOCKMODE lockmode)
Definition: indexam.c:132
#define PROGRESS_CREATEIDX_ACCESS_METHOD_OID
Definition: progress.h:81
#define RelationGetNamespace(relation)
Definition: rel.h:497

◆ reindex_relation()

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

Definition at line 3674 of file index.c.

References Assert, CommandCounterIncrement(), ereport, errcode(), errmsg(), get_index_isvalid(), get_namespace_name(), get_rel_name(), get_rel_namespace(), i, IsToastNamespace(), lfirst_oid, NIL, NoLock, OidIsValid, 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, SetReindexPending(), ShareLock, table_close(), table_open(), and WARNING.

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

3675 {
3676  Relation rel;
3677  Oid toast_relid;
3678  List *indexIds;
3679  char persistence;
3680  bool result;
3681  ListCell *indexId;
3682  int i;
3683 
3684  /*
3685  * Open and lock the relation. ShareLock is sufficient since we only need
3686  * to prevent schema and data changes in it. The lock level used here
3687  * should match ReindexTable().
3688  */
3689  rel = table_open(relid, ShareLock);
3690 
3691  /*
3692  * This may be useful when implemented someday; but that day is not today.
3693  * For now, avoid erroring out when called in a multi-table context
3694  * (REINDEX SCHEMA) and happen to come across a partitioned table. The
3695  * partitions may be reindexed on their own anyway.
3696  */
3697  if (rel->rd_rel->relkind == RELKIND_PARTITIONED_TABLE)
3698  {
3699  ereport(WARNING,
3700  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
3701  errmsg("REINDEX of partitioned tables is not yet implemented, skipping \"%s\"",
3702  RelationGetRelationName(rel))));
3703  table_close(rel, ShareLock);
3704  return false;
3705  }
3706 
3707  toast_relid = rel->rd_rel->reltoastrelid;
3708 
3709  /*
3710  * Get the list of index OIDs for this relation. (We trust to the
3711  * relcache to get this with a sequential scan if ignoring system
3712  * indexes.)
3713  */
3714  indexIds = RelationGetIndexList(rel);
3715 
3716  if (flags & REINDEX_REL_SUPPRESS_INDEX_USE)
3717  {
3718  /* Suppress use of all the indexes until they are rebuilt */
3719  SetReindexPending(indexIds);
3720 
3721  /*
3722  * Make the new heap contents visible --- now things might be
3723  * inconsistent!
3724  */
3726  }
3727 
3728  /*
3729  * Compute persistence of indexes: same as that of owning rel, unless
3730  * caller specified otherwise.
3731  */
3733  persistence = RELPERSISTENCE_UNLOGGED;
3734  else if (flags & REINDEX_REL_FORCE_INDEXES_PERMANENT)
3735  persistence = RELPERSISTENCE_PERMANENT;
3736  else
3737  persistence = rel->rd_rel->relpersistence;
3738 
3739  /* Reindex all the indexes. */
3740  i = 1;
3741  foreach(indexId, indexIds)
3742  {
3743  Oid indexOid = lfirst_oid(indexId);
3744  Oid indexNamespaceId = get_rel_namespace(indexOid);
3745 
3746  /*
3747  * Skip any invalid indexes on a TOAST table. These can only be
3748  * duplicate leftovers from a failed REINDEX CONCURRENTLY, and if
3749  * rebuilt it would not be possible to drop them anymore.
3750  */
3751  if (IsToastNamespace(indexNamespaceId) &&
3752  !get_index_isvalid(indexOid))
3753  {
3754  ereport(WARNING,
3755  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
3756  errmsg("cannot reindex invalid index \"%s.%s\" on TOAST table, skipping",
3757  get_namespace_name(indexNamespaceId),
3758  get_rel_name(indexOid))));
3759  continue;
3760  }
3761 
3762  reindex_index(indexOid, !(flags & REINDEX_REL_CHECK_CONSTRAINTS),
3763  persistence, options);
3764 
3766 
3767  /* Index should no longer be in the pending list */
3768  Assert(!ReindexIsProcessingIndex(indexOid));
3769 
3770  /* Set index rebuild count */
3772  i);
3773  i++;
3774  }
3775 
3776  /*
3777  * Close rel, but continue to hold the lock.
3778  */
3779  table_close(rel, NoLock);
3780 
3781  result = (indexIds != NIL);
3782 
3783  /*
3784  * If the relation has a secondary toast rel, reindex that too while we
3785  * still hold the lock on the master table.
3786  */
3787  if ((flags & REINDEX_REL_PROCESS_TOAST) && OidIsValid(toast_relid))
3788  result |= reindex_relation(toast_relid, flags, options);
3789 
3790  return result;
3791 }
#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:3880
void pgstat_progress_update_param(int index, int64 val)
Definition: pgstat.c:3235
Oid get_rel_namespace(Oid relid)
Definition: lsyscache.c:1864
int errcode(int sqlerrcode)
Definition: elog.c:610
#define REINDEX_REL_SUPPRESS_INDEX_USE
Definition: index.h:141
bool IsToastNamespace(Oid namespaceId)
Definition: catalog.c:195
Form_pg_class rd_rel
Definition: rel.h:109
unsigned int Oid
Definition: postgres_ext.h:31
#define OidIsValid(objectId)
Definition: c.h:644
char * get_namespace_name(Oid nspid)
Definition: lsyscache.c:3191
#define NoLock
Definition: lockdefs.h:34
#define RelationGetRelationName(relation)
Definition: rel.h:490
#define WARNING
Definition: elog.h:40
void CommandCounterIncrement(void)
Definition: xact.c:1006
#define ereport(elevel,...)
Definition: elog.h:144
#define REINDEX_REL_FORCE_INDEXES_UNLOGGED
Definition: index.h:143
#define Assert(condition)
Definition: c.h:738
bool get_index_isvalid(Oid index_oid)
Definition: lsyscache.c:3357
#define REINDEX_REL_CHECK_CONSTRAINTS
Definition: index.h:142
List * RelationGetIndexList(Relation relation)
Definition: relcache.c:4506
void reindex_index(Oid indexId, bool skip_constraint_checks, char persistence, int options)
Definition: index.c:3437
int errmsg(const char *fmt,...)
Definition: elog.c:824
#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:144
#define REINDEX_REL_PROCESS_TOAST
Definition: index.h:140
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39
bool ReindexIsProcessingIndex(Oid indexOid)
Definition: index.c:3836
bool reindex_relation(Oid relid, int flags, int options)
Definition: index.c:3674
Definition: pg_list.h:50
char * get_rel_name(Oid relid)
Definition: lsyscache.c:1840
#define lfirst_oid(lc)
Definition: pg_list.h:192

◆ ReindexIsProcessingHeap()

bool ReindexIsProcessingHeap ( Oid  heapOid)

Definition at line 3815 of file index.c.

References currentlyReindexedHeap.

Referenced by index_update_stats().

3816 {
3817  return heapOid == currentlyReindexedHeap;
3818 }
static Oid currentlyReindexedHeap
Definition: index.c:3805

◆ ReindexIsProcessingIndex()

bool ReindexIsProcessingIndex ( Oid  indexOid)

Definition at line 3836 of file index.c.

References currentlyReindexedIndex, and list_member_oid().

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

3837 {
3838  return indexOid == currentlyReindexedIndex ||
3840 }
static List * pendingReindexedIndexes
Definition: index.c:3807
static Oid currentlyReindexedIndex
Definition: index.c:3806
bool list_member_oid(const List *list, Oid datum)
Definition: list.c:674

◆ ResetReindexState()

void ResetReindexState ( int  nestLevel)

Definition at line 3909 of file index.c.

References currentlyReindexedHeap, currentlyReindexedIndex, InvalidOid, NIL, and reindexingNestLevel.

Referenced by AbortSubTransaction(), and AbortTransaction().

3910 {
3911  /*
3912  * Because reindexing is not re-entrant, we don't need to cope with nested
3913  * reindexing states. We just need to avoid messing up the outer-level
3914  * state in case a subtransaction fails within a REINDEX. So checking the
3915  * current nest level against that of the reindex operation is sufficient.
3916  */
3917  if (reindexingNestLevel >= nestLevel)
3918  {
3921 
3922  /*
3923  * We needn't try to release the contents of pendingReindexedIndexes;
3924  * that list should be in a transaction-lifespan context, so it will
3925  * go away automatically.
3926  */
3928 
3929  reindexingNestLevel = 0;
3930  }
3931 }
#define NIL
Definition: pg_list.h:65
static Oid currentlyReindexedHeap
Definition: index.c:3805
static List * pendingReindexedIndexes
Definition: index.c:3807
static Oid currentlyReindexedIndex
Definition: index.c:3806
#define InvalidOid
Definition: postgres_ext.h:36
static int reindexingNestLevel
Definition: index.c:3808

◆ RestoreReindexState()

void RestoreReindexState ( void *  reindexstate)

Definition at line 3967 of file index.c.

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

Referenced by ParallelWorkerMain().

3968 {
3969  SerializedReindexState *sistate = (SerializedReindexState *) reindexstate;
3970  int c = 0;
3971  MemoryContext oldcontext;
3972 
3975 
3978  for (c = 0; c < sistate->numPendingReindexedIndexes; ++c)
3981  sistate->pendingReindexedIndexes[c]);
3982  MemoryContextSwitchTo(oldcontext);
3983 
3984  /* Note the worker has its own transaction nesting level */
3986 }
#define NIL
Definition: pg_list.h:65
static Oid currentlyReindexedHeap
Definition: index.c:3805
Oid currentlyReindexedIndex
Definition: index.c:94
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
static List * pendingReindexedIndexes
Definition: index.c:3807
Oid pendingReindexedIndexes[FLEXIBLE_ARRAY_MEMBER]
Definition: index.c:96
List * lappend_oid(List *list, Oid datum)
Definition: list.c:357
char * c
MemoryContext TopMemoryContext
Definition: mcxt.c:44
int numPendingReindexedIndexes
Definition: index.c:95
static Oid currentlyReindexedIndex
Definition: index.c:3806
int GetCurrentTransactionNestLevel(void)
Definition: xact.c:842
#define Assert(condition)
Definition: c.h:738
static int reindexingNestLevel
Definition: index.c:3808
Oid currentlyReindexedHeap
Definition: index.c:93

◆ SerializeReindexState()

void SerializeReindexState ( Size  maxsize,
char *  start_address 
)

Definition at line 3949 of file index.c.

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

Referenced by InitializeParallelDSM().

3950 {
3951  SerializedReindexState *sistate = (SerializedReindexState *) start_address;
3952  int c = 0;
3953  ListCell *lc;
3954 
3958  foreach(lc, pendingReindexedIndexes)
3959  sistate->pendingReindexedIndexes[c++] = lfirst_oid(lc);
3960 }
static Oid currentlyReindexedHeap
Definition: index.c:3805
Oid currentlyReindexedIndex
Definition: index.c:94
static List * pendingReindexedIndexes
Definition: index.c:3807
Oid pendingReindexedIndexes[FLEXIBLE_ARRAY_MEMBER]
Definition: index.c:96
char * c
int numPendingReindexedIndexes
Definition: index.c:95
static Oid currentlyReindexedIndex
Definition: index.c:3806
static int list_length(const List *l)
Definition: pg_list.h:169
Oid currentlyReindexedHeap
Definition: index.c:93
#define lfirst_oid(lc)
Definition: pg_list.h:192

◆ validate_index()

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

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

3178 {
3179  Relation heapRelation,
3180  indexRelation;
3181  IndexInfo *indexInfo;
3182  IndexVacuumInfo ivinfo;
3184  Oid save_userid;
3185  int save_sec_context;
3186  int save_nestlevel;
3187 
3188  {
3189  const int index[] = {
3195  };
3196  const int64 val[] = {
3198  0, 0, 0, 0
3199  };
3200 
3201  pgstat_progress_update_multi_param(5, index, val);
3202  }
3203 
3204  /* Open and lock the parent heap relation */
3205  heapRelation = table_open(heapId, ShareUpdateExclusiveLock);
3206  /* And the target index relation */
3207  indexRelation = index_open(indexId, RowExclusiveLock);
3208 
3209  /*
3210  * Fetch info needed for index_insert. (You might think this should be
3211  * passed in from DefineIndex, but its copy is long gone due to having
3212  * been built in a previous transaction.)
3213  */
3214  indexInfo = BuildIndexInfo(indexRelation);
3215 
3216  /* mark build is concurrent just for consistency */
3217  indexInfo->ii_Concurrent = true;
3218 
3219  /*
3220  * Switch to the table owner's userid, so that any index functions are run
3221  * as that user. Also lock down security-restricted operations and
3222  * arrange to make GUC variable changes local to this command.
3223  */
3224  GetUserIdAndSecContext(&save_userid, &save_sec_context);
3225  SetUserIdAndSecContext(heapRelation->rd_rel->relowner,
3226  save_sec_context | SECURITY_RESTRICTED_OPERATION);
3227  save_nestlevel = NewGUCNestLevel();
3228 
3229  /*
3230  * Scan the index and gather up all the TIDs into a tuplesort object.
3231  */
3232  ivinfo.index = indexRelation;
3233  ivinfo.analyze_only = false;
3234  ivinfo.report_progress = true;
3235  ivinfo.estimated_count = true;
3236  ivinfo.message_level = DEBUG2;
3237  ivinfo.num_heap_tuples = heapRelation->rd_rel->reltuples;
3238  ivinfo.strategy = NULL;
3239 
3240  /*
3241  * Encode TIDs as int8 values for the sort, rather than directly sorting
3242  * item pointers. This can be significantly faster, primarily because TID
3243  * is a pass-by-reference type on all platforms, whereas int8 is
3244  * pass-by-value on most platforms.
3245  */
3246  state.tuplesort = tuplesort_begin_datum(INT8OID, Int8LessOperator,
3247  InvalidOid, false,
3249  NULL, false);
3250  state.htups = state.itups = state.tups_inserted = 0;
3251 
3252  /* ambulkdelete updates progress metrics */
3253  (void) index_bulk_delete(&ivinfo, NULL,
3254  validate_index_callback, (void *) &state);
3255 
3256  /* Execute the sort */
3257  {
3258  const int index[] = {
3262  };
3263  const int64 val[] = {
3265  0, 0
3266  };
3267 
3268  pgstat_progress_update_multi_param(3, index, val);
3269  }
3271 
3272  /*
3273  * Now scan the heap and "merge" it with the index
3274  */
3277  table_index_validate_scan(heapRelation,
3278  indexRelation,
3279  indexInfo,
3280  snapshot,
3281  &state);
3282 
3283  /* Done with tuplesort object */
3284  tuplesort_end(state.tuplesort);
3285 
3286  elog(DEBUG2,
3287  "validate_index found %.0f heap tuples, %.0f index tuples; inserted %.0f missing tuples",
3288  state.htups, state.itups, state.tups_inserted);
3289 
3290  /* Roll back any GUC changes executed by index functions */
3291  AtEOXact_GUC(false, save_nestlevel);
3292 
3293  /* Restore userid and security context */
3294  SetUserIdAndSecContext(save_userid, save_sec_context);
3295 
3296  /* Close rels, but keep locks */
3297  index_close(indexRelation, NoLock);
3298  table_close(heapRelation, NoLock);
3299 }
#define PROGRESS_CREATEIDX_PHASE_VALIDATE_SORT
Definition: progress.h:95
void tuplesort_performsort(Tuplesortstate *state)
Definition: tuplesort.c:1964
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:1171
#define SECURITY_RESTRICTED_OPERATION
Definition: miscadmin.h:298
void SetUserIdAndSecContext(Oid userid, int sec_context)
Definition: miscinit.c:560
void pgstat_progress_update_param(int index, int64 val)
Definition: pgstat.c:3235
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:2315
Form_pg_class rd_rel
Definition: rel.h:109
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:553
#define RowExclusiveLock
Definition: lockdefs.h:38
void AtEOXact_GUC(bool isCommit, int nestLevel)
Definition: guc.c:5948
#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:688
#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:3257
#define PROGRESS_SCAN_BLOCKS_TOTAL
Definition: progress.h:119
bool ii_Concurrent
Definition: execnodes.h:174
void index_close(Relation relation, LOCKMODE lockmode)
Definition: indexam.c:158
double htups
Definition: index.h:37
#define PROGRESS_CREATEIDX_PHASE_VALIDATE_IDXSCAN
Definition: progress.h:94
int NewGUCNestLevel(void)
Definition: guc.c:5934
static void table_index_validate_scan(Relation table_rel, Relation index_rel, struct IndexInfo *index_info, Snapshot snapshot, struct ValidateIndexState *state)
Definition: tableam.h:1588
#define PROGRESS_CREATEIDX_TUPLES_DONE
Definition: progress.h:85
#define elog(elevel,...)
Definition: elog.h:214
void tuplesort_end(Tuplesortstate *state)
Definition: tuplesort.c:1388
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39
static bool validate_index_callback(ItemPointer itemptr, void *opaque)
Definition: index.c:3305
long val
Definition: informix.c:664
Relation index_open(Oid relationId, LOCKMODE lockmode)
Definition: indexam.c:132
bool estimated_count
Definition: genam.h:49