heap.h

Go to the documentation of this file.

/*-------------------------------------------------------------------------
 *
 * heap.h
 *    prototypes for functions in backend/catalog/heap.c
 *
 *
 * Portions Copyright (c) 1996-2025, PostgreSQL Global Development Group
 * Portions Copyright (c) 1994, Regents of the University of California
 *
 * src/include/catalog/heap.h
 *
 *-------------------------------------------------------------------------
 */
#ifndef HEAP_H
#define HEAP_H
 
#include "catalog/indexing.h"
#include "catalog/objectaddress.h"
#include "parser/parse_node.h"
 
 
/* flag bits for CheckAttributeType/CheckAttributeNamesTypes */
#define CHKATYPE_ANYARRAY       0x01    /* allow ANYARRAY */
#define CHKATYPE_ANYRECORD      0x02    /* allow RECORD and RECORD[] */
#define CHKATYPE_IS_PARTKEY     0x04    /* attname is part key # not column */
#define CHKATYPE_IS_VIRTUAL     0x08    /* is virtual generated column */
 
typedef struct RawColumnDefault
{
    AttrNumber  attnum;         /* attribute to attach default to */
    Node       *raw_default;    /* default value (untransformed parse tree) */
    char        generated;      /* attgenerated setting */
} RawColumnDefault;
 
typedef struct CookedConstraint
{
    ConstrType  contype;        /* CONSTR_DEFAULT, CONSTR_CHECK,
                                 * CONSTR_NOTNULL */
    Oid         conoid;         /* constr OID if created, otherwise Invalid */
    char       *name;           /* name, or NULL if none */
    AttrNumber  attnum;         /* which attr (only for NOTNULL, DEFAULT) */
    Node       *expr;           /* transformed default or check expr */
    bool        is_enforced;    /* is enforced? (only for CHECK) */
    bool        skip_validation;    /* skip validation? (only for CHECK) */
    bool        is_local;       /* constraint has local (non-inherited) def */
    int16       inhcount;       /* number of times constraint is inherited */
    bool        is_no_inherit;  /* constraint has local def and cannot be
                                 * inherited */
} CookedConstraint;
 
extern Relation heap_create(const char *relname,
                            Oid relnamespace,
                            Oid reltablespace,
                            Oid relid,
                            RelFileNumber relfilenumber,
                            Oid accessmtd,
                            TupleDesc tupDesc,
                            char relkind,
                            char relpersistence,
                            bool shared_relation,
                            bool mapped_relation,
                            bool allow_system_table_mods,
                            TransactionId *relfrozenxid,
                            MultiXactId *relminmxid,
                            bool create_storage);
 
extern Oid  heap_create_with_catalog(const char *relname,
                                     Oid relnamespace,
                                     Oid reltablespace,
                                     Oid relid,
                                     Oid reltypeid,
                                     Oid reloftypeid,
                                     Oid ownerid,
                                     Oid accessmtd,
                                     TupleDesc tupdesc,
                                     List *cooked_constraints,
                                     char relkind,
                                     char relpersistence,
                                     bool shared_relation,
                                     bool mapped_relation,
                                     OnCommitAction oncommit,
                                     Datum reloptions,
                                     bool use_user_acl,
                                     bool allow_system_table_mods,
                                     bool is_internal,
                                     Oid relrewrite,
                                     ObjectAddress *typaddress);
 
extern void heap_drop_with_catalog(Oid relid);
 
extern void heap_truncate(List *relids);
 
extern void heap_truncate_one_rel(Relation rel);
 
extern void heap_truncate_check_FKs(List *relations, bool tempTables);
 
extern List *heap_truncate_find_FKs(List *relationIds);
 
extern void InsertPgAttributeTuples(Relation pg_attribute_rel,
                                    TupleDesc tupdesc,
                                    Oid new_rel_oid,
                                    const FormExtraData_pg_attribute tupdesc_extra[],
                                    CatalogIndexState indstate);
 
extern void InsertPgClassTuple(Relation pg_class_desc,
                               Relation new_rel_desc,
                               Oid new_rel_oid,
                               Datum relacl,
                               Datum reloptions);
 
extern List *AddRelationNewConstraints(Relation rel,
                                       List *newColDefaults,
                                       List *newConstraints,
                                       bool allow_merge,
                                       bool is_local,
                                       bool is_internal,
                                       const char *queryString);
extern List *AddRelationNotNullConstraints(Relation rel,
                                           List *constraints,
                                           List *old_notnulls);
 
extern void RelationClearMissing(Relation rel);
 
extern void StoreAttrMissingVal(Relation rel, AttrNumber attnum,
                                Datum missingval);
extern void SetAttrMissing(Oid relid, char *attname, char *value);
 
extern Node *cookDefault(ParseState *pstate,
                         Node *raw_default,
                         Oid atttypid,
                         int32 atttypmod,
                         const char *attname,
                         char attgenerated);
 
extern void DeleteRelationTuple(Oid relid);
extern void DeleteAttributeTuples(Oid relid);
extern void DeleteSystemAttributeTuples(Oid relid);
extern void RemoveAttributeById(Oid relid, AttrNumber attnum);
 
extern void CopyStatistics(Oid fromrelid, Oid torelid);
extern void RemoveStatistics(Oid relid, AttrNumber attnum);
 
extern const FormData_pg_attribute *SystemAttributeDefinition(AttrNumber attno);
 
extern const FormData_pg_attribute *SystemAttributeByName(const char *attname);
 
extern void CheckAttributeNamesTypes(TupleDesc tupdesc, char relkind,
                                     int flags);
 
extern void CheckAttributeType(const char *attname,
                               Oid atttypid, Oid attcollation,
                               List *containing_rowtypes,
                               int flags);
 
/* pg_partitioned_table catalog manipulation functions */
extern void StorePartitionKey(Relation rel,
                              char strategy,
                              int16 partnatts,
                              AttrNumber *partattrs,
                              List *partexprs,
                              Oid *partopclass,
                              Oid *partcollation);
extern void RemovePartitionKeyByRelId(Oid relid);
extern void StorePartitionBound(Relation rel, Relation parent,
                                PartitionBoundSpec *bound);
 
#endif                          /* HEAP_H */