PostgreSQL Source Code  git master
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
indexcmds.c
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * indexcmds.c
4  * POSTGRES define and remove index code.
5  *
6  * Portions Copyright (c) 1996-2017, PostgreSQL Global Development Group
7  * Portions Copyright (c) 1994, Regents of the University of California
8  *
9  *
10  * IDENTIFICATION
11  * src/backend/commands/indexcmds.c
12  *
13  *-------------------------------------------------------------------------
14  */
15 
16 #include "postgres.h"
17 
18 #include "access/amapi.h"
19 #include "access/htup_details.h"
20 #include "access/reloptions.h"
21 #include "access/sysattr.h"
22 #include "access/xact.h"
23 #include "catalog/catalog.h"
24 #include "catalog/index.h"
25 #include "catalog/indexing.h"
26 #include "catalog/pg_am.h"
27 #include "catalog/pg_opclass.h"
28 #include "catalog/pg_opfamily.h"
29 #include "catalog/pg_tablespace.h"
30 #include "catalog/pg_type.h"
31 #include "commands/comment.h"
32 #include "commands/dbcommands.h"
33 #include "commands/defrem.h"
34 #include "commands/tablecmds.h"
35 #include "commands/tablespace.h"
36 #include "mb/pg_wchar.h"
37 #include "miscadmin.h"
38 #include "nodes/nodeFuncs.h"
39 #include "optimizer/clauses.h"
40 #include "optimizer/planner.h"
41 #include "optimizer/var.h"
42 #include "parser/parse_coerce.h"
43 #include "parser/parse_func.h"
44 #include "parser/parse_oper.h"
45 #include "storage/lmgr.h"
46 #include "storage/proc.h"
47 #include "storage/procarray.h"
48 #include "utils/acl.h"
49 #include "utils/builtins.h"
50 #include "utils/fmgroids.h"
51 #include "utils/inval.h"
52 #include "utils/lsyscache.h"
53 #include "utils/memutils.h"
54 #include "utils/regproc.h"
55 #include "utils/snapmgr.h"
56 #include "utils/syscache.h"
57 #include "utils/tqual.h"
58 
59 
60 /* non-export function prototypes */
61 static void CheckPredicate(Expr *predicate);
62 static void ComputeIndexAttrs(IndexInfo *indexInfo,
63  Oid *typeOidP,
64  Oid *collationOidP,
65  Oid *classOidP,
66  int16 *colOptionP,
67  List *attList,
68  List *exclusionOpNames,
69  Oid relId,
70  char *accessMethodName, Oid accessMethodId,
71  bool amcanorder,
72  bool isconstraint);
73 static char *ChooseIndexName(const char *tabname, Oid namespaceId,
74  List *colnames, List *exclusionOpNames,
75  bool primary, bool isconstraint);
76 static char *ChooseIndexNameAddition(List *colnames);
77 static List *ChooseIndexColumnNames(List *indexElems);
78 static void RangeVarCallbackForReindexIndex(const RangeVar *relation,
79  Oid relId, Oid oldRelId, void *arg);
80 
81 /*
82  * CheckIndexCompatible
83  * Determine whether an existing index definition is compatible with a
84  * prospective index definition, such that the existing index storage
85  * could become the storage of the new index, avoiding a rebuild.
86  *
87  * 'heapRelation': the relation the index would apply to.
88  * 'accessMethodName': name of the AM to use.
89  * 'attributeList': a list of IndexElem specifying columns and expressions
90  * to index on.
91  * 'exclusionOpNames': list of names of exclusion-constraint operators,
92  * or NIL if not an exclusion constraint.
93  *
94  * This is tailored to the needs of ALTER TABLE ALTER TYPE, which recreates
95  * any indexes that depended on a changing column from their pg_get_indexdef
96  * or pg_get_constraintdef definitions. We omit some of the sanity checks of
97  * DefineIndex. We assume that the old and new indexes have the same number
98  * of columns and that if one has an expression column or predicate, both do.
99  * Errors arising from the attribute list still apply.
100  *
101  * Most column type changes that can skip a table rewrite do not invalidate
102  * indexes. We acknowledge this when all operator classes, collations and
103  * exclusion operators match. Though we could further permit intra-opfamily
104  * changes for btree and hash indexes, that adds subtle complexity with no
105  * concrete benefit for core types.
106 
107  * When a comparison or exclusion operator has a polymorphic input type, the
108  * actual input types must also match. This defends against the possibility
109  * that operators could vary behavior in response to get_fn_expr_argtype().
110  * At present, this hazard is theoretical: check_exclusion_constraint() and
111  * all core index access methods decline to set fn_expr for such calls.
112  *
113  * We do not yet implement a test to verify compatibility of expression
114  * columns or predicates, so assume any such index is incompatible.
115  */
116 bool
118  char *accessMethodName,
119  List *attributeList,
120  List *exclusionOpNames)
121 {
122  bool isconstraint;
123  Oid *typeObjectId;
124  Oid *collationObjectId;
125  Oid *classObjectId;
126  Oid accessMethodId;
127  Oid relationId;
128  HeapTuple tuple;
129  Form_pg_index indexForm;
130  Form_pg_am accessMethodForm;
131  IndexAmRoutine *amRoutine;
132  bool amcanorder;
133  int16 *coloptions;
134  IndexInfo *indexInfo;
135  int numberOfAttributes;
136  int old_natts;
137  bool isnull;
138  bool ret = true;
139  oidvector *old_indclass;
140  oidvector *old_indcollation;
141  Relation irel;
142  int i;
143  Datum d;
144 
145  /* Caller should already have the relation locked in some way. */
146  relationId = IndexGetRelation(oldId, false);
147 
148  /*
149  * We can pretend isconstraint = false unconditionally. It only serves to
150  * decide the text of an error message that should never happen for us.
151  */
152  isconstraint = false;
153 
154  numberOfAttributes = list_length(attributeList);
155  Assert(numberOfAttributes > 0);
156  Assert(numberOfAttributes <= INDEX_MAX_KEYS);
157 
158  /* look up the access method */
159  tuple = SearchSysCache1(AMNAME, PointerGetDatum(accessMethodName));
160  if (!HeapTupleIsValid(tuple))
161  ereport(ERROR,
162  (errcode(ERRCODE_UNDEFINED_OBJECT),
163  errmsg("access method \"%s\" does not exist",
164  accessMethodName)));
165  accessMethodId = HeapTupleGetOid(tuple);
166  accessMethodForm = (Form_pg_am) GETSTRUCT(tuple);
167  amRoutine = GetIndexAmRoutine(accessMethodForm->amhandler);
168  ReleaseSysCache(tuple);
169 
170  amcanorder = amRoutine->amcanorder;
171 
172  /*
173  * Compute the operator classes, collations, and exclusion operators for
174  * the new index, so we can test whether it's compatible with the existing
175  * one. Note that ComputeIndexAttrs might fail here, but that's OK:
176  * DefineIndex would have called this function with the same arguments
177  * later on, and it would have failed then anyway.
178  */
179  indexInfo = makeNode(IndexInfo);
180  indexInfo->ii_Expressions = NIL;
181  indexInfo->ii_ExpressionsState = NIL;
182  indexInfo->ii_PredicateState = NIL;
183  indexInfo->ii_ExclusionOps = NULL;
184  indexInfo->ii_ExclusionProcs = NULL;
185  indexInfo->ii_ExclusionStrats = NULL;
186  indexInfo->ii_AmCache = NULL;
187  indexInfo->ii_Context = CurrentMemoryContext;
188  typeObjectId = (Oid *) palloc(numberOfAttributes * sizeof(Oid));
189  collationObjectId = (Oid *) palloc(numberOfAttributes * sizeof(Oid));
190  classObjectId = (Oid *) palloc(numberOfAttributes * sizeof(Oid));
191  coloptions = (int16 *) palloc(numberOfAttributes * sizeof(int16));
192  ComputeIndexAttrs(indexInfo,
193  typeObjectId, collationObjectId, classObjectId,
194  coloptions, attributeList,
195  exclusionOpNames, relationId,
196  accessMethodName, accessMethodId,
197  amcanorder, isconstraint);
198 
199 
200  /* Get the soon-obsolete pg_index tuple. */
202  if (!HeapTupleIsValid(tuple))
203  elog(ERROR, "cache lookup failed for index %u", oldId);
204  indexForm = (Form_pg_index) GETSTRUCT(tuple);
205 
206  /*
207  * We don't assess expressions or predicates; assume incompatibility.
208  * Also, if the index is invalid for any reason, treat it as incompatible.
209  */
210  if (!(heap_attisnull(tuple, Anum_pg_index_indpred) &&
212  IndexIsValid(indexForm)))
213  {
214  ReleaseSysCache(tuple);
215  return false;
216  }
217 
218  /* Any change in operator class or collation breaks compatibility. */
219  old_natts = indexForm->indnatts;
220  Assert(old_natts == numberOfAttributes);
221 
223  Assert(!isnull);
224  old_indcollation = (oidvector *) DatumGetPointer(d);
225 
226  d = SysCacheGetAttr(INDEXRELID, tuple, Anum_pg_index_indclass, &isnull);
227  Assert(!isnull);
228  old_indclass = (oidvector *) DatumGetPointer(d);
229 
230  ret = (memcmp(old_indclass->values, classObjectId,
231  old_natts * sizeof(Oid)) == 0 &&
232  memcmp(old_indcollation->values, collationObjectId,
233  old_natts * sizeof(Oid)) == 0);
234 
235  ReleaseSysCache(tuple);
236 
237  if (!ret)
238  return false;
239 
240  /* For polymorphic opcintype, column type changes break compatibility. */
241  irel = index_open(oldId, AccessShareLock); /* caller probably has a lock */
242  for (i = 0; i < old_natts; i++)
243  {
244  if (IsPolymorphicType(get_opclass_input_type(classObjectId[i])) &&
245  irel->rd_att->attrs[i]->atttypid != typeObjectId[i])
246  {
247  ret = false;
248  break;
249  }
250  }
251 
252  /* Any change in exclusion operator selections breaks compatibility. */
253  if (ret && indexInfo->ii_ExclusionOps != NULL)
254  {
255  Oid *old_operators,
256  *old_procs;
257  uint16 *old_strats;
258 
259  RelationGetExclusionInfo(irel, &old_operators, &old_procs, &old_strats);
260  ret = memcmp(old_operators, indexInfo->ii_ExclusionOps,
261  old_natts * sizeof(Oid)) == 0;
262 
263  /* Require an exact input type match for polymorphic operators. */
264  if (ret)
265  {
266  for (i = 0; i < old_natts && ret; i++)
267  {
268  Oid left,
269  right;
270 
271  op_input_types(indexInfo->ii_ExclusionOps[i], &left, &right);
272  if ((IsPolymorphicType(left) || IsPolymorphicType(right)) &&
273  irel->rd_att->attrs[i]->atttypid != typeObjectId[i])
274  {
275  ret = false;
276  break;
277  }
278  }
279  }
280  }
281 
282  index_close(irel, NoLock);
283  return ret;
284 }
285 
286 /*
287  * DefineIndex
288  * Creates a new index.
289  *
290  * 'relationId': the OID of the heap relation on which the index is to be
291  * created
292  * 'stmt': IndexStmt describing the properties of the new index.
293  * 'indexRelationId': normally InvalidOid, but during bootstrap can be
294  * nonzero to specify a preselected OID for the index.
295  * 'is_alter_table': this is due to an ALTER rather than a CREATE operation.
296  * 'check_rights': check for CREATE rights in namespace and tablespace. (This
297  * should be true except when ALTER is deleting/recreating an index.)
298  * 'skip_build': make the catalog entries but leave the index file empty;
299  * it will be filled later.
300  * 'quiet': suppress the NOTICE chatter ordinarily provided for constraints.
301  *
302  * Returns the object address of the created index.
303  */
305 DefineIndex(Oid relationId,
306  IndexStmt *stmt,
307  Oid indexRelationId,
308  bool is_alter_table,
309  bool check_rights,
310  bool skip_build,
311  bool quiet)
312 {
313  char *indexRelationName;
314  char *accessMethodName;
315  Oid *typeObjectId;
316  Oid *collationObjectId;
317  Oid *classObjectId;
318  Oid accessMethodId;
319  Oid namespaceId;
320  Oid tablespaceId;
321  List *indexColNames;
322  Relation rel;
323  Relation indexRelation;
324  HeapTuple tuple;
325  Form_pg_am accessMethodForm;
326  IndexAmRoutine *amRoutine;
327  bool amcanorder;
328  amoptions_function amoptions;
329  Datum reloptions;
330  int16 *coloptions;
331  IndexInfo *indexInfo;
332  int numberOfAttributes;
333  TransactionId limitXmin;
334  VirtualTransactionId *old_snapshots;
335  ObjectAddress address;
336  int n_old_snapshots;
337  LockRelId heaprelid;
338  LOCKTAG heaplocktag;
339  LOCKMODE lockmode;
340  Snapshot snapshot;
341  int i;
342 
343  /*
344  * count attributes in index
345  */
346  numberOfAttributes = list_length(stmt->indexParams);
347  if (numberOfAttributes <= 0)
348  ereport(ERROR,
349  (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
350  errmsg("must specify at least one column")));
351  if (numberOfAttributes > INDEX_MAX_KEYS)
352  ereport(ERROR,
353  (errcode(ERRCODE_TOO_MANY_COLUMNS),
354  errmsg("cannot use more than %d columns in an index",
355  INDEX_MAX_KEYS)));
356 
357  /*
358  * Only SELECT ... FOR UPDATE/SHARE are allowed while doing a standard
359  * index build; but for concurrent builds we allow INSERT/UPDATE/DELETE
360  * (but not VACUUM).
361  *
362  * NB: Caller is responsible for making sure that relationId refers to the
363  * relation on which the index should be built; except in bootstrap mode,
364  * this will typically require the caller to have already locked the
365  * relation. To avoid lock upgrade hazards, that lock should be at least
366  * as strong as the one we take here.
367  */
368  lockmode = stmt->concurrent ? ShareUpdateExclusiveLock : ShareLock;
369  rel = heap_open(relationId, lockmode);
370 
371  relationId = RelationGetRelid(rel);
372  namespaceId = RelationGetNamespace(rel);
373 
374  if (rel->rd_rel->relkind != RELKIND_RELATION &&
375  rel->rd_rel->relkind != RELKIND_MATVIEW)
376  {
377  if (rel->rd_rel->relkind == RELKIND_FOREIGN_TABLE)
378 
379  /*
380  * Custom error message for FOREIGN TABLE since the term is close
381  * to a regular table and can confuse the user.
382  */
383  ereport(ERROR,
384  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
385  errmsg("cannot create index on foreign table \"%s\"",
386  RelationGetRelationName(rel))));
387  else if (rel->rd_rel->relkind == RELKIND_PARTITIONED_TABLE)
388  ereport(ERROR,
389  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
390  errmsg("cannot create index on partitioned table \"%s\"",
391  RelationGetRelationName(rel))));
392  else
393  ereport(ERROR,
394  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
395  errmsg("\"%s\" is not a table or materialized view",
396  RelationGetRelationName(rel))));
397  }
398 
399  /*
400  * Don't try to CREATE INDEX on temp tables of other backends.
401  */
402  if (RELATION_IS_OTHER_TEMP(rel))
403  ereport(ERROR,
404  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
405  errmsg("cannot create indexes on temporary tables of other sessions")));
406 
407  /*
408  * Verify we (still) have CREATE rights in the rel's namespace.
409  * (Presumably we did when the rel was created, but maybe not anymore.)
410  * Skip check if caller doesn't want it. Also skip check if
411  * bootstrapping, since permissions machinery may not be working yet.
412  */
413  if (check_rights && !IsBootstrapProcessingMode())
414  {
415  AclResult aclresult;
416 
417  aclresult = pg_namespace_aclcheck(namespaceId, GetUserId(),
418  ACL_CREATE);
419  if (aclresult != ACLCHECK_OK)
421  get_namespace_name(namespaceId));
422  }
423 
424  /*
425  * Select tablespace to use. If not specified, use default tablespace
426  * (which may in turn default to database's default).
427  */
428  if (stmt->tableSpace)
429  {
430  tablespaceId = get_tablespace_oid(stmt->tableSpace, false);
431  }
432  else
433  {
434  tablespaceId = GetDefaultTablespace(rel->rd_rel->relpersistence);
435  /* note InvalidOid is OK in this case */
436  }
437 
438  /* Check tablespace permissions */
439  if (check_rights &&
440  OidIsValid(tablespaceId) && tablespaceId != MyDatabaseTableSpace)
441  {
442  AclResult aclresult;
443 
444  aclresult = pg_tablespace_aclcheck(tablespaceId, GetUserId(),
445  ACL_CREATE);
446  if (aclresult != ACLCHECK_OK)
448  get_tablespace_name(tablespaceId));
449  }
450 
451  /*
452  * Force shared indexes into the pg_global tablespace. This is a bit of a
453  * hack but seems simpler than marking them in the BKI commands. On the
454  * other hand, if it's not shared, don't allow it to be placed there.
455  */
456  if (rel->rd_rel->relisshared)
457  tablespaceId = GLOBALTABLESPACE_OID;
458  else if (tablespaceId == GLOBALTABLESPACE_OID)
459  ereport(ERROR,
460  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
461  errmsg("only shared relations can be placed in pg_global tablespace")));
462 
463  /*
464  * Choose the index column names.
465  */
466  indexColNames = ChooseIndexColumnNames(stmt->indexParams);
467 
468  /*
469  * Select name for index if caller didn't specify
470  */
471  indexRelationName = stmt->idxname;
472  if (indexRelationName == NULL)
473  indexRelationName = ChooseIndexName(RelationGetRelationName(rel),
474  namespaceId,
475  indexColNames,
476  stmt->excludeOpNames,
477  stmt->primary,
478  stmt->isconstraint);
479 
480  /*
481  * look up the access method, verify it can handle the requested features
482  */
483  accessMethodName = stmt->accessMethod;
484  tuple = SearchSysCache1(AMNAME, PointerGetDatum(accessMethodName));
485  if (!HeapTupleIsValid(tuple))
486  {
487  /*
488  * Hack to provide more-or-less-transparent updating of old RTREE
489  * indexes to GiST: if RTREE is requested and not found, use GIST.
490  */
491  if (strcmp(accessMethodName, "rtree") == 0)
492  {
493  ereport(NOTICE,
494  (errmsg("substituting access method \"gist\" for obsolete method \"rtree\"")));
495  accessMethodName = "gist";
496  tuple = SearchSysCache1(AMNAME, PointerGetDatum(accessMethodName));
497  }
498 
499  if (!HeapTupleIsValid(tuple))
500  ereport(ERROR,
501  (errcode(ERRCODE_UNDEFINED_OBJECT),
502  errmsg("access method \"%s\" does not exist",
503  accessMethodName)));
504  }
505  accessMethodId = HeapTupleGetOid(tuple);
506  accessMethodForm = (Form_pg_am) GETSTRUCT(tuple);
507  amRoutine = GetIndexAmRoutine(accessMethodForm->amhandler);
508 
509  if (strcmp(accessMethodName, "hash") == 0 &&
510  RelationNeedsWAL(rel))
512  (errmsg("hash indexes are not WAL-logged and their use is discouraged")));
513 
514  if (stmt->unique && !amRoutine->amcanunique)
515  ereport(ERROR,
516  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
517  errmsg("access method \"%s\" does not support unique indexes",
518  accessMethodName)));
519  if (numberOfAttributes > 1 && !amRoutine->amcanmulticol)
520  ereport(ERROR,
521  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
522  errmsg("access method \"%s\" does not support multicolumn indexes",
523  accessMethodName)));
524  if (stmt->excludeOpNames && amRoutine->amgettuple == NULL)
525  ereport(ERROR,
526  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
527  errmsg("access method \"%s\" does not support exclusion constraints",
528  accessMethodName)));
529 
530  amcanorder = amRoutine->amcanorder;
531  amoptions = amRoutine->amoptions;
532 
533  pfree(amRoutine);
534  ReleaseSysCache(tuple);
535 
536  /*
537  * Validate predicate, if given
538  */
539  if (stmt->whereClause)
540  CheckPredicate((Expr *) stmt->whereClause);
541 
542  /*
543  * Parse AM-specific options, convert to text array form, validate.
544  */
545  reloptions = transformRelOptions((Datum) 0, stmt->options,
546  NULL, NULL, false, false);
547 
548  (void) index_reloptions(amoptions, reloptions, true);
549 
550  /*
551  * Prepare arguments for index_create, primarily an IndexInfo structure.
552  * Note that ii_Predicate must be in implicit-AND format.
553  */
554  indexInfo = makeNode(IndexInfo);
555  indexInfo->ii_NumIndexAttrs = numberOfAttributes;
556  indexInfo->ii_Expressions = NIL; /* for now */
557  indexInfo->ii_ExpressionsState = NIL;
558  indexInfo->ii_Predicate = make_ands_implicit((Expr *) stmt->whereClause);
559  indexInfo->ii_PredicateState = NIL;
560  indexInfo->ii_ExclusionOps = NULL;
561  indexInfo->ii_ExclusionProcs = NULL;
562  indexInfo->ii_ExclusionStrats = NULL;
563  indexInfo->ii_Unique = stmt->unique;
564  /* In a concurrent build, mark it not-ready-for-inserts */
565  indexInfo->ii_ReadyForInserts = !stmt->concurrent;
566  indexInfo->ii_Concurrent = stmt->concurrent;
567  indexInfo->ii_BrokenHotChain = false;
568  indexInfo->ii_AmCache = NULL;
569  indexInfo->ii_Context = CurrentMemoryContext;
570 
571  typeObjectId = (Oid *) palloc(numberOfAttributes * sizeof(Oid));
572  collationObjectId = (Oid *) palloc(numberOfAttributes * sizeof(Oid));
573  classObjectId = (Oid *) palloc(numberOfAttributes * sizeof(Oid));
574  coloptions = (int16 *) palloc(numberOfAttributes * sizeof(int16));
575  ComputeIndexAttrs(indexInfo,
576  typeObjectId, collationObjectId, classObjectId,
577  coloptions, stmt->indexParams,
578  stmt->excludeOpNames, relationId,
579  accessMethodName, accessMethodId,
580  amcanorder, stmt->isconstraint);
581 
582  /*
583  * Extra checks when creating a PRIMARY KEY index.
584  */
585  if (stmt->primary)
586  index_check_primary_key(rel, indexInfo, is_alter_table);
587 
588  /*
589  * We disallow indexes on system columns other than OID. They would not
590  * necessarily get updated correctly, and they don't seem useful anyway.
591  */
592  for (i = 0; i < indexInfo->ii_NumIndexAttrs; i++)
593  {
594  AttrNumber attno = indexInfo->ii_KeyAttrNumbers[i];
595 
596  if (attno < 0 && attno != ObjectIdAttributeNumber)
597  ereport(ERROR,
598  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
599  errmsg("index creation on system columns is not supported")));
600  }
601 
602  /*
603  * Also check for system columns used in expressions or predicates.
604  */
605  if (indexInfo->ii_Expressions || indexInfo->ii_Predicate)
606  {
607  Bitmapset *indexattrs = NULL;
608 
609  pull_varattnos((Node *) indexInfo->ii_Expressions, 1, &indexattrs);
610  pull_varattnos((Node *) indexInfo->ii_Predicate, 1, &indexattrs);
611 
612  for (i = FirstLowInvalidHeapAttributeNumber + 1; i < 0; i++)
613  {
614  if (i != ObjectIdAttributeNumber &&
616  indexattrs))
617  ereport(ERROR,
618  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
619  errmsg("index creation on system columns is not supported")));
620  }
621  }
622 
623  /*
624  * Report index creation if appropriate (delay this till after most of the
625  * error checks)
626  */
627  if (stmt->isconstraint && !quiet)
628  {
629  const char *constraint_type;
630 
631  if (stmt->primary)
632  constraint_type = "PRIMARY KEY";
633  else if (stmt->unique)
634  constraint_type = "UNIQUE";
635  else if (stmt->excludeOpNames != NIL)
636  constraint_type = "EXCLUDE";
637  else
638  {
639  elog(ERROR, "unknown constraint type");
640  constraint_type = NULL; /* keep compiler quiet */
641  }
642 
643  ereport(DEBUG1,
644  (errmsg("%s %s will create implicit index \"%s\" for table \"%s\"",
645  is_alter_table ? "ALTER TABLE / ADD" : "CREATE TABLE /",
646  constraint_type,
647  indexRelationName, RelationGetRelationName(rel))));
648  }
649 
650  /*
651  * A valid stmt->oldNode implies that we already have a built form of the
652  * index. The caller should also decline any index build.
653  */
654  Assert(!OidIsValid(stmt->oldNode) || (skip_build && !stmt->concurrent));
655 
656  /*
657  * Make the catalog entries for the index, including constraints. Then, if
658  * not skip_build || concurrent, actually build the index.
659  */
660  indexRelationId =
661  index_create(rel, indexRelationName, indexRelationId, stmt->oldNode,
662  indexInfo, indexColNames,
663  accessMethodId, tablespaceId,
664  collationObjectId, classObjectId,
665  coloptions, reloptions, stmt->primary,
666  stmt->isconstraint, stmt->deferrable, stmt->initdeferred,
668  skip_build || stmt->concurrent,
669  stmt->concurrent, !check_rights,
670  stmt->if_not_exists);
671 
672  ObjectAddressSet(address, RelationRelationId, indexRelationId);
673 
674  if (!OidIsValid(indexRelationId))
675  {
676  heap_close(rel, NoLock);
677  return address;
678  }
679 
680  /* Add any requested comment */
681  if (stmt->idxcomment != NULL)
682  CreateComments(indexRelationId, RelationRelationId, 0,
683  stmt->idxcomment);
684 
685  if (!stmt->concurrent)
686  {
687  /* Close the heap and we're done, in the non-concurrent case */
688  heap_close(rel, NoLock);
689  return address;
690  }
691 
692  /* save lockrelid and locktag for below, then close rel */
693  heaprelid = rel->rd_lockInfo.lockRelId;
694  SET_LOCKTAG_RELATION(heaplocktag, heaprelid.dbId, heaprelid.relId);
695  heap_close(rel, NoLock);
696 
697  /*
698  * For a concurrent build, it's important to make the catalog entries
699  * visible to other transactions before we start to build the index. That
700  * will prevent them from making incompatible HOT updates. The new index
701  * will be marked not indisready and not indisvalid, so that no one else
702  * tries to either insert into it or use it for queries.
703  *
704  * We must commit our current transaction so that the index becomes
705  * visible; then start another. Note that all the data structures we just
706  * built are lost in the commit. The only data we keep past here are the
707  * relation IDs.
708  *
709  * Before committing, get a session-level lock on the table, to ensure
710  * that neither it nor the index can be dropped before we finish. This
711  * cannot block, even if someone else is waiting for access, because we
712  * already have the same lock within our transaction.
713  *
714  * Note: we don't currently bother with a session lock on the index,
715  * because there are no operations that could change its state while we
716  * hold lock on the parent table. This might need to change later.
717  */
719 
723 
724  /*
725  * Phase 2 of concurrent index build (see comments for validate_index()
726  * for an overview of how this works)
727  *
728  * Now we must wait until no running transaction could have the table open
729  * with the old list of indexes. Use ShareLock to consider running
730  * transactions that hold locks that permit writing to the table. Note we
731  * do not need to worry about xacts that open the table for writing after
732  * this point; they will see the new index when they open it.
733  *
734  * Note: the reason we use actual lock acquisition here, rather than just
735  * checking the ProcArray and sleeping, is that deadlock is possible if
736  * one of the transactions in question is blocked trying to acquire an
737  * exclusive lock on our table. The lock code will detect deadlock and
738  * error out properly.
739  */
740  WaitForLockers(heaplocktag, ShareLock);
741 
742  /*
743  * At this moment we are sure that there are no transactions with the
744  * table open for write that don't have this new index in their list of
745  * indexes. We have waited out all the existing transactions and any new
746  * transaction will have the new index in its list, but the index is still
747  * marked as "not-ready-for-inserts". The index is consulted while
748  * deciding HOT-safety though. This arrangement ensures that no new HOT
749  * chains can be created where the new tuple and the old tuple in the
750  * chain have different index keys.
751  *
752  * We now take a new snapshot, and build the index using all tuples that
753  * are visible in this snapshot. We can be sure that any HOT updates to
754  * these tuples will be compatible with the index, since any updates made
755  * by transactions that didn't know about the index are now committed or
756  * rolled back. Thus, each visible tuple is either the end of its
757  * HOT-chain or the extension of the chain is HOT-safe for this index.
758  */
759 
760  /* Open and lock the parent heap relation */
762 
763  /* And the target index relation */
764  indexRelation = index_open(indexRelationId, RowExclusiveLock);
765 
766  /* Set ActiveSnapshot since functions in the indexes may need it */
768 
769  /* We have to re-build the IndexInfo struct, since it was lost in commit */
770  indexInfo = BuildIndexInfo(indexRelation);
771  Assert(!indexInfo->ii_ReadyForInserts);
772  indexInfo->ii_Concurrent = true;
773  indexInfo->ii_BrokenHotChain = false;
774 
775  /* Now build the index */
776  index_build(rel, indexRelation, indexInfo, stmt->primary, false);
777 
778  /* Close both the relations, but keep the locks */
779  heap_close(rel, NoLock);
780  index_close(indexRelation, NoLock);
781 
782  /*
783  * Update the pg_index row to mark the index as ready for inserts. Once we
784  * commit this transaction, any new transactions that open the table must
785  * insert new entries into the index for insertions and non-HOT updates.
786  */
788 
789  /* we can do away with our snapshot */
791 
792  /*
793  * Commit this transaction to make the indisready update visible.
794  */
797 
798  /*
799  * Phase 3 of concurrent index build
800  *
801  * We once again wait until no transaction can have the table open with
802  * the index marked as read-only for updates.
803  */
804  WaitForLockers(heaplocktag, ShareLock);
805 
806  /*
807  * Now take the "reference snapshot" that will be used by validate_index()
808  * to filter candidate tuples. Beware! There might still be snapshots in
809  * use that treat some transaction as in-progress that our reference
810  * snapshot treats as committed. If such a recently-committed transaction
811  * deleted tuples in the table, we will not include them in the index; yet
812  * those transactions which see the deleting one as still-in-progress will
813  * expect such tuples to be there once we mark the index as valid.
814  *
815  * We solve this by waiting for all endangered transactions to exit before
816  * we mark the index as valid.
817  *
818  * We also set ActiveSnapshot to this snap, since functions in indexes may
819  * need a snapshot.
820  */
822  PushActiveSnapshot(snapshot);
823 
824  /*
825  * Scan the index and the heap, insert any missing index entries.
826  */
827  validate_index(relationId, indexRelationId, snapshot);
828 
829  /*
830  * Drop the reference snapshot. We must do this before waiting out other
831  * snapshot holders, else we will deadlock against other processes also
832  * doing CREATE INDEX CONCURRENTLY, which would see our snapshot as one
833  * they must wait for. But first, save the snapshot's xmin to use as
834  * limitXmin for GetCurrentVirtualXIDs().
835  */
836  limitXmin = snapshot->xmin;
837 
839  UnregisterSnapshot(snapshot);
840 
841  /*
842  * The index is now valid in the sense that it contains all currently
843  * interesting tuples. But since it might not contain tuples deleted just
844  * before the reference snap was taken, we have to wait out any
845  * transactions that might have older snapshots. Obtain a list of VXIDs
846  * of such transactions, and wait for them individually.
847  *
848  * We can exclude any running transactions that have xmin > the xmin of
849  * our reference snapshot; their oldest snapshot must be newer than ours.
850  * We can also exclude any transactions that have xmin = zero, since they
851  * evidently have no live snapshot at all (and any one they might be in
852  * process of taking is certainly newer than ours). Transactions in other
853  * DBs can be ignored too, since they'll never even be able to see this
854  * index.
855  *
856  * We can also exclude autovacuum processes and processes running manual
857  * lazy VACUUMs, because they won't be fazed by missing index entries
858  * either. (Manual ANALYZEs, however, can't be excluded because they
859  * might be within transactions that are going to do arbitrary operations
860  * later.)
861  *
862  * Also, GetCurrentVirtualXIDs never reports our own vxid, so we need not
863  * check for that.
864  *
865  * If a process goes idle-in-transaction with xmin zero, we do not need to
866  * wait for it anymore, per the above argument. We do not have the
867  * infrastructure right now to stop waiting if that happens, but we can at
868  * least avoid the folly of waiting when it is idle at the time we would
869  * begin to wait. We do this by repeatedly rechecking the output of
870  * GetCurrentVirtualXIDs. If, during any iteration, a particular vxid
871  * doesn't show up in the output, we know we can forget about it.
872  */
873  old_snapshots = GetCurrentVirtualXIDs(limitXmin, true, false,
875  &n_old_snapshots);
876 
877  for (i = 0; i < n_old_snapshots; i++)
878  {
879  if (!VirtualTransactionIdIsValid(old_snapshots[i]))
880  continue; /* found uninteresting in previous cycle */
881 
882  if (i > 0)
883  {
884  /* see if anything's changed ... */
885  VirtualTransactionId *newer_snapshots;
886  int n_newer_snapshots;
887  int j;
888  int k;
889 
890  newer_snapshots = GetCurrentVirtualXIDs(limitXmin,
891  true, false,
893  &n_newer_snapshots);
894  for (j = i; j < n_old_snapshots; j++)
895  {
896  if (!VirtualTransactionIdIsValid(old_snapshots[j]))
897  continue; /* found uninteresting in previous cycle */
898  for (k = 0; k < n_newer_snapshots; k++)
899  {
900  if (VirtualTransactionIdEquals(old_snapshots[j],
901  newer_snapshots[k]))
902  break;
903  }
904  if (k >= n_newer_snapshots) /* not there anymore */
905  SetInvalidVirtualTransactionId(old_snapshots[j]);
906  }
907  pfree(newer_snapshots);
908  }
909 
910  if (VirtualTransactionIdIsValid(old_snapshots[i]))
911  VirtualXactLock(old_snapshots[i], true);
912  }
913 
914  /*
915  * Index can now be marked valid -- update its pg_index entry
916  */
918 
919  /*
920  * The pg_index update will cause backends (including this one) to update
921  * relcache entries for the index itself, but we should also send a
922  * relcache inval on the parent table to force replanning of cached plans.
923  * Otherwise existing sessions might fail to use the new index where it
924  * would be useful. (Note that our earlier commits did not create reasons
925  * to replan; so relcache flush on the index itself was sufficient.)
926  */
928 
929  /*
930  * Last thing to do is release the session-level lock on the parent table.
931  */
933 
934  return address;
935 }
936 
937 
938 /*
939  * CheckMutability
940  * Test whether given expression is mutable
941  */
942 static bool
944 {
945  /*
946  * First run the expression through the planner. This has a couple of
947  * important consequences. First, function default arguments will get
948  * inserted, which may affect volatility (consider "default now()").
949  * Second, inline-able functions will get inlined, which may allow us to
950  * conclude that the function is really less volatile than it's marked. As
951  * an example, polymorphic functions must be marked with the most volatile
952  * behavior that they have for any input type, but once we inline the
953  * function we may be able to conclude that it's not so volatile for the
954  * particular input type we're dealing with.
955  *
956  * We assume here that expression_planner() won't scribble on its input.
957  */
958  expr = expression_planner(expr);
959 
960  /* Now we can search for non-immutable functions */
961  return contain_mutable_functions((Node *) expr);
962 }
963 
964 
965 /*
966  * CheckPredicate
967  * Checks that the given partial-index predicate is valid.
968  *
969  * This used to also constrain the form of the predicate to forms that
970  * indxpath.c could do something with. However, that seems overly
971  * restrictive. One useful application of partial indexes is to apply
972  * a UNIQUE constraint across a subset of a table, and in that scenario
973  * any evaluable predicate will work. So accept any predicate here
974  * (except ones requiring a plan), and let indxpath.c fend for itself.
975  */
976 static void
977 CheckPredicate(Expr *predicate)
978 {
979  /*
980  * transformExpr() should have already rejected subqueries, aggregates,
981  * and window functions, based on the EXPR_KIND_ for a predicate.
982  */
983 
984  /*
985  * A predicate using mutable functions is probably wrong, for the same
986  * reasons that we don't allow an index expression to use one.
987  */
988  if (CheckMutability(predicate))
989  ereport(ERROR,
990  (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
991  errmsg("functions in index predicate must be marked IMMUTABLE")));
992 }
993 
994 /*
995  * Compute per-index-column information, including indexed column numbers
996  * or index expressions, opclasses, and indoptions.
997  */
998 static void
1000  Oid *typeOidP,
1001  Oid *collationOidP,
1002  Oid *classOidP,
1003  int16 *colOptionP,
1004  List *attList, /* list of IndexElem's */
1005  List *exclusionOpNames,
1006  Oid relId,
1007  char *accessMethodName,
1008  Oid accessMethodId,
1009  bool amcanorder,
1010  bool isconstraint)
1011 {
1012  ListCell *nextExclOp;
1013  ListCell *lc;
1014  int attn;
1015 
1016  /* Allocate space for exclusion operator info, if needed */
1017  if (exclusionOpNames)
1018  {
1019  int ncols = list_length(attList);
1020 
1021  Assert(list_length(exclusionOpNames) == ncols);
1022  indexInfo->ii_ExclusionOps = (Oid *) palloc(sizeof(Oid) * ncols);
1023  indexInfo->ii_ExclusionProcs = (Oid *) palloc(sizeof(Oid) * ncols);
1024  indexInfo->ii_ExclusionStrats = (uint16 *) palloc(sizeof(uint16) * ncols);
1025  nextExclOp = list_head(exclusionOpNames);
1026  }
1027  else
1028  nextExclOp = NULL;
1029 
1030  /*
1031  * process attributeList
1032  */
1033  attn = 0;
1034  foreach(lc, attList)
1035  {
1036  IndexElem *attribute = (IndexElem *) lfirst(lc);
1037  Oid atttype;
1038  Oid attcollation;
1039 
1040  /*
1041  * Process the column-or-expression to be indexed.
1042  */
1043  if (attribute->name != NULL)
1044  {
1045  /* Simple index attribute */
1046  HeapTuple atttuple;
1047  Form_pg_attribute attform;
1048 
1049  Assert(attribute->expr == NULL);
1050  atttuple = SearchSysCacheAttName(relId, attribute->name);
1051  if (!HeapTupleIsValid(atttuple))
1052  {
1053  /* difference in error message spellings is historical */
1054  if (isconstraint)
1055  ereport(ERROR,
1056  (errcode(ERRCODE_UNDEFINED_COLUMN),
1057  errmsg("column \"%s\" named in key does not exist",
1058  attribute->name)));
1059  else
1060  ereport(ERROR,
1061  (errcode(ERRCODE_UNDEFINED_COLUMN),
1062  errmsg("column \"%s\" does not exist",
1063  attribute->name)));
1064  }
1065  attform = (Form_pg_attribute) GETSTRUCT(atttuple);
1066  indexInfo->ii_KeyAttrNumbers[attn] = attform->attnum;
1067  atttype = attform->atttypid;
1068  attcollation = attform->attcollation;
1069  ReleaseSysCache(atttuple);
1070  }
1071  else
1072  {
1073  /* Index expression */
1074  Node *expr = attribute->expr;
1075 
1076  Assert(expr != NULL);
1077  atttype = exprType(expr);
1078  attcollation = exprCollation(expr);
1079 
1080  /*
1081  * Strip any top-level COLLATE clause. This ensures that we treat
1082  * "x COLLATE y" and "(x COLLATE y)" alike.
1083  */
1084  while (IsA(expr, CollateExpr))
1085  expr = (Node *) ((CollateExpr *) expr)->arg;
1086 
1087  if (IsA(expr, Var) &&
1088  ((Var *) expr)->varattno != InvalidAttrNumber)
1089  {
1090  /*
1091  * User wrote "(column)" or "(column COLLATE something)".
1092  * Treat it like simple attribute anyway.
1093  */
1094  indexInfo->ii_KeyAttrNumbers[attn] = ((Var *) expr)->varattno;
1095  }
1096  else
1097  {
1098  indexInfo->ii_KeyAttrNumbers[attn] = 0; /* marks expression */
1099  indexInfo->ii_Expressions = lappend(indexInfo->ii_Expressions,
1100  expr);
1101 
1102  /*
1103  * transformExpr() should have already rejected subqueries,
1104  * aggregates, and window functions, based on the EXPR_KIND_
1105  * for an index expression.
1106  */
1107 
1108  /*
1109  * An expression using mutable functions is probably wrong,
1110  * since if you aren't going to get the same result for the
1111  * same data every time, it's not clear what the index entries
1112  * mean at all.
1113  */
1114  if (CheckMutability((Expr *) expr))
1115  ereport(ERROR,
1116  (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
1117  errmsg("functions in index expression must be marked IMMUTABLE")));
1118  }
1119  }
1120 
1121  typeOidP[attn] = atttype;
1122 
1123  /*
1124  * Apply collation override if any
1125  */
1126  if (attribute->collation)
1127  attcollation = get_collation_oid(attribute->collation, false);
1128 
1129  /*
1130  * Check we have a collation iff it's a collatable type. The only
1131  * expected failures here are (1) COLLATE applied to a noncollatable
1132  * type, or (2) index expression had an unresolved collation. But we
1133  * might as well code this to be a complete consistency check.
1134  */
1135  if (type_is_collatable(atttype))
1136  {
1137  if (!OidIsValid(attcollation))
1138  ereport(ERROR,
1139  (errcode(ERRCODE_INDETERMINATE_COLLATION),
1140  errmsg("could not determine which collation to use for index expression"),
1141  errhint("Use the COLLATE clause to set the collation explicitly.")));
1142  }
1143  else
1144  {
1145  if (OidIsValid(attcollation))
1146  ereport(ERROR,
1147  (errcode(ERRCODE_DATATYPE_MISMATCH),
1148  errmsg("collations are not supported by type %s",
1149  format_type_be(atttype))));
1150  }
1151 
1152  collationOidP[attn] = attcollation;
1153 
1154  /*
1155  * Identify the opclass to use.
1156  */
1157  classOidP[attn] = ResolveOpClass(attribute->opclass,
1158  atttype,
1159  accessMethodName,
1160  accessMethodId);
1161 
1162  /*
1163  * Identify the exclusion operator, if any.
1164  */
1165  if (nextExclOp)
1166  {
1167  List *opname = (List *) lfirst(nextExclOp);
1168  Oid opid;
1169  Oid opfamily;
1170  int strat;
1171 
1172  /*
1173  * Find the operator --- it must accept the column datatype
1174  * without runtime coercion (but binary compatibility is OK)
1175  */
1176  opid = compatible_oper_opid(opname, atttype, atttype, false);
1177 
1178  /*
1179  * Only allow commutative operators to be used in exclusion
1180  * constraints. If X conflicts with Y, but Y does not conflict
1181  * with X, bad things will happen.
1182  */
1183  if (get_commutator(opid) != opid)
1184  ereport(ERROR,
1185  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
1186  errmsg("operator %s is not commutative",
1187  format_operator(opid)),
1188  errdetail("Only commutative operators can be used in exclusion constraints.")));
1189 
1190  /*
1191  * Operator must be a member of the right opfamily, too
1192  */
1193  opfamily = get_opclass_family(classOidP[attn]);
1194  strat = get_op_opfamily_strategy(opid, opfamily);
1195  if (strat == 0)
1196  {
1197  HeapTuple opftuple;
1198  Form_pg_opfamily opfform;
1199 
1200  /*
1201  * attribute->opclass might not explicitly name the opfamily,
1202  * so fetch the name of the selected opfamily for use in the
1203  * error message.
1204  */
1205  opftuple = SearchSysCache1(OPFAMILYOID,
1206  ObjectIdGetDatum(opfamily));
1207  if (!HeapTupleIsValid(opftuple))
1208  elog(ERROR, "cache lookup failed for opfamily %u",
1209  opfamily);
1210  opfform = (Form_pg_opfamily) GETSTRUCT(opftuple);
1211 
1212  ereport(ERROR,
1213  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
1214  errmsg("operator %s is not a member of operator family \"%s\"",
1215  format_operator(opid),
1216  NameStr(opfform->opfname)),
1217  errdetail("The exclusion operator must be related to the index operator class for the constraint.")));
1218  }
1219 
1220  indexInfo->ii_ExclusionOps[attn] = opid;
1221  indexInfo->ii_ExclusionProcs[attn] = get_opcode(opid);
1222  indexInfo->ii_ExclusionStrats[attn] = strat;
1223  nextExclOp = lnext(nextExclOp);
1224  }
1225 
1226  /*
1227  * Set up the per-column options (indoption field). For now, this is
1228  * zero for any un-ordered index, while ordered indexes have DESC and
1229  * NULLS FIRST/LAST options.
1230  */
1231  colOptionP[attn] = 0;
1232  if (amcanorder)
1233  {
1234  /* default ordering is ASC */
1235  if (attribute->ordering == SORTBY_DESC)
1236  colOptionP[attn] |= INDOPTION_DESC;
1237  /* default null ordering is LAST for ASC, FIRST for DESC */
1238  if (attribute->nulls_ordering == SORTBY_NULLS_DEFAULT)
1239  {
1240  if (attribute->ordering == SORTBY_DESC)
1241  colOptionP[attn] |= INDOPTION_NULLS_FIRST;
1242  }
1243  else if (attribute->nulls_ordering == SORTBY_NULLS_FIRST)
1244  colOptionP[attn] |= INDOPTION_NULLS_FIRST;
1245  }
1246  else
1247  {
1248  /* index AM does not support ordering */
1249  if (attribute->ordering != SORTBY_DEFAULT)
1250  ereport(ERROR,
1251  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1252  errmsg("access method \"%s\" does not support ASC/DESC options",
1253  accessMethodName)));
1254  if (attribute->nulls_ordering != SORTBY_NULLS_DEFAULT)
1255  ereport(ERROR,
1256  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1257  errmsg("access method \"%s\" does not support NULLS FIRST/LAST options",
1258  accessMethodName)));
1259  }
1260 
1261  attn++;
1262  }
1263 }
1264 
1265 /*
1266  * Resolve possibly-defaulted operator class specification
1267  *
1268  * Note: This is used to resolve operator class specification in index and
1269  * partition key definitions.
1270  */
1271 Oid
1272 ResolveOpClass(List *opclass, Oid attrType,
1273  char *accessMethodName, Oid accessMethodId)
1274 {
1275  char *schemaname;
1276  char *opcname;
1277  HeapTuple tuple;
1278  Oid opClassId,
1279  opInputType;
1280 
1281  /*
1282  * Release 7.0 removed network_ops, timespan_ops, and datetime_ops, so we
1283  * ignore those opclass names so the default *_ops is used. This can be
1284  * removed in some later release. bjm 2000/02/07
1285  *
1286  * Release 7.1 removes lztext_ops, so suppress that too for a while. tgl
1287  * 2000/07/30
1288  *
1289  * Release 7.2 renames timestamp_ops to timestamptz_ops, so suppress that
1290  * too for awhile. I'm starting to think we need a better approach. tgl
1291  * 2000/10/01
1292  *
1293  * Release 8.0 removes bigbox_ops (which was dead code for a long while
1294  * anyway). tgl 2003/11/11
1295  */
1296  if (list_length(opclass) == 1)
1297  {
1298  char *claname = strVal(linitial(opclass));
1299 
1300  if (strcmp(claname, "network_ops") == 0 ||
1301  strcmp(claname, "timespan_ops") == 0 ||
1302  strcmp(claname, "datetime_ops") == 0 ||
1303  strcmp(claname, "lztext_ops") == 0 ||
1304  strcmp(claname, "timestamp_ops") == 0 ||
1305  strcmp(claname, "bigbox_ops") == 0)
1306  opclass = NIL;
1307  }
1308 
1309  if (opclass == NIL)
1310  {
1311  /* no operator class specified, so find the default */
1312  opClassId = GetDefaultOpClass(attrType, accessMethodId);
1313  if (!OidIsValid(opClassId))
1314  ereport(ERROR,
1315  (errcode(ERRCODE_UNDEFINED_OBJECT),
1316  errmsg("data type %s has no default operator class for access method \"%s\"",
1317  format_type_be(attrType), accessMethodName),
1318  errhint("You must specify an operator class for the index or define a default operator class for the data type.")));
1319  return opClassId;
1320  }
1321 
1322  /*
1323  * Specific opclass name given, so look up the opclass.
1324  */
1325 
1326  /* deconstruct the name list */
1327  DeconstructQualifiedName(opclass, &schemaname, &opcname);
1328 
1329  if (schemaname)
1330  {
1331  /* Look in specific schema only */
1332  Oid namespaceId;
1333 
1334  namespaceId = LookupExplicitNamespace(schemaname, false);
1335  tuple = SearchSysCache3(CLAAMNAMENSP,
1336  ObjectIdGetDatum(accessMethodId),
1337  PointerGetDatum(opcname),
1338  ObjectIdGetDatum(namespaceId));
1339  }
1340  else
1341  {
1342  /* Unqualified opclass name, so search the search path */
1343  opClassId = OpclassnameGetOpcid(accessMethodId, opcname);
1344  if (!OidIsValid(opClassId))
1345  ereport(ERROR,
1346  (errcode(ERRCODE_UNDEFINED_OBJECT),
1347  errmsg("operator class \"%s\" does not exist for access method \"%s\"",
1348  opcname, accessMethodName)));
1349  tuple = SearchSysCache1(CLAOID, ObjectIdGetDatum(opClassId));
1350  }
1351 
1352  if (!HeapTupleIsValid(tuple))
1353  ereport(ERROR,
1354  (errcode(ERRCODE_UNDEFINED_OBJECT),
1355  errmsg("operator class \"%s\" does not exist for access method \"%s\"",
1356  NameListToString(opclass), accessMethodName)));
1357 
1358  /*
1359  * Verify that the index operator class accepts this datatype. Note we
1360  * will accept binary compatibility.
1361  */
1362  opClassId = HeapTupleGetOid(tuple);
1363  opInputType = ((Form_pg_opclass) GETSTRUCT(tuple))->opcintype;
1364 
1365  if (!IsBinaryCoercible(attrType, opInputType))
1366  ereport(ERROR,
1367  (errcode(ERRCODE_DATATYPE_MISMATCH),
1368  errmsg("operator class \"%s\" does not accept data type %s",
1369  NameListToString(opclass), format_type_be(attrType))));
1370 
1371  ReleaseSysCache(tuple);
1372 
1373  return opClassId;
1374 }
1375 
1376 /*
1377  * GetDefaultOpClass
1378  *
1379  * Given the OIDs of a datatype and an access method, find the default
1380  * operator class, if any. Returns InvalidOid if there is none.
1381  */
1382 Oid
1383 GetDefaultOpClass(Oid type_id, Oid am_id)
1384 {
1385  Oid result = InvalidOid;
1386  int nexact = 0;
1387  int ncompatible = 0;
1388  int ncompatiblepreferred = 0;
1389  Relation rel;
1390  ScanKeyData skey[1];
1391  SysScanDesc scan;
1392  HeapTuple tup;
1393  TYPCATEGORY tcategory;
1394 
1395  /* If it's a domain, look at the base type instead */
1396  type_id = getBaseType(type_id);
1397 
1398  tcategory = TypeCategory(type_id);
1399 
1400  /*
1401  * We scan through all the opclasses available for the access method,
1402  * looking for one that is marked default and matches the target type
1403  * (either exactly or binary-compatibly, but prefer an exact match).
1404  *
1405  * We could find more than one binary-compatible match. If just one is
1406  * for a preferred type, use that one; otherwise we fail, forcing the user
1407  * to specify which one he wants. (The preferred-type special case is a
1408  * kluge for varchar: it's binary-compatible to both text and bpchar, so
1409  * we need a tiebreaker.) If we find more than one exact match, then
1410  * someone put bogus entries in pg_opclass.
1411  */
1413 
1414  ScanKeyInit(&skey[0],
1416  BTEqualStrategyNumber, F_OIDEQ,
1417  ObjectIdGetDatum(am_id));
1418 
1419  scan = systable_beginscan(rel, OpclassAmNameNspIndexId, true,
1420  NULL, 1, skey);
1421 
1422  while (HeapTupleIsValid(tup = systable_getnext(scan)))
1423  {
1424  Form_pg_opclass opclass = (Form_pg_opclass) GETSTRUCT(tup);
1425 
1426  /* ignore altogether if not a default opclass */
1427  if (!opclass->opcdefault)
1428  continue;
1429  if (opclass->opcintype == type_id)
1430  {
1431  nexact++;
1432  result = HeapTupleGetOid(tup);
1433  }
1434  else if (nexact == 0 &&
1435  IsBinaryCoercible(type_id, opclass->opcintype))
1436  {
1437  if (IsPreferredType(tcategory, opclass->opcintype))
1438  {
1439  ncompatiblepreferred++;
1440  result = HeapTupleGetOid(tup);
1441  }
1442  else if (ncompatiblepreferred == 0)
1443  {
1444  ncompatible++;
1445  result = HeapTupleGetOid(tup);
1446  }
1447  }
1448  }
1449 
1450  systable_endscan(scan);
1451 
1453 
1454  /* raise error if pg_opclass contains inconsistent data */
1455  if (nexact > 1)
1456  ereport(ERROR,
1458  errmsg("there are multiple default operator classes for data type %s",
1459  format_type_be(type_id))));
1460 
1461  if (nexact == 1 ||
1462  ncompatiblepreferred == 1 ||
1463  (ncompatiblepreferred == 0 && ncompatible == 1))
1464  return result;
1465 
1466  return InvalidOid;
1467 }
1468 
1469 /*
1470  * makeObjectName()
1471  *
1472  * Create a name for an implicitly created index, sequence, constraint, etc.
1473  *
1474  * The parameters are typically: the original table name, the original field
1475  * name, and a "type" string (such as "seq" or "pkey"). The field name
1476  * and/or type can be NULL if not relevant.
1477  *
1478  * The result is a palloc'd string.
1479  *
1480  * The basic result we want is "name1_name2_label", omitting "_name2" or
1481  * "_label" when those parameters are NULL. However, we must generate
1482  * a name with less than NAMEDATALEN characters! So, we truncate one or
1483  * both names if necessary to make a short-enough string. The label part
1484  * is never truncated (so it had better be reasonably short).
1485  *
1486  * The caller is responsible for checking uniqueness of the generated
1487  * name and retrying as needed; retrying will be done by altering the
1488  * "label" string (which is why we never truncate that part).
1489  */
1490 char *
1491 makeObjectName(const char *name1, const char *name2, const char *label)
1492 {
1493  char *name;
1494  int overhead = 0; /* chars needed for label and underscores */
1495  int availchars; /* chars available for name(s) */
1496  int name1chars; /* chars allocated to name1 */
1497  int name2chars; /* chars allocated to name2 */
1498  int ndx;
1499 
1500  name1chars = strlen(name1);
1501  if (name2)
1502  {
1503  name2chars = strlen(name2);
1504  overhead++; /* allow for separating underscore */
1505  }
1506  else
1507  name2chars = 0;
1508  if (label)
1509  overhead += strlen(label) + 1;
1510 
1511  availchars = NAMEDATALEN - 1 - overhead;
1512  Assert(availchars > 0); /* else caller chose a bad label */
1513 
1514  /*
1515  * If we must truncate, preferentially truncate the longer name. This
1516  * logic could be expressed without a loop, but it's simple and obvious as
1517  * a loop.
1518  */
1519  while (name1chars + name2chars > availchars)
1520  {
1521  if (name1chars > name2chars)
1522  name1chars--;
1523  else
1524  name2chars--;
1525  }
1526 
1527  name1chars = pg_mbcliplen(name1, name1chars, name1chars);
1528  if (name2)
1529  name2chars = pg_mbcliplen(name2, name2chars, name2chars);
1530 
1531  /* Now construct the string using the chosen lengths */
1532  name = palloc(name1chars + name2chars + overhead + 1);
1533  memcpy(name, name1, name1chars);
1534  ndx = name1chars;
1535  if (name2)
1536  {
1537  name[ndx++] = '_';
1538  memcpy(name + ndx, name2, name2chars);
1539  ndx += name2chars;
1540  }
1541  if (label)
1542  {
1543  name[ndx++] = '_';
1544  strcpy(name + ndx, label);
1545  }
1546  else
1547  name[ndx] = '\0';
1548 
1549  return name;
1550 }
1551 
1552 /*
1553  * Select a nonconflicting name for a new relation. This is ordinarily
1554  * used to choose index names (which is why it's here) but it can also
1555  * be used for sequences, or any autogenerated relation kind.
1556  *
1557  * name1, name2, and label are used the same way as for makeObjectName(),
1558  * except that the label can't be NULL; digits will be appended to the label
1559  * if needed to create a name that is unique within the specified namespace.
1560  *
1561  * Note: it is theoretically possible to get a collision anyway, if someone
1562  * else chooses the same name concurrently. This is fairly unlikely to be
1563  * a problem in practice, especially if one is holding an exclusive lock on
1564  * the relation identified by name1. However, if choosing multiple names
1565  * within a single command, you'd better create the new object and do
1566  * CommandCounterIncrement before choosing the next one!
1567  *
1568  * Returns a palloc'd string.
1569  */
1570 char *
1571 ChooseRelationName(const char *name1, const char *name2,
1572  const char *label, Oid namespaceid)
1573 {
1574  int pass = 0;
1575  char *relname = NULL;
1576  char modlabel[NAMEDATALEN];
1577 
1578  /* try the unmodified label first */
1579  StrNCpy(modlabel, label, sizeof(modlabel));
1580 
1581  for (;;)
1582  {
1583  relname = makeObjectName(name1, name2, modlabel);
1584 
1585  if (!OidIsValid(get_relname_relid(relname, namespaceid)))
1586  break;
1587 
1588  /* found a conflict, so try a new name component */
1589  pfree(relname);
1590  snprintf(modlabel, sizeof(modlabel), "%s%d", label, ++pass);
1591  }
1592 
1593  return relname;
1594 }
1595 
1596 /*
1597  * Select the name to be used for an index.
1598  *
1599  * The argument list is pretty ad-hoc :-(
1600  */
1601 static char *
1602 ChooseIndexName(const char *tabname, Oid namespaceId,
1603  List *colnames, List *exclusionOpNames,
1604  bool primary, bool isconstraint)
1605 {
1606  char *indexname;
1607 
1608  if (primary)
1609  {
1610  /* the primary key's name does not depend on the specific column(s) */
1611  indexname = ChooseRelationName(tabname,
1612  NULL,
1613  "pkey",
1614  namespaceId);
1615  }
1616  else if (exclusionOpNames != NIL)
1617  {
1618  indexname = ChooseRelationName(tabname,
1619  ChooseIndexNameAddition(colnames),
1620  "excl",
1621  namespaceId);
1622  }
1623  else if (isconstraint)
1624  {
1625  indexname = ChooseRelationName(tabname,
1626  ChooseIndexNameAddition(colnames),
1627  "key",
1628  namespaceId);
1629  }
1630  else
1631  {
1632  indexname = ChooseRelationName(tabname,
1633  ChooseIndexNameAddition(colnames),
1634  "idx",
1635  namespaceId);
1636  }
1637 
1638  return indexname;
1639 }
1640 
1641 /*
1642  * Generate "name2" for a new index given the list of column names for it
1643  * (as produced by ChooseIndexColumnNames). This will be passed to
1644  * ChooseRelationName along with the parent table name and a suitable label.
1645  *
1646  * We know that less than NAMEDATALEN characters will actually be used,
1647  * so we can truncate the result once we've generated that many.
1648  */
1649 static char *
1651 {
1652  char buf[NAMEDATALEN * 2];
1653  int buflen = 0;
1654  ListCell *lc;
1655 
1656  buf[0] = '\0';
1657  foreach(lc, colnames)
1658  {
1659  const char *name = (const char *) lfirst(lc);
1660 
1661  if (buflen > 0)
1662  buf[buflen++] = '_'; /* insert _ between names */
1663 
1664  /*
1665  * At this point we have buflen <= NAMEDATALEN. name should be less
1666  * than NAMEDATALEN already, but use strlcpy for paranoia.
1667  */
1668  strlcpy(buf + buflen, name, NAMEDATALEN);
1669  buflen += strlen(buf + buflen);
1670  if (buflen >= NAMEDATALEN)
1671  break;
1672  }
1673  return pstrdup(buf);
1674 }
1675 
1676 /*
1677  * Select the actual names to be used for the columns of an index, given the
1678  * list of IndexElems for the columns. This is mostly about ensuring the
1679  * names are unique so we don't get a conflicting-attribute-names error.
1680  *
1681  * Returns a List of plain strings (char *, not String nodes).
1682  */
1683 static List *
1685 {
1686  List *result = NIL;
1687  ListCell *lc;
1688 
1689  foreach(lc, indexElems)
1690  {
1691  IndexElem *ielem = (IndexElem *) lfirst(lc);
1692  const char *origname;
1693  const char *curname;
1694  int i;
1695  char buf[NAMEDATALEN];
1696 
1697  /* Get the preliminary name from the IndexElem */
1698  if (ielem->indexcolname)
1699  origname = ielem->indexcolname; /* caller-specified name */
1700  else if (ielem->name)
1701  origname = ielem->name; /* simple column reference */
1702  else
1703  origname = "expr"; /* default name for expression */
1704 
1705  /* If it conflicts with any previous column, tweak it */
1706  curname = origname;
1707  for (i = 1;; i++)
1708  {
1709  ListCell *lc2;
1710  char nbuf[32];
1711  int nlen;
1712 
1713  foreach(lc2, result)
1714  {
1715  if (strcmp(curname, (char *) lfirst(lc2)) == 0)
1716  break;
1717  }
1718  if (lc2 == NULL)
1719  break; /* found nonconflicting name */
1720 
1721  sprintf(nbuf, "%d", i);
1722 
1723  /* Ensure generated names are shorter than NAMEDATALEN */
1724  nlen = pg_mbcliplen(origname, strlen(origname),
1725  NAMEDATALEN - 1 - strlen(nbuf));
1726  memcpy(buf, origname, nlen);
1727  strcpy(buf + nlen, nbuf);
1728  curname = buf;
1729  }
1730 
1731  /* And attach to the result list */
1732  result = lappend(result, pstrdup(curname));
1733  }
1734  return result;
1735 }
1736 
1737 /*
1738  * ReindexIndex
1739  * Recreate a specific index.
1740  */
1741 Oid
1742 ReindexIndex(RangeVar *indexRelation, int options)
1743 {
1744  Oid indOid;
1745  Oid heapOid = InvalidOid;
1746  Relation irel;
1747  char persistence;
1748 
1749  /*
1750  * Find and lock index, and check permissions on table; use callback to
1751  * obtain lock on table first, to avoid deadlock hazard. The lock level
1752  * used here must match the index lock obtained in reindex_index().
1753  */
1754  indOid = RangeVarGetRelidExtended(indexRelation, AccessExclusiveLock,
1755  false, false,
1757  (void *) &heapOid);
1758 
1759  /*
1760  * Obtain the current persistence of the existing index. We already hold
1761  * lock on the index.
1762  */
1763  irel = index_open(indOid, NoLock);
1764  persistence = irel->rd_rel->relpersistence;
1765  index_close(irel, NoLock);
1766 
1767  reindex_index(indOid, false, persistence, options);
1768 
1769  return indOid;
1770 }
1771 
1772 /*
1773  * Check permissions on table before acquiring relation lock; also lock
1774  * the heap before the RangeVarGetRelidExtended takes the index lock, to avoid
1775  * deadlocks.
1776  */
1777 static void
1779  Oid relId, Oid oldRelId, void *arg)
1780 {
1781  char relkind;
1782  Oid *heapOid = (Oid *) arg;
1783 
1784  /*
1785  * If we previously locked some other index's heap, and the name we're
1786  * looking up no longer refers to that relation, release the now-useless
1787  * lock.
1788  */
1789  if (relId != oldRelId && OidIsValid(oldRelId))
1790  {
1791  /* lock level here should match reindex_index() heap lock */
1792  UnlockRelationOid(*heapOid, ShareLock);
1793  *heapOid = InvalidOid;
1794  }
1795 
1796  /* If the relation does not exist, there's nothing more to do. */
1797  if (!OidIsValid(relId))
1798  return;
1799 
1800  /*
1801  * If the relation does exist, check whether it's an index. But note that
1802  * the relation might have been dropped between the time we did the name
1803  * lookup and now. In that case, there's nothing to do.
1804  */
1805  relkind = get_rel_relkind(relId);
1806  if (!relkind)
1807  return;
1808  if (relkind != RELKIND_INDEX)
1809  ereport(ERROR,
1810  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
1811  errmsg("\"%s\" is not an index", relation->relname)));
1812 
1813  /* Check permissions */
1814  if (!pg_class_ownercheck(relId, GetUserId()))
1816 
1817  /* Lock heap before index to avoid deadlock. */
1818  if (relId != oldRelId)
1819  {
1820  /*
1821  * Lock level here should match reindex_index() heap lock. If the OID
1822  * isn't valid, it means the index as concurrently dropped, which is
1823  * not a problem for us; just return normally.
1824  */
1825  *heapOid = IndexGetRelation(relId, true);
1826  if (OidIsValid(*heapOid))
1827  LockRelationOid(*heapOid, ShareLock);
1828  }
1829 }
1830 
1831 /*
1832  * ReindexTable
1833  * Recreate all indexes of a table (and of its toast table, if any)
1834  */
1835 Oid
1837 {
1838  Oid heapOid;
1839 
1840  /* The lock level used here should match reindex_relation(). */
1841  heapOid = RangeVarGetRelidExtended(relation, ShareLock, false, false,
1843 
1844  if (!reindex_relation(heapOid,
1847  options))
1848  ereport(NOTICE,
1849  (errmsg("table \"%s\" has no indexes",
1850  relation->relname)));
1851 
1852  return heapOid;
1853 }
1854 
1855 /*
1856  * ReindexMultipleTables
1857  * Recreate indexes of tables selected by objectName/objectKind.
1858  *
1859  * To reduce the probability of deadlocks, each table is reindexed in a
1860  * separate transaction, so we can release the lock on it right away.
1861  * That means this must not be called within a user transaction block!
1862  */
1863 void
1864 ReindexMultipleTables(const char *objectName, ReindexObjectType objectKind,
1865  int options)
1866 {
1867  Oid objectOid;
1868  Relation relationRelation;
1869  HeapScanDesc scan;
1870  ScanKeyData scan_keys[1];
1871  HeapTuple tuple;
1872  MemoryContext private_context;
1873  MemoryContext old;
1874  List *relids = NIL;
1875  ListCell *l;
1876  int num_keys;
1877 
1878  AssertArg(objectName);
1879  Assert(objectKind == REINDEX_OBJECT_SCHEMA ||
1880  objectKind == REINDEX_OBJECT_SYSTEM ||
1881  objectKind == REINDEX_OBJECT_DATABASE);
1882 
1883  /*
1884  * Get OID of object to reindex, being the database currently being used
1885  * by session for a database or for system catalogs, or the schema defined
1886  * by caller. At the same time do permission checks that need different
1887  * processing depending on the object type.
1888  */
1889  if (objectKind == REINDEX_OBJECT_SCHEMA)
1890  {
1891  objectOid = get_namespace_oid(objectName, false);
1892 
1893  if (!pg_namespace_ownercheck(objectOid, GetUserId()))
1895  objectName);
1896  }
1897  else
1898  {
1899  objectOid = MyDatabaseId;
1900 
1901  if (strcmp(objectName, get_database_name(objectOid)) != 0)
1902  ereport(ERROR,
1903  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1904  errmsg("can only reindex the currently open database")));
1905  if (!pg_database_ownercheck(objectOid, GetUserId()))
1907  objectName);
1908  }
1909 
1910  /*
1911  * Create a memory context that will survive forced transaction commits we
1912  * do below. Since it is a child of PortalContext, it will go away
1913  * eventually even if we suffer an error; there's no need for special
1914  * abort cleanup logic.
1915  */
1916  private_context = AllocSetContextCreate(PortalContext,
1917  "ReindexMultipleTables",
1919 
1920  /*
1921  * Define the search keys to find the objects to reindex. For a schema, we
1922  * select target relations using relnamespace, something not necessary for
1923  * a database-wide operation.
1924  */
1925  if (objectKind == REINDEX_OBJECT_SCHEMA)
1926  {
1927  num_keys = 1;
1928  ScanKeyInit(&scan_keys[0],
1930  BTEqualStrategyNumber, F_OIDEQ,
1931  ObjectIdGetDatum(objectOid));
1932  }
1933  else
1934  num_keys = 0;
1935 
1936  /*
1937  * Scan pg_class to build a list of the relations we need to reindex.
1938  *
1939  * We only consider plain relations and materialized views here (toast
1940  * rels will be processed indirectly by reindex_relation).
1941  */
1942  relationRelation = heap_open(RelationRelationId, AccessShareLock);
1943  scan = heap_beginscan_catalog(relationRelation, num_keys, scan_keys);
1944  while ((tuple = heap_getnext(scan, ForwardScanDirection)) != NULL)
1945  {
1946  Form_pg_class classtuple = (Form_pg_class) GETSTRUCT(tuple);
1947  Oid relid = HeapTupleGetOid(tuple);
1948 
1949  /*
1950  * Only regular tables and matviews can have indexes, so ignore any
1951  * other kind of relation.
1952  */
1953  if (classtuple->relkind != RELKIND_RELATION &&
1954  classtuple->relkind != RELKIND_MATVIEW)
1955  continue;
1956 
1957  /* Skip temp tables of other backends; we can't reindex them at all */
1958  if (classtuple->relpersistence == RELPERSISTENCE_TEMP &&
1959  !isTempNamespace(classtuple->relnamespace))
1960  continue;
1961 
1962  /* Check user/system classification, and optionally skip */
1963  if (objectKind == REINDEX_OBJECT_SYSTEM &&
1964  !IsSystemClass(relid, classtuple))
1965  continue;
1966 
1967  /* Save the list of relation OIDs in private context */
1968  old = MemoryContextSwitchTo(private_context);
1969 
1970  /*
1971  * We always want to reindex pg_class first if it's selected to be
1972  * reindexed. This ensures that if there is any corruption in
1973  * pg_class' indexes, they will be fixed before we process any other
1974  * tables. This is critical because reindexing itself will try to
1975  * update pg_class.
1976  */
1977  if (relid == RelationRelationId)
1978  relids = lcons_oid(relid, relids);
1979  else
1980  relids = lappend_oid(relids, relid);
1981 
1982  MemoryContextSwitchTo(old);
1983  }
1984  heap_endscan(scan);
1985  heap_close(relationRelation, AccessShareLock);
1986 
1987  /* Now reindex each rel in a separate transaction */
1990  foreach(l, relids)
1991  {
1992  Oid relid = lfirst_oid(l);
1993 
1995  /* functions in indexes may want a snapshot set */
1997  if (reindex_relation(relid,
2000  options))
2001 
2002  if (options & REINDEXOPT_VERBOSE)
2003  ereport(INFO,
2004  (errmsg("table \"%s.%s\" was reindexed",
2006  get_rel_name(relid))));
2009  }
2011 
2012  MemoryContextDelete(private_context);
2013 }
bool deferrable
Definition: parsenodes.h:2602
signed short int16
Definition: c.h:252
#define NIL
Definition: pg_list.h:69
Definition: c.h:474
bool primary
Definition: parsenodes.h:2600
VirtualTransactionId * GetCurrentVirtualXIDs(TransactionId limitXmin, bool excludeXmin0, bool allDbs, int excludeVacuum, int *nvxids)
Definition: procarray.c:2457
Oid get_tablespace_oid(const char *tablespacename, bool missing_ok)
Definition: tablespace.c:1380
#define INDOPTION_NULLS_FIRST
Definition: pg_index.h:100
MemoryContext ii_Context
Definition: execnodes.h:82
Oid IndexGetRelation(Oid indexId, bool missing_ok)
Definition: index.c:3281
void RelationGetExclusionInfo(Relation indexRelation, Oid **operators, Oid **procs, uint16 **strategies)
Definition: relcache.c:4966
LockRelId lockRelId
Definition: rel.h:44
void RangeVarCallbackOwnsTable(const RangeVar *relation, Oid relId, Oid oldRelId, void *arg)
Definition: tablecmds.c:12585
bool amcanmulticol
Definition: amapi.h:179
#define IsA(nodeptr, _type_)
Definition: nodes.h:559
static bool CheckMutability(Expr *expr)
Definition: indexcmds.c:943
AclResult pg_tablespace_aclcheck(Oid spc_oid, Oid roleid, AclMode mode)
Definition: aclchk.c:4471
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:200
#define Anum_pg_opclass_opcmethod
Definition: pg_opclass.h:75
Oid get_namespace_oid(const char *nspname, bool missing_ok)
Definition: namespace.c:2839
static char * ChooseIndexNameAddition(List *colnames)
Definition: indexcmds.c:1650
#define DEBUG1
Definition: elog.h:25
Oid get_commutator(Oid opno)
Definition: lsyscache.c:1281
Oid LookupExplicitNamespace(const char *nspname, bool missing_ok)
Definition: namespace.c:2687
int errhint(const char *fmt,...)
Definition: elog.c:987
Oid GetDefaultOpClass(Oid type_id, Oid am_id)
Definition: indexcmds.c:1383
SortByDir ordering
Definition: parsenodes.h:649
void systable_endscan(SysScanDesc sysscan)
Definition: genam.c:493
#define GETSTRUCT(TUP)
Definition: htup_details.h:656
List * ii_Predicate
Definition: execnodes.h:69
void heap_endscan(HeapScanDesc scan)
Definition: heapam.c:1581
List * options
Definition: parsenodes.h:2593
#define IndexIsValid(indexForm)
Definition: pg_index.h:107
uint32 TransactionId
Definition: c.h:394
Snapshot RegisterSnapshot(Snapshot snapshot)
Definition: snapmgr.c:858
amgettuple_function amgettuple
Definition: amapi.h:210
Oid ReindexTable(RangeVar *relation, int options)
Definition: indexcmds.c:1836
int LOCKMODE
Definition: lockdefs.h:26
Oid GetUserId(void)
Definition: miscinit.c:282
#define ObjectIdAttributeNumber
Definition: sysattr.h:22
void index_set_state_flags(Oid indexId, IndexStateFlagsAction action)
Definition: index.c:3202
void UnlockRelationOid(Oid relid, LOCKMODE lockmode)
Definition: lmgr.c:182
Oid RangeVarGetRelidExtended(const RangeVar *relation, LOCKMODE lockmode, bool missing_ok, bool nowait, RangeVarGetRelidCallback callback, void *callback_arg)
Definition: namespace.c:217
#define PointerGetDatum(X)
Definition: postgres.h:564
char * tableSpace
Definition: parsenodes.h:2591
char get_rel_relkind(Oid relid)
Definition: lsyscache.c:1769
char * pstrdup(const char *in)
Definition: mcxt.c:1165
void CommitTransactionCommand(void)
Definition: xact.c:2745
#define RelationRelationId
Definition: pg_class.h:29
#define ALLOCSET_SMALL_SIZES
Definition: memutils.h:155
Oid dbId
Definition: rel.h:39
Oid get_rel_namespace(Oid relid)
Definition: lsyscache.c:1718
Expr * expression_planner(Expr *expr)
Definition: planner.c:5211
Form_pg_attribute * attrs
Definition: tupdesc.h:74
#define RELKIND_MATVIEW
Definition: pg_class.h:167
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
Node * whereClause
Definition: parsenodes.h:2594
#define Anum_pg_index_indclass
Definition: pg_index.h:89
Definition: lock.h:179
#define AccessShareLock
Definition: lockdefs.h:36
#define OperatorClassRelationId
Definition: pg_opclass.h:49
#define GLOBALTABLESPACE_OID
Definition: pg_tablespace.h:64
void index_check_primary_key(Relation heapRel, IndexInfo *indexInfo, bool is_alter_table)
Definition: index.c:192
Definition: nodes.h:508
Oid * ii_ExclusionProcs
Definition: execnodes.h:72
Oid index_create(Relation heapRelation, const char *indexRelationName, Oid indexRelationId, Oid relFileNode, IndexInfo *indexInfo, List *indexColNames, Oid accessMethodObjectId, Oid tableSpaceId, Oid *collationObjectId, Oid *classObjectId, int16 *coloptions, Datum reloptions, bool isprimary, bool isconstraint, bool deferrable, bool initdeferred, bool allow_system_table_mods, bool skip_build, bool concurrent, bool is_internal, bool if_not_exists)
Definition: index.c:697
#define strVal(v)
Definition: value.h:54
int errcode(int sqlerrcode)
Definition: elog.c:575
void CreateComments(Oid oid, Oid classoid, int32 subid, char *comment)
Definition: comment.c:142
#define INFO
Definition: elog.h:33
char * format_type_be(Oid type_oid)
Definition: format_type.c:94
Oid ReindexIndex(RangeVar *indexRelation, int options)
Definition: indexcmds.c:1742
int snprintf(char *str, size_t count, const char *fmt,...) pg_attribute_printf(3
#define FirstLowInvalidHeapAttributeNumber
Definition: sysattr.h:28
char * format_operator(Oid operator_oid)
Definition: regproc.c:904
void PopActiveSnapshot(void)
Definition: snapmgr.c:807
void DeconstructQualifiedName(List *names, char **nspname_p, char **objname_p)
Definition: namespace.c:2603
bool pg_namespace_ownercheck(Oid nsp_oid, Oid roleid)
Definition: aclchk.c:4697
List * lcons_oid(Oid datum, List *list)
Definition: list.c:295
#define heap_close(r, l)
Definition: heapam.h:97
IndexInfo * BuildIndexInfo(Relation index)
Definition: index.c:1639
Oid ResolveOpClass(List *opclass, Oid attrType, char *accessMethodName, Oid accessMethodId)
Definition: indexcmds.c:1272
static List * ChooseIndexColumnNames(List *indexElems)
Definition: indexcmds.c:1684
Form_pg_class rd_rel
Definition: rel.h:113
unsigned int Oid
Definition: postgres_ext.h:31
Definition: primnodes.h:141
Oid OpclassnameGetOpcid(Oid amid, const char *opcname)
Definition: namespace.c:1759
List * lappend_oid(List *list, Oid datum)
Definition: list.c:164
Snapshot GetTransactionSnapshot(void)
Definition: snapmgr.c:300
#define OidIsValid(objectId)
Definition: c.h:534
ReindexObjectType
Definition: parsenodes.h:3098
AclResult pg_namespace_aclcheck(Oid nsp_oid, Oid roleid, AclMode mode)
Definition: aclchk.c:4459
SysScanDesc systable_beginscan(Relation heapRelation, Oid indexId, bool indexOK, Snapshot snapshot, int nkeys, ScanKey key)
Definition: genam.c:322
#define OpclassAmNameNspIndexId
Definition: indexing.h:191
bool IsPreferredType(TYPCATEGORY category, Oid type)
#define Anum_pg_class_relnamespace
Definition: pg_class.h:104
void pull_varattnos(Node *node, Index varno, Bitmapset **varattnos)
Definition: var.c:219
#define SearchSysCache1(cacheId, key1)
Definition: syscache.h:149
#define REINDEXOPT_VERBOSE
Definition: parsenodes.h:3096
Oid GetDefaultTablespace(char relpersistence)
Definition: tablespace.c:1111
Oid MyDatabaseTableSpace
Definition: globals.c:78
bool IsSystemClass(Oid relid, Form_pg_class reltuple)
Definition: catalog.c:74
MemoryContext PortalContext
Definition: mcxt.c:52
bool VirtualXactLock(VirtualTransactionId vxid, bool wait)
Definition: lock.c:4291
char * makeObjectName(const char *name1, const char *name2, const char *label)
Definition: indexcmds.c:1491
#define NAMEDATALEN
#define VirtualTransactionIdEquals(vxid1, vxid2)
Definition: lock.h:75
char * relname
Definition: primnodes.h:67
Node * expr
Definition: parsenodes.h:645
char TYPCATEGORY
Definition: parse_coerce.h:21
RangeVar * relation
Definition: parsenodes.h:2589
List * ii_ExpressionsState
Definition: execnodes.h:68
HeapTuple systable_getnext(SysScanDesc sysscan)
Definition: genam.c:410
unsigned short uint16
Definition: c.h:264
void pfree(void *pointer)
Definition: mcxt.c:992
#define PROC_IN_VACUUM
Definition: proc.h:44
#define linitial(l)
Definition: pg_list.h:110
List * make_ands_implicit(Expr *clause)
Definition: clauses.c:377
SortByNulls nulls_ordering
Definition: parsenodes.h:650
void UnlockRelationIdForSession(LockRelId *relid, LOCKMODE lockmode)
Definition: lmgr.c:312
#define ObjectIdGetDatum(X)
Definition: postgres.h:515
#define ERROR
Definition: elog.h:43
Definition: rel.h:36
#define ACL_CREATE
Definition: parsenodes.h:75
#define IsPolymorphicType(typid)
Definition: pg_type.h:733
bool CheckIndexCompatible(Oid oldId, char *accessMethodName, List *attributeList, List *exclusionOpNames)
Definition: indexcmds.c:117
void LockRelationIdForSession(LockRelId *relid, LOCKMODE lockmode)
Definition: lmgr.c:299
amoptions_function amoptions
Definition: amapi.h:205
static void ComputeIndexAttrs(IndexInfo *indexInfo, Oid *typeOidP, Oid *collationOidP, Oid *classOidP, int16 *colOptionP, List *attList, List *exclusionOpNames, Oid relId, char *accessMethodName, Oid accessMethodId, bool amcanorder, bool isconstraint)
Definition: indexcmds.c:999
IndexAmRoutine * GetIndexAmRoutine(Oid amhandler)
Definition: amapi.c:33
int pg_mbcliplen(const char *mbstr, int len, int limit)
Definition: mbutils.c:831
Oid get_relname_relid(const char *relname, Oid relnamespace)
Definition: lsyscache.c:1651
char * get_database_name(Oid dbid)
Definition: dbcommands.c:2048
List * ii_PredicateState
Definition: execnodes.h:70
bool amcanunique
Definition: amapi.h:177
#define SET_LOCKTAG_RELATION(locktag, dboid, reloid)
Definition: lock.h:194
char * get_namespace_name(Oid nspid)
Definition: lsyscache.c:3006
#define NoLock
Definition: lockdefs.h:34
LockInfoData rd_lockInfo
Definition: rel.h:116
static char * buf
Definition: pg_test_fsync.c:65
void PushActiveSnapshot(Snapshot snap)
Definition: snapmgr.c:728
Oid values[FLEXIBLE_ARRAY_MEMBER]
Definition: c.h:482
bool heap_attisnull(HeapTuple tup, int attnum)
Definition: heaptuple.c:297
void aclcheck_error(AclResult aclerr, AclObjectKind objectkind, const char *objectname)
Definition: aclchk.c:3378
#define RowExclusiveLock
Definition: lockdefs.h:38
int errdetail(const char *fmt,...)
Definition: elog.c:873
char * indexcolname
Definition: parsenodes.h:646
void CacheInvalidateRelcacheByRelid(Oid relid)
Definition: inval.c:1284
#define RelationGetRelationName(relation)
Definition: rel.h:433
static ListCell * list_head(const List *l)
Definition: pg_list.h:77
FormData_pg_attribute * Form_pg_attribute
Definition: pg_attribute.h:184
bool ii_BrokenHotChain
Definition: execnodes.h:80
bool isTempNamespace(Oid namespaceId)
Definition: namespace.c:2952
#define RELKIND_FOREIGN_TABLE
Definition: pg_class.h:166
void op_input_types(Oid opno, Oid *lefttype, Oid *righttype)
Definition: lsyscache.c:1135
TransactionId xmin
Definition: snapshot.h:66
MemoryContext CurrentMemoryContext
Definition: mcxt.c:37
HeapScanDesc heap_beginscan_catalog(Relation relation, int nkeys, ScanKey key)
Definition: heapam.c:1402
#define lnext(lc)
Definition: pg_list.h:105
bool ii_ReadyForInserts
Definition: execnodes.h:78
#define ereport(elevel, rest)
Definition: elog.h:122
#define AssertArg(condition)
Definition: c.h:673
bool pg_database_ownercheck(Oid db_oid, Oid roleid)
Definition: aclchk.c:4939
void UnregisterSnapshot(Snapshot snapshot)
Definition: snapmgr.c:900
bool IsBinaryCoercible(Oid srctype, Oid targettype)
void ReindexMultipleTables(const char *objectName, ReindexObjectType objectKind, int options)
Definition: indexcmds.c:1864
List * lappend(List *list, void *datum)
Definition: list.c:128
void * ii_AmCache
Definition: execnodes.h:81
bytea *(* amoptions_function)(Datum reloptions, bool validate)
Definition: amapi.h:102
char * idxname
Definition: parsenodes.h:2588
#define WARNING
Definition: elog.h:40
void index_build(Relation heapRelation, Relation indexRelation, IndexInfo *indexInfo, bool isprimary, bool isreindex)
Definition: index.c:2000
#define VirtualTransactionIdIsValid(vxid)
Definition: lock.h:72
void validate_index(Oid heapId, Oid indexId, Snapshot snapshot)
Definition: index.c:2803
static void RangeVarCallbackForReindexIndex(const RangeVar *relation, Oid relId, Oid oldRelId, void *arg)
Definition: indexcmds.c:1778
FormData_pg_index * Form_pg_index
Definition: pg_index.h:67
char * NameListToString(List *names)
Definition: namespace.c:2897
#define RELKIND_PARTITIONED_TABLE
Definition: pg_class.h:168
FormData_pg_opfamily * Form_pg_opfamily
Definition: pg_opfamily.h:44
bool if_not_exists
Definition: parsenodes.h:2606
MemoryContext AllocSetContextCreate(MemoryContext parent, const char *name, Size minContextSize, Size initBlockSize, Size maxBlockSize)
Definition: aset.c:440
AclResult
Definition: acl.h:170
uintptr_t Datum
Definition: postgres.h:374
void ReleaseSysCache(HeapTuple tuple)
Definition: syscache.c:1083
int ii_NumIndexAttrs
Definition: execnodes.h:65
Datum SysCacheGetAttr(int cacheId, HeapTuple tup, AttrNumber attributeNumber, bool *isNull)
Definition: syscache.c:1245
static char * label
Definition: pg_basebackup.c:83
Oid MyDatabaseId
Definition: globals.c:76
HeapTuple heap_getnext(HeapScanDesc scan, ScanDirection direction)
Definition: heapam.c:1781
bool unique
Definition: parsenodes.h:2599
Relation heap_open(Oid relationId, LOCKMODE lockmode)
Definition: heapam.c:1287
TupleDesc rd_att
Definition: rel.h:114
char * accessMethod
Definition: parsenodes.h:2590
Datum transformRelOptions(Datum oldOptions, List *defList, char *namspace, char *validnsps[], bool ignoreOids, bool isReset)
Definition: reloptions.c:700
void WaitForLockers(LOCKTAG heaplocktag, LOCKMODE lockmode)
Definition: lmgr.c:811
Relation heap_openrv(const RangeVar *relation, LOCKMODE lockmode)
Definition: heapam.c:1315
bool allowSystemTableMods
Definition: globals.c:111
#define InvalidOid
Definition: postgres_ext.h:36
TYPCATEGORY TypeCategory(Oid type)
RegProcedure get_opcode(Oid opno)
Definition: lsyscache.c:1062
bytea * index_reloptions(amoptions_function amoptions, Datum reloptions, bool validate)
Definition: reloptions.c:1404
List * opclass
Definition: parsenodes.h:648
#define NOTICE
Definition: elog.h:37
#define Anum_pg_index_indpred
Definition: pg_index.h:92
size_t strlcpy(char *dst, const char *src, size_t siz)
Definition: strlcpy.c:45
bool ii_Unique
Definition: execnodes.h:77
#define makeNode(_type_)
Definition: nodes.h:556
#define ShareUpdateExclusiveLock
Definition: lockdefs.h:39
#define HeapTupleIsValid(tuple)
Definition: htup.h:77
#define NULL
Definition: c.h:226
List * ii_Expressions
Definition: execnodes.h:67
#define Assert(condition)
Definition: c.h:671
#define lfirst(lc)
Definition: pg_list.h:106
#define StrNCpy(dst, src, len)
Definition: c.h:826
#define RELATION_IS_OTHER_TEMP(relation)
Definition: rel.h:530
#define INDOPTION_DESC
Definition: pg_index.h:99
bool pg_class_ownercheck(Oid class_oid, Oid roleid)
Definition: aclchk.c:4521
void StartTransactionCommand(void)
Definition: xact.c:2675
#define SetInvalidVirtualTransactionId(vxid)
Definition: lock.h:78
List * indexParams
Definition: parsenodes.h:2592
ObjectAddress DefineIndex(Oid relationId, IndexStmt *stmt, Oid indexRelationId, bool is_alter_table, bool check_rights, bool skip_build, bool quiet)
Definition: indexcmds.c:305
static void CheckPredicate(Expr *predicate)
Definition: indexcmds.c:977
#define INDEX_MAX_KEYS
Oid exprType(const Node *expr)
Definition: nodeFuncs.c:42
List * excludeOpNames
Definition: parsenodes.h:2595
static int list_length(const List *l)
Definition: pg_list.h:89
#define REINDEX_REL_CHECK_CONSTRAINTS
Definition: index.h:124
Oid exprCollation(const Node *expr)
Definition: nodeFuncs.c:745
AttrNumber ii_KeyAttrNumbers[INDEX_MAX_KEYS]
Definition: execnodes.h:66
bool initdeferred
Definition: parsenodes.h:2603
bool amcanorder
Definition: amapi.h:171
char * name
Definition: parsenodes.h:644
char * idxcomment
Definition: parsenodes.h:2596
HeapTuple SearchSysCacheAttName(Oid relid, const char *attname)
Definition: syscache.c:1171
#define RelationNeedsWAL(relation)
Definition: rel.h:502
Oid get_opclass_family(Oid opclass)
Definition: lsyscache.c:1015
void reindex_index(Oid indexId, bool skip_constraint_checks, char persistence, int options)
Definition: index.c:3306
bool ii_Concurrent
Definition: execnodes.h:79
const char * name
Definition: encode.c:521
#define InvalidAttrNumber
Definition: attnum.h:23
#define ObjectAddressSet(addr, class_id, object_id)
Definition: objectaddress.h:40
void index_close(Relation relation, LOCKMODE lockmode)
Definition: indexam.c:176
#define DatumGetPointer(X)
Definition: postgres.h:557
#define Anum_pg_index_indcollation
Definition: pg_index.h:88
#define IsBootstrapProcessingMode()
Definition: miscadmin.h:365
int get_op_opfamily_strategy(Oid opno, Oid opfamily)
Definition: lsyscache.c:80
FormData_pg_class * Form_pg_class
Definition: pg_class.h:95
bool concurrent
Definition: parsenodes.h:2605
#define AccessExclusiveLock
Definition: lockdefs.h:46
bool isconstraint
Definition: parsenodes.h:2601
Oid * ii_ExclusionOps
Definition: execnodes.h:71
FormData_pg_am * Form_pg_am
Definition: pg_am.h:46
void * palloc(Size size)
Definition: mcxt.c:891
int errmsg(const char *fmt,...)
Definition: elog.c:797
Oid compatible_oper_opid(List *op, Oid arg1, Oid arg2, bool noError)
Definition: parse_oper.c:492
char * get_tablespace_name(Oid spc_oid)
Definition: tablespace.c:1426
#define SearchSysCache3(cacheId, key1, key2, key3)
Definition: syscache.h:153
#define ShareLock
Definition: lockdefs.h:41
int i
#define NameStr(name)
Definition: c.h:495
#define RELKIND_INDEX
Definition: pg_class.h:161
void ScanKeyInit(ScanKey entry, AttrNumber attributeNumber, StrategyNumber strategy, RegProcedure procedure, Datum argument)
Definition: scankey.c:76
void * arg
List * collation
Definition: parsenodes.h:647
#define REINDEX_REL_PROCESS_TOAST
Definition: index.h:122
bool contain_mutable_functions(Node *clause)
Definition: clauses.c:877
static char * ChooseIndexName(const char *tabname, Oid namespaceId, List *colnames, List *exclusionOpNames, bool primary, bool isconstraint)
Definition: indexcmds.c:1602
char * ChooseRelationName(const char *name1, const char *name2, const char *label, Oid namespaceid)
Definition: indexcmds.c:1571
#define elog
Definition: elog.h:219
#define HeapTupleGetOid(tuple)
Definition: htup_details.h:695
void LockRelationOid(Oid relid, LOCKMODE lockmode)
Definition: lmgr.c:105
#define RELPERSISTENCE_TEMP
Definition: pg_class.h:172
uint16 * ii_ExclusionStrats
Definition: execnodes.h:73
Oid getBaseType(Oid typid)
Definition: lsyscache.c:2239
#define RELKIND_RELATION
Definition: pg_class.h:160
bool type_is_collatable(Oid typid)
Definition: lsyscache.c:2774
FormData_pg_opclass * Form_pg_opclass
Definition: pg_opclass.h:68
#define ERRCODE_DUPLICATE_OBJECT
Definition: streamutil.c:31
bool reindex_relation(Oid relid, int flags, int options)
Definition: index.c:3515
Oid get_collation_oid(List *name, bool missing_ok)
Definition: namespace.c:3324
Definition: pg_list.h:45
char * get_rel_name(Oid relid)
Definition: lsyscache.c:1694
bool bms_is_member(int x, const Bitmapset *a)
Definition: bitmapset.c:419
int16 AttrNumber
Definition: attnum.h:21
#define RelationGetRelid(relation)
Definition: rel.h:413
Relation index_open(Oid relationId, LOCKMODE lockmode)
Definition: indexam.c:151
#define BTEqualStrategyNumber
Definition: stratnum.h:31
#define PROC_IS_AUTOVACUUM
Definition: proc.h:43
#define lfirst_oid(lc)
Definition: pg_list.h:108
#define Anum_pg_index_indexprs
Definition: pg_index.h:91
Oid relId
Definition: rel.h:38
Oid get_opclass_input_type(Oid opclass)
Definition: lsyscache.c:1037
#define RelationGetNamespace(relation)
Definition: rel.h:440