granicus.if.org Git - postgresql/blob - src/include/catalog/pg_class.h

   1 /*-------------------------------------------------------------------------
   2  *
   3  * pg_class.h
   4  *        definition of the system "relation" relation (pg_class)
   5  *        along with the relation's initial contents.
   6  *
   7  *
   8  * Portions Copyright (c) 1996-2014, PostgreSQL Global Development Group
   9  * Portions Copyright (c) 1994, Regents of the University of California
  10  *
  11  * src/include/catalog/pg_class.h
  12  *
  13  * NOTES
  14  *        the genbki.pl script reads this file and generates .bki
  15  *        information from the DATA() statements.
  16  *
  17  *-------------------------------------------------------------------------
  18  */
  19 #ifndef PG_CLASS_H
  20 #define PG_CLASS_H
  21
  22 #include "catalog/genbki.h"
  23
  24 /* ----------------
  25  *              pg_class definition.  cpp turns this into
  26  *              typedef struct FormData_pg_class
  27  * ----------------
  28  */
  29 #define RelationRelationId      1259
  30 #define RelationRelation_Rowtype_Id  83
  31
  32 CATALOG(pg_class,1259) BKI_BOOTSTRAP BKI_ROWTYPE_OID(83) BKI_SCHEMA_MACRO
  33 {
  34         NameData        relname;                /* class name */
  35         Oid                     relnamespace;   /* OID of namespace containing this class */
  36         Oid                     reltype;                /* OID of entry in pg_type for table's
  37                                                                  * implicit row type */
  38         Oid                     reloftype;              /* OID of entry in pg_type for underlying
  39                                                                  * composite type */
  40         Oid                     relowner;               /* class owner */
  41         Oid                     relam;                  /* index access method; 0 if not an index */
  42         Oid                     relfilenode;    /* identifier of physical storage file */
  43
  44         /* relfilenode == 0 means it is a "mapped" relation, see relmapper.c */
  45         Oid                     reltablespace;  /* identifier of table space for relation */
  46         int32           relpages;               /* # of blocks (not always up-to-date) */
  47         float4          reltuples;              /* # of tuples (not always up-to-date) */
  48         int32           relallvisible;  /* # of all-visible blocks (not always
  49                                                                  * up-to-date) */
  50         Oid                     reltoastrelid;  /* OID of toast table; 0 if none */
  51         bool            relhasindex;    /* T if has (or has had) any indexes */
  52         bool            relisshared;    /* T if shared across databases */
  53         char            relpersistence; /* see RELPERSISTENCE_xxx constants below */
  54         char            relkind;                /* see RELKIND_xxx constants below */
  55         int16           relnatts;               /* number of user attributes */
  56
  57         /*
  58          * Class pg_attribute must contain exactly "relnatts" user attributes
  59          * (with attnums ranging from 1 to relnatts) for this class.  It may also
  60          * contain entries with negative attnums for system attributes.
  61          */
  62         int16           relchecks;              /* # of CHECK constraints for class */
  63         bool            relhasoids;             /* T if we generate OIDs for rows of rel */
  64         bool            relhaspkey;             /* has (or has had) PRIMARY KEY index */
  65         bool            relhasrules;    /* has (or has had) any rules */
  66         bool            relhastriggers; /* has (or has had) any TRIGGERs */
  67         bool            relhassubclass; /* has (or has had) derived classes */
  68         bool            relispopulated; /* matview currently holds query results */
  69         char            relreplident;   /* see REPLICA_IDENTITY_xxx constants  */
  70         TransactionId relfrozenxid; /* all Xids < this are frozen in this rel */
  71         TransactionId relminmxid;       /* all multixacts in this rel are >= this.
  72                                                                  * this is really a MultiXactId */
  73
  74 #ifdef CATALOG_VARLEN                   /* variable-length fields start here */
  75         /* NOTE: These fields are not present in a relcache entry's rd_rel field. */
  76         aclitem         relacl[1];              /* access permissions */
  77         text            reloptions[1];  /* access-method-specific options */
  78 #endif
  79 } FormData_pg_class;
  80
  81 /* Size of fixed part of pg_class tuples, not counting var-length fields */
  82 #define CLASS_TUPLE_SIZE \
  83          (offsetof(FormData_pg_class,relminmxid) + sizeof(TransactionId))
  84
  85 /* ----------------
  86  *              Form_pg_class corresponds to a pointer to a tuple with
  87  *              the format of pg_class relation.
  88  * ----------------
  89  */
  90 typedef FormData_pg_class *Form_pg_class;
  91
  92 /* ----------------
  93  *              compiler constants for pg_class
  94  * ----------------
  95  */
  96
  97 #define Natts_pg_class                                  29
  98 #define Anum_pg_class_relname                   1
  99 #define Anum_pg_class_relnamespace              2
 100 #define Anum_pg_class_reltype                   3
 101 #define Anum_pg_class_reloftype                 4
 102 #define Anum_pg_class_relowner                  5
 103 #define Anum_pg_class_relam                             6
 104 #define Anum_pg_class_relfilenode               7
 105 #define Anum_pg_class_reltablespace             8
 106 #define Anum_pg_class_relpages                  9
 107 #define Anum_pg_class_reltuples                 10
 108 #define Anum_pg_class_relallvisible             11
 109 #define Anum_pg_class_reltoastrelid             12
 110 #define Anum_pg_class_relhasindex               13
 111 #define Anum_pg_class_relisshared               14
 112 #define Anum_pg_class_relpersistence    15
 113 #define Anum_pg_class_relkind                   16
 114 #define Anum_pg_class_relnatts                  17
 115 #define Anum_pg_class_relchecks                 18
 116 #define Anum_pg_class_relhasoids                19
 117 #define Anum_pg_class_relhaspkey                20
 118 #define Anum_pg_class_relhasrules               21
 119 #define Anum_pg_class_relhastriggers    22
 120 #define Anum_pg_class_relhassubclass    23
 121 #define Anum_pg_class_relispopulated    24
 122 #define Anum_pg_class_relreplident              25
 123 #define Anum_pg_class_relfrozenxid              26
 124 #define Anum_pg_class_relminmxid                27
 125 #define Anum_pg_class_relacl                    28
 126 #define Anum_pg_class_reloptions                29
 127
 128 /* ----------------
 129  *              initial contents of pg_class
 130  *
 131  * NOTE: only "bootstrapped" relations need to be declared here.  Be sure that
 132  * the OIDs listed here match those given in their CATALOG macros, and that
 133  * the relnatts values are correct.
 134  * ----------------
 135  */
 136
 137 /*
 138  * Note: "3" in the relfrozenxid column stands for FirstNormalTransactionId;
 139  * similarly, "1" in relminmxid stands for FirstMultiXactId
 140  */
 141 DATA(insert OID = 1247 (  pg_type               PGNSP 71 0 PGUID 0 0 0 0 0 0 0 f f p r 30 0 t f f f f t n 3 1 _null_ _null_ ));
 142 DESCR("");
 143 DATA(insert OID = 1249 (  pg_attribute  PGNSP 75 0 PGUID 0 0 0 0 0 0 0 f f p r 21 0 f f f f f t n 3 1 _null_ _null_ ));
 144 DESCR("");
 145 DATA(insert OID = 1255 (  pg_proc               PGNSP 81 0 PGUID 0 0 0 0 0 0 0 f f p r 27 0 t f f f f t n 3 1 _null_ _null_ ));
 146 DESCR("");
 147 DATA(insert OID = 1259 (  pg_class              PGNSP 83 0 PGUID 0 0 0 0 0 0 0 f f p r 29 0 t f f f f t n 3 1 _null_ _null_ ));
 148 DESCR("");
 149
 150
 151 #define           RELKIND_RELATION                'r'           /* ordinary table */
 152 #define           RELKIND_INDEX                   'i'           /* secondary index */
 153 #define           RELKIND_SEQUENCE                'S'           /* sequence object */
 154 #define           RELKIND_TOASTVALUE      't'           /* for out-of-line values */
 155 #define           RELKIND_VIEW                    'v'           /* view */
 156 #define           RELKIND_COMPOSITE_TYPE  'c'           /* composite type */
 157 #define           RELKIND_FOREIGN_TABLE   'f'           /* foreign table */
 158 #define           RELKIND_MATVIEW                 'm'           /* materialized view */
 159
 160 #define           RELPERSISTENCE_PERMANENT      'p'             /* regular table */
 161 #define           RELPERSISTENCE_UNLOGGED       'u'             /* unlogged permanent table */
 162 #define           RELPERSISTENCE_TEMP           't'             /* temporary table */
 163
 164 /* default selection for replica identity (primary key or nothing) */
 165 #define           REPLICA_IDENTITY_DEFAULT      'd'
 166 /* no replica identity is logged for this relation */
 167 #define           REPLICA_IDENTITY_NOTHING      'n'
 168 /* all columns are loged as replica identity */
 169 #define           REPLICA_IDENTITY_FULL         'f'
 170 /*
 171  * an explicitly chosen candidate key's columns are used as identity;
 172  * will still be set if the index has been dropped, in that case it
 173  * has the same meaning as 'd'
 174  */
 175 #define           REPLICA_IDENTITY_INDEX        'i'
 176 #endif   /* PG_CLASS_H */