PostgreSQL Source Code  git master
pg_enum.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * pg_enum.h
4  * definition of the "enum" system catalog (pg_enum)
5  *
6  *
7  * Portions Copyright (c) 1996-2021, PostgreSQL Global Development Group
8  * Portions Copyright (c) 1994, Regents of the University of California
9  *
10  * src/include/catalog/pg_enum.h
11  *
12  * NOTES
13  * The Catalog.pm module reads this file and derives schema
14  * information.
15  *
16  *-------------------------------------------------------------------------
17  */
18 #ifndef PG_ENUM_H
19 #define PG_ENUM_H
20 
21 #include "catalog/genbki.h"
22 #include "catalog/pg_enum_d.h"
23 
24 #include "nodes/pg_list.h"
25 
26 /* ----------------
27  * pg_enum definition. cpp turns this into
28  * typedef struct FormData_pg_enum
29  * ----------------
30  */
31 CATALOG(pg_enum,3501,EnumRelationId)
32 {
33  Oid oid; /* oid */
34  Oid enumtypid BKI_LOOKUP(pg_type); /* OID of owning enum type */
35  float4 enumsortorder; /* sort position of this enum value */
36  NameData enumlabel; /* text representation of enum value */
38 
39 /* ----------------
40  * Form_pg_enum corresponds to a pointer to a tuple with
41  * the format of pg_enum relation.
42  * ----------------
43  */
45 
46 DECLARE_UNIQUE_INDEX_PKEY(pg_enum_oid_index, 3502, on pg_enum using btree(oid oid_ops));
47 #define EnumOidIndexId 3502
48 DECLARE_UNIQUE_INDEX(pg_enum_typid_label_index, 3503, on pg_enum using btree(enumtypid oid_ops, enumlabel name_ops));
49 #define EnumTypIdLabelIndexId 3503
50 DECLARE_UNIQUE_INDEX(pg_enum_typid_sortorder_index, 3534, on pg_enum using btree(enumtypid oid_ops, enumsortorder float4_ops));
51 #define EnumTypIdSortOrderIndexId 3534
52 
53 /*
54  * prototypes for functions in pg_enum.c
55  */
56 extern void EnumValuesCreate(Oid enumTypeOid, List *vals);
57 extern void EnumValuesDelete(Oid enumTypeOid);
58 extern void AddEnumLabel(Oid enumTypeOid, const char *newVal,
59  const char *neighbor, bool newValIsAfter,
60  bool skipIfExists);
61 extern void RenameEnumLabel(Oid enumTypeOid,
62  const char *oldVal, const char *newVal);
63 extern bool EnumUncommitted(Oid enum_id);
65 extern void SerializeUncommittedEnums(void *space, Size size);
66 extern void RestoreUncommittedEnums(void *space);
67 extern void AtEOXact_Enum(void);
68 
69 #endif /* PG_ENUM_H */
void SerializeUncommittedEnums(void *space, Size size)
Definition: pg_enum.c:709
void RenameEnumLabel(Oid enumTypeOid, const char *oldVal, const char *newVal)
Definition: pg_enum.c:508
void EnumValuesCreate(Oid enumTypeOid, List *vals)
Definition: pg_enum.c:61
unsigned int Oid
Definition: postgres_ext.h:31
void AddEnumLabel(Oid enumTypeOid, const char *newVal, const char *neighbor, bool newValIsAfter, bool skipIfExists)
Definition: pg_enum.c:208
void EnumValuesDelete(Oid enumTypeOid)
Definition: pg_enum.c:157
Definition: c.h:675
FormData_pg_enum * Form_pg_enum
Definition: pg_enum.h:44
bool EnumUncommitted(Oid enum_id)
Definition: pg_enum.c:591
#define BKI_LOOKUP(catalog)
Definition: genbki.h:46
FormData_pg_enum
Definition: pg_enum.h:37
float float4
Definition: c.h:564
void RestoreUncommittedEnums(void *space)
Definition: pg_enum.c:741
void AtEOXact_Enum(void)
Definition: pg_enum.c:609
size_t Size
Definition: c.h:540
DECLARE_UNIQUE_INDEX(pg_enum_typid_label_index, 3503, on pg_enum using btree(enumtypid oid_ops, enumlabel name_ops))
Size EstimateUncommittedEnumsSpace(void)
Definition: pg_enum.c:695
DECLARE_UNIQUE_INDEX_PKEY(pg_enum_oid_index, 3502, on pg_enum using btree(oid oid_ops))
Definition: pg_list.h:50
CATALOG(pg_enum, 3501, EnumRelationId)
Definition: pg_enum.h:31