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_index *	Form_pg_index

Functions
	CATALOG (pg_index, 2610, IndexRelationId) BKI_SCHEMA_MACRO
	DECLARE_TOAST_WITH_MACRO (pg_index, 6351, 6352, 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

typedef FormData_pg_index* 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.

{
    Oid         indexrelid BKI_LOOKUP(pg_class);    /* OID of the index */
    Oid         indrelid BKI_LOOKUP(pg_class);  /* OID of the relation it
                                                 * indexes */
    int16       indnatts;       /* total number of columns in index */
    int16       indnkeyatts;    /* number of key columns in index */
    bool        indisunique;    /* is this a unique index? */
    bool        indnullsnotdistinct;    /* null treatment in unique index */
    bool        indisprimary;   /* is this index for primary key? */
    bool        indisexclusion; /* is this index for exclusion constraint? */
    bool        indimmediate;   /* is uniqueness enforced immediately? */
    bool        indisclustered; /* is this the index last clustered by? */
    bool        indisvalid;     /* is this index valid for use by queries? */
    bool        indcheckxmin;   /* must we wait for xmin to be old? */
    bool        indisready;     /* is this index ready for inserts? */
    bool        indislive;      /* is this index alive at all? */
    bool        indisreplident; /* is this index the identity for replication? */
 
    /* variable-length fields start here, but we allow direct access to indkey */
    int2vector  indkey BKI_FORCE_NOT_NULL;  /* column numbers of indexed cols,
                                             * or 0 */
 
#ifdef CATALOG_VARLEN
    oidvector   indcollation BKI_LOOKUP_OPT(pg_collation) BKI_FORCE_NOT_NULL;   /* collation identifiers */
    oidvector   indclass BKI_LOOKUP(pg_opclass) BKI_FORCE_NOT_NULL; /* opclass identifiers */
    int2vector  indoption BKI_FORCE_NOT_NULL;   /* per-column flags
                                                 * (AM-specific meanings) */
    pg_node_tree indexprs;      /* expression trees for index attributes that
                                 * are not simple column references; one for
                                 * each zero entry in indkey[] */
    pg_node_tree indpred;       /* expression tree for predicate, if a partial
                                 * index; else NULL */
#endif
} FormData_pg_index;

References BKI_FORCE_NOT_NULL, BKI_LOOKUP, BKI_LOOKUP_OPT, and fb().

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	,
		6351	,
		6352	,
		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.