PostgreSQL Source Code  git master
pg_index.h File Reference
#include "catalog/genbki.h"
#include "catalog/pg_index_d.h"
Include dependency graph for pg_index.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs

typedef FormData_pg_indexForm_pg_index
 

Functions

 CATALOG (pg_index, 2610, IndexRelationId) BKI_SCHEMA_MACRO
 
 DECLARE_TOAST_WITH_MACRO (pg_index, 8149, 8150, PgIndexToastTable, PgIndexToastIndex)
 
 DECLARE_INDEX (pg_index_indrelid_index, 2678, IndexIndrelidIndexId, pg_index, btree(indrelid oid_ops))
 
 DECLARE_UNIQUE_INDEX_PKEY (pg_index_indexrelid_index, 2679, IndexRelidIndexId, pg_index, btree(indexrelid oid_ops))
 
 MAKE_SYSCACHE (INDEXRELID, pg_index_indexrelid_index, 64)
 
 DECLARE_ARRAY_FOREIGN_KEY_OPT ((indrelid, indkey), pg_attribute,(attrelid, attnum))
 

Variables

 FormData_pg_index
 

Typedef Documentation

◆ Form_pg_index

Definition at line 70 of file pg_index.h.

Function Documentation

◆ CATALOG()

CATALOG ( pg_index  ,
2610  ,
IndexRelationId   
)

Definition at line 29 of file pg_index.h.

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 indnullsnotdistinct; /* null treatment in unique index */
38  bool indisprimary; /* is this index for primary key? */
39  bool indisexclusion; /* is this index for exclusion constraint? */
40  bool indimmediate; /* is uniqueness enforced immediately? */
41  bool indisclustered; /* is this the index last clustered by? */
42  bool indisvalid; /* is this index valid for use by queries? */
43  bool indcheckxmin; /* must we wait for xmin to be old? */
44  bool indisready; /* is this index ready for inserts? */
45  bool indislive; /* is this index alive at all? */
46  bool indisreplident; /* is this index the identity for replication? */
47 
48  /* variable-length fields start here, but we allow direct access to indkey */
49  int2vector indkey BKI_FORCE_NOT_NULL; /* column numbers of indexed cols,
50  * or 0 */
51 
52 #ifdef CATALOG_VARLEN
53  oidvector indcollation BKI_LOOKUP_OPT(pg_collation) BKI_FORCE_NOT_NULL; /* collation identifiers */
54  oidvector indclass BKI_LOOKUP(pg_opclass) BKI_FORCE_NOT_NULL; /* opclass identifiers */
55  int2vector indoption BKI_FORCE_NOT_NULL; /* per-column flags
56  * (AM-specific meanings) */
57  pg_node_tree indexprs; /* expression trees for index attributes that
58  * are not simple column references; one for
59  * each zero entry in indkey[] */
60  pg_node_tree indpred; /* expression tree for predicate, if a partial
61  * index; else NULL */
62 #endif
signed short int16
Definition: c.h:496
#define BKI_LOOKUP(catalog)
Definition: genbki.h:46
#define BKI_LOOKUP_OPT(catalog)
Definition: genbki.h:47
#define BKI_FORCE_NOT_NULL
Definition: genbki.h:33
FormData_pg_index
Definition: pg_index.h:63
unsigned int Oid
Definition: postgres_ext.h:31
Definition: c.h:718
Definition: c.h:729

References BKI_FORCE_NOT_NULL, BKI_LOOKUP, and BKI_LOOKUP_OPT.

◆ DECLARE_ARRAY_FOREIGN_KEY_OPT()

DECLARE_ARRAY_FOREIGN_KEY_OPT ( (indrelid, indkey)  ,
pg_attribute  ,
(attrelid, attnum  
)

◆ DECLARE_INDEX()

DECLARE_INDEX ( pg_index_indrelid_index  ,
2678  ,
IndexIndrelidIndexId  ,
pg_index  ,
btree(indrelid oid_ops)   
)

◆ DECLARE_TOAST_WITH_MACRO()

DECLARE_TOAST_WITH_MACRO ( pg_index  ,
8149  ,
8150  ,
PgIndexToastTable  ,
PgIndexToastIndex   
)

◆ DECLARE_UNIQUE_INDEX_PKEY()

DECLARE_UNIQUE_INDEX_PKEY ( pg_index_indexrelid_index  ,
2679  ,
IndexRelidIndexId  ,
pg_index  ,
btree(indexrelid oid_ops)   
)

◆ MAKE_SYSCACHE()

MAKE_SYSCACHE ( INDEXRELID  ,
pg_index_indexrelid_index  ,
64   
)

Variable Documentation

◆ FormData_pg_index

FormData_pg_index

Definition at line 63 of file pg_index.h.