<!--

Documentation of the system catalogs, directed toward PostgreSQL developers

$Header: /cvsroot/pgsql/doc/src/sgml/catalogs.sgml,v 2.61 2002/09/22 19:42:50 tgl Exp $

$Header: /cvsroot/pgsql/doc/src/sgml/catalogs.sgml,v 2.62 2002/09/24 21:26:44 tgl Exp $

-->

<chapter id="catalogs">

<entry>aggfinalfn</entry>

<entry><type>regproc</type></entry>

<entry>pg_proc.oid</entry>

<entry>Final function</entry>

<entry>Final function (zero if none)</entry>

</row>

<row>

<entry>aggtranstype</entry>

<entry><type>int2</type></entry>

<entry></entry>

<entry>

This is a copy of the

This is a copy of

<structname>pg_type</structname>.<structfield>typlen</structfield>

for this column's type.

of this column's type.

</entry>

</row>

<structfield>atttypmod</structfield> records type-specific data

supplied at table creation time (for example, the maximum

length of a <type>varchar</type> column). It is passed to

type-specific input and output functions as the third

argument. The value will generally be -1 for types that do not

need typmod.

type-specific input functions and length coercion functions.

The value will generally be -1 for types that do not need typmod.

</entry>

</row>

<entry><type>char</type></entry>

<entry></entry>

<entry>

A copy of

Normally a copy of

<structname>pg_type</structname>.<structfield>typstorage</structfield>

of this column's type

of this column's type. For TOASTable datatypes, this can be altered

after column creation to control storage policy.

</entry>

</row>

table. This includes indexes (but see also

<structname>pg_index</structname>), sequences, views, and some

kinds of special relation; see <structfield>relkind</>.

. Below, when we mean all of these

Below, when we mean all of these

kinds of objects we speak of <quote>relations</quote>. Not all

fields are meaningful for all relation types.

</para>

<row>

<entry>conkey</entry>

<entry><type>smallint[]</type></entry>

<entry><type>int2[]</type></entry>

<entry>pg_attribute.attnum</entry>

<entry>If a table constraint, list of columns which the constraint constrains</entry>

</row>

<row>

<entry>confkey</entry>

<entry><type>smallint[]</type></entry>

<entry><type>int2[]</type></entry>

<entry>pg_attribute.attnum</entry>

<entry>If a foreign key, list of the referenced columns</entry>

</row>

<entry>datdba</entry>

<entry><type>int4</type></entry>

<entry>pg_shadow.usesysid</entry>

<entry>Owner of the database,initially who created it</entry>

<entry>Owner of the database,usually the user who created it</entry>

</row>

<row>

<row>

<entry>objsubid</entry>

<entry><type>integer</type></entry>

<entry><type>int4</type></entry>

<entry></entry>

<entry>For a table attribute, this is the attribute's

column number (the objid and classid refer to the table itself).

<row>

<entry>refobjsubid</entry>

<entry><type>integer</type></entry>

<entry><type>int4</type></entry>

<entry></entry>

<entry>For a table attribute, this is the attribute's

column number (theobjid andclassid refer to the table itself).

column number (therefobjid andrefclassid refer to the table itself).

For all other object types, this field is presently zero.

</entry>

</row>

<para>

The pg_description table can store an optional description or

comment for each database object. Descriptions can be manipulated

with the <command>COMMENT</command> command. Client applications

can view the descriptions by joining with this table. Many built-in

system objects have comments associated with them that are shown by

with the <command>COMMENT</command> command and viewed with

<application>psql</application>'s <literal>\d</literal> commands.

Descriptions of many built-in system objects are provided in the initial

contents of pg_description.

</para>

<table>

<entry>indexrelid</entry>

<entry><type>oid</type></entry>

<entry>pg_class.oid</entry>

<entry>Theoid of the pg_class entry for this index</entry>

<entry>TheOID of the pg_class entry for this index</entry>

</row>

<row>

<entry>indrelid</entry>

<entry><type>oid</type></entry>

<entry>pg_class.oid</entry>

<entry>Theoid of the pg_class entry for the table this index is for</entry>

<entry>TheOID of the pg_class entry for the table this index is for</entry>

</row>

<row>

<entry>indproc</entry>

<entry><type>regproc</type></entry>

<entry>pg_proc.oid</entry>

<entry>The registered procedure if this is a functional index</entry>

<entry>The function's OID if this is a functional index,

else zero</entry>

</row>

<row>

<symbol>INDEX_MAX_KEYS</symbol> values that indicate which

table columns this index pertains to. For example a value of

<literal>1 3</literal> would mean that the first and the third

column make up the index key.

column make up the index key. For a functional index, these

columns are the inputs to the function, and the function's return

value is the index key.

</entry>

</row>

<entry><type>text</type></entry>

<entry></entry>

<entry>Expression tree (in the form of a nodeToString representation)

for partial index predicate</entry>

for partial index predicate. Empty string if not a partial

index.</entry>

</row>

</tbody>

</tgroup>

<entry><type>oid</type></entry>

<entry>pg_class.oid</entry>

<entry>

This is the reference to the subtable, that is, it records the

fact that the identified table is inherited from some other

table.

The OID of the child table.

</entry>

</row>

<entry><type>oid</type></entry>

<entry>pg_class.oid</entry>

<entry>

This is the reference to the parent table, which the table

referenced by <structfield>inhrelid</structfield> inherited

from.

The OID of the parent table.

</entry>

</row>

<entry><type>int4</type></entry>

<entry></entry>

<entry>

If there is more than one parent for asubtable (multiple

If there is more than one parent for achild table (multiple

inheritance), this number tells the order in which the

inherited columns are to be arranged. The count starts at 1.

</entry>

</tgroup>

</table>

<para>

Unused fields contain zeroes, for example oprleft is zero for a

prefix operator.

</para>

</sect1>

</row>

<row>

<entry>proistrusted</entry>

<entry>prosecdef</entry>

<entry><type>bool</type></entry>

<entry></entry>

<entry>not functional</entry>

<entry>Function is a security definer (i.e., a <quote>setuid</>

function)</entry>

</row>

<row>

<entry>prorettype</entry>

<entry><type>oid</type></entry>

<entry>pg_type.oid</entry>

<entry>Data type of the return value (0 if the function does not return a value)</entry>

<entry>Data type of the return value</entry>

</row>

<row>

<entry>Rule name</entry>

</row>

<row>

<entry>ev_type</entry>

<entry><type>char</type></entry>

<entry></entry>

<entry>Event type that the rule is for: '1' = SELECT,

'2' = UPDATE, '3' = INSERT, '4' = DELETE</entry>

</row>

<row>

<entry>ev_class</entry>

<entry><type>oid</type></entry>

indicate the whole table)</entry>

</row>

<row>

<entry>ev_type</entry>

<entry><type>char</type></entry>

<entry></entry>

<entry>Event type that the rule is for: '1' = SELECT,

'2' = UPDATE, '3' = INSERT, '4' = DELETE</entry>

</row>

<row>

<entry>is_instead</entry>

<entry><type>bool</type></entry>

<entry>tgname</entry>

<entry><type>name</type></entry>

<entry></entry>

<entry>Trigger name (need notbe unique)</entry>

<entry>Trigger name (mustbe unique among triggers of same table)</entry>

</row>

<row>

<entry>tgisconstraint</entry>

<entry><type>bool</type></entry>

<entry></entry>

<entry>True if triggeris a RI constraint</entry>

<entry>True if triggerimplements an RI constraint</entry>

</row>

<row>

<entry></entry>

<entry>True if the type is defined, false if this is a placeholder

entry for a not-yet-defined type. When typisdefined is false,

nothing except the type name and OID can be relied on.

nothing except the type name, namespace, and OID can be relied on.

</entry>

</row>

<entry>typinput</entry>

<entry><type>regproc</type></entry>

<entry>pg_proc.oid</entry>

<entry>Input function</entry>

<entry>Inputconversionfunction</entry>

</row>

<row>

<entry>typoutput</entry>

<entry><type>regproc</type></entry>

<entry>pg_proc.oid</entry>

<entry>Output function</entry>

<entry>Outputconversionfunction</entry>

</row>

<row>

<entry><type>int4</type></entry>

<entry></entry>

<entry><para>

<structfield>typtypmod</structfield> records type-specific data

supplied at table creation time (for example, the maximum

length of a <type>varchar</type> column). It is passed to

type-specific input and output functions as the third

argument. The value will generally be -1 for types that do not

need typmod. This value is copied to

<structfield>pg_attribute.atttypmod</structfield> when

creating a column of a domain type.

</para></entry>

Domains use <structfield>typtypmod</structfield> to record the typmod

to be applied to their base type (-1 if base type does not use a

typmod). -1 if this type is not a domain.

</para></entry>

</row>

<row>

<entry></entry>

<entry><para>

<structfield>typndims</structfield> is the number of array dimensions

for a domain that is an array. (The array element type is

typbasetype.) Zero for non-domains and non-array domains.

This value is copied to

<structfield>pg_attribute.attndims</structfield> when

creating a column of a domain type.

for a domain that is an array (that is, typbasetype is an array type;

the domain's typelem will match the base type's typelem).

Zero for non-domains and non-array domains.

</para></entry>

</row>

Oidtypbasetype;

int4typtypmod;

int4typndims;