Age Owner TLA Line data Source code
1 : /*-------------------------------------------------------------------------
2 : *
3 : * index.c
4 : * code to create and destroy POSTGRES index relations
5 : *
6 : * Portions Copyright (c) 1996-2023, PostgreSQL Global Development Group
7 : * Portions Copyright (c) 1994, Regents of the University of California
8 : *
9 : *
10 : * IDENTIFICATION
11 : * src/backend/catalog/index.c
12 : *
13 : *
14 : * INTERFACE ROUTINES
15 : * index_create() - Create a cataloged index relation
16 : * index_drop() - Removes index relation from catalogs
17 : * BuildIndexInfo() - Prepare to insert index tuples
18 : * FormIndexDatum() - Construct datum vector for one index tuple
19 : *
20 : *-------------------------------------------------------------------------
21 : */
22 : #include "postgres.h"
23 :
24 : #include <unistd.h>
25 :
26 : #include "access/amapi.h"
27 : #include "access/heapam.h"
28 : #include "access/multixact.h"
29 : #include "access/reloptions.h"
30 : #include "access/relscan.h"
31 : #include "access/sysattr.h"
32 : #include "access/tableam.h"
33 : #include "access/toast_compression.h"
34 : #include "access/transam.h"
35 : #include "access/visibilitymap.h"
36 : #include "access/xact.h"
37 : #include "bootstrap/bootstrap.h"
38 : #include "catalog/binary_upgrade.h"
39 : #include "catalog/catalog.h"
40 : #include "catalog/dependency.h"
41 : #include "catalog/heap.h"
42 : #include "catalog/index.h"
43 : #include "catalog/objectaccess.h"
44 : #include "catalog/partition.h"
45 : #include "catalog/pg_am.h"
46 : #include "catalog/pg_collation.h"
47 : #include "catalog/pg_constraint.h"
48 : #include "catalog/pg_depend.h"
49 : #include "catalog/pg_description.h"
50 : #include "catalog/pg_inherits.h"
51 : #include "catalog/pg_opclass.h"
52 : #include "catalog/pg_operator.h"
53 : #include "catalog/pg_tablespace.h"
54 : #include "catalog/pg_trigger.h"
55 : #include "catalog/pg_type.h"
56 : #include "catalog/storage.h"
57 : #include "commands/event_trigger.h"
58 : #include "commands/progress.h"
59 : #include "commands/tablecmds.h"
60 : #include "commands/tablespace.h"
61 : #include "commands/trigger.h"
62 : #include "executor/executor.h"
63 : #include "miscadmin.h"
64 : #include "nodes/makefuncs.h"
65 : #include "nodes/nodeFuncs.h"
66 : #include "optimizer/optimizer.h"
67 : #include "parser/parser.h"
68 : #include "pgstat.h"
69 : #include "rewrite/rewriteManip.h"
70 : #include "storage/bufmgr.h"
71 : #include "storage/lmgr.h"
72 : #include "storage/predicate.h"
73 : #include "storage/procarray.h"
74 : #include "storage/smgr.h"
75 : #include "utils/builtins.h"
76 : #include "utils/datum.h"
77 : #include "utils/fmgroids.h"
78 : #include "utils/guc.h"
79 : #include "utils/inval.h"
80 : #include "utils/lsyscache.h"
81 : #include "utils/memutils.h"
82 : #include "utils/pg_rusage.h"
83 : #include "utils/rel.h"
84 : #include "utils/snapmgr.h"
85 : #include "utils/syscache.h"
86 : #include "utils/tuplesort.h"
87 :
88 : /* Potentially set by pg_upgrade_support functions */
89 : Oid binary_upgrade_next_index_pg_class_oid = InvalidOid;
90 : RelFileNumber binary_upgrade_next_index_pg_class_relfilenumber =
91 : InvalidRelFileNumber;
92 :
93 : /*
94 : * Pointer-free representation of variables used when reindexing system
95 : * catalogs; we use this to propagate those values to parallel workers.
96 : */
97 : typedef struct
98 : {
99 : Oid currentlyReindexedHeap;
100 : Oid currentlyReindexedIndex;
101 : int numPendingReindexedIndexes;
102 : Oid pendingReindexedIndexes[FLEXIBLE_ARRAY_MEMBER];
103 : } SerializedReindexState;
104 :
105 : /* non-export function prototypes */
106 : static bool relationHasPrimaryKey(Relation rel);
107 : static TupleDesc ConstructTupleDescriptor(Relation heapRelation,
108 : IndexInfo *indexInfo,
109 : List *indexColNames,
110 : Oid accessMethodObjectId,
111 : Oid *collationObjectId,
112 : Oid *classObjectId);
113 : static void InitializeAttributeOids(Relation indexRelation,
114 : int numatts, Oid indexoid);
115 : static void AppendAttributeTuples(Relation indexRelation, Datum *attopts);
116 : static void UpdateIndexRelation(Oid indexoid, Oid heapoid,
117 : Oid parentIndexId,
118 : IndexInfo *indexInfo,
119 : Oid *collationOids,
120 : Oid *classOids,
121 : int16 *coloptions,
122 : bool primary,
123 : bool isexclusion,
124 : bool immediate,
125 : bool isvalid,
126 : bool isready);
127 : static void index_update_stats(Relation rel,
128 : bool hasindex,
129 : double reltuples);
130 : static void IndexCheckExclusion(Relation heapRelation,
131 : Relation indexRelation,
132 : IndexInfo *indexInfo);
133 : static bool validate_index_callback(ItemPointer itemptr, void *opaque);
134 : static bool ReindexIsCurrentlyProcessingIndex(Oid indexOid);
135 : static void SetReindexProcessing(Oid heapOid, Oid indexOid);
136 : static void ResetReindexProcessing(void);
137 : static void SetReindexPending(List *indexes);
138 : static void RemoveReindexPending(Oid indexOid);
139 :
140 :
141 : /*
142 : * relationHasPrimaryKey
143 : * See whether an existing relation has a primary key.
144 : *
145 : * Caller must have suitable lock on the relation.
146 : *
147 : * Note: we intentionally do not check indisvalid here; that's because this
148 : * is used to enforce the rule that there can be only one indisprimary index,
149 : * and we want that to be true even if said index is invalid.
150 : */
151 : static bool
4457 tgl 152 GIC 19717 : relationHasPrimaryKey(Relation rel)
4457 tgl 153 ECB : {
4457 tgl 154 GIC 19717 : bool result = false;
4457 tgl 155 ECB : List *indexoidlist;
156 : ListCell *indexoidscan;
157 :
158 : /*
159 : * Get the list of index OIDs for the table from the relcache, and look up
160 : * each one in the pg_index syscache until we find one marked primary key
161 : * (hopefully there isn't more than one such).
162 : */
4457 tgl 163 GIC 19717 : indexoidlist = RelationGetIndexList(rel);
4457 tgl 164 ECB :
4457 tgl 165 GIC 56202 : foreach(indexoidscan, indexoidlist)
4457 tgl 166 ECB : {
4457 tgl 167 GIC 36503 : Oid indexoid = lfirst_oid(indexoidscan);
4457 tgl 168 ECB : HeapTuple indexTuple;
169 :
4457 tgl 170 GIC 36503 : indexTuple = SearchSysCache1(INDEXRELID, ObjectIdGetDatum(indexoid));
2118 tgl 171 CBC 36503 : if (!HeapTupleIsValid(indexTuple)) /* should not happen */
4457 tgl 172 LBC 0 : elog(ERROR, "cache lookup failed for index %u", indexoid);
4457 tgl 173 GBC 36503 : result = ((Form_pg_index) GETSTRUCT(indexTuple))->indisprimary;
4457 tgl 174 CBC 36503 : ReleaseSysCache(indexTuple);
175 36503 : if (result)
176 18 : break;
4457 tgl 177 ECB : }
178 :
4457 tgl 179 GIC 19717 : list_free(indexoidlist);
4457 tgl 180 ECB :
4457 tgl 181 GIC 19717 : return result;
4457 tgl 182 ECB : }
183 :
184 : /*
185 : * index_check_primary_key
186 : * Apply special checks needed before creating a PRIMARY KEY index
187 : *
188 : * This processing used to be in DefineIndex(), but has been split out
189 : * so that it can be applied during ALTER TABLE ADD PRIMARY KEY USING INDEX.
190 : *
191 : * We check for a pre-existing primary key, and that all columns of the index
192 : * are simple column references (not expressions), and that all those
193 : * columns are marked NOT NULL. If not, fail.
194 : *
195 : * We used to automatically change unmarked columns to NOT NULL here by doing
196 : * our own local ALTER TABLE command. But that doesn't work well if we're
197 : * executing one subcommand of an ALTER TABLE: the operations may not get
198 : * performed in the right order overall. Now we expect that the parser
199 : * inserted any required ALTER TABLE SET NOT NULL operations before trying
200 : * to create a primary-key index.
201 : *
202 : * Caller had better have at least ShareLock on the table, else the not-null
203 : * checking isn't trustworthy.
204 : */
205 : void
4457 tgl 206 GIC 22569 : index_check_primary_key(Relation heapRel,
4457 tgl 207 ECB : IndexInfo *indexInfo,
208 : bool is_alter_table,
209 : IndexStmt *stmt)
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 : */
1648 alvherre 219 GIC 42286 : if ((is_alter_table || heapRel->rd_rel->relispartition) &&
4457 tgl 220 CBC 19717 : relationHasPrimaryKey(heapRel))
4457 tgl 221 ECB : {
4457 tgl 222 GIC 18 : ereport(ERROR,
4457 tgl 223 ECB : (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 : */
44 dgustafsson 234 GNC 22551 : if (indexInfo->ii_NullsNotDistinct)
235 : {
236 3 : 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 : */
1828 teodor 246 GIC 51532 : for (i = 0; i < indexInfo->ii_NumIndexKeyAttrs; i++)
247 : {
1823 teodor 248 CBC 28984 : AttrNumber attnum = indexInfo->ii_IndexAttrNumbers[i];
249 : HeapTuple atttuple;
4457 tgl 250 ECB : Form_pg_attribute attform;
251 :
4457 tgl 252 GIC 28984 : if (attnum == 0)
4457 tgl 253 UIC 0 : 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 */
4457 tgl 258 GIC 28984 : if (attnum < 0)
4457 tgl 259 UIC 0 : continue;
4457 tgl 260 ECB :
4457 tgl 261 GIC 28984 : atttuple = SearchSysCache2(ATTNUM,
2118 tgl 262 ECB : ObjectIdGetDatum(RelationGetRelid(heapRel)),
263 : Int16GetDatum(attnum));
4457 tgl 264 GIC 28984 : if (!HeapTupleIsValid(atttuple))
4457 tgl 265 UIC 0 : elog(ERROR, "cache lookup failed for attribute %d of relation %u",
4457 tgl 266 ECB : attnum, RelationGetRelid(heapRel));
4457 tgl 267 GBC 28984 : attform = (Form_pg_attribute) GETSTRUCT(atttuple);
268 :
4457 tgl 269 GIC 28984 : if (!attform->attnotnull)
1447 tgl 270 UIC 0 : ereport(ERROR,
271 : (errcode(ERRCODE_INVALID_TABLE_DEFINITION),
1447 tgl 272 ECB : errmsg("primary key column \"%s\" is not marked NOT NULL",
1447 tgl 273 EUB : NameStr(attform->attname))));
274 :
4457 tgl 275 CBC 28984 : ReleaseSysCache(atttuple);
276 : }
4457 tgl 277 GIC 22548 : }
4457 tgl 278 ECB :
7256 tgl 279 EUB : /*
280 : * ConstructTupleDescriptor
8304 tgl 281 ECB : *
282 : * Build an index tuple descriptor for a new index
9770 scrappy 283 : */
9344 bruce 284 EUB : static TupleDesc
8110 tgl 285 GIC 63460 : ConstructTupleDescriptor(Relation heapRelation,
286 : IndexInfo *indexInfo,
287 : List *indexColNames,
288 : Oid accessMethodObjectId,
4443 peter_e 289 ECB : Oid *collationObjectId,
290 : Oid *classObjectId)
9345 bruce 291 : {
7256 tgl 292 GIC 63460 : int numatts = indexInfo->ii_NumIndexAttrs;
1823 teodor 293 63460 : int numkeyatts = indexInfo->ii_NumIndexKeyAttrs;
4855 tgl 294 63460 : ListCell *colnames_item = list_head(indexColNames);
6892 neilc 295 63460 : ListCell *indexpr_item = list_head(indexInfo->ii_Expressions);
296 : IndexAmRoutine *amroutine;
297 : TupleDesc heapTupDesc;
298 : TupleDesc indexTupDesc;
8304 tgl 299 ECB : int natts; /* #atts in heap rel --- for error checks */
300 : int i;
301 :
302 : /* We need access to the index AM's API struct */
2430 tgl 303 GIC 63460 : amroutine = GetIndexAmRoutineByAmId(accessMethodObjectId, false);
304 :
305 : /* ... and to the table's tuple descriptor */
8304 tgl 306 CBC 63460 : heapTupDesc = RelationGetDescr(heapRelation);
307 63460 : natts = RelationGetForm(heapRelation)->relnatts;
8304 tgl 308 ECB :
8053 bruce 309 : /*
310 : * allocate the new tuple descriptor
311 : */
1601 andres 312 GIC 63460 : indexTupDesc = CreateTemplateTupleDesc(numatts);
313 :
314 : /*
315 : * Fill in the pg_attribute row.
316 : */
8304 tgl 317 CBC 171452 : for (i = 0; i < numatts; i++)
318 : {
1823 teodor 319 GIC 107995 : AttrNumber atnum = indexInfo->ii_IndexAttrNumbers[i];
2058 andres 320 CBC 107995 : Form_pg_attribute to = TupleDescAttr(indexTupDesc, i);
7900 tgl 321 ECB : HeapTuple tuple;
322 : Form_pg_type typeTup;
323 : Form_pg_opclass opclassTup;
324 : Oid keyType;
325 :
1686 peter_e 326 CBC 107995 : MemSet(to, 0, ATTRIBUTE_FIXED_PART_SIZE);
1686 peter_e 327 GIC 107995 : to->attnum = i + 1;
328 107995 : to->attstattarget = -1;
329 107995 : to->attcacheoff = -1;
330 107995 : to->attislocal = true;
1686 peter_e 331 CBC 107995 : to->attcollation = (i < numkeyatts) ?
1686 peter_e 332 GIC 107995 : collationObjectId[i] : InvalidOid;
1686 peter_e 333 ECB :
1209 tgl 334 : /*
335 : * Set the attribute name as specified by caller.
336 : */
1209 tgl 337 GIC 107995 : if (colnames_item == NULL) /* shouldn't happen */
1209 tgl 338 UIC 0 : elog(ERROR, "too few entries in colnames list");
1209 tgl 339 GIC 107995 : namestrcpy(&to->attname, (const char *) lfirst(colnames_item));
1209 tgl 340 CBC 107995 : colnames_item = lnext(indexColNames, colnames_item);
1209 tgl 341 ECB :
1686 peter_e 342 : /*
343 : * For simple index columns, we copy some pg_attribute fields from the
344 : * parent relation. For expressions we have to look at the expression
345 : * result.
346 : */
7256 tgl 347 GIC 107995 : if (atnum != 0)
348 : {
349 : /* Simple index column */
350 : const FormData_pg_attribute *from;
7256 tgl 351 ECB :
1545 tgl 352 GBC 107624 : Assert(atnum > 0); /* should've been caught above */
1601 andres 353 ECB :
1601 andres 354 CBC 107624 : if (atnum > natts) /* safety check */
1601 andres 355 UIC 0 : elog(ERROR, "invalid column number %d", atnum);
1601 andres 356 GIC 107624 : from = TupleDescAttr(heapTupDesc,
357 : AttrNumberGetAttrOffset(atnum));
358 :
1686 peter_e 359 107624 : to->atttypid = from->atttypid;
360 107624 : to->attlen = from->attlen;
1686 peter_e 361 CBC 107624 : to->attndims = from->attndims;
1686 peter_e 362 GIC 107624 : to->atttypmod = from->atttypmod;
363 107624 : to->attbyval = from->attbyval;
364 107624 : to->attalign = from->attalign;
686 tgl 365 107624 : to->attstorage = from->attstorage;
751 rhaas 366 CBC 107624 : to->attcompression = from->attcompression;
367 : }
9345 bruce 368 ECB : else
9345 bruce 369 EUB : {
7256 tgl 370 ECB : /* Expressional index */
371 : Node *indexkey;
372 :
6892 neilc 373 CBC 371 : if (indexpr_item == NULL) /* shouldn't happen */
7256 tgl 374 LBC 0 : elog(ERROR, "too few entries in indexprs list");
6892 neilc 375 CBC 371 : indexkey = (Node *) lfirst(indexpr_item);
1364 tgl 376 371 : indexpr_item = lnext(indexInfo->ii_Expressions, indexpr_item);
7256 tgl 377 ECB :
378 : /*
6385 bruce 379 : * Lookup the expression type in pg_type for the type length etc.
7256 tgl 380 : */
7256 tgl 381 GIC 371 : keyType = exprType(indexkey);
4802 rhaas 382 371 : tuple = SearchSysCache1(TYPEOID, ObjectIdGetDatum(keyType));
7256 tgl 383 371 : if (!HeapTupleIsValid(tuple))
7202 tgl 384 UIC 0 : elog(ERROR, "cache lookup failed for type %u", keyType);
7256 tgl 385 GIC 371 : typeTup = (Form_pg_type) GETSTRUCT(tuple);
386 :
7256 tgl 387 ECB : /*
1686 peter_e 388 EUB : * Assign some of the attributes values. Leave the rest.
7256 tgl 389 ECB : */
7256 tgl 390 CBC 371 : to->atttypid = keyType;
7256 tgl 391 GIC 371 : to->attlen = typeTup->typlen;
686 392 371 : to->atttypmod = exprTypmod(indexkey);
7256 393 371 : to->attbyval = typeTup->typbyval;
394 371 : to->attalign = typeTup->typalign;
686 tgl 395 CBC 371 : to->attstorage = typeTup->typstorage;
4419 peter_e 396 ECB :
745 rhaas 397 : /*
745 rhaas 398 EUB : * For expression columns, set attcompression invalid, since
745 rhaas 399 ECB : * there's no table column from which to copy the value. Whenever
400 : * we actually need to compress a value, we'll use whatever the
401 : * current value of default_toast_compression is at that point in
402 : * time.
403 : */
745 rhaas 404 CBC 371 : to->attcompression = InvalidCompressionMethod;
745 rhaas 405 ECB :
7256 tgl 406 CBC 371 : ReleaseSysCache(tuple);
5290 tgl 407 ECB :
408 : /*
409 : * Make sure the expression yields a type that's safe to store in
410 : * an index. We need this defense because we have index opclasses
411 : * for pseudo-types such as "record", and the actually stored type
412 : * had better be safe; eg, a named composite type is okay, an
413 : * anonymous record type is not. The test is the same as for
414 : * whether a table column is of a safe type (which is why we
415 : * needn't check for the non-expression case).
416 : */
4395 tgl 417 GIC 371 : CheckAttributeType(NameStr(to->attname),
4395 tgl 418 ECB : to->atttypid, to->attcollation,
419 : NIL, 0);
7256 420 : }
421 :
422 : /*
423 : * We do not yet have the correct relation OID for the index, so just
424 : * set it invalid for now. InitializeAttributeOids() will fix it
425 : * later.
426 : */
8110 tgl 427 GIC 107992 : to->attrelid = InvalidOid;
428 :
429 : /*
430 : * Check the opclass and index AM to see if either provides a keytype
1828 teodor 431 ECB : * (overriding the attribute type). Opclass (if exists) takes
432 : * precedence.
433 : */
1828 teodor 434 GIC 107992 : keyType = amroutine->amkeytype;
435 :
436 107992 : if (i < indexInfo->ii_NumIndexKeyAttrs)
437 : {
438 107678 : tuple = SearchSysCache1(CLAOID, ObjectIdGetDatum(classObjectId[i]));
439 107678 : if (!HeapTupleIsValid(tuple))
1828 teodor 440 UIC 0 : elog(ERROR, "cache lookup failed for opclass %u",
1828 teodor 441 ECB : classObjectId[i]);
1828 teodor 442 GIC 107678 : opclassTup = (Form_pg_opclass) GETSTRUCT(tuple);
443 107678 : if (OidIsValid(opclassTup->opckeytype))
444 10613 : keyType = opclassTup->opckeytype;
445 :
446 : /*
447 : * If keytype is specified as ANYELEMENT, and opcintype is
1828 teodor 448 ECB : * ANYARRAY, then the attribute type must be an array (else it'd
449 : * not have matched this opclass); use its element type.
1116 tgl 450 : *
451 : * We could also allow ANYCOMPATIBLE/ANYCOMPATIBLEARRAY here, but
452 : * there seems no need to do so; there's no reason to declare an
453 : * opclass as taking ANYCOMPATIBLEARRAY rather than ANYARRAY.
1828 teodor 454 EUB : */
1828 teodor 455 GIC 107678 : if (keyType == ANYELEMENTOID && opclassTup->opcintype == ANYARRAYOID)
1828 teodor 456 ECB : {
1828 teodor 457 CBC 103 : keyType = get_base_element_type(to->atttypid);
458 103 : if (!OidIsValid(keyType))
1828 teodor 459 UIC 0 : elog(ERROR, "could not get element type of array type %u",
460 : to->atttypid);
461 : }
462 :
1828 teodor 463 GIC 107678 : ReleaseSysCache(tuple);
464 : }
465 :
466 : /*
467 : * If a key type different from the heap value is specified, update
468 : * the type-related fields in the index tupdesc.
2386 tgl 469 ECB : */
7900 tgl 470 GIC 107992 : if (OidIsValid(keyType) && keyType != to->atttypid)
7900 tgl 471 ECB : {
4802 rhaas 472 CBC 10212 : tuple = SearchSysCache1(TYPEOID, ObjectIdGetDatum(keyType));
7900 tgl 473 GBC 10212 : if (!HeapTupleIsValid(tuple))
7202 tgl 474 UIC 0 : elog(ERROR, "cache lookup failed for type %u", keyType);
7900 tgl 475 GIC 10212 : typeTup = (Form_pg_type) GETSTRUCT(tuple);
476 :
7836 bruce 477 CBC 10212 : to->atttypid = keyType;
7836 bruce 478 GIC 10212 : to->atttypmod = -1;
479 10212 : to->attlen = typeTup->typlen;
480 10212 : to->attbyval = typeTup->typbyval;
481 10212 : to->attalign = typeTup->typalign;
7900 tgl 482 10212 : to->attstorage = typeTup->typstorage;
483 : /* As above, use the default compression method in this case */
686 tgl 484 CBC 10212 : to->attcompression = InvalidCompressionMethod;
485 :
7900 486 10212 : ReleaseSysCache(tuple);
7900 tgl 487 ECB : }
9345 bruce 488 EUB : }
9345 bruce 489 ECB :
2639 tgl 490 GIC 63457 : pfree(amroutine);
5319 tgl 491 ECB :
9345 bruce 492 CBC 63457 : return indexTupDesc;
9345 bruce 493 ECB : }
494 :
495 : /* ----------------------------------------------------------------
496 : * InitializeAttributeOids
497 : * ----------------------------------------------------------------
498 : */
499 : static void
9345 bruce 500 CBC 63457 : InitializeAttributeOids(Relation indexRelation,
501 : int numatts,
502 : Oid indexoid)
503 : {
9344 bruce 504 ECB : TupleDesc tupleDescriptor;
505 : int i;
9345 506 :
8986 bruce 507 GIC 63457 : tupleDescriptor = RelationGetDescr(indexRelation);
508 :
9345 509 171446 : for (i = 0; i < numatts; i += 1)
2058 andres 510 107989 : TupleDescAttr(tupleDescriptor, i)->attrelid = indexoid;
9345 bruce 511 63457 : }
512 :
513 : /* ----------------------------------------------------------------
9345 bruce 514 ECB : * AppendAttributeTuples
515 : * ----------------------------------------------------------------
516 : */
517 : static void
982 michael 518 GIC 63457 : AppendAttributeTuples(Relation indexRelation, Datum *attopts)
519 : {
520 : Relation pg_attribute;
7552 tgl 521 ECB : CatalogIndexState indstate;
522 : TupleDesc indexTupDesc;
9345 bruce 523 :
8053 524 : /*
7552 tgl 525 : * open the attribute relation and its indexes
526 : */
1539 andres 527 GIC 63457 : pg_attribute = table_open(AttributeRelationId, RowExclusiveLock);
528 :
7552 tgl 529 63457 : indstate = CatalogOpenIndexes(pg_attribute);
530 :
531 : /*
7971 tgl 532 ECB : * insert data from new index's tupdesc into pg_attribute
533 : */
8986 bruce 534 GIC 63457 : indexTupDesc = RelationGetDescr(indexRelation);
535 :
982 michael 536 63457 : InsertPgAttributeTuples(pg_attribute, indexTupDesc, InvalidOid, attopts, indstate);
537 :
7552 tgl 538 63457 : CatalogCloseIndexes(indstate);
539 :
1539 andres 540 63457 : table_close(pg_attribute, RowExclusiveLock);
9345 bruce 541 CBC 63457 : }
542 :
9345 bruce 543 ECB : /* ----------------------------------------------------------------
544 : * UpdateIndexRelation
545 : *
546 : * Construct and insert a new entry in the pg_index catalog
547 : * ----------------------------------------------------------------
548 : */
549 : static void
9345 bruce 550 CBC 63457 : UpdateIndexRelation(Oid indexoid,
551 : Oid heapoid,
1392 michael 552 ECB : Oid parentIndexId,
553 : IndexInfo *indexInfo,
4443 peter_e 554 : Oid *collationOids,
8986 bruce 555 : Oid *classOids,
556 : int16 *coloptions,
557 : bool primary,
558 : bool isexclusion,
559 : bool immediate,
560 : bool isvalid,
561 : bool isready)
562 : {
563 : int2vector *indkey;
4443 peter_e 564 : oidvector *indcollation;
565 : oidvector *indclass;
566 : int2vector *indoption;
567 : Datum exprsDatum;
568 : Datum predDatum;
569 : Datum values[Natts_pg_index];
267 peter 570 GNC 63457 : bool nulls[Natts_pg_index] = {0};
571 : Relation pg_index;
572 : HeapTuple tuple;
573 : int i;
574 :
575 : /*
576 : * Copy the index key, opclass, and indoption info into arrays (should we
577 : * make the caller pass them like this to start with?)
578 : */
6585 tgl 579 GIC 63457 : indkey = buildint2vector(NULL, indexInfo->ii_NumIndexAttrs);
7499 580 171446 : for (i = 0; i < indexInfo->ii_NumIndexAttrs; i++)
1823 teodor 581 107989 : indkey->values[i] = indexInfo->ii_IndexAttrNumbers[i];
582 63457 : indcollation = buildoidvector(collationOids, indexInfo->ii_NumIndexKeyAttrs);
1828 583 63457 : indclass = buildoidvector(classOids, indexInfo->ii_NumIndexKeyAttrs);
1823 teodor 584 CBC 63457 : indoption = buildint2vector(coloptions, indexInfo->ii_NumIndexKeyAttrs);
585 :
586 : /*
587 : * Convert the index expressions (if any) to a text datum
588 : */
7256 tgl 589 GIC 63457 : if (indexInfo->ii_Expressions != NIL)
590 : {
591 : char *exprsString;
592 :
7256 tgl 593 CBC 355 : exprsString = nodeToString(indexInfo->ii_Expressions);
5493 594 355 : exprsDatum = CStringGetTextDatum(exprsString);
7256 595 355 : pfree(exprsString);
7256 tgl 596 ECB : }
597 : else
7256 tgl 598 CBC 63102 : exprsDatum = (Datum) 0;
599 :
600 : /*
601 : * Convert the index predicate (if any) to a text datum. Note we convert
602 : * implicit-AND format to normal explicit-AND for storage.
9345 bruce 603 ECB : */
7937 tgl 604 GIC 63457 : if (indexInfo->ii_Predicate != NIL)
605 : {
606 : char *predString;
7499 tgl 607 ECB :
7042 tgl 608 CBC 198 : predString = nodeToString(make_ands_explicit(indexInfo->ii_Predicate));
5493 609 198 : predDatum = CStringGetTextDatum(predString);
9345 bruce 610 GIC 198 : pfree(predString);
611 : }
9345 bruce 612 ECB : else
7256 tgl 613 GIC 63259 : predDatum = (Datum) 0;
614 :
615 :
616 : /*
617 : * open the system catalog index relation
9345 bruce 618 ECB : */
1539 andres 619 GIC 63457 : pg_index = table_open(IndexRelationId, RowExclusiveLock);
620 :
621 : /*
7499 tgl 622 ECB : * Build a pg_index tuple
9345 bruce 623 : */
7499 tgl 624 GIC 63457 : values[Anum_pg_index_indexrelid - 1] = ObjectIdGetDatum(indexoid);
7499 tgl 625 CBC 63457 : values[Anum_pg_index_indrelid - 1] = ObjectIdGetDatum(heapoid);
7256 tgl 626 GIC 63457 : values[Anum_pg_index_indnatts - 1] = Int16GetDatum(indexInfo->ii_NumIndexAttrs);
1828 teodor 627 63457 : values[Anum_pg_index_indnkeyatts - 1] = Int16GetDatum(indexInfo->ii_NumIndexKeyAttrs);
7499 tgl 628 63457 : values[Anum_pg_index_indisunique - 1] = BoolGetDatum(indexInfo->ii_Unique);
430 peter 629 63457 : values[Anum_pg_index_indnullsnotdistinct - 1] = BoolGetDatum(indexInfo->ii_NullsNotDistinct);
7499 tgl 630 63457 : values[Anum_pg_index_indisprimary - 1] = BoolGetDatum(primary);
4457 tgl 631 CBC 63457 : values[Anum_pg_index_indisexclusion - 1] = BoolGetDatum(isexclusion);
5002 tgl 632 GIC 63457 : values[Anum_pg_index_indimmediate - 1] = BoolGetDatum(immediate);
7256 633 63457 : values[Anum_pg_index_indisclustered - 1] = BoolGetDatum(false);
6071 634 63457 : values[Anum_pg_index_indisvalid - 1] = BoolGetDatum(isvalid);
5680 635 63457 : values[Anum_pg_index_indcheckxmin - 1] = BoolGetDatum(false);
1906 alvherre 636 CBC 63457 : values[Anum_pg_index_indisready - 1] = BoolGetDatum(isready);
3784 tgl 637 63457 : values[Anum_pg_index_indislive - 1] = BoolGetDatum(true);
3439 rhaas 638 63457 : values[Anum_pg_index_indisreplident - 1] = BoolGetDatum(false);
6585 tgl 639 63457 : values[Anum_pg_index_indkey - 1] = PointerGetDatum(indkey);
4443 peter_e 640 63457 : values[Anum_pg_index_indcollation - 1] = PointerGetDatum(indcollation);
6585 tgl 641 63457 : values[Anum_pg_index_indclass - 1] = PointerGetDatum(indclass);
5934 642 63457 : values[Anum_pg_index_indoption - 1] = PointerGetDatum(indoption);
7256 643 63457 : values[Anum_pg_index_indexprs - 1] = exprsDatum;
644 63457 : if (exprsDatum == (Datum) 0)
5271 645 63102 : nulls[Anum_pg_index_indexprs - 1] = true;
7499 646 63457 : values[Anum_pg_index_indpred - 1] = predDatum;
7256 647 63457 : if (predDatum == (Datum) 0)
5271 648 63259 : nulls[Anum_pg_index_indpred - 1] = true;
7499 tgl 649 ECB :
5271 tgl 650 CBC 63457 : tuple = heap_form_tuple(RelationGetDescr(pg_index), values, nulls);
9345 bruce 651 ECB :
8053 652 : /*
7552 tgl 653 : * insert the tuple into the pg_index catalog
9345 bruce 654 : */
2259 alvherre 655 CBC 63457 : CatalogTupleInsert(pg_index, tuple);
8304 tgl 656 ECB :
8053 bruce 657 : /*
658 : * close the relation and free the tuple
9345 659 : */
1539 andres 660 CBC 63457 : table_close(pg_index, RowExclusiveLock);
8515 JanWieck 661 GIC 63457 : heap_freetuple(tuple);
9345 bruce 662 CBC 63457 : }
663 :
664 :
665 : /*
666 : * index_create
7912 tgl 667 ECB : *
668 : * heapRelation: table to build index on (suitably locked by caller)
669 : * indexRelationName: what it say
670 : * indexRelationId: normally, pass InvalidOid to let this routine
671 : * generate an OID for the index. During bootstrap this may be
6569 672 : * nonzero to specify a preselected OID.
1906 alvherre 673 : * parentIndexRelid: if creating an index partition, the OID of the
674 : * parent index; otherwise InvalidOid.
675 : * parentConstraintId: if creating a constraint on a partition, the OID
676 : * of the constraint in the parent; otherwise InvalidOid.
677 : * relFileNumber: normally, pass InvalidRelFileNumber to get new storage.
678 : * May be nonzero to attach an existing valid build.
679 : * indexInfo: same info executor uses to insert into the index
680 : * indexColNames: column names to use for index (List of char *)
681 : * accessMethodObjectId: OID of index AM to use
682 : * tableSpaceId: OID of tablespace to use
683 : * collationObjectId: array of collation OIDs, one per index column
684 : * classObjectId: array of index opclass OIDs, one per index column
685 : * coloptions: array of per-index-column indoption settings
686 : * reloptions: AM-specific options
687 : * flags: bitmask that can include any combination of these bits:
688 : * INDEX_CREATE_IS_PRIMARY
689 : * the index is a primary key
690 : * INDEX_CREATE_ADD_CONSTRAINT:
691 : * invoke index_constraint_create also
692 : * INDEX_CREATE_SKIP_BUILD:
693 : * skip the index_build() step for the moment; caller must do it
694 : * later (typically via reindex_index())
695 : * INDEX_CREATE_CONCURRENT:
696 : * do not lock the table against writers. The index will be
697 : * marked "invalid" and the caller must take additional steps
698 : * to fix it up.
699 : * INDEX_CREATE_IF_NOT_EXISTS:
700 : * do not throw an error if a relation with the same name
701 : * already exists.
702 : * INDEX_CREATE_PARTITIONED:
703 : * create a partitioned index (table must be partitioned)
704 : * constr_flags: flags passed to index_constraint_create
705 : * (only if INDEX_CREATE_ADD_CONSTRAINT is set)
706 : * allow_system_table_mods: allow table to be a system catalog
707 : * is_internal: if true, post creation hook for new index
708 : * constraintId: if not NULL, receives OID of created constraint
709 : *
710 : * Returns the OID of the created index.
711 : */
712 : Oid
4457 tgl 713 GIC 63481 : index_create(Relation heapRelation,
714 : const char *indexRelationName,
715 : Oid indexRelationId,
716 : Oid parentIndexRelid,
717 : Oid parentConstraintId,
718 : RelFileNumber relFileNumber,
719 : IndexInfo *indexInfo,
720 : List *indexColNames,
721 : Oid accessMethodObjectId,
722 : Oid tableSpaceId,
723 : Oid *collationObjectId,
724 : Oid *classObjectId,
5934 tgl 725 ECB : int16 *coloptions,
726 : Datum reloptions,
727 : bits16 flags,
728 : bits16 constr_flags,
729 : bool allow_system_table_mods,
730 : bool is_internal,
731 : Oid *constraintId)
732 : {
4457 tgl 733 GIC 63481 : 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;
1972 alvherre 743 63481 : bool isprimary = (flags & INDEX_CREATE_IS_PRIMARY) != 0;
1906 744 63481 : bool invalid = (flags & INDEX_CREATE_INVALID) != 0;
1972 alvherre 745 CBC 63481 : bool concurrent = (flags & INDEX_CREATE_CONCURRENT) != 0;
1906 alvherre 746 GIC 63481 : bool partitioned = (flags & INDEX_CREATE_PARTITIONED) != 0;
747 : char relkind;
748 : TransactionId relfrozenxid;
749 : MultiXactId relminmxid;
277 rhaas 750 GNC 63481 : bool create_storage = !RelFileNumberIsValid(relFileNumber);
751 :
752 : /* constraint flags can only be set when a constraint is requested */
1972 alvherre 753 GIC 63481 : Assert((constr_flags == 0) ||
754 : ((flags & INDEX_CREATE_ADD_CONSTRAINT) != 0));
1906 alvherre 755 ECB : /* partitioned indexes must never be "built" by themselves */
1906 alvherre 756 CBC 63481 : Assert(!partitioned || (flags & INDEX_CREATE_SKIP_BUILD));
8720 bruce 757 ECB :
1906 alvherre 758 CBC 63481 : relkind = partitioned ? RELKIND_PARTITIONED_INDEX : RELKIND_INDEX;
4871 tgl 759 GIC 63481 : is_exclusion = (indexInfo->ii_ExclusionOps != NULL);
760 :
1539 andres 761 63481 : pg_class = table_open(RelationRelationId, RowExclusiveLock);
6449 tgl 762 ECB :
763 : /*
764 : * The index will be in the same namespace as its parent table, and is
4790 bruce 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.
7652 tgl 768 : */
7684 tgl 769 GIC 63481 : namespaceId = RelationGetNamespace(heapRelation);
7652 tgl 770 CBC 63481 : shared_relation = heapRelation->rd_rel->relisshared;
4809 771 63481 : mapped_relation = RelationIsMapped(heapRelation);
4500 rhaas 772 GIC 63481 : relpersistence = heapRelation->rd_rel->relpersistence;
7684 tgl 773 ECB :
774 : /*
775 : * check parameters
776 : */
7256 tgl 777 GIC 63481 : if (indexInfo->ii_NumIndexAttrs < 1)
7912 peter_e 778 UIC 0 : elog(ERROR, "must index at least one column");
779 :
7684 tgl 780 GIC 108666 : if (!allow_system_table_mods &&
7667 tgl 781 CBC 45185 : IsSystemRelation(heapRelation) &&
7684 782 37820 : IsNormalProcessingMode())
7202 tgl 783 LBC 0 : ereport(ERROR,
7202 tgl 784 ECB : (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
1296 789 : * fine as long as the collation is deterministic; text_eq then reduces to
1296 tgl 790 EUB : * bitwise equality and so it is semantically compatible with the other
791 : * operators and functions in that opclass. But with a nondeterministic
1296 tgl 792 ECB : * 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
1296 tgl 795 EUB : * 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 : */
1296 tgl 806 GIC 171180 : for (i = 0; i < indexInfo->ii_NumIndexKeyAttrs; i++)
807 : {
808 107705 : Oid collation = collationObjectId[i];
809 107705 : Oid opclass = classObjectId[i];
810 :
811 107705 : if (collation)
812 : {
813 12327 : if ((opclass == TEXT_BTREE_PATTERN_OPS_OID ||
814 12290 : opclass == VARCHAR_BTREE_PATTERN_OPS_OID ||
815 43 : opclass == BPCHAR_BTREE_PATTERN_OPS_OID) &&
816 43 : !get_collation_isdeterministic(collation))
817 : {
1296 tgl 818 ECB : HeapTuple classtup;
819 :
1296 tgl 820 CBC 6 : classtup = SearchSysCache1(CLAOID, ObjectIdGetDatum(opclass));
821 6 : if (!HeapTupleIsValid(classtup))
1296 tgl 822 UIC 0 : elog(ERROR, "cache lookup failed for operator class %u", opclass);
1296 tgl 823 CBC 6 : ereport(ERROR,
824 : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1296 tgl 825 ECB : 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 :
6071 832 : /*
1472 peter 833 : * Concurrent index build on a system catalog is unsafe because we tend to
1472 peter 834 EUB : * release locks before committing in catalogs.
6071 tgl 835 ECB : */
6071 tgl 836 GIC 63762 : if (concurrent &&
1472 peter 837 287 : IsCatalogRelation(heapRelation))
6071 tgl 838 UIC 0 : 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 : */
4871 tgl 846 GIC 63475 : if (concurrent && is_exclusion)
4871 tgl 847 UIC 0 : ereport(ERROR,
4871 tgl 848 ECB : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1385 peter 849 : errmsg("concurrent index creation for exclusion constraints is not supported")));
4871 tgl 850 EUB :
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 : */
6096 tgl 855 GIC 63475 : if (shared_relation && !IsBootstrapProcessingMode())
7202 tgl 856 UIC 0 : ereport(ERROR,
857 : (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
6385 bruce 858 ECB : errmsg("shared indexes cannot be created after initdb")));
7652 tgl 859 EUB :
860 : /*
861 : * Shared relations must be in pg_global, too (last-ditch check)
862 : */
4809 tgl 863 GIC 63475 : if (shared_relation && tableSpaceId != GLOBALTABLESPACE_OID)
4809 tgl 864 UIC 0 : elog(ERROR, "shared relations must be placed in pg_global tablespace");
865 :
866 : /*
1678 tgl 867 ECB : * Check for duplicate name (both as to the index, and as to the
1678 tgl 868 EUB : * 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 : */
7679 tgl 872 GIC 63475 : if (get_relname_relid(indexRelationName, namespaceId))
873 : {
1972 alvherre 874 12 : if ((flags & INDEX_CREATE_IF_NOT_EXISTS) != 0)
3076 fujii 875 ECB : {
3076 fujii 876 GBC 9 : ereport(NOTICE,
877 : (errcode(ERRCODE_DUPLICATE_TABLE),
878 : errmsg("relation \"%s\" already exists, skipping",
879 : indexRelationName)));
1539 andres 880 GIC 9 : table_close(pg_class, RowExclusiveLock);
3076 fujii 881 9 : return InvalidOid;
882 : }
883 :
7202 tgl 884 CBC 3 : ereport(ERROR,
885 : (errcode(ERRCODE_DUPLICATE_TABLE),
7202 tgl 886 ECB : errmsg("relation \"%s\" already exists",
887 : indexRelationName)));
3076 fujii 888 : }
889 :
1678 tgl 890 GIC 67655 : if ((flags & INDEX_CREATE_ADD_CONSTRAINT) != 0 &&
891 4192 : ConstraintNameIsUsed(CONSTRAINT_RELATION, heapRelationId,
1678 tgl 892 ECB : indexRelationName))
893 : {
894 : /*
895 : * INDEX_CREATE_IF_NOT_EXISTS does not apply here, since the
896 : * conflicting constraint is not an index.
897 : */
1678 tgl 898 GIC 3 : ereport(ERROR,
899 : (errcode(ERRCODE_DUPLICATE_OBJECT),
900 : errmsg("constraint \"%s\" for relation \"%s\" already exists",
901 : indexRelationName, RelationGetRelationName(heapRelation))));
1678 tgl 902 ECB : }
903 :
904 : /*
905 : * construct tuple descriptor for index tuples
906 : */
7256 tgl 907 GIC 63460 : indexTupDesc = ConstructTupleDescriptor(heapRelation,
908 : indexInfo,
909 : indexColNames,
5319 tgl 910 ECB : 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.
193 rhaas 919 : */
4813 tgl 920 GIC 63457 : if (!OidIsValid(indexRelationId))
921 : {
922 : /* Use binary-upgrade override for pg_class.oid and relfilenumber */
3149 bruce 923 14657 : if (IsBinaryUpgrade)
924 : {
925 482 : if (!OidIsValid(binary_upgrade_next_index_pg_class_oid))
3149 bruce 926 UIC 0 : ereport(ERROR,
927 : (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
928 : errmsg("pg_class index OID value not set when in binary upgrade mode")));
929 :
4475 bruce 930 GIC 482 : indexRelationId = binary_upgrade_next_index_pg_class_oid;
931 482 : binary_upgrade_next_index_pg_class_oid = InvalidOid;
447 rhaas 932 ECB :
933 : /* Override the index relfilenumber */
447 rhaas 934 GIC 482 : if ((relkind == RELKIND_INDEX) &&
277 rhaas 935 GNC 460 : (!RelFileNumberIsValid(binary_upgrade_next_index_pg_class_relfilenumber)))
447 rhaas 936 UIC 0 : ereport(ERROR,
447 rhaas 937 ECB : (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
938 : errmsg("index relfilenumber value not set when in binary upgrade mode")));
277 rhaas 939 GNC 482 : relFileNumber = binary_upgrade_next_index_pg_class_relfilenumber;
940 482 : binary_upgrade_next_index_pg_class_relfilenumber = InvalidRelFileNumber;
941 :
447 rhaas 942 ECB : /*
332 tgl 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.
447 rhaas 946 : */
447 rhaas 947 CBC 482 : Assert(create_storage);
4813 tgl 948 EUB : }
949 : else
950 : {
193 rhaas 951 ECB : indexRelationId =
193 rhaas 952 GNC 14175 : 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
1906 alvherre 959 ECB : * responsibility to remove the disk file again, if any.)
960 : */
7684 tgl 961 GIC 63457 : indexRelation = heap_create(indexRelationName,
962 : namespaceId,
963 : tableSpaceId,
6569 tgl 964 ECB : indexRelationId,
965 : relFileNumber,
966 : accessMethodObjectId,
967 : indexTupDesc,
968 : relkind,
969 : relpersistence,
970 : shared_relation,
971 : mapped_relation,
972 : allow_system_table_mods,
1473 andres 973 : &relfrozenxid,
974 : &relminmxid,
975 : create_storage);
976 :
1473 andres 977 GIC 63457 : Assert(relfrozenxid == InvalidTransactionId);
978 63457 : Assert(relminmxid == InvalidMultiXactId);
6449 tgl 979 63457 : 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 : */
8187 986 63457 : LockRelation(indexRelation, AccessExclusiveLock);
987 :
988 : /*
6385 bruce 989 ECB : * Fill in fields of the index's pg_class entry that are not set correctly
990 : * by heap_create.
9345 991 : *
992 : * XXX should have a cleaner way to create cataloged indexes
993 : */
6435 tgl 994 GIC 63457 : indexRelation->rd_rel->relowner = heapRelation->rd_rel->relowner;
7652 995 63457 : indexRelation->rd_rel->relam = accessMethodObjectId;
1824 alvherre 996 63457 : indexRelation->rd_rel->relispartition = OidIsValid(parentIndexRelid);
997 :
7652 tgl 998 ECB : /*
999 : * store index's pg_class entry
1000 : */
6124 tgl 1001 GIC 63457 : InsertPgClassTuple(pg_class, indexRelation,
1002 : RelationGetRelid(indexRelation),
1003 : (Datum) 0,
1004 : reloptions);
1005 :
6449 tgl 1006 ECB : /* done with pg_class */
1539 andres 1007 CBC 63457 : table_close(pg_class, RowExclusiveLock);
9722 scrappy 1008 ECB :
1009 : /*
1010 : * now update the object id's of all the attribute tuple forms in the
1011 : * index relation's tuple descriptor
1012 : */
8304 tgl 1013 CBC 63457 : InitializeAttributeOids(indexRelation,
1014 : indexInfo->ii_NumIndexAttrs,
1015 : indexRelationId);
1016 :
1017 : /*
1018 : * append ATTRIBUTE tuples for the index
9770 scrappy 1019 ECB : */
982 michael 1020 GIC 63457 : AppendAttributeTuples(indexRelation, indexInfo->ii_OpclassOptions);
1021 :
1022 : /* ----------------
1023 : * update pg_index
1024 : * (append INDEX tuple)
9345 bruce 1025 ECB : *
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 : */
1906 alvherre 1030 GIC 126914 : UpdateIndexRelation(indexRelationId, heapRelationId, parentIndexRelid,
1031 : indexInfo,
4370 tgl 1032 ECB : collationObjectId, classObjectId, coloptions,
1033 : isprimary, is_exclusion,
1972 alvherre 1034 GIC 63457 : (constr_flags & INDEX_CONSTR_CREATE_DEFERRABLE) == 0,
1906 1035 63457 : !concurrent && !invalid,
5002 tgl 1036 63457 : !concurrent);
1037 :
1038 : /*
1039 : * Register relcache invalidation on the indexes' heap relation, to
1040 : * maintain consistency of its index list
1041 : */
1710 pg 1042 CBC 63457 : CacheInvalidateRelcache(heapRelation);
1043 :
1044 : /* update pg_inherits and the parent's relhassubclass, if needed */
1906 alvherre 1045 GIC 63457 : if (OidIsValid(parentIndexRelid))
1630 michael 1046 ECB : {
1906 alvherre 1047 CBC 1055 : StoreSingleInheritance(indexRelationId, parentIndexRelid, 1);
1630 michael 1048 1055 : SetRelationHasSubclass(parentIndexRelid, true);
1049 : }
1050 :
1051 : /*
1052 : * Register constraint and dependencies for the index.
1053 : *
6347 bruce 1054 ECB : * 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
4457 tgl 1057 : * dependency directly on the table.
1058 : *
7522 bruce 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 : */
7576 tgl 1065 GIC 63457 : if (!IsBootstrapProcessingMode())
1066 : {
1067 : ObjectAddress myself,
1068 : referenced;
1069 : ObjectAddresses *addrs;
1070 :
1012 michael 1071 14657 : ObjectAddressSet(myself, RelationRelationId, indexRelationId);
1072 :
1972 alvherre 1073 14657 : if ((flags & INDEX_CREATE_ADD_CONSTRAINT) != 0)
1074 : {
1075 : char constraintType;
1076 : ObjectAddress localaddr;
7576 tgl 1077 ECB :
6178 tgl 1078 GIC 4189 : if (isprimary)
7576 1079 3726 : constraintType = CONSTRAINT_PRIMARY;
1080 463 : else if (indexInfo->ii_Unique)
1081 399 : constraintType = CONSTRAINT_UNIQUE;
4871 1082 64 : else if (is_exclusion)
4871 tgl 1083 CBC 64 : constraintType = CONSTRAINT_EXCLUSION;
1084 : else
7576 tgl 1085 ECB : {
4871 tgl 1086 UIC 0 : elog(ERROR, "constraint must be PRIMARY, UNIQUE or EXCLUDE");
1087 : constraintType = 0; /* keep compiler quiet */
1088 : }
1089 :
1875 alvherre 1090 CBC 4189 : localaddr = index_constraint_create(heapRelation,
1809 tgl 1091 ECB : indexRelationId,
1092 : parentConstraintId,
1093 : indexInfo,
1094 : indexRelationName,
1095 : constraintType,
1096 : constr_flags,
1097 : allow_system_table_mods,
1809 tgl 1098 EUB : is_internal);
1875 alvherre 1099 GIC 4189 : if (constraintId)
1100 4189 : *constraintId = localaddr.objectId;
1101 : }
7576 tgl 1102 ECB : else
1103 : {
5624 bruce 1104 GIC 10468 : bool have_simple_col = false;
1105 :
946 michael 1106 10468 : addrs = new_object_addresses();
1107 :
1108 : /* Create auto dependencies on simply-referenced columns */
7256 tgl 1109 29137 : for (i = 0; i < indexInfo->ii_NumIndexAttrs; i++)
1110 : {
1823 teodor 1111 CBC 18669 : if (indexInfo->ii_IndexAttrNumbers[i] != 0)
7256 tgl 1112 ECB : {
1012 michael 1113 GIC 18315 : ObjectAddressSubSet(referenced, RelationRelationId,
1114 : heapRelationId,
1115 : indexInfo->ii_IndexAttrNumbers[i]);
946 michael 1116 CBC 18315 : add_exact_object_address(&referenced, addrs);
5631 tgl 1117 GIC 18315 : have_simple_col = true;
7256 tgl 1118 ECB : }
1119 : }
1120 :
5631 1121 : /*
1122 : * If there are no simply-referenced columns, give the index an
3260 bruce 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
4541 tgl 1125 : * predicate contain no Vars or only whole-row Vars.
1126 : */
4541 tgl 1127 GIC 10468 : if (!have_simple_col)
5631 tgl 1128 ECB : {
1012 michael 1129 CBC 262 : ObjectAddressSet(referenced, RelationRelationId,
1130 : heapRelationId);
946 michael 1131 GIC 262 : add_exact_object_address(&referenced, addrs);
1132 : }
1133 :
1134 10468 : record_object_address_dependencies(&myself, addrs, DEPENDENCY_AUTO);
1135 10468 : free_object_addresses(addrs);
1136 : }
1137 :
1138 : /*
1518 tgl 1139 ECB : * 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 : */
1906 alvherre 1144 GIC 14657 : if (OidIsValid(parentIndexRelid))
1145 : {
1012 michael 1146 CBC 1055 : ObjectAddressSet(referenced, RelationRelationId, parentIndexRelid);
1518 tgl 1147 1055 : recordDependencyOn(&myself, &referenced, DEPENDENCY_PARTITION_PRI);
1148 :
1012 michael 1149 GIC 1055 : ObjectAddressSet(referenced, RelationRelationId, heapRelationId);
1518 tgl 1150 1055 : recordDependencyOn(&myself, &referenced, DEPENDENCY_PARTITION_SEC);
1151 : }
1152 :
1153 : /* placeholder for normal dependencies */
702 tmunro 1154 14657 : addrs = new_object_addresses();
1155 :
702 tmunro 1156 ECB : /* Store dependency on collations */
1157 :
1158 : /* The default collation is pinned, so don't bother recording it */
702 tmunro 1159 CBC 37847 : for (i = 0; i < indexInfo->ii_NumIndexKeyAttrs; i++)
1160 : {
1161 23190 : if (OidIsValid(collationObjectId[i]) &&
1162 1329 : collationObjectId[i] != DEFAULT_COLLATION_OID)
1163 : {
702 tmunro 1164 GIC 189 : ObjectAddressSet(referenced, CollationRelationId,
1165 : collationObjectId[i]);
702 tmunro 1166 CBC 189 : add_exact_object_address(&referenced, addrs);
1167 : }
1168 : }
1169 :
1170 : /* Store dependency on operator classes */
1828 teodor 1171 37847 : for (i = 0; i < indexInfo->ii_NumIndexKeyAttrs; i++)
1172 : {
1012 michael 1173 23190 : ObjectAddressSet(referenced, OperatorClassRelationId, classObjectId[i]);
946 1174 23190 : add_exact_object_address(&referenced, addrs);
1175 : }
702 tmunro 1176 ECB :
946 michael 1177 GIC 14657 : record_object_address_dependencies(&myself, addrs, DEPENDENCY_NORMAL);
946 michael 1178 CBC 14657 : free_object_addresses(addrs);
1179 :
1180 : /* Store dependencies on anything mentioned in index expressions */
7256 tgl 1181 GIC 14657 : if (indexInfo->ii_Expressions)
1182 : {
7256 tgl 1183 CBC 355 : recordDependencyOnSingleRelExpr(&myself,
2118 tgl 1184 GIC 355 : (Node *) indexInfo->ii_Expressions,
7256 tgl 1185 ECB : heapRelationId,
1186 : DEPENDENCY_NORMAL,
1187 : DEPENDENCY_AUTO, false);
1188 : }
7576 1189 :
7256 1190 : /* Store dependencies on anything mentioned in predicate */
7256 tgl 1191 GIC 14657 : if (indexInfo->ii_Predicate)
1192 : {
7256 tgl 1193 CBC 198 : recordDependencyOnSingleRelExpr(&myself,
6385 bruce 1194 GIC 198 : (Node *) indexInfo->ii_Predicate,
7256 tgl 1195 ECB : heapRelationId,
1196 : DEPENDENCY_NORMAL,
1197 : DEPENDENCY_AUTO, false);
1198 : }
1199 : }
1200 : else
1201 : {
1202 : /* Bootstrap mode - assert we weren't asked for constraint support */
1972 alvherre 1203 CBC 48800 : Assert((flags & INDEX_CREATE_ADD_CONSTRAINT) == 0);
1204 : }
7576 tgl 1205 ECB :
3820 alvherre 1206 : /* Post creation hook for new index */
3686 rhaas 1207 GIC 63457 : 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 : */
7855 tgl 1214 63457 : CommandCounterIncrement();
7855 tgl 1215 ECB :
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
6385 bruce 1219 : * relcache entry has already been rebuilt thanks to sinval update during
1220 : * CommandCounterIncrement.
1221 : */
6497 tgl 1222 GIC 63454 : if (IsBootstrapProcessingMode())
1223 48800 : RelationInitIndexAccessInfo(indexRelation);
1224 : else
1225 14654 : Assert(indexRelation->rd_indexcxt != NULL);
9345 bruce 1226 ECB :
1828 teodor 1227 GIC 63454 : indexRelation->rd_index->indnkeyatts = indexInfo->ii_NumIndexKeyAttrs;
1228 :
1229 : /* Validate opclass-specific options */
1105 akorotkov 1230 63454 : if (indexInfo->ii_OpclassOptions)
1231 102 : for (i = 0; i < indexInfo->ii_NumIndexKeyAttrs; i++)
1232 78 : (void) index_opclass_options(indexRelation, i + 1,
1233 78 : indexInfo->ii_OpclassOptions[i],
1105 akorotkov 1234 ECB : true);
1235 :
1236 : /*
6385 bruce 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
1972 alvherre 1242 : * with this). Otherwise, we call the AM routine that constructs the
1243 : * index.
9345 bruce 1244 : */
9345 bruce 1245 CBC 63412 : if (IsBootstrapProcessingMode())
1246 : {
6449 tgl 1247 GIC 48800 : index_register(heapRelationId, indexRelationId, indexInfo);
1248 : }
1972 alvherre 1249 14612 : 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 : */
6178 tgl 1256 1292 : index_update_stats(heapRelation,
6178 tgl 1257 ECB : true,
1258 : -1.0);
1259 : /* Make the above update visible */
6178 tgl 1260 GIC 1292 : CommandCounterIncrement();
6913 tgl 1261 ECB : }
1262 : else
1263 : {
1536 michael 1264 GIC 13320 : index_build(heapRelation, indexRelation, indexInfo, false, true);
1265 : }
1266 :
1267 : /*
4457 tgl 1268 ECB : * 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 : */
6096 tgl 1271 GIC 63382 : index_close(indexRelation, NoLock);
6178 tgl 1272 ECB :
6449 tgl 1273 GIC 63382 : return indexRelationId;
1274 : }
1275 :
1472 peter 1276 ECB : /*
1277 : * index_concurrently_create_copy
1278 : *
1279 : * Create concurrently an index based on the definition of the one provided by
1280 : * caller. The index is inserted into catalogs and needs to be built later
1281 : * on. This is called during concurrent reindex processing.
1282 : *
794 michael 1283 : * "tablespaceOid" is the tablespace to use for this index.
1284 : */
1472 peter 1285 : Oid
794 michael 1286 GIC 213 : index_concurrently_create_copy(Relation heapRelation, Oid oldIndexId,
1287 : Oid tablespaceOid, const char *newName)
1288 : {
1289 : Relation indexRelation;
1290 : IndexInfo *oldInfo,
1291 : *newInfo;
1472 peter 1292 213 : Oid newIndexId = InvalidOid;
1293 : HeapTuple indexTuple,
1294 : classTuple;
1295 : Datum indclassDatum,
1296 : colOptionDatum,
1297 : optionDatum;
1472 peter 1298 ECB : oidvector *indclass;
1299 : int2vector *indcoloptions;
1300 : bool isnull;
1472 peter 1301 GIC 213 : List *indexColNames = NIL;
1350 michael 1302 213 : List *indexExprs = NIL;
1303 213 : List *indexPreds = NIL;
1472 peter 1304 ECB :
1472 peter 1305 GIC 213 : indexRelation = index_open(oldIndexId, RowExclusiveLock);
1306 :
1307 : /* The new index needs some information from the old index */
1350 michael 1308 213 : oldInfo = BuildIndexInfo(indexRelation);
1309 :
1310 : /*
1311 : * Concurrent build of an index with exclusion constraints is not
1312 : * supported.
1350 michael 1313 ECB : */
1350 michael 1314 CBC 213 : if (oldInfo->ii_ExclusionOps != NULL)
1315 3 : ereport(ERROR,
1316 : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1350 michael 1317 ECB : errmsg("concurrent index creation for exclusion constraints is not supported")));
1318 :
1319 : /* Get the array of class and column options IDs from index info */
1472 peter 1320 CBC 210 : indexTuple = SearchSysCache1(INDEXRELID, ObjectIdGetDatum(oldIndexId));
1472 peter 1321 GIC 210 : if (!HeapTupleIsValid(indexTuple))
1472 peter 1322 UIC 0 : elog(ERROR, "cache lookup failed for index %u", oldIndexId);
15 dgustafsson 1323 GNC 210 : indclassDatum = SysCacheGetAttrNotNull(INDEXRELID, indexTuple,
1324 : Anum_pg_index_indclass);
1472 peter 1325 CBC 210 : indclass = (oidvector *) DatumGetPointer(indclassDatum);
1472 peter 1326 ECB :
15 dgustafsson 1327 GNC 210 : colOptionDatum = SysCacheGetAttrNotNull(INDEXRELID, indexTuple,
1328 : Anum_pg_index_indoption);
1472 peter 1329 GIC 210 : indcoloptions = (int2vector *) DatumGetPointer(colOptionDatum);
1472 peter 1330 ECB :
1331 : /* Fetch options of index if any */
1472 peter 1332 GBC 210 : classTuple = SearchSysCache1(RELOID, oldIndexId);
1472 peter 1333 CBC 210 : if (!HeapTupleIsValid(classTuple))
1472 peter 1334 UIC 0 : elog(ERROR, "cache lookup failed for relation %u", oldIndexId);
1472 peter 1335 CBC 210 : optionDatum = SysCacheGetAttr(RELOID, classTuple,
1336 : Anum_pg_class_reloptions, &isnull);
1472 peter 1337 ECB :
1338 : /*
1350 michael 1339 : * Fetch the list of expressions and predicates directly from the
1340 : * catalogs. This cannot rely on the information from IndexInfo of the
1341 : * old index as these have been flattened for the planner.
1342 : */
1350 michael 1343 CBC 210 : if (oldInfo->ii_Expressions != NIL)
1350 michael 1344 EUB : {
1350 michael 1345 ECB : Datum exprDatum;
1346 : char *exprString;
1347 :
15 dgustafsson 1348 GNC 15 : exprDatum = SysCacheGetAttrNotNull(INDEXRELID, indexTuple,
1349 : Anum_pg_index_indexprs);
1350 michael 1350 GIC 15 : exprString = TextDatumGetCString(exprDatum);
1351 15 : indexExprs = (List *) stringToNode(exprString);
1350 michael 1352 CBC 15 : pfree(exprString);
1353 : }
1350 michael 1354 GIC 210 : if (oldInfo->ii_Predicate != NIL)
1355 : {
1356 : Datum predDatum;
1350 michael 1357 ECB : char *predString;
1358 :
15 dgustafsson 1359 GNC 12 : predDatum = SysCacheGetAttrNotNull(INDEXRELID, indexTuple,
1360 : Anum_pg_index_indpred);
1350 michael 1361 GIC 12 : predString = TextDatumGetCString(predDatum);
1350 michael 1362 CBC 12 : indexPreds = (List *) stringToNode(predString);
1363 :
1364 : /* Also convert to implicit-AND format */
1350 michael 1365 GIC 12 : indexPreds = make_ands_implicit((Expr *) indexPreds);
1366 12 : pfree(predString);
1350 michael 1367 ECB : }
1368 :
1369 : /*
1370 : * Build the index information for the new index. Note that rebuild of
1371 : * indexes with exclusion constraints is not supported, hence there is no
1372 : * need to fill all the ii_Exclusion* fields.
1373 : */
1350 michael 1374 CBC 210 : newInfo = makeIndexInfo(oldInfo->ii_NumIndexAttrs,
1375 : oldInfo->ii_NumIndexKeyAttrs,
1376 : oldInfo->ii_Am,
1377 : indexExprs,
1378 : indexPreds,
1350 michael 1379 GIC 210 : oldInfo->ii_Unique,
430 peter 1380 210 : oldInfo->ii_NullsNotDistinct,
1381 : false, /* not ready for inserts */
1382 : true,
20 tomas.vondra 1383 GNC 210 : indexRelation->rd_indam->amsummarizing);
1384 :
1385 : /*
1386 : * Extract the list of column names and the column numbers for the new
1387 : * index information. All this information will be used for the index
1350 michael 1388 ECB : * creation.
1472 peter 1389 : */
1350 michael 1390 GIC 522 : for (int i = 0; i < oldInfo->ii_NumIndexAttrs; i++)
1391 : {
1472 peter 1392 CBC 312 : TupleDesc indexTupDesc = RelationGetDescr(indexRelation);
1472 peter 1393 GIC 312 : Form_pg_attribute att = TupleDescAttr(indexTupDesc, i);
1394 :
1395 312 : indexColNames = lappend(indexColNames, NameStr(att->attname));
1350 michael 1396 312 : newInfo->ii_IndexAttrNumbers[i] = oldInfo->ii_IndexAttrNumbers[i];
1397 : }
1398 :
524 michael 1399 ECB : /* Extract opclass parameters for each attribute, if any */
524 michael 1400 GIC 210 : if (oldInfo->ii_OpclassOptions != NULL)
524 michael 1401 ECB : {
524 michael 1402 CBC 12 : newInfo->ii_OpclassOptions = palloc0(sizeof(Datum) *
524 michael 1403 GIC 6 : newInfo->ii_NumIndexAttrs);
524 michael 1404 CBC 18 : for (int i = 0; i < newInfo->ii_NumIndexAttrs; i++)
1405 12 : newInfo->ii_OpclassOptions[i] = get_attoptions(oldIndexId, i + 1);
1406 : }
1407 :
1408 : /*
1458 peter 1409 ECB : * Now create the new index.
1410 : *
1411 : * For a partition index, we adjust the partition dependency later, to
1412 : * ensure a consistent state at all times. That is why parentIndexRelid
1413 : * is not set here.
1414 : */
1472 peter 1415 GIC 210 : newIndexId = index_create(heapRelation,
1416 : newName,
1417 : InvalidOid, /* indexRelationId */
1418 : InvalidOid, /* parentIndexRelid */
1419 : InvalidOid, /* parentConstraintId */
1420 : InvalidRelFileNumber, /* relFileNumber */
1421 : newInfo,
1422 : indexColNames,
1423 210 : indexRelation->rd_rel->relam,
794 michael 1424 ECB : tablespaceOid,
1425 : indexRelation->rd_indcollation,
1472 peter 1426 GIC 210 : indclass->values,
1427 210 : indcoloptions->values,
1428 : optionDatum,
1429 : INDEX_CREATE_SKIP_BUILD | INDEX_CREATE_CONCURRENT,
1430 : 0,
1431 : true, /* allow table to be a system catalog? */
1418 tgl 1432 ECB : false, /* is_internal? */
1433 : NULL);
1434 :
1472 peter 1435 : /* Close the relations used and clean up */
1472 peter 1436 CBC 210 : index_close(indexRelation, NoLock);
1472 peter 1437 GIC 210 : ReleaseSysCache(indexTuple);
1438 210 : ReleaseSysCache(classTuple);
1439 :
1440 210 : return newIndexId;
1441 : }
1442 :
1443 : /*
1444 : * index_concurrently_build
1472 peter 1445 ECB : *
1446 : * Build index for a concurrent operation. Low-level locks are taken when
1447 : * this operation is performed to prevent only schema changes, but they need
1448 : * to be kept until the end of the transaction performing this operation.
1449 : * 'indexOid' refers to an index relation OID already created as part of
1450 : * previous processing, and 'heapOid' refers to its parent heap relation.
1451 : */
1452 : void
1472 peter 1453 GIC 281 : index_concurrently_build(Oid heapRelationId,
1454 : Oid indexRelationId)
1455 : {
1456 : Relation heapRel;
1457 : Oid save_userid;
1458 : int save_sec_context;
1459 : int save_nestlevel;
1460 : Relation indexRelation;
1461 : IndexInfo *indexInfo;
1472 peter 1462 ECB :
1463 : /* This had better make sure that a snapshot is active */
1472 peter 1464 GIC 281 : Assert(ActiveSnapshotSet());
1465 :
1466 : /* Open and lock the parent heap relation */
1467 281 : heapRel = table_open(heapRelationId, ShareUpdateExclusiveLock);
1468 :
1469 : /*
1470 : * Switch to the table owner's userid, so that any index functions are run
1471 : * as that user. Also lock down security-restricted operations and
1472 : * arrange to make GUC variable changes local to this command.
335 noah 1473 ECB : */
335 noah 1474 GIC 281 : GetUserIdAndSecContext(&save_userid, &save_sec_context);
1475 281 : SetUserIdAndSecContext(heapRel->rd_rel->relowner,
335 noah 1476 ECB : save_sec_context | SECURITY_RESTRICTED_OPERATION);
335 noah 1477 GIC 281 : save_nestlevel = NewGUCNestLevel();
1478 :
1472 peter 1479 281 : indexRelation = index_open(indexRelationId, RowExclusiveLock);
1480 :
1481 : /*
1482 : * We have to re-build the IndexInfo struct, since it was lost in the
1472 peter 1483 ECB : * commit of the transaction where this concurrent index was created at
1484 : * the catalog level.
1485 : */
1472 peter 1486 CBC 281 : indexInfo = BuildIndexInfo(indexRelation);
1472 peter 1487 GIC 281 : Assert(!indexInfo->ii_ReadyForInserts);
1472 peter 1488 CBC 281 : indexInfo->ii_Concurrent = true;
1472 peter 1489 GIC 281 : indexInfo->ii_BrokenHotChain = false;
1490 :
1491 : /* Now build the index */
1492 281 : index_build(heapRel, indexRelation, indexInfo, false, true);
1493 :
1494 : /* Roll back any GUC changes executed by index functions */
335 noah 1495 CBC 272 : AtEOXact_GUC(false, save_nestlevel);
335 noah 1496 ECB :
1497 : /* Restore userid and security context */
335 noah 1498 CBC 272 : SetUserIdAndSecContext(save_userid, save_sec_context);
1499 :
1500 : /* Close both the relations, but keep the locks */
1472 peter 1501 272 : table_close(heapRel, NoLock);
1472 peter 1502 GIC 272 : index_close(indexRelation, NoLock);
1503 :
1472 peter 1504 ECB : /*
1505 : * Update the pg_index row to mark the index as ready for inserts. Once we
1506 : * commit this transaction, any new transactions that open the table must
1507 : * insert new entries into the index for insertions and non-HOT updates.
1508 : */
1472 peter 1509 GIC 272 : index_set_state_flags(indexRelationId, INDEX_CREATE_SET_READY);
1472 peter 1510 CBC 272 : }
1472 peter 1511 ECB :
1512 : /*
1513 : * index_concurrently_swap
1514 : *
1515 : * Swap name, dependencies, and constraints of the old index over to the new
1516 : * index, while marking the old index as invalid and the new as valid.
1517 : */
1518 : void
1472 peter 1519 CBC 207 : index_concurrently_swap(Oid newIndexId, Oid oldIndexId, const char *oldName)
1520 : {
1521 : Relation pg_class,
1522 : pg_index,
1523 : pg_constraint,
1524 : pg_trigger;
1525 : Relation oldClassRel,
1526 : newClassRel;
1527 : HeapTuple oldClassTuple,
1472 peter 1528 ECB : newClassTuple;
1529 : Form_pg_class oldClassForm,
1530 : newClassForm;
1531 : HeapTuple oldIndexTuple,
1532 : newIndexTuple;
1533 : Form_pg_index oldIndexForm,
1534 : newIndexForm;
1535 : bool isPartition;
1536 : Oid indexConstraintOid;
1472 peter 1537 GIC 207 : List *constraintOids = NIL;
1538 : ListCell *lc;
1539 :
1540 : /*
1541 : * Take a necessary lock on the old and new index before swapping them.
1542 : */
1543 207 : oldClassRel = relation_open(oldIndexId, ShareUpdateExclusiveLock);
1544 207 : newClassRel = relation_open(newIndexId, ShareUpdateExclusiveLock);
1545 :
1472 peter 1546 ECB : /* Now swap names and dependencies of those indexes */
1472 peter 1547 GIC 207 : pg_class = table_open(RelationRelationId, RowExclusiveLock);
1548 :
1549 207 : oldClassTuple = SearchSysCacheCopy1(RELOID,
1550 : ObjectIdGetDatum(oldIndexId));
1551 207 : if (!HeapTupleIsValid(oldClassTuple))
1472 peter 1552 LBC 0 : elog(ERROR, "could not find tuple for relation %u", oldIndexId);
1472 peter 1553 CBC 207 : newClassTuple = SearchSysCacheCopy1(RELOID,
1554 : ObjectIdGetDatum(newIndexId));
1472 peter 1555 GIC 207 : if (!HeapTupleIsValid(newClassTuple))
1472 peter 1556 LBC 0 : elog(ERROR, "could not find tuple for relation %u", newIndexId);
1557 :
1472 peter 1558 CBC 207 : oldClassForm = (Form_pg_class) GETSTRUCT(oldClassTuple);
1472 peter 1559 GIC 207 : newClassForm = (Form_pg_class) GETSTRUCT(newClassTuple);
1472 peter 1560 ECB :
1472 peter 1561 EUB : /* Swap the names */
1472 peter 1562 CBC 207 : namestrcpy(&newClassForm->relname, NameStr(oldClassForm->relname));
1472 peter 1563 GIC 207 : namestrcpy(&oldClassForm->relname, oldName);
1472 peter 1564 ECB :
1258 michael 1565 EUB : /* Swap the partition flags to track inheritance properly */
1258 michael 1566 GIC 207 : isPartition = newClassForm->relispartition;
1458 peter 1567 CBC 207 : newClassForm->relispartition = oldClassForm->relispartition;
1258 michael 1568 207 : oldClassForm->relispartition = isPartition;
1569 :
1472 peter 1570 GIC 207 : CatalogTupleUpdate(pg_class, &oldClassTuple->t_self, oldClassTuple);
1472 peter 1571 CBC 207 : CatalogTupleUpdate(pg_class, &newClassTuple->t_self, newClassTuple);
1472 peter 1572 ECB :
1472 peter 1573 GIC 207 : heap_freetuple(oldClassTuple);
1574 207 : heap_freetuple(newClassTuple);
1472 peter 1575 ECB :
1576 : /* Now swap index info */
1472 peter 1577 CBC 207 : pg_index = table_open(IndexRelationId, RowExclusiveLock);
1578 :
1579 207 : oldIndexTuple = SearchSysCacheCopy1(INDEXRELID,
1472 peter 1580 ECB : ObjectIdGetDatum(oldIndexId));
1472 peter 1581 GIC 207 : if (!HeapTupleIsValid(oldIndexTuple))
1472 peter 1582 LBC 0 : elog(ERROR, "could not find tuple for relation %u", oldIndexId);
1472 peter 1583 CBC 207 : newIndexTuple = SearchSysCacheCopy1(INDEXRELID,
1584 : ObjectIdGetDatum(newIndexId));
1472 peter 1585 GIC 207 : if (!HeapTupleIsValid(newIndexTuple))
1472 peter 1586 LBC 0 : elog(ERROR, "could not find tuple for relation %u", newIndexId);
1587 :
1472 peter 1588 CBC 207 : oldIndexForm = (Form_pg_index) GETSTRUCT(oldIndexTuple);
1472 peter 1589 GIC 207 : newIndexForm = (Form_pg_index) GETSTRUCT(newIndexTuple);
1472 peter 1590 ECB :
1472 peter 1591 EUB : /*
1472 peter 1592 ECB : * Copy constraint flags from the old index. This is safe because the old
1593 : * index guaranteed uniqueness.
1594 : */
1472 peter 1595 GBC 207 : newIndexForm->indisprimary = oldIndexForm->indisprimary;
1472 peter 1596 GIC 207 : oldIndexForm->indisprimary = false;
1472 peter 1597 CBC 207 : newIndexForm->indisexclusion = oldIndexForm->indisexclusion;
1598 207 : oldIndexForm->indisexclusion = false;
1472 peter 1599 GIC 207 : newIndexForm->indimmediate = oldIndexForm->indimmediate;
1600 207 : oldIndexForm->indimmediate = true;
1601 :
1602 : /* Preserve indisreplident in the new index */
1038 michael 1603 207 : newIndexForm->indisreplident = oldIndexForm->indisreplident;
1038 michael 1604 ECB :
1132 1605 : /* Preserve indisclustered in the new index */
1132 michael 1606 CBC 207 : newIndexForm->indisclustered = oldIndexForm->indisclustered;
1132 michael 1607 ECB :
1608 : /*
1083 tgl 1609 : * Mark the new index as valid, and the old index as invalid similarly to
1610 : * what index_set_state_flags() does.
1611 : */
1472 peter 1612 CBC 207 : newIndexForm->indisvalid = true;
1472 peter 1613 GIC 207 : oldIndexForm->indisvalid = false;
1614 207 : oldIndexForm->indisclustered = false;
952 michael 1615 CBC 207 : oldIndexForm->indisreplident = false;
1616 :
1472 peter 1617 GIC 207 : CatalogTupleUpdate(pg_index, &oldIndexTuple->t_self, oldIndexTuple);
1618 207 : CatalogTupleUpdate(pg_index, &newIndexTuple->t_self, newIndexTuple);
1619 :
1620 207 : heap_freetuple(oldIndexTuple);
1472 peter 1621 CBC 207 : heap_freetuple(newIndexTuple);
1472 peter 1622 ECB :
1623 : /*
1624 : * Move constraints and triggers over to the new index
1625 : */
1626 :
1472 peter 1627 CBC 207 : constraintOids = get_index_ref_constraints(oldIndexId);
1628 :
1629 207 : indexConstraintOid = get_index_constraint(oldIndexId);
1472 peter 1630 ECB :
1472 peter 1631 GIC 207 : if (OidIsValid(indexConstraintOid))
1632 19 : constraintOids = lappend_oid(constraintOids, indexConstraintOid);
1633 :
1634 207 : pg_constraint = table_open(ConstraintRelationId, RowExclusiveLock);
1635 207 : pg_trigger = table_open(TriggerRelationId, RowExclusiveLock);
1472 peter 1636 ECB :
1472 peter 1637 GIC 232 : foreach(lc, constraintOids)
1472 peter 1638 ECB : {
1639 : HeapTuple constraintTuple,
1640 : triggerTuple;
1641 : Form_pg_constraint conForm;
1642 : ScanKeyData key[1];
1643 : SysScanDesc scan;
1472 peter 1644 CBC 25 : Oid constraintOid = lfirst_oid(lc);
1645 :
1472 peter 1646 ECB : /* Move the constraint from the old to the new index */
1472 peter 1647 GIC 25 : constraintTuple = SearchSysCacheCopy1(CONSTROID,
1648 : ObjectIdGetDatum(constraintOid));
1649 25 : if (!HeapTupleIsValid(constraintTuple))
1472 peter 1650 UIC 0 : elog(ERROR, "could not find tuple for constraint %u", constraintOid);
1651 :
1472 peter 1652 GIC 25 : conForm = ((Form_pg_constraint) GETSTRUCT(constraintTuple));
1472 peter 1653 ECB :
1472 peter 1654 GIC 25 : if (conForm->conindid == oldIndexId)
1655 : {
1472 peter 1656 CBC 25 : conForm->conindid = newIndexId;
1657 :
1658 25 : CatalogTupleUpdate(pg_constraint, &constraintTuple->t_self, constraintTuple);
1472 peter 1659 EUB : }
1660 :
1472 peter 1661 CBC 25 : heap_freetuple(constraintTuple);
1662 :
1472 peter 1663 ECB : /* Search for trigger records */
1472 peter 1664 GIC 25 : ScanKeyInit(&key[0],
1472 peter 1665 ECB : Anum_pg_trigger_tgconstraint,
1666 : BTEqualStrategyNumber, F_OIDEQ,
1667 : ObjectIdGetDatum(constraintOid));
1668 :
1472 peter 1669 GIC 25 : scan = systable_beginscan(pg_trigger, TriggerConstraintIndexId, true,
1472 peter 1670 ECB : NULL, 1, key);
1671 :
1472 peter 1672 GIC 49 : while (HeapTupleIsValid((triggerTuple = systable_getnext(scan))))
1472 peter 1673 ECB : {
1472 peter 1674 GIC 24 : Form_pg_trigger tgForm = (Form_pg_trigger) GETSTRUCT(triggerTuple);
1675 :
1676 24 : if (tgForm->tgconstrindid != oldIndexId)
1472 peter 1677 UIC 0 : continue;
1472 peter 1678 ECB :
1679 : /* Make a modifiable copy */
1472 peter 1680 GIC 24 : triggerTuple = heap_copytuple(triggerTuple);
1472 peter 1681 CBC 24 : tgForm = (Form_pg_trigger) GETSTRUCT(triggerTuple);
1682 :
1683 24 : tgForm->tgconstrindid = newIndexId;
1684 :
1685 24 : CatalogTupleUpdate(pg_trigger, &triggerTuple->t_self, triggerTuple);
1472 peter 1686 EUB :
1472 peter 1687 GIC 24 : heap_freetuple(triggerTuple);
1688 : }
1472 peter 1689 ECB :
1472 peter 1690 CBC 25 : systable_endscan(scan);
1691 : }
1472 peter 1692 ECB :
1693 : /*
1694 : * Move comment if any
1695 : */
1696 : {
1697 : Relation description;
1698 : ScanKeyData skey[3];
1699 : SysScanDesc sd;
1700 : HeapTuple tuple;
1472 peter 1701 GIC 207 : Datum values[Natts_pg_description] = {0};
1702 207 : bool nulls[Natts_pg_description] = {0};
1703 207 : bool replaces[Natts_pg_description] = {0};
1704 :
1705 207 : values[Anum_pg_description_objoid - 1] = ObjectIdGetDatum(newIndexId);
1706 207 : replaces[Anum_pg_description_objoid - 1] = true;
1707 :
1708 207 : ScanKeyInit(&skey[0],
1709 : Anum_pg_description_objoid,
1472 peter 1710 ECB : BTEqualStrategyNumber, F_OIDEQ,
1711 : ObjectIdGetDatum(oldIndexId));
1472 peter 1712 CBC 207 : ScanKeyInit(&skey[1],
1713 : Anum_pg_description_classoid,
1472 peter 1714 ECB : BTEqualStrategyNumber, F_OIDEQ,
1715 : ObjectIdGetDatum(RelationRelationId));
1472 peter 1716 GIC 207 : ScanKeyInit(&skey[2],
1472 peter 1717 ECB : Anum_pg_description_objsubid,
1718 : BTEqualStrategyNumber, F_INT4EQ,
1719 : Int32GetDatum(0));
1720 :
1472 peter 1721 CBC 207 : description = table_open(DescriptionRelationId, RowExclusiveLock);
1722 :
1472 peter 1723 GIC 207 : sd = systable_beginscan(description, DescriptionObjIndexId, true,
1724 : NULL, 3, skey);
1472 peter 1725 ECB :
1472 peter 1726 GIC 207 : while ((tuple = systable_getnext(sd)) != NULL)
1727 : {
1728 3 : tuple = heap_modify_tuple(tuple, RelationGetDescr(description),
1729 : values, nulls, replaces);
1472 peter 1730 CBC 3 : CatalogTupleUpdate(description, &tuple->t_self, tuple);
1731 :
1418 tgl 1732 3 : break; /* Assume there can be only one match */
1733 : }
1734 :
1472 peter 1735 207 : systable_endscan(sd);
1472 peter 1736 GIC 207 : table_close(description, NoLock);
1472 peter 1737 ECB : }
1738 :
1739 : /*
1740 : * Swap inheritance relationship with parent index
1741 : */
1458 peter 1742 GIC 207 : if (get_rel_relispartition(oldIndexId))
1743 : {
1418 tgl 1744 CBC 33 : List *ancestors = get_partition_ancestors(oldIndexId);
1745 33 : Oid parentIndexRelid = linitial_oid(ancestors);
1746 :
745 alvherre 1747 GIC 33 : DeleteInheritsTuple(oldIndexId, parentIndexRelid, false, NULL);
1458 peter 1748 33 : StoreSingleInheritance(newIndexId, parentIndexRelid, 1);
1749 :
1750 33 : list_free(ancestors);
1472 peter 1751 ECB : }
1752 :
1458 1753 : /*
1130 michael 1754 : * Swap all dependencies of and on the old index to the new one, and
1755 : * vice-versa. Note that a call to CommandCounterIncrement() would cause
1756 : * duplicate entries in pg_depend, so this should not be done.
1458 peter 1757 : */
1130 michael 1758 GIC 207 : changeDependenciesOf(RelationRelationId, newIndexId, oldIndexId);
1130 michael 1759 CBC 207 : changeDependenciesOn(RelationRelationId, newIndexId, oldIndexId);
1760 :
1458 peter 1761 GIC 207 : changeDependenciesOf(RelationRelationId, oldIndexId, newIndexId);
1472 1762 207 : changeDependenciesOn(RelationRelationId, oldIndexId, newIndexId);
1763 :
1764 : /* copy over statistics from old to new index */
368 andres 1765 207 : pgstat_copy_relation_stats(newClassRel, oldClassRel);
1766 :
889 michael 1767 ECB : /* Copy data of pg_statistic from the old index to the new one */
889 michael 1768 CBC 207 : CopyStatistics(oldIndexId, newIndexId);
1769 :
788 michael 1770 ECB : /* Copy pg_attribute.attstattarget for each index attribute */
1771 : {
1772 : HeapTuple attrTuple;
1773 : Relation pg_attribute;
1774 : SysScanDesc scan;
1775 : ScanKeyData key[1];
1776 :
788 michael 1777 CBC 207 : pg_attribute = table_open(AttributeRelationId, RowExclusiveLock);
788 michael 1778 GIC 207 : ScanKeyInit(&key[0],
1779 : Anum_pg_attribute_attrelid,
1780 : BTEqualStrategyNumber, F_OIDEQ,
1781 : ObjectIdGetDatum(newIndexId));
1782 207 : scan = systable_beginscan(pg_attribute, AttributeRelidNumIndexId,
1783 : true, NULL, 1, key);
1784 :
1785 516 : while (HeapTupleIsValid((attrTuple = systable_getnext(scan))))
788 michael 1786 ECB : {
788 michael 1787 CBC 309 : Form_pg_attribute att = (Form_pg_attribute) GETSTRUCT(attrTuple);
1788 : Datum repl_val[Natts_pg_attribute];
1789 : bool repl_null[Natts_pg_attribute];
1790 : bool repl_repl[Natts_pg_attribute];
788 michael 1791 ECB : int attstattarget;
1792 : HeapTuple newTuple;
1793 :
1794 : /* Ignore dropped columns */
788 michael 1795 GIC 309 : if (att->attisdropped)
788 michael 1796 CBC 306 : continue;
1797 :
1798 : /*
1799 : * Get attstattarget from the old index and refresh the new value.
1800 : */
788 michael 1801 GIC 309 : attstattarget = get_attstattarget(oldIndexId, att->attnum);
1802 :
1803 : /* no need for a refresh if both match */
788 michael 1804 CBC 309 : if (attstattarget == att->attstattarget)
1805 306 : continue;
1806 :
788 michael 1807 GIC 3 : memset(repl_val, 0, sizeof(repl_val));
1808 3 : memset(repl_null, false, sizeof(repl_null));
1809 3 : memset(repl_repl, false, sizeof(repl_repl));
788 michael 1810 ECB :
788 michael 1811 GIC 3 : repl_repl[Anum_pg_attribute_attstattarget - 1] = true;
12 peter 1812 GNC 3 : repl_val[Anum_pg_attribute_attstattarget - 1] = Int16GetDatum(attstattarget);
788 michael 1813 ECB :
788 michael 1814 CBC 3 : newTuple = heap_modify_tuple(attrTuple,
1815 : RelationGetDescr(pg_attribute),
788 michael 1816 ECB : repl_val, repl_null, repl_repl);
788 michael 1817 CBC 3 : CatalogTupleUpdate(pg_attribute, &newTuple->t_self, newTuple);
788 michael 1818 ECB :
788 michael 1819 GIC 3 : heap_freetuple(newTuple);
788 michael 1820 ECB : }
1821 :
788 michael 1822 GIC 207 : systable_endscan(scan);
788 michael 1823 CBC 207 : table_close(pg_attribute, RowExclusiveLock);
1824 : }
1825 :
1472 peter 1826 ECB : /* Close relations */
1472 peter 1827 GIC 207 : table_close(pg_class, RowExclusiveLock);
1472 peter 1828 CBC 207 : table_close(pg_index, RowExclusiveLock);
1472 peter 1829 GIC 207 : table_close(pg_constraint, RowExclusiveLock);
1830 207 : table_close(pg_trigger, RowExclusiveLock);
1472 peter 1831 ECB :
1832 : /* The lock taken previously is not released until the end of transaction */
1472 peter 1833 GIC 207 : relation_close(oldClassRel, NoLock);
1834 207 : relation_close(newClassRel, NoLock);
1835 207 : }
1472 peter 1836 ECB :
1837 : /*
1838 : * index_concurrently_set_dead
1839 : *
1840 : * Perform the last invalidation stage of DROP INDEX CONCURRENTLY or REINDEX
1841 : * CONCURRENTLY before actually dropping the index. After calling this
1842 : * function, the index is seen by all the backends as dead. Low-level locks
1843 : * taken here are kept until the end of the transaction calling this function.
1844 : */
1845 : void
1472 peter 1846 GIC 259 : index_concurrently_set_dead(Oid heapId, Oid indexId)
1847 : {
1848 : Relation userHeapRelation;
1849 : Relation userIndexRelation;
1850 :
1851 : /*
1852 : * No more predicate locks will be acquired on this index, and we're about
1853 : * to stop doing inserts into the index which could show conflicts with
1854 : * existing predicate locks, so now is the time to move them to the heap
1418 tgl 1855 ECB : * relation.
1856 : */
1472 peter 1857 GIC 259 : userHeapRelation = table_open(heapId, ShareUpdateExclusiveLock);
1858 259 : userIndexRelation = index_open(indexId, ShareUpdateExclusiveLock);
1859 259 : TransferPredicateLocksToHeapRelation(userIndexRelation);
1860 :
1861 : /*
1862 : * Now we are sure that nobody uses the index for queries; they just might
1863 : * have it open for updating it. So now we can unset indisready and
1864 : * indislive, then wait till nobody could be using it at all anymore.
1865 : */
1472 peter 1866 CBC 259 : index_set_state_flags(indexId, INDEX_DROP_SET_DEAD);
1472 peter 1867 ECB :
1868 : /*
1869 : * Invalidate the relcache for the table, so that after this commit all
1870 : * sessions will refresh the table's index list. Forgetting just the
1871 : * index's relcache entry is not enough.
1872 : */
1472 peter 1873 GIC 259 : CacheInvalidateRelcache(userHeapRelation);
1874 :
1472 peter 1875 ECB : /*
1876 : * Close the relations again, though still holding session lock.
1877 : */
1472 peter 1878 GIC 259 : table_close(userHeapRelation, NoLock);
1879 259 : index_close(userIndexRelation, NoLock);
1880 259 : }
1881 :
4457 tgl 1882 ECB : /*
1883 : * index_constraint_create
1884 : *
1885 : * Set up a constraint associated with an index. Return the new constraint's
1886 : * address.
1887 : *
1888 : * heapRelation: table owning the index (must be suitably locked by caller)
1889 : * indexRelationId: OID of the index
1890 : * parentConstraintId: if constraint is on a partition, the OID of the
1891 : * constraint in the parent.
1892 : * indexInfo: same info executor uses to insert into the index
1893 : * constraintName: what it say (generally, should match name of index)
1894 : * constraintType: one of CONSTRAINT_PRIMARY, CONSTRAINT_UNIQUE, or
1895 : * CONSTRAINT_EXCLUSION
1896 : * flags: bitmask that can include any combination of these bits:
1897 : * INDEX_CONSTR_CREATE_MARK_AS_PRIMARY: index is a PRIMARY KEY
1898 : * INDEX_CONSTR_CREATE_DEFERRABLE: constraint is DEFERRABLE
1899 : * INDEX_CONSTR_CREATE_INIT_DEFERRED: constraint is INITIALLY DEFERRED
1900 : * INDEX_CONSTR_CREATE_UPDATE_INDEX: update the pg_index row
1901 : * INDEX_CONSTR_CREATE_REMOVE_OLD_DEPS: remove existing dependencies
1902 : * of index on table's columns
1903 : * allow_system_table_mods: allow table to be a system catalog
1904 : * is_internal: index is constructed due to internal process
1905 : */
1906 : ObjectAddress
4457 tgl 1907 GIC 37544 : index_constraint_create(Relation heapRelation,
1908 : Oid indexRelationId,
1909 : Oid parentConstraintId,
1910 : IndexInfo *indexInfo,
1911 : const char *constraintName,
1912 : char constraintType,
1913 : bits16 constr_flags,
1914 : bool allow_system_table_mods,
1915 : bool is_internal)
4457 tgl 1916 ECB : {
4457 tgl 1917 GIC 37544 : Oid namespaceId = RelationGetNamespace(heapRelation);
1918 : ObjectAddress myself,
1919 : idxaddr;
1920 : Oid conOid;
1921 : bool deferrable;
1922 : bool initdeferred;
1923 : bool mark_as_primary;
1924 : bool islocal;
1925 : bool noinherit;
1875 alvherre 1926 ECB : int inhcount;
1927 :
1972 alvherre 1928 GIC 37544 : deferrable = (constr_flags & INDEX_CONSTR_CREATE_DEFERRABLE) != 0;
1929 37544 : initdeferred = (constr_flags & INDEX_CONSTR_CREATE_INIT_DEFERRED) != 0;
1930 37544 : mark_as_primary = (constr_flags & INDEX_CONSTR_CREATE_MARK_AS_PRIMARY) != 0;
1931 :
1932 : /* constraint creation support doesn't work while bootstrapping */
4457 tgl 1933 37544 : Assert(!IsBootstrapProcessingMode());
1934 :
1935 : /* enforce system-table restriction */
1936 41698 : if (!allow_system_table_mods &&
4457 tgl 1937 CBC 4154 : IsSystemRelation(heapRelation) &&
4457 tgl 1938 LBC 0 : IsNormalProcessingMode())
1939 0 : ereport(ERROR,
1940 : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1941 : errmsg("user-defined indexes on system catalog tables are not supported")));
4457 tgl 1942 ECB :
1943 : /* primary/unique constraints shouldn't have any expressions */
4457 tgl 1944 GIC 37544 : if (indexInfo->ii_Expressions &&
4457 tgl 1945 ECB : constraintType != CONSTRAINT_EXCLUSION)
4457 tgl 1946 LBC 0 : elog(ERROR, "constraints cannot have index expressions");
4457 tgl 1947 EUB :
3893 1948 : /*
1949 : * If we're manufacturing a constraint for a pre-existing index, we need
1950 : * to get rid of the existing auto dependencies for the index (the ones
1951 : * that index_create() would have made instead of calling this function).
1952 : *
3893 tgl 1953 ECB : * Note: this code would not necessarily do the right thing if the index
1954 : * has any expressions or predicate, but we'd never be turning such an
3893 tgl 1955 EUB : * index into a UNIQUE or PRIMARY KEY constraint.
1956 : */
1972 alvherre 1957 GIC 37544 : if (constr_flags & INDEX_CONSTR_CREATE_REMOVE_OLD_DEPS)
3893 tgl 1958 33355 : deleteDependencyRecordsForClass(RelationRelationId, indexRelationId,
1959 : RelationRelationId, DEPENDENCY_AUTO);
1960 :
1875 alvherre 1961 37544 : if (OidIsValid(parentConstraintId))
1962 : {
1963 576 : islocal = false;
1964 576 : inhcount = 1;
1965 576 : noinherit = false;
1875 alvherre 1966 ECB : }
1967 : else
1968 : {
1875 alvherre 1969 GIC 36968 : islocal = true;
1875 alvherre 1970 CBC 36968 : inhcount = 0;
1875 alvherre 1971 GIC 36968 : noinherit = true;
1875 alvherre 1972 ECB : }
1973 :
4457 tgl 1974 : /*
1975 : * Construct a pg_constraint entry.
1976 : */
4457 tgl 1977 GIC 37544 : conOid = CreateConstraintEntry(constraintName,
4457 tgl 1978 ECB : namespaceId,
1979 : constraintType,
1980 : deferrable,
1981 : initdeferred,
1982 : true,
1983 : parentConstraintId,
1984 : RelationGetRelid(heapRelation),
1823 teodor 1985 GIC 37544 : indexInfo->ii_IndexAttrNumbers,
1828 teodor 1986 ECB : indexInfo->ii_NumIndexKeyAttrs,
1987 : indexInfo->ii_NumIndexAttrs,
1988 : InvalidOid, /* no domain */
1989 : indexRelationId, /* index OID */
1990 : InvalidOid, /* no foreign key */
1991 : NULL,
1992 : NULL,
1993 : NULL,
4457 tgl 1994 : NULL,
1995 : 0,
1996 : ' ',
1997 : ' ',
1998 : NULL,
1999 : 0,
2000 : ' ',
4457 tgl 2001 GIC 37544 : indexInfo->ii_ExclusionOps,
2002 : NULL, /* no check constraint */
2003 : NULL,
2004 : islocal,
2005 : inhcount,
2006 : noinherit,
2007 : is_internal);
2008 :
2009 : /*
4457 tgl 2010 ECB : * Register the index as internally dependent on the constraint.
2011 : *
2012 : * Note that the constraint has a dependency on the table, so we don't
2013 : * need (or want) any direct dependency from the index to the table.
2014 : */
1480 alvherre 2015 GIC 37544 : ObjectAddressSet(myself, ConstraintRelationId, conOid);
2016 37544 : ObjectAddressSet(idxaddr, RelationRelationId, indexRelationId);
2017 37544 : recordDependencyOn(&idxaddr, &myself, DEPENDENCY_INTERNAL);
2018 :
2019 : /*
2020 : * Also, if this is a constraint on a partition, give it partition-type
2021 : * dependencies on the parent constraint as well as the table.
2022 : */
1875 2023 37544 : if (OidIsValid(parentConstraintId))
1875 alvherre 2024 ECB : {
1418 tgl 2025 : ObjectAddress referenced;
1480 alvherre 2026 :
1518 tgl 2027 GIC 576 : ObjectAddressSet(referenced, ConstraintRelationId, parentConstraintId);
2028 576 : recordDependencyOn(&myself, &referenced, DEPENDENCY_PARTITION_PRI);
2029 576 : ObjectAddressSet(referenced, RelationRelationId,
2030 : RelationGetRelid(heapRelation));
2031 576 : recordDependencyOn(&myself, &referenced, DEPENDENCY_PARTITION_SEC);
1875 alvherre 2032 ECB : }
2033 :
2034 : /*
2035 : * If the constraint is deferrable, create the deferred uniqueness
4382 bruce 2036 : * checking trigger. (The trigger will be given an internal dependency on
2037 : * the constraint by CreateTrigger.)
4457 tgl 2038 : */
4457 tgl 2039 GIC 37544 : if (deferrable)
4457 tgl 2040 ECB : {
876 tgl 2041 GIC 40 : CreateTrigStmt *trigger = makeNode(CreateTrigStmt);
2042 :
2043 40 : trigger->replace = false;
2044 40 : trigger->isconstraint = true;
4457 2045 40 : trigger->trigname = (constraintType == CONSTRAINT_PRIMARY) ?
2046 40 : "PK_ConstraintTrigger" :
2047 : "Unique_ConstraintTrigger";
3338 rhaas 2048 CBC 40 : trigger->relation = NULL;
4457 tgl 2049 GIC 40 : trigger->funcname = SystemFuncName("unique_key_recheck");
4457 tgl 2050 CBC 40 : trigger->args = NIL;
4457 tgl 2051 GIC 40 : trigger->row = true;
4457 tgl 2052 CBC 40 : trigger->timing = TRIGGER_TYPE_AFTER;
2053 40 : trigger->events = TRIGGER_TYPE_INSERT | TRIGGER_TYPE_UPDATE;
2054 40 : trigger->columns = NIL;
2055 40 : trigger->whenClause = NULL;
876 tgl 2056 GIC 40 : trigger->transitionRels = NIL;
4457 tgl 2057 CBC 40 : trigger->deferrable = true;
2058 40 : trigger->initdeferred = initdeferred;
2059 40 : trigger->constrrel = NULL;
4457 tgl 2060 ECB :
3338 rhaas 2061 CBC 40 : (void) CreateTrigger(trigger, NULL, RelationGetRelid(heapRelation),
1843 alvherre 2062 ECB : InvalidOid, conOid, indexRelationId, InvalidOid,
2063 : InvalidOid, NULL, true, false);
4457 tgl 2064 : }
2065 :
2066 : /*
2067 : * If needed, mark the index as primary and/or deferred in pg_index.
2068 : *
2069 : * Note: When making an existing index into a constraint, caller must have
3260 bruce 2070 : * a table lock that prevents concurrent table updates; otherwise, there
2071 : * is a risk that concurrent readers of the table will miss seeing this
2072 : * index at all.
2073 : */
1972 alvherre 2074 GIC 37544 : if ((constr_flags & INDEX_CONSTR_CREATE_UPDATE_INDEX) &&
2075 14548 : (mark_as_primary || deferrable))
2076 : {
2077 : Relation pg_index;
2078 : HeapTuple indexTuple;
2079 : Form_pg_index indexForm;
4382 bruce 2080 18807 : bool dirty = false;
442 tgl 2081 18807 : bool marked_as_primary = false;
2082 :
1539 andres 2083 CBC 18807 : pg_index = table_open(IndexRelationId, RowExclusiveLock);
4457 tgl 2084 ECB :
4457 tgl 2085 GIC 18807 : indexTuple = SearchSysCacheCopy1(INDEXRELID,
2086 : ObjectIdGetDatum(indexRelationId));
2087 18807 : if (!HeapTupleIsValid(indexTuple))
4457 tgl 2088 UIC 0 : elog(ERROR, "cache lookup failed for index %u", indexRelationId);
4457 tgl 2089 CBC 18807 : indexForm = (Form_pg_index) GETSTRUCT(indexTuple);
4457 tgl 2090 ECB :
4457 tgl 2091 GIC 18807 : if (mark_as_primary && !indexForm->indisprimary)
4457 tgl 2092 ECB : {
4457 tgl 2093 GIC 18807 : indexForm->indisprimary = true;
4457 tgl 2094 CBC 18807 : dirty = true;
442 tgl 2095 GIC 18807 : marked_as_primary = true;
4457 tgl 2096 ECB : }
4457 tgl 2097 EUB :
4457 tgl 2098 CBC 18807 : if (deferrable && indexForm->indimmediate)
2099 : {
4457 tgl 2100 LBC 0 : indexForm->indimmediate = false;
4457 tgl 2101 UIC 0 : dirty = true;
4457 tgl 2102 ECB : }
2103 :
4457 tgl 2104 CBC 18807 : if (dirty)
2105 : {
2259 alvherre 2106 GIC 18807 : CatalogTupleUpdate(pg_index, &indexTuple->t_self, indexTuple);
3675 rhaas 2107 ECB :
2108 : /*
442 tgl 2109 EUB : * When we mark an existing index as primary, force a relcache
2110 : * flush on its parent table, so that all sessions will become
2111 : * aware that the table now has a primary key. This is important
2112 : * because it affects some replication behaviors.
442 tgl 2113 ECB : */
442 tgl 2114 GIC 18807 : if (marked_as_primary)
442 tgl 2115 CBC 18807 : CacheInvalidateRelcache(heapRelation);
2116 :
3675 rhaas 2117 GIC 18807 : InvokeObjectPostAlterHookArg(IndexRelationId, indexRelationId, 0,
2118 : InvalidOid, is_internal);
2119 : }
2120 :
4457 tgl 2121 18807 : heap_freetuple(indexTuple);
1539 andres 2122 18807 : table_close(pg_index, RowExclusiveLock);
4457 tgl 2123 ECB : }
2937 alvherre 2124 :
1480 alvherre 2125 GIC 37544 : return myself;
4457 tgl 2126 ECB : }
2127 :
2128 : /*
2129 : * index_drop
9345 bruce 2130 : *
7576 tgl 2131 : * NOTE: this routine should now only be called through performDeletion(),
2132 : * else associated dependencies won't be cleaned up.
2133 : *
1472 peter 2134 : * If concurrent is true, do a DROP INDEX CONCURRENTLY. If concurrent is
2135 : * false but concurrent_lock_mode is true, then do a normal DROP INDEX but
2136 : * take a lock for CONCURRENTLY processing. That is used as part of REINDEX
2137 : * CONCURRENTLY.
2138 : */
2139 : void
1472 peter 2140 GIC 10275 : index_drop(Oid indexId, bool concurrent, bool concurrent_lock_mode)
2141 : {
2142 : Oid heapId;
2143 : Relation userHeapRelation;
2144 : Relation userIndexRelation;
2145 : Relation indexRelation;
2146 : HeapTuple tuple;
2147 : bool hasexprs;
2148 : LockRelId heaprelid,
4020 simon 2149 ECB : indexrelid;
2150 : LOCKTAG heaplocktag;
2151 : LOCKMODE lockmode;
2152 :
2153 : /*
2154 : * A temporary relation uses a non-concurrent DROP. Other backends can't
2155 : * access a temporary relation, so there's no harm in grabbing a stronger
2156 : * lock (see comments in RemoveRelations), and a non-concurrent DROP is
2157 : * more efficient.
2158 : */
1173 michael 2159 GIC 10275 : Assert(get_rel_persistence(indexId) != RELPERSISTENCE_TEMP ||
2160 : (!concurrent && !concurrent_lock_mode));
2161 :
2162 : /*
2163 : * To drop an index safely, we must grab exclusive lock on its parent
2164 : * table. Exclusive lock on the index alone is insufficient because
2165 : * another backend might be about to execute a query on the parent table.
2166 : * If it relies on a previously cached list of index OIDs, then it could
2167 : * attempt to access the just-dropped index. We must therefore take a
5061 tgl 2168 ECB : * table lock strong enough to prevent all queries on the table from
2169 : * proceeding until we commit and send out a shared-cache-inval notice
2170 : * that will make them update their index lists.
2171 : *
2172 : * In the concurrent case we avoid this requirement by disabling index use
2173 : * in multiple steps and waiting out any transactions that might be using
2174 : * the index, so we don't need exclusive lock on the parent table. Instead
2175 : * we take ShareUpdateExclusiveLock, to ensure that two sessions aren't
2176 : * doing CREATE/DROP INDEX CONCURRENTLY on the same index. (We will get
2177 : * AccessExclusiveLock on the index below, once we're sure nobody else is
2178 : * using it.)
2179 : */
4148 rhaas 2180 GIC 10275 : heapId = IndexGetRelation(indexId, false);
1472 peter 2181 10275 : lockmode = (concurrent || concurrent_lock_mode) ? ShareUpdateExclusiveLock : AccessExclusiveLock;
1539 andres 2182 10275 : userHeapRelation = table_open(heapId, lockmode);
3784 tgl 2183 10275 : userIndexRelation = index_open(indexId, lockmode);
2184 :
2185 : /*
2186 : * We might still have open queries using it in our own session, which the
2187 : * above locking won't prevent, so test explicitly.
2188 : */
4436 tgl 2189 CBC 10275 : CheckTableNotInUse(userIndexRelation, "DROP INDEX");
4436 tgl 2190 ECB :
4020 simon 2191 : /*
3784 tgl 2192 : * Drop Index Concurrently is more or less the reverse process of Create
2193 : * Index Concurrently.
2194 : *
2195 : * First we unset indisvalid so queries starting afterwards don't use the
2196 : * index to answer queries anymore. We have to keep indisready = true so
2197 : * transactions that are still scanning the index can continue to see
2198 : * valid index contents. For instance, if they are using READ COMMITTED
2199 : * mode, and another transaction makes changes and commits, they need to
2200 : * see those new tuples in the index.
2201 : *
2202 : * After all transactions that could possibly have used the index for
2203 : * queries end, we can unset indisready and indislive, then wait till
2204 : * nobody could be touching it anymore. (Note: we need indislive because
2205 : * this state must be distinct from the initial state during CREATE INDEX
2206 : * CONCURRENTLY, which has indislive true while indisready and indisvalid
2207 : * are false. That's because in that state, transactions must examine the
2208 : * index for HOT-safety decisions, while in this state we don't want them
2209 : * to open it at all.)
2210 : *
2211 : * Since all predicate locks on the index are about to be made invalid, we
2212 : * must promote them to predicate locks on the heap. In the
2213 : * non-concurrent case we can just do that now. In the concurrent case
2214 : * it's a bit trickier. The predicate locks must be moved when there are
2215 : * no index scans in progress on the index and no more can subsequently
2216 : * start, so that no new predicate locks can be made on the index. Also,
2217 : * they must be moved before heap inserts stop maintaining the index, else
2218 : * the conflict with the predicate lock on the index gap could be missed
2219 : * before the lock on the heap relation is in place to detect a conflict
2220 : * based on the heap tuple insert.
2221 : */
4020 simon 2222 GIC 10275 : if (concurrent)
2223 : {
2224 : /*
2225 : * We must commit our transaction in order to make the first pg_index
2226 : * state update visible to other sessions. If the DROP machinery has
2227 : * already performed any other actions (removal of other objects,
2228 : * pg_depend entries, etc), the commit would make those actions
2229 : * permanent, which would leave us with inconsistent catalog state if
2230 : * we fail partway through the following sequence. Since DROP INDEX
3784 tgl 2231 ECB : * CONCURRENTLY is restricted to dropping just one index that has no
2232 : * dependencies, we should get here before anything's been done ---
2233 : * but let's check that to be sure. We can verify that the current
2234 : * transaction has not executed any transactional updates by checking
2235 : * that no XID has been assigned.
2236 : */
3784 tgl 2237 GIC 52 : if (GetTopTransactionIdIfAny() != InvalidTransactionId)
3784 tgl 2238 UIC 0 : ereport(ERROR,
2239 : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
2240 : errmsg("DROP INDEX CONCURRENTLY must be first action in transaction")));
2241 :
2242 : /*
2243 : * Mark index invalid by updating its pg_index entry
2244 : */
3784 tgl 2245 GIC 52 : index_set_state_flags(indexId, INDEX_DROP_CLEAR_VALID);
4020 simon 2246 ECB :
3784 tgl 2247 EUB : /*
2248 : * Invalidate the relcache for the table, so that after this commit
2249 : * all sessions will refresh any cached plans that might reference the
2250 : * index.
2251 : */
3784 tgl 2252 GIC 52 : CacheInvalidateRelcache(userHeapRelation);
2253 :
4020 simon 2254 ECB : /* save lockrelid and locktag for below, then close but keep locks */
4020 simon 2255 GIC 52 : heaprelid = userHeapRelation->rd_lockInfo.lockRelId;
2256 52 : SET_LOCKTAG_RELATION(heaplocktag, heaprelid.dbId, heaprelid.relId);
2257 52 : indexrelid = userIndexRelation->rd_lockInfo.lockRelId;
2258 :
1539 andres 2259 52 : table_close(userHeapRelation, NoLock);
4020 simon 2260 52 : index_close(userIndexRelation, NoLock);
4020 simon 2261 ECB :
2262 : /*
2263 : * We must commit our current transaction so that the indisvalid
3784 tgl 2264 : * update becomes visible to other transactions; then start another.
2265 : * Note that any previously-built data structures are lost in the
3260 bruce 2266 : * commit. The only data we keep past here are the relation IDs.
2267 : *
4020 simon 2268 : * Before committing, get a session-level lock on the table, to ensure
2269 : * that neither it nor the index can be dropped before we finish. This
2270 : * cannot block, even if someone else is waiting for access, because
2271 : * we already have the same lock within our transaction.
2272 : */
4020 simon 2273 GIC 52 : LockRelationIdForSession(&heaprelid, ShareUpdateExclusiveLock);
2274 52 : LockRelationIdForSession(&indexrelid, ShareUpdateExclusiveLock);
2275 :
2276 52 : PopActiveSnapshot();
2277 52 : CommitTransactionCommand();
2278 52 : StartTransactionCommand();
2279 :
2280 : /*
2281 : * Now we must wait until no running transaction could be using the
3383 alvherre 2282 ECB : * index for a query. Use AccessExclusiveLock here to check for
3260 bruce 2283 : * running transactions that hold locks of any kind on the table. Note
2284 : * we do not need to worry about xacts that open the table for reading
2285 : * after this point; they will see the index as invalid when they open
2286 : * the relation.
4020 simon 2287 : *
2288 : * Note: the reason we use actual lock acquisition here, rather than
2289 : * just checking the ProcArray and sleeping, is that deadlock is
2290 : * possible if one of the transactions in question is blocked trying
2291 : * to acquire an exclusive lock on our table. The lock code will
2292 : * detect deadlock and error out properly.
2293 : *
2294 : * Note: we report progress through WaitForLockers() unconditionally
2295 : * here, even though it will only be used when we're called by REINDEX
2296 : * CONCURRENTLY and not when called by DROP INDEX CONCURRENTLY.
2297 : */
1468 alvherre 2298 GIC 52 : WaitForLockers(heaplocktag, AccessExclusiveLock, true);
2299 :
2300 : /* Finish invalidation of index and mark it as dead */
1472 peter 2301 52 : index_concurrently_set_dead(heapId, indexId);
2302 :
2303 : /*
2304 : * Again, commit the transaction to make the pg_index update visible
2305 : * to other sessions.
2306 : */
3825 simon 2307 CBC 52 : CommitTransactionCommand();
3825 simon 2308 GIC 52 : StartTransactionCommand();
2309 :
3825 simon 2310 ECB : /*
2311 : * Wait till every transaction that saw the old index state has
2312 : * finished. See above about progress reporting.
2313 : */
1468 alvherre 2314 GIC 52 : WaitForLockers(heaplocktag, AccessExclusiveLock, true);
2315 :
4020 simon 2316 ECB : /*
2317 : * Re-open relations to allow us to complete our actions.
2318 : *
2319 : * At this point, nothing should be accessing the index, but lets
2320 : * leave nothing to chance and grab AccessExclusiveLock on the index
2321 : * before the physical deletion.
2322 : */
1539 andres 2323 CBC 52 : userHeapRelation = table_open(heapId, ShareUpdateExclusiveLock);
4020 simon 2324 GIC 52 : userIndexRelation = index_open(indexId, AccessExclusiveLock);
2325 : }
2326 : else
2327 : {
2328 : /* Not concurrent, so just transfer predicate locks and we're good */
3822 kgrittn 2329 10223 : TransferPredicateLocksToHeapRelation(userIndexRelation);
2330 : }
2331 :
8053 bruce 2332 ECB : /*
1906 alvherre 2333 : * Schedule physical removal of the files (if any)
2334 : */
492 peter 2335 GIC 10275 : if (RELKIND_HAS_STORAGE(userIndexRelation->rd_rel->relkind))
1906 alvherre 2336 9594 : RelationDropStorage(userIndexRelation);
2337 :
198 andres 2338 ECB : /* ensure that stats are dropped if transaction commits */
198 andres 2339 GIC 10275 : pgstat_drop_relation(userIndexRelation);
2340 :
2341 : /*
2342 : * Close and flush the index's relcache entry, to ensure relcache doesn't
2343 : * try to rebuild it while we're deleting catalog entries. We keep the
6385 bruce 2344 ECB : * lock though.
9345 2345 : */
6096 tgl 2346 GIC 10275 : index_close(userIndexRelation, NoLock);
2347 :
6798 tgl 2348 CBC 10275 : RelationForgetRelation(indexId);
2349 :
2350 : /*
2351 : * fix INDEX relation, and check for expressional index
2352 : */
1539 andres 2353 GIC 10275 : indexRelation = table_open(IndexRelationId, RowExclusiveLock);
2354 :
4802 rhaas 2355 CBC 10275 : tuple = SearchSysCache1(INDEXRELID, ObjectIdGetDatum(indexId));
8179 tgl 2356 GIC 10275 : if (!HeapTupleIsValid(tuple))
7202 tgl 2357 LBC 0 : elog(ERROR, "cache lookup failed for index %u", indexId);
2358 :
1838 andrew 2359 GIC 10275 : hasexprs = !heap_attisnull(tuple, Anum_pg_index_indexprs,
2360 10275 : RelationGetDescr(indexRelation));
2361 :
2258 tgl 2362 CBC 10275 : CatalogTupleDelete(indexRelation, &tuple->t_self);
2363 :
7574 2364 10275 : ReleaseSysCache(tuple);
1539 andres 2365 10275 : table_close(indexRelation, RowExclusiveLock);
9345 bruce 2366 EUB :
2367 : /*
6385 bruce 2368 ECB : * if it has any expression columns, we might have stored statistics about
2369 : * them.
2370 : */
6993 tgl 2371 CBC 10275 : if (hasexprs)
6798 tgl 2372 GIC 292 : RemoveStatistics(indexId, 0);
6993 tgl 2373 ECB :
9345 bruce 2374 : /*
2375 : * fix ATTRIBUTE relation
2376 : */
6798 tgl 2377 GIC 10275 : DeleteAttributeTuples(indexId);
2378 :
2379 : /*
6798 tgl 2380 ECB : * fix RELATION relation
2381 : */
6798 tgl 2382 GIC 10275 : DeleteRelationTuple(indexId);
2383 :
2384 : /*
2385 : * fix INHERITS relation
1906 alvherre 2386 ECB : */
745 alvherre 2387 GIC 10275 : DeleteInheritsTuple(indexId, InvalidOid, false, NULL);
2388 :
2389 : /*
2390 : * We are presently too lazy to attempt to compute the new correct value
6385 bruce 2391 ECB : * of relhasindex (the next VACUUM will fix it if necessary). So there is
2392 : * no need to update the pg_class tuple for the owning relation. But we
2393 : * must send out a shared-cache-inval notice on the owning relation to
2394 : * ensure other backends update their relcache lists of indexes. (In the
2395 : * concurrent case, this is redundant but harmless.)
7707 tgl 2396 : */
6998 tgl 2397 GIC 10275 : CacheInvalidateRelcache(userHeapRelation);
2398 :
2399 : /*
2400 : * Close owning rel, but keep lock
2401 : */
1539 andres 2402 10275 : table_close(userHeapRelation, NoLock);
2403 :
2404 : /*
2405 : * Release the session locks before we go.
4020 simon 2406 ECB : */
4020 simon 2407 GIC 10275 : if (concurrent)
2408 : {
2409 52 : UnlockRelationIdForSession(&heaprelid, ShareUpdateExclusiveLock);
2410 52 : UnlockRelationIdForSession(&indexrelid, ShareUpdateExclusiveLock);
4020 simon 2411 ECB : }
9770 scrappy 2412 GIC 10275 : }
2413 :
2414 : /* ----------------------------------------------------------------
2415 : * index_build support
9770 scrappy 2416 ECB : * ----------------------------------------------------------------
2417 : */
8304 tgl 2418 :
2419 : /* ----------------
2420 : * BuildIndexInfo
7256 2421 : * Construct an IndexInfo record for an open index
2422 : *
2423 : * IndexInfo stores the information about the index that's needed by
2424 : * FormIndexDatum, which is used for both index_build() and later insertion
2425 : * of individual index tuples. Normally we build an IndexInfo for an index
2426 : * just once per command, and then use it for (potentially) many tuples.
2427 : * ----------------
2428 : */
2429 : IndexInfo *
7256 tgl 2430 GIC 4180686 : BuildIndexInfo(Relation index)
2431 : {
2432 : IndexInfo *ii;
2433 4180686 : Form_pg_index indexStruct = index->rd_index;
2434 : int i;
2435 : int numAtts;
2436 :
2437 : /* check the number of keys, and copy attr numbers into the IndexInfo */
1828 teodor 2438 4180686 : numAtts = indexStruct->indnatts;
1828 teodor 2439 CBC 4180686 : if (numAtts < 1 || numAtts > INDEX_MAX_KEYS)
7256 tgl 2440 UIC 0 : elog(ERROR, "invalid indnatts %d for index %u",
2441 : numAtts, RelationGetRelid(index));
1828 teodor 2442 ECB :
2443 : /*
2444 : * Create the node, fetching any expressions needed for expressional
2445 : * indexes and index predicate if any.
2446 : */
1344 michael 2447 CBC 4180686 : ii = makeIndexInfo(indexStruct->indnatts,
2448 4180685 : indexStruct->indnkeyatts,
1344 michael 2449 GBC 4180685 : index->rd_rel->relam,
2450 : RelationGetIndexExpressions(index),
2451 : RelationGetIndexPredicate(index),
1344 michael 2452 GIC 4180686 : indexStruct->indisunique,
430 peter 2453 4180686 : indexStruct->indnullsnotdistinct,
1344 michael 2454 4180686 : indexStruct->indisready,
2455 : false,
20 tomas.vondra 2456 GNC 4180686 : index->rd_indam->amsummarizing);
1344 michael 2457 ECB :
2458 : /* fill in attribute numbers */
1828 teodor 2459 CBC 13224817 : for (i = 0; i < numAtts; i++)
1823 teodor 2460 GIC 9044132 : ii->ii_IndexAttrNumbers[i] = indexStruct->indkey.values[i];
2461 :
4871 tgl 2462 ECB : /* fetch exclusion constraint info if any */
4457 tgl 2463 CBC 4180685 : if (indexStruct->indisexclusion)
4871 tgl 2464 ECB : {
4871 tgl 2465 GIC 161 : RelationGetExclusionInfo(index,
4871 tgl 2466 ECB : &ii->ii_ExclusionOps,
2467 : &ii->ii_ExclusionProcs,
2468 : &ii->ii_ExclusionStrats);
2469 : }
2250 2470 :
1105 akorotkov 2471 GIC 4180685 : ii->ii_OpclassOptions = RelationGetIndexRawAttOptions(index);
2472 :
8304 tgl 2473 CBC 4180685 : return ii;
2474 : }
8304 tgl 2475 ECB :
2476 : /* ----------------
2477 : * BuildDummyIndexInfo
2478 : * Construct a dummy IndexInfo record for an open index
2479 : *
2480 : * This differs from the real BuildIndexInfo in that it will never run any
1225 2481 : * user-defined code that might exist in index expressions or predicates.
2482 : * Instead of the real index expressions, we return null constants that have
2483 : * the right types/typmods/collations. Predicates and exclusion clauses are
2484 : * just ignored. This is sufficient for the purpose of truncating an index,
2485 : * since we will not need to actually evaluate the expressions or predicates;
2486 : * the only thing that's likely to be done with the data is construction of
2487 : * a tupdesc describing the index's rowtype.
2488 : * ----------------
2489 : */
2490 : IndexInfo *
1225 tgl 2491 GIC 97 : BuildDummyIndexInfo(Relation index)
2492 : {
2493 : IndexInfo *ii;
2494 97 : Form_pg_index indexStruct = index->rd_index;
2495 : int i;
2496 : int numAtts;
2497 :
2498 : /* check the number of keys, and copy attr numbers into the IndexInfo */
2499 97 : numAtts = indexStruct->indnatts;
2500 97 : if (numAtts < 1 || numAtts > INDEX_MAX_KEYS)
1225 tgl 2501 LBC 0 : elog(ERROR, "invalid indnatts %d for index %u",
2502 : numAtts, RelationGetRelid(index));
2503 :
1225 tgl 2504 ECB : /*
2505 : * Create the node, using dummy index expressions, and pretending there is
2506 : * no predicate.
2507 : */
1225 tgl 2508 GIC 194 : ii = makeIndexInfo(indexStruct->indnatts,
1225 tgl 2509 CBC 97 : indexStruct->indnkeyatts,
2510 97 : index->rd_rel->relam,
1225 tgl 2511 EUB : RelationGetDummyIndexExpressions(index),
2512 : NIL,
1225 tgl 2513 GIC 97 : indexStruct->indisunique,
430 peter 2514 97 : indexStruct->indnullsnotdistinct,
1225 tgl 2515 97 : indexStruct->indisready,
2516 : false,
20 tomas.vondra 2517 GNC 97 : index->rd_indam->amsummarizing);
2518 :
1225 tgl 2519 ECB : /* fill in attribute numbers */
1225 tgl 2520 CBC 250 : for (i = 0; i < numAtts; i++)
2521 153 : ii->ii_IndexAttrNumbers[i] = indexStruct->indkey.values[i];
2522 :
2523 : /* We ignore the exclusion constraint if any */
1225 tgl 2524 ECB :
1225 tgl 2525 CBC 97 : return ii;
1225 tgl 2526 ECB : }
2527 :
1906 alvherre 2528 : /*
2529 : * CompareIndexInfo
2530 : * Return whether the properties of two indexes (in different tables)
2531 : * indicate that they have the "same" definitions.
2532 : *
2533 : * Note: passing collations and opfamilies separately is a kludge. Adding
2534 : * them to IndexInfo may result in better coding here and elsewhere.
2535 : *
1208 michael 2536 : * Use build_attrmap_by_name(index2, index1) to build the attmap.
2537 : */
2538 : bool
1906 alvherre 2539 GIC 311 : CompareIndexInfo(IndexInfo *info1, IndexInfo *info2,
2540 : Oid *collations1, Oid *collations2,
2541 : Oid *opfamilies1, Oid *opfamilies2,
2542 : AttrMap *attmap)
2543 : {
2544 : int i;
2545 :
2546 311 : if (info1->ii_Unique != info2->ii_Unique)
1906 alvherre 2547 UIC 0 : return false;
2548 :
430 peter 2549 GIC 311 : if (info1->ii_NullsNotDistinct != info2->ii_NullsNotDistinct)
430 peter 2550 LBC 0 : return false;
2551 :
2552 : /* indexes are only equivalent if they have the same access method */
1906 alvherre 2553 GIC 311 : if (info1->ii_Am != info2->ii_Am)
2554 6 : return false;
2555 :
2556 : /* and same number of attributes */
1906 alvherre 2557 CBC 305 : if (info1->ii_NumIndexAttrs != info2->ii_NumIndexAttrs)
1906 alvherre 2558 GBC 12 : return false;
2559 :
1823 teodor 2560 ECB : /* and same number of key attributes */
1823 teodor 2561 GBC 293 : if (info1->ii_NumIndexKeyAttrs != info2->ii_NumIndexKeyAttrs)
1823 teodor 2562 UIC 0 : return false;
2563 :
1906 alvherre 2564 ECB : /*
2565 : * and columns match through the attribute map (actual attribute numbers
2566 : * might differ!) Note that this implies that index columns that are
2567 : * expressions appear in the same positions. We will next compare the
2568 : * expressions themselves.
2569 : */
1906 alvherre 2570 GIC 606 : for (i = 0; i < info1->ii_NumIndexAttrs; i++)
2571 : {
1208 michael 2572 CBC 331 : if (attmap->maplen < info2->ii_IndexAttrNumbers[i])
1906 alvherre 2573 UBC 0 : elog(ERROR, "incorrect attribute map");
2574 :
2575 : /* ignore expressions at this stage */
1823 teodor 2576 GIC 331 : if ((info1->ii_IndexAttrNumbers[i] != InvalidAttrNumber) &&
1208 michael 2577 310 : (attmap->attnums[info2->ii_IndexAttrNumbers[i] - 1] !=
1809 tgl 2578 310 : info1->ii_IndexAttrNumbers[i]))
1906 alvherre 2579 6 : return false;
2580 :
1823 teodor 2581 ECB : /* collation and opfamily is not valid for including columns */
1823 teodor 2582 GIC 325 : if (i >= info1->ii_NumIndexKeyAttrs)
1823 teodor 2583 CBC 7 : continue;
1823 teodor 2584 EUB :
1906 alvherre 2585 GIC 318 : if (collations1[i] != collations2[i])
2586 6 : return false;
1906 alvherre 2587 CBC 312 : if (opfamilies1[i] != opfamilies2[i])
2588 6 : return false;
1906 alvherre 2589 ECB : }
2590 :
2591 : /*
2592 : * For expression indexes: either both are expression indexes, or neither
2593 : * is; if they are, make sure the expressions match.
2594 : */
1906 alvherre 2595 GIC 275 : if ((info1->ii_Expressions != NIL) != (info2->ii_Expressions != NIL))
1906 alvherre 2596 CBC 3 : return false;
2597 272 : if (info1->ii_Expressions != NIL)
1906 alvherre 2598 ECB : {
1809 tgl 2599 : bool found_whole_row;
2600 : Node *mapped;
2601 :
1906 alvherre 2602 GIC 18 : mapped = map_variable_attnos((Node *) info2->ii_Expressions,
2603 : 1, 0, attmap,
2604 : InvalidOid, &found_whole_row);
2605 18 : if (found_whole_row)
1906 alvherre 2606 ECB : {
2607 : /*
2608 : * we could throw an error here, but seems out of scope for this
2609 : * routine.
2610 : */
1906 alvherre 2611 GIC 3 : return false;
2612 : }
1906 alvherre 2613 ECB :
1906 alvherre 2614 GIC 18 : if (!equal(info1->ii_Expressions, mapped))
2615 3 : return false;
1906 alvherre 2616 ECB : }
2617 :
2618 : /* Partial index predicates must be identical, if they exist */
1906 alvherre 2619 GIC 269 : if ((info1->ii_Predicate == NULL) != (info2->ii_Predicate == NULL))
2620 6 : return false;
2621 263 : if (info1->ii_Predicate != NULL)
1906 alvherre 2622 ECB : {
2623 : bool found_whole_row;
2624 : Node *mapped;
2625 :
1906 alvherre 2626 CBC 12 : mapped = map_variable_attnos((Node *) info2->ii_Predicate,
2627 : 1, 0, attmap,
2628 : InvalidOid, &found_whole_row);
1906 alvherre 2629 GIC 12 : if (found_whole_row)
1906 alvherre 2630 ECB : {
2631 : /*
2632 : * we could throw an error here, but seems out of scope for this
2633 : * routine.
2634 : */
1906 alvherre 2635 GIC 3 : return false;
2636 : }
1906 alvherre 2637 CBC 12 : if (!equal(info1->ii_Predicate, mapped))
1906 alvherre 2638 GIC 3 : return false;
2639 : }
1906 alvherre 2640 ECB :
2641 : /* No support currently for comparing exclusion indexes. */
1906 alvherre 2642 GIC 260 : if (info1->ii_ExclusionOps != NULL || info2->ii_ExclusionOps != NULL)
1906 alvherre 2643 UIC 0 : return false;
2644 :
1906 alvherre 2645 GIC 260 : return true;
1906 alvherre 2646 ECB : }
2647 :
2893 andres 2648 : /* ----------------
2649 : * BuildSpeculativeIndexInfo
2650 : * Add extra state to IndexInfo record
2651 : *
2652 : * For unique indexes, we usually don't want to add info to the IndexInfo for
2653 : * checking uniqueness, since the B-Tree AM handles that directly. However,
2893 andres 2654 EUB : * in the case of speculative insertion, additional support is required.
2655 : *
2893 andres 2656 ECB : * Do this processing here rather than in BuildIndexInfo() to not incur the
2657 : * overhead in the common non-speculative cases.
2658 : * ----------------
2659 : */
2660 : void
2893 andres 2661 GIC 603 : BuildSpeculativeIndexInfo(Relation index, IndexInfo *ii)
2662 : {
2663 : int indnkeyatts;
2664 : int i;
2665 :
1828 teodor 2666 603 : indnkeyatts = IndexRelationGetNumberOfKeyAttributes(index);
2667 :
2668 : /*
2669 : * fetch info for checking unique indexes
2670 : */
2893 andres 2671 603 : Assert(ii->ii_Unique);
2893 andres 2672 ECB :
2893 andres 2673 GIC 603 : if (index->rd_rel->relam != BTREE_AM_OID)
2893 andres 2674 UIC 0 : elog(ERROR, "unexpected non-btree speculative unique index");
2675 :
1828 teodor 2676 GIC 603 : ii->ii_UniqueOps = (Oid *) palloc(sizeof(Oid) * indnkeyatts);
1828 teodor 2677 CBC 603 : ii->ii_UniqueProcs = (Oid *) palloc(sizeof(Oid) * indnkeyatts);
1828 teodor 2678 GIC 603 : ii->ii_UniqueStrats = (uint16 *) palloc(sizeof(uint16) * indnkeyatts);
2679 :
2680 : /*
2681 : * We have to look up the operator's strategy number. This provides a
2878 bruce 2682 ECB : * cross-check that the operator does match the index.
2683 : */
2893 andres 2684 : /* We need the func OIDs and strategy numbers too */
1828 teodor 2685 GBC 1248 : for (i = 0; i < indnkeyatts; i++)
2686 : {
2893 andres 2687 CBC 645 : ii->ii_UniqueStrats[i] = BTEqualStrategyNumber;
2688 1290 : ii->ii_UniqueOps[i] =
2689 645 : get_opfamily_member(index->rd_opfamily[i],
2893 andres 2690 GIC 645 : index->rd_opcintype[i],
2691 645 : index->rd_opcintype[i],
2692 645 : ii->ii_UniqueStrats[i]);
2085 tgl 2693 645 : if (!OidIsValid(ii->ii_UniqueOps[i]))
2085 tgl 2694 UIC 0 : elog(ERROR, "missing operator %d(%u,%u) in opfamily %u",
2695 : ii->ii_UniqueStrats[i], index->rd_opcintype[i],
2085 tgl 2696 ECB : index->rd_opcintype[i], index->rd_opfamily[i]);
2893 andres 2697 GIC 645 : ii->ii_UniqueProcs[i] = get_opcode(ii->ii_UniqueOps[i]);
2893 andres 2698 ECB : }
2893 andres 2699 CBC 603 : }
2893 andres 2700 ECB :
9770 scrappy 2701 : /* ----------------
9345 bruce 2702 : * FormIndexDatum
6593 tgl 2703 : * Construct values[] and isnull[] arrays for a new index tuple.
8304 2704 : *
8304 tgl 2705 EUB : * indexInfo Info about the index
2706 : * slot Heap tuple for which we must prepare an index entry
2707 : * estate executor state for evaluating any index expressions
6593 tgl 2708 ECB : * values Array of index Datums (output area)
2709 : * isnull Array of is-null indicators (output area)
8304 2710 : *
2711 : * When there are no index expressions, estate may be NULL. Otherwise it
2712 : * must be supplied, *and* the ecxt_scantuple slot of its per-tuple expr
2713 : * context must point to the heap tuple passed in.
2714 : *
2715 : * Notice we don't actually call index_form_tuple() here; we just prepare
2716 : * its input arrays values[] and isnull[]. This is because the index AM
2717 : * may wish to alter the data before storage.
2718 : * ----------------
2719 : */
2720 : void
8304 tgl 2721 GIC 21835514 : FormIndexDatum(IndexInfo *indexInfo,
2722 : TupleTableSlot *slot,
2723 : EState *estate,
2724 : Datum *values,
2725 : bool *isnull)
2726 : {
2727 : ListCell *indexpr_item;
2728 : int i;
2729 :
7256 2730 21835514 : if (indexInfo->ii_Expressions != NIL &&
2731 285740 : indexInfo->ii_ExpressionsState == NIL)
9345 bruce 2732 ECB : {
2733 : /* First time through, set up expression evaluation state */
2217 andres 2734 GIC 353 : indexInfo->ii_ExpressionsState =
2735 353 : ExecPrepareExprList(indexInfo->ii_Expressions, estate);
2736 : /* Check caller has set up context correctly */
6598 tgl 2737 353 : Assert(GetPerTupleExprContext(estate)->ecxt_scantuple == slot);
2738 : }
6892 neilc 2739 21835514 : indexpr_item = list_head(indexInfo->ii_ExpressionsState);
2740 :
7256 tgl 2741 CBC 62784483 : for (i = 0; i < indexInfo->ii_NumIndexAttrs; i++)
7256 tgl 2742 ECB : {
1823 teodor 2743 GIC 40948975 : int keycol = indexInfo->ii_IndexAttrNumbers[i];
2744 : Datum iDatum;
7256 tgl 2745 ECB : bool isNull;
8990 bruce 2746 :
1605 andres 2747 GIC 40948975 : if (keycol < 0)
1605 andres 2748 LBC 0 : iDatum = slot_getsysattr(slot, keycol, &isNull);
1605 andres 2749 GIC 40948975 : else if (keycol != 0)
8304 tgl 2750 ECB : {
2751 : /*
7256 2752 : * Plain index column; get the value we need directly from the
2753 : * heap tuple.
2754 : */
6598 tgl 2755 GIC 40663208 : iDatum = slot_getattr(slot, keycol, &isNull);
2756 : }
2757 : else
8304 tgl 2758 ECB : {
7256 tgl 2759 EUB : /*
7256 tgl 2760 ECB : * Index expression --- need to evaluate it.
2761 : */
6892 neilc 2762 GIC 285767 : if (indexpr_item == NULL)
7256 tgl 2763 UIC 0 : elog(ERROR, "wrong number of index expressions");
6892 neilc 2764 GIC 285767 : iDatum = ExecEvalExprSwitchContext((ExprState *) lfirst(indexpr_item),
6385 bruce 2765 285767 : GetPerTupleExprContext(estate),
2271 andres 2766 ECB : &isNull);
1364 tgl 2767 GIC 285761 : indexpr_item = lnext(indexInfo->ii_ExpressionsState, indexpr_item);
2768 : }
6593 2769 40948969 : values[i] = iDatum;
2770 40948969 : isnull[i] = isNull;
2771 : }
2772 :
6892 neilc 2773 CBC 21835508 : if (indexpr_item != NULL)
7256 tgl 2774 UBC 0 : elog(ERROR, "wrong number of index expressions");
9770 scrappy 2775 CBC 21835508 : }
9770 scrappy 2776 ECB :
2777 :
6178 tgl 2778 : /*
2779 : * index_update_stats --- update pg_class entry after CREATE INDEX or REINDEX
2780 : *
2781 : * This routine updates the pg_class row of either an index or its parent
2782 : * relation after CREATE INDEX or REINDEX. Its rather bizarre API is designed
2783 : * to ensure we can do all the necessary work in just one update.
8187 2784 : *
6178 tgl 2785 EUB : * hasindex: set relhasindex to this value
4195 tgl 2786 ECB : * reltuples: if >= 0, set reltuples to this value; else no change
2787 : *
2788 : * If reltuples >= 0, relpages and relallvisible are also updated (using
2789 : * RelationGetNumberOfBlocks() and visibilitymap_count()).
2790 : *
2791 : * NOTE: an important side-effect of this operation is that an SI invalidation
2792 : * message is sent out to all backends --- including me --- causing relcache
2793 : * entries to be flushed or updated with the new data. This must happen even
2794 : * if we find that no change is needed in the pg_class row. When updating
2795 : * a heap entry, this ensures that other backends find out about the new
2796 : * index. When updating an index, it's important because some index AMs
2797 : * expect a relcache flush to occur after REINDEX.
2798 : */
2799 : static void
4871 tgl 2800 GIC 131152 : index_update_stats(Relation rel,
2801 : bool hasindex,
2802 : double reltuples)
2803 : {
6178 2804 131152 : Oid relid = RelationGetRelid(rel);
2805 : Relation pg_class;
2806 : HeapTuple tuple;
2807 : Form_pg_class rd_rel;
2808 : bool dirty;
2809 :
2810 : /*
6096 tgl 2811 ECB : * We always update the pg_class row using a non-transactional,
2812 : * overwrite-in-place update. There are several reasons for this:
2813 : *
2814 : * 1. In bootstrap mode, we have no choice --- UPDATE wouldn't work.
2815 : *
2816 : * 2. We could be reindexing pg_class itself, in which case we can't move
2817 : * its pg_class row because CatalogTupleInsert/CatalogTupleUpdate might
2818 : * not know about all the indexes yet (see reindex_relation).
2819 : *
2820 : * 3. Because we execute CREATE INDEX with just share lock on the parent
2821 : * rel (to allow concurrent index creations), an ordinary update could
2822 : * suffer a tuple-concurrently-updated failure against another CREATE
2823 : * INDEX committing at about the same time. We can avoid that by having
2824 : * them both do nontransactional updates (we assume they will both be
2825 : * trying to change the pg_class row to the same thing, so it doesn't
2826 : * matter which goes first).
2827 : *
2828 : * It is safe to use a non-transactional update even though our
2829 : * transaction could still fail before committing. Setting relhasindex
2830 : * true is safe even if there are no indexes (VACUUM will eventually fix
2831 : * it). And of course the new relpages and reltuples counts are correct
2832 : * regardless. However, we don't want to change relpages (or
2833 : * relallvisible) if the caller isn't providing an updated reltuples
2834 : * count, because that would bollix the reltuples/relpages ratio which is
2835 : * what's really important.
2836 : */
2837 :
1539 andres 2838 GIC 131152 : pg_class = table_open(RelationRelationId, RowExclusiveLock);
2839 :
2840 : /*
2841 : * Make a copy of the tuple to update. Normally we use the syscache, but
2842 : * we can't rely on that during bootstrap or while reindexing pg_class
2843 : * itself.
2844 : */
6096 tgl 2845 164704 : if (IsBootstrapProcessingMode() ||
2846 33552 : ReindexIsProcessingHeap(RelationRelationId))
8451 inoue 2847 97700 : {
2848 : /* don't assume syscache will work */
1490 andres 2849 ECB : TableScanDesc pg_class_scan;
2850 : ScanKeyData key[1];
2851 :
7088 tgl 2852 GIC 97700 : ScanKeyInit(&key[0],
2853 : Anum_pg_class_oid,
2854 : BTEqualStrategyNumber, F_OIDEQ,
2855 : ObjectIdGetDatum(relid));
8451 inoue 2856 ECB :
1490 andres 2857 CBC 97700 : pg_class_scan = table_beginscan_catalog(pg_class, 1, key);
7629 tgl 2858 97700 : tuple = heap_getnext(pg_class_scan, ForwardScanDirection);
6178 tgl 2859 GIC 97700 : tuple = heap_copytuple(tuple);
1490 andres 2860 97700 : table_endscan(pg_class_scan);
2861 : }
2862 : else
6096 tgl 2863 ECB : {
2864 : /* normal case, use syscache */
4802 rhaas 2865 GIC 33452 : tuple = SearchSysCacheCopy1(RELOID, ObjectIdGetDatum(relid));
2866 : }
2867 :
8451 inoue 2868 CBC 131152 : if (!HeapTupleIsValid(tuple))
7202 tgl 2869 LBC 0 : elog(ERROR, "could not find tuple for relation %u", relid);
6178 tgl 2870 CBC 131152 : rd_rel = (Form_pg_class) GETSTRUCT(tuple);
8451 inoue 2871 ECB :
2872 : /* Should this be a more comprehensive test? */
1906 alvherre 2873 GIC 131152 : Assert(rd_rel->relkind != RELKIND_PARTITIONED_INDEX);
2874 :
2875 : /*
952 tgl 2876 ECB : * As a special hack, if we are dealing with an empty table and the
2877 : * existing reltuples is -1, we leave that alone. This ensures that
2878 : * creating an index as part of CREATE TABLE doesn't cause the table to
2879 : * prematurely look like it's been vacuumed.
952 tgl 2880 EUB : */
952 tgl 2881 CBC 131152 : if (reltuples == 0 && rd_rel->reltuples < 0)
952 tgl 2882 GIC 47060 : reltuples = -1;
2883 :
6178 tgl 2884 ECB : /* Apply required updates, if any, to copied tuple */
2885 :
6178 tgl 2886 GIC 131152 : dirty = false;
2887 131152 : if (rd_rel->relhasindex != hasindex)
2888 : {
2889 43411 : rd_rel->relhasindex = hasindex;
7707 2890 43411 : dirty = true;
2891 : }
4195 tgl 2892 ECB :
4195 tgl 2893 CBC 131152 : if (reltuples >= 0)
2894 : {
4195 tgl 2895 GIC 82800 : BlockNumber relpages = RelationGetNumberOfBlocks(rel);
2896 : BlockNumber relallvisible;
4195 tgl 2897 ECB :
4195 tgl 2898 CBC 82800 : if (rd_rel->relkind != RELKIND_INDEX)
2595 rhaas 2899 GIC 19519 : visibilitymap_count(rel, &relallvisible, NULL);
2118 tgl 2900 ECB : else /* don't bother for indexes */
4195 tgl 2901 CBC 63281 : relallvisible = 0;
2902 :
4195 tgl 2903 GIC 82800 : if (rd_rel->relpages != (int32) relpages)
4195 tgl 2904 ECB : {
4195 tgl 2905 GIC 72499 : rd_rel->relpages = (int32) relpages;
4195 tgl 2906 CBC 72499 : dirty = true;
2907 : }
4195 tgl 2908 GIC 82800 : if (rd_rel->reltuples != (float4) reltuples)
4195 tgl 2909 ECB : {
4195 tgl 2910 CBC 28569 : rd_rel->reltuples = (float4) reltuples;
4195 tgl 2911 GIC 28569 : dirty = true;
4195 tgl 2912 ECB : }
4195 tgl 2913 GIC 82800 : if (rd_rel->relallvisible != (int32) relallvisible)
4195 tgl 2914 ECB : {
4195 tgl 2915 GIC 26 : rd_rel->relallvisible = (int32) relallvisible;
4195 tgl 2916 CBC 26 : dirty = true;
4195 tgl 2917 ECB : }
2918 : }
6178 2919 :
2920 : /*
2921 : * If anything changed, write out the tuple
2922 : */
6178 tgl 2923 GIC 131152 : if (dirty)
6178 tgl 2924 ECB : {
6096 tgl 2925 GIC 106842 : heap_inplace_update(pg_class, tuple);
6096 tgl 2926 ECB : /* the above sends a cache inval message */
8187 2927 : }
2928 : else
2929 : {
2930 : /* no need to change tuple, but force relcache inval anyway */
6998 tgl 2931 GIC 24310 : CacheInvalidateRelcacheByTuple(tuple);
2932 : }
2933 :
6178 tgl 2934 CBC 131152 : heap_freetuple(tuple);
2935 :
1539 andres 2936 131152 : table_close(pg_class, RowExclusiveLock);
8451 inoue 2937 GIC 131152 : }
2938 :
2939 :
2940 : /*
2941 : * index_build - invoke access-method-specific index build procedure
6178 tgl 2942 ECB : *
2943 : * On entry, the index's catalog entries are valid, and its physical disk
2944 : * file has been created but is empty. We call the AM-specific build
2945 : * procedure to fill in the index contents. We then update the pg_class
2946 : * entries of the index and heap relation as needed, using statistics
2947 : * returned by ambuild as well as data passed by the caller.
2948 : *
2949 : * isreindex indicates we are recreating a previously-existing index.
2950 : * parallel indicates if parallelism may be useful.
2951 : *
2952 : * Note: before Postgres 8.2, the passed-in heap and index Relations
2953 : * were automatically closed by this routine. This is no longer the case.
2954 : * The caller opened 'em, and the caller should close 'em.
2955 : */
2956 : void
7938 tgl 2957 GIC 64975 : index_build(Relation heapRelation,
2958 : Relation indexRelation,
2959 : IndexInfo *indexInfo,
2960 : bool isreindex,
2961 : bool parallel)
2962 : {
2963 : IndexBuildResult *stats;
2964 : Oid save_userid;
2965 : int save_sec_context;
2966 : int save_nestlevel;
2967 :
7938 tgl 2968 ECB : /*
2969 : * sanity checks
2970 : */
7938 tgl 2971 GIC 64975 : Assert(RelationIsValid(indexRelation));
1539 andres 2972 64975 : Assert(PointerIsValid(indexRelation->rd_indam));
2973 64975 : Assert(PointerIsValid(indexRelation->rd_indam->ambuild));
2974 64975 : Assert(PointerIsValid(indexRelation->rd_indam->ambuildempty));
2975 :
2976 : /*
2977 : * Determine worker process details for parallel CREATE INDEX. Currently,
2978 : * only btree has support for parallel builds.
2979 : *
2980 : * Note that planner considers parallel safety for us.
2981 : */
1892 rhaas 2982 CBC 64975 : if (parallel && IsNormalProcessingMode() &&
2983 16078 : indexRelation->rd_rel->relam == BTREE_AM_OID)
2984 15261 : indexInfo->ii_ParallelWorkers =
2985 15261 : plan_create_index_workers(RelationGetRelid(heapRelation),
2986 : RelationGetRelid(indexRelation));
2987 :
1892 rhaas 2988 GIC 64975 : if (indexInfo->ii_ParallelWorkers == 0)
2989 64904 : ereport(DEBUG1,
2990 : (errmsg_internal("building index \"%s\" on table \"%s\" serially",
2991 : RelationGetRelationName(indexRelation),
2992 : RelationGetRelationName(heapRelation))));
1892 rhaas 2993 ECB : else
1892 rhaas 2994 CBC 71 : ereport(DEBUG1,
781 peter 2995 ECB : (errmsg_internal("building index \"%s\" on table \"%s\" with request for %d parallel workers",
697 tgl 2996 : RelationGetRelationName(indexRelation),
2997 : RelationGetRelationName(heapRelation),
2998 : indexInfo->ii_ParallelWorkers)));
4439 rhaas 2999 :
5575 tgl 3000 : /*
3001 : * Switch to the table owner's userid, so that any index functions are run
3002 : * as that user. Also lock down security-restricted operations and
3003 : * arrange to make GUC variable changes local to this command.
3004 : */
4869 tgl 3005 CBC 64975 : GetUserIdAndSecContext(&save_userid, &save_sec_context);
4869 tgl 3006 GIC 64975 : SetUserIdAndSecContext(heapRelation->rd_rel->relowner,
3007 : save_sec_context | SECURITY_RESTRICTED_OPERATION);
3008 64975 : save_nestlevel = NewGUCNestLevel();
3009 :
3010 : /* Set up initial progress report status */
3011 : {
796 peter 3012 64975 : const int progress_index[] = {
3013 : PROGRESS_CREATEIDX_PHASE,
3014 : PROGRESS_CREATEIDX_SUBPHASE,
3015 : PROGRESS_CREATEIDX_TUPLES_DONE,
1468 alvherre 3016 ECB : PROGRESS_CREATEIDX_TUPLES_TOTAL,
3017 : PROGRESS_SCAN_BLOCKS_DONE,
3018 : PROGRESS_SCAN_BLOCKS_TOTAL
3019 : };
796 peter 3020 GIC 64975 : const int64 progress_vals[] = {
3021 : PROGRESS_CREATEIDX_PHASE_BUILD,
3022 : PROGRESS_CREATEIDX_SUBPHASE_INITIALIZE,
1468 alvherre 3023 ECB : 0, 0, 0, 0
3024 : };
3025 :
796 peter 3026 GIC 64975 : pgstat_progress_update_multi_param(6, progress_index, progress_vals);
3027 : }
3028 :
3029 : /*
3030 : * Call the access method's build procedure
7938 tgl 3031 ECB : */
1539 andres 3032 GIC 64975 : stats = indexRelation->rd_indam->ambuild(heapRelation, indexRelation,
3033 : indexInfo);
6178 tgl 3034 64930 : Assert(PointerIsValid(stats));
3035 :
3036 : /*
4329 rhaas 3037 ECB : * If this is an unlogged index, we may need to write out an init fork for
3038 : * it -- but we must first check whether one already exists. If, for
3039 : * example, an unlogged relation is truncated in the transaction that
3040 : * created it, or truncated twice in a subsequent transaction, the
3041 : * relfilenumber won't change, and nothing needs to be done here.
3042 : */
3067 alvherre 3043 CBC 64930 : if (indexRelation->rd_rel->relpersistence == RELPERSISTENCE_UNLOGGED &&
636 tgl 3044 GIC 79 : !smgrexists(RelationGetSmgr(indexRelation), INIT_FORKNUM))
4484 rhaas 3045 ECB : {
636 tgl 3046 GIC 79 : smgrcreate(RelationGetSmgr(indexRelation), INIT_FORKNUM, false);
1539 andres 3047 79 : indexRelation->rd_indam->ambuildempty(indexRelation);
3048 : }
3049 :
3050 : /*
3051 : * If we found any potentially broken HOT chains, mark the index as not
3052 : * being usable until the current transaction is below the event horizon.
3053 : * See src/backend/access/heap/README.HOT for discussion. Also set this
2494 kgrittn 3054 ECB : * if early pruning/vacuuming is enabled for the heap relation. While it
3055 : * might become safe to use the index earlier based on actual cleanup
3056 : * activity and other active transactions, the test for that would be much
3057 : * more complex and would require some form of blocking, so keep it simple
3058 : * and fast by just using the current transaction.
3059 : *
3060 : * However, when reindexing an existing index, we should do nothing here.
3061 : * Any HOT chains that are broken with respect to the index must predate
3062 : * the index's original creation, so there is no need to change the
3063 : * index's usability horizon. Moreover, we *must not* try to change the
3064 : * index's pg_index entry while reindexing pg_index itself, and this
3065 : * optimization nicely prevents that. The more complex rules needed for a
3066 : * reindex are handled separately after this function returns.
3067 : *
3068 : * We also need not set indcheckxmin during a concurrent index build,
3069 : * because we won't set indisvalid true until all transactions that care
3070 : * about the broken HOT chains or early pruning/vacuuming are gone.
3071 : *
3072 : * Therefore, this code path can only be taken during non-concurrent
3073 : * CREATE INDEX. Thus the fact that heap_update will set the pg_index
3074 : * tuple's xmin doesn't matter, because that tuple was created in the
3075 : * current transaction anyway. That also means we don't need to worry
3076 : * about any concurrent readers of the tuple; no other transaction can see
3077 : * it yet.
3078 : */
2494 kgrittn 3079 GIC 64930 : if ((indexInfo->ii_BrokenHotChain || EarlyPruningEnabled(heapRelation)) &&
3080 3 : !isreindex &&
3784 tgl 3081 3 : !indexInfo->ii_Concurrent)
3082 : {
5624 bruce 3083 3 : Oid indexId = RelationGetRelid(indexRelation);
3084 : Relation pg_index;
3085 : HeapTuple indexTuple;
3086 : Form_pg_index indexForm;
3087 :
1539 andres 3088 3 : pg_index = table_open(IndexRelationId, RowExclusiveLock);
3089 :
4802 rhaas 3090 CBC 3 : indexTuple = SearchSysCacheCopy1(INDEXRELID,
4802 rhaas 3091 ECB : ObjectIdGetDatum(indexId));
5680 tgl 3092 CBC 3 : if (!HeapTupleIsValid(indexTuple))
5680 tgl 3093 UIC 0 : elog(ERROR, "cache lookup failed for index %u", indexId);
5680 tgl 3094 CBC 3 : indexForm = (Form_pg_index) GETSTRUCT(indexTuple);
3095 :
3096 : /* If it's a new index, indcheckxmin shouldn't be set ... */
4373 tgl 3097 GIC 3 : Assert(!indexForm->indcheckxmin);
3098 :
5680 tgl 3099 CBC 3 : indexForm->indcheckxmin = true;
2259 alvherre 3100 GIC 3 : CatalogTupleUpdate(pg_index, &indexTuple->t_self, indexTuple);
5680 tgl 3101 ECB :
5680 tgl 3102 GIC 3 : heap_freetuple(indexTuple);
1539 andres 3103 CBC 3 : table_close(pg_index, RowExclusiveLock);
5680 tgl 3104 EUB : }
5680 tgl 3105 ECB :
3106 : /*
3107 : * Update heap and index pg_class rows
6178 3108 : */
6178 tgl 3109 GIC 64930 : index_update_stats(heapRelation,
6178 tgl 3110 ECB : true,
3111 : stats->heap_tuples);
3112 :
6178 tgl 3113 CBC 64930 : index_update_stats(indexRelation,
6178 tgl 3114 ECB : false,
3115 : stats->index_tuples);
3116 :
3117 : /* Make the updated catalog row versions visible */
6178 tgl 3118 GIC 64930 : CommandCounterIncrement();
3119 :
4326 tgl 3120 ECB : /*
3121 : * If it's for an exclusion constraint, make a second pass over the heap
3122 : * to verify that the constraint is satisfied. We must not do this until
3123 : * the index is fully valid. (Broken HOT chains shouldn't matter, though;
3124 : * see comments for IndexCheckExclusion.)
3125 : */
4326 tgl 3126 GIC 64930 : if (indexInfo->ii_ExclusionOps != NULL)
3127 82 : IndexCheckExclusion(heapRelation, indexRelation, indexInfo);
3128 :
4326 tgl 3129 ECB : /* Roll back any GUC changes executed by index functions */
4326 tgl 3130 GIC 64924 : AtEOXact_GUC(false, save_nestlevel);
3131 :
3132 : /* Restore userid and security context */
3133 64924 : SetUserIdAndSecContext(save_userid, save_sec_context);
7938 3134 64924 : }
3135 :
3136 : /*
4871 tgl 3137 ECB : * IndexCheckExclusion - verify that a new exclusion constraint is satisfied
3138 : *
3139 : * When creating an exclusion constraint, we first build the index normally
3140 : * and then rescan the heap to check for conflicts. We assume that we only
3568 rhaas 3141 : * need to validate tuples that are live according to an up-to-date snapshot,
3142 : * and that these were correctly indexed even in the presence of broken HOT
3143 : * chains. This should be OK since we are holding at least ShareLock on the
3144 : * table, meaning there can be no uncommitted updates from other transactions.
4871 tgl 3145 : * (Note: that wouldn't necessarily work for system catalogs, since many
3146 : * operations release write lock early on the system catalogs.)
3147 : */
3148 : static void
4871 tgl 3149 GIC 82 : IndexCheckExclusion(Relation heapRelation,
3150 : Relation indexRelation,
3151 : IndexInfo *indexInfo)
3152 : {
3153 : TableScanDesc scan;
3154 : Datum values[INDEX_MAX_KEYS];
3155 : bool isnull[INDEX_MAX_KEYS];
3156 : ExprState *predicate;
3157 : TupleTableSlot *slot;
3158 : EState *estate;
3159 : ExprContext *econtext;
3568 rhaas 3160 ECB : Snapshot snapshot;
3161 :
3162 : /*
3163 : * If we are reindexing the target index, mark it as no longer being
3164 : * reindexed, to forestall an Assert in index_beginscan when we try to use
3165 : * the index for probes. This is OK because the index is now fully valid.
3166 : */
4326 tgl 3167 GIC 82 : if (ReindexIsCurrentlyProcessingIndex(RelationGetRelid(indexRelation)))
3168 30 : ResetReindexProcessing();
3169 :
3170 : /*
3171 : * Need an EState for evaluation of index expressions and partial-index
3172 : * predicates. Also a slot to hold the current tuple.
3173 : */
4871 3174 82 : estate = CreateExecutorState();
3175 82 : econtext = GetPerTupleExprContext(estate);
1490 andres 3176 82 : slot = table_slot_create(heapRelation, NULL);
3177 :
4871 tgl 3178 ECB : /* Arrange for econtext's scan tuple to be the tuple under test */
4871 tgl 3179 CBC 82 : econtext->ecxt_scantuple = slot;
3180 :
3181 : /* Set up execution state for predicate, if any. */
2217 andres 3182 GIC 82 : predicate = ExecPrepareQual(indexInfo->ii_Predicate, estate);
3183 :
3184 : /*
4871 tgl 3185 ECB : * Scan all live tuples in the base relation.
3186 : */
3568 rhaas 3187 CBC 82 : snapshot = RegisterSnapshot(GetLatestSnapshot());
1490 andres 3188 GIC 82 : scan = table_beginscan_strat(heapRelation, /* relation */
3189 : snapshot, /* snapshot */
1490 andres 3190 ECB : 0, /* number of keys */
3191 : NULL, /* scan key */
3192 : true, /* buffer access strategy OK */
3193 : true); /* syncscan OK */
3194 :
1490 andres 3195 GIC 105 : while (table_scan_getnextslot(scan, ForwardScanDirection, slot))
3196 : {
4871 tgl 3197 29 : CHECK_FOR_INTERRUPTS();
4871 tgl 3198 ECB :
3199 : /*
3200 : * In a partial index, ignore tuples that don't satisfy the predicate.
3201 : */
2217 andres 3202 GIC 29 : if (predicate != NULL)
3203 : {
3204 17 : if (!ExecQual(predicate, econtext))
4871 tgl 3205 6 : continue;
4871 tgl 3206 ECB : }
3207 :
3208 : /*
3209 : * Extract index column values, including computing expressions.
3210 : */
4871 tgl 3211 GIC 23 : FormIndexDatum(indexInfo,
3212 : slot,
4871 tgl 3213 ECB : estate,
3214 : values,
3215 : isnull);
3216 :
3217 : /*
3218 : * Check that this tuple has no conflicts.
3219 : */
4871 tgl 3220 GIC 23 : check_exclusion_constraint(heapRelation,
3221 : indexRelation, indexInfo,
1490 andres 3222 ECB : &(slot->tts_tid), values, isnull,
3223 : estate, true);
3224 :
1490 andres 3225 GIC 17 : MemoryContextReset(econtext->ecxt_per_tuple_memory);
3226 : }
3227 :
3228 76 : table_endscan(scan);
3568 rhaas 3229 76 : UnregisterSnapshot(snapshot);
3230 :
4871 tgl 3231 CBC 76 : ExecDropSingleTupleTableSlot(slot);
3232 :
4871 tgl 3233 GIC 76 : FreeExecutorState(estate);
3234 :
3235 : /* These may have been pointing to the now-gone estate */
4871 tgl 3236 CBC 76 : indexInfo->ii_ExpressionsState = NIL;
2217 andres 3237 GIC 76 : indexInfo->ii_PredicateState = NULL;
4871 tgl 3238 76 : }
4871 tgl 3239 ECB :
3240 :
3241 : /*
6071 3242 : * validate_index - support code for concurrent index builds
3243 : *
5680 3244 : * We do a concurrent index build by first inserting the catalog entry for the
3245 : * index via index_create(), marking it not indisready and not indisvalid.
3246 : * Then we commit our transaction and start a new one, then we wait for all
3260 bruce 3247 : * transactions that could have been modifying the table to terminate. Now
5680 tgl 3248 : * we know that any subsequently-started transactions will see the index and
3249 : * honor its constraints on HOT updates; so while existing HOT-chains might
3250 : * be broken with respect to the index, no currently live tuple will have an
3251 : * incompatible HOT update done to it. We now build the index normally via
3252 : * index_build(), while holding a weak lock that allows concurrent
3253 : * insert/update/delete. Also, we index only tuples that are valid
3254 : * as of the start of the scan (see table_index_build_scan), whereas a normal
3255 : * build takes care to include recently-dead tuples. This is OK because
3256 : * we won't mark the index valid until all transactions that might be able
3257 : * to see those tuples are gone. The reason for doing that is to avoid
3258 : * bogus unique-index failures due to concurrent UPDATEs (we might see
3259 : * different versions of the same row as being valid when we pass over them,
3260 : * if we used HeapTupleSatisfiesVacuum). This leaves us with an index that
3261 : * does not contain any tuples added to the table while we built the index.
3262 : *
3263 : * Next, we mark the index "indisready" (but still not "indisvalid") and
3264 : * commit the second transaction and start a third. Again we wait for all
3265 : * transactions that could have been modifying the table to terminate. Now
3266 : * we know that any subsequently-started transactions will see the index and
3267 : * insert their new tuples into it. We then take a new reference snapshot
3268 : * which is passed to validate_index(). Any tuples that are valid according
3269 : * to this snap, but are not in the index, must be added to the index.
3270 : * (Any tuples committed live after the snap will be inserted into the
3271 : * index by their originating transaction. Any tuples committed dead before
3272 : * the snap need not be indexed, because we will wait out all transactions
3273 : * that might care about them before we mark the index valid.)
3274 : *
3275 : * validate_index() works by first gathering all the TIDs currently in the
3276 : * index, using a bulkdelete callback that just stores the TIDs and doesn't
3277 : * ever say "delete it". (This should be faster than a plain indexscan;
3278 : * also, not all index AMs support full-index indexscan.) Then we sort the
3279 : * TIDs, and finally scan the table doing a "merge join" against the TID list
3280 : * to see which tuples are missing from the index. Thus we will ensure that
3281 : * all tuples valid according to the reference snapshot are in the index.
3282 : *
3283 : * Building a unique index this way is tricky: we might try to insert a
3284 : * tuple that is already dead or is in process of being deleted, and we
3285 : * mustn't have a uniqueness failure against an updated version of the same
3286 : * row. We could try to check the tuple to see if it's already dead and tell
3287 : * index_insert() not to do the uniqueness check, but that still leaves us
3288 : * with a race condition against an in-progress update. To handle that,
3289 : * we expect the index AM to recheck liveness of the to-be-inserted tuple
3290 : * before it declares a uniqueness error.
3291 : *
3292 : * After completing validate_index(), we wait until all transactions that
3293 : * were alive at the time of the reference snapshot are gone; this is
3294 : * necessary to be sure there are none left with a transaction snapshot
3295 : * older than the reference (and hence possibly able to see tuples we did
3296 : * not index). Then we mark the index "indisvalid" and commit. Subsequent
3297 : * transactions will be able to use it for queries.
3298 : *
3299 : * Doing two full table scans is a brute-force strategy. We could try to be
3300 : * cleverer, eg storing new tuples in a special area of the table (perhaps
3301 : * making the table append-only by setting use_fsm). However that would
3302 : * add yet more locking issues.
3303 : */
3304 : void
6071 tgl 3305 GIC 272 : validate_index(Oid heapId, Oid indexId, Snapshot snapshot)
3306 : {
3307 : Relation heapRelation,
3308 : indexRelation;
3309 : IndexInfo *indexInfo;
3310 : IndexVacuumInfo ivinfo;
3311 : ValidateIndexState state;
3312 : Oid save_userid;
3313 : int save_sec_context;
3314 : int save_nestlevel;
3315 :
1468 alvherre 3316 ECB : {
796 peter 3317 GIC 272 : const int progress_index[] = {
3318 : PROGRESS_CREATEIDX_PHASE,
3319 : PROGRESS_CREATEIDX_TUPLES_DONE,
3320 : PROGRESS_CREATEIDX_TUPLES_TOTAL,
3321 : PROGRESS_SCAN_BLOCKS_DONE,
3322 : PROGRESS_SCAN_BLOCKS_TOTAL
3323 : };
3324 272 : const int64 progress_vals[] = {
3325 : PROGRESS_CREATEIDX_PHASE_VALIDATE_IDXSCAN,
3326 : 0, 0, 0, 0
3327 : };
1418 tgl 3328 ECB :
796 peter 3329 GIC 272 : pgstat_progress_update_multi_param(5, progress_index, progress_vals);
3330 : }
3331 :
3332 : /* Open and lock the parent heap relation */
1539 andres 3333 272 : heapRelation = table_open(heapId, ShareUpdateExclusiveLock);
3334 :
335 noah 3335 ECB : /*
3336 : * Switch to the table owner's userid, so that any index functions are run
3337 : * as that user. Also lock down security-restricted operations and
3338 : * arrange to make GUC variable changes local to this command.
3339 : */
335 noah 3340 CBC 272 : GetUserIdAndSecContext(&save_userid, &save_sec_context);
335 noah 3341 GIC 272 : SetUserIdAndSecContext(heapRelation->rd_rel->relowner,
3342 : save_sec_context | SECURITY_RESTRICTED_OPERATION);
3343 272 : save_nestlevel = NewGUCNestLevel();
335 noah 3344 ECB :
6071 tgl 3345 GIC 272 : indexRelation = index_open(indexId, RowExclusiveLock);
3346 :
3347 : /*
3348 : * Fetch info needed for index_insert. (You might think this should be
3349 : * passed in from DefineIndex, but its copy is long gone due to having
3350 : * been built in a previous transaction.)
6071 tgl 3351 ECB : */
6071 tgl 3352 CBC 272 : indexInfo = BuildIndexInfo(indexRelation);
3353 :
6071 tgl 3354 ECB : /* mark build is concurrent just for consistency */
6071 tgl 3355 GIC 272 : indexInfo->ii_Concurrent = true;
6071 tgl 3356 ECB :
3357 : /*
3358 : * Scan the index and gather up all the TIDs into a tuplesort object.
3359 : */
6071 tgl 3360 GIC 272 : ivinfo.index = indexRelation;
6 pg 3361 GNC 272 : ivinfo.heaprel = heapRelation;
5129 tgl 3362 GIC 272 : ivinfo.analyze_only = false;
1468 alvherre 3363 272 : ivinfo.report_progress = true;
5055 tgl 3364 CBC 272 : ivinfo.estimated_count = true;
6071 tgl 3365 GIC 272 : ivinfo.message_level = DEBUG2;
5055 3366 272 : ivinfo.num_heap_tuples = heapRelation->rd_rel->reltuples;
5793 tgl 3367 CBC 272 : ivinfo.strategy = NULL;
3368 :
3369 : /*
3370 : * Encode TIDs as int8 values for the sort, rather than directly sorting
3371 : * item pointers. This can be significantly faster, primarily because TID
2671 rhaas 3372 ECB : * is a pass-by-reference type on all platforms, whereas int8 is
3373 : * pass-by-value on most platforms.
3374 : */
2671 rhaas 3375 CBC 272 : state.tuplesort = tuplesort_begin_datum(INT8OID, Int8LessOperator,
4370 tgl 3376 ECB : InvalidOid, false,
6071 3377 : maintenance_work_mem,
370 drowley 3378 : NULL, TUPLESORT_NONE);
6071 tgl 3379 CBC 272 : state.htups = state.itups = state.tups_inserted = 0;
3380 :
3381 : /* ambulkdelete updates progress metrics */
6071 tgl 3382 GIC 272 : (void) index_bulk_delete(&ivinfo, NULL,
3383 : validate_index_callback, (void *) &state);
3384 :
3385 : /* Execute the sort */
3386 : {
796 peter 3387 CBC 272 : const int progress_index[] = {
3388 : PROGRESS_CREATEIDX_PHASE,
3389 : PROGRESS_SCAN_BLOCKS_DONE,
3390 : PROGRESS_SCAN_BLOCKS_TOTAL
1468 alvherre 3391 ECB : };
796 peter 3392 GIC 272 : const int64 progress_vals[] = {
3393 : PROGRESS_CREATEIDX_PHASE_VALIDATE_SORT,
1468 alvherre 3394 ECB : 0, 0
3395 : };
3396 :
796 peter 3397 GIC 272 : pgstat_progress_update_multi_param(3, progress_index, progress_vals);
3398 : }
6071 tgl 3399 CBC 272 : tuplesort_performsort(state.tuplesort);
3400 :
3401 : /*
3402 : * Now scan the heap and "merge" it with the index
3403 : */
1468 alvherre 3404 272 : pgstat_progress_update_param(PROGRESS_CREATEIDX_PHASE,
3405 : PROGRESS_CREATEIDX_PHASE_VALIDATE_TABLESCAN);
1474 andres 3406 GIC 272 : table_index_validate_scan(heapRelation,
3407 : indexRelation,
3408 : indexInfo,
1474 andres 3409 ECB : snapshot,
3410 : &state);
6071 tgl 3411 :
3412 : /* Done with tuplesort object */
6071 tgl 3413 GIC 272 : tuplesort_end(state.tuplesort);
3414 :
3415 272 : elog(DEBUG2,
6071 tgl 3416 ECB : "validate_index found %.0f heap tuples, %.0f index tuples; inserted %.0f missing tuples",
3417 : state.htups, state.itups, state.tups_inserted);
3418 :
3419 : /* Roll back any GUC changes executed by index functions */
4869 tgl 3420 GIC 272 : AtEOXact_GUC(false, save_nestlevel);
3421 :
3422 : /* Restore userid and security context */
3423 272 : SetUserIdAndSecContext(save_userid, save_sec_context);
3424 :
6071 tgl 3425 ECB : /* Close rels, but keep locks */
6071 tgl 3426 GIC 272 : index_close(indexRelation, NoLock);
1539 andres 3427 CBC 272 : table_close(heapRelation, NoLock);
6071 tgl 3428 GIC 272 : }
3429 :
3430 : /*
3431 : * validate_index_callback - bulkdelete callback to collect the index TIDs
6071 tgl 3432 ECB : */
3433 : static bool
6071 tgl 3434 GIC 16099 : validate_index_callback(ItemPointer itemptr, void *opaque)
6071 tgl 3435 ECB : {
1474 andres 3436 GIC 16099 : ValidateIndexState *state = (ValidateIndexState *) opaque;
2671 rhaas 3437 16099 : int64 encoded = itemptr_encode(itemptr);
6071 tgl 3438 ECB :
2671 rhaas 3439 CBC 16099 : tuplesort_putdatum(state->tuplesort, Int64GetDatum(encoded), false);
6071 tgl 3440 16099 : state->itups += 1;
6071 tgl 3441 GIC 16099 : return false; /* never actually delete anything */
3442 : }
3443 :
3444 : /*
3445 : * index_set_state_flags - adjust pg_index state flags
3784 tgl 3446 ECB : *
3447 : * This is used during CREATE/DROP INDEX CONCURRENTLY to adjust the pg_index
937 michael 3448 : * flags that denote the index's state.
3784 tgl 3449 : *
3450 : * Note that CatalogTupleUpdate() sends a cache invalidation message for the
3451 : * tuple, so other sessions will hear about the update as soon as we commit.
3452 : */
3453 : void
3784 tgl 3454 GIC 648 : index_set_state_flags(Oid indexId, IndexStateFlagsAction action)
3455 : {
3456 : Relation pg_index;
3457 : HeapTuple indexTuple;
3458 : Form_pg_index indexForm;
3459 :
3460 : /* Open pg_index and fetch a writable copy of the index's tuple */
1539 andres 3461 648 : pg_index = table_open(IndexRelationId, RowExclusiveLock);
3462 :
3784 tgl 3463 648 : indexTuple = SearchSysCacheCopy1(INDEXRELID,
3464 : ObjectIdGetDatum(indexId));
3465 648 : if (!HeapTupleIsValid(indexTuple))
3784 tgl 3466 LBC 0 : elog(ERROR, "cache lookup failed for index %u", indexId);
3784 tgl 3467 GIC 648 : indexForm = (Form_pg_index) GETSTRUCT(indexTuple);
3468 :
3469 : /* Perform the requested state change on the copy */
3470 648 : switch (action)
3471 : {
3472 272 : case INDEX_CREATE_SET_READY:
3784 tgl 3473 ECB : /* Set indisready during a CREATE INDEX CONCURRENTLY sequence */
3784 tgl 3474 GIC 272 : Assert(indexForm->indislive);
3784 tgl 3475 CBC 272 : Assert(!indexForm->indisready);
3784 tgl 3476 GIC 272 : Assert(!indexForm->indisvalid);
3784 tgl 3477 CBC 272 : indexForm->indisready = true;
3784 tgl 3478 GBC 272 : break;
3784 tgl 3479 CBC 65 : case INDEX_CREATE_SET_VALID:
3480 : /* Set indisvalid during a CREATE INDEX CONCURRENTLY sequence */
3784 tgl 3481 GIC 65 : Assert(indexForm->indislive);
3784 tgl 3482 CBC 65 : Assert(indexForm->indisready);
3784 tgl 3483 GIC 65 : Assert(!indexForm->indisvalid);
3784 tgl 3484 CBC 65 : indexForm->indisvalid = true;
3784 tgl 3485 GIC 65 : break;
3784 tgl 3486 CBC 52 : case INDEX_DROP_CLEAR_VALID:
3784 tgl 3487 ECB :
3488 : /*
3489 : * Clear indisvalid during a DROP INDEX CONCURRENTLY sequence
3490 : *
3491 : * If indisready == true we leave it set so the index still gets
3492 : * maintained by active transactions. We only need to ensure that
3493 : * indisvalid is false. (We don't assert that either is initially
3494 : * true, though, since we want to be able to retry a DROP INDEX
3495 : * CONCURRENTLY that failed partway through.)
3496 : *
3497 : * Note: the CLUSTER logic assumes that indisclustered cannot be
78 3498 : * set on any invalid index, so clear that flag too. For
3499 : * cleanliness, also clear indisreplident.
3500 : */
3784 tgl 3501 GIC 52 : indexForm->indisvalid = false;
3502 52 : indexForm->indisclustered = false;
952 michael 3503 52 : indexForm->indisreplident = false;
3784 tgl 3504 52 : break;
3505 259 : case INDEX_DROP_SET_DEAD:
3506 :
3507 : /*
3508 : * Clear indisready/indislive during DROP INDEX CONCURRENTLY
3509 : *
3510 : * We clear both indisready and indislive, because we not only
3511 : * want to stop updates, we want to prevent sessions from touching
3512 : * the index at all.
3784 tgl 3513 ECB : */
3784 tgl 3514 CBC 259 : Assert(!indexForm->indisvalid);
952 michael 3515 259 : Assert(!indexForm->indisclustered);
3516 259 : Assert(!indexForm->indisreplident);
3784 tgl 3517 259 : indexForm->indisready = false;
3784 tgl 3518 GIC 259 : indexForm->indislive = false;
3519 259 : break;
3520 : }
3521 :
3522 : /* ... and update it */
937 michael 3523 648 : CatalogTupleUpdate(pg_index, &indexTuple->t_self, indexTuple);
3524 :
1539 andres 3525 648 : table_close(pg_index, RowExclusiveLock);
3784 tgl 3526 CBC 648 : }
3784 tgl 3527 ECB :
3528 :
8540 3529 : /*
3530 : * IndexGetRelation: given an index's relation OID, get the OID of the
3260 bruce 3531 : * relation it is an index on. Uses the system cache.
3532 : */
3533 : Oid
4148 rhaas 3534 GIC 21106 : IndexGetRelation(Oid indexId, bool missing_ok)
8540 tgl 3535 ECB : {
3536 : HeapTuple tuple;
3537 : Form_pg_index index;
8179 3538 : Oid result;
3539 :
4802 rhaas 3540 GIC 21106 : tuple = SearchSysCache1(INDEXRELID, ObjectIdGetDatum(indexId));
8540 tgl 3541 21106 : if (!HeapTupleIsValid(tuple))
3542 : {
4148 rhaas 3543 13 : if (missing_ok)
3544 13 : return InvalidOid;
7202 tgl 3545 UIC 0 : elog(ERROR, "cache lookup failed for index %u", indexId);
4148 rhaas 3546 ECB : }
8540 tgl 3547 GIC 21093 : index = (Form_pg_index) GETSTRUCT(tuple);
3548 21093 : Assert(index->indexrelid == indexId);
3549 :
8179 3550 21093 : result = index->indrelid;
3551 21093 : ReleaseSysCache(tuple);
8179 tgl 3552 CBC 21093 : return result;
8540 tgl 3553 ECB : }
3554 :
7137 3555 : /*
3556 : * reindex_index - This routine is used to recreate a single index
8451 inoue 3557 EUB : */
3558 : void
2886 fujii 3559 CBC 2497 : reindex_index(Oid indexId, bool skip_constraint_checks, char persistence,
811 michael 3560 ECB : ReindexParams *params)
3561 : {
8397 bruce 3562 : Relation iRel,
3784 tgl 3563 : heapRelation;
7855 3564 : Oid heapId;
3565 : Oid save_userid;
3566 : int save_sec_context;
3567 : int save_nestlevel;
3568 : IndexInfo *indexInfo;
4809 tgl 3569 GIC 2497 : volatile bool skipped_constraint = false;
3570 : PGRUsage ru0;
811 michael 3571 CBC 2497 : bool progress = ((params->options & REINDEXOPT_REPORT_PROGRESS) != 0);
794 michael 3572 GIC 2497 : bool set_tablespace = false;
3573 :
2886 fujii 3574 2497 : pg_rusage_init(&ru0);
3575 :
3576 : /*
3577 : * Open and lock the parent heap relation. ShareLock is sufficient since
3578 : * we only need to be sure no schema or data changes are going on.
3579 : */
949 michael 3580 2497 : heapId = IndexGetRelation(indexId,
811 michael 3581 CBC 2497 : (params->options & REINDEXOPT_MISSING_OK) != 0);
3582 : /* if relation is missing, leave */
949 3583 2497 : if (!OidIsValid(heapId))
949 michael 3584 LBC 0 : return;
3585 :
811 michael 3586 CBC 2497 : if ((params->options & REINDEXOPT_MISSING_OK) != 0)
949 michael 3587 GIC 431 : heapRelation = try_table_open(heapId, ShareLock);
3588 : else
3589 2066 : heapRelation = table_open(heapId, ShareLock);
3590 :
3591 : /* if relation is gone, leave */
949 michael 3592 CBC 2497 : if (!heapRelation)
949 michael 3593 LBC 0 : return;
3594 :
335 noah 3595 ECB : /*
335 noah 3596 EUB : * Switch to the table owner's userid, so that any index functions are run
3597 : * as that user. Also lock down security-restricted operations and
335 noah 3598 ECB : * arrange to make GUC variable changes local to this command.
3599 : */
335 noah 3600 GIC 2497 : GetUserIdAndSecContext(&save_userid, &save_sec_context);
335 noah 3601 CBC 2497 : SetUserIdAndSecContext(heapRelation->rd_rel->relowner,
3602 : save_sec_context | SECURITY_RESTRICTED_OPERATION);
335 noah 3603 GIC 2497 : save_nestlevel = NewGUCNestLevel();
335 noah 3604 ECB :
1304 alvherre 3605 GBC 2497 : if (progress)
3606 : {
776 michael 3607 GIC 753 : const int progress_cols[] = {
3608 : PROGRESS_CREATEIDX_COMMAND,
3609 : PROGRESS_CREATEIDX_INDEX_OID
3610 : };
3611 753 : const int64 progress_vals[] = {
776 michael 3612 ECB : PROGRESS_CREATEIDX_COMMAND_REINDEX,
3613 : indexId
3614 : };
3615 :
1304 alvherre 3616 GIC 753 : pgstat_progress_start_command(PROGRESS_COMMAND_CREATE_INDEX,
1304 alvherre 3617 ECB : heapId);
776 michael 3618 GIC 753 : pgstat_progress_update_multi_param(2, progress_cols, progress_vals);
1304 alvherre 3619 ECB : }
3620 :
3621 : /*
3622 : * Open the target index relation and get an exclusive lock on it, to
6385 bruce 3623 : * ensure that no one else is touching this particular index.
3624 : */
6096 tgl 3625 GIC 2497 : iRel = index_open(indexId, AccessExclusiveLock);
3626 :
1304 alvherre 3627 2497 : if (progress)
1304 alvherre 3628 CBC 753 : pgstat_progress_update_param(PROGRESS_CREATEIDX_ACCESS_METHOD_OID,
1304 alvherre 3629 GIC 753 : iRel->rd_rel->relam);
1463 peter 3630 ECB :
3631 : /*
3632 : * Partitioned indexes should never get processed here, as they have no
3633 : * physical storage.
3634 : */
1906 alvherre 3635 GIC 2497 : if (iRel->rd_rel->relkind == RELKIND_PARTITIONED_INDEX)
943 michael 3636 UIC 0 : elog(ERROR, "cannot reindex partitioned index \"%s.%s\"",
943 michael 3637 ECB : get_namespace_name(RelationGetNamespace(iRel)),
3638 : RelationGetRelationName(iRel));
1906 alvherre 3639 :
5548 tgl 3640 : /*
3641 : * Don't allow reindex on temp tables of other backends ... their local
3642 : * buffer manager is not going to cope.
3643 : */
5122 tgl 3644 GIC 2497 : if (RELATION_IS_OTHER_TEMP(iRel))
5548 tgl 3645 UIC 0 : ereport(ERROR,
3646 : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
2118 tgl 3647 ECB : errmsg("cannot reindex temporary tables of other sessions")));
5548 tgl 3648 EUB :
3649 : /*
3650 : * Don't allow reindex of an invalid index on TOAST table. This is a
3651 : * leftover from a failed REINDEX CONCURRENTLY, and if rebuilt it would
3652 : * not be possible to drop it anymore.
3653 : */
1125 michael 3654 GIC 2497 : if (IsToastNamespace(RelationGetNamespace(iRel)) &&
3655 903 : !get_index_isvalid(indexId))
1125 michael 3656 LBC 0 : ereport(ERROR,
1125 michael 3657 EUB : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
3658 : errmsg("cannot reindex invalid index on TOAST table")));
3659 :
3660 : /*
3661 : * System relations cannot be moved even if allow_system_table_mods is
3662 : * enabled to keep things consistent with the concurrent case where all
3663 : * the indexes of a relation are processed in series, including indexes of
3664 : * toast relations.
3665 : *
794 michael 3666 ECB : * Note that this check is not part of CheckRelationTableSpaceMove() as it
3667 : * gets used for ALTER TABLE SET TABLESPACE that could cascade across
794 michael 3668 EUB : * toast relations.
3669 : */
794 michael 3670 GIC 2528 : if (OidIsValid(params->tablespaceOid) &&
3671 31 : IsSystemRelation(iRel))
3672 17 : ereport(ERROR,
3673 : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
3674 : errmsg("cannot move system relation \"%s\"",
3675 : RelationGetRelationName(iRel))));
3676 :
3677 : /* Check if the tablespace of this index needs to be changed */
3678 2491 : if (OidIsValid(params->tablespaceOid) &&
3679 14 : CheckRelationTableSpaceMove(iRel, params->tablespaceOid))
3680 7 : set_tablespace = true;
3681 :
5548 tgl 3682 ECB : /*
5050 bruce 3683 : * Also check for active uses of the index in the current transaction; we
3684 : * don't want to reindex underneath an open indexscan.
3685 : */
5548 tgl 3686 GIC 2477 : CheckTableNotInUse(iRel, "REINDEX INDEX");
3687 :
3688 : /* Set new tablespace, if requested */
794 michael 3689 2477 : if (set_tablespace)
794 michael 3690 ECB : {
3691 : /* Update its pg_class row */
794 michael 3692 CBC 7 : SetRelationTableSpace(iRel, params->tablespaceOid, InvalidOid);
3693 :
3694 : /*
3695 : * Schedule unlinking of the old index storage at transaction commit.
3696 : */
794 michael 3697 GIC 7 : RelationDropStorage(iRel);
277 rhaas 3698 GNC 7 : RelationAssumeNewRelfilelocator(iRel);
3699 :
3700 : /* Make sure the reltablespace change is visible */
794 michael 3701 CBC 7 : CommandCounterIncrement();
3702 : }
3703 :
4323 heikki.linnakangas 3704 ECB : /*
3705 : * All predicate locks on the index are about to be made invalid. Promote
3706 : * them to relation locks on the heap.
3707 : */
4323 heikki.linnakangas 3708 GIC 2477 : TransferPredicateLocksToHeapRelation(iRel);
4323 heikki.linnakangas 3709 ECB :
1441 andres 3710 : /* Fetch info needed for index_build */
1441 andres 3711 GIC 2477 : indexInfo = BuildIndexInfo(iRel);
3712 :
1441 andres 3713 ECB : /* If requested, skip checking uniqueness/exclusion constraints */
1441 andres 3714 GIC 2477 : if (skip_constraint_checks)
3715 : {
3716 1426 : if (indexInfo->ii_Unique || indexInfo->ii_ExclusionOps != NULL)
3717 1194 : skipped_constraint = true;
3718 1426 : indexInfo->ii_Unique = false;
3719 1426 : indexInfo->ii_ExclusionOps = NULL;
1441 andres 3720 CBC 1426 : indexInfo->ii_ExclusionProcs = NULL;
1441 andres 3721 GIC 1426 : indexInfo->ii_ExclusionStrats = NULL;
3722 : }
1441 andres 3723 ECB :
3724 : /* Suppress use of the target index while rebuilding it */
1083 tgl 3725 GIC 2477 : SetReindexProcessing(heapId, indexId);
6825 tgl 3726 ECB :
3727 : /* Create a new physical relation for the index */
277 rhaas 3728 GNC 2477 : RelationSetNewRelfilenumber(iRel, persistence);
1438 tgl 3729 ECB :
1083 3730 : /* Initialize the index and rebuild */
3731 : /* Note: we do not need to re-establish pkey setting */
1083 tgl 3732 CBC 2477 : index_build(heapRelation, iRel, indexInfo, true, true);
1083 tgl 3733 ECB :
3734 : /* Re-allow use of target index */
1083 tgl 3735 GIC 2465 : ResetReindexProcessing();
3736 :
6071 tgl 3737 ECB : /*
3738 : * If the index is marked invalid/not-ready/dead (ie, it's from a failed
3739 : * CREATE INDEX CONCURRENTLY, or a DROP INDEX CONCURRENTLY failed midway),
3784 3740 : * and we didn't skip a uniqueness check, we can now mark it valid. This
3741 : * allows REINDEX to be used to clean up in such cases.
3742 : *
3743 : * We can also reset indcheckxmin, because we have now done a
5126 3744 : * non-concurrent index build, *except* in the case where index_build
3745 : * found some still-broken HOT chains. If it did, and we don't have to
3746 : * change any of the other flags, we just leave indcheckxmin alone (note
3784 3747 : * that index_build won't have changed it, because this is a reindex).
3748 : * This is okay and desirable because not updating the tuple leaves the
3749 : * index's usability horizon (recorded as the tuple's xmin value) the same
3750 : * as it was.
3751 : *
3752 : * But, if the index was invalid/not-ready/dead and there were broken HOT
3753 : * chains, we had better force indcheckxmin true, because the normal
3754 : * argument that the HOT chains couldn't conflict with the index is
3755 : * suspect for an invalid index. (A conflict is definitely possible if
3756 : * the index was dead. It probably shouldn't happen otherwise, but let's
3757 : * be conservative.) In this case advancing the usability horizon is
3758 : * appropriate.
3759 : *
3760 : * Another reason for avoiding unnecessary updates here is that while
3761 : * reindexing pg_index itself, we must not try to update tuples in it.
3762 : * pg_index's indexes should always have these flags in their clean state,
3763 : * so that won't happen.
3764 : *
3765 : * If early pruning/vacuuming is enabled for the heap relation, the
3766 : * usability horizon must be advanced to the current transaction on every
3767 : * build or rebuild. pg_index is OK in this regard because catalog tables
3768 : * are not subject to early cleanup.
3769 : */
4373 tgl 3770 GIC 2465 : if (!skipped_constraint)
3771 : {
3772 : Relation pg_index;
3773 : HeapTuple indexTuple;
3774 : Form_pg_index indexForm;
3775 : bool index_bad;
2494 kgrittn 3776 1271 : bool early_pruning_enabled = EarlyPruningEnabled(heapRelation);
3777 :
1539 andres 3778 1271 : pg_index = table_open(IndexRelationId, RowExclusiveLock);
3779 :
4802 rhaas 3780 1271 : indexTuple = SearchSysCacheCopy1(INDEXRELID,
3781 : ObjectIdGetDatum(indexId));
4809 tgl 3782 CBC 1271 : if (!HeapTupleIsValid(indexTuple))
4809 tgl 3783 UIC 0 : elog(ERROR, "cache lookup failed for index %u", indexId);
4809 tgl 3784 GIC 1271 : indexForm = (Form_pg_index) GETSTRUCT(indexTuple);
3785 :
3784 3786 3810 : index_bad = (!indexForm->indisvalid ||
3787 2539 : !indexForm->indisready ||
3784 tgl 3788 CBC 1268 : !indexForm->indislive);
3784 tgl 3789 GIC 1271 : if (index_bad ||
2494 kgrittn 3790 CBC 1268 : (indexForm->indcheckxmin && !indexInfo->ii_BrokenHotChain) ||
3791 : early_pruning_enabled)
4809 tgl 3792 ECB : {
2494 kgrittn 3793 GIC 3 : if (!indexInfo->ii_BrokenHotChain && !early_pruning_enabled)
4809 tgl 3794 CBC 3 : indexForm->indcheckxmin = false;
2494 kgrittn 3795 UBC 0 : else if (index_bad || early_pruning_enabled)
4372 tgl 3796 LBC 0 : indexForm->indcheckxmin = true;
4372 tgl 3797 GIC 3 : indexForm->indisvalid = true;
4372 tgl 3798 CBC 3 : indexForm->indisready = true;
3784 3799 3 : indexForm->indislive = true;
2259 alvherre 3800 3 : CatalogTupleUpdate(pg_index, &indexTuple->t_self, indexTuple);
3784 tgl 3801 ECB :
3802 : /*
3803 : * Invalidate the relcache for the table, so that after we commit
3804 : * all sessions will refresh the table's index list. This ensures
3805 : * that if anyone misses seeing the pg_index row during this
3806 : * update, they'll refresh their list before attempting any update
3784 tgl 3807 EUB : * on the table.
3808 : */
3784 tgl 3809 CBC 3 : CacheInvalidateRelcache(heapRelation);
4809 tgl 3810 ECB : }
3811 :
1539 andres 3812 CBC 1271 : table_close(pg_index, RowExclusiveLock);
3813 : }
3814 :
3815 : /* Log what we did */
811 michael 3816 GIC 2465 : if ((params->options & REINDEXOPT_VERBOSE) != 0)
2886 fujii 3817 7 : ereport(INFO,
3818 : (errmsg("index \"%s\" was reindexed",
3819 : get_rel_name(indexId)),
3820 : errdetail_internal("%s",
2126 tgl 3821 ECB : pg_rusage_show(&ru0))));
3822 :
3823 : /* Roll back any GUC changes executed by index functions */
335 noah 3824 CBC 2465 : AtEOXact_GUC(false, save_nestlevel);
3825 :
3826 : /* Restore userid and security context */
335 noah 3827 GIC 2465 : SetUserIdAndSecContext(save_userid, save_sec_context);
1463 peter 3828 ECB :
6178 tgl 3829 : /* Close rels, but keep locks */
6096 tgl 3830 GIC 2465 : index_close(iRel, NoLock);
1539 andres 3831 2465 : table_close(heapRelation, NoLock);
3832 :
335 noah 3833 2465 : if (progress)
3834 730 : pgstat_progress_end_command();
3835 : }
8451 inoue 3836 ECB :
3837 : /*
3838 : * reindex_relation - This routine is used to recreate all indexes
6910 tgl 3839 : * of a relation (and optionally its toast relation too, if any).
3840 : *
3841 : * "flags" is a bitmask that can include any combination of these bits:
4809 3842 : *
4376 3843 : * REINDEX_REL_PROCESS_TOAST: if true, process the toast table too (if any).
3844 : *
3845 : * REINDEX_REL_SUPPRESS_INDEX_USE: if true, the relation was just completely
4462 rhaas 3846 : * rebuilt by an operation such as VACUUM FULL or CLUSTER, and therefore its
3847 : * indexes are inconsistent with it. This makes things tricky if the relation
3848 : * is a system catalog that we might consult during the reindexing. To deal
3849 : * with that case, we mark all of the indexes as pending rebuild so that they
3850 : * won't be trusted until rebuilt. The caller is required to call us *without*
3851 : * having made the rebuilt table visible by doing CommandCounterIncrement;
3852 : * we'll do CCI after having collected the index list. (This way we can still
3853 : * use catalog indexes while collecting the list.)
3854 : *
3855 : * REINDEX_REL_CHECK_CONSTRAINTS: if true, recheck unique and exclusion
3856 : * constraint conditions, else don't. To avoid deadlocks, VACUUM FULL or
3857 : * CLUSTER on a system catalog must omit this flag. REINDEX should be used to
3858 : * rebuild an index if constraint inconsistency is suspected. For optimal
3859 : * performance, other callers should include the flag only after transforming
3860 : * the data in a manner that risks a change in constraint validity.
3861 : *
3862 : * REINDEX_REL_FORCE_INDEXES_UNLOGGED: if true, set the persistence of the
3863 : * rebuilt indexes to unlogged.
3864 : *
3865 : * REINDEX_REL_FORCE_INDEXES_PERMANENT: if true, set the persistence of the
3866 : * rebuilt indexes to permanent.
3867 : *
3868 : * Returns true if any indexes were rebuilt (including toast table's index
3869 : * when relevant). Note that a CommandCounterIncrement will occur after each
3870 : * index rebuild.
3871 : */
3872 : bool
811 michael 3873 GIC 3101 : reindex_relation(Oid relid, int flags, ReindexParams *params)
3874 : {
3875 : Relation rel;
3876 : Oid toast_relid;
3877 : List *indexIds;
3878 : char persistence;
3879 : bool result;
3880 : ListCell *indexId;
3881 : int i;
3882 :
3883 : /*
3884 : * Open and lock the relation. ShareLock is sufficient since we only need
4293 rhaas 3885 ECB : * to prevent schema and data changes in it. The lock level used here
3886 : * should match ReindexTable().
3887 : */
811 michael 3888 GIC 3101 : if ((params->options & REINDEXOPT_MISSING_OK) != 0)
949 3889 294 : rel = try_table_open(relid, ShareLock);
3890 : else
3891 2807 : rel = table_open(relid, ShareLock);
3892 :
3893 : /* if relation is gone, leave */
3894 3101 : if (!rel)
949 michael 3895 UIC 0 : return false;
3896 :
3897 : /*
3898 : * Partitioned tables should never get processed here, as they have no
3899 : * physical storage.
1906 alvherre 3900 ECB : */
1906 alvherre 3901 CBC 3101 : if (rel->rd_rel->relkind == RELKIND_PARTITIONED_TABLE)
943 michael 3902 UIC 0 : elog(ERROR, "cannot reindex partitioned table \"%s.%s\"",
943 michael 3903 ECB : get_namespace_name(RelationGetNamespace(rel)),
3904 : RelationGetRelationName(rel));
3905 :
7137 tgl 3906 CBC 3101 : toast_relid = rel->rd_rel->reltoastrelid;
7137 tgl 3907 EUB :
3908 : /*
3909 : * Get the list of index OIDs for this relation. (We trust to the
3910 : * relcache to get this with a sequential scan if ignoring system
3911 : * indexes.)
3912 : */
7137 tgl 3913 CBC 3101 : indexIds = RelationGetIndexList(rel);
8053 bruce 3914 EUB :
1083 tgl 3915 GIC 3101 : if (flags & REINDEX_REL_SUPPRESS_INDEX_USE)
3916 : {
3917 : /* Suppress use of all the indexes until they are rebuilt */
1083 tgl 3918 CBC 684 : SetReindexPending(indexIds);
3919 :
3920 : /*
3921 : * Make the new heap contents visible --- now things might be
3922 : * inconsistent!
3923 : */
1083 tgl 3924 GIC 684 : CommandCounterIncrement();
1083 tgl 3925 ECB : }
3926 :
3927 : /*
3928 : * Compute persistence of indexes: same as that of owning rel, unless
3929 : * caller specified otherwise.
3930 : */
1083 tgl 3931 GIC 3101 : if (flags & REINDEX_REL_FORCE_INDEXES_UNLOGGED)
3932 10 : persistence = RELPERSISTENCE_UNLOGGED;
3933 3091 : else if (flags & REINDEX_REL_FORCE_INDEXES_PERMANENT)
3934 637 : persistence = RELPERSISTENCE_PERMANENT;
3935 : else
1083 tgl 3936 CBC 2454 : persistence = rel->rd_rel->relpersistence;
3937 :
3938 : /* Reindex all the indexes. */
1083 tgl 3939 GIC 3101 : i = 1;
3940 5518 : foreach(indexId, indexIds)
3941 : {
3942 2442 : Oid indexOid = lfirst_oid(indexId);
1083 tgl 3943 CBC 2442 : Oid indexNamespaceId = get_rel_namespace(indexOid);
7137 tgl 3944 ECB :
3067 alvherre 3945 : /*
1083 tgl 3946 : * Skip any invalid indexes on a TOAST table. These can only be
3947 : * duplicate leftovers from a failed REINDEX CONCURRENTLY, and if
3948 : * rebuilt it would not be possible to drop them anymore.
3949 : */
1083 tgl 3950 GIC 2442 : if (IsToastNamespace(indexNamespaceId) &&
1083 tgl 3951 CBC 899 : !get_index_isvalid(indexOid))
4809 tgl 3952 ECB : {
1083 tgl 3953 UIC 0 : ereport(WARNING,
1083 tgl 3954 ECB : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
3955 : errmsg("cannot reindex invalid index \"%s.%s\" on TOAST table, skipping",
3956 : get_namespace_name(indexNamespaceId),
3957 : get_rel_name(indexOid))));
1083 tgl 3958 UIC 0 : continue;
3959 : }
3960 :
1083 tgl 3961 GIC 2442 : reindex_index(indexOid, !(flags & REINDEX_REL_CHECK_CONSTRAINTS),
811 michael 3962 ECB : persistence, params);
4809 tgl 3963 :
1083 tgl 3964 GIC 2417 : CommandCounterIncrement();
4809 tgl 3965 EUB :
3966 : /* Index should no longer be in the pending list */
1083 tgl 3967 GIC 2417 : Assert(!ReindexIsProcessingIndex(indexOid));
3968 :
3969 : /* Set index rebuild count */
1083 tgl 3970 GBC 2417 : pgstat_progress_update_param(PROGRESS_CLUSTER_INDEX_REBUILD_COUNT,
3971 : i);
1083 tgl 3972 GIC 2417 : i++;
4809 tgl 3973 ECB : }
3974 :
3975 : /*
7137 3976 : * Close rel, but continue to hold the lock.
3977 : */
1539 andres 3978 GIC 3076 : table_close(rel, NoLock);
7503 tgl 3979 ECB :
7137 tgl 3980 GIC 3076 : result = (indexIds != NIL);
3981 :
7137 tgl 3982 ECB : /*
3983 : * If the relation has a secondary toast rel, reindex that too while we
1028 andres 3984 : * still hold the lock on the main table.
3985 : */
4376 tgl 3986 GIC 3076 : if ((flags & REINDEX_REL_PROCESS_TOAST) && OidIsValid(toast_relid))
3987 : {
3988 : /*
3989 : * Note that this should fail if the toast relation is missing, so
794 michael 3990 ECB : * reset REINDEXOPT_MISSING_OK. Even if a new tablespace is set for
3991 : * the parent relation, the indexes on its toast table are not moved.
3992 : * This rule is enforced by setting tablespaceOid to InvalidOid.
3993 : */
811 michael 3994 GIC 889 : ReindexParams newparams = *params;
3995 :
3996 889 : newparams.options &= ~(REINDEXOPT_MISSING_OK);
794 3997 889 : newparams.tablespaceOid = InvalidOid;
811 michael 3998 CBC 889 : result |= reindex_relation(toast_relid, flags, &newparams);
3999 : }
4000 :
7137 tgl 4001 GIC 3076 : return result;
4002 : }
4003 :
4004 :
4005 : /* ----------------------------------------------------------------
4809 tgl 4006 ECB : * System index reindexing support
4007 : *
4008 : * When we are busy reindexing a system index, this code provides support
4326 4009 : * for preventing catalog lookups from using that index. We also make use
4010 : * of this to catch attempted uses of user indexes during reindexing of
4011 : * those indexes. This information is propagated to parallel workers;
4012 : * attempting to change it during a parallel operation is not permitted.
4809 4013 : * ----------------------------------------------------------------
4014 : */
4015 :
4016 : static Oid currentlyReindexedHeap = InvalidOid;
4017 : static Oid currentlyReindexedIndex = InvalidOid;
4018 : static List *pendingReindexedIndexes = NIL;
4019 : static int reindexingNestLevel = 0;
4020 :
4021 : /*
4022 : * ReindexIsProcessingHeap
4023 : * True if heap specified by OID is currently being reindexed.
4024 : */
4025 : bool
4809 tgl 4026 GIC 33552 : ReindexIsProcessingHeap(Oid heapOid)
4027 : {
4028 33552 : return heapOid == currentlyReindexedHeap;
4029 : }
4030 :
4031 : /*
4032 : * ReindexIsCurrentlyProcessingIndex
4033 : * True if index specified by OID is currently being reindexed.
4034 : */
4035 : static bool
4326 4036 82 : ReindexIsCurrentlyProcessingIndex(Oid indexOid)
4037 : {
4326 tgl 4038 CBC 82 : return indexOid == currentlyReindexedIndex;
4039 : }
4326 tgl 4040 ECB :
4041 : /*
4042 : * ReindexIsProcessingIndex
4043 : * True if index specified by OID is currently being reindexed,
4044 : * or should be treated as invalid because it is awaiting reindex.
4045 : */
4046 : bool
4809 tgl 4047 GIC 26474702 : ReindexIsProcessingIndex(Oid indexOid)
4809 tgl 4048 ECB : {
4809 tgl 4049 GIC 52944960 : return indexOid == currentlyReindexedIndex ||
4809 tgl 4050 CBC 26470258 : list_member_oid(pendingReindexedIndexes, indexOid);
4051 : }
4052 :
4053 : /*
4054 : * SetReindexProcessing
4055 : * Set flag that specified heap/index are being reindexed.
4056 : */
4057 : static void
4809 tgl 4058 GIC 2477 : SetReindexProcessing(Oid heapOid, Oid indexOid)
4809 tgl 4059 ECB : {
4809 tgl 4060 GIC 2477 : Assert(OidIsValid(heapOid) && OidIsValid(indexOid));
4809 tgl 4061 ECB : /* Reindexing is not re-entrant. */
4809 tgl 4062 CBC 2477 : if (OidIsValid(currentlyReindexedHeap))
4809 tgl 4063 UIC 0 : elog(ERROR, "cannot reindex while reindexing");
4809 tgl 4064 GIC 2477 : currentlyReindexedHeap = heapOid;
4065 2477 : currentlyReindexedIndex = indexOid;
4066 : /* Index is no longer "pending" reindex. */
4326 4067 2477 : RemoveReindexPending(indexOid);
4068 : /* This may have been set already, but in case it isn't, do so now. */
1083 4069 2477 : reindexingNestLevel = GetCurrentTransactionNestLevel();
4809 tgl 4070 CBC 2477 : }
4071 :
4809 tgl 4072 ECB : /*
4073 : * ResetReindexProcessing
4074 : * Unset reindexing status.
4809 tgl 4075 EUB : */
4809 tgl 4076 ECB : static void
4809 tgl 4077 CBC 2495 : ResetReindexProcessing(void)
4078 : {
4079 2495 : currentlyReindexedHeap = InvalidOid;
4809 tgl 4080 GIC 2495 : currentlyReindexedIndex = InvalidOid;
1083 tgl 4081 ECB : /* reindexingNestLevel remains set till end of (sub)transaction */
4809 tgl 4082 CBC 2495 : }
4083 :
4084 : /*
4085 : * SetReindexPending
4086 : * Mark the given indexes as pending reindex.
4087 : *
4088 : * NB: we assume that the current memory context stays valid throughout.
4809 tgl 4089 ECB : */
4090 : static void
4809 tgl 4091 CBC 684 : SetReindexPending(List *indexes)
4809 tgl 4092 ECB : {
4093 : /* Reindexing is not re-entrant. */
4809 tgl 4094 CBC 684 : if (pendingReindexedIndexes)
4809 tgl 4095 UIC 0 : elog(ERROR, "cannot reindex while reindexing");
1906 rhaas 4096 GIC 684 : if (IsInParallelMode())
1906 rhaas 4097 UIC 0 : elog(ERROR, "cannot modify reindex state during a parallel operation");
4809 tgl 4098 GIC 684 : pendingReindexedIndexes = list_copy(indexes);
1083 4099 684 : reindexingNestLevel = GetCurrentTransactionNestLevel();
4809 4100 684 : }
4101 :
4102 : /*
4809 tgl 4103 ECB : * RemoveReindexPending
4104 : * Remove the given index from the pending list.
4105 : */
4106 : static void
4809 tgl 4107 GBC 2477 : RemoveReindexPending(Oid indexOid)
4809 tgl 4108 ECB : {
1906 rhaas 4109 GBC 2477 : if (IsInParallelMode())
1906 rhaas 4110 LBC 0 : elog(ERROR, "cannot modify reindex state during a parallel operation");
4809 tgl 4111 CBC 2477 : pendingReindexedIndexes = list_delete_oid(pendingReindexedIndexes,
4809 tgl 4112 ECB : indexOid);
4809 tgl 4113 GIC 2477 : }
4114 :
4115 : /*
4116 : * ResetReindexState
4117 : * Clear all reindexing state during (sub)transaction abort.
4118 : */
1083 tgl 4119 ECB : void
1083 tgl 4120 GIC 24566 : ResetReindexState(int nestLevel)
4809 tgl 4121 ECB : {
1083 tgl 4122 EUB : /*
1083 tgl 4123 ECB : * Because reindexing is not re-entrant, we don't need to cope with nested
4124 : * reindexing states. We just need to avoid messing up the outer-level
4125 : * state in case a subtransaction fails within a REINDEX. So checking the
4126 : * current nest level against that of the reindex operation is sufficient.
4127 : */
1083 tgl 4128 GIC 24566 : if (reindexingNestLevel >= nestLevel)
4129 : {
4130 449 : currentlyReindexedHeap = InvalidOid;
4131 449 : currentlyReindexedIndex = InvalidOid;
1083 tgl 4132 ECB :
4133 : /*
4134 : * We needn't try to release the contents of pendingReindexedIndexes;
4135 : * that list should be in a transaction-lifespan context, so it will
4136 : * go away automatically.
4137 : */
1083 tgl 4138 GIC 449 : pendingReindexedIndexes = NIL;
4139 :
1083 tgl 4140 CBC 449 : reindexingNestLevel = 0;
4141 : }
4809 4142 24566 : }
1906 rhaas 4143 ECB :
4144 : /*
4145 : * EstimateReindexStateSpace
4146 : * Estimate space needed to pass reindex state to parallel workers.
4147 : */
4148 : Size
1906 rhaas 4149 GIC 403 : EstimateReindexStateSpace(void)
1906 rhaas 4150 ECB : {
4151 : return offsetof(SerializedReindexState, pendingReindexedIndexes)
1906 rhaas 4152 CBC 403 : + mul_size(sizeof(Oid), list_length(pendingReindexedIndexes));
4153 : }
1906 rhaas 4154 ECB :
4155 : /*
4156 : * SerializeReindexState
4157 : * Serialize reindex state for parallel workers.
4158 : */
4159 : void
1906 rhaas 4160 GIC 403 : SerializeReindexState(Size maxsize, char *start_address)
1906 rhaas 4161 ECB : {
1906 rhaas 4162 GIC 403 : SerializedReindexState *sistate = (SerializedReindexState *) start_address;
4163 403 : int c = 0;
1906 rhaas 4164 ECB : ListCell *lc;
4165 :
1906 rhaas 4166 GIC 403 : sistate->currentlyReindexedHeap = currentlyReindexedHeap;
4167 403 : sistate->currentlyReindexedIndex = currentlyReindexedIndex;
4168 403 : sistate->numPendingReindexedIndexes = list_length(pendingReindexedIndexes);
4169 403 : foreach(lc, pendingReindexedIndexes)
1906 rhaas 4170 UIC 0 : sistate->pendingReindexedIndexes[c++] = lfirst_oid(lc);
1906 rhaas 4171 GIC 403 : }
1906 rhaas 4172 ECB :
4173 : /*
4174 : * RestoreReindexState
4175 : * Restore reindex state in a parallel worker.
4176 : */
4177 : void
1906 rhaas 4178 CBC 1298 : RestoreReindexState(void *reindexstate)
1906 rhaas 4179 ECB : {
1906 rhaas 4180 CBC 1298 : SerializedReindexState *sistate = (SerializedReindexState *) reindexstate;
4181 1298 : int c = 0;
1809 tgl 4182 EUB : MemoryContext oldcontext;
1906 rhaas 4183 ECB :
1906 rhaas 4184 GIC 1298 : currentlyReindexedHeap = sistate->currentlyReindexedHeap;
4185 1298 : currentlyReindexedIndex = sistate->currentlyReindexedIndex;
4186 :
4187 1298 : Assert(pendingReindexedIndexes == NIL);
4188 1298 : oldcontext = MemoryContextSwitchTo(TopMemoryContext);
4189 1298 : for (c = 0; c < sistate->numPendingReindexedIndexes; ++c)
1906 rhaas 4190 LBC 0 : pendingReindexedIndexes =
1906 rhaas 4191 UIC 0 : lappend_oid(pendingReindexedIndexes,
1906 rhaas 4192 ECB : sistate->pendingReindexedIndexes[c]);
1906 rhaas 4193 CBC 1298 : MemoryContextSwitchTo(oldcontext);
4194 :
4195 : /* Note the worker has its own transaction nesting level */
1083 tgl 4196 1298 : reindexingNestLevel = GetCurrentTransactionNestLevel();
1906 rhaas 4197 1298 : }
|
