pg_enum.h

Go to the documentation of this file.

/*-------------------------------------------------------------------------
 *
 * pg_enum.h
 *    definition of the "enum" system catalog (pg_enum)
 *
 *
 * Portions Copyright (c) 1996-2026, PostgreSQL Global Development Group
 * Portions Copyright (c) 1994, Regents of the University of California
 *
 * src/include/catalog/pg_enum.h
 *
 * NOTES
 *    The Catalog.pm module reads this file and derives schema
 *    information.
 *
 *-------------------------------------------------------------------------
 */
#ifndef PG_ENUM_H
#define PG_ENUM_H
 
#include "catalog/genbki.h"
#include "catalog/pg_enum_d.h"  /* IWYU pragma: export */
 
#include "nodes/pg_list.h"
 
/* ----------------
 *      pg_enum definition.  cpp turns this into
 *      typedef struct FormData_pg_enum
 * ----------------
 */
BEGIN_CATALOG_STRUCT
 
CATALOG(pg_enum,3501,EnumRelationId)
{
    Oid         oid;            /* oid */
    Oid         enumtypid BKI_LOOKUP(pg_type);  /* OID of owning enum type */
    float4      enumsortorder;  /* sort position of this enum value */
    NameData    enumlabel;      /* text representation of enum value */
} FormData_pg_enum;
 
END_CATALOG_STRUCT
 
/* ----------------
 *      Form_pg_enum corresponds to a pointer to a tuple with
 *      the format of pg_enum relation.
 * ----------------
 */
typedef FormData_pg_enum *Form_pg_enum;
 
DECLARE_UNIQUE_INDEX_PKEY(pg_enum_oid_index, 3502, EnumOidIndexId, pg_enum, btree(oid oid_ops));
DECLARE_UNIQUE_INDEX(pg_enum_typid_label_index, 3503, EnumTypIdLabelIndexId, pg_enum, btree(enumtypid oid_ops, enumlabel name_ops));
DECLARE_UNIQUE_INDEX(pg_enum_typid_sortorder_index, 3534, EnumTypIdSortOrderIndexId, pg_enum, btree(enumtypid oid_ops, enumsortorder float4_ops));
 
MAKE_SYSCACHE(ENUMOID, pg_enum_oid_index, 8);
MAKE_SYSCACHE(ENUMTYPOIDNAME, pg_enum_typid_label_index, 8);
 
/*
 * prototypes for functions in pg_enum.c
 */
extern void EnumValuesCreate(Oid enumTypeOid, List *vals);
extern void EnumValuesDelete(Oid enumTypeOid);
extern void AddEnumLabel(Oid enumTypeOid, const char *newVal,
                         const char *neighbor, bool newValIsAfter,
                         bool skipIfExists);
extern void RenameEnumLabel(Oid enumTypeOid,
                            const char *oldVal, const char *newVal);
extern bool EnumUncommitted(Oid enum_id);
extern Size EstimateUncommittedEnumsSpace(void);
extern void SerializeUncommittedEnums(void *space, Size size);
extern void RestoreUncommittedEnums(void *space);
extern void AtEOXact_Enum(void);
 
#endif                          /* PG_ENUM_H */