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, AttrNumber *attmap, int maplen)
 
void BuildSpeculativeIndexInfo (Relation index, IndexInfo *ii)
 
void FormIndexDatum (IndexInfo *indexInfo, TupleTableSlot *slot, EState *estate, Datum *values, bool *isnull)
 
void index_build (Relation heapRelation, Relation indexRelation, IndexInfo *indexInfo, bool isreindex, bool parallel)
 
void validate_index (Oid heapId, Oid indexId, Snapshot snapshot)
 
void index_set_state_flags (Oid indexId, IndexStateFlagsAction action)
 
void reindex_index (Oid indexId, bool skip_constraint_checks, char relpersistence, int options)
 
bool reindex_relation (Oid relid, int flags, int options)
 
bool ReindexIsProcessingHeap (Oid heapOid)
 
bool ReindexIsProcessingIndex (Oid indexOid)
 
Oid IndexGetRelation (Oid indexId, bool missing_ok)
 
Size EstimateReindexStateSpace (void)
 
void SerializeReindexState (Size maxsize, char *start_address)
 
void RestoreReindexState (void *reindexstate)
 
void IndexSetParentIndex (Relation idx, Oid parentOid)
 
static int64 itemptr_encode (ItemPointer itemptr)
 
static void itemptr_decode (ItemPointer itemptr, int64 encoded)
 

Macro Definition Documentation

◆ DEFAULT_INDEX_TYPE

#define DEFAULT_INDEX_TYPE   "btree"

Definition at line 21 of file index.h.

Referenced by transformIndexConstraint().

◆ INDEX_CONSTR_CREATE_DEFERRABLE

#define INDEX_CONSTR_CREATE_DEFERRABLE   (1 << 1)

◆ INDEX_CONSTR_CREATE_INIT_DEFERRED

#define INDEX_CONSTR_CREATE_INIT_DEFERRED   (1 << 2)

Definition at line 77 of file index.h.

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

◆ INDEX_CONSTR_CREATE_MARK_AS_PRIMARY

#define INDEX_CONSTR_CREATE_MARK_AS_PRIMARY   (1 << 0)

Definition at line 75 of file index.h.

Referenced by ATExecAddIndexConstraint(), and index_constraint_create().

◆ INDEX_CONSTR_CREATE_REMOVE_OLD_DEPS

#define INDEX_CONSTR_CREATE_REMOVE_OLD_DEPS   (1 << 4)

Definition at line 79 of file index.h.

Referenced by ATExecAddIndexConstraint(), and index_constraint_create().

◆ INDEX_CONSTR_CREATE_UPDATE_INDEX

#define INDEX_CONSTR_CREATE_UPDATE_INDEX   (1 << 3)

Definition at line 78 of file index.h.

Referenced by ATExecAddIndexConstraint(), and index_constraint_create().

◆ INDEX_CREATE_ADD_CONSTRAINT

#define INDEX_CREATE_ADD_CONSTRAINT   (1 << 1)

Definition at line 48 of file index.h.

Referenced by DefineIndex(), and index_create().

◆ INDEX_CREATE_CONCURRENT

#define INDEX_CREATE_CONCURRENT   (1 << 3)

Definition at line 50 of file index.h.

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

◆ INDEX_CREATE_IF_NOT_EXISTS

#define INDEX_CREATE_IF_NOT_EXISTS   (1 << 4)

Definition at line 51 of file index.h.

Referenced by DefineIndex(), and index_create().

◆ INDEX_CREATE_INVALID

#define INDEX_CREATE_INVALID   (1 << 6)

Definition at line 53 of file index.h.

Referenced by DefineIndex(), and index_create().

◆ INDEX_CREATE_IS_PRIMARY

#define INDEX_CREATE_IS_PRIMARY   (1 << 0)

Definition at line 47 of file index.h.

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

◆ INDEX_CREATE_PARTITIONED

#define INDEX_CREATE_PARTITIONED   (1 << 5)

Definition at line 52 of file index.h.

Referenced by DefineIndex(), and index_create().

◆ INDEX_CREATE_SKIP_BUILD

#define INDEX_CREATE_SKIP_BUILD   (1 << 2)

Definition at line 49 of file index.h.

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

◆ REINDEX_REL_CHECK_CONSTRAINTS

#define REINDEX_REL_CHECK_CONSTRAINTS   0x04

Definition at line 140 of file index.h.

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

◆ REINDEX_REL_FORCE_INDEXES_PERMANENT

#define REINDEX_REL_FORCE_INDEXES_PERMANENT   0x10

Definition at line 142 of file index.h.

Referenced by finish_heap_swap(), and reindex_relation().

◆ REINDEX_REL_FORCE_INDEXES_UNLOGGED

#define REINDEX_REL_FORCE_INDEXES_UNLOGGED   0x08

Definition at line 141 of file index.h.

Referenced by finish_heap_swap(), and reindex_relation().

◆ REINDEX_REL_PROCESS_TOAST

#define REINDEX_REL_PROCESS_TOAST   0x01

◆ REINDEX_REL_SUPPRESS_INDEX_USE

#define REINDEX_REL_SUPPRESS_INDEX_USE   0x02

Definition at line 139 of file index.h.

Referenced by finish_heap_swap(), and reindex_relation().

Typedef Documentation

◆ ValidateIndexState

Enumeration Type Documentation

◆ IndexStateFlagsAction

Enumerator
INDEX_CREATE_SET_READY 
INDEX_CREATE_SET_VALID 
INDEX_DROP_CLEAR_VALID 
INDEX_DROP_SET_DEAD 

Definition at line 24 of file index.h.

Function Documentation

◆ BuildDummyIndexInfo()

IndexInfo* BuildDummyIndexInfo ( Relation  index)

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

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

◆ BuildIndexInfo()

IndexInfo* BuildIndexInfo ( Relation  index)

Definition at line 2285 of file index.c.

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

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

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

◆ BuildSpeculativeIndexInfo()

void BuildSpeculativeIndexInfo ( Relation  index,
IndexInfo ii 
)

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

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

◆ CompareIndexInfo()

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

Definition at line 2388 of file index.c.

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

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

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

◆ EstimateReindexStateSpace()

Size EstimateReindexStateSpace ( void  )

Definition at line 3876 of file index.c.

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

Referenced by InitializeParallelDSM().

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

◆ FormIndexDatum()

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

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

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

◆ index_build()

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

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

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

◆ index_check_primary_key()

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

Definition at line 200 of file index.c.

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

Referenced by ATExecAddIndexConstraint(), and DefineIndex().

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

◆ index_concurrently_build()

void index_concurrently_build ( Oid  heapRelationId,
Oid  indexRelationId 
)

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

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

◆ index_concurrently_create_copy()

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

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

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

◆ index_concurrently_set_dead()

void index_concurrently_set_dead ( Oid  heapId,
Oid  indexId 
)

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

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

◆ index_concurrently_swap()

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

Definition at line 1448 of file index.c.

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

Referenced by ReindexRelationConcurrently().

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

◆ index_constraint_create()

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

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

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

◆ 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 691 of file index.c.

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

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

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

◆ index_drop()

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

Definition at line 2007 of file index.c.

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

Referenced by doDeletion().

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

◆ index_set_state_flags()

void index_set_state_flags ( Oid  indexId,
IndexStateFlagsAction  action 
)

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

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

◆ IndexGetRelation()

Oid IndexGetRelation ( Oid  indexId,
bool  missing_ok 
)

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

3381 {
3382  HeapTuple tuple;
3384  Oid result;
3385 
3386  tuple = SearchSysCache1(INDEXRELID, ObjectIdGetDatum(indexId));
3387  if (!HeapTupleIsValid(tuple))
3388  {
3389  if (missing_ok)
3390  return InvalidOid;
3391  elog(ERROR, "cache lookup failed for index %u", indexId);
3392  }
3393  index = (Form_pg_index) GETSTRUCT(tuple);
3394  Assert(index->indexrelid == indexId);
3395 
3396  result = index->indrelid;
3397  ReleaseSysCache(tuple);
3398  return result;
3399 }
#define GETSTRUCT(TUP)
Definition: htup_details.h:655
unsigned int Oid
Definition: postgres_ext.h:31
Definition: type.h:89
#define ObjectIdGetDatum(X)
Definition: postgres.h:507
#define ERROR
Definition: elog.h:43
FormData_pg_index * Form_pg_index
Definition: pg_index.h:66
HeapTuple SearchSysCache1(int cacheId, Datum key1)
Definition: syscache.c:1116
void ReleaseSysCache(HeapTuple tuple)
Definition: syscache.c:1164
#define InvalidOid
Definition: postgres_ext.h:36
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
#define Assert(condition)
Definition: c.h:739
#define elog(elevel,...)
Definition: elog.h:228

◆ IndexSetParentIndex()

void IndexSetParentIndex ( Relation  idx,
Oid  parentOid 
)

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

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

◆ itemptr_decode()

static void itemptr_decode ( ItemPointer  itemptr,
int64  encoded 
)
inlinestatic

Definition at line 189 of file index.h.

References ItemPointerSet.

Referenced by heapam_index_validate_scan().

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

◆ itemptr_encode()

static int64 itemptr_encode ( ItemPointer  itemptr)
inlinestatic

Definition at line 168 of file index.h.

References ItemPointerGetBlockNumber, and ItemPointerGetOffsetNumber.

Referenced by validate_index_callback().

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

◆ reindex_index()

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

Definition at line 3405 of file index.c.

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

Referenced by reindex_relation(), and ReindexIndex().

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

◆ reindex_relation()

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

Definition at line 3638 of file index.c.

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

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

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

◆ ReindexIsProcessingHeap()

bool ReindexIsProcessingHeap ( Oid  heapOid)

Definition at line 3771 of file index.c.

References currentlyReindexedHeap.

Referenced by index_update_stats().

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

◆ ReindexIsProcessingIndex()

bool ReindexIsProcessingIndex ( Oid  indexOid)

Definition at line 3792 of file index.c.

References currentlyReindexedIndex, and list_member_oid().

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

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

◆ RestoreReindexState()

void RestoreReindexState ( void *  reindexstate)

Definition at line 3905 of file index.c.

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

Referenced by ParallelWorkerMain().

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

◆ SerializeReindexState()

void SerializeReindexState ( Size  maxsize,
char *  start_address 
)

Definition at line 3887 of file index.c.

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

Referenced by InitializeParallelDSM().

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

◆ validate_index()

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

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

3146 {
3147  Relation heapRelation,
3148  indexRelation;
3149  IndexInfo *indexInfo;
3150  IndexVacuumInfo ivinfo;
3152  Oid save_userid;
3153  int save_sec_context;
3154  int save_nestlevel;
3155 
3156  {
3157  const int index[] = {
3163  };
3164  const int64 val[] = {
3166  0, 0, 0, 0
3167  };
3168 
3169  pgstat_progress_update_multi_param(5, index, val);
3170  }
3171 
3172  /* Open and lock the parent heap relation */
3173  heapRelation = table_open(heapId, ShareUpdateExclusiveLock);
3174  /* And the target index relation */
3175  indexRelation = index_open(indexId, RowExclusiveLock);
3176 
3177  /*
3178  * Fetch info needed for index_insert. (You might think this should be
3179  * passed in from DefineIndex, but its copy is long gone due to having
3180  * been built in a previous transaction.)
3181  */
3182  indexInfo = BuildIndexInfo(indexRelation);
3183 
3184  /* mark build is concurrent just for consistency */
3185  indexInfo->ii_Concurrent = true;
3186 
3187  /*
3188  * Switch to the table owner's userid, so that any index functions are run
3189  * as that user. Also lock down security-restricted operations and
3190  * arrange to make GUC variable changes local to this command.
3191  */
3192  GetUserIdAndSecContext(&save_userid, &save_sec_context);
3193  SetUserIdAndSecContext(heapRelation->rd_rel->relowner,
3194  save_sec_context | SECURITY_RESTRICTED_OPERATION);
3195  save_nestlevel = NewGUCNestLevel();
3196 
3197  /*
3198  * Scan the index and gather up all the TIDs into a tuplesort object.
3199  */
3200  ivinfo.index = indexRelation;
3201  ivinfo.analyze_only = false;
3202  ivinfo.report_progress = true;
3203  ivinfo.estimated_count = true;
3204  ivinfo.message_level = DEBUG2;
3205  ivinfo.num_heap_tuples = heapRelation->rd_rel->reltuples;
3206  ivinfo.strategy = NULL;
3207 
3208  /*
3209  * Encode TIDs as int8 values for the sort, rather than directly sorting
3210  * item pointers. This can be significantly faster, primarily because TID
3211  * is a pass-by-reference type on all platforms, whereas int8 is
3212  * pass-by-value on most platforms.
3213  */
3214  state.tuplesort = tuplesort_begin_datum(INT8OID, Int8LessOperator,
3215  InvalidOid, false,
3217  NULL, false);
3218  state.htups = state.itups = state.tups_inserted = 0;
3219 
3220  /* ambulkdelete updates progress metrics */
3221  (void) index_bulk_delete(&ivinfo, NULL,
3222  validate_index_callback, (void *) &state);
3223 
3224  /* Execute the sort */
3225  {
3226  const int index[] = {
3230  };
3231  const int64 val[] = {
3233  0, 0
3234  };
3235 
3236  pgstat_progress_update_multi_param(3, index, val);
3237  }
3239 
3240  /*
3241  * Now scan the heap and "merge" it with the index
3242  */
3245  table_index_validate_scan(heapRelation,
3246  indexRelation,
3247  indexInfo,
3248  snapshot,
3249  &state);
3250 
3251  /* Done with tuplesort object */
3252  tuplesort_end(state.tuplesort);
3253 
3254  elog(DEBUG2,
3255  "validate_index found %.0f heap tuples, %.0f index tuples; inserted %.0f missing tuples",
3256  state.htups, state.itups, state.tups_inserted);
3257 
3258  /* Roll back any GUC changes executed by index functions */
3259  AtEOXact_GUC(false, save_nestlevel);
3260 
3261  /* Restore userid and security context */
3262  SetUserIdAndSecContext(save_userid, save_sec_context);
3263 
3264  /* Close rels, but keep locks */
3265  index_close(indexRelation, NoLock);
3266  table_close(heapRelation, NoLock);
3267 }
#define PROGRESS_CREATEIDX_PHASE_VALIDATE_SORT
Definition: progress.h:78
void tuplesort_performsort(Tuplesortstate *state)
Definition: tuplesort.c:1791
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:133
Tuplesortstate * tuplesort_begin_datum(Oid datumType, Oid sortOperator, Oid sortCollation, bool nullsFirstFlag, int workMem, SortCoordinate coordinate, bool randomAccess)
Definition: tuplesort.c:1099
#define SECURITY_RESTRICTED_OPERATION
Definition: miscadmin.h:300
void SetUserIdAndSecContext(Oid userid, int sec_context)
Definition: miscinit.c:492
void pgstat_progress_update_param(int index, int64 val)
Definition: pgstat.c:3218
bool analyze_only
Definition: genam.h:47
bool report_progress
Definition: genam.h:48
BufferAccessStrategy strategy
Definition: genam.h:52
Relation index
Definition: genam.h:46
#define PROGRESS_CREATEIDX_TUPLES_TOTAL
Definition: progress.h:67
IndexInfo * BuildIndexInfo(Relation index)
Definition: index.c:2285
Form_pg_class rd_rel
Definition: rel.h:83
unsigned int Oid
Definition: postgres_ext.h:31
double itups
Definition: index.h:37
Definition: type.h:89
#define DEBUG2
Definition: elog.h:24
Tuplesortstate * tuplesort
Definition: index.h:35
#define NoLock
Definition: lockdefs.h:34
void GetUserIdAndSecContext(Oid *userid, int *sec_context)
Definition: miscinit.c:485
#define RowExclusiveLock
Definition: lockdefs.h:38
void AtEOXact_GUC(bool isCommit, int nestLevel)
Definition: guc.c:5782
#define PROGRESS_CREATEIDX_PHASE
Definition: progress.h:65
#define PROGRESS_SCAN_BLOCKS_DONE
Definition: progress.h:103
IndexBulkDeleteResult * index_bulk_delete(IndexVacuumInfo *info, IndexBulkDeleteResult *stats, IndexBulkDeleteCallback callback, void *callback_state)
Definition: indexam.c:682
#define InvalidOid
Definition: postgres_ext.h:36
int maintenance_work_mem
Definition: globals.c:122
int message_level
Definition: genam.h:50
double num_heap_tuples
Definition: genam.h:51
#define ShareUpdateExclusiveLock
Definition: lockdefs.h:39
Definition: regguts.h:298
double tups_inserted
Definition: index.h:37
#define PROGRESS_CREATEIDX_PHASE_VALIDATE_TABLESCAN
Definition: progress.h:79
void pgstat_progress_update_multi_param(int nparam, const int *index, const int64 *val)
Definition: pgstat.c:3240
#define PROGRESS_SCAN_BLOCKS_TOTAL
Definition: progress.h:102
bool ii_Concurrent
Definition: execnodes.h:171
void index_close(Relation relation, LOCKMODE lockmode)
Definition: indexam.c:152
double htups
Definition: index.h:37
#define PROGRESS_CREATEIDX_PHASE_VALIDATE_IDXSCAN
Definition: progress.h:77
int NewGUCNestLevel(void)
Definition: guc.c:5768
static void table_index_validate_scan(Relation table_rel, Relation index_rel, struct IndexInfo *index_info, Snapshot snapshot, struct ValidateIndexState *state)
Definition: tableam.h:1563
#define PROGRESS_CREATEIDX_TUPLES_DONE
Definition: progress.h:68
#define elog(elevel,...)
Definition: elog.h:228
void tuplesort_end(Tuplesortstate *state)
Definition: tuplesort.c:1236
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39
static bool validate_index_callback(ItemPointer itemptr, void *opaque)
Definition: index.c:3273
long val
Definition: informix.c:664
Relation index_open(Oid relationId, LOCKMODE lockmode)
Definition: indexam.c:126
bool estimated_count
Definition: genam.h:49