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  ReindexParams
 
struct  ValidateIndexState
 

Macros

#define DEFAULT_INDEX_TYPE   "btree"
 
#define REINDEXOPT_VERBOSE   0x01 /* print progress info */
 
#define REINDEXOPT_REPORT_PROGRESS   0x02 /* report pgstat progress */
 
#define REINDEXOPT_MISSING_OK   0x04 /* skip missing relations */
 
#define REINDEXOPT_CONCURRENTLY   0x08 /* concurrent mode */
 
#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 ReindexParams ReindexParams
 
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, RelFileNumber relFileNumber, 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, Oid tablespaceOid, const char *newName)
 
void index_concurrently_build (Oid heapRelationId, Oid indexRelationId)
 
void index_concurrently_swap (Oid newIndexId, Oid oldIndexId, const char *oldName)
 
void index_concurrently_set_dead (Oid heapId, Oid indexId)
 
ObjectAddress index_constraint_create (Relation heapRelation, Oid indexRelationId, Oid parentConstraintId, IndexInfo *indexInfo, const char *constraintName, char constraintType, bits16 constr_flags, bool allow_system_table_mods, bool is_internal)
 
void index_drop (Oid indexId, bool concurrent, bool concurrent_lock_mode)
 
IndexInfoBuildIndexInfo (Relation index)
 
IndexInfoBuildDummyIndexInfo (Relation index)
 
bool CompareIndexInfo (IndexInfo *info1, IndexInfo *info2, Oid *collations1, Oid *collations2, Oid *opfamilies1, Oid *opfamilies2, AttrMap *attmap)
 
void BuildSpeculativeIndexInfo (Relation index, IndexInfo *ii)
 
void FormIndexDatum (IndexInfo *indexInfo, TupleTableSlot *slot, EState *estate, Datum *values, bool *isnull)
 
void index_build (Relation heapRelation, Relation indexRelation, IndexInfo *indexInfo, bool isreindex, bool parallel)
 
void validate_index (Oid heapId, Oid indexId, Snapshot snapshot)
 
void index_set_state_flags (Oid indexId, IndexStateFlagsAction action)
 
Oid IndexGetRelation (Oid indexId, bool missing_ok)
 
void reindex_index (Oid indexId, bool skip_constraint_checks, char persistence, ReindexParams *params)
 
bool reindex_relation (Oid relid, int flags, ReindexParams *params)
 
bool ReindexIsProcessingHeap (Oid heapOid)
 
bool ReindexIsProcessingIndex (Oid indexOid)
 
void ResetReindexState (int nestLevel)
 
Size EstimateReindexStateSpace (void)
 
void SerializeReindexState (Size maxsize, char *start_address)
 
void RestoreReindexState (void *reindexstate)
 
void IndexSetParentIndex (Relation partitionIdx, 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.

◆ INDEX_CONSTR_CREATE_DEFERRABLE

#define INDEX_CONSTR_CREATE_DEFERRABLE   (1 << 1)

Definition at line 90 of file index.h.

◆ INDEX_CONSTR_CREATE_INIT_DEFERRED

#define INDEX_CONSTR_CREATE_INIT_DEFERRED   (1 << 2)

Definition at line 91 of file index.h.

◆ INDEX_CONSTR_CREATE_MARK_AS_PRIMARY

#define INDEX_CONSTR_CREATE_MARK_AS_PRIMARY   (1 << 0)

Definition at line 89 of file index.h.

◆ INDEX_CONSTR_CREATE_REMOVE_OLD_DEPS

#define INDEX_CONSTR_CREATE_REMOVE_OLD_DEPS   (1 << 4)

Definition at line 93 of file index.h.

◆ INDEX_CONSTR_CREATE_UPDATE_INDEX

#define INDEX_CONSTR_CREATE_UPDATE_INDEX   (1 << 3)

Definition at line 92 of file index.h.

◆ INDEX_CREATE_ADD_CONSTRAINT

#define INDEX_CREATE_ADD_CONSTRAINT   (1 << 1)

Definition at line 62 of file index.h.

◆ INDEX_CREATE_CONCURRENT

#define INDEX_CREATE_CONCURRENT   (1 << 3)

Definition at line 64 of file index.h.

◆ INDEX_CREATE_IF_NOT_EXISTS

#define INDEX_CREATE_IF_NOT_EXISTS   (1 << 4)

Definition at line 65 of file index.h.

◆ INDEX_CREATE_INVALID

#define INDEX_CREATE_INVALID   (1 << 6)

Definition at line 67 of file index.h.

◆ INDEX_CREATE_IS_PRIMARY

#define INDEX_CREATE_IS_PRIMARY   (1 << 0)

Definition at line 61 of file index.h.

◆ INDEX_CREATE_PARTITIONED

#define INDEX_CREATE_PARTITIONED   (1 << 5)

Definition at line 66 of file index.h.

◆ INDEX_CREATE_SKIP_BUILD

#define INDEX_CREATE_SKIP_BUILD   (1 << 2)

Definition at line 63 of file index.h.

◆ REINDEX_REL_CHECK_CONSTRAINTS

#define REINDEX_REL_CHECK_CONSTRAINTS   0x04

Definition at line 157 of file index.h.

◆ REINDEX_REL_FORCE_INDEXES_PERMANENT

#define REINDEX_REL_FORCE_INDEXES_PERMANENT   0x10

Definition at line 159 of file index.h.

◆ REINDEX_REL_FORCE_INDEXES_UNLOGGED

#define REINDEX_REL_FORCE_INDEXES_UNLOGGED   0x08

Definition at line 158 of file index.h.

◆ REINDEX_REL_PROCESS_TOAST

#define REINDEX_REL_PROCESS_TOAST   0x01

Definition at line 155 of file index.h.

◆ REINDEX_REL_SUPPRESS_INDEX_USE

#define REINDEX_REL_SUPPRESS_INDEX_USE   0x02

Definition at line 156 of file index.h.

◆ REINDEXOPT_CONCURRENTLY

#define REINDEXOPT_CONCURRENTLY   0x08 /* concurrent mode */

Definition at line 44 of file index.h.

◆ REINDEXOPT_MISSING_OK

#define REINDEXOPT_MISSING_OK   0x04 /* skip missing relations */

Definition at line 43 of file index.h.

◆ REINDEXOPT_REPORT_PROGRESS

#define REINDEXOPT_REPORT_PROGRESS   0x02 /* report pgstat progress */

Definition at line 42 of file index.h.

◆ REINDEXOPT_VERBOSE

#define REINDEXOPT_VERBOSE   0x01 /* print progress info */

Definition at line 41 of file index.h.

Typedef Documentation

◆ ReindexParams

typedef struct ReindexParams ReindexParams

◆ 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.

25 {
IndexStateFlagsAction
Definition: index.h:25
@ INDEX_CREATE_SET_VALID
Definition: index.h:27
@ INDEX_DROP_CLEAR_VALID
Definition: index.h:28
@ INDEX_DROP_SET_DEAD
Definition: index.h:29
@ INDEX_CREATE_SET_READY
Definition: index.h:26

Function Documentation

◆ BuildDummyIndexInfo()

IndexInfo* BuildDummyIndexInfo ( Relation  index)

Definition at line 2495 of file index.c.

2496 {
2497  IndexInfo *ii;
2498  Form_pg_index indexStruct = index->rd_index;
2499  int i;
2500  int numAtts;
2501 
2502  /* check the number of keys, and copy attr numbers into the IndexInfo */
2503  numAtts = indexStruct->indnatts;
2504  if (numAtts < 1 || numAtts > INDEX_MAX_KEYS)
2505  elog(ERROR, "invalid indnatts %d for index %u",
2506  numAtts, RelationGetRelid(index));
2507 
2508  /*
2509  * Create the node, using dummy index expressions, and pretending there is
2510  * no predicate.
2511  */
2512  ii = makeIndexInfo(indexStruct->indnatts,
2513  indexStruct->indnkeyatts,
2514  index->rd_rel->relam,
2516  NIL,
2517  indexStruct->indisunique,
2518  indexStruct->indnullsnotdistinct,
2519  indexStruct->indisready,
2520  false,
2521  index->rd_indam->amsummarizing);
2522 
2523  /* fill in attribute numbers */
2524  for (i = 0; i < numAtts; i++)
2525  ii->ii_IndexAttrNumbers[i] = indexStruct->indkey.values[i];
2526 
2527  /* We ignore the exclusion constraint if any */
2528 
2529  return ii;
2530 }
#define ERROR
Definition: elog.h:39
int i
Definition: isn.c:73
IndexInfo * makeIndexInfo(int numattrs, int numkeyattrs, Oid amoid, List *expressions, List *predicates, bool unique, bool nulls_not_distinct, bool isready, bool concurrent, bool summarizing)
Definition: makefuncs.c:745
#define INDEX_MAX_KEYS
FormData_pg_index * Form_pg_index
Definition: pg_index.h:70
#define NIL
Definition: pg_list.h:68
#define RelationGetRelid(relation)
Definition: rel.h:503
List * RelationGetDummyIndexExpressions(Relation relation)
Definition: relcache.c:5032
AttrNumber ii_IndexAttrNumbers[INDEX_MAX_KEYS]
Definition: execnodes.h:179
Definition: type.h:95

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

Referenced by RelationTruncateIndexes().

◆ BuildIndexInfo()

IndexInfo* BuildIndexInfo ( Relation  index)

Definition at line 2434 of file index.c.

2435 {
2436  IndexInfo *ii;
2437  Form_pg_index indexStruct = index->rd_index;
2438  int i;
2439  int numAtts;
2440 
2441  /* check the number of keys, and copy attr numbers into the IndexInfo */
2442  numAtts = indexStruct->indnatts;
2443  if (numAtts < 1 || numAtts > INDEX_MAX_KEYS)
2444  elog(ERROR, "invalid indnatts %d for index %u",
2445  numAtts, RelationGetRelid(index));
2446 
2447  /*
2448  * Create the node, fetching any expressions needed for expressional
2449  * indexes and index predicate if any.
2450  */
2451  ii = makeIndexInfo(indexStruct->indnatts,
2452  indexStruct->indnkeyatts,
2453  index->rd_rel->relam,
2456  indexStruct->indisunique,
2457  indexStruct->indnullsnotdistinct,
2458  indexStruct->indisready,
2459  false,
2460  index->rd_indam->amsummarizing);
2461 
2462  /* fill in attribute numbers */
2463  for (i = 0; i < numAtts; i++)
2464  ii->ii_IndexAttrNumbers[i] = indexStruct->indkey.values[i];
2465 
2466  /* fetch exclusion constraint info if any */
2467  if (indexStruct->indisexclusion)
2468  {
2470  &ii->ii_ExclusionOps,
2471  &ii->ii_ExclusionProcs,
2472  &ii->ii_ExclusionStrats);
2473  }
2474 
2476 
2477  return ii;
2478 }
if(TABLE==NULL||TABLE_index==NULL)
Definition: isn.c:77
List * RelationGetIndexPredicate(Relation relation)
Definition: relcache.c:5086
Datum * RelationGetIndexRawAttOptions(Relation indexrel)
Definition: relcache.c:5799
void RelationGetExclusionInfo(Relation indexRelation, Oid **operators, Oid **procs, uint16 **strategies)
Definition: relcache.c:5516
List * RelationGetIndexExpressions(Relation relation)
Definition: relcache.c:4973
uint16 * ii_ExclusionStrats
Definition: execnodes.h:186
Datum * ii_OpclassOptions
Definition: execnodes.h:190
Oid * ii_ExclusionOps
Definition: execnodes.h:184
Oid * ii_ExclusionProcs
Definition: execnodes.h:185

References elog(), ERROR, i, if(), IndexInfo::ii_ExclusionOps, IndexInfo::ii_ExclusionProcs, IndexInfo::ii_ExclusionStrats, IndexInfo::ii_IndexAttrNumbers, IndexInfo::ii_OpclassOptions, INDEX_MAX_KEYS, makeIndexInfo(), RelationGetExclusionInfo(), RelationGetIndexExpressions(), RelationGetIndexPredicate(), RelationGetIndexRawAttOptions(), and RelationGetRelid.

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

◆ BuildSpeculativeIndexInfo()

void BuildSpeculativeIndexInfo ( Relation  index,
IndexInfo ii 
)

Definition at line 2665 of file index.c.

2666 {
2667  int indnkeyatts;
2668  int i;
2669 
2671 
2672  /*
2673  * fetch info for checking unique indexes
2674  */
2675  Assert(ii->ii_Unique);
2676 
2677  if (index->rd_rel->relam != BTREE_AM_OID)
2678  elog(ERROR, "unexpected non-btree speculative unique index");
2679 
2680  ii->ii_UniqueOps = (Oid *) palloc(sizeof(Oid) * indnkeyatts);
2681  ii->ii_UniqueProcs = (Oid *) palloc(sizeof(Oid) * indnkeyatts);
2682  ii->ii_UniqueStrats = (uint16 *) palloc(sizeof(uint16) * indnkeyatts);
2683 
2684  /*
2685  * We have to look up the operator's strategy number. This provides a
2686  * cross-check that the operator does match the index.
2687  */
2688  /* We need the func OIDs and strategy numbers too */
2689  for (i = 0; i < indnkeyatts; i++)
2690  {
2692  ii->ii_UniqueOps[i] =
2693  get_opfamily_member(index->rd_opfamily[i],
2694  index->rd_opcintype[i],
2695  index->rd_opcintype[i],
2696  ii->ii_UniqueStrats[i]);
2697  if (!OidIsValid(ii->ii_UniqueOps[i]))
2698  elog(ERROR, "missing operator %d(%u,%u) in opfamily %u",
2699  ii->ii_UniqueStrats[i], index->rd_opcintype[i],
2700  index->rd_opcintype[i], index->rd_opfamily[i]);
2701  ii->ii_UniqueProcs[i] = get_opcode(ii->ii_UniqueOps[i]);
2702  }
2703 }
unsigned short uint16
Definition: c.h:489
#define OidIsValid(objectId)
Definition: c.h:759
Assert(fmt[strlen(fmt) - 1] !='\n')
RegProcedure get_opcode(Oid opno)
Definition: lsyscache.c:1267
Oid get_opfamily_member(Oid opfamily, Oid lefttype, Oid righttype, int16 strategy)
Definition: lsyscache.c:165
void * palloc(Size size)
Definition: mcxt.c:1210
unsigned int Oid
Definition: postgres_ext.h:31
#define IndexRelationGetNumberOfKeyAttributes(relation)
Definition: rel.h:522
#define BTEqualStrategyNumber
Definition: stratnum.h:31
bool ii_Unique
Definition: execnodes.h:191
Oid * ii_UniqueOps
Definition: execnodes.h:187
uint16 * ii_UniqueStrats
Definition: execnodes.h:189
Oid * ii_UniqueProcs
Definition: execnodes.h:188

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, and palloc().

Referenced by ExecOpenIndices().

◆ CompareIndexInfo()

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

Definition at line 2543 of file index.c.

2547 {
2548  int i;
2549 
2550  if (info1->ii_Unique != info2->ii_Unique)
2551  return false;
2552 
2553  if (info1->ii_NullsNotDistinct != info2->ii_NullsNotDistinct)
2554  return false;
2555 
2556  /* indexes are only equivalent if they have the same access method */
2557  if (info1->ii_Am != info2->ii_Am)
2558  return false;
2559 
2560  /* and same number of attributes */
2561  if (info1->ii_NumIndexAttrs != info2->ii_NumIndexAttrs)
2562  return false;
2563 
2564  /* and same number of key attributes */
2565  if (info1->ii_NumIndexKeyAttrs != info2->ii_NumIndexKeyAttrs)
2566  return false;
2567 
2568  /*
2569  * and columns match through the attribute map (actual attribute numbers
2570  * might differ!) Note that this implies that index columns that are
2571  * expressions appear in the same positions. We will next compare the
2572  * expressions themselves.
2573  */
2574  for (i = 0; i < info1->ii_NumIndexAttrs; i++)
2575  {
2576  if (attmap->maplen < info2->ii_IndexAttrNumbers[i])
2577  elog(ERROR, "incorrect attribute map");
2578 
2579  /* ignore expressions at this stage */
2580  if ((info1->ii_IndexAttrNumbers[i] != InvalidAttrNumber) &&
2581  (attmap->attnums[info2->ii_IndexAttrNumbers[i] - 1] !=
2582  info1->ii_IndexAttrNumbers[i]))
2583  return false;
2584 
2585  /* collation and opfamily is not valid for including columns */
2586  if (i >= info1->ii_NumIndexKeyAttrs)
2587  continue;
2588 
2589  if (collations1[i] != collations2[i])
2590  return false;
2591  if (opfamilies1[i] != opfamilies2[i])
2592  return false;
2593  }
2594 
2595  /*
2596  * For expression indexes: either both are expression indexes, or neither
2597  * is; if they are, make sure the expressions match.
2598  */
2599  if ((info1->ii_Expressions != NIL) != (info2->ii_Expressions != NIL))
2600  return false;
2601  if (info1->ii_Expressions != NIL)
2602  {
2603  bool found_whole_row;
2604  Node *mapped;
2605 
2606  mapped = map_variable_attnos((Node *) info2->ii_Expressions,
2607  1, 0, attmap,
2608  InvalidOid, &found_whole_row);
2609  if (found_whole_row)
2610  {
2611  /*
2612  * we could throw an error here, but seems out of scope for this
2613  * routine.
2614  */
2615  return false;
2616  }
2617 
2618  if (!equal(info1->ii_Expressions, mapped))
2619  return false;
2620  }
2621 
2622  /* Partial index predicates must be identical, if they exist */
2623  if ((info1->ii_Predicate == NULL) != (info2->ii_Predicate == NULL))
2624  return false;
2625  if (info1->ii_Predicate != NULL)
2626  {
2627  bool found_whole_row;
2628  Node *mapped;
2629 
2630  mapped = map_variable_attnos((Node *) info2->ii_Predicate,
2631  1, 0, attmap,
2632  InvalidOid, &found_whole_row);
2633  if (found_whole_row)
2634  {
2635  /*
2636  * we could throw an error here, but seems out of scope for this
2637  * routine.
2638  */
2639  return false;
2640  }
2641  if (!equal(info1->ii_Predicate, mapped))
2642  return false;
2643  }
2644 
2645  /* No support currently for comparing exclusion indexes. */
2646  if (info1->ii_ExclusionOps != NULL || info2->ii_ExclusionOps != NULL)
2647  return false;
2648 
2649  return true;
2650 }
#define InvalidAttrNumber
Definition: attnum.h:23
bool equal(const void *a, const void *b)
Definition: equalfuncs.c:223
#define InvalidOid
Definition: postgres_ext.h:36
Node * map_variable_attnos(Node *node, int target_varno, int sublevels_up, const AttrMap *attno_map, Oid to_rowtype, bool *found_whole_row)
int maplen
Definition: attmap.h:37
AttrNumber * attnums
Definition: attmap.h:36
int ii_NumIndexAttrs
Definition: execnodes.h:177
bool ii_NullsNotDistinct
Definition: execnodes.h:192
int ii_NumIndexKeyAttrs
Definition: execnodes.h:178
List * ii_Expressions
Definition: execnodes.h:180
Oid ii_Am
Definition: execnodes.h:200
List * ii_Predicate
Definition: execnodes.h:182
Definition: nodes.h:129

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

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

◆ EstimateReindexStateSpace()

Size EstimateReindexStateSpace ( void  )

Definition at line 4152 of file index.c.

4153 {
4156 }
static List * pendingReindexedIndexes
Definition: index.c:4021
static int list_length(const List *l)
Definition: pg_list.h:152
Size mul_size(Size s1, Size s2)
Definition: shmem.c:519

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

Referenced by InitializeParallelDSM().

◆ FormIndexDatum()

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

Definition at line 2725 of file index.c.

2730 {
2731  ListCell *indexpr_item;
2732  int i;
2733 
2734  if (indexInfo->ii_Expressions != NIL &&
2735  indexInfo->ii_ExpressionsState == NIL)
2736  {
2737  /* First time through, set up expression evaluation state */
2738  indexInfo->ii_ExpressionsState =
2739  ExecPrepareExprList(indexInfo->ii_Expressions, estate);
2740  /* Check caller has set up context correctly */
2741  Assert(GetPerTupleExprContext(estate)->ecxt_scantuple == slot);
2742  }
2743  indexpr_item = list_head(indexInfo->ii_ExpressionsState);
2744 
2745  for (i = 0; i < indexInfo->ii_NumIndexAttrs; i++)
2746  {
2747  int keycol = indexInfo->ii_IndexAttrNumbers[i];
2748  Datum iDatum;
2749  bool isNull;
2750 
2751  if (keycol < 0)
2752  iDatum = slot_getsysattr(slot, keycol, &isNull);
2753  else if (keycol != 0)
2754  {
2755  /*
2756  * Plain index column; get the value we need directly from the
2757  * heap tuple.
2758  */
2759  iDatum = slot_getattr(slot, keycol, &isNull);
2760  }
2761  else
2762  {
2763  /*
2764  * Index expression --- need to evaluate it.
2765  */
2766  if (indexpr_item == NULL)
2767  elog(ERROR, "wrong number of index expressions");
2768  iDatum = ExecEvalExprSwitchContext((ExprState *) lfirst(indexpr_item),
2769  GetPerTupleExprContext(estate),
2770  &isNull);
2771  indexpr_item = lnext(indexInfo->ii_ExpressionsState, indexpr_item);
2772  }
2773  values[i] = iDatum;
2774  isnull[i] = isNull;
2775  }
2776 
2777  if (indexpr_item != NULL)
2778  elog(ERROR, "wrong number of index expressions");
2779 }
static Datum values[MAXATTR]
Definition: bootstrap.c:156
List * ExecPrepareExprList(List *nodes, EState *estate)
Definition: execExpr.c:809
#define GetPerTupleExprContext(estate)
Definition: executor.h:538
static Datum ExecEvalExprSwitchContext(ExprState *state, ExprContext *econtext, bool *isNull)
Definition: executor.h:336
#define lfirst(lc)
Definition: pg_list.h:172
static ListCell * list_head(const List *l)
Definition: pg_list.h:128
static ListCell * lnext(const List *l, const ListCell *c)
Definition: pg_list.h:343
uintptr_t Datum
Definition: postgres.h:64
List * ii_ExpressionsState
Definition: execnodes.h:181
static Datum slot_getsysattr(TupleTableSlot *slot, int attnum, bool *isnull)
Definition: tuptable.h:410
static Datum slot_getattr(TupleTableSlot *slot, int attnum, bool *isnull)
Definition: tuptable.h:389

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(), slot_getsysattr(), and values.

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

◆ index_build()

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

Definition at line 2961 of file index.c.

2966 {
2967  IndexBuildResult *stats;
2968  Oid save_userid;
2969  int save_sec_context;
2970  int save_nestlevel;
2971 
2972  /*
2973  * sanity checks
2974  */
2975  Assert(RelationIsValid(indexRelation));
2976  Assert(PointerIsValid(indexRelation->rd_indam));
2977  Assert(PointerIsValid(indexRelation->rd_indam->ambuild));
2978  Assert(PointerIsValid(indexRelation->rd_indam->ambuildempty));
2979 
2980  /*
2981  * Determine worker process details for parallel CREATE INDEX. Currently,
2982  * only btree has support for parallel builds.
2983  *
2984  * Note that planner considers parallel safety for us.
2985  */
2986  if (parallel && IsNormalProcessingMode() &&
2987  indexRelation->rd_rel->relam == BTREE_AM_OID)
2988  indexInfo->ii_ParallelWorkers =
2990  RelationGetRelid(indexRelation));
2991 
2992  if (indexInfo->ii_ParallelWorkers == 0)
2993  ereport(DEBUG1,
2994  (errmsg_internal("building index \"%s\" on table \"%s\" serially",
2995  RelationGetRelationName(indexRelation),
2996  RelationGetRelationName(heapRelation))));
2997  else
2998  ereport(DEBUG1,
2999  (errmsg_internal("building index \"%s\" on table \"%s\" with request for %d parallel workers",
3000  RelationGetRelationName(indexRelation),
3001  RelationGetRelationName(heapRelation),
3002  indexInfo->ii_ParallelWorkers)));
3003 
3004  /*
3005  * Switch to the table owner's userid, so that any index functions are run
3006  * as that user. Also lock down security-restricted operations and
3007  * arrange to make GUC variable changes local to this command.
3008  */
3009  GetUserIdAndSecContext(&save_userid, &save_sec_context);
3010  SetUserIdAndSecContext(heapRelation->rd_rel->relowner,
3011  save_sec_context | SECURITY_RESTRICTED_OPERATION);
3012  save_nestlevel = NewGUCNestLevel();
3013 
3014  /* Set up initial progress report status */
3015  {
3016  const int progress_index[] = {
3023  };
3024  const int64 progress_vals[] = {
3027  0, 0, 0, 0
3028  };
3029 
3030  pgstat_progress_update_multi_param(6, progress_index, progress_vals);
3031  }
3032 
3033  /*
3034  * Call the access method's build procedure
3035  */
3036  stats = indexRelation->rd_indam->ambuild(heapRelation, indexRelation,
3037  indexInfo);
3038  Assert(PointerIsValid(stats));
3039 
3040  /*
3041  * If this is an unlogged index, we may need to write out an init fork for
3042  * it -- but we must first check whether one already exists. If, for
3043  * example, an unlogged relation is truncated in the transaction that
3044  * created it, or truncated twice in a subsequent transaction, the
3045  * relfilenumber won't change, and nothing needs to be done here.
3046  */
3047  if (indexRelation->rd_rel->relpersistence == RELPERSISTENCE_UNLOGGED &&
3048  !smgrexists(RelationGetSmgr(indexRelation), INIT_FORKNUM))
3049  {
3050  smgrcreate(RelationGetSmgr(indexRelation), INIT_FORKNUM, false);
3051  indexRelation->rd_indam->ambuildempty(indexRelation);
3052  }
3053 
3054  /*
3055  * If we found any potentially broken HOT chains, mark the index as not
3056  * being usable until the current transaction is below the event horizon.
3057  * See src/backend/access/heap/README.HOT for discussion. Also set this
3058  * if early pruning/vacuuming is enabled for the heap relation. While it
3059  * might become safe to use the index earlier based on actual cleanup
3060  * activity and other active transactions, the test for that would be much
3061  * more complex and would require some form of blocking, so keep it simple
3062  * and fast by just using the current transaction.
3063  *
3064  * However, when reindexing an existing index, we should do nothing here.
3065  * Any HOT chains that are broken with respect to the index must predate
3066  * the index's original creation, so there is no need to change the
3067  * index's usability horizon. Moreover, we *must not* try to change the
3068  * index's pg_index entry while reindexing pg_index itself, and this
3069  * optimization nicely prevents that. The more complex rules needed for a
3070  * reindex are handled separately after this function returns.
3071  *
3072  * We also need not set indcheckxmin during a concurrent index build,
3073  * because we won't set indisvalid true until all transactions that care
3074  * about the broken HOT chains or early pruning/vacuuming are gone.
3075  *
3076  * Therefore, this code path can only be taken during non-concurrent
3077  * CREATE INDEX. Thus the fact that heap_update will set the pg_index
3078  * tuple's xmin doesn't matter, because that tuple was created in the
3079  * current transaction anyway. That also means we don't need to worry
3080  * about any concurrent readers of the tuple; no other transaction can see
3081  * it yet.
3082  */
3083  if ((indexInfo->ii_BrokenHotChain || EarlyPruningEnabled(heapRelation)) &&
3084  !isreindex &&
3085  !indexInfo->ii_Concurrent)
3086  {
3087  Oid indexId = RelationGetRelid(indexRelation);
3088  Relation pg_index;
3089  HeapTuple indexTuple;
3090  Form_pg_index indexForm;
3091 
3092  pg_index = table_open(IndexRelationId, RowExclusiveLock);
3093 
3094  indexTuple = SearchSysCacheCopy1(INDEXRELID,
3095  ObjectIdGetDatum(indexId));
3096  if (!HeapTupleIsValid(indexTuple))
3097  elog(ERROR, "cache lookup failed for index %u", indexId);
3098  indexForm = (Form_pg_index) GETSTRUCT(indexTuple);
3099 
3100  /* If it's a new index, indcheckxmin shouldn't be set ... */
3101  Assert(!indexForm->indcheckxmin);
3102 
3103  indexForm->indcheckxmin = true;
3104  CatalogTupleUpdate(pg_index, &indexTuple->t_self, indexTuple);
3105 
3106  heap_freetuple(indexTuple);
3107  table_close(pg_index, RowExclusiveLock);
3108  }
3109 
3110  /*
3111  * Update heap and index pg_class rows
3112  */
3113  index_update_stats(heapRelation,
3114  true,
3115  stats->heap_tuples);
3116 
3117  index_update_stats(indexRelation,
3118  false,
3119  stats->index_tuples);
3120 
3121  /* Make the updated catalog row versions visible */
3123 
3124  /*
3125  * If it's for an exclusion constraint, make a second pass over the heap
3126  * to verify that the constraint is satisfied. We must not do this until
3127  * the index is fully valid. (Broken HOT chains shouldn't matter, though;
3128  * see comments for IndexCheckExclusion.)
3129  */
3130  if (indexInfo->ii_ExclusionOps != NULL)
3131  IndexCheckExclusion(heapRelation, indexRelation, indexInfo);
3132 
3133  /* Roll back any GUC changes executed by index functions */
3134  AtEOXact_GUC(false, save_nestlevel);
3135 
3136  /* Restore userid and security context */
3137  SetUserIdAndSecContext(save_userid, save_sec_context);
3138 }
void pgstat_progress_update_multi_param(int nparam, const int *index, const int64 *val)
#define PointerIsValid(pointer)
Definition: c.h:747
int errmsg_internal(const char *fmt,...)
Definition: elog.c:1156
#define DEBUG1
Definition: elog.h:30
#define ereport(elevel,...)
Definition: elog.h:149
int NewGUCNestLevel(void)
Definition: guc.c:2201
void AtEOXact_GUC(bool isCommit, int nestLevel)
Definition: guc.c:2215
void heap_freetuple(HeapTuple htup)
Definition: heaptuple.c:1338
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
#define GETSTRUCT(TUP)
Definition: htup_details.h:653
static void index_update_stats(Relation rel, bool hasindex, double reltuples)
Definition: index.c:2804
static void IndexCheckExclusion(Relation heapRelation, Relation indexRelation, IndexInfo *indexInfo)
Definition: index.c:3153
void CatalogTupleUpdate(Relation heapRel, ItemPointer otid, HeapTuple tup)
Definition: indexing.c:313
#define RowExclusiveLock
Definition: lockdefs.h:38
#define SECURITY_RESTRICTED_OPERATION
Definition: miscadmin.h:305
#define IsNormalProcessingMode()
Definition: miscadmin.h:407
void GetUserIdAndSecContext(Oid *userid, int *sec_context)
Definition: miscinit.c:631
void SetUserIdAndSecContext(Oid userid, int sec_context)
Definition: miscinit.c:638
int plan_create_index_workers(Oid tableOid, Oid indexOid)
Definition: planner.c:6634
static Datum ObjectIdGetDatum(Oid X)
Definition: postgres.h:252
#define PROGRESS_CREATEIDX_PHASE_BUILD
Definition: progress.h:92
#define PROGRESS_CREATEIDX_TUPLES_TOTAL
Definition: progress.h:84
#define PROGRESS_SCAN_BLOCKS_DONE
Definition: progress.h:120
#define PROGRESS_CREATEIDX_TUPLES_DONE
Definition: progress.h:85
#define PROGRESS_CREATEIDX_SUBPHASE
Definition: progress.h:83
#define PROGRESS_CREATEIDX_SUBPHASE_INITIALIZE
Definition: progress.h:104
#define PROGRESS_CREATEIDX_PHASE
Definition: progress.h:82
#define PROGRESS_SCAN_BLOCKS_TOTAL
Definition: progress.h:119
static SMgrRelation RelationGetSmgr(Relation rel)
Definition: rel.h:571
#define RelationGetRelationName(relation)
Definition: rel.h:537
#define RelationIsValid(relation)
Definition: rel.h:476
@ INIT_FORKNUM
Definition: relpath.h:53
void smgrcreate(SMgrRelation reln, ForkNumber forknum, bool isRedo)
Definition: smgr.c:369
bool smgrexists(SMgrRelation reln, ForkNumber forknum)
Definition: smgr.c:247
#define EarlyPruningEnabled(rel)
Definition: snapmgr.h:44
ItemPointerData t_self
Definition: htup.h:65
ambuildempty_function ambuildempty
Definition: amapi.h:262
ambuild_function ambuild
Definition: amapi.h:261
double heap_tuples
Definition: genam.h:32
double index_tuples
Definition: genam.h:33
bool ii_BrokenHotChain
Definition: execnodes.h:197
int ii_ParallelWorkers
Definition: execnodes.h:199
bool ii_Concurrent
Definition: execnodes.h:196
struct IndexAmRoutine * rd_indam
Definition: rel.h:204
Form_pg_class rd_rel
Definition: rel.h:110
#define SearchSysCacheCopy1(cacheId, key1)
Definition: syscache.h:179
@ INDEXRELID
Definition: syscache.h:66
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:126
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:40
void CommandCounterIncrement(void)
Definition: xact.c:1078

References IndexAmRoutine::ambuild, IndexAmRoutine::ambuildempty, Assert(), AtEOXact_GUC(), CatalogTupleUpdate(), CommandCounterIncrement(), DEBUG1, EarlyPruningEnabled, elog(), ereport, errmsg_internal(), 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, RelationGetRelationName, RelationGetRelid, RelationGetSmgr(), RelationIsValid, RowExclusiveLock, SearchSysCacheCopy1, SECURITY_RESTRICTED_OPERATION, SetUserIdAndSecContext(), smgrcreate(), smgrexists(), HeapTupleData::t_self, table_close(), and table_open().

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

◆ index_check_primary_key()

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

Definition at line 206 of file index.c.

210 {
211  int i;
212 
213  /*
214  * If ALTER TABLE or CREATE TABLE .. PARTITION OF, check that there isn't
215  * already a PRIMARY KEY. In CREATE TABLE for an ordinary relation, we
216  * have faith that the parser rejected multiple pkey clauses; and CREATE
217  * INDEX doesn't have a way to say PRIMARY KEY, so it's no problem either.
218  */
219  if ((is_alter_table || heapRel->rd_rel->relispartition) &&
220  relationHasPrimaryKey(heapRel))
221  {
222  ereport(ERROR,
223  (errcode(ERRCODE_INVALID_TABLE_DEFINITION),
224  errmsg("multiple primary keys for table \"%s\" are not allowed",
225  RelationGetRelationName(heapRel))));
226  }
227 
228  /*
229  * Indexes created with NULLS NOT DISTINCT cannot be used for primary key
230  * constraints. While there is no direct syntax to reach here, it can be
231  * done by creating a separate index and attaching it via ALTER TABLE ..
232  * USING INDEX.
233  */
234  if (indexInfo->ii_NullsNotDistinct)
235  {
236  ereport(ERROR,
237  (errcode(ERRCODE_INVALID_TABLE_DEFINITION),
238  errmsg("primary keys cannot use NULLS NOT DISTINCT indexes")));
239  }
240 
241  /*
242  * Check that all of the attributes in a primary key are marked as not
243  * null. (We don't really expect to see that; it'd mean the parser messed
244  * up. But it seems wise to check anyway.)
245  */
246  for (i = 0; i < indexInfo->ii_NumIndexKeyAttrs; i++)
247  {
248  AttrNumber attnum = indexInfo->ii_IndexAttrNumbers[i];
249  HeapTuple atttuple;
250  Form_pg_attribute attform;
251 
252  if (attnum == 0)
253  ereport(ERROR,
254  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
255  errmsg("primary keys cannot be expressions")));
256 
257  /* System attributes are never null, so no need to check */
258  if (attnum < 0)
259  continue;
260 
261  atttuple = SearchSysCache2(ATTNUM,
264  if (!HeapTupleIsValid(atttuple))
265  elog(ERROR, "cache lookup failed for attribute %d of relation %u",
266  attnum, RelationGetRelid(heapRel));
267  attform = (Form_pg_attribute) GETSTRUCT(atttuple);
268 
269  if (!attform->attnotnull)
270  ereport(ERROR,
271  (errcode(ERRCODE_INVALID_TABLE_DEFINITION),
272  errmsg("primary key column \"%s\" is not marked NOT NULL",
273  NameStr(attform->attname))));
274 
275  ReleaseSysCache(atttuple);
276  }
277 }
int16 AttrNumber
Definition: attnum.h:21
#define NameStr(name)
Definition: c.h:730
int errcode(int sqlerrcode)
Definition: elog.c:858
int errmsg(const char *fmt,...)
Definition: elog.c:1069
static bool relationHasPrimaryKey(Relation rel)
Definition: index.c:152
int16 attnum
Definition: pg_attribute.h:83
FormData_pg_attribute * Form_pg_attribute
Definition: pg_attribute.h:207
static Datum Int16GetDatum(int16 X)
Definition: postgres.h:172
void ReleaseSysCache(HeapTuple tuple)
Definition: syscache.c:865
HeapTuple SearchSysCache2(int cacheId, Datum key1, Datum key2)
Definition: syscache.c:828
@ ATTNUM
Definition: syscache.h:41

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

Referenced by ATExecAddIndexConstraint(), and DefineIndex().

◆ index_concurrently_build()

void index_concurrently_build ( Oid  heapRelationId,
Oid  indexRelationId 
)

Definition at line 1457 of file index.c.

1459 {
1460  Relation heapRel;
1461  Oid save_userid;
1462  int save_sec_context;
1463  int save_nestlevel;
1464  Relation indexRelation;
1465  IndexInfo *indexInfo;
1466 
1467  /* This had better make sure that a snapshot is active */
1469 
1470  /* Open and lock the parent heap relation */
1471  heapRel = table_open(heapRelationId, ShareUpdateExclusiveLock);
1472 
1473  /*
1474  * Switch to the table owner's userid, so that any index functions are run
1475  * as that user. Also lock down security-restricted operations and
1476  * arrange to make GUC variable changes local to this command.
1477  */
1478  GetUserIdAndSecContext(&save_userid, &save_sec_context);
1479  SetUserIdAndSecContext(heapRel->rd_rel->relowner,
1480  save_sec_context | SECURITY_RESTRICTED_OPERATION);
1481  save_nestlevel = NewGUCNestLevel();
1482 
1483  indexRelation = index_open(indexRelationId, RowExclusiveLock);
1484 
1485  /*
1486  * We have to re-build the IndexInfo struct, since it was lost in the
1487  * commit of the transaction where this concurrent index was created at
1488  * the catalog level.
1489  */
1490  indexInfo = BuildIndexInfo(indexRelation);
1491  Assert(!indexInfo->ii_ReadyForInserts);
1492  indexInfo->ii_Concurrent = true;
1493  indexInfo->ii_BrokenHotChain = false;
1494 
1495  /* Now build the index */
1496  index_build(heapRel, indexRelation, indexInfo, false, true);
1497 
1498  /* Roll back any GUC changes executed by index functions */
1499  AtEOXact_GUC(false, save_nestlevel);
1500 
1501  /* Restore userid and security context */
1502  SetUserIdAndSecContext(save_userid, save_sec_context);
1503 
1504  /* Close both the relations, but keep the locks */
1505  table_close(heapRel, NoLock);
1506  index_close(indexRelation, NoLock);
1507 
1508  /*
1509  * Update the pg_index row to mark the index as ready for inserts. Once we
1510  * commit this transaction, any new transactions that open the table must
1511  * insert new entries into the index for insertions and non-HOT updates.
1512  */
1514 }
void index_set_state_flags(Oid indexId, IndexStateFlagsAction action)
Definition: index.c:3457
void index_build(Relation heapRelation, Relation indexRelation, IndexInfo *indexInfo, bool isreindex, bool parallel)
Definition: index.c:2961
IndexInfo * BuildIndexInfo(Relation index)
Definition: index.c:2434
void index_close(Relation relation, LOCKMODE lockmode)
Definition: indexam.c:158
Relation index_open(Oid relationId, LOCKMODE lockmode)
Definition: indexam.c:132
#define NoLock
Definition: lockdefs.h:34
#define ShareUpdateExclusiveLock
Definition: lockdefs.h:39
bool ActiveSnapshotSet(void)
Definition: snapmgr.c:817
bool ii_ReadyForInserts
Definition: execnodes.h:193

References ActiveSnapshotSet(), Assert(), AtEOXact_GUC(), BuildIndexInfo(), GetUserIdAndSecContext(), IndexInfo::ii_BrokenHotChain, IndexInfo::ii_Concurrent, IndexInfo::ii_ReadyForInserts, index_build(), index_close(), INDEX_CREATE_SET_READY, index_open(), index_set_state_flags(), NewGUCNestLevel(), NoLock, RelationData::rd_rel, RowExclusiveLock, SECURITY_RESTRICTED_OPERATION, SetUserIdAndSecContext(), ShareUpdateExclusiveLock, table_close(), and table_open().

Referenced by DefineIndex(), and ReindexRelationConcurrently().

◆ index_concurrently_create_copy()

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

Definition at line 1286 of file index.c.

1288 {
1289  Relation indexRelation;
1290  IndexInfo *oldInfo,
1291  *newInfo;
1292  Oid newIndexId = InvalidOid;
1293  HeapTuple indexTuple,
1294  classTuple;
1295  Datum indclassDatum,
1296  colOptionDatum,
1297  optionDatum;
1298  oidvector *indclass;
1299  int2vector *indcoloptions;
1300  bool isnull;
1301  List *indexColNames = NIL;
1302  List *indexExprs = NIL;
1303  List *indexPreds = NIL;
1304 
1305  indexRelation = index_open(oldIndexId, RowExclusiveLock);
1306 
1307  /* The new index needs some information from the old index */
1308  oldInfo = BuildIndexInfo(indexRelation);
1309 
1310  /*
1311  * Concurrent build of an index with exclusion constraints is not
1312  * supported.
1313  */
1314  if (oldInfo->ii_ExclusionOps != NULL)
1315  ereport(ERROR,
1316  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1317  errmsg("concurrent index creation for exclusion constraints is not supported")));
1318 
1319  /* Get the array of class and column options IDs from index info */
1320  indexTuple = SearchSysCache1(INDEXRELID, ObjectIdGetDatum(oldIndexId));
1321  if (!HeapTupleIsValid(indexTuple))
1322  elog(ERROR, "cache lookup failed for index %u", oldIndexId);
1323  indclassDatum = SysCacheGetAttr(INDEXRELID, indexTuple,
1324  Anum_pg_index_indclass, &isnull);
1325  Assert(!isnull);
1326  indclass = (oidvector *) DatumGetPointer(indclassDatum);
1327 
1328  colOptionDatum = SysCacheGetAttr(INDEXRELID, indexTuple,
1329  Anum_pg_index_indoption, &isnull);
1330  Assert(!isnull);
1331  indcoloptions = (int2vector *) DatumGetPointer(colOptionDatum);
1332 
1333  /* Fetch options of index if any */
1334  classTuple = SearchSysCache1(RELOID, oldIndexId);
1335  if (!HeapTupleIsValid(classTuple))
1336  elog(ERROR, "cache lookup failed for relation %u", oldIndexId);
1337  optionDatum = SysCacheGetAttr(RELOID, classTuple,
1338  Anum_pg_class_reloptions, &isnull);
1339 
1340  /*
1341  * Fetch the list of expressions and predicates directly from the
1342  * catalogs. This cannot rely on the information from IndexInfo of the
1343  * old index as these have been flattened for the planner.
1344  */
1345  if (oldInfo->ii_Expressions != NIL)
1346  {
1347  Datum exprDatum;
1348  char *exprString;
1349 
1350  exprDatum = SysCacheGetAttr(INDEXRELID, indexTuple,
1351  Anum_pg_index_indexprs, &isnull);
1352  Assert(!isnull);
1353  exprString = TextDatumGetCString(exprDatum);
1354  indexExprs = (List *) stringToNode(exprString);
1355  pfree(exprString);
1356  }
1357  if (oldInfo->ii_Predicate != NIL)
1358  {
1359  Datum predDatum;
1360  char *predString;
1361 
1362  predDatum = SysCacheGetAttr(INDEXRELID, indexTuple,
1363  Anum_pg_index_indpred, &isnull);
1364  Assert(!isnull);
1365  predString = TextDatumGetCString(predDatum);
1366  indexPreds = (List *) stringToNode(predString);
1367 
1368  /* Also convert to implicit-AND format */
1369  indexPreds = make_ands_implicit((Expr *) indexPreds);
1370  pfree(predString);
1371  }
1372 
1373  /*
1374  * Build the index information for the new index. Note that rebuild of
1375  * indexes with exclusion constraints is not supported, hence there is no
1376  * need to fill all the ii_Exclusion* fields.
1377  */
1378  newInfo = makeIndexInfo(oldInfo->ii_NumIndexAttrs,
1379  oldInfo->ii_NumIndexKeyAttrs,
1380  oldInfo->ii_Am,
1381  indexExprs,
1382  indexPreds,
1383  oldInfo->ii_Unique,
1384  oldInfo->ii_NullsNotDistinct,
1385  false, /* not ready for inserts */
1386  true,
1387  indexRelation->rd_indam->amsummarizing);
1388 
1389  /*
1390  * Extract the list of column names and the column numbers for the new
1391  * index information. All this information will be used for the index
1392  * creation.
1393  */
1394  for (int i = 0; i < oldInfo->ii_NumIndexAttrs; i++)
1395  {
1396  TupleDesc indexTupDesc = RelationGetDescr(indexRelation);
1397  Form_pg_attribute att = TupleDescAttr(indexTupDesc, i);
1398 
1399  indexColNames = lappend(indexColNames, NameStr(att->attname));
1400  newInfo->ii_IndexAttrNumbers[i] = oldInfo->ii_IndexAttrNumbers[i];
1401  }
1402 
1403  /* Extract opclass parameters for each attribute, if any */
1404  if (oldInfo->ii_OpclassOptions != NULL)
1405  {
1406  newInfo->ii_OpclassOptions = palloc0(sizeof(Datum) *
1407  newInfo->ii_NumIndexAttrs);
1408  for (int i = 0; i < newInfo->ii_NumIndexAttrs; i++)
1409  newInfo->ii_OpclassOptions[i] = get_attoptions(oldIndexId, i + 1);
1410  }
1411 
1412  /*
1413  * Now create the new index.
1414  *
1415  * For a partition index, we adjust the partition dependency later, to
1416  * ensure a consistent state at all times. That is why parentIndexRelid
1417  * is not set here.
1418  */
1419  newIndexId = index_create(heapRelation,
1420  newName,
1421  InvalidOid, /* indexRelationId */
1422  InvalidOid, /* parentIndexRelid */
1423  InvalidOid, /* parentConstraintId */
1424  InvalidRelFileNumber, /* relFileNumber */
1425  newInfo,
1426  indexColNames,
1427  indexRelation->rd_rel->relam,
1428  tablespaceOid,
1429  indexRelation->rd_indcollation,
1430  indclass->values,
1431  indcoloptions->values,
1432  optionDatum,
1434  0,
1435  true, /* allow table to be a system catalog? */
1436  false, /* is_internal? */
1437  NULL);
1438 
1439  /* Close the relations used and clean up */
1440  index_close(indexRelation, NoLock);
1441  ReleaseSysCache(indexTuple);
1442  ReleaseSysCache(classTuple);
1443 
1444  return newIndexId;
1445 }
#define TextDatumGetCString(d)
Definition: builtins.h:95
Oid index_create(Relation heapRelation, const char *indexRelationName, Oid indexRelationId, Oid parentIndexRelid, Oid parentConstraintId, RelFileNumber relFileNumber, 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:713
#define INDEX_CREATE_SKIP_BUILD
Definition: index.h:63
#define INDEX_CREATE_CONCURRENT
Definition: index.h:64
List * lappend(List *list, void *datum)
Definition: list.c:338
Datum get_attoptions(Oid relid, int16 attnum)
Definition: lsyscache.c:996
List * make_ands_implicit(Expr *clause)
Definition: makefuncs.c:721
void pfree(void *pointer)
Definition: mcxt.c:1436
void * palloc0(Size size)
Definition: mcxt.c:1241
static Pointer DatumGetPointer(Datum X)
Definition: postgres.h:312
void * stringToNode(const char *str)
Definition: read.c:90
#define RelationGetDescr(relation)
Definition: rel.h:529
#define InvalidRelFileNumber
Definition: relpath.h:26
bool amsummarizing
Definition: amapi.h:248
Definition: pg_list.h:54
Oid * rd_indcollation
Definition: rel.h:215
Definition: c.h:699
int16 values[FLEXIBLE_ARRAY_MEMBER]
Definition: c.h:706
Definition: c.h:710
Oid values[FLEXIBLE_ARRAY_MEMBER]
Definition: c.h:717
HeapTuple SearchSysCache1(int cacheId, Datum key1)
Definition: syscache.c:817
Datum SysCacheGetAttr(int cacheId, HeapTuple tup, AttrNumber attributeNumber, bool *isNull)
Definition: syscache.c:1078
@ RELOID
Definition: syscache.h:89
#define TupleDescAttr(tupdesc, i)
Definition: tupdesc.h:92

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

Referenced by ReindexRelationConcurrently().

◆ index_concurrently_set_dead()

void index_concurrently_set_dead ( Oid  heapId,
Oid  indexId 
)

Definition at line 1850 of file index.c.

1851 {
1852  Relation userHeapRelation;
1853  Relation userIndexRelation;
1854 
1855  /*
1856  * No more predicate locks will be acquired on this index, and we're about
1857  * to stop doing inserts into the index which could show conflicts with
1858  * existing predicate locks, so now is the time to move them to the heap
1859  * relation.
1860  */
1861  userHeapRelation = table_open(heapId, ShareUpdateExclusiveLock);
1862  userIndexRelation = index_open(indexId, ShareUpdateExclusiveLock);
1863  TransferPredicateLocksToHeapRelation(userIndexRelation);
1864 
1865  /*
1866  * Now we are sure that nobody uses the index for queries; they just might
1867  * have it open for updating it. So now we can unset indisready and
1868  * indislive, then wait till nobody could be using it at all anymore.
1869  */
1871 
1872  /*
1873  * Invalidate the relcache for the table, so that after this commit all
1874  * sessions will refresh the table's index list. Forgetting just the
1875  * index's relcache entry is not enough.
1876  */
1877  CacheInvalidateRelcache(userHeapRelation);
1878 
1879  /*
1880  * Close the relations again, though still holding session lock.
1881  */
1882  table_close(userHeapRelation, NoLock);
1883  index_close(userIndexRelation, NoLock);
1884 }
void CacheInvalidateRelcache(Relation relation)
Definition: inval.c:1363
void TransferPredicateLocksToHeapRelation(Relation relation)
Definition: predicate.c:3057

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

◆ index_concurrently_swap()

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

Definition at line 1523 of file index.c.

1524 {
1525  Relation pg_class,
1526  pg_index,
1527  pg_constraint,
1528  pg_trigger;
1529  Relation oldClassRel,
1530  newClassRel;
1531  HeapTuple oldClassTuple,
1532  newClassTuple;
1533  Form_pg_class oldClassForm,
1534  newClassForm;
1535  HeapTuple oldIndexTuple,
1536  newIndexTuple;
1537  Form_pg_index oldIndexForm,
1538  newIndexForm;
1539  bool isPartition;
1540  Oid indexConstraintOid;
1541  List *constraintOids = NIL;
1542  ListCell *lc;
1543 
1544  /*
1545  * Take a necessary lock on the old and new index before swapping them.
1546  */
1547  oldClassRel = relation_open(oldIndexId, ShareUpdateExclusiveLock);
1548  newClassRel = relation_open(newIndexId, ShareUpdateExclusiveLock);
1549 
1550  /* Now swap names and dependencies of those indexes */
1551  pg_class = table_open(RelationRelationId, RowExclusiveLock);
1552 
1553  oldClassTuple = SearchSysCacheCopy1(RELOID,
1554  ObjectIdGetDatum(oldIndexId));
1555  if (!HeapTupleIsValid(oldClassTuple))
1556  elog(ERROR, "could not find tuple for relation %u", oldIndexId);
1557  newClassTuple = SearchSysCacheCopy1(RELOID,
1558  ObjectIdGetDatum(newIndexId));
1559  if (!HeapTupleIsValid(newClassTuple))
1560  elog(ERROR, "could not find tuple for relation %u", newIndexId);
1561 
1562  oldClassForm = (Form_pg_class) GETSTRUCT(oldClassTuple);
1563  newClassForm = (Form_pg_class) GETSTRUCT(newClassTuple);
1564 
1565  /* Swap the names */
1566  namestrcpy(&newClassForm->relname, NameStr(oldClassForm->relname));
1567  namestrcpy(&oldClassForm->relname, oldName);
1568 
1569  /* Swap the partition flags to track inheritance properly */
1570  isPartition = newClassForm->relispartition;
1571  newClassForm->relispartition = oldClassForm->relispartition;
1572  oldClassForm->relispartition = isPartition;
1573 
1574  CatalogTupleUpdate(pg_class, &oldClassTuple->t_self, oldClassTuple);
1575  CatalogTupleUpdate(pg_class, &newClassTuple->t_self, newClassTuple);
1576 
1577  heap_freetuple(oldClassTuple);
1578  heap_freetuple(newClassTuple);
1579 
1580  /* Now swap index info */
1581  pg_index = table_open(IndexRelationId, RowExclusiveLock);
1582 
1583  oldIndexTuple = SearchSysCacheCopy1(INDEXRELID,
1584  ObjectIdGetDatum(oldIndexId));
1585  if (!HeapTupleIsValid(oldIndexTuple))
1586  elog(ERROR, "could not find tuple for relation %u", oldIndexId);
1587  newIndexTuple = SearchSysCacheCopy1(INDEXRELID,
1588  ObjectIdGetDatum(newIndexId));
1589  if (!HeapTupleIsValid(newIndexTuple))
1590  elog(ERROR, "could not find tuple for relation %u", newIndexId);
1591 
1592  oldIndexForm = (Form_pg_index) GETSTRUCT(oldIndexTuple);
1593  newIndexForm = (Form_pg_index) GETSTRUCT(newIndexTuple);
1594 
1595  /*
1596  * Copy constraint flags from the old index. This is safe because the old
1597  * index guaranteed uniqueness.
1598  */
1599  newIndexForm->indisprimary = oldIndexForm->indisprimary;
1600  oldIndexForm->indisprimary = false;
1601  newIndexForm->indisexclusion = oldIndexForm->indisexclusion;
1602  oldIndexForm->indisexclusion = false;
1603  newIndexForm->indimmediate = oldIndexForm->indimmediate;
1604  oldIndexForm->indimmediate = true;
1605 
1606  /* Preserve indisreplident in the new index */
1607  newIndexForm->indisreplident = oldIndexForm->indisreplident;
1608 
1609  /* Preserve indisclustered in the new index */
1610  newIndexForm->indisclustered = oldIndexForm->indisclustered;
1611 
1612  /*
1613  * Mark the new index as valid, and the old index as invalid similarly to
1614  * what index_set_state_flags() does.
1615  */
1616  newIndexForm->indisvalid = true;
1617  oldIndexForm->indisvalid = false;
1618  oldIndexForm->indisclustered = false;
1619  oldIndexForm->indisreplident = false;
1620 
1621  CatalogTupleUpdate(pg_index, &oldIndexTuple->t_self, oldIndexTuple);
1622  CatalogTupleUpdate(pg_index, &newIndexTuple->t_self, newIndexTuple);
1623 
1624  heap_freetuple(oldIndexTuple);
1625  heap_freetuple(newIndexTuple);
1626 
1627  /*
1628  * Move constraints and triggers over to the new index
1629  */
1630 
1631  constraintOids = get_index_ref_constraints(oldIndexId);
1632 
1633  indexConstraintOid = get_index_constraint(oldIndexId);
1634 
1635  if (OidIsValid(indexConstraintOid))
1636  constraintOids = lappend_oid(constraintOids, indexConstraintOid);
1637 
1638  pg_constraint = table_open(ConstraintRelationId, RowExclusiveLock);
1639  pg_trigger = table_open(TriggerRelationId, RowExclusiveLock);
1640 
1641  foreach(lc, constraintOids)
1642  {
1643  HeapTuple constraintTuple,
1644  triggerTuple;
1645  Form_pg_constraint conForm;
1646  ScanKeyData key[1];
1647  SysScanDesc scan;
1648  Oid constraintOid = lfirst_oid(lc);
1649 
1650  /* Move the constraint from the old to the new index */
1651  constraintTuple = SearchSysCacheCopy1(CONSTROID,
1652  ObjectIdGetDatum(constraintOid));
1653  if (!HeapTupleIsValid(constraintTuple))
1654  elog(ERROR, "could not find tuple for constraint %u", constraintOid);
1655 
1656  conForm = ((Form_pg_constraint) GETSTRUCT(constraintTuple));
1657 
1658  if (conForm->conindid == oldIndexId)
1659  {
1660  conForm->conindid = newIndexId;
1661 
1662  CatalogTupleUpdate(pg_constraint, &constraintTuple->t_self, constraintTuple);
1663  }
1664 
1665  heap_freetuple(constraintTuple);
1666 
1667  /* Search for trigger records */
1668  ScanKeyInit(&key[0],
1669  Anum_pg_trigger_tgconstraint,
1670  BTEqualStrategyNumber, F_OIDEQ,
1671  ObjectIdGetDatum(constraintOid));
1672 
1673  scan = systable_beginscan(pg_trigger, TriggerConstraintIndexId, true,
1674  NULL, 1, key);
1675 
1676  while (HeapTupleIsValid((triggerTuple = systable_getnext(scan))))
1677  {
1678  Form_pg_trigger tgForm = (Form_pg_trigger) GETSTRUCT(triggerTuple);
1679 
1680  if (tgForm->tgconstrindid != oldIndexId)
1681  continue;
1682 
1683  /* Make a modifiable copy */
1684  triggerTuple = heap_copytuple(triggerTuple);
1685  tgForm = (Form_pg_trigger) GETSTRUCT(triggerTuple);
1686 
1687  tgForm->tgconstrindid = newIndexId;
1688 
1689  CatalogTupleUpdate(pg_trigger, &triggerTuple->t_self, triggerTuple);
1690 
1691  heap_freetuple(triggerTuple);
1692  }
1693 
1694  systable_endscan(scan);
1695  }
1696 
1697  /*
1698  * Move comment if any
1699  */
1700  {
1701  Relation description;
1702  ScanKeyData skey[3];
1703  SysScanDesc sd;
1704  HeapTuple tuple;
1705  Datum values[Natts_pg_description] = {0};
1706  bool nulls[Natts_pg_description] = {0};
1707  bool replaces[Natts_pg_description] = {0};
1708 
1709  values[Anum_pg_description_objoid - 1] = ObjectIdGetDatum(newIndexId);
1710  replaces[Anum_pg_description_objoid - 1] = true;
1711 
1712  ScanKeyInit(&skey[0],
1713  Anum_pg_description_objoid,
1714  BTEqualStrategyNumber, F_OIDEQ,
1715  ObjectIdGetDatum(oldIndexId));
1716  ScanKeyInit(&skey[1],
1717  Anum_pg_description_classoid,
1718  BTEqualStrategyNumber, F_OIDEQ,
1719  ObjectIdGetDatum(RelationRelationId));
1720  ScanKeyInit(&skey[2],
1721  Anum_pg_description_objsubid,
1722  BTEqualStrategyNumber, F_INT4EQ,
1723  Int32GetDatum(0));
1724 
1725  description = table_open(DescriptionRelationId, RowExclusiveLock);
1726 
1727  sd = systable_beginscan(description, DescriptionObjIndexId, true,
1728  NULL, 3, skey);
1729 
1730  while ((tuple = systable_getnext(sd)) != NULL)
1731  {
1732  tuple = heap_modify_tuple(tuple, RelationGetDescr(description),
1733  values, nulls, replaces);
1734  CatalogTupleUpdate(description, &tuple->t_self, tuple);
1735 
1736  break; /* Assume there can be only one match */
1737  }
1738 
1739  systable_endscan(sd);
1740  table_close(description, NoLock);
1741  }
1742 
1743  /*
1744  * Swap inheritance relationship with parent index
1745  */
1746  if (get_rel_relispartition(oldIndexId))
1747  {
1748  List *ancestors = get_partition_ancestors(oldIndexId);
1749  Oid parentIndexRelid = linitial_oid(ancestors);
1750 
1751  DeleteInheritsTuple(oldIndexId, parentIndexRelid, false, NULL);
1752  StoreSingleInheritance(newIndexId, parentIndexRelid, 1);
1753 
1754  list_free(ancestors);
1755  }
1756 
1757  /*
1758  * Swap all dependencies of and on the old index to the new one, and
1759  * vice-versa. Note that a call to CommandCounterIncrement() would cause
1760  * duplicate entries in pg_depend, so this should not be done.
1761  */
1762  changeDependenciesOf(RelationRelationId, newIndexId, oldIndexId);
1763  changeDependenciesOn(RelationRelationId, newIndexId, oldIndexId);
1764 
1765  changeDependenciesOf(RelationRelationId, oldIndexId, newIndexId);
1766  changeDependenciesOn(RelationRelationId, oldIndexId, newIndexId);
1767 
1768  /* copy over statistics from old to new index */
1769  pgstat_copy_relation_stats(newClassRel, oldClassRel);
1770 
1771  /* Copy data of pg_statistic from the old index to the new one */
1772  CopyStatistics(oldIndexId, newIndexId);
1773 
1774  /* Copy pg_attribute.attstattarget for each index attribute */
1775  {
1776  HeapTuple attrTuple;
1777  Relation pg_attribute;
1778  SysScanDesc scan;
1779  ScanKeyData key[1];
1780 
1781  pg_attribute = table_open(AttributeRelationId, RowExclusiveLock);
1782  ScanKeyInit(&key[0],
1783  Anum_pg_attribute_attrelid,
1784  BTEqualStrategyNumber, F_OIDEQ,
1785  ObjectIdGetDatum(newIndexId));
1786  scan = systable_beginscan(pg_attribute, AttributeRelidNumIndexId,
1787  true, NULL, 1, key);
1788 
1789  while (HeapTupleIsValid((attrTuple = systable_getnext(scan))))
1790  {
1791  Form_pg_attribute att = (Form_pg_attribute) GETSTRUCT(attrTuple);
1792  Datum repl_val[Natts_pg_attribute];
1793  bool repl_null[Natts_pg_attribute];
1794  bool repl_repl[Natts_pg_attribute];
1795  int attstattarget;
1796  HeapTuple newTuple;
1797 
1798  /* Ignore dropped columns */
1799  if (att->attisdropped)
1800  continue;
1801 
1802  /*
1803  * Get attstattarget from the old index and refresh the new value.
1804  */
1805  attstattarget = get_attstattarget(oldIndexId, att->attnum);
1806 
1807  /* no need for a refresh if both match */
1808  if (attstattarget == att->attstattarget)
1809  continue;
1810 
1811  memset(repl_val, 0, sizeof(repl_val));
1812  memset(repl_null, false, sizeof(repl_null));
1813  memset(repl_repl, false, sizeof(repl_repl));
1814 
1815  repl_repl[Anum_pg_attribute_attstattarget - 1] = true;
1816  repl_val[Anum_pg_attribute_attstattarget - 1] = Int32GetDatum(attstattarget);
1817 
1818  newTuple = heap_modify_tuple(attrTuple,
1819  RelationGetDescr(pg_attribute),
1820  repl_val, repl_null, repl_repl);
1821  CatalogTupleUpdate(pg_attribute, &newTuple->t_self, newTuple);
1822 
1823  heap_freetuple(newTuple);
1824  }
1825 
1826  systable_endscan(scan);
1827  table_close(pg_attribute, RowExclusiveLock);
1828  }
1829 
1830  /* Close relations */
1831  table_close(pg_class, RowExclusiveLock);
1832  table_close(pg_index, RowExclusiveLock);
1833  table_close(pg_constraint, RowExclusiveLock);
1834  table_close(pg_trigger, RowExclusiveLock);
1835 
1836  /* The lock taken previously is not released until the end of transaction */
1837  relation_close(oldClassRel, NoLock);
1838  relation_close(newClassRel, NoLock);
1839 }
void systable_endscan(SysScanDesc sysscan)
Definition: genam.c:599
HeapTuple systable_getnext(SysScanDesc sysscan)
Definition: genam.c:506
SysScanDesc systable_beginscan(Relation heapRelation, Oid indexId, bool indexOK, Snapshot snapshot, int nkeys, ScanKey key)
Definition: genam.c:387
void CopyStatistics(Oid fromrelid, Oid torelid)
Definition: heap.c:2853
HeapTuple heap_copytuple(HeapTuple tuple)
Definition: heaptuple.c:680
HeapTuple heap_modify_tuple(HeapTuple tuple, TupleDesc tupleDesc, Datum *replValues, bool *replIsnull, bool *doReplace)
Definition: heaptuple.c:1113
List * lappend_oid(List *list, Oid datum)
Definition: list.c:374
void list_free(List *list)
Definition: list.c:1545
bool get_rel_relispartition(Oid relid)
Definition: lsyscache.c:2009
int get_attstattarget(Oid relid, AttrNumber attnum)
Definition: lsyscache.c:884
void namestrcpy(Name name, const char *str)
Definition: name.c:233
List * get_partition_ancestors(Oid relid)
Definition: partition.c:133
FormData_pg_class * Form_pg_class
Definition: pg_class.h:153
FormData_pg_constraint * Form_pg_constraint
long changeDependenciesOf(Oid classId, Oid oldObjectId, Oid newObjectId)
Definition: pg_depend.c:564
long changeDependenciesOn(Oid refClassId, Oid oldRefObjectId, Oid newRefObjectId)
Definition: pg_depend.c:620
Oid get_index_constraint(Oid indexId)
Definition: pg_depend.c:968
List * get_index_ref_constraints(Oid indexId)
Definition: pg_depend.c:1024
bool DeleteInheritsTuple(Oid inhrelid, Oid inhparent, bool expect_detach_pending, const char *childname)
Definition: pg_inherits.c:553
void StoreSingleInheritance(Oid relationId, Oid parentOid, int32 seqNumber)
Definition: pg_inherits.c:509
#define linitial_oid(l)
Definition: pg_list.h:180
#define lfirst_oid(lc)
Definition: pg_list.h:174
FormData_pg_trigger * Form_pg_trigger
Definition: pg_trigger.h:80
void pgstat_copy_relation_stats(Relation dst, Relation src)
static Datum Int32GetDatum(int32 X)
Definition: postgres.h:212
void ScanKeyInit(ScanKey entry, AttrNumber attributeNumber, StrategyNumber strategy, RegProcedure procedure, Datum argument)
Definition: scankey.c:76
void relation_close(Relation relation, LOCKMODE lockmode)
Definition: relation.c:206
Relation relation_open(Oid relationId, LOCKMODE lockmode)
Definition: relation.c:48
@ CONSTROID
Definition: syscache.h:53

References BTEqualStrategyNumber, CatalogTupleUpdate(), changeDependenciesOf(), changeDependenciesOn(), CONSTROID, CopyStatistics(), DeleteInheritsTuple(), elog(), ERROR, get_attstattarget(), 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, ObjectIdGetDatum(), OidIsValid, pgstat_copy_relation_stats(), relation_close(), relation_open(), RelationGetDescr, RELOID, RowExclusiveLock, ScanKeyInit(), SearchSysCacheCopy1, ShareUpdateExclusiveLock, StoreSingleInheritance(), systable_beginscan(), systable_endscan(), systable_getnext(), HeapTupleData::t_self, table_close(), table_open(), and values.

Referenced by ReindexRelationConcurrently().

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

1920 {
1921  Oid namespaceId = RelationGetNamespace(heapRelation);
1922  ObjectAddress myself,
1923  idxaddr;
1924  Oid conOid;
1925  bool deferrable;
1926  bool initdeferred;
1927  bool mark_as_primary;
1928  bool islocal;
1929  bool noinherit;
1930  int inhcount;
1931 
1932  deferrable = (constr_flags & INDEX_CONSTR_CREATE_DEFERRABLE) != 0;
1933  initdeferred = (constr_flags & INDEX_CONSTR_CREATE_INIT_DEFERRED) != 0;
1934  mark_as_primary = (constr_flags & INDEX_CONSTR_CREATE_MARK_AS_PRIMARY) != 0;
1935 
1936  /* constraint creation support doesn't work while bootstrapping */
1938 
1939  /* enforce system-table restriction */
1940  if (!allow_system_table_mods &&
1941  IsSystemRelation(heapRelation) &&
1943  ereport(ERROR,
1944  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1945  errmsg("user-defined indexes on system catalog tables are not supported")));
1946 
1947  /* primary/unique constraints shouldn't have any expressions */
1948  if (indexInfo->ii_Expressions &&
1949  constraintType != CONSTRAINT_EXCLUSION)
1950  elog(ERROR, "constraints cannot have index expressions");
1951 
1952  /*
1953  * If we're manufacturing a constraint for a pre-existing index, we need
1954  * to get rid of the existing auto dependencies for the index (the ones
1955  * that index_create() would have made instead of calling this function).
1956  *
1957  * Note: this code would not necessarily do the right thing if the index
1958  * has any expressions or predicate, but we'd never be turning such an
1959  * index into a UNIQUE or PRIMARY KEY constraint.
1960  */
1961  if (constr_flags & INDEX_CONSTR_CREATE_REMOVE_OLD_DEPS)
1962  deleteDependencyRecordsForClass(RelationRelationId, indexRelationId,
1963  RelationRelationId, DEPENDENCY_AUTO);
1964 
1965  if (OidIsValid(parentConstraintId))
1966  {
1967  islocal = false;
1968  inhcount = 1;
1969  noinherit = false;
1970  }
1971  else
1972  {
1973  islocal = true;
1974  inhcount = 0;
1975  noinherit = true;
1976  }
1977 
1978  /*
1979  * Construct a pg_constraint entry.
1980  */
1981  conOid = CreateConstraintEntry(constraintName,
1982  namespaceId,
1983  constraintType,
1984  deferrable,
1985  initdeferred,
1986  true,
1987  parentConstraintId,
1988  RelationGetRelid(heapRelation),
1989  indexInfo->ii_IndexAttrNumbers,
1990  indexInfo->ii_NumIndexKeyAttrs,
1991  indexInfo->ii_NumIndexAttrs,
1992  InvalidOid, /* no domain */
1993  indexRelationId, /* index OID */
1994  InvalidOid, /* no foreign key */
1995  NULL,
1996  NULL,
1997  NULL,
1998  NULL,
1999  0,
2000  ' ',
2001  ' ',
2002  NULL,
2003  0,
2004  ' ',
2005  indexInfo->ii_ExclusionOps,
2006  NULL, /* no check constraint */
2007  NULL,
2008  islocal,
2009  inhcount,
2010  noinherit,
2011  is_internal);
2012 
2013  /*
2014  * Register the index as internally dependent on the constraint.
2015  *
2016  * Note that the constraint has a dependency on the table, so we don't
2017  * need (or want) any direct dependency from the index to the table.
2018  */
2019  ObjectAddressSet(myself, ConstraintRelationId, conOid);
2020  ObjectAddressSet(idxaddr, RelationRelationId, indexRelationId);
2021  recordDependencyOn(&idxaddr, &myself, DEPENDENCY_INTERNAL);
2022 
2023  /*
2024  * Also, if this is a constraint on a partition, give it partition-type
2025  * dependencies on the parent constraint as well as the table.
2026  */
2027  if (OidIsValid(parentConstraintId))
2028  {
2029  ObjectAddress referenced;
2030 
2031  ObjectAddressSet(referenced, ConstraintRelationId, parentConstraintId);
2032  recordDependencyOn(&myself, &referenced, DEPENDENCY_PARTITION_PRI);
2033  ObjectAddressSet(referenced, RelationRelationId,
2034  RelationGetRelid(heapRelation));
2035  recordDependencyOn(&myself, &referenced, DEPENDENCY_PARTITION_SEC);
2036  }
2037 
2038  /*
2039  * If the constraint is deferrable, create the deferred uniqueness
2040  * checking trigger. (The trigger will be given an internal dependency on
2041  * the constraint by CreateTrigger.)
2042  */
2043  if (deferrable)
2044  {
2046 
2047  trigger->replace = false;
2048  trigger->isconstraint = true;
2049  trigger->trigname = (constraintType == CONSTRAINT_PRIMARY) ?
2050  "PK_ConstraintTrigger" :
2051  "Unique_ConstraintTrigger";
2052  trigger->relation = NULL;
2053  trigger->funcname = SystemFuncName("unique_key_recheck");
2054  trigger->args = NIL;
2055  trigger->row = true;
2056  trigger->timing = TRIGGER_TYPE_AFTER;
2057  trigger->events = TRIGGER_TYPE_INSERT | TRIGGER_TYPE_UPDATE;
2058  trigger->columns = NIL;
2059  trigger->whenClause = NULL;
2060  trigger->transitionRels = NIL;
2061  trigger->deferrable = true;
2062  trigger->initdeferred = initdeferred;
2063  trigger->constrrel = NULL;
2064 
2065  (void) CreateTrigger(trigger, NULL, RelationGetRelid(heapRelation),
2066  InvalidOid, conOid, indexRelationId, InvalidOid,
2067  InvalidOid, NULL, true, false);
2068  }
2069 
2070  /*
2071  * If needed, mark the index as primary and/or deferred in pg_index.
2072  *
2073  * Note: When making an existing index into a constraint, caller must have
2074  * a table lock that prevents concurrent table updates; otherwise, there
2075  * is a risk that concurrent readers of the table will miss seeing this
2076  * index at all.
2077  */
2078  if ((constr_flags & INDEX_CONSTR_CREATE_UPDATE_INDEX) &&
2079  (mark_as_primary || deferrable))
2080  {
2081  Relation pg_index;
2082  HeapTuple indexTuple;
2083  Form_pg_index indexForm;
2084  bool dirty = false;
2085  bool marked_as_primary = false;
2086 
2087  pg_index = table_open(IndexRelationId, RowExclusiveLock);
2088 
2089  indexTuple = SearchSysCacheCopy1(INDEXRELID,
2090  ObjectIdGetDatum(indexRelationId));
2091  if (!HeapTupleIsValid(indexTuple))
2092  elog(ERROR, "cache lookup failed for index %u", indexRelationId);
2093  indexForm = (Form_pg_index) GETSTRUCT(indexTuple);
2094 
2095  if (mark_as_primary && !indexForm->indisprimary)
2096  {
2097  indexForm->indisprimary = true;
2098  dirty = true;
2099  marked_as_primary = true;
2100  }
2101 
2102  if (deferrable && indexForm->indimmediate)
2103  {
2104  indexForm->indimmediate = false;
2105  dirty = true;
2106  }
2107 
2108  if (dirty)
2109  {
2110  CatalogTupleUpdate(pg_index, &indexTuple->t_self, indexTuple);
2111 
2112  /*
2113  * When we mark an existing index as primary, force a relcache
2114  * flush on its parent table, so that all sessions will become
2115  * aware that the table now has a primary key. This is important
2116  * because it affects some replication behaviors.
2117  */
2118  if (marked_as_primary)
2119  CacheInvalidateRelcache(heapRelation);
2120 
2121  InvokeObjectPostAlterHookArg(IndexRelationId, indexRelationId, 0,
2122  InvalidOid, is_internal);
2123  }
2124 
2125  heap_freetuple(indexTuple);
2126  table_close(pg_index, RowExclusiveLock);
2127  }
2128 
2129  return myself;
2130 }
bool IsSystemRelation(Relation relation)
Definition: catalog.c:75
@ DEPENDENCY_AUTO
Definition: dependency.h:34
@ DEPENDENCY_INTERNAL
Definition: dependency.h:35
@ DEPENDENCY_PARTITION_PRI
Definition: dependency.h:36
@ DEPENDENCY_PARTITION_SEC
Definition: dependency.h:37
#define INDEX_CONSTR_CREATE_UPDATE_INDEX
Definition: index.h:92
#define INDEX_CONSTR_CREATE_REMOVE_OLD_DEPS
Definition: index.h:93
#define INDEX_CONSTR_CREATE_DEFERRABLE
Definition: index.h:90
#define INDEX_CONSTR_CREATE_MARK_AS_PRIMARY
Definition: index.h:89
#define INDEX_CONSTR_CREATE_INIT_DEFERRED
Definition: index.h:91
#define IsBootstrapProcessingMode()
Definition: miscadmin.h:405
#define makeNode(_type_)
Definition: nodes.h:176
#define InvokeObjectPostAlterHookArg(classId, objectId, subId, auxiliaryId, is_internal)
Definition: objectaccess.h:200
#define ObjectAddressSet(addr, class_id, object_id)
Definition: objectaddress.h:40
List * SystemFuncName(char *name)
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, const int16 *fkDeleteSetCols, int numFkDeleteSetCols, char foreignMatchType, const Oid *exclOp, Node *conExpr, const char *conBin, bool conIsLocal, int conInhCount, bool conNoInherit, bool is_internal)
Definition: pg_constraint.c:50
void recordDependencyOn(const ObjectAddress *depender, const ObjectAddress *referenced, DependencyType behavior)
Definition: pg_depend.c:44
long deleteDependencyRecordsForClass(Oid classId, Oid objectId, Oid refclassId, char deptype)
Definition: pg_depend.c:350
#define RelationGetNamespace(relation)
Definition: rel.h:544
Node * whenClause
Definition: parsenodes.h:2742
List * transitionRels
Definition: parsenodes.h:2744
RangeVar * constrrel
Definition: parsenodes.h:2748
RangeVar * relation
Definition: parsenodes.h:2733
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:165

References CreateTrigStmt::args, Assert(), CacheInvalidateRelcache(), 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::replace, CreateTrigStmt::row, RowExclusiveLock, SearchSysCacheCopy1, SystemFuncName(), HeapTupleData::t_self, table_close(), table_open(), CreateTrigStmt::timing, CreateTrigStmt::transitionRels, CreateTrigStmt::trigname, and CreateTrigStmt::whenClause.

Referenced by ATExecAddIndexConstraint(), and index_create().

◆ index_create()

Oid index_create ( Relation  heapRelation,
const char *  indexRelationName,
Oid  indexRelationId,
Oid  parentIndexRelid,
Oid  parentConstraintId,
RelFileNumber  relFileNumber,
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 713 of file index.c.

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

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

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

◆ index_drop()

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

Definition at line 2144 of file index.c.

2145 {
2146  Oid heapId;
2147  Relation userHeapRelation;
2148  Relation userIndexRelation;
2149  Relation indexRelation;
2150  HeapTuple tuple;
2151  bool hasexprs;
2152  LockRelId heaprelid,
2153  indexrelid;
2154  LOCKTAG heaplocktag;
2155  LOCKMODE lockmode;
2156 
2157  /*
2158  * A temporary relation uses a non-concurrent DROP. Other backends can't
2159  * access a temporary relation, so there's no harm in grabbing a stronger
2160  * lock (see comments in RemoveRelations), and a non-concurrent DROP is
2161  * more efficient.
2162  */
2163  Assert(get_rel_persistence(indexId) != RELPERSISTENCE_TEMP ||
2164  (!concurrent && !concurrent_lock_mode));
2165 
2166  /*
2167  * To drop an index safely, we must grab exclusive lock on its parent
2168  * table. Exclusive lock on the index alone is insufficient because
2169  * another backend might be about to execute a query on the parent table.
2170  * If it relies on a previously cached list of index OIDs, then it could
2171  * attempt to access the just-dropped index. We must therefore take a
2172  * table lock strong enough to prevent all queries on the table from
2173  * proceeding until we commit and send out a shared-cache-inval notice
2174  * that will make them update their index lists.
2175  *
2176  * In the concurrent case we avoid this requirement by disabling index use
2177  * in multiple steps and waiting out any transactions that might be using
2178  * the index, so we don't need exclusive lock on the parent table. Instead
2179  * we take ShareUpdateExclusiveLock, to ensure that two sessions aren't
2180  * doing CREATE/DROP INDEX CONCURRENTLY on the same index. (We will get
2181  * AccessExclusiveLock on the index below, once we're sure nobody else is
2182  * using it.)
2183  */
2184  heapId = IndexGetRelation(indexId, false);
2185  lockmode = (concurrent || concurrent_lock_mode) ? ShareUpdateExclusiveLock : AccessExclusiveLock;
2186  userHeapRelation = table_open(heapId, lockmode);
2187  userIndexRelation = index_open(indexId, lockmode);
2188 
2189  /*
2190  * We might still have open queries using it in our own session, which the
2191  * above locking won't prevent, so test explicitly.
2192  */
2193  CheckTableNotInUse(userIndexRelation, "DROP INDEX");
2194 
2195  /*
2196  * Drop Index Concurrently is more or less the reverse process of Create
2197  * Index Concurrently.
2198  *
2199  * First we unset indisvalid so queries starting afterwards don't use the
2200  * index to answer queries anymore. We have to keep indisready = true so
2201  * transactions that are still scanning the index can continue to see
2202  * valid index contents. For instance, if they are using READ COMMITTED
2203  * mode, and another transaction makes changes and commits, they need to
2204  * see those new tuples in the index.
2205  *
2206  * After all transactions that could possibly have used the index for
2207  * queries end, we can unset indisready and indislive, then wait till
2208  * nobody could be touching it anymore. (Note: we need indislive because
2209  * this state must be distinct from the initial state during CREATE INDEX
2210  * CONCURRENTLY, which has indislive true while indisready and indisvalid
2211  * are false. That's because in that state, transactions must examine the
2212  * index for HOT-safety decisions, while in this state we don't want them
2213  * to open it at all.)
2214  *
2215  * Since all predicate locks on the index are about to be made invalid, we
2216  * must promote them to predicate locks on the heap. In the
2217  * non-concurrent case we can just do that now. In the concurrent case
2218  * it's a bit trickier. The predicate locks must be moved when there are
2219  * no index scans in progress on the index and no more can subsequently
2220  * start, so that no new predicate locks can be made on the index. Also,
2221  * they must be moved before heap inserts stop maintaining the index, else
2222  * the conflict with the predicate lock on the index gap could be missed
2223  * before the lock on the heap relation is in place to detect a conflict
2224  * based on the heap tuple insert.
2225  */
2226  if (concurrent)
2227  {
2228  /*
2229  * We must commit our transaction in order to make the first pg_index
2230  * state update visible to other sessions. If the DROP machinery has
2231  * already performed any other actions (removal of other objects,
2232  * pg_depend entries, etc), the commit would make those actions
2233  * permanent, which would leave us with inconsistent catalog state if
2234  * we fail partway through the following sequence. Since DROP INDEX
2235  * CONCURRENTLY is restricted to dropping just one index that has no
2236  * dependencies, we should get here before anything's been done ---
2237  * but let's check that to be sure. We can verify that the current
2238  * transaction has not executed any transactional updates by checking
2239  * that no XID has been assigned.
2240  */
2242  ereport(ERROR,
2243  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
2244  errmsg("DROP INDEX CONCURRENTLY must be first action in transaction")));
2245 
2246  /*
2247  * Mark index invalid by updating its pg_index entry
2248  */
2250 
2251  /*
2252  * Invalidate the relcache for the table, so that after this commit
2253  * all sessions will refresh any cached plans that might reference the
2254  * index.
2255  */
2256  CacheInvalidateRelcache(userHeapRelation);
2257 
2258  /* save lockrelid and locktag for below, then close but keep locks */
2259  heaprelid = userHeapRelation->rd_lockInfo.lockRelId;
2260  SET_LOCKTAG_RELATION(heaplocktag, heaprelid.dbId, heaprelid.relId);
2261  indexrelid = userIndexRelation->rd_lockInfo.lockRelId;
2262 
2263  table_close(userHeapRelation, NoLock);
2264  index_close(userIndexRelation, NoLock);
2265 
2266  /*
2267  * We must commit our current transaction so that the indisvalid
2268  * update becomes visible to other transactions; then start another.
2269  * Note that any previously-built data structures are lost in the
2270  * commit. The only data we keep past here are the relation IDs.
2271  *
2272  * Before committing, get a session-level lock on the table, to ensure
2273  * that neither it nor the index can be dropped before we finish. This
2274  * cannot block, even if someone else is waiting for access, because
2275  * we already have the same lock within our transaction.
2276  */
2279 
2283 
2284  /*
2285  * Now we must wait until no running transaction could be using the
2286  * index for a query. Use AccessExclusiveLock here to check for
2287  * running transactions that hold locks of any kind on the table. Note
2288  * we do not need to worry about xacts that open the table for reading
2289  * after this point; they will see the index as invalid when they open
2290  * the relation.
2291  *
2292  * Note: the reason we use actual lock acquisition here, rather than
2293  * just checking the ProcArray and sleeping, is that deadlock is
2294  * possible if one of the transactions in question is blocked trying
2295  * to acquire an exclusive lock on our table. The lock code will
2296  * detect deadlock and error out properly.
2297  *
2298  * Note: we report progress through WaitForLockers() unconditionally
2299  * here, even though it will only be used when we're called by REINDEX
2300  * CONCURRENTLY and not when called by DROP INDEX CONCURRENTLY.
2301  */
2302  WaitForLockers(heaplocktag, AccessExclusiveLock, true);
2303 
2304  /* Finish invalidation of index and mark it as dead */
2305  index_concurrently_set_dead(heapId, indexId);
2306 
2307  /*
2308  * Again, commit the transaction to make the pg_index update visible
2309  * to other sessions.
2310  */
2313 
2314  /*
2315  * Wait till every transaction that saw the old index state has
2316  * finished. See above about progress reporting.
2317  */
2318  WaitForLockers(heaplocktag, AccessExclusiveLock, true);
2319 
2320  /*
2321  * Re-open relations to allow us to complete our actions.
2322  *
2323  * At this point, nothing should be accessing the index, but lets
2324  * leave nothing to chance and grab AccessExclusiveLock on the index
2325  * before the physical deletion.
2326  */
2327  userHeapRelation = table_open(heapId, ShareUpdateExclusiveLock);
2328  userIndexRelation = index_open(indexId, AccessExclusiveLock);
2329  }
2330  else
2331  {
2332  /* Not concurrent, so just transfer predicate locks and we're good */
2333  TransferPredicateLocksToHeapRelation(userIndexRelation);
2334  }
2335 
2336  /*
2337  * Schedule physical removal of the files (if any)
2338  */
2339  if (RELKIND_HAS_STORAGE(userIndexRelation->rd_rel->relkind))
2340  RelationDropStorage(userIndexRelation);
2341 
2342  /* ensure that stats are dropped if transaction commits */
2343  pgstat_drop_relation(userIndexRelation);
2344 
2345  /*
2346  * Close and flush the index's relcache entry, to ensure relcache doesn't
2347  * try to rebuild it while we're deleting catalog entries. We keep the
2348  * lock though.
2349  */
2350  index_close(userIndexRelation, NoLock);
2351 
2352  RelationForgetRelation(indexId);
2353 
2354  /*
2355  * fix INDEX relation, and check for expressional index
2356  */
2357  indexRelation = table_open(IndexRelationId, RowExclusiveLock);
2358 
2359  tuple = SearchSysCache1(INDEXRELID, ObjectIdGetDatum(indexId));
2360  if (!HeapTupleIsValid(tuple))
2361  elog(ERROR, "cache lookup failed for index %u", indexId);
2362 
2363  hasexprs = !heap_attisnull(tuple, Anum_pg_index_indexprs,
2364  RelationGetDescr(indexRelation));
2365 
2366  CatalogTupleDelete(indexRelation, &tuple->t_self);
2367 
2368  ReleaseSysCache(tuple);
2369  table_close(indexRelation, RowExclusiveLock);
2370 
2371  /*
2372  * if it has any expression columns, we might have stored statistics about
2373  * them.
2374  */
2375  if (hasexprs)
2376  RemoveStatistics(indexId, 0);
2377 
2378  /*
2379  * fix ATTRIBUTE relation
2380  */
2381  DeleteAttributeTuples(indexId);
2382 
2383  /*
2384  * fix RELATION relation
2385  */
2386  DeleteRelationTuple(indexId);
2387 
2388  /*
2389  * fix INHERITS relation
2390  */
2391  DeleteInheritsTuple(indexId, InvalidOid, false, NULL);
2392 
2393  /*
2394  * We are presently too lazy to attempt to compute the new correct value
2395  * of relhasindex (the next VACUUM will fix it if necessary). So there is
2396  * no need to update the pg_class tuple for the owning relation. But we
2397  * must send out a shared-cache-inval notice on the owning relation to
2398  * ensure other backends update their relcache lists of indexes. (In the
2399  * concurrent case, this is redundant but harmless.)
2400  */
2401  CacheInvalidateRelcache(userHeapRelation);
2402 
2403  /*
2404  * Close owning rel, but keep lock
2405  */
2406  table_close(userHeapRelation, NoLock);
2407 
2408  /*
2409  * Release the session locks before we go.
2410  */
2411  if (concurrent)
2412  {
2415  }
2416 }
void DeleteRelationTuple(Oid relid)
Definition: heap.c:1536
void DeleteAttributeTuples(Oid relid)
Definition: heap.c:1565
void RemoveStatistics(Oid relid, AttrNumber attnum)
Definition: heap.c:2906
bool heap_attisnull(HeapTuple tup, int attnum, TupleDesc tupleDesc)
Definition: heaptuple.c:359
Oid IndexGetRelation(Oid indexId, bool missing_ok)
Definition: index.c:3537
void index_concurrently_set_dead(Oid heapId, Oid indexId)
Definition: index.c:1850
void CatalogTupleDelete(Relation heapRel, ItemPointer tid)
Definition: indexing.c:365
void LockRelationIdForSession(LockRelId *relid, LOCKMODE lockmode)
Definition: lmgr.c:398
void WaitForLockers(LOCKTAG heaplocktag, LOCKMODE lockmode, bool progress)
Definition: lmgr.c:986
void UnlockRelationIdForSession(LockRelId *relid, LOCKMODE lockmode)
Definition: lmgr.c:411
#define SET_LOCKTAG_RELATION(locktag, dboid, reloid)
Definition: lock.h:181
int LOCKMODE
Definition: lockdefs.h:26
char get_rel_persistence(Oid relid)
Definition: lsyscache.c:2060
void pgstat_drop_relation(Relation rel)
void RelationForgetRelation(Oid rid)
Definition: relcache.c:2833
void PopActiveSnapshot(void)
Definition: snapmgr.c:778
void RelationDropStorage(Relation rel)
Definition: storage.c:205
Definition: lock.h:165
LockRelId lockRelId
Definition: rel.h:45
Definition: rel.h:38
Oid relId
Definition: rel.h:39
Oid dbId
Definition: rel.h:40
LockInfoData rd_lockInfo
Definition: rel.h:113
void CheckTableNotInUse(Relation rel, const char *stmt)
Definition: tablecmds.c:4071
TransactionId GetTopTransactionIdIfAny(void)
Definition: xact.c:432
void StartTransactionCommand(void)
Definition: xact.c:2944
void CommitTransactionCommand(void)
Definition: xact.c:3041

References AccessExclusiveLock, Assert(), CacheInvalidateRelcache(), CatalogTupleDelete(), CheckTableNotInUse(), CommitTransactionCommand(), LockRelId::dbId, DeleteAttributeTuples(), DeleteInheritsTuple(), DeleteRelationTuple(), elog(), ereport, errcode(), errmsg(), ERROR, get_rel_persistence(), GetTopTransactionIdIfAny(), heap_attisnull(), HeapTupleIsValid, index_close(), index_concurrently_set_dead(), INDEX_DROP_CLEAR_VALID, index_open(), index_set_state_flags(), IndexGetRelation(), INDEXRELID, InvalidOid, InvalidTransactionId, LockRelationIdForSession(), LockInfoData::lockRelId, NoLock, ObjectIdGetDatum(), pgstat_drop_relation(), 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().

◆ index_set_state_flags()

void index_set_state_flags ( Oid  indexId,
IndexStateFlagsAction  action 
)

Definition at line 3457 of file index.c.

3458 {
3459  Relation pg_index;
3460  HeapTuple indexTuple;
3461  Form_pg_index indexForm;
3462 
3463  /* Open pg_index and fetch a writable copy of the index's tuple */
3464  pg_index = table_open(IndexRelationId, RowExclusiveLock);
3465 
3466  indexTuple = SearchSysCacheCopy1(INDEXRELID,
3467  ObjectIdGetDatum(indexId));
3468  if (!HeapTupleIsValid(indexTuple))
3469  elog(ERROR, "cache lookup failed for index %u", indexId);
3470  indexForm = (Form_pg_index) GETSTRUCT(indexTuple);
3471 
3472  /* Perform the requested state change on the copy */
3473  switch (action)
3474  {
3476  /* Set indisready during a CREATE INDEX CONCURRENTLY sequence */
3477  Assert(indexForm->indislive);
3478  Assert(!indexForm->indisready);
3479  Assert(!indexForm->indisvalid);
3480  indexForm->indisready = true;
3481  break;
3483  /* Set indisvalid during a CREATE INDEX CONCURRENTLY sequence */
3484  Assert(indexForm->indislive);
3485  Assert(indexForm->indisready);
3486  Assert(!indexForm->indisvalid);
3487  indexForm->indisvalid = true;
3488  break;
3490 
3491  /*
3492  * Clear indisvalid during a DROP INDEX CONCURRENTLY sequence
3493  *
3494  * If indisready == true we leave it set so the index still gets
3495  * maintained by active transactions. We only need to ensure that
3496  * indisvalid is false. (We don't assert that either is initially
3497  * true, though, since we want to be able to retry a DROP INDEX
3498  * CONCURRENTLY that failed partway through.)
3499  *
3500  * Note: the CLUSTER logic assumes that indisclustered cannot be
3501  * set on any invalid index, so clear that flag too. For
3502  * cleanliness, also clear indisreplident.
3503  */
3504  indexForm->indisvalid = false;
3505  indexForm->indisclustered = false;
3506  indexForm->indisreplident = false;
3507  break;
3508  case INDEX_DROP_SET_DEAD:
3509 
3510  /*
3511  * Clear indisready/indislive during DROP INDEX CONCURRENTLY
3512  *
3513  * We clear both indisready and indislive, because we not only
3514  * want to stop updates, we want to prevent sessions from touching
3515  * the index at all.
3516  */
3517  Assert(!indexForm->indisvalid);
3518  Assert(!indexForm->indisclustered);
3519  Assert(!indexForm->indisreplident);
3520  indexForm->indisready = false;
3521  indexForm->indislive = false;
3522  break;
3523  }
3524 
3525  /* ... and update it */
3526  CatalogTupleUpdate(pg_index, &indexTuple->t_self, indexTuple);
3527 
3528  table_close(pg_index, RowExclusiveLock);
3529 }

References generate_unaccent_rules::action, Assert(), CatalogTupleUpdate(), elog(), ERROR, GETSTRUCT, HeapTupleIsValid, INDEX_CREATE_SET_READY, INDEX_CREATE_SET_VALID, INDEX_DROP_CLEAR_VALID, INDEX_DROP_SET_DEAD, INDEXRELID, ObjectIdGetDatum(), RowExclusiveLock, SearchSysCacheCopy1, HeapTupleData::t_self, table_close(), and table_open().

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

◆ IndexGetRelation()

Oid IndexGetRelation ( Oid  indexId,
bool  missing_ok 
)

Definition at line 3537 of file index.c.

3538 {
3539  HeapTuple tuple;
3541  Oid result;
3542 
3543  tuple = SearchSysCache1(INDEXRELID, ObjectIdGetDatum(indexId));
3544  if (!HeapTupleIsValid(tuple))
3545  {
3546  if (missing_ok)
3547  return InvalidOid;
3548  elog(ERROR, "cache lookup failed for index %u", indexId);
3549  }
3550  index = (Form_pg_index) GETSTRUCT(tuple);
3551  Assert(index->indexrelid == indexId);
3552 
3553  result = index->indrelid;
3554  ReleaseSysCache(tuple);
3555  return result;
3556 }

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

Referenced by brin_desummarize_range(), brin_summarize_range(), bringetbitmap(), brinvacuumcleanup(), bt_index_check_internal(), CheckIndexCompatible(), DetachPartitionFinalize(), get_tables_to_cluster_partitioned(), index_drop(), RangeVarCallbackForAttachIndex(), RangeVarCallbackForDropRelation(), RangeVarCallbackForReindexIndex(), reindex_index(), and ReindexRelationConcurrently().

◆ IndexSetParentIndex()

void IndexSetParentIndex ( Relation  partitionIdx,
Oid  parentOid 
)

Definition at line 4189 of file indexcmds.c.

4190 {
4191  Relation pg_inherits;
4192  ScanKeyData key[2];
4193  SysScanDesc scan;
4194  Oid partRelid = RelationGetRelid(partitionIdx);
4195  HeapTuple tuple;
4196  bool fix_dependencies;
4197 
4198  /* Make sure this is an index */
4199  Assert(partitionIdx->rd_rel->relkind == RELKIND_INDEX ||
4200  partitionIdx->rd_rel->relkind == RELKIND_PARTITIONED_INDEX);
4201 
4202  /*
4203  * Scan pg_inherits for rows linking our index to some parent.
4204  */
4205  pg_inherits = relation_open(InheritsRelationId, RowExclusiveLock);
4206  ScanKeyInit(&key[0],
4207  Anum_pg_inherits_inhrelid,
4208  BTEqualStrategyNumber, F_OIDEQ,
4209  ObjectIdGetDatum(partRelid));
4210  ScanKeyInit(&key[1],
4211  Anum_pg_inherits_inhseqno,
4212  BTEqualStrategyNumber, F_INT4EQ,
4213  Int32GetDatum(1));
4214  scan = systable_beginscan(pg_inherits, InheritsRelidSeqnoIndexId, true,
4215  NULL, 2, key);
4216  tuple = systable_getnext(scan);
4217 
4218  if (!HeapTupleIsValid(tuple))
4219  {
4220  if (parentOid == InvalidOid)
4221  {
4222  /*
4223  * No pg_inherits row, and no parent wanted: nothing to do in this
4224  * case.
4225  */
4226  fix_dependencies = false;
4227  }
4228  else
4229  {
4230  StoreSingleInheritance(partRelid, parentOid, 1);
4231  fix_dependencies = true;
4232  }
4233  }
4234  else
4235  {
4236  Form_pg_inherits inhForm = (Form_pg_inherits) GETSTRUCT(tuple);
4237 
4238  if (parentOid == InvalidOid)
4239  {
4240  /*
4241  * There exists a pg_inherits row, which we want to clear; do so.
4242  */
4243  CatalogTupleDelete(pg_inherits, &tuple->t_self);
4244  fix_dependencies = true;
4245  }
4246  else
4247  {
4248  /*
4249  * A pg_inherits row exists. If it's the same we want, then we're
4250  * good; if it differs, that amounts to a corrupt catalog and
4251  * should not happen.
4252  */
4253  if (inhForm->inhparent != parentOid)
4254  {
4255  /* unexpected: we should not get called in this case */
4256  elog(ERROR, "bogus pg_inherit row: inhrelid %u inhparent %u",
4257  inhForm->inhrelid, inhForm->inhparent);
4258  }
4259 
4260  /* already in the right state */
4261  fix_dependencies = false;
4262  }
4263  }
4264 
4265  /* done with pg_inherits */
4266  systable_endscan(scan);
4267  relation_close(pg_inherits, RowExclusiveLock);
4268 
4269  /* set relhassubclass if an index partition has been added to the parent */
4270  if (OidIsValid(parentOid))
4271  SetRelationHasSubclass(parentOid, true);
4272 
4273  /* set relispartition correctly on the partition */
4274  update_relispartition(partRelid, OidIsValid(parentOid));
4275 
4276  if (fix_dependencies)
4277  {
4278  /*
4279  * Insert/delete pg_depend rows. If setting a parent, add PARTITION
4280  * dependencies on the parent index and the table; if removing a
4281  * parent, delete PARTITION dependencies.
4282  */
4283  if (OidIsValid(parentOid))
4284  {
4285  ObjectAddress partIdx;
4286  ObjectAddress parentIdx;
4287  ObjectAddress partitionTbl;
4288 
4289  ObjectAddressSet(partIdx, RelationRelationId, partRelid);
4290  ObjectAddressSet(parentIdx, RelationRelationId, parentOid);
4291  ObjectAddressSet(partitionTbl, RelationRelationId,
4292  partitionIdx->rd_index->indrelid);
4293  recordDependencyOn(&partIdx, &parentIdx,
4295  recordDependencyOn(&partIdx, &partitionTbl,
4297  }
4298  else
4299  {
4300  deleteDependencyRecordsForClass(RelationRelationId, partRelid,
4301  RelationRelationId,
4303  deleteDependencyRecordsForClass(RelationRelationId, partRelid,
4304  RelationRelationId,
4306  }
4307 
4308  /* make our updates visible */
4310  }
4311 }
static void update_relispartition(Oid relationId, bool newval)
Definition: indexcmds.c:4318
static void fix_dependencies(ArchiveHandle *AH)
FormData_pg_inherits * Form_pg_inherits
Definition: pg_inherits.h:45

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

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

◆ itemptr_decode()

static void itemptr_decode ( ItemPointer  itemptr,
int64  encoded 
)
inlinestatic

Definition at line 206 of file index.h.

207 {
208  BlockNumber block = (BlockNumber) (encoded >> 16);
209  OffsetNumber offset = (OffsetNumber) (encoded & 0xFFFF);
210 
211  ItemPointerSet(itemptr, block, offset);
212 }
uint32 BlockNumber
Definition: block.h:31
static void ItemPointerSet(ItemPointerData *pointer, BlockNumber blockNumber, OffsetNumber offNum)
Definition: itemptr.h:135
uint16 OffsetNumber
Definition: off.h:24

References ItemPointerSet().

Referenced by heapam_index_validate_scan().

◆ itemptr_encode()

static int64 itemptr_encode ( ItemPointer  itemptr)
inlinestatic

Definition at line 185 of file index.h.

186 {
187  BlockNumber block = ItemPointerGetBlockNumber(itemptr);
188  OffsetNumber offset = ItemPointerGetOffsetNumber(itemptr);
189  int64 encoded;
190 
191  /*
192  * Use the 16 least significant bits for the offset. 32 adjacent bits are
193  * used for the block number. Since remaining bits are unused, there
194  * cannot be negative encoded values (We assume a two's complement
195  * representation).
196  */
197  encoded = ((uint64) block << 16) | (uint16) offset;
198 
199  return encoded;
200 }
static OffsetNumber ItemPointerGetOffsetNumber(const ItemPointerData *pointer)
Definition: itemptr.h:124
static BlockNumber ItemPointerGetBlockNumber(const ItemPointerData *pointer)
Definition: itemptr.h:103

References ItemPointerGetBlockNumber(), and ItemPointerGetOffsetNumber().

Referenced by vac_tid_reaped(), and validate_index_callback().

◆ reindex_index()

void reindex_index ( Oid  indexId,
bool  skip_constraint_checks,
char  persistence,
ReindexParams params 
)

Definition at line 3562 of file index.c.

3564 {
3565  Relation iRel,
3566  heapRelation;
3567  Oid heapId;
3568  Oid save_userid;
3569  int save_sec_context;
3570  int save_nestlevel;
3571  IndexInfo *indexInfo;
3572  volatile bool skipped_constraint = false;
3573  PGRUsage ru0;
3574  bool progress = ((params->options & REINDEXOPT_REPORT_PROGRESS) != 0);
3575  bool set_tablespace = false;
3576 
3577  pg_rusage_init(&ru0);
3578 
3579  /*
3580  * Open and lock the parent heap relation. ShareLock is sufficient since
3581  * we only need to be sure no schema or data changes are going on.
3582  */
3583  heapId = IndexGetRelation(indexId,
3584  (params->options & REINDEXOPT_MISSING_OK) != 0);
3585  /* if relation is missing, leave */
3586  if (!OidIsValid(heapId))
3587  return;
3588 
3589  if ((params->options & REINDEXOPT_MISSING_OK) != 0)
3590  heapRelation = try_table_open(heapId, ShareLock);
3591  else
3592  heapRelation = table_open(heapId, ShareLock);
3593 
3594  /* if relation is gone, leave */
3595  if (!heapRelation)
3596  return;
3597 
3598  /*
3599  * Switch to the table owner's userid, so that any index functions are run
3600  * as that user. Also lock down security-restricted operations and
3601  * arrange to make GUC variable changes local to this command.
3602  */
3603  GetUserIdAndSecContext(&save_userid, &save_sec_context);
3604  SetUserIdAndSecContext(heapRelation->rd_rel->relowner,
3605  save_sec_context | SECURITY_RESTRICTED_OPERATION);
3606  save_nestlevel = NewGUCNestLevel();
3607 
3608  if (progress)
3609  {
3610  const int progress_cols[] = {
3613  };
3614  const int64 progress_vals[] = {
3616  indexId
3617  };
3618 
3620  heapId);
3621  pgstat_progress_update_multi_param(2, progress_cols, progress_vals);
3622  }
3623 
3624  /*
3625  * Open the target index relation and get an exclusive lock on it, to
3626  * ensure that no one else is touching this particular index.
3627  */
3628  iRel = index_open(indexId, AccessExclusiveLock);
3629 
3630  if (progress)
3632  iRel->rd_rel->relam);
3633 
3634  /*
3635  * Partitioned indexes should never get processed here, as they have no
3636  * physical storage.
3637  */
3638  if (iRel->rd_rel->relkind == RELKIND_PARTITIONED_INDEX)
3639  elog(ERROR, "cannot reindex partitioned index \"%s.%s\"",
3641  RelationGetRelationName(iRel));
3642 
3643  /*
3644  * Don't allow reindex on temp tables of other backends ... their local
3645  * buffer manager is not going to cope.
3646  */
3647  if (RELATION_IS_OTHER_TEMP(iRel))
3648  ereport(ERROR,
3649  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
3650  errmsg("cannot reindex temporary tables of other sessions")));
3651 
3652  /*
3653  * Don't allow reindex of an invalid index on TOAST table. This is a
3654  * leftover from a failed REINDEX CONCURRENTLY, and if rebuilt it would
3655  * not be possible to drop it anymore.
3656  */
3658  !get_index_isvalid(indexId))
3659  ereport(ERROR,
3660  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
3661  errmsg("cannot reindex invalid index on TOAST table")));
3662 
3663  /*
3664  * System relations cannot be moved even if allow_system_table_mods is
3665  * enabled to keep things consistent with the concurrent case where all
3666  * the indexes of a relation are processed in series, including indexes of
3667  * toast relations.
3668  *
3669  * Note that this check is not part of CheckRelationTableSpaceMove() as it
3670  * gets used for ALTER TABLE SET TABLESPACE that could cascade across
3671  * toast relations.
3672  */
3673  if (OidIsValid(params->tablespaceOid) &&
3674  IsSystemRelation(iRel))
3675  ereport(ERROR,
3676  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
3677  errmsg("cannot move system relation \"%s\"",
3678  RelationGetRelationName(iRel))));
3679 
3680  /* Check if the tablespace of this index needs to be changed */
3681  if (OidIsValid(params->tablespaceOid) &&
3683  set_tablespace = true;
3684 
3685  /*
3686  * Also check for active uses of the index in the current transaction; we
3687  * don't want to reindex underneath an open indexscan.
3688  */
3689  CheckTableNotInUse(iRel, "REINDEX INDEX");
3690 
3691  /* Set new tablespace, if requested */
3692  if (set_tablespace)
3693  {
3694  /* Update its pg_class row */
3696 
3697  /*
3698  * Schedule unlinking of the old index storage at transaction commit.
3699  */
3700  RelationDropStorage(iRel);
3702 
3703  /* Make sure the reltablespace change is visible */
3705  }
3706 
3707  /*
3708  * All predicate locks on the index are about to be made invalid. Promote
3709  * them to relation locks on the heap.
3710  */
3712 
3713  /* Fetch info needed for index_build */
3714  indexInfo = BuildIndexInfo(iRel);
3715 
3716  /* If requested, skip checking uniqueness/exclusion constraints */
3717  if (skip_constraint_checks)
3718  {
3719  if (indexInfo->ii_Unique || indexInfo->ii_ExclusionOps != NULL)
3720  skipped_constraint = true;
3721  indexInfo->ii_Unique = false;
3722  indexInfo->ii_ExclusionOps = NULL;
3723  indexInfo->ii_ExclusionProcs = NULL;
3724  indexInfo->ii_ExclusionStrats = NULL;
3725  }
3726 
3727  /* Suppress use of the target index while rebuilding it */
3728  SetReindexProcessing(heapId, indexId);
3729 
3730  /* Create a new physical relation for the index */
3731  RelationSetNewRelfilenumber(iRel, persistence);
3732 
3733  /* Initialize the index and rebuild */
3734  /* Note: we do not need to re-establish pkey setting */
3735  index_build(heapRelation, iRel, indexInfo, true, true);
3736 
3737  /* Re-allow use of target index */
3739 
3740  /*
3741  * If the index is marked invalid/not-ready/dead (ie, it's from a failed
3742  * CREATE INDEX CONCURRENTLY, or a DROP INDEX CONCURRENTLY failed midway),
3743  * and we didn't skip a uniqueness check, we can now mark it valid. This
3744  * allows REINDEX to be used to clean up in such cases.
3745  *
3746  * We can also reset indcheckxmin, because we have now done a
3747  * non-concurrent index build, *except* in the case where index_build
3748  * found some still-broken HOT chains. If it did, and we don't have to
3749  * change any of the other flags, we just leave indcheckxmin alone (note
3750  * that index_build won't have changed it, because this is a reindex).
3751  * This is okay and desirable because not updating the tuple leaves the
3752  * index's usability horizon (recorded as the tuple's xmin value) the same
3753  * as it was.
3754  *
3755  * But, if the index was invalid/not-ready/dead and there were broken HOT
3756  * chains, we had better force indcheckxmin true, because the normal
3757  * argument that the HOT chains couldn't conflict with the index is
3758  * suspect for an invalid index. (A conflict is definitely possible if
3759  * the index was dead. It probably shouldn't happen otherwise, but let's
3760  * be conservative.) In this case advancing the usability horizon is
3761  * appropriate.
3762  *
3763  * Another reason for avoiding unnecessary updates here is that while
3764  * reindexing pg_index itself, we must not try to update tuples in it.
3765  * pg_index's indexes should always have these flags in their clean state,
3766  * so that won't happen.
3767  *
3768  * If early pruning/vacuuming is enabled for the heap relation, the
3769  * usability horizon must be advanced to the current transaction on every
3770  * build or rebuild. pg_index is OK in this regard because catalog tables
3771  * are not subject to early cleanup.
3772  */
3773  if (!skipped_constraint)
3774  {
3775  Relation pg_index;
3776  HeapTuple indexTuple;
3777  Form_pg_index indexForm;
3778  bool index_bad;
3779  bool early_pruning_enabled = EarlyPruningEnabled(heapRelation);
3780 
3781  pg_index = table_open(IndexRelationId, RowExclusiveLock);
3782 
3783  indexTuple = SearchSysCacheCopy1(INDEXRELID,
3784  ObjectIdGetDatum(indexId));
3785  if (!HeapTupleIsValid(indexTuple))
3786  elog(ERROR, "cache lookup failed for index %u", indexId);
3787  indexForm = (Form_pg_index) GETSTRUCT(indexTuple);
3788 
3789  index_bad = (!indexForm->indisvalid ||
3790  !indexForm->indisready ||
3791  !indexForm->indislive);
3792  if (index_bad ||
3793  (indexForm->indcheckxmin && !indexInfo->ii_BrokenHotChain) ||
3794  early_pruning_enabled)
3795  {
3796  if (!indexInfo->ii_BrokenHotChain && !early_pruning_enabled)
3797  indexForm->indcheckxmin = false;
3798  else if (index_bad || early_pruning_enabled)
3799  indexForm->indcheckxmin = true;
3800  indexForm->indisvalid = true;
3801  indexForm->indisready = true;
3802  indexForm->indislive = true;
3803  CatalogTupleUpdate(pg_index, &indexTuple->t_self, indexTuple);
3804 
3805  /*
3806  * Invalidate the relcache for the table, so that after we commit
3807  * all sessions will refresh the table's index list. This ensures
3808  * that if anyone misses seeing the pg_index row during this
3809  * update, they'll refresh their list before attempting any update
3810  * on the table.
3811  */
3812  CacheInvalidateRelcache(heapRelation);
3813  }
3814 
3815  table_close(pg_index, RowExclusiveLock);
3816  }
3817 
3818  /* Log what we did */
3819  if ((params->options & REINDEXOPT_VERBOSE) != 0)
3820  ereport(INFO,
3821  (errmsg("index \"%s\" was reindexed",
3822  get_rel_name(indexId)),
3823  errdetail_internal("%s",
3824  pg_rusage_show(&ru0))));
3825 
3826  /* Roll back any GUC changes executed by index functions */
3827  AtEOXact_GUC(false, save_nestlevel);
3828 
3829  /* Restore userid and security context */
3830  SetUserIdAndSecContext(save_userid, save_sec_context);
3831 
3832  /* Close rels, but keep locks */
3833  index_close(iRel, NoLock);
3834  table_close(heapRelation, NoLock);
3835 
3836  if (progress)
3838 }
void pgstat_progress_start_command(ProgressCommandType cmdtype, Oid relid)
void pgstat_progress_update_param(int index, int64 val)
void pgstat_progress_end_command(void)
@ PROGRESS_COMMAND_CREATE_INDEX
bool IsToastNamespace(Oid namespaceId)
Definition: catalog.c:202
int errdetail_internal(const char *fmt,...)
Definition: elog.c:1229
#define INFO
Definition: elog.h:34
static void ResetReindexProcessing(void)
Definition: index.c:4080
static void SetReindexProcessing(Oid heapOid, Oid indexOid)
Definition: index.c:4061
#define REINDEXOPT_MISSING_OK
Definition: index.h:43
#define REINDEXOPT_REPORT_PROGRESS
Definition: index.h:42
#define REINDEXOPT_VERBOSE
Definition: index.h:41
#define ShareLock
Definition: lockdefs.h:40
bool get_index_isvalid(Oid index_oid)
Definition: lsyscache.c:3547
char * get_namespace_name(Oid nspid)
Definition: lsyscache.c:3331
char * get_rel_name(Oid relid)
Definition: lsyscache.c:1910
const char * pg_rusage_show(const PGRUsage *ru0)
Definition: pg_rusage.c:40
void pg_rusage_init(PGRUsage *ru0)
Definition: pg_rusage.c:27
int progress
Definition: pgbench.c:271
#define PROGRESS_CREATEIDX_ACCESS_METHOD_OID
Definition: progress.h:81
#define PROGRESS_CREATEIDX_COMMAND_REINDEX
Definition: progress.h:110
#define PROGRESS_CREATEIDX_INDEX_OID
Definition: progress.h:80
#define PROGRESS_CREATEIDX_COMMAND
Definition: progress.h:79
#define RELATION_IS_OTHER_TEMP(relation)
Definition: rel.h:658
void RelationSetNewRelfilenumber(Relation relation, char persistence)
Definition: relcache.c:3709
void RelationAssumeNewRelfilelocator(Relation relation)
Definition: relcache.c:3908
Oid tablespaceOid
Definition: index.h:36
bits32 options
Definition: index.h:35
Relation try_table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:60
bool CheckRelationTableSpaceMove(Relation rel, Oid newTableSpaceId)
Definition: tablecmds.c:3357
void SetRelationTableSpace(Relation rel, Oid newTableSpaceId, RelFileNumber newRelFilenumber)
Definition: tablecmds.c:3414

References AccessExclusiveLock, AtEOXact_GUC(), BuildIndexInfo(), CacheInvalidateRelcache(), CatalogTupleUpdate(), CheckRelationTableSpaceMove(), CheckTableNotInUse(), CommandCounterIncrement(), EarlyPruningEnabled, elog(), ereport, errcode(), errdetail_internal(), errmsg(), ERROR, get_index_isvalid(), get_namespace_name(), get_rel_name(), GETSTRUCT, GetUserIdAndSecContext(), 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, InvalidOid, IsSystemRelation(), IsToastNamespace(), NewGUCNestLevel(), NoLock, ObjectIdGetDatum(), OidIsValid, ReindexParams::options, pg_rusage_init(), pg_rusage_show(), pgstat_progress_end_command(), pgstat_progress_start_command(), pgstat_progress_update_multi_param(), 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_MISSING_OK, REINDEXOPT_REPORT_PROGRESS, REINDEXOPT_VERBOSE, RELATION_IS_OTHER_TEMP, RelationAssumeNewRelfilelocator(), RelationDropStorage(), RelationGetNamespace, RelationGetRelationName, RelationSetNewRelfilenumber(), ResetReindexProcessing(), RowExclusiveLock, SearchSysCacheCopy1, SECURITY_RESTRICTED_OPERATION, SetReindexProcessing(), SetRelationTableSpace(), SetUserIdAndSecContext(), ShareLock, HeapTupleData::t_self, table_close(), table_open(), ReindexParams::tablespaceOid, TransferPredicateLocksToHeapRelation(), and try_table_open().

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

◆ reindex_relation()

bool reindex_relation ( Oid  relid,
int  flags,
ReindexParams params 
)

Definition at line 3876 of file index.c.

3877 {
3878  Relation rel;
3879  Oid toast_relid;
3880  List *indexIds;
3881  char persistence;
3882  bool result;
3883  ListCell *indexId;
3884  int i;
3885 
3886  /*
3887  * Open and lock the relation. ShareLock is sufficient since we only need
3888  * to prevent schema and data changes in it. The lock level used here
3889  * should match ReindexTable().
3890  */
3891  if ((params->options & REINDEXOPT_MISSING_OK) != 0)
3892  rel = try_table_open(relid, ShareLock);
3893  else
3894  rel = table_open(relid, ShareLock);
3895 
3896  /* if relation is gone, leave */
3897  if (!rel)
3898  return false;
3899 
3900  /*
3901  * Partitioned tables should never get processed here, as they have no
3902  * physical storage.
3903  */
3904  if (rel->rd_rel->relkind == RELKIND_PARTITIONED_TABLE)
3905  elog(ERROR, "cannot reindex partitioned table \"%s.%s\"",
3908 
3909  toast_relid = rel->rd_rel->reltoastrelid;
3910 
3911  /*
3912  * Get the list of index OIDs for this relation. (We trust to the
3913  * relcache to get this with a sequential scan if ignoring system
3914  * indexes.)
3915  */
3916  indexIds = RelationGetIndexList(rel);
3917 
3918  if (flags & REINDEX_REL_SUPPRESS_INDEX_USE)
3919  {
3920  /* Suppress use of all the indexes until they are rebuilt */
3921  SetReindexPending(indexIds);
3922 
3923  /*
3924  * Make the new heap contents visible --- now things might be
3925  * inconsistent!
3926  */
3928  }
3929 
3930  /*
3931  * Compute persistence of indexes: same as that of owning rel, unless
3932  * caller specified otherwise.
3933  */
3935  persistence = RELPERSISTENCE_UNLOGGED;
3936  else if (flags & REINDEX_REL_FORCE_INDEXES_PERMANENT)
3937  persistence = RELPERSISTENCE_PERMANENT;
3938  else
3939  persistence = rel->rd_rel->relpersistence;
3940 
3941  /* Reindex all the indexes. */
3942  i = 1;
3943  foreach(indexId, indexIds)
3944  {
3945  Oid indexOid = lfirst_oid(indexId);
3946  Oid indexNamespaceId = get_rel_namespace(indexOid);
3947 
3948  /*
3949  * Skip any invalid indexes on a TOAST table. These can only be
3950  * duplicate leftovers from a failed REINDEX CONCURRENTLY, and if
3951  * rebuilt it would not be possible to drop them anymore.
3952  */
3953  if (IsToastNamespace(indexNamespaceId) &&
3954  !get_index_isvalid(indexOid))
3955  {
3956  ereport(WARNING,
3957  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
3958  errmsg("cannot reindex invalid index \"%s.%s\" on TOAST table, skipping",
3959  get_namespace_name(indexNamespaceId),
3960  get_rel_name(indexOid))));
3961  continue;
3962  }
3963 
3964  reindex_index(indexOid, !(flags & REINDEX_REL_CHECK_CONSTRAINTS),
3965  persistence, params);
3966 
3968 
3969  /* Index should no longer be in the pending list */
3970  Assert(!ReindexIsProcessingIndex(indexOid));
3971 
3972  /* Set index rebuild count */
3974  i);
3975  i++;
3976  }
3977 
3978  /*
3979  * Close rel, but continue to hold the lock.
3980  */
3981  table_close(rel, NoLock);
3982 
3983  result = (indexIds != NIL);
3984 
3985  /*
3986  * If the relation has a secondary toast rel, reindex that too while we
3987  * still hold the lock on the main table.
3988  */
3989  if ((flags & REINDEX_REL_PROCESS_TOAST) && OidIsValid(toast_relid))
3990  {
3991  /*
3992  * Note that this should fail if the toast relation is missing, so
3993  * reset REINDEXOPT_MISSING_OK. Even if a new tablespace is set for
3994  * the parent relation, the indexes on its toast table are not moved.
3995  * This rule is enforced by setting tablespaceOid to InvalidOid.
3996  */
3997  ReindexParams newparams = *params;
3998 
3999  newparams.options &= ~(REINDEXOPT_MISSING_OK);
4000  newparams.tablespaceOid = InvalidOid;
4001  result |= reindex_relation(toast_relid, flags, &newparams);
4002  }
4003 
4004  return result;
4005 }
#define WARNING
Definition: elog.h:36
bool ReindexIsProcessingIndex(Oid indexOid)
Definition: index.c:4050
void reindex_index(Oid indexId, bool skip_constraint_checks, char persistence, ReindexParams *params)
Definition: index.c:3562
bool reindex_relation(Oid relid, int flags, ReindexParams *params)
Definition: index.c:3876
static void SetReindexPending(List *indexes)
Definition: index.c:4094
#define REINDEX_REL_PROCESS_TOAST
Definition: index.h:155
#define REINDEX_REL_FORCE_INDEXES_UNLOGGED
Definition: index.h:158
#define REINDEX_REL_SUPPRESS_INDEX_USE
Definition: index.h:156
#define REINDEX_REL_FORCE_INDEXES_PERMANENT
Definition: index.h:159
#define REINDEX_REL_CHECK_CONSTRAINTS
Definition: index.h:157
Oid get_rel_namespace(Oid relid)
Definition: lsyscache.c:1934
#define PROGRESS_CLUSTER_INDEX_REBUILD_COUNT
Definition: progress.h:62
List * RelationGetIndexList(Relation relation)
Definition: relcache.c:4739

References Assert(), CommandCounterIncrement(), elog(), ereport, errcode(), errmsg(), ERROR, get_index_isvalid(), get_namespace_name(), get_rel_name(), get_rel_namespace(), i, InvalidOid, IsToastNamespace(), lfirst_oid, NIL, NoLock, OidIsValid, ReindexParams::options, 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, ReindexIsProcessingIndex(), REINDEXOPT_MISSING_OK, RelationGetIndexList(), RelationGetNamespace, RelationGetRelationName, SetReindexPending(), ShareLock, table_close(), table_open(), ReindexParams::tablespaceOid, try_table_open(), and WARNING.

Referenced by ExecuteTruncateGuts(), finish_heap_swap(), ReindexMultipleInternal(), and ReindexTable().

◆ ReindexIsProcessingHeap()

bool ReindexIsProcessingHeap ( Oid  heapOid)

Definition at line 4029 of file index.c.

4030 {
4031  return heapOid == currentlyReindexedHeap;
4032 }
static Oid currentlyReindexedHeap
Definition: index.c:4019

References currentlyReindexedHeap.

Referenced by index_update_stats().

◆ ReindexIsProcessingIndex()

bool ReindexIsProcessingIndex ( Oid  indexOid)

Definition at line 4050 of file index.c.

4051 {
4052  return indexOid == currentlyReindexedIndex ||
4054 }
static Oid currentlyReindexedIndex
Definition: index.c:4020
bool list_member_oid(const List *list, Oid datum)
Definition: list.c:721

References currentlyReindexedIndex, list_member_oid(), and pendingReindexedIndexes.

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

◆ ResetReindexState()

void ResetReindexState ( int  nestLevel)

Definition at line 4123 of file index.c.

4124 {
4125  /*
4126  * Because reindexing is not re-entrant, we don't need to cope with nested
4127  * reindexing states. We just need to avoid messing up the outer-level
4128  * state in case a subtransaction fails within a REINDEX. So checking the
4129  * current nest level against that of the reindex operation is sufficient.
4130  */
4131  if (reindexingNestLevel >= nestLevel)
4132  {
4135 
4136  /*
4137  * We needn't try to release the contents of pendingReindexedIndexes;
4138  * that list should be in a transaction-lifespan context, so it will
4139  * go away automatically.
4140  */
4142 
4143  reindexingNestLevel = 0;
4144  }
4145 }
static int reindexingNestLevel
Definition: index.c:4022

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

Referenced by AbortSubTransaction(), and AbortTransaction().

◆ RestoreReindexState()

void RestoreReindexState ( void *  reindexstate)

Definition at line 4181 of file index.c.

4182 {
4183  SerializedReindexState *sistate = (SerializedReindexState *) reindexstate;
4184  int c = 0;
4185  MemoryContext oldcontext;
4186 
4189 
4192  for (c = 0; c < sistate->numPendingReindexedIndexes; ++c)
4195  sistate->pendingReindexedIndexes[c]);
4196  MemoryContextSwitchTo(oldcontext);
4197 
4198  /* Note the worker has its own transaction nesting level */
4200 }
MemoryContext TopMemoryContext
Definition: mcxt.c:141
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:138
char * c
Oid currentlyReindexedHeap
Definition: index.c:99
Oid currentlyReindexedIndex
Definition: index.c:100
int numPendingReindexedIndexes
Definition: index.c:101
Oid pendingReindexedIndexes[FLEXIBLE_ARRAY_MEMBER]
Definition: index.c:102
int GetCurrentTransactionNestLevel(void)
Definition: xact.c:914

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

Referenced by ParallelWorkerMain().

◆ SerializeReindexState()

◆ validate_index()

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

Definition at line 3309 of file index.c.

3310 {
3311  Relation heapRelation,
3312  indexRelation;
3313  IndexInfo *indexInfo;
3314  IndexVacuumInfo ivinfo;
3316  Oid save_userid;
3317  int save_sec_context;
3318  int save_nestlevel;
3319 
3320  {
3321  const int progress_index[] = {
3327  };
3328  const int64 progress_vals[] = {
3330  0, 0, 0, 0
3331  };
3332 
3333  pgstat_progress_update_multi_param(5, progress_index, progress_vals);
3334  }
3335 
3336  /* Open and lock the parent heap relation */
3337  heapRelation = table_open(heapId, ShareUpdateExclusiveLock);
3338 
3339  /*
3340  * Switch to the table owner's userid, so that any index functions are run
3341  * as that user. Also lock down security-restricted operations and
3342  * arrange to make GUC variable changes local to this command.
3343  */
3344  GetUserIdAndSecContext(&save_userid, &save_sec_context);
3345  SetUserIdAndSecContext(heapRelation->rd_rel->relowner,
3346  save_sec_context | SECURITY_RESTRICTED_OPERATION);
3347  save_nestlevel = NewGUCNestLevel();
3348 
3349  indexRelation = index_open(indexId, RowExclusiveLock);
3350 
3351  /*
3352  * Fetch info needed for index_insert. (You might think this should be
3353  * passed in from DefineIndex, but its copy is long gone due to having
3354  * been built in a previous transaction.)
3355  */
3356  indexInfo = BuildIndexInfo(indexRelation);
3357 
3358  /* mark build is concurrent just for consistency */
3359  indexInfo->ii_Concurrent = true;
3360 
3361  /*
3362  * Scan the index and gather up all the TIDs into a tuplesort object.
3363  */
3364  ivinfo.index = indexRelation;
3365  ivinfo.analyze_only = false;
3366  ivinfo.report_progress = true;
3367  ivinfo.estimated_count = true;
3368  ivinfo.message_level = DEBUG2;
3369  ivinfo.num_heap_tuples = heapRelation->rd_rel->reltuples;
3370  ivinfo.strategy = NULL;
3371 
3372  /*
3373  * Encode TIDs as int8 values for the sort, rather than directly sorting
3374  * item pointers. This can be significantly faster, primarily because TID
3375  * is a pass-by-reference type on all platforms, whereas int8 is
3376  * pass-by-value on most platforms.
3377  */
3378  state.tuplesort = tuplesort_begin_datum(INT8OID, Int8LessOperator,
3379  InvalidOid, false,
3381  NULL, TUPLESORT_NONE);
3382  state.htups = state.itups = state.tups_inserted = 0;
3383 
3384  /* ambulkdelete updates progress metrics */
3385  (void) index_bulk_delete(&ivinfo, NULL,
3386  validate_index_callback, (void *) &state);
3387 
3388  /* Execute the sort */
3389  {
3390  const int progress_index[] = {
3394  };
3395  const int64 progress_vals[] = {
3397  0, 0
3398  };
3399 
3400  pgstat_progress_update_multi_param(3, progress_index, progress_vals);
3401  }
3402  tuplesort_performsort(state.tuplesort);
3403 
3404  /*
3405  * Now scan the heap and "merge" it with the index
3406  */
3409  table_index_validate_scan(heapRelation,
3410  indexRelation,
3411  indexInfo,
3412  snapshot,
3413  &state);
3414 
3415  /* Done with tuplesort object */
3416  tuplesort_end(state.tuplesort);
3417 
3418  elog(DEBUG2,
3419  "validate_index found %.0f heap tuples, %.0f index tuples; inserted %.0f missing tuples",
3420  state.htups, state.itups, state.tups_inserted);
3421 
3422  /* Roll back any GUC changes executed by index functions */
3423  AtEOXact_GUC(false, save_nestlevel);
3424 
3425  /* Restore userid and security context */
3426  SetUserIdAndSecContext(save_userid, save_sec_context);
3427 
3428  /* Close rels, but keep locks */
3429  index_close(indexRelation, NoLock);
3430  table_close(heapRelation, NoLock);
3431 }
#define DEBUG2
Definition: elog.h:29
int maintenance_work_mem
Definition: globals.c:127
static bool validate_index_callback(ItemPointer itemptr, void *opaque)
Definition: index.c:3437
IndexBulkDeleteResult * index_bulk_delete(IndexVacuumInfo *info, IndexBulkDeleteResult *istat, IndexBulkDeleteCallback callback, void *callback_state)
Definition: indexam.c:699
#define PROGRESS_CREATEIDX_PHASE_VALIDATE_TABLESCAN
Definition: progress.h:96
#define PROGRESS_CREATEIDX_PHASE_VALIDATE_SORT
Definition: progress.h:95
#define PROGRESS_CREATEIDX_PHASE_VALIDATE_IDXSCAN
Definition: progress.h:94
Relation index
Definition: genam.h:46
double num_heap_tuples
Definition: genam.h:51
bool analyze_only
Definition: genam.h:47
BufferAccessStrategy strategy
Definition: genam.h:52
bool report_progress
Definition: genam.h:48
int message_level
Definition: genam.h:50
bool estimated_count
Definition: genam.h:49
Definition: regguts.h:318
static void table_index_validate_scan(Relation table_rel, Relation index_rel, struct IndexInfo *index_info, Snapshot snapshot, struct ValidateIndexState *state)
Definition: tableam.h:1836
void tuplesort_performsort(Tuplesortstate *state)
Definition: tuplesort.c:1385
void tuplesort_end(Tuplesortstate *state)
Definition: tuplesort.c:972
#define TUPLESORT_NONE
Definition: tuplesort.h:92
Tuplesortstate * tuplesort_begin_datum(Oid datumType, Oid sortOperator, Oid sortCollation, bool nullsFirstFlag, int workMem, SortCoordinate coordinate, int sortopt)

References IndexVacuumInfo::analyze_only, AtEOXact_GUC(), BuildIndexInfo(), DEBUG2, elog(), IndexVacuumInfo::estimated_count, GetUserIdAndSecContext(), IndexInfo::ii_Concurrent, IndexVacuumInfo::index, index_bulk_delete(), index_close(), index_open(), InvalidOid, 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(), tuplesort_begin_datum(), tuplesort_end(), TUPLESORT_NONE, tuplesort_performsort(), and validate_index_callback().

Referenced by DefineIndex(), and ReindexRelationConcurrently().