PostgreSQL Source Code  git master
pg_index.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * pg_index.h
4  * definition of the "index" system catalog (pg_index)
5  *
6  *
7  * Portions Copyright (c) 1996-2021, PostgreSQL Global Development Group
8  * Portions Copyright (c) 1994, Regents of the University of California
9  *
10  * src/include/catalog/pg_index.h
11  *
12  * NOTES
13  * The Catalog.pm module reads this file and derives schema
14  * information.
15  *
16  *-------------------------------------------------------------------------
17  */
18 #ifndef PG_INDEX_H
19 #define PG_INDEX_H
20 
21 #include "catalog/genbki.h"
22 #include "catalog/pg_index_d.h"
23 
24 /* ----------------
25  * pg_index definition. cpp turns this into
26  * typedef struct FormData_pg_index.
27  * ----------------
28  */
29 CATALOG(pg_index,2610,IndexRelationId) BKI_SCHEMA_MACRO
30 {
31  Oid indexrelid BKI_LOOKUP(pg_class); /* OID of the index */
32  Oid indrelid BKI_LOOKUP(pg_class); /* OID of the relation it
33  * indexes */
34  int16 indnatts; /* total number of columns in index */
35  int16 indnkeyatts; /* number of key columns in index */
36  bool indisunique; /* is this a unique index? */
37  bool indisprimary; /* is this index for primary key? */
38  bool indisexclusion; /* is this index for exclusion constraint? */
39  bool indimmediate; /* is uniqueness enforced immediately? */
40  bool indisclustered; /* is this the index last clustered by? */
41  bool indisvalid; /* is this index valid for use by queries? */
42  bool indcheckxmin; /* must we wait for xmin to be old? */
43  bool indisready; /* is this index ready for inserts? */
44  bool indislive; /* is this index alive at all? */
45  bool indisreplident; /* is this index the identity for replication? */
46 
47  /* variable-length fields start here, but we allow direct access to indkey */
48  int2vector indkey BKI_FORCE_NOT_NULL; /* column numbers of indexed cols,
49  * or 0 */
50 
51 #ifdef CATALOG_VARLEN
52  oidvector indcollation BKI_LOOKUP_OPT(pg_collation) BKI_FORCE_NOT_NULL; /* collation identifiers */
53  oidvector indclass BKI_LOOKUP(pg_opclass) BKI_FORCE_NOT_NULL; /* opclass identifiers */
54  int2vector indoption BKI_FORCE_NOT_NULL; /* per-column flags
55  * (AM-specific meanings) */
56  pg_node_tree indexprs; /* expression trees for index attributes that
57  * are not simple column references; one for
58  * each zero entry in indkey[] */
59  pg_node_tree indpred; /* expression tree for predicate, if a partial
60  * index; else NULL */
61 #endif
63 
64 /* ----------------
65  * Form_pg_index corresponds to a pointer to a tuple with
66  * the format of pg_index relation.
67  * ----------------
68  */
70 
71 DECLARE_INDEX(pg_index_indrelid_index, 2678, IndexIndrelidIndexId, on pg_index using btree(indrelid oid_ops));
72 DECLARE_UNIQUE_INDEX_PKEY(pg_index_indexrelid_index, 2679, IndexRelidIndexId, on pg_index using btree(indexrelid oid_ops));
73 
74 /* indkey can contain zero (InvalidAttrNumber) to represent expressions */
75 DECLARE_ARRAY_FOREIGN_KEY_OPT((indrelid, indkey), pg_attribute, (attrelid, attnum));
76 
77 #ifdef EXPOSE_TO_CLIENT_CODE
78 
79 /*
80  * Index AMs that support ordered scans must support these two indoption
81  * bits. Otherwise, the content of the per-column indoption fields is
82  * open for future definition.
83  */
84 #define INDOPTION_DESC 0x0001 /* values are in reverse order */
85 #define INDOPTION_NULLS_FIRST 0x0002 /* NULLs are first instead of last */
86 
87 #endif /* EXPOSE_TO_CLIENT_CODE */
88 
89 #endif /* PG_INDEX_H */
#define BKI_SCHEMA_MACRO
Definition: genbki.h:29
FormData_pg_index
Definition: pg_index.h:62
signed short int16
Definition: c.h:428
Definition: c.h:660
unsigned int Oid
Definition: postgres_ext.h:31
CATALOG(pg_index, 2610, IndexRelationId) BKI_SCHEMA_MACRO
Definition: pg_index.h:29
#define BKI_FORCE_NOT_NULL
Definition: genbki.h:33
DECLARE_ARRAY_FOREIGN_KEY_OPT((indrelid, indkey), pg_attribute,(attrelid, attnum))
#define BKI_LOOKUP_OPT(catalog)
Definition: genbki.h:47
#define BKI_LOOKUP(catalog)
Definition: genbki.h:46
DECLARE_INDEX(pg_index_indrelid_index, 2678, IndexIndrelidIndexId, on pg_index using btree(indrelid oid_ops))
FormData_pg_index * Form_pg_index
Definition: pg_index.h:69
Definition: c.h:649
DECLARE_UNIQUE_INDEX_PKEY(pg_index_indexrelid_index, 2679, IndexRelidIndexId, on pg_index using btree(indexrelid oid_ops))
int16 attnum
Definition: pg_attribute.h:83