pg_init_privs.h

Go to the documentation of this file.

/*-------------------------------------------------------------------------
 *
 * pg_init_privs.h
 *    definition of the "initial privileges" system catalog (pg_init_privs)
 *
 * NOTE: an object is identified by the OID of the row that primarily
 * defines the object, plus the OID of the table that that row appears in.
 * For example, a function is identified by the OID of its pg_proc row
 * plus the pg_class OID of table pg_proc.  This allows unique identification
 * of objects without assuming that OIDs are unique across tables.
 *
 * Since attributes don't have OIDs of their own, we identify an attribute
 * privilege by the objoid+classoid of its parent table, plus an "objsubid"
 * giving the attribute column number.  "objsubid" must be zero in a privilege
 * for a table itself, so that it is distinct from any column privilege.
 * Currently, objsubid is unused and zero for all other kinds of objects.
 *
 * Because the contents of this table depend on what is done with the other
 * objects in the system (and, in particular, may change due to changes in
 * system_views.sql), there is no pg_init_privs.dat file. The initial contents
 * are loaded near the end of initdb.
 *
 *
 * Portions Copyright (c) 1996-2025, PostgreSQL Global Development Group
 * Portions Copyright (c) 1994, Regents of the University of California
 *
 * src/include/catalog/pg_init_privs.h
 *
 * NOTES
 *    The Catalog.pm module reads this file and derives schema
 *    information.
 *
 *-------------------------------------------------------------------------
 */
#ifndef PG_INIT_PRIVS_H
#define PG_INIT_PRIVS_H
 
#include "catalog/genbki.h"
#include "catalog/pg_init_privs_d.h"    /* IWYU pragma: export */
 
/* ----------------
 *      pg_init_privs definition.  cpp turns this into
 *      typedef struct FormData_pg_init_privs
 * ----------------
 */
CATALOG(pg_init_privs,3394,InitPrivsRelationId)
{
    Oid         objoid;         /* OID of object itself */
    Oid         classoid BKI_LOOKUP(pg_class);  /* OID of table containing
                                                 * object */
    int32       objsubid;       /* column number, or 0 if not used */
    char        privtype;       /* from initdb or extension? */
 
#ifdef CATALOG_VARLEN           /* variable-length fields start here */
    aclitem     initprivs[1] BKI_FORCE_NOT_NULL;    /* initial privs on object */
#endif
} FormData_pg_init_privs;
 
/* ----------------
 *      Form_pg_init_privs corresponds to a pointer to a tuple with
 *      the format of pg_init_privs relation.
 * ----------------
 */
typedef FormData_pg_init_privs * Form_pg_init_privs;
 
DECLARE_TOAST(pg_init_privs, 4155, 4156);
 
DECLARE_UNIQUE_INDEX_PKEY(pg_init_privs_o_c_o_index, 3395, InitPrivsObjIndexId, pg_init_privs, btree(objoid oid_ops, classoid oid_ops, objsubid int4_ops));
 
/*
 * It is important to know if the initial privileges are from initdb or from an
 * extension.  This enum is used to provide that differentiation and the two
 * places which populate this table (initdb and during CREATE EXTENSION, see
 * recordExtensionInitPriv()) know to use the correct values.
 */
 
typedef enum InitPrivsType
{
    INITPRIVS_INITDB = 'i',
    INITPRIVS_EXTENSION = 'e',
}           InitPrivsType;
 
#endif                          /* PG_INIT_PRIVS_H */