src/include/catalog/pg_enum.h

   1 /*-------------------------------------------------------------------------
   2  *
   3  * pg_enum.h
   4  *        definition of the system "enum" relation (pg_enum)
   5  *        along with the relation's initial contents.
   6  *
   7  *
   8  * Copyright (c) 2006-2008, PostgreSQL Global Development Group
   9  *
  10  * $PostgreSQL$
  11  *
  12  * NOTES
  13  *        the genbki.sh script reads this file and generates .bki
  14  *        information from the DATA() statements.
  15  *
  16  *        XXX do NOT break up DATA() statements into multiple lines!
  17  *                the scripts are not as smart as you might think...
  18  *
  19  *-------------------------------------------------------------------------
  20  */
  21 #ifndef PG_ENUM_H
  22 #define PG_ENUM_H
  23
  24 #include "catalog/genbki.h"
  25 #include "nodes/pg_list.h"
  26
  27 /* ----------------
  28  *              pg_enum definition.  cpp turns this into
  29  *              typedef struct FormData_pg_enum
  30  * ----------------
  31  */
  32 #define EnumRelationId  3501
  33
  34 CATALOG(pg_enum,3501)
  35 {
  36         Oid                     enumtypid;              /* OID of owning enum type */
  37         NameData        enumlabel;              /* text representation of enum value */
  38 } FormData_pg_enum;
  39
  40 /* ----------------
  41  *              Form_pg_enum corresponds to a pointer to a tuple with
  42  *              the format of pg_enum relation.
  43  * ----------------
  44  */
  45 typedef FormData_pg_enum *Form_pg_enum;
  46
  47 /* ----------------
  48  *              compiler constants for pg_enum
  49  * ----------------
  50  */
  51 #define Natts_pg_enum                                   2
  52 #define Anum_pg_enum_enumtypid                  1
  53 #define Anum_pg_enum_enumlabel                  2
  54
  55 /* ----------------
  56  *              pg_enum has no initial contents
  57  * ----------------
  58  */
  59
  60 /*
  61  * prototypes for functions in pg_enum.c
  62  */
  63 extern void EnumValuesCreate(Oid enumTypeOid, List *vals);
  64 extern void EnumValuesDelete(Oid enumTypeOid);
  65
  66 #endif   /* PG_ENUM_H */