Header And Logo

PostgreSQL
| The world's most advanced open source database.

Defines | Typedefs | Functions | Variables

pg_am.h File Reference

#include "catalog/genbki.h"
Include dependency graph for pg_am.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines

#define AccessMethodRelationId   2601
#define Natts_pg_am   30
#define Anum_pg_am_amname   1
#define Anum_pg_am_amstrategies   2
#define Anum_pg_am_amsupport   3
#define Anum_pg_am_amcanorder   4
#define Anum_pg_am_amcanorderbyop   5
#define Anum_pg_am_amcanbackward   6
#define Anum_pg_am_amcanunique   7
#define Anum_pg_am_amcanmulticol   8
#define Anum_pg_am_amoptionalkey   9
#define Anum_pg_am_amsearcharray   10
#define Anum_pg_am_amsearchnulls   11
#define Anum_pg_am_amstorage   12
#define Anum_pg_am_amclusterable   13
#define Anum_pg_am_ampredlocks   14
#define Anum_pg_am_amkeytype   15
#define Anum_pg_am_aminsert   16
#define Anum_pg_am_ambeginscan   17
#define Anum_pg_am_amgettuple   18
#define Anum_pg_am_amgetbitmap   19
#define Anum_pg_am_amrescan   20
#define Anum_pg_am_amendscan   21
#define Anum_pg_am_ammarkpos   22
#define Anum_pg_am_amrestrpos   23
#define Anum_pg_am_ambuild   24
#define Anum_pg_am_ambuildempty   25
#define Anum_pg_am_ambulkdelete   26
#define Anum_pg_am_amvacuumcleanup   27
#define Anum_pg_am_amcanreturn   28
#define Anum_pg_am_amcostestimate   29
#define Anum_pg_am_amoptions   30
#define BTREE_AM_OID   403
#define HASH_AM_OID   405
#define GIST_AM_OID   783
#define GIN_AM_OID   2742
#define SPGIST_AM_OID   4000

Typedefs

typedef FormData_pg_amForm_pg_am

Functions

 CATALOG (pg_am, 2601)
 DATA (insert OID=403(btree5 2 t f t t t t t t f t t 0 btinsert btbeginscan btgettuple btgetbitmap btrescan btendscan btmarkpos btrestrpos btbuild btbuildempty btbulkdelete btvacuumcleanup btcanreturn btcostestimate btoptions))
 DESCR ("b-tree index access method")
 DESCR ("hash index access method")
 DESCR ("GiST index access method")
 DESCR ("GIN index access method")
 DESCR ("SP-GiST index access method")

Variables

 FormData_pg_am

Define Documentation

#define AccessMethodRelationId   2601

Definition at line 32 of file pg_am.h.

#define Anum_pg_am_ambeginscan   17

Definition at line 100 of file pg_am.h.

#define Anum_pg_am_ambuild   24

Definition at line 107 of file pg_am.h.

#define Anum_pg_am_ambuildempty   25

Definition at line 108 of file pg_am.h.

#define Anum_pg_am_ambulkdelete   26

Definition at line 109 of file pg_am.h.

#define Anum_pg_am_amcanbackward   6

Definition at line 89 of file pg_am.h.

#define Anum_pg_am_amcanmulticol   8

Definition at line 91 of file pg_am.h.

#define Anum_pg_am_amcanorder   4

Definition at line 87 of file pg_am.h.

#define Anum_pg_am_amcanorderbyop   5

Definition at line 88 of file pg_am.h.

#define Anum_pg_am_amcanreturn   28

Definition at line 111 of file pg_am.h.

#define Anum_pg_am_amcanunique   7

Definition at line 90 of file pg_am.h.

#define Anum_pg_am_amclusterable   13

Definition at line 96 of file pg_am.h.

#define Anum_pg_am_amcostestimate   29

Definition at line 112 of file pg_am.h.

#define Anum_pg_am_amendscan   21

Definition at line 104 of file pg_am.h.

#define Anum_pg_am_amgetbitmap   19

Definition at line 102 of file pg_am.h.

#define Anum_pg_am_amgettuple   18

Definition at line 101 of file pg_am.h.

#define Anum_pg_am_aminsert   16

Definition at line 99 of file pg_am.h.

#define Anum_pg_am_amkeytype   15

Definition at line 98 of file pg_am.h.

#define Anum_pg_am_ammarkpos   22

Definition at line 105 of file pg_am.h.

#define Anum_pg_am_amname   1

Definition at line 84 of file pg_am.h.

#define Anum_pg_am_amoptionalkey   9

Definition at line 92 of file pg_am.h.

#define Anum_pg_am_amoptions   30

Definition at line 113 of file pg_am.h.

#define Anum_pg_am_ampredlocks   14

Definition at line 97 of file pg_am.h.

#define Anum_pg_am_amrescan   20

Definition at line 103 of file pg_am.h.

#define Anum_pg_am_amrestrpos   23

Definition at line 106 of file pg_am.h.

#define Anum_pg_am_amsearcharray   10

Definition at line 93 of file pg_am.h.

#define Anum_pg_am_amsearchnulls   11

Definition at line 94 of file pg_am.h.

#define Anum_pg_am_amstorage   12

Definition at line 95 of file pg_am.h.

#define Anum_pg_am_amstrategies   2

Definition at line 85 of file pg_am.h.

#define Anum_pg_am_amsupport   3

Definition at line 86 of file pg_am.h.

#define Anum_pg_am_amvacuumcleanup   27

Definition at line 110 of file pg_am.h.

#define BTREE_AM_OID   403
#define GIN_AM_OID   2742

Definition at line 131 of file pg_am.h.

Referenced by pgstat_relation().

#define GIST_AM_OID   783

Definition at line 128 of file pg_am.h.

Referenced by pgstat_relation().

#define HASH_AM_OID   405
#define Natts_pg_am   30

Definition at line 83 of file pg_am.h.

#define SPGIST_AM_OID   4000

Definition at line 134 of file pg_am.h.

Referenced by pgstat_relation().


Typedef Documentation

Definition at line 77 of file pg_am.h.


Function Documentation

CATALOG ( pg_am  ,
2601   
)

Definition at line 34 of file pg_am.h.

{
    NameData    amname;         /* access method name */
    int16       amstrategies;   /* total number of strategies (operators) by
                                 * which we can traverse/search this AM. Zero
                                 * if AM does not have a fixed set of strategy
                                 * assignments. */
    int16       amsupport;      /* total number of support functions that this
                                 * AM uses */
    bool        amcanorder;     /* does AM support order by column value? */
    bool        amcanorderbyop; /* does AM support order by operator result? */
    bool        amcanbackward;  /* does AM support backward scan? */
    bool        amcanunique;    /* does AM support UNIQUE indexes? */
    bool        amcanmulticol;  /* does AM support multi-column indexes? */
    bool        amoptionalkey;  /* can query omit key for the first column? */
    bool        amsearcharray;  /* can AM handle ScalarArrayOpExpr quals? */
    bool        amsearchnulls;  /* can AM search for NULL/NOT NULL entries? */
    bool        amstorage;      /* can storage type differ from column type? */
    bool        amclusterable;  /* does AM support cluster command? */
    bool        ampredlocks;    /* does AM handle predicate locks? */
    Oid         amkeytype;      /* type of data in index, or InvalidOid */
    regproc     aminsert;       /* "insert this tuple" function */
    regproc     ambeginscan;    /* "prepare for index scan" function */
    regproc     amgettuple;     /* "next valid tuple" function, or 0 */
    regproc     amgetbitmap;    /* "fetch all valid tuples" function, or 0 */
    regproc     amrescan;       /* "(re)start index scan" function */
    regproc     amendscan;      /* "end index scan" function */
    regproc     ammarkpos;      /* "mark current scan position" function */
    regproc     amrestrpos;     /* "restore marked scan position" function */
    regproc     ambuild;        /* "build new index" function */
    regproc     ambuildempty;   /* "build empty index" function */
    regproc     ambulkdelete;   /* bulk-delete function */
    regproc     amvacuumcleanup;    /* post-VACUUM cleanup function */
    regproc     amcanreturn;    /* can indexscan return IndexTuples? */
    regproc     amcostestimate; /* estimate cost of an indexscan */
    regproc     amoptions;      /* parse AM-specific parameters */
} FormData_pg_am;

DATA ( insert  OID = 403(btree5 2 t f t t t t t t f t t 0 btinsert btbeginscan btgettuple btgetbitmap btrescan btendscan btmarkpos btrestrpos btbuild btbuildempty btbulkdelete btvacuumcleanup btcanreturn btcostestimate btoptions)  ) 
DESCR ( "GIN index access method"   ) 
DESCR ( "GiST index access method"   ) 
DESCR ( "hash index access method"   ) 
DESCR ( "b-tree index access method"   ) 
DESCR ( "SP-GiST index access method"   ) 

Variable Documentation

Definition at line 70 of file pg_am.h.

Referenced by write_relcache_init_file().