PostgreSQL Source Code git master
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
pg_shdescription.h
Go to the documentation of this file.
1/*-------------------------------------------------------------------------
2 *
3 * pg_shdescription.h
4 * definition of the "shared description" system catalog
5 * (pg_shdescription)
6 *
7 * Because the contents of this table are taken from the *.dat files
8 * of other catalogs, there is no pg_shdescription.dat file. The initial
9 * contents are assembled by genbki.pl and loaded during initdb.
10 *
11 * NOTE: an object is identified by the OID of the row that primarily
12 * defines the object, plus the OID of the table that that row appears in.
13 * For example, a database is identified by the OID of its pg_database row
14 * plus the pg_class OID of table pg_database. This allows unique
15 * identification of objects without assuming that OIDs are unique
16 * across tables.
17 *
18 *
19 * Portions Copyright (c) 1996-2025, PostgreSQL Global Development Group
20 * Portions Copyright (c) 1994, Regents of the University of California
21 *
22 * src/include/catalog/pg_shdescription.h
23 *
24 * NOTES
25 * The Catalog.pm module reads this file and derives schema
26 * information.
27 *
28 *-------------------------------------------------------------------------
29 */
30#ifndef PG_SHDESCRIPTION_H
31#define PG_SHDESCRIPTION_H
32
33#include "catalog/genbki.h"
34#include "catalog/pg_shdescription_d.h"
35
36/* ----------------
37 * pg_shdescription definition. cpp turns this into
38 * typedef struct FormData_pg_shdescription
39 * ----------------
40 */
41CATALOG(pg_shdescription,2396,SharedDescriptionRelationId) BKI_SHARED_RELATION
42{
43 Oid objoid; /* OID of object itself */
44 Oid classoid; /* OID of table containing object */
45
46#ifdef CATALOG_VARLEN /* variable-length fields start here */
47 text description BKI_FORCE_NOT_NULL; /* description of object */
48#endif
50
51/* ----------------
52 * Form_pg_shdescription corresponds to a pointer to a tuple with
53 * the format of pg_shdescription relation.
54 * ----------------
55 */
57
58DECLARE_TOAST_WITH_MACRO(pg_shdescription, 2846, 2847, PgShdescriptionToastTable, PgShdescriptionToastIndex);
59
60DECLARE_UNIQUE_INDEX_PKEY(pg_shdescription_o_c_index, 2397, SharedDescriptionObjIndexId, pg_shdescription, btree(objoid oid_ops, classoid oid_ops));
61
62/* We do not use BKI_LOOKUP here because it causes problems for genbki.pl */
63DECLARE_FOREIGN_KEY((classoid), pg_class, (oid));
64
65#endif /* PG_SHDESCRIPTION_H */
#define BKI_FORCE_NOT_NULL
Definition: genbki.h:33
#define BKI_SHARED_RELATION
Definition: genbki.h:27
DECLARE_TOAST_WITH_MACRO(pg_shdescription, 2846, 2847, PgShdescriptionToastTable, PgShdescriptionToastIndex)
DECLARE_UNIQUE_INDEX_PKEY(pg_shdescription_o_c_index, 2397, SharedDescriptionObjIndexId, pg_shdescription, btree(objoid oid_ops, classoid oid_ops))
DECLARE_FOREIGN_KEY((classoid), pg_class,(oid))
FormData_pg_shdescription * Form_pg_shdescription
FormData_pg_shdescription
CATALOG(pg_shdescription, 2396, SharedDescriptionRelationId) BKI_SHARED_RELATION
unsigned int Oid
Definition: postgres_ext.h:31
Definition: c.h:641
const char * description