mirror of
https://github.com/postgres/postgres.git
synced 2026-03-01 12:50:55 -05:00
0a78320057
This includes removing tabs after periods in C comments, which was applied to back branches, so this change should not effect backpatching.
111 lines
3.9 KiB
C
111 lines
3.9 KiB
C
/*-------------------------------------------------------------------------
|
|
*
|
|
* pg_index.h
|
|
* definition of the system "index" relation (pg_index)
|
|
* along with the relation's initial contents.
|
|
*
|
|
*
|
|
* Portions Copyright (c) 1996-2014, PostgreSQL Global Development Group
|
|
* Portions Copyright (c) 1994, Regents of the University of California
|
|
*
|
|
* src/include/catalog/pg_index.h
|
|
*
|
|
* NOTES
|
|
* the genbki.pl script reads this file and generates .bki
|
|
* information from the DATA() statements.
|
|
*
|
|
*-------------------------------------------------------------------------
|
|
*/
|
|
#ifndef PG_INDEX_H
|
|
#define PG_INDEX_H
|
|
|
|
#include "catalog/genbki.h"
|
|
|
|
/* ----------------
|
|
* pg_index definition. cpp turns this into
|
|
* typedef struct FormData_pg_index.
|
|
* ----------------
|
|
*/
|
|
#define IndexRelationId 2610
|
|
|
|
CATALOG(pg_index,2610) BKI_WITHOUT_OIDS BKI_SCHEMA_MACRO
|
|
{
|
|
Oid indexrelid; /* OID of the index */
|
|
Oid indrelid; /* OID of the relation it indexes */
|
|
int16 indnatts; /* number of columns in index */
|
|
bool indisunique; /* is this a 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; /* column numbers of indexed cols, or 0 */
|
|
|
|
#ifdef CATALOG_VARLEN
|
|
oidvector indcollation; /* collation identifiers */
|
|
oidvector indclass; /* opclass identifiers */
|
|
int2vector indoption; /* 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;
|
|
|
|
/* ----------------
|
|
* Form_pg_index corresponds to a pointer to a tuple with
|
|
* the format of pg_index relation.
|
|
* ----------------
|
|
*/
|
|
typedef FormData_pg_index *Form_pg_index;
|
|
|
|
/* ----------------
|
|
* compiler constants for pg_index
|
|
* ----------------
|
|
*/
|
|
#define Natts_pg_index 19
|
|
#define Anum_pg_index_indexrelid 1
|
|
#define Anum_pg_index_indrelid 2
|
|
#define Anum_pg_index_indnatts 3
|
|
#define Anum_pg_index_indisunique 4
|
|
#define Anum_pg_index_indisprimary 5
|
|
#define Anum_pg_index_indisexclusion 6
|
|
#define Anum_pg_index_indimmediate 7
|
|
#define Anum_pg_index_indisclustered 8
|
|
#define Anum_pg_index_indisvalid 9
|
|
#define Anum_pg_index_indcheckxmin 10
|
|
#define Anum_pg_index_indisready 11
|
|
#define Anum_pg_index_indislive 12
|
|
#define Anum_pg_index_indisreplident 13
|
|
#define Anum_pg_index_indkey 14
|
|
#define Anum_pg_index_indcollation 15
|
|
#define Anum_pg_index_indclass 16
|
|
#define Anum_pg_index_indoption 17
|
|
#define Anum_pg_index_indexprs 18
|
|
#define Anum_pg_index_indpred 19
|
|
|
|
/*
|
|
* Index AMs that support ordered scans must support these two indoption
|
|
* bits. Otherwise, the content of the per-column indoption fields is
|
|
* open for future definition.
|
|
*/
|
|
#define INDOPTION_DESC 0x0001 /* values are in reverse order */
|
|
#define INDOPTION_NULLS_FIRST 0x0002 /* NULLs are first instead of last */
|
|
|
|
/*
|
|
* Use of these macros is recommended over direct examination of the state
|
|
* flag columns where possible; this allows source code compatibility with
|
|
* the hacky representation used in 9.2.
|
|
*/
|
|
#define IndexIsValid(indexForm) ((indexForm)->indisvalid)
|
|
#define IndexIsReady(indexForm) ((indexForm)->indisready)
|
|
#define IndexIsLive(indexForm) ((indexForm)->indislive)
|
|
|
|
#endif /* PG_INDEX_H */
|