mirror of
https://github.com/postgres/postgres.git
synced 2026-03-09 09:40:40 -04:00
039dfbfd5d
inclusions in src/include/catalog/*.h files. The main idea here is to push function declarations for src/backend/catalog/*.c files into separate headers, rather than sticking them into the corresponding catalog definition file as has been done in the past. This commit only carries out that idea fully for pg_proc, pg_type and pg_conversion, but that's enough for the moment --- if pg_list.h ever becomes unsafe for frontend code to include, we'll need to work a bit more. Zdenek Kotala
84 lines
2.9 KiB
C
84 lines
2.9 KiB
C
/*-------------------------------------------------------------------------
|
|
*
|
|
* pg_description.h
|
|
* definition of the system "description" relation (pg_description)
|
|
*
|
|
* 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
|
|
* comment by the objoid+classoid of its parent table, plus an "objsubid"
|
|
* giving the attribute column number. "objsubid" must be zero in a comment
|
|
* for a table itself, so that it is distinct from any column comment.
|
|
* Currently, objsubid is unused and zero for all other kinds of objects,
|
|
* but perhaps it might be useful someday to associate comments with
|
|
* constituent elements of other kinds of objects (arguments of a function,
|
|
* for example).
|
|
*
|
|
*
|
|
* Portions Copyright (c) 1996-2008, PostgreSQL Global Development Group
|
|
* Portions Copyright (c) 1994, Regents of the University of California
|
|
*
|
|
* $PostgreSQL: pgsql/src/include/catalog/pg_description.h,v 1.27 2008/03/27 03:57:34 tgl Exp $
|
|
*
|
|
* NOTES
|
|
* the genbki.sh script reads this file and generates .bki
|
|
* information from the DATA() statements.
|
|
*
|
|
* XXX do NOT break up DATA() statements into multiple lines!
|
|
* the scripts are not as smart as you might think...
|
|
*
|
|
*-------------------------------------------------------------------------
|
|
*/
|
|
#ifndef PG_DESCRIPTION_H
|
|
#define PG_DESCRIPTION_H
|
|
|
|
#include "catalog/genbki.h"
|
|
|
|
/* ----------------
|
|
* pg_description definition. cpp turns this into
|
|
* typedef struct FormData_pg_description
|
|
* ----------------
|
|
*/
|
|
#define DescriptionRelationId 2609
|
|
|
|
CATALOG(pg_description,2609) BKI_WITHOUT_OIDS
|
|
{
|
|
Oid objoid; /* OID of object itself */
|
|
Oid classoid; /* OID of table containing object */
|
|
int4 objsubid; /* column number, or 0 if not used */
|
|
text description; /* description of object */
|
|
} FormData_pg_description;
|
|
|
|
/* ----------------
|
|
* Form_pg_description corresponds to a pointer to a tuple with
|
|
* the format of pg_description relation.
|
|
* ----------------
|
|
*/
|
|
typedef FormData_pg_description *Form_pg_description;
|
|
|
|
/* ----------------
|
|
* compiler constants for pg_description
|
|
* ----------------
|
|
*/
|
|
#define Natts_pg_description 4
|
|
#define Anum_pg_description_objoid 1
|
|
#define Anum_pg_description_classoid 2
|
|
#define Anum_pg_description_objsubid 3
|
|
#define Anum_pg_description_description 4
|
|
|
|
/* ----------------
|
|
* initial contents of pg_description
|
|
* ----------------
|
|
*/
|
|
|
|
/*
|
|
* Because the contents of this table are taken from the other *.h files,
|
|
* there is no initialization here. The initial contents are extracted
|
|
* by genbki.sh and loaded during initdb.
|
|
*/
|
|
|
|
#endif /* PG_DESCRIPTION_H */
|