pg_inherits.h

Go to the documentation of this file.

/*-------------------------------------------------------------------------
 *
 * pg_inherits.h
 *    definition of the "inherits" system catalog (pg_inherits)
 *
 *
 * Portions Copyright (c) 1996-2025, PostgreSQL Global Development Group
 * Portions Copyright (c) 1994, Regents of the University of California
 *
 * src/include/catalog/pg_inherits.h
 *
 * NOTES
 *    The Catalog.pm module reads this file and derives schema
 *    information.
 *
 *-------------------------------------------------------------------------
 */
#ifndef PG_INHERITS_H
#define PG_INHERITS_H
 
#include "catalog/genbki.h"
#include "catalog/pg_inherits_d.h"  /* IWYU pragma: export */
 
#include "nodes/pg_list.h"
#include "storage/lock.h"
 
/* ----------------
 *      pg_inherits definition.  cpp turns this into
 *      typedef struct FormData_pg_inherits
 * ----------------
 */
CATALOG(pg_inherits,2611,InheritsRelationId)
{
    Oid         inhrelid BKI_LOOKUP(pg_class);
    Oid         inhparent BKI_LOOKUP(pg_class);
    int32       inhseqno;
    bool        inhdetachpending;
} FormData_pg_inherits;
 
/* ----------------
 *      Form_pg_inherits corresponds to a pointer to a tuple with
 *      the format of pg_inherits relation.
 * ----------------
 */
typedef FormData_pg_inherits *Form_pg_inherits;
 
DECLARE_UNIQUE_INDEX_PKEY(pg_inherits_relid_seqno_index, 2680, InheritsRelidSeqnoIndexId, pg_inherits, btree(inhrelid oid_ops, inhseqno int4_ops));
DECLARE_INDEX(pg_inherits_parent_index, 2187, InheritsParentIndexId, pg_inherits, btree(inhparent oid_ops));
 
 
extern List *find_inheritance_children(Oid parentrelId, LOCKMODE lockmode);
extern List *find_inheritance_children_extended(Oid parentrelId, bool omit_detached,
                                                LOCKMODE lockmode, bool *detached_exist, TransactionId *detached_xmin);
 
extern List *find_all_inheritors(Oid parentrelId, LOCKMODE lockmode,
                                 List **numparents);
extern bool has_subclass(Oid relationId);
extern bool has_superclass(Oid relationId);
extern bool typeInheritsFrom(Oid subclassTypeId, Oid superclassTypeId);
extern void StoreSingleInheritance(Oid relationId, Oid parentOid,
                                   int32 seqNumber);
extern bool DeleteInheritsTuple(Oid inhrelid, Oid inhparent,
                                bool expect_detach_pending,
                                const char *childname);
extern bool PartitionHasPendingDetach(Oid partoid);
 
#endif                          /* PG_INHERITS_H */