rdelaage
/
postgresql
mirror of https://git.postgresql.org/git/postgresql.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
postgresql/doc/src/sgml/catalogs.sgml

5479 lines
177 KiB
Plaintext
Raw Normal View History

Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<!--
Documentation of the system catalogs, directed toward PostgreSQL developers
Integrate autovacuum functionality into the backend. There's still a few loose ends to be dealt with, but it seems to work. Alvaro Herrera, based on the contrib code by Matthew O'Connor.
2005-07-14 07:13:45 +02:00
$PostgreSQL: pgsql/doc/src/sgml/catalogs.sgml,v 2.108 2005/07/14 05:13:38 tgl Exp $
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
-->
<chapter id="catalogs">
<title>System Catalogs</title>
<para>
The system catalogs are the place where a relational database
management system stores schema metadata, such as information about
tables and columns, and internal bookkeeping information.
<productname>PostgreSQL</productname>'s system catalogs are regular
tables. You can drop and recreate the tables, add columns, insert
and update values, and severely mess up your system that way.
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
Normally, one should not change the system catalogs by hand, there
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
are always SQL commands to do that. (For example, <command>CREATE
DATABASE</command> inserts a row into the
Replace "--" and "---" with "&mdash;" as appropriate, for better-looking output.
2004-11-15 07:32:15 +01:00
<structname>pg_database</structname> catalog &mdash; and actually
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
creates the database on disk.) There are some exceptions for
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
particularly esoteric operations, such as adding index access methods.
</para>
<sect1 id="catalogs-overview">
<title>Overview</title>
<para>
<xref linkend="catalog-table"> lists the system catalogs.
More detailed documentation of each catalog follows below.
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</para>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
- Link the entries in the table to the catalog heading - Wrap them in the <database class="table"> tags, since thats what they are (no markup rules for this, so it inherits from parent -- no style change) - Mention that pg_database, pg_shadow, and pg_group are global, and the rest are local to the specific DB. (I believe this is correct). > Works for me, though I suppose we could explain what the exceptions are > like in general terms. Perhaps something like > > 'Most system catalogs are copied from the template database during > database creation, and are thereafter database-specific. A few > catalogs are physically shared across all databases in an installation; > these are marked in the descriptions of the individual catalogs.' Ok, new patch. Rod Taylor
2002-10-14 06:29:23 +02:00
<para>
Most system catalogs are copied from the template database during
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
database creation and are thereafter database-specific. A few
catalogs are physically shared across all databases in a cluster;
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
these are noted in the descriptions of the individual catalogs.
- Link the entries in the table to the catalog heading - Wrap them in the <database class="table"> tags, since thats what they are (no markup rules for this, so it inherits from parent -- no style change) - Mention that pg_database, pg_shadow, and pg_group are global, and the rest are local to the specific DB. (I believe this is correct). > Works for me, though I suppose we could explain what the exceptions are > like in general terms. Perhaps something like > > 'Most system catalogs are copied from the template database during > database creation, and are thereafter database-specific. A few > catalogs are physically shared across all databases in an installation; > these are marked in the descriptions of the individual catalogs.' Ok, new patch. Rod Taylor
2002-10-14 06:29:23 +02:00
</para>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<table id="catalog-table">
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<title>System Catalogs</title>
<tgroup cols="2">
<thead>
<row>
<entry>Catalog Name</entry>
<entry>Purpose</entry>
</row>
</thead>
<tbody>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><link linkend="catalog-pg-aggregate"><structname>pg_aggregate</structname></link></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>aggregate functions</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><link linkend="catalog-pg-am"><structname>pg_am</structname></link></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>index access methods</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><link linkend="catalog-pg-amop"><structname>pg_amop</structname></link></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>access method operators</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><link linkend="catalog-pg-amproc"><structname>pg_amproc</structname></link></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>access method support procedures</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><link linkend="catalog-pg-attrdef"><structname>pg_attrdef</structname></link></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>column default values</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><link linkend="catalog-pg-attribute"><structname>pg_attribute</structname></link></entry>
<entry>table columns (<quote>attributes</quote>)</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
Replace pg_shadow and pg_group by new role-capable catalogs pg_authid and pg_auth_members. There are still many loose ends to finish in this patch (no documentation, no regression tests, no pg_dump support for instance). But I'm going to commit it now anyway so that Alvaro can make some progress on shared dependencies. The catalog changes should be pretty much done.
2005-06-28 07:09:14 +02:00
<row>
<entry><link linkend="catalog-pg-authid"><structname>pg_authid</structname></link></entry>
<entry>authorization identifiers (roles)</entry>
</row>
<row>
<entry><link linkend="catalog-pg-auth-members"><structname>pg_auth_members</structname></link></entry>
<entry>authorization identifier membership relationships</entry>
</row>
Integrate autovacuum functionality into the backend. There's still a few loose ends to be dealt with, but it seems to work. Alvaro Herrera, based on the contrib code by Matthew O'Connor.
2005-07-14 07:13:45 +02:00
<row>
<entry><link linkend="catalog-pg-autovacuum"><structname>pg_autovacuum</structname></link></entry>
<entry>per-relation autovacuum configuration parameters</entry>
</row>
Add unique index on pg_cast.oid, and document pg_cast table.
2002-07-22 22:23:19 +02:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><link linkend="catalog-pg-cast"><structname>pg_cast</structname></link></entry>
Add unique index on pg_cast.oid, and document pg_cast table.
2002-07-22 22:23:19 +02:00
<entry>casts (data type conversions)</entry>
</row>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><link linkend="catalog-pg-class"><structname>pg_class</structname></link></entry>
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
<entry>tables, indexes, sequences, views (<quote>relations</quote>)</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><link linkend="catalog-pg-constraint"><structname>pg_constraint</structname></link></entry>
<entry>check constraints, unique constraints, primary key constraints, foreign key constraints</entry>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
</row>
Add pg_conversion system catalog. Update description for multibyte support.
2002-07-24 07:51:56 +02:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><link linkend="catalog-pg-conversion"><structname>pg_conversion</structname></link></entry>
Add pg_conversion system catalog. Update description for multibyte support.
2002-07-24 07:51:56 +02:00
<entry>encoding conversion information</entry>
</row>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><link linkend="catalog-pg-database"><structname>pg_database</structname></link></entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<entry>databases within this database cluster</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><link linkend="catalog-pg-depend"><structname>pg_depend</structname></link></entry>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<entry>dependencies between database objects</entry>
</row>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><link linkend="catalog-pg-description"><structname>pg_description</structname></link></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>descriptions or comments on database objects</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><link linkend="catalog-pg-index"><structname>pg_index</structname></link></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>additional index information</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><link linkend="catalog-pg-inherits"><structname>pg_inherits</structname></link></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>table inheritance hierarchy</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><link linkend="catalog-pg-language"><structname>pg_language</structname></link></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>languages for writing functions</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><link linkend="catalog-pg-largeobject"><structname>pg_largeobject</structname></link></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>large objects</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><link linkend="catalog-pg-listener"><structname>pg_listener</structname></link></entry>
<entry>asynchronous notification support</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
Create the pg_namespace system catalog. Doesn't do much yet, but it's there and CREATE SCHEMA will make entries in it...
2002-03-22 22:34:44 +01:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><link linkend="catalog-pg-namespace"><structname>pg_namespace</structname></link></entry>
<entry>schemas</entry>
Create the pg_namespace system catalog. Doesn't do much yet, but it's there and CREATE SCHEMA will make entries in it...
2002-03-22 22:34:44 +01:00
</row>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><link linkend="catalog-pg-opclass"><structname>pg_opclass</structname></link></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>index access method operator classes</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><link linkend="catalog-pg-operator"><structname>pg_operator</structname></link></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>operators</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>functions and procedures</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><link linkend="catalog-pg-rewrite"><structname>pg_rewrite</structname></link></entry>
<entry>query rewrite rules</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
Track dependencies on shared objects (which is to say, roles; we already have adequate mechanisms for tracking the contents of databases and tablespaces). This solves the longstanding problem that you can drop a user who still owns objects and/or has access permissions. Alvaro Herrera, with some kibitzing from Tom Lane.
2005-07-07 22:40:02 +02:00
<row>
<entry><link linkend="catalog-pg-shdepend"><structname>pg_shdepend</structname></link></entry>
<entry>dependencies on shared objects</entry>
</row>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><link linkend="catalog-pg-statistic"><structname>pg_statistic</structname></link></entry>
<entry>planner statistics</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
Tablespaces. Alternate database locations are dead, long live tablespaces. There are various things left to do: contrib dbsize and oid2name modules need work, and so does the documentation. Also someone should think about COMMENT ON TABLESPACE and maybe RENAME TABLESPACE. Also initlocation is dead, it just doesn't know it yet. Gavin Sherry and Tom Lane.
2004-06-18 08:14:31 +02:00
<row>
<entry><link linkend="catalog-pg-tablespace"><structname>pg_tablespace</structname></link></entry>
<entry>tablespaces within this database cluster</entry>
</row>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><link linkend="catalog-pg-trigger"><structname>pg_trigger</structname></link></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>triggers</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><link linkend="catalog-pg-type"><structname>pg_type</structname></link></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>data types</entry>
</row>
</tbody>
</tgroup>
</table>
Use <sect1> rather than <section> to simplify formatting.
2001-11-09 00:44:01 +01:00
</sect1>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
Use <sect1> rather than <section> to simplify formatting.
2001-11-09 00:44:01 +01:00
<sect1 id="catalog-pg-aggregate">
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_aggregate</structname></title>
<indexterm zone="catalog-pg-aggregate">
<primary>pg_aggregate</primary>
</indexterm>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<para>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
The catalog <structname>pg_aggregate</structname> stores information about
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
aggregate functions. An aggregate function is a function that
Rewrite of planner statistics-gathering code. ANALYZE is now available as a separate statement (though it can still be invoked as part of VACUUM, too). pg_statistic redesigned to be more flexible about what statistics are stored. ANALYZE now collects a list of several of the most common values, not just one, plus a histogram (not just the min and max values). Random sampling is used to make the process reasonably fast even on very large tables. The number of values and histogram bins collected is now user-settable via an ALTER TABLE command. There is more still to do; the new stats are not being used everywhere they could be in the planner. But the remaining changes for this project should be localized, and the behavior is already better than before. A not-very-related change is that sorting now makes use of btree comparison routines if it can find one, rather than invoking '<' twice.
2001-05-07 02:43:27 +02:00
operates on a set of values (typically one column from each row
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
that matches a query condition) and returns a single value computed
from all these values. Typical aggregate functions are
<function>sum</function>, <function>count</function>, and
Restructure representation of aggregate functions so that they have pg_proc entries, per pghackers discussion. This fixes aggregates to live in namespaces, and also simplifies/speeds up lookup in parse_func.c. Also, add a 'proimplicit' flag to pg_proc that controls whether a type coercion function may be invoked implicitly, or only explicitly. The current settings of these flags are more permissive than I would like, but we will need to debate and refine the behavior; for now, I avoided breaking regression tests as much as I could.
2002-04-11 22:00:18 +02:00
<function>max</function>. Each entry in
<structname>pg_aggregate</structname> is an extension of an entry
in <structname>pg_proc</structname>. The <structname>pg_proc</structname>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
entry carries the aggregate's name, input and output data types, and
Restructure representation of aggregate functions so that they have pg_proc entries, per pghackers discussion. This fixes aggregates to live in namespaces, and also simplifies/speeds up lookup in parse_func.c. Also, add a 'proimplicit' flag to pg_proc that controls whether a type coercion function may be invoked implicitly, or only explicitly. The current settings of these flags are more permissive than I would like, but we will need to debate and refine the behavior; for now, I avoided breaking regression tests as much as I could.
2002-04-11 22:00:18 +02:00
other information that is similar to ordinary functions.
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</para>
<table>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_aggregate</> Columns</title>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>aggfnoid</structfield></entry>
Restructure representation of aggregate functions so that they have pg_proc entries, per pghackers discussion. This fixes aggregates to live in namespaces, and also simplifies/speeds up lookup in parse_func.c. Also, add a 'proimplicit' flag to pg_proc that controls whether a type coercion function may be invoked implicitly, or only explicitly. The current settings of these flags are more permissive than I would like, but we will need to debate and refine the behavior; for now, I avoided breaking regression tests as much as I could.
2002-04-11 22:00:18 +02:00
<entry><type>regproc</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structname>pg_proc</structname> OID of the aggregate function</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>aggtransfn</structfield></entry>
Restructure representation of aggregate functions so that they have pg_proc entries, per pghackers discussion. This fixes aggregates to live in namespaces, and also simplifies/speeds up lookup in parse_func.c. Also, add a 'proimplicit' flag to pg_proc that controls whether a type coercion function may be invoked implicitly, or only explicitly. The current settings of these flags are more permissive than I would like, but we will need to debate and refine the behavior; for now, I avoided breaking regression tests as much as I could.
2002-04-11 22:00:18 +02:00
<entry><type>regproc</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>Transition function</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>aggfinalfn</structfield></entry>
Restructure representation of aggregate functions so that they have pg_proc entries, per pghackers discussion. This fixes aggregates to live in namespaces, and also simplifies/speeds up lookup in parse_func.c. Also, add a 'proimplicit' flag to pg_proc that controls whether a type coercion function may be invoked implicitly, or only explicitly. The current settings of these flags are more permissive than I would like, but we will need to debate and refine the behavior; for now, I avoided breaking regression tests as much as I could.
2002-04-11 22:00:18 +02:00
<entry><type>regproc</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
Update some obsolete comments and column descriptions.
2002-09-24 23:26:44 +02:00
<entry>Final function (zero if none)</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
Add aggsortop column to pg_aggregate, so that MIN/MAX optimization can be supported for all datatypes. Add CREATE AGGREGATE and pg_dump support too. Add specialized min/max aggregates for bpchar, instead of depending on text's min/max, because otherwise the possible use of bpchar indexes cannot be recognized. initdb forced because of catalog changes.
2005-04-12 06:26:34 +02:00
<row>
<entry><structfield>aggsortop</structfield></entry>
<entry><type>oid</type></entry>
<entry><literal><link linkend="catalog-pg-operator"><structname>pg_operator</structname></link>.oid</literal></entry>
<entry>Associated sort operator (zero if none)</entry>
</row>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>aggtranstype</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-type"><structname>pg_type</structname></link>.oid</literal></entry>
Add aggsortop column to pg_aggregate, so that MIN/MAX optimization can be supported for all datatypes. Add CREATE AGGREGATE and pg_dump support too. Add specialized min/max aggregates for bpchar, instead of depending on text's min/max, because otherwise the possible use of bpchar indexes cannot be recognized. initdb forced because of catalog changes.
2005-04-12 06:26:34 +02:00
<entry>Data type of the aggregate function's internal transition (state) data</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>agginitval</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>text</type></entry>
<entry></entry>
<entry>
The initial value of the transition state. This is a text
Fix handling of pg_type.typdefault per bug report from Dave Blasby. If there's anyone out there who's actually using datatype-defined default values, this will be an incompatible change in behavior ... but the old behavior was so broken that I doubt anyone was using it.
2001-09-06 04:07:42 +02:00
field containing the initial value in its external string
Add aggsortop column to pg_aggregate, so that MIN/MAX optimization can be supported for all datatypes. Add CREATE AGGREGATE and pg_dump support too. Add specialized min/max aggregates for bpchar, instead of depending on text's min/max, because otherwise the possible use of bpchar indexes cannot be recognized. initdb forced because of catalog changes.
2005-04-12 06:26:34 +02:00
representation. If this field is null, the transition state
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
value starts out null.
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</entry>
</row>
</tbody>
</tgroup>
</table>
<para>
New aggregate functions are registered with the <command>CREATE
Merge documentation into one book. (Build with "make html".) Replace vague cross-references with real links.
2003-03-25 17:15:44 +01:00
AGGREGATE</command> command. See <xref linkend="xaggr"> for more
This patch includes a lot of minor cleanups to the SGML documentation, including: - replacing all the appropriate usages of <citetitle>PostgreSQL ...</citetitle> with &cite-user;, &cite-admin;, and so on - fix an omission in the EXECUTE documentation - add some more text to the EXPLAIN documentation - improve the PL/PgSQL RETURN NEXT documentation (more work to do here) - minor markup fixes Neil Conway
2003-01-19 01:13:31 +01:00
information about writing aggregate functions and the meaning of
the transition functions, etc.
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</para>
Use <sect1> rather than <section> to simplify formatting.
2001-11-09 00:44:01 +01:00
</sect1>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<sect1 id="catalog-pg-am">
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_am</structname></title>
<indexterm zone="catalog-pg-am">
<primary>pg_am</primary>
</indexterm>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<para>
Write some real documentation about the index access method API.
2005-02-13 04:04:15 +01:00
The catalog <structname>pg_am</structname> stores information about index
access methods. There is one row for each index access method supported by
the system. The contents of this catalog are discussed in detail in
<xref linkend="indexam">.
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
</para>
<table>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_am</> Columns</title>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>amname</structfield></entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<entry><type>name</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>Name of the access method</entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>amstrategies</structfield></entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<entry><type>int2</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>Number of operator strategies for this access method</entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>amsupport</structfield></entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<entry><type>int2</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>Number of support routines for this access method</entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>amorderstrategy</structfield></entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<entry><type>int2</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>Zero if the index offers no sort order, otherwise the strategy
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
number of the strategy operator that describes the sort order</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>amcanunique</structfield></entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<entry><type>bool</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>Does the access method support unique indexes?</entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>amcanmulticol</structfield></entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<entry><type>bool</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>Does the access method support multicolumn indexes?</entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
</row>
Change the planner to allow indexscan qualification clauses to use nonconsecutive columns of a multicolumn index, as per discussion around mid-May (pghackers thread "Best way to scan on-disk bitmaps"). This turns out to require only minimal changes in btree, and so far as I can see none at all in GiST. btcostestimate did need some work, but its original assumption that index selectivity == heap selectivity was quite bogus even before this.
2005-06-14 01:14:49 +02:00
<row>
<entry><structfield>amoptionalkey</structfield></entry>
<entry><type>bool</type></entry>
<entry></entry>
<entry>Does the access method support a scan without any constraint
for the first index column?</entry>
</row>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>amindexnulls</structfield></entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<entry><type>bool</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>Does the access method support null index entries?</entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>amconcurrent</structfield></entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<entry><type>bool</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>Does the access method support concurrent updates?</entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
</row>
<row>
First steps towards index scans with heap access decoupled from index access: define new index access method functions 'amgetmulti' that can fetch multiple TIDs per call. (The functions exist but are totally untested as yet.) Since I was modifying pg_am anyway, remove the no-longer-needed 'rel' parameter from amcostestimate functions, and also remove the vestigial amowner column that was creating useless work for Alvaro's shared-object-dependencies project. Initdb forced due to changes in pg_am.
2005-03-28 01:53:05 +02:00
<entry><structfield>aminsert</structfield></entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<entry><type>regproc</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
First steps towards index scans with heap access decoupled from index access: define new index access method functions 'amgetmulti' that can fetch multiple TIDs per call. (The functions exist but are totally untested as yet.) Since I was modifying pg_am anyway, remove the no-longer-needed 'rel' parameter from amcostestimate functions, and also remove the vestigial amowner column that was creating useless work for Alvaro's shared-object-dependencies project. Initdb forced due to changes in pg_am.
2005-03-28 01:53:05 +02:00
<entry><quote>Insert this tuple</quote> function</entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
</row>
<row>
First steps towards index scans with heap access decoupled from index access: define new index access method functions 'amgetmulti' that can fetch multiple TIDs per call. (The functions exist but are totally untested as yet.) Since I was modifying pg_am anyway, remove the no-longer-needed 'rel' parameter from amcostestimate functions, and also remove the vestigial amowner column that was creating useless work for Alvaro's shared-object-dependencies project. Initdb forced due to changes in pg_am.
2005-03-28 01:53:05 +02:00
<entry><structfield>ambeginscan</structfield></entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<entry><type>regproc</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
First steps towards index scans with heap access decoupled from index access: define new index access method functions 'amgetmulti' that can fetch multiple TIDs per call. (The functions exist but are totally untested as yet.) Since I was modifying pg_am anyway, remove the no-longer-needed 'rel' parameter from amcostestimate functions, and also remove the vestigial amowner column that was creating useless work for Alvaro's shared-object-dependencies project. Initdb forced due to changes in pg_am.
2005-03-28 01:53:05 +02:00
<entry><quote>Start new scan</quote> function</entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
</row>
<row>
First steps towards index scans with heap access decoupled from index access: define new index access method functions 'amgetmulti' that can fetch multiple TIDs per call. (The functions exist but are totally untested as yet.) Since I was modifying pg_am anyway, remove the no-longer-needed 'rel' parameter from amcostestimate functions, and also remove the vestigial amowner column that was creating useless work for Alvaro's shared-object-dependencies project. Initdb forced due to changes in pg_am.
2005-03-28 01:53:05 +02:00
<entry><structfield>amgettuple</structfield></entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<entry><type>regproc</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
First steps towards index scans with heap access decoupled from index access: define new index access method functions 'amgetmulti' that can fetch multiple TIDs per call. (The functions exist but are totally untested as yet.) Since I was modifying pg_am anyway, remove the no-longer-needed 'rel' parameter from amcostestimate functions, and also remove the vestigial amowner column that was creating useless work for Alvaro's shared-object-dependencies project. Initdb forced due to changes in pg_am.
2005-03-28 01:53:05 +02:00
<entry><quote>Next valid tuple</quote> function</entry>
</row>
<row>
<entry><structfield>amgetmulti</structfield></entry>
<entry><type>regproc</type></entry>
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
<entry><quote>Fetch multiple tuples</quote> function</entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>amrescan</structfield></entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<entry><type>regproc</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><quote>Restart this scan</quote> function</entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>amendscan</structfield></entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<entry><type>regproc</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><quote>End this scan</quote> function</entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>ammarkpos</structfield></entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<entry><type>regproc</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><quote>Mark current scan position</quote> function</entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>amrestrpos</structfield></entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<entry><type>regproc</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><quote>Restore marked scan position</quote> function</entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>ambuild</structfield></entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<entry><type>regproc</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><quote>Build new index</quote> function</entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>ambulkdelete</structfield></entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<entry><type>regproc</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>Bulk-delete function</entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
</row>
More infrastructure for btree compaction project. Tree-traversal code now knows what to do upon hitting a dead page (in theory anyway, it's untested...). Add a post-VACUUM-cleanup entry point for index AMs, to provide a place for dead-page scavenging to happen. Also, fix oversight that broke btpo_prev links in temporary indexes. initdb forced due to additions in pg_am.
2003-02-22 01:45:05 +01:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>amvacuumcleanup</structfield></entry>
More infrastructure for btree compaction project. Tree-traversal code now knows what to do upon hitting a dead page (in theory anyway, it's untested...). Add a post-VACUUM-cleanup entry point for index AMs, to provide a place for dead-page scavenging to happen. Also, fix oversight that broke btpo_prev links in temporary indexes. initdb forced due to additions in pg_am.
2003-02-22 01:45:05 +01:00
<entry><type>regproc</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>Post-<command>VACUUM</command> cleanup function</entry>
More infrastructure for btree compaction project. Tree-traversal code now knows what to do upon hitting a dead page (in theory anyway, it's untested...). Add a post-VACUUM-cleanup entry point for index AMs, to provide a place for dead-page scavenging to happen. Also, fix oversight that broke btpo_prev links in temporary indexes. initdb forced due to additions in pg_am.
2003-02-22 01:45:05 +01:00
</row>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>amcostestimate</structfield></entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<entry><type>regproc</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>Function to estimate cost of an index scan</entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
</row>
</tbody>
</tgroup>
</table>
</sect1>
<sect1 id="catalog-pg-amop">
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_amop</structname></title>
<indexterm zone="catalog-pg-amop">
<primary>pg_amop</primary>
</indexterm>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<para>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
The catalog <structname>pg_amop</structname> stores information about operators
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
associated with index access method operator classes. There is one
row for each operator that is a member of an operator class.
</para>
<table>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_amop</> Columns</title>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>amopclaid</structfield></entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-opclass"><structname>pg_opclass</structname></link>.oid</literal></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>The index operator class this entry is for</entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
</row>
Cross-data-type comparisons are now indexable by btrees, pursuant to my pghackers proposal of 8-Nov. All the existing cross-type comparison operators (int2/int4/int8 and float4/float8) have appropriate support. The original proposal of storing the right-hand-side datatype as part of the primary key for pg_amop and pg_amproc got modified a bit in the event; it is easier to store zero as the 'default' case and only store a nonzero when the operator is actually cross-type. Along the way, remove the long-since-defunct bigbox_ops operator class.
2003-11-12 22:15:59 +01:00
<row>
<entry><structfield>amopsubtype</structfield></entry>
<entry><type>oid</type></entry>
<entry><literal><link linkend="catalog-pg-type"><structname>pg_type</structname></link>.oid</literal></entry>
<entry>Subtype to distinguish multiple entries for one strategy;
zero for default</entry>
</row>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>amopstrategy</structfield></entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<entry><type>int2</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>Operator strategy number</entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>amopreqcheck</structfield></entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<entry><type>bool</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>Index hit must be rechecked</entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>amopopr</structfield></entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-operator"><structname>pg_operator</structname></link>.oid</literal></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>OID of the operator</entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
</row>
</tbody>
</tgroup>
</table>
</sect1>
<sect1 id="catalog-pg-amproc">
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_amproc</structname></title>
<indexterm zone="catalog-pg-amproc">
<primary>pg_amproc</primary>
</indexterm>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<para>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
The catalog <structname>pg_amproc</structname> stores information about support
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
procedures
associated with index access method operator classes. There is one
row for each support procedure belonging to an operator class.
</para>
<table>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_amproc</structname> Columns</title>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>amopclaid</structfield></entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-opclass"><structname>pg_opclass</structname></link>.oid</literal></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>The index operator class this entry is for</entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
</row>
Cross-data-type comparisons are now indexable by btrees, pursuant to my pghackers proposal of 8-Nov. All the existing cross-type comparison operators (int2/int4/int8 and float4/float8) have appropriate support. The original proposal of storing the right-hand-side datatype as part of the primary key for pg_amop and pg_amproc got modified a bit in the event; it is easier to store zero as the 'default' case and only store a nonzero when the operator is actually cross-type. Along the way, remove the long-since-defunct bigbox_ops operator class.
2003-11-12 22:15:59 +01:00
<row>
<entry><structfield>amprocsubtype</structfield></entry>
<entry><type>oid</type></entry>
<entry><literal><link linkend="catalog-pg-type"><structname>pg_type</structname></link>.oid</literal></entry>
<entry>Subtype, if cross-type routine, else zero</entry>
</row>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>amprocnum</structfield></entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<entry><type>int2</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>Support procedure number</entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>amproc</structfield></entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<entry><type>regproc</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>OID of the procedure</entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
</row>
</tbody>
</tgroup>
</table>
</sect1>
Use <sect1> rather than <section> to simplify formatting.
2001-11-09 00:44:01 +01:00
<sect1 id="catalog-pg-attrdef">
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_attrdef</structname></title>
<indexterm zone="catalog-pg-attrdef">
<primary>pg_attrdef</primary>
</indexterm>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<para>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
The catalog <structname>pg_attrdef</structname> stores column default values. The main information
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
about columns is stored in <structname>pg_attribute</structname>
(see below). Only columns that explicitly specify a default value
(when the table is created or the column is added) will have an
entry here.
</para>
<table>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_attrdef</> Columns</title>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>adrelid</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.oid</literal></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>The table this column belongs to</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>adnum</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>int2</type></entry>
Update obsolete examples of error messages; various other minor editing.
2003-09-13 00:17:24 +02:00
<entry><literal><link linkend="catalog-pg-attribute"><structname>pg_attribute</structname></link>.attnum</literal></entry>
Rewrite of planner statistics-gathering code. ANALYZE is now available as a separate statement (though it can still be invoked as part of VACUUM, too). pg_statistic redesigned to be more flexible about what statistics are stored. ANALYZE now collects a list of several of the most common values, not just one, plus a histogram (not just the min and max values). Random sampling is used to make the process reasonably fast even on very large tables. The number of values and histogram bins collected is now user-settable via an ALTER TABLE command. There is more still to do; the new stats are not being used everywhere they could be in the planner. But the remaining changes for this project should be localized, and the behavior is already better than before. A not-very-related change is that sorting now makes use of btree comparison routines if it can find one, rather than invoking '<' twice.
2001-05-07 02:43:27 +02:00
<entry>The number of the column</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>adbin</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>text</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>The internal representation of the column default value</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>adsrc</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>text</type></entry>
<entry></entry>
<entry>A human-readable representation of the default value</entry>
</row>
</tbody>
</tgroup>
</table>
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
<para>
The <structfield>adsrc</structfield> field is historical, and is best
not used, because it does not track outside changes that might affect
the representation of the default value. Reverse-compiling the
<structfield>adbin</structfield> field (with <function>pg_get_expr</> for
example) is a better way to display the default value.
</para>
Use <sect1> rather than <section> to simplify formatting.
2001-11-09 00:44:01 +01:00
</sect1>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
Use <sect1> rather than <section> to simplify formatting.
2001-11-09 00:44:01 +01:00
<sect1 id="catalog-pg-attribute">
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_attribute</structname></title>
<indexterm zone="catalog-pg-attribute">
<primary>pg_attribute</primary>
</indexterm>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<para>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
The catalog <structname>pg_attribute</structname> stores information about
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
table columns. There will be exactly one
<structname>pg_attribute</structname> row for every column in every
table in the database. (There will also be attribute entries for
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
indexes, and indeed all objects that have <structname>pg_class</structname>
entries.)
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</para>
<para>
The term attribute is equivalent to column and is used for
historical reasons.
</para>
<table>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_attribute</> Columns</title>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>attrelid</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.oid</literal></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>The table this column belongs to</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>attname</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>name</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>The column name</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>atttypid</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-type"><structname>pg_type</structname></link>.oid</literal></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>The data type of this column</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>attstattarget</structfield></entry>
Rewrite of planner statistics-gathering code. ANALYZE is now available as a separate statement (though it can still be invoked as part of VACUUM, too). pg_statistic redesigned to be more flexible about what statistics are stored. ANALYZE now collects a list of several of the most common values, not just one, plus a histogram (not just the min and max values). Random sampling is used to make the process reasonably fast even on very large tables. The number of values and histogram bins collected is now user-settable via an ALTER TABLE command. There is more still to do; the new stats are not being used everywhere they could be in the planner. But the remaining changes for this project should be localized, and the behavior is already better than before. A not-very-related change is that sorting now makes use of btree comparison routines if it can find one, rather than invoking '<' twice.
2001-05-07 02:43:27 +02:00
<entry><type>int4</type></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry></entry>
<entry>
Rewrite of planner statistics-gathering code. ANALYZE is now available as a separate statement (though it can still be invoked as part of VACUUM, too). pg_statistic redesigned to be more flexible about what statistics are stored. ANALYZE now collects a list of several of the most common values, not just one, plus a histogram (not just the min and max values). Random sampling is used to make the process reasonably fast even on very large tables. The number of values and histogram bins collected is now user-settable via an ALTER TABLE command. There is more still to do; the new stats are not being used everywhere they could be in the planner. But the remaining changes for this project should be localized, and the behavior is already better than before. A not-very-related change is that sorting now makes use of btree comparison routines if it can find one, rather than invoking '<' twice.
2001-05-07 02:43:27 +02:00
<structfield>attstattarget</structfield> controls the level of detail
of statistics accumulated for this column by
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
<xref linkend="sql-analyze" endterm="sql-analyze-title">.
Rewrite of planner statistics-gathering code. ANALYZE is now available as a separate statement (though it can still be invoked as part of VACUUM, too). pg_statistic redesigned to be more flexible about what statistics are stored. ANALYZE now collects a list of several of the most common values, not just one, plus a histogram (not just the min and max values). Random sampling is used to make the process reasonably fast even on very large tables. The number of values and histogram bins collected is now user-settable via an ALTER TABLE command. There is more still to do; the new stats are not being used everywhere they could be in the planner. But the remaining changes for this project should be localized, and the behavior is already better than before. A not-very-related change is that sorting now makes use of btree comparison routines if it can find one, rather than invoking '<' twice.
2001-05-07 02:43:27 +02:00
A zero value indicates that no statistics should be collected.
Instead of having a configure-time DEFAULT_ATTSTATTARGET, store -1 in attstattarget to indicate 'use the default'. The default is now a GUC variable default_statistics_target, and so may be changed on the fly. Along the way we gain the ability to have pg_dump dump the per-column statistics target when it's not the default. Patch by Neil Conway, with some kibitzing from Tom Lane.
2002-07-31 19:19:54 +02:00
A negative value says to use the system default statistics target.
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
The exact meaning of positive values is data type-dependent.
For scalar data types, <structfield>attstattarget</structfield>
Rewrite of planner statistics-gathering code. ANALYZE is now available as a separate statement (though it can still be invoked as part of VACUUM, too). pg_statistic redesigned to be more flexible about what statistics are stored. ANALYZE now collects a list of several of the most common values, not just one, plus a histogram (not just the min and max values). Random sampling is used to make the process reasonably fast even on very large tables. The number of values and histogram bins collected is now user-settable via an ALTER TABLE command. There is more still to do; the new stats are not being used everywhere they could be in the planner. But the remaining changes for this project should be localized, and the behavior is already better than before. A not-very-related change is that sorting now makes use of btree comparison routines if it can find one, rather than invoking '<' twice.
2001-05-07 02:43:27 +02:00
is both the target number of <quote>most common values</quote>
to collect, and the target number of histogram bins to create.
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>attlen</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>int2</type></entry>
<entry></entry>
<entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
A copy of <literal>pg_type.typlen</literal> of this column's
type
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>attnum</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>int2</type></entry>
<entry></entry>
<entry>
The number of the column. Ordinary columns are numbered from 1
up. System columns, such as <structfield>oid</structfield>,
have (arbitrary) negative numbers.
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>attndims</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>int4</type></entry>
<entry></entry>
Rewrite of planner statistics-gathering code. ANALYZE is now available as a separate statement (though it can still be invoked as part of VACUUM, too). pg_statistic redesigned to be more flexible about what statistics are stored. ANALYZE now collects a list of several of the most common values, not just one, plus a histogram (not just the min and max values). Random sampling is used to make the process reasonably fast even on very large tables. The number of values and histogram bins collected is now user-settable via an ALTER TABLE command. There is more still to do; the new stats are not being used everywhere they could be in the planner. But the remaining changes for this project should be localized, and the behavior is already better than before. A not-very-related change is that sorting now makes use of btree comparison routines if it can find one, rather than invoking '<' twice.
2001-05-07 02:43:27 +02:00
<entry>
Clean up wrong, misleading, or obsolete documentation about array types, particularly in the CREATE TYPE reference page. Fix some other errors in the CREATE TYPE page, too.
2001-11-03 22:42:47 +01:00
Number of dimensions, if the column is an array type; otherwise 0.
(Presently, the number of dimensions of an array is not enforced,
so any nonzero value effectively means <quote>it's an array</>.)
Rewrite of planner statistics-gathering code. ANALYZE is now available as a separate statement (though it can still be invoked as part of VACUUM, too). pg_statistic redesigned to be more flexible about what statistics are stored. ANALYZE now collects a list of several of the most common values, not just one, plus a histogram (not just the min and max values). Random sampling is used to make the process reasonably fast even on very large tables. The number of values and histogram bins collected is now user-settable via an ALTER TABLE command. There is more still to do; the new stats are not being used everywhere they could be in the planner. But the remaining changes for this project should be localized, and the behavior is already better than before. A not-very-related change is that sorting now makes use of btree comparison routines if it can find one, rather than invoking '<' twice.
2001-05-07 02:43:27 +02:00
</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>attcacheoff</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>int4</type></entry>
<entry></entry>
<entry>
Spell checking, consistent terminology.
2003-11-01 02:56:29 +01:00
Always -1 in storage, but when loaded into a row descriptor
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
in memory this may be updated to cache the offset of the attribute
Spell checking, consistent terminology.
2003-11-01 02:56:29 +01:00
within the row.
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>atttypmod</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>int4</type></entry>
<entry></entry>
<entry>
<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
Update some obsolete comments and column descriptions.
2002-09-24 23:26:44 +02:00
type-specific input functions and length coercion functions.
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
The value will generally be -1 for types that do not need <structfield>atttypmod</>.
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>attbyval</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>bool</type></entry>
<entry></entry>
<entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
A copy of <literal>pg_type.typbyval</> of this column's type
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>attstorage</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>char</type></entry>
<entry></entry>
<entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
Normally a copy of <literal>pg_type.typstorage</> of this
column's type. For TOAST-able data types, this can be altered
Update some obsolete comments and column descriptions.
2002-09-24 23:26:44 +02:00
after column creation to control storage policy.
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>attalign</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>char</type></entry>
<entry></entry>
<entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
A copy of <literal>pg_type.typalign</> of this column's type
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>attnotnull</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>bool</type></entry>
<entry></entry>
<entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
This represents a not-null constraint. It is possible to
change this column to enable or disable the constraint.
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>atthasdef</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>bool</type></entry>
<entry></entry>
<entry>
This column has a default value, in which case there will be a
corresponding entry in the <structname>pg_attrdef</structname>
catalog that actually defines the value.
</entry>
</row>
ALTER TABLE DROP COLUMN works. Patch by Christopher Kings-Lynne, code review by Tom Lane. Remaining issues: functions that take or return tuple types are likely to break if one drops (or adds!) a column in the table defining the type. Need to think about what to do here. Along the way: some code review for recent COPY changes; mark system columns attnotnull = true where appropriate, per discussion a month ago.
2002-08-02 20:15:10 +02:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>attisdropped</structfield></entry>
ALTER TABLE DROP COLUMN works. Patch by Christopher Kings-Lynne, code review by Tom Lane. Remaining issues: functions that take or return tuple types are likely to break if one drops (or adds!) a column in the table defining the type. Need to think about what to do here. Along the way: some code review for recent COPY changes; mark system columns attnotnull = true where appropriate, per discussion a month ago.
2002-08-02 20:15:10 +02:00
<entry><type>bool</type></entry>
<entry></entry>
<entry>
This column has been dropped and is no longer valid. A dropped
column is still physically present in the table, but is
ignored by the parser and so cannot be accessed via SQL.
</entry>
</row>
Add attisinherited column to pg_attribute; use it to guard against column additions, deletions, and renames that would let a child table get out of sync with its parent. Patch by Alvaro Herrera, with some kibitzing by Tom Lane.
2002-08-30 21:23:20 +02:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>attislocal</structfield></entry>
Add attisinherited column to pg_attribute; use it to guard against column additions, deletions, and renames that would let a child table get out of sync with its parent. Patch by Alvaro Herrera, with some kibitzing by Tom Lane.
2002-08-30 21:23:20 +02:00
<entry><type>bool</type></entry>
<entry></entry>
<entry>
Replace pg_attribute.attisinherited with attislocal and attinhcount columns, to allow more correct behavior in multiple-inheritance cases. Patch by Alvaro Herrera, review by Tom Lane.
2002-09-22 21:42:52 +02:00
This column is defined locally in the relation. Note that a column may
be locally defined and inherited simultaneously.
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>attinhcount</structfield></entry>
Replace pg_attribute.attisinherited with attislocal and attinhcount columns, to allow more correct behavior in multiple-inheritance cases. Patch by Alvaro Herrera, review by Tom Lane.
2002-09-22 21:42:52 +02:00
<entry><type>int4</type></entry>
<entry></entry>
<entry>
The number of direct ancestors this column has. A column with a
nonzero number of ancestors cannot be dropped nor renamed.
Add attisinherited column to pg_attribute; use it to guard against column additions, deletions, and renames that would let a child table get out of sync with its parent. Patch by Alvaro Herrera, with some kibitzing by Tom Lane.
2002-08-30 21:23:20 +02:00
</entry>
</row>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</tbody>
</tgroup>
</table>
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
<para>
In a dropped column's <structname>pg_attribute</structname> entry,
<structfield>atttypid</structfield> is reset to zero, but
<structfield>attlen</structfield> and the other fields copied from
<structname>pg_type</> are still valid. This arrangement is needed
to cope with the situation where the dropped column's data type was
later dropped, and so there is no <structname>pg_type</> row anymore.
<structfield>attlen</structfield> and the other fields can be used
to interpret the contents of a row of the table.
</para>
Use <sect1> rather than <section> to simplify formatting.
2001-11-09 00:44:01 +01:00
</sect1>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
Replace pg_shadow and pg_group by new role-capable catalogs pg_authid and pg_auth_members. There are still many loose ends to finish in this patch (no documentation, no regression tests, no pg_dump support for instance). But I'm going to commit it now anyway so that Alvaro can make some progress on shared dependencies. The catalog changes should be pretty much done.
2005-06-28 07:09:14 +02:00
<sect1 id="catalog-pg-authid">
<title><structname>pg_authid</structname></title>
<indexterm zone="catalog-pg-authid">
<primary>pg_authid</primary>
</indexterm>
<para>
The catalog <structname>pg_authid</structname> contains information about
database authorization identifiers (roles). A role subsumes the concepts
of <quote>users</> and <quote>groups</>. A user is essentially just a
role with the <structfield>rolcanlogin</> flag set. Any role (with or
without <structfield>rolcanlogin</>) may have other roles as members; see
<link linkend="catalog-pg-auth-members"><structname>pg_auth_members</structname></link>.
</para>
<para>
Since this catalog contains passwords, it must not be publicly readable.
<link linkend="view-pg-roles"><structname>pg_roles</structname></link>
is a publicly readable view on
<structname>pg_authid</structname> that blanks out the password field.
</para>
<para>
<xref linkend="user-manag"> contains detailed information about user and
privilege management.
</para>
<para>
Because user identities are cluster-wide,
<structname>pg_authid</structname>
is shared across all databases of a cluster: there is only one
copy of <structname>pg_authid</structname> per cluster, not
one per database.
</para>
<table>
<title><structname>pg_authid</> Columns</title>
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><structfield>rolname</structfield></entry>
<entry><type>name</type></entry>
<entry></entry>
<entry>Role name</entry>
</row>
<row>
<entry><structfield>rolsuper</structfield></entry>
<entry><type>bool</type></entry>
<entry></entry>
<entry>Role has superuser privileges</entry>
</row>
<row>
<entry><structfield>rolcreaterole</structfield></entry>
<entry><type>bool</type></entry>
<entry></entry>
<entry>Role may create more roles</entry>
</row>
<row>
<entry><structfield>rolcreatedb</structfield></entry>
<entry><type>bool</type></entry>
<entry></entry>
<entry>Role may create databases</entry>
</row>
<row>
<entry><structfield>rolcatupdate</structfield></entry>
<entry><type>bool</type></entry>
<entry></entry>
<entry>
Role may update system catalogs directly. (Even a superuser may not do
this unless this column is true.)
</entry>
</row>
<row>
<entry><structfield>rolcanlogin</structfield></entry>
<entry><type>bool</type></entry>
<entry></entry>
<entry>
Role may log in, that is, this role can be given as the initial
session authorization identifier.
</entry>
</row>
<row>
<entry><structfield>rolpassword</structfield></entry>
<entry><type>text</type></entry>
<entry></entry>
<entry>Password (possibly encrypted); NULL if none</entry>
</row>
<row>
<entry><structfield>rolvaliduntil</structfield></entry>
<entry><type>timestamptz</type></entry>
<entry></entry>
<entry>Password expiry time (only used for password authentication);
NULL if no expiration</entry>
</row>
<row>
<entry><structfield>rolconfig</structfield></entry>
<entry><type>text[]</type></entry>
<entry></entry>
<entry>Session defaults for run-time configuration variables</entry>
</row>
</tbody>
</tgroup>
</table>
</sect1>
<sect1 id="catalog-pg-auth-members">
<title><structname>pg_auth_members</structname></title>
<indexterm zone="catalog-pg-auth-members">
<primary>pg_auth_members</primary>
</indexterm>
<para>
The catalog <structname>pg_auth_members</structname> shows the membership
relations between roles. Any non-circular set of relationships is allowed.
</para>
<para>
Because user identities are cluster-wide,
<structname>pg_auth_members</structname>
is shared across all databases of a cluster: there is only one
copy of <structname>pg_auth_members</structname> per cluster, not
one per database.
</para>
<table>
<title><structname>pg_auth_members</> Columns</title>
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><structfield>roleid</structfield></entry>
<entry><type>oid</type></entry>
<entry><literal><link linkend="catalog-pg-authid"><structname>pg_authid</structname></link>.oid</literal></entry>
<entry>ID of a role that has a member</entry>
</row>
<row>
<entry><structfield>member</structfield></entry>
<entry><type>oid</type></entry>
<entry><literal><link linkend="catalog-pg-authid"><structname>pg_authid</structname></link>.oid</literal></entry>
<entry>ID of a role that is a member of <structfield>roleid</></entry>
</row>
<row>
<entry><structfield>grantor</structfield></entry>
<entry><type>oid</type></entry>
<entry><literal><link linkend="catalog-pg-authid"><structname>pg_authid</structname></link>.oid</literal></entry>
<entry>ID of the role that granted this membership</entry>
</row>
<row>
<entry><structfield>admin_option</structfield></entry>
<entry><type>bool</type></entry>
<entry></entry>
<entry>True if <structfield>member</> may grant membership in
<structfield>roleid</> to others</entry>
</row>
</tbody>
</tgroup>
</table>
</sect1>
Integrate autovacuum functionality into the backend. There's still a few loose ends to be dealt with, but it seems to work. Alvaro Herrera, based on the contrib code by Matthew O'Connor.
2005-07-14 07:13:45 +02:00
<sect1 id="catalog-pg-autovacuum">
<title><structname>pg_autovacuum</structname></title>
<indexterm zone="catalog-pg-autovacuum">
<primary>pg_autovacuum</primary>
</indexterm>
<para>
The catalog <structname>pg_autovacuum</structname> stores optional
per-relation configuration parameters for <quote>autovacuum</>.
If there is an entry here for a particular relation, the given
parameters will be used for autovacuuming that table. If no entry
is present, the system-wide defaults will be used.
</para>
<table>
<title><structname>pg_autovacuum</> Columns</title>
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><structfield>vacrelid</structfield></entry>
<entry><type>oid</type></entry>
<entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.oid</literal></entry>
<entry>The table this entry is for</entry>
</row>
<row>
<entry><structfield>enabled</structfield></entry>
<entry><type>bool</type></entry>
<entry></entry>
<entry>If false, this table is never autovacuumed</entry>
</row>
<row>
<entry><structfield>vac_base_thresh</structfield></entry>
<entry><type>integer</type></entry>
<entry></entry>
<entry>Minimum number of modified tuples before vacuum</entry>
</row>
<row>
<entry><structfield>vac_scale_factor</structfield></entry>
<entry><type>float4</type></entry>
<entry></entry>
<entry>Multiplier for reltuples to add to
<structfield>vac_base_thresh</></entry>
</row>
<row>
<entry><structfield>anl_base_thresh</structfield></entry>
<entry><type>integer</type></entry>
<entry></entry>
<entry>Minimum number of modified tuples before analyze</entry>
</row>
<row>
<entry><structfield>anl_scale_factor</structfield></entry>
<entry><type>float4</type></entry>
<entry></entry>
<entry>Multiplier for reltuples to add to
<structfield>anl_base_thresh</></entry>
</row>
</tbody>
</tgroup>
</table>
<para>
The autovacuum daemon will initiate a <command>VACUUM</> operation
on a particular table when the number of updated or deleted tuples
exceeds <structfield>vac_base_thresh</structfield> plus
<structfield>vac_scale_factor</structfield> times the number of
live tuples currently estimated to be in the relation.
Similarly, it will initiate an <command>ANALYZE</> operation
when the number of inserted, updated or deleted tuples
exceeds <structfield>anl_base_thresh</structfield> plus
<structfield>anl_scale_factor</structfield> times the number of
live tuples currently estimated to be in the relation.
</para>
<para>
Any of the numerical fields can contain <literal>-1</> (or indeed
any negative value) to indicate that the system-wide default should
be used for this particular value.
</para>
</sect1>
Add unique index on pg_cast.oid, and document pg_cast table.
2002-07-22 22:23:19 +02:00
<sect1 id="catalog-pg-cast">
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_cast</structname></title>
<indexterm zone="catalog-pg-cast">
<primary>pg_cast</primary>
</indexterm>
Add unique index on pg_cast.oid, and document pg_cast table.
2002-07-22 22:23:19 +02:00
<para>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
The catalog <structname>pg_cast</structname> stores data type conversion paths,
Extend pg_cast castimplicit column to a three-way value; this allows us to be flexible about assignment casts without introducing ambiguity in operator/function resolution. Introduce a well-defined promotion hierarchy for numeric datatypes (int2->int4->int8->numeric->float4->float8). Change make_const to initially label numeric literals as int4, int8, or numeric (never float8 anymore). Explicitly mark Func and RelabelType nodes to indicate whether they came from a function call, explicit cast, or implicit cast; use this to do reverse-listing more accurately and without so many heuristics. Explicit casts to char, varchar, bit, varbit will truncate or pad without raising an error (the pre-7.2 behavior), while assigning to a column without any explicit cast will still raise an error for wrong-length data like 7.3. This more nearly follows the SQL spec than 7.2 behavior (we should be reporting a 'completion condition' in the explicit-cast cases, but we have no mechanism for that, so just do silent truncation). Fix some problems with enforcement of typmod for array elements; it didn't work at all in 'UPDATE ... SET array[n] = foo', for example. Provide a generalized array_length_coerce() function to replace the specialized per-array-type functions that used to be needed (and were missing for NUMERIC as well as all the datetime types). Add missing conversions int8<->float4, text<->numeric, oid<->int8. initdb forced.
2002-09-18 23:35:25 +02:00
both built-in paths and those defined with <command>CREATE CAST</command>.
Add unique index on pg_cast.oid, and document pg_cast table.
2002-07-22 22:23:19 +02:00
</para>
<table>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structfield>pg_cast</> Columns</title>
Add unique index on pg_cast.oid, and document pg_cast table.
2002-07-22 22:23:19 +02:00
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>castsource</structfield></entry>
Add unique index on pg_cast.oid, and document pg_cast table.
2002-07-22 22:23:19 +02:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-type"><structname>pg_type</structname></link>.oid</literal></entry>
Add unique index on pg_cast.oid, and document pg_cast table.
2002-07-22 22:23:19 +02:00
<entry>OID of the source data type</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>casttarget</structfield></entry>
Add unique index on pg_cast.oid, and document pg_cast table.
2002-07-22 22:23:19 +02:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-type"><structname>pg_type</structname></link>.oid</literal></entry>
Add unique index on pg_cast.oid, and document pg_cast table.
2002-07-22 22:23:19 +02:00
<entry>OID of the target data type</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>castfunc</structfield></entry>
Add unique index on pg_cast.oid, and document pg_cast table.
2002-07-22 22:23:19 +02:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
Add unique index on pg_cast.oid, and document pg_cast table.
2002-07-22 22:23:19 +02:00
<entry>
Extend pg_cast castimplicit column to a three-way value; this allows us to be flexible about assignment casts without introducing ambiguity in operator/function resolution. Introduce a well-defined promotion hierarchy for numeric datatypes (int2->int4->int8->numeric->float4->float8). Change make_const to initially label numeric literals as int4, int8, or numeric (never float8 anymore). Explicitly mark Func and RelabelType nodes to indicate whether they came from a function call, explicit cast, or implicit cast; use this to do reverse-listing more accurately and without so many heuristics. Explicit casts to char, varchar, bit, varbit will truncate or pad without raising an error (the pre-7.2 behavior), while assigning to a column without any explicit cast will still raise an error for wrong-length data like 7.3. This more nearly follows the SQL spec than 7.2 behavior (we should be reporting a 'completion condition' in the explicit-cast cases, but we have no mechanism for that, so just do silent truncation). Fix some problems with enforcement of typmod for array elements; it didn't work at all in 'UPDATE ... SET array[n] = foo', for example. Provide a generalized array_length_coerce() function to replace the specialized per-array-type functions that used to be needed (and were missing for NUMERIC as well as all the datetime types). Add missing conversions int8<->float4, text<->numeric, oid<->int8. initdb forced.
2002-09-18 23:35:25 +02:00
The OID of the function to use to perform this cast. Zero is
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
stored if the data types are binary compatible (that is, no
Extend pg_cast castimplicit column to a three-way value; this allows us to be flexible about assignment casts without introducing ambiguity in operator/function resolution. Introduce a well-defined promotion hierarchy for numeric datatypes (int2->int4->int8->numeric->float4->float8). Change make_const to initially label numeric literals as int4, int8, or numeric (never float8 anymore). Explicitly mark Func and RelabelType nodes to indicate whether they came from a function call, explicit cast, or implicit cast; use this to do reverse-listing more accurately and without so many heuristics. Explicit casts to char, varchar, bit, varbit will truncate or pad without raising an error (the pre-7.2 behavior), while assigning to a column without any explicit cast will still raise an error for wrong-length data like 7.3. This more nearly follows the SQL spec than 7.2 behavior (we should be reporting a 'completion condition' in the explicit-cast cases, but we have no mechanism for that, so just do silent truncation). Fix some problems with enforcement of typmod for array elements; it didn't work at all in 'UPDATE ... SET array[n] = foo', for example. Provide a generalized array_length_coerce() function to replace the specialized per-array-type functions that used to be needed (and were missing for NUMERIC as well as all the datetime types). Add missing conversions int8<->float4, text<->numeric, oid<->int8. initdb forced.
2002-09-18 23:35:25 +02:00
run-time operation is needed to perform the cast).
Add unique index on pg_cast.oid, and document pg_cast table.
2002-07-22 22:23:19 +02:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>castcontext</structfield></entry>
Extend pg_cast castimplicit column to a three-way value; this allows us to be flexible about assignment casts without introducing ambiguity in operator/function resolution. Introduce a well-defined promotion hierarchy for numeric datatypes (int2->int4->int8->numeric->float4->float8). Change make_const to initially label numeric literals as int4, int8, or numeric (never float8 anymore). Explicitly mark Func and RelabelType nodes to indicate whether they came from a function call, explicit cast, or implicit cast; use this to do reverse-listing more accurately and without so many heuristics. Explicit casts to char, varchar, bit, varbit will truncate or pad without raising an error (the pre-7.2 behavior), while assigning to a column without any explicit cast will still raise an error for wrong-length data like 7.3. This more nearly follows the SQL spec than 7.2 behavior (we should be reporting a 'completion condition' in the explicit-cast cases, but we have no mechanism for that, so just do silent truncation). Fix some problems with enforcement of typmod for array elements; it didn't work at all in 'UPDATE ... SET array[n] = foo', for example. Provide a generalized array_length_coerce() function to replace the specialized per-array-type functions that used to be needed (and were missing for NUMERIC as well as all the datetime types). Add missing conversions int8<->float4, text<->numeric, oid<->int8. initdb forced.
2002-09-18 23:35:25 +02:00
<entry><type>char</type></entry>
Add unique index on pg_cast.oid, and document pg_cast table.
2002-07-22 22:23:19 +02:00
<entry></entry>
Extend pg_cast castimplicit column to a three-way value; this allows us to be flexible about assignment casts without introducing ambiguity in operator/function resolution. Introduce a well-defined promotion hierarchy for numeric datatypes (int2->int4->int8->numeric->float4->float8). Change make_const to initially label numeric literals as int4, int8, or numeric (never float8 anymore). Explicitly mark Func and RelabelType nodes to indicate whether they came from a function call, explicit cast, or implicit cast; use this to do reverse-listing more accurately and without so many heuristics. Explicit casts to char, varchar, bit, varbit will truncate or pad without raising an error (the pre-7.2 behavior), while assigning to a column without any explicit cast will still raise an error for wrong-length data like 7.3. This more nearly follows the SQL spec than 7.2 behavior (we should be reporting a 'completion condition' in the explicit-cast cases, but we have no mechanism for that, so just do silent truncation). Fix some problems with enforcement of typmod for array elements; it didn't work at all in 'UPDATE ... SET array[n] = foo', for example. Provide a generalized array_length_coerce() function to replace the specialized per-array-type functions that used to be needed (and were missing for NUMERIC as well as all the datetime types). Add missing conversions int8<->float4, text<->numeric, oid<->int8. initdb forced.
2002-09-18 23:35:25 +02:00
<entry>
Indicates what contexts the cast may be invoked in.
<literal>e</> means only as an explicit cast (using
Represent type-specific length coercion functions as pg_cast entries, eliminating the former hard-wired convention about their names. Allow pg_cast entries to represent both type coercion and length coercion in a single step --- this is represented by a function that takes an extra typmod argument, just like a length coercion function. This nicely merges the type and length coercion mechanisms into something at least a little cleaner than we had before. Make use of the single- coercion-step behavior to fix integer-to-bit coercion so that coercing to bit(n) yields the rightmost n bits of the integer instead of the leftmost n bits. This should fix recurrent complaints about the odd behavior of this coercion. Clean up the documentation of the bit string functions, and try to put it where people might actually find it. Also, get rid of the unreliable heuristics in ruleutils.c about whether to display nested coercion steps; instead require parse_coerce.c to label them properly in the first place.
2004-06-16 03:27:00 +02:00
<literal>CAST</> or <literal>::</> syntax).
Extend pg_cast castimplicit column to a three-way value; this allows us to be flexible about assignment casts without introducing ambiguity in operator/function resolution. Introduce a well-defined promotion hierarchy for numeric datatypes (int2->int4->int8->numeric->float4->float8). Change make_const to initially label numeric literals as int4, int8, or numeric (never float8 anymore). Explicitly mark Func and RelabelType nodes to indicate whether they came from a function call, explicit cast, or implicit cast; use this to do reverse-listing more accurately and without so many heuristics. Explicit casts to char, varchar, bit, varbit will truncate or pad without raising an error (the pre-7.2 behavior), while assigning to a column without any explicit cast will still raise an error for wrong-length data like 7.3. This more nearly follows the SQL spec than 7.2 behavior (we should be reporting a 'completion condition' in the explicit-cast cases, but we have no mechanism for that, so just do silent truncation). Fix some problems with enforcement of typmod for array elements; it didn't work at all in 'UPDATE ... SET array[n] = foo', for example. Provide a generalized array_length_coerce() function to replace the specialized per-array-type functions that used to be needed (and were missing for NUMERIC as well as all the datetime types). Add missing conversions int8<->float4, text<->numeric, oid<->int8. initdb forced.
2002-09-18 23:35:25 +02:00
<literal>a</> means implicitly in assignment
to a target column, as well as explicitly.
<literal>i</> means implicitly in expressions, as well as the
other cases.
</entry>
Add unique index on pg_cast.oid, and document pg_cast table.
2002-07-22 22:23:19 +02:00
</row>
</tbody>
</tgroup>
</table>
Represent type-specific length coercion functions as pg_cast entries, eliminating the former hard-wired convention about their names. Allow pg_cast entries to represent both type coercion and length coercion in a single step --- this is represented by a function that takes an extra typmod argument, just like a length coercion function. This nicely merges the type and length coercion mechanisms into something at least a little cleaner than we had before. Make use of the single- coercion-step behavior to fix integer-to-bit coercion so that coercing to bit(n) yields the rightmost n bits of the integer instead of the leftmost n bits. This should fix recurrent complaints about the odd behavior of this coercion. Clean up the documentation of the bit string functions, and try to put it where people might actually find it. Also, get rid of the unreliable heuristics in ruleutils.c about whether to display nested coercion steps; instead require parse_coerce.c to label them properly in the first place.
2004-06-16 03:27:00 +02:00
<para>
The cast functions listed in <structname>pg_cast</structname> must
always take the cast source type as their first argument type, and
return the cast destination type as their result type. A cast
function can have up to three arguments. The second argument,
if present, must be type <type>integer</>; it receives the type
modifier associated with the destination type, or <literal>-1</>
if there is none. The third argument,
if present, must be type <type>boolean</>; it receives <literal>true</>
if the cast is an explicit cast, <literal>false</> otherwise.
</para>
<para>
It is legitimate to create a <structname>pg_cast</structname> entry
in which the source and target types are the same, if the associated
function takes more than one argument. Such entries represent
<quote>length coercion functions</> that coerce values of the type
to be legal for a particular type modifier value. Note however that
at present there is no support for associating non-default type
modifiers with user-created data types, and so this facility is only
of use for the small number of built-in types that have type modifier
syntax built into the grammar.
</para>
<para>
When a <structname>pg_cast</structname> entry has different source and
target types and a function that takes more than one argument, it
represents converting from one type to another and applying a length
coercion in a single step. When no such entry is available, coercion
to a type that uses a type modifier involves two steps, one to
Spell checker run
2004-12-13 19:05:10 +01:00
convert between data types and a second to apply the modifier.
Represent type-specific length coercion functions as pg_cast entries, eliminating the former hard-wired convention about their names. Allow pg_cast entries to represent both type coercion and length coercion in a single step --- this is represented by a function that takes an extra typmod argument, just like a length coercion function. This nicely merges the type and length coercion mechanisms into something at least a little cleaner than we had before. Make use of the single- coercion-step behavior to fix integer-to-bit coercion so that coercing to bit(n) yields the rightmost n bits of the integer instead of the leftmost n bits. This should fix recurrent complaints about the odd behavior of this coercion. Clean up the documentation of the bit string functions, and try to put it where people might actually find it. Also, get rid of the unreliable heuristics in ruleutils.c about whether to display nested coercion steps; instead require parse_coerce.c to label them properly in the first place.
2004-06-16 03:27:00 +02:00
</para>
Add unique index on pg_cast.oid, and document pg_cast table.
2002-07-22 22:23:19 +02:00
</sect1>
Use <sect1> rather than <section> to simplify formatting.
2001-11-09 00:44:01 +01:00
<sect1 id="catalog-pg-class">
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_class</structname></title>
<indexterm zone="catalog-pg-class">
<primary>pg_class</primary>
</indexterm>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<para>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
The catalog <structname>pg_class</structname> catalogs tables and most
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
everything else that has columns or is otherwise similar to a
Make OIDs optional, per discussions in pghackers. WITH OIDS is still the default, but OIDS are removed from many system catalogs that don't need them. Some interesting side effects: TOAST pointers are 20 bytes not 32 now; pg_description has a three-column key instead of one. Bugs fixed in passing: BINARY cursors work again; pg_class.relhaspkey has some usefulness; pg_dump dumps comments on indexes, rules, and triggers in a valid order. initdb forced.
2001-08-10 20:57:42 +02:00
table. This includes indexes (but see also
Some preliminary documentation for composite-type stuff.
2004-06-07 06:04:47 +02:00
<structname>pg_index</structname>), sequences, views, composite types,
and some kinds of special relation; see <structfield>relkind</>.
Update some obsolete comments and column descriptions.
2002-09-24 23:26:44 +02:00
Below, when we mean all of these
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
kinds of objects we speak of <quote>relations</quote>. Not all
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
columns are meaningful for all relation types.
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</para>
<table>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_class</> Columns</title>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>relname</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>name</type></entry>
<entry></entry>
<entry>Name of the table, index, view, etc.</entry>
</row>
pg_class has a relnamespace column. You can create and access tables in schemas other than the system namespace; however, there's no search path yet, and not all operations work yet on tables outside the system namespace.
2002-03-26 20:17:02 +01:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>relnamespace</structfield></entry>
pg_class has a relnamespace column. You can create and access tables in schemas other than the system namespace; however, there's no search path yet, and not all operations work yet on tables outside the system namespace.
2002-03-26 20:17:02 +01:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-namespace"><structname>pg_namespace</structname></link>.oid</literal></entry>
pg_class has a relnamespace column. You can create and access tables in schemas other than the system namespace; however, there's no search path yet, and not all operations work yet on tables outside the system namespace.
2002-03-26 20:17:02 +01:00
<entry>
The OID of the namespace that contains this relation
</entry>
</row>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>reltype</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-type"><structname>pg_type</structname></link>.oid</literal></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>
Spell checker run
2004-12-13 19:05:10 +01:00
The OID of the data type that corresponds to this table's row type,
Some preliminary documentation for composite-type stuff.
2004-06-07 06:04:47 +02:00
if any (zero for indexes, which have no <structname>pg_type</> entry)
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>relowner</structfield></entry>
Replace pg_shadow and pg_group by new role-capable catalogs pg_authid and pg_auth_members. There are still many loose ends to finish in this patch (no documentation, no regression tests, no pg_dump support for instance). But I'm going to commit it now anyway so that Alvaro can make some progress on shared dependencies. The catalog changes should be pretty much done.
2005-06-28 07:09:14 +02:00
<entry><type>oid</type></entry>
<entry><literal><link linkend="catalog-pg-authid"><structname>pg_authid</structname></link>.oid</literal></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>Owner of the relation</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>relam</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-am"><structname>pg_am</structname></link>.oid</literal></entry>
Spell checking and markup additions
2002-03-22 20:20:45 +01:00
<entry>If this is an index, the access method used (B-tree, hash, etc.)</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>relfilenode</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>oid</type></entry>
<entry></entry>
Update info about relkind and pg_type entries for composite-types patch.
2002-08-28 17:02:55 +02:00
<entry>Name of the on-disk file of this relation; 0 if none</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
Tablespaces. Alternate database locations are dead, long live tablespaces. There are various things left to do: contrib dbsize and oid2name modules need work, and so does the documentation. Also someone should think about COMMENT ON TABLESPACE and maybe RENAME TABLESPACE. Also initlocation is dead, it just doesn't know it yet. Gavin Sherry and Tom Lane.
2004-06-18 08:14:31 +02:00
<row>
<entry><structfield>reltablespace</structfield></entry>
<entry><type>oid</type></entry>
<entry><literal><link linkend="catalog-pg-tablespace"><structname>pg_tablespace</structname></link>.oid</literal></entry>
<entry>
The tablespace in which this relation is stored. If zero,
the database's default tablespace is implied. (Not meaningful
if the relation has no on-disk file.)
</entry>
</row>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>relpages</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>int4</type></entry>
<entry></entry>
<entry>
Change planner to use the current true disk file size as its estimate of a relation's number of blocks, rather than the possibly-obsolete value in pg_class.relpages. Scale the value in pg_class.reltuples correspondingly to arrive at a hopefully more accurate number of rows. When pg_class contains 0/0, estimate a tuple width from the column datatypes and divide that into current file size to estimate number of rows. This improved methodology allows us to jettison the ancient hacks that put bogus default values into pg_class when a table is first created. Also, per a suggestion from Simon, make VACUUM (but not VACUUM FULL or ANALYZE) adjust the value it puts into pg_class.reltuples to try to represent the mean tuple density instead of the minimal density that actually prevails just after VACUUM. These changes alter the plans selected for certain regression tests, so update the expected files accordingly. (I removed join_1.out because it's not clear if it still applies; we can add back any variant versions as they are shown to be needed.)
2004-12-01 20:00:56 +01:00
Size of the on-disk representation of this table in pages (of size
Rewrite of planner statistics-gathering code. ANALYZE is now available as a separate statement (though it can still be invoked as part of VACUUM, too). pg_statistic redesigned to be more flexible about what statistics are stored. ANALYZE now collects a list of several of the most common values, not just one, plus a histogram (not just the min and max values). Random sampling is used to make the process reasonably fast even on very large tables. The number of values and histogram bins collected is now user-settable via an ALTER TABLE command. There is more still to do; the new stats are not being used everywhere they could be in the planner. But the remaining changes for this project should be localized, and the behavior is already better than before. A not-very-related change is that sorting now makes use of btree comparison routines if it can find one, rather than invoking '<' twice.
2001-05-07 02:43:27 +02:00
<symbol>BLCKSZ</symbol>).
This is only an estimate used by the planner.
It is updated by <command>VACUUM</command>,
Change planner to use the current true disk file size as its estimate of a relation's number of blocks, rather than the possibly-obsolete value in pg_class.relpages. Scale the value in pg_class.reltuples correspondingly to arrive at a hopefully more accurate number of rows. When pg_class contains 0/0, estimate a tuple width from the column datatypes and divide that into current file size to estimate number of rows. This improved methodology allows us to jettison the ancient hacks that put bogus default values into pg_class when a table is first created. Also, per a suggestion from Simon, make VACUUM (but not VACUUM FULL or ANALYZE) adjust the value it puts into pg_class.reltuples to try to represent the mean tuple density instead of the minimal density that actually prevails just after VACUUM. These changes alter the plans selected for certain regression tests, so update the expected files accordingly. (I removed join_1.out because it's not clear if it still applies; we can add back any variant versions as they are shown to be needed.)
2004-12-01 20:00:56 +01:00
<command>ANALYZE</command>, and a few DDL commands
such as <command>CREATE INDEX</command>.
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>reltuples</structfield></entry>
Rewrite of planner statistics-gathering code. ANALYZE is now available as a separate statement (though it can still be invoked as part of VACUUM, too). pg_statistic redesigned to be more flexible about what statistics are stored. ANALYZE now collects a list of several of the most common values, not just one, plus a histogram (not just the min and max values). Random sampling is used to make the process reasonably fast even on very large tables. The number of values and histogram bins collected is now user-settable via an ALTER TABLE command. There is more still to do; the new stats are not being used everywhere they could be in the planner. But the remaining changes for this project should be localized, and the behavior is already better than before. A not-very-related change is that sorting now makes use of btree comparison routines if it can find one, rather than invoking '<' twice.
2001-05-07 02:43:27 +02:00
<entry><type>float4</type></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry></entry>
<entry>
Spell checking, consistent terminology.
2003-11-01 02:56:29 +01:00
Number of rows in the table.
Rewrite of planner statistics-gathering code. ANALYZE is now available as a separate statement (though it can still be invoked as part of VACUUM, too). pg_statistic redesigned to be more flexible about what statistics are stored. ANALYZE now collects a list of several of the most common values, not just one, plus a histogram (not just the min and max values). Random sampling is used to make the process reasonably fast even on very large tables. The number of values and histogram bins collected is now user-settable via an ALTER TABLE command. There is more still to do; the new stats are not being used everywhere they could be in the planner. But the remaining changes for this project should be localized, and the behavior is already better than before. A not-very-related change is that sorting now makes use of btree comparison routines if it can find one, rather than invoking '<' twice.
2001-05-07 02:43:27 +02:00
This is only an estimate used by the planner.
It is updated by <command>VACUUM</command>,
Change planner to use the current true disk file size as its estimate of a relation's number of blocks, rather than the possibly-obsolete value in pg_class.relpages. Scale the value in pg_class.reltuples correspondingly to arrive at a hopefully more accurate number of rows. When pg_class contains 0/0, estimate a tuple width from the column datatypes and divide that into current file size to estimate number of rows. This improved methodology allows us to jettison the ancient hacks that put bogus default values into pg_class when a table is first created. Also, per a suggestion from Simon, make VACUUM (but not VACUUM FULL or ANALYZE) adjust the value it puts into pg_class.reltuples to try to represent the mean tuple density instead of the minimal density that actually prevails just after VACUUM. These changes alter the plans selected for certain regression tests, so update the expected files accordingly. (I removed join_1.out because it's not clear if it still applies; we can add back any variant versions as they are shown to be needed.)
2004-12-01 20:00:56 +01:00
<command>ANALYZE</command>, and a few DDL commands
such as <command>CREATE INDEX</command>.
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>reltoastrelid</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.oid</literal></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>
Spell checking and markup additions
2002-03-22 20:20:45 +01:00
OID of the TOAST table associated with this table, 0 if none.
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
The TOAST table stores large attributes <quote>out of
line</quote> in a secondary table.
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>reltoastidxid</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.oid</literal></entry>
Make OIDs optional, per discussions in pghackers. WITH OIDS is still the default, but OIDS are removed from many system catalogs that don't need them. Some interesting side effects: TOAST pointers are 20 bytes not 32 now; pg_description has a three-column key instead of one. Bugs fixed in passing: BINARY cursors work again; pg_class.relhaspkey has some usefulness; pg_dump dumps comments on indexes, rules, and triggers in a valid order. initdb forced.
2001-08-10 20:57:42 +02:00
<entry>
For a TOAST table, the OID of its index. 0 if not a TOAST table.
</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>relhasindex</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>bool</type></entry>
<entry></entry>
Improvement to CREATE TRIGGER and catalog documentation. Neil Conway
2002-12-17 18:41:30 +01:00
<entry>
True if this is a table and it has (or recently had) any
indexes. This is set by <command>CREATE INDEX</command>, but
not cleared immediately by <command>DROP INDEX</command>.
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<command>VACUUM</command> clears <structfield>relhasindex</> if it finds the
Improvement to CREATE TRIGGER and catalog documentation. Neil Conway
2002-12-17 18:41:30 +01:00
table has no indexes.
Make OIDs optional, per discussions in pghackers. WITH OIDS is still the default, but OIDS are removed from many system catalogs that don't need them. Some interesting side effects: TOAST pointers are 20 bytes not 32 now; pg_description has a three-column key instead of one. Bugs fixed in passing: BINARY cursors work again; pg_class.relhaspkey has some usefulness; pg_dump dumps comments on indexes, rules, and triggers in a valid order. initdb forced.
2001-08-10 20:57:42 +02:00
</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>relisshared</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>bool</type></entry>
<entry></entry>
Clean up various to-do items associated with system indexes: pg_database now has unique indexes on oid and on datname. pg_shadow now has unique indexes on usename and on usesysid. pg_am now has unique index on oid. pg_opclass now has unique index on oid. pg_amproc now has unique index on amid+amopclaid+amprocnum. Remove pg_rewrite's unnecessary index on oid, delete unused RULEOID syscache. Remove index on pg_listener and associated syscache for performance reasons (caching rows that are certain to change before you need 'em again is rather pointless). Change pg_attrdef's nonunique index on adrelid into a unique index on adrelid+adnum. Fix various incorrect settings of pg_class.relisshared, make that the primary reference point for whether a relation is shared or not. IsSharedSystemRelationName() is now only consulted to initialize relisshared during initial creation of tables and indexes. In theory we might now support shared user relations, though it's not clear how one would get entries for them into pg_class &etc of multiple databases. Fix recently reported bug that pg_attribute rows created for an index all have the same OID. (Proof that non-unique OID doesn't matter unless it's actually used to do lookups ;-)) There's no need to treat pg_trigger, pg_attrdef, pg_relcheck as bootstrap relations. Convert them into plain system catalogs without hardwired entries in pg_class and friends. Unify global.bki and template1.bki into a single init script postgres.bki, since the alleged distinction between them was misleading and pointless. Not to mention that it didn't work for setting up indexes on shared system relations. Rationalize locking of pg_shadow, pg_group, pg_attrdef (no need to use AccessExclusiveLock where ExclusiveLock or even RowExclusiveLock will do). Also, hold locks until transaction commit where necessary.
2001-06-12 07:55:50 +02:00
<entry>True if this table is shared across all databases in the
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
cluster. Only certain system catalogs (such as
<structname>pg_database</structname>) are shared.</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>relkind</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>char</type></entry>
<entry></entry>
<entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<literal>r</> = ordinary table, <literal>i</> = index,
<literal>S</> = sequence, <literal>v</> = view, <literal>c</> =
composite type, <literal>s</> = special, <literal>t</> = TOAST
table
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>relnatts</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>int2</type></entry>
<entry></entry>
<entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
Number of user columns in the relation (system columns not
counted). There must be this many corresponding entries in
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<structname>pg_attribute</structname>. See also
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<literal>pg_attribute.attnum</literal>.
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>relchecks</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>int2</type></entry>
<entry></entry>
<entry>
Number of check constraints on the table; see
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<structname>pg_constraint</structname> catalog
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>reltriggers</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>int2</type></entry>
<entry></entry>
<entry>
Number of triggers on the table; see
<structname>pg_trigger</structname> catalog
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>relukeys</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>int2</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>unused (<emphasis>not</emphasis> the number of unique keys)</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>relfkeys</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>int2</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>unused (<emphasis>not</emphasis> the number of foreign keys on the table)</entry>
Make OIDs optional, per discussions in pghackers. WITH OIDS is still the default, but OIDS are removed from many system catalogs that don't need them. Some interesting side effects: TOAST pointers are 20 bytes not 32 now; pg_description has a three-column key instead of one. Bugs fixed in passing: BINARY cursors work again; pg_class.relhaspkey has some usefulness; pg_dump dumps comments on indexes, rules, and triggers in a valid order. initdb forced.
2001-08-10 20:57:42 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>relrefs</structfield></entry>
Make OIDs optional, per discussions in pghackers. WITH OIDS is still the default, but OIDS are removed from many system catalogs that don't need them. Some interesting side effects: TOAST pointers are 20 bytes not 32 now; pg_description has a three-column key instead of one. Bugs fixed in passing: BINARY cursors work again; pg_class.relhaspkey has some usefulness; pg_dump dumps comments on indexes, rules, and triggers in a valid order. initdb forced.
2001-08-10 20:57:42 +02:00
<entry><type>int2</type></entry>
<entry></entry>
<entry>unused</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>relhasoids</structfield></entry>
Make OIDs optional, per discussions in pghackers. WITH OIDS is still the default, but OIDS are removed from many system catalogs that don't need them. Some interesting side effects: TOAST pointers are 20 bytes not 32 now; pg_description has a three-column key instead of one. Bugs fixed in passing: BINARY cursors work again; pg_class.relhaspkey has some usefulness; pg_dump dumps comments on indexes, rules, and triggers in a valid order. initdb forced.
2001-08-10 20:57:42 +02:00
<entry><type>bool</type></entry>
<entry></entry>
<entry>
True if we generate an OID for each row of the relation.
</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>relhaspkey</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>bool</type></entry>
<entry></entry>
<entry>
Make OIDs optional, per discussions in pghackers. WITH OIDS is still the default, but OIDS are removed from many system catalogs that don't need them. Some interesting side effects: TOAST pointers are 20 bytes not 32 now; pg_description has a three-column key instead of one. Bugs fixed in passing: BINARY cursors work again; pg_class.relhaspkey has some usefulness; pg_dump dumps comments on indexes, rules, and triggers in a valid order. initdb forced.
2001-08-10 20:57:42 +02:00
True if the table has (or once had) a primary key.
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>relhasrules</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>bool</type></entry>
<entry></entry>
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
<entry>True if table has rules; see
<structname>pg_rewrite</structname> catalog.
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>relhassubclass</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>bool</type></entry>
<entry></entry>
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
<entry>True if table has (or once had) any inheritance children.</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>relacl</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>aclitem[]</type></entry>
<entry></entry>
<entry>
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
Access privileges; see
<xref linkend="sql-grant" endterm="sql-grant-title"> and
<xref linkend="sql-revoke" endterm="sql-revoke-title">
for details.
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</entry>
</row>
</tbody>
</tgroup>
</table>
Use <sect1> rather than <section> to simplify formatting.
2001-11-09 00:44:01 +01:00
</sect1>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<sect1 id="catalog-pg-constraint">
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_constraint</structname></title>
<indexterm zone="catalog-pg-constraint">
<primary>pg_constraint</primary>
</indexterm>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<para>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
The catalog <structname>pg_constraint</structname> stores check, primary key, unique, and foreign
key constraints on tables. (Column constraints are not treated
specially. Every column constraint is equivalent to some table
constraint.) Not-null constraints are represented in the
<structname>pg_attribute</> catalog.
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
</para>
<para>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
Check constraints on domains are stored here, too.
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
</para>
<table>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_constraint</> Columns</title>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>conname</structfield></entry>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<entry><type>name</type></entry>
<entry></entry>
<entry>Constraint name (not necessarily unique!)</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>connamespace</structfield></entry>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-namespace"><structname>pg_namespace</structname></link>.oid</literal></entry>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<entry>
The OID of the namespace that contains this constraint
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>contype</structfield></entry>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<entry><type>char</type></entry>
<entry></entry>
<entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<literal>c</> = check constraint,
<literal>f</> = foreign key constraint,
<literal>p</> = primary key constraint,
<literal>u</> = unique constraint
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>condeferrable</structfield></entry>
<entry><type>bool</type></entry>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<entry></entry>
<entry>Is the constraint deferrable?</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>condeferred</structfield></entry>
<entry><type>bool</type></entry>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<entry></entry>
<entry>Is the constraint deferred by default?</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>conrelid</structfield></entry>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.oid</literal></entry>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<entry>The table this constraint is on; 0 if not a table constraint</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>contypid</structfield></entry>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-type"><structname>pg_type</structname></link>.oid</literal></entry>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<entry>The domain this constraint is on; 0 if not a domain constraint</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>confrelid</structfield></entry>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.oid</literal></entry>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<entry>If a foreign key, the referenced table; else 0</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>confupdtype</structfield></entry>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<entry><type>char</type></entry>
<entry></entry>
<entry>Foreign key update action code</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>confdeltype</structfield></entry>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<entry><type>char</type></entry>
<entry></entry>
<entry>Foreign key deletion action code</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>confmatchtype</structfield></entry>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<entry><type>char</type></entry>
<entry></entry>
<entry>Foreign key match type</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>conkey</structfield></entry>
Update some obsolete comments and column descriptions.
2002-09-24 23:26:44 +02:00
<entry><type>int2[]</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-attribute"><structname>pg_attribute</structname></link>.attnum</></entry>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<entry>If a table constraint, list of columns which the constraint constrains</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>confkey</structfield></entry>
Update some obsolete comments and column descriptions.
2002-09-24 23:26:44 +02:00
<entry><type>int2[]</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-attribute"><structname>pg_attribute</structname></link>.attnum</></entry>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<entry>If a foreign key, list of the referenced columns</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>conbin</structfield></entry>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<entry><type>text</type></entry>
<entry></entry>
<entry>If a check constraint, an internal representation of the expression</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>consrc</structfield></entry>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<entry><type>text</type></entry>
<entry></entry>
<entry>If a check constraint, a human-readable representation of the expression</entry>
</row>
</tbody>
</tgroup>
</table>
Add note deprecating use of consrc.
2003-10-17 02:55:17 +02:00
<note>
<para>
<structfield>consrc</structfield> is not updated when referenced objects
change; for example, it won't track renaming of columns. Rather than
relying on this field, it's best to use <function>pg_get_constraintdef()</>
to extract the definition of a check constraint.
</para>
</note>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<note>
<para>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<literal>pg_class.relchecks</literal> needs to agree with the
number of check-constraint entries found in this table for the
given relation.
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
</para>
</note>
</sect1>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
Add pg_conversion system catalog. Update description for multibyte support.
2002-07-24 07:51:56 +02:00
<sect1 id="catalog-pg-conversion">
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_conversion</structname></title>
<indexterm zone="catalog-pg-conversion">
<primary>pg_conversion</primary>
</indexterm>
Add pg_conversion system catalog. Update description for multibyte support.
2002-07-24 07:51:56 +02:00
<para>
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
The catalog <structname>pg_conversion</structname> describes the
available encoding conversion procedures. See
<xref linkend="sql-createconversion" endterm="sql-createconversion-title">
for more information.
Add pg_conversion system catalog. Update description for multibyte support.
2002-07-24 07:51:56 +02:00
</para>
<table>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_conversion</> Columns</title>
Add pg_conversion system catalog. Update description for multibyte support.
2002-07-24 07:51:56 +02:00
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>conname</structfield></entry>
Add pg_conversion system catalog. Update description for multibyte support.
2002-07-24 07:51:56 +02:00
<entry><type>name</type></entry>
<entry></entry>
<entry>Conversion name (unique within a namespace)</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>connamespace</structfield></entry>
Add pg_conversion system catalog. Update description for multibyte support.
2002-07-24 07:51:56 +02:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-namespace"><structname>pg_namespace</structname></link>.oid</literal></entry>
Add pg_conversion system catalog. Update description for multibyte support.
2002-07-24 07:51:56 +02:00
<entry>
The OID of the namespace that contains this conversion
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>conowner</structfield></entry>
Replace pg_shadow and pg_group by new role-capable catalogs pg_authid and pg_auth_members. There are still many loose ends to finish in this patch (no documentation, no regression tests, no pg_dump support for instance). But I'm going to commit it now anyway so that Alvaro can make some progress on shared dependencies. The catalog changes should be pretty much done.
2005-06-28 07:09:14 +02:00
<entry><type>oid</type></entry>
<entry><literal><link linkend="catalog-pg-authid"><structname>pg_authid</structname></link>.oid</literal></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>Owner of the conversion</entry>
Add pg_conversion system catalog. Update description for multibyte support.
2002-07-24 07:51:56 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>conforencoding</structfield></entry>
Add pg_conversion system catalog. Update description for multibyte support.
2002-07-24 07:51:56 +02:00
<entry><type>int4</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>Source encoding ID</entry>
Add pg_conversion system catalog. Update description for multibyte support.
2002-07-24 07:51:56 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>contoencoding</structfield></entry>
Add pg_conversion system catalog. Update description for multibyte support.
2002-07-24 07:51:56 +02:00
<entry><type>int4</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>Destination encoding ID</entry>
Add pg_conversion system catalog. Update description for multibyte support.
2002-07-24 07:51:56 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>conproc</structfield></entry>
Add pg_conversion system catalog. Update description for multibyte support.
2002-07-24 07:51:56 +02:00
<entry><type>regproc</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
Add pg_conversion system catalog. Update description for multibyte support.
2002-07-24 07:51:56 +02:00
<entry>Conversion procedure</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>condefault</structfield></entry>
<entry><type>bool</type></entry>
Add pg_conversion system catalog. Update description for multibyte support.
2002-07-24 07:51:56 +02:00
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>True if this is the default conversion</entry>
Add pg_conversion system catalog. Update description for multibyte support.
2002-07-24 07:51:56 +02:00
</row>
</tbody>
</tgroup>
</table>
</sect1>
Use <sect1> rather than <section> to simplify formatting.
2001-11-09 00:44:01 +01:00
<sect1 id="catalog-pg-database">
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_database</structname></title>
<indexterm zone="catalog-pg-database">
<primary>pg_database</primary>
</indexterm>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<para>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
The catalog <structname>pg_database</structname> stores information
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
about the available databases. Databases are created with the
Merge documentation into one book. (Build with "make html".) Replace vague cross-references with real links.
2003-03-25 17:15:44 +01:00
<command>CREATE DATABASE</command> command. Consult
<xref linkend="managing-databases"> for details about the meaning of some of the
This patch includes a lot of minor cleanups to the SGML documentation, including: - replacing all the appropriate usages of <citetitle>PostgreSQL ...</citetitle> with &cite-user;, &cite-admin;, and so on - fix an omission in the EXECUTE documentation - add some more text to the EXPLAIN documentation - improve the PL/PgSQL RETURN NEXT documentation (more work to do here) - minor markup fixes Neil Conway
2003-01-19 01:13:31 +01:00
parameters.
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</para>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<para>
Unlike most system catalogs, <structname>pg_database</structname>
is shared across all databases of a cluster: there is only one
copy of <structname>pg_database</structname> per cluster, not
one per database.
</para>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<table>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_database</> Columns</title>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>datname</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>name</type></entry>
<entry></entry>
<entry>Database name</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>datdba</structfield></entry>
Replace pg_shadow and pg_group by new role-capable catalogs pg_authid and pg_auth_members. There are still many loose ends to finish in this patch (no documentation, no regression tests, no pg_dump support for instance). But I'm going to commit it now anyway so that Alvaro can make some progress on shared dependencies. The catalog changes should be pretty much done.
2005-06-28 07:09:14 +02:00
<entry><type>oid</type></entry>
<entry><literal><link linkend="catalog-pg-authid"><structname>pg_authid</structname></link>.oid</literal></entry>
Update some obsolete comments and column descriptions.
2002-09-24 23:26:44 +02:00
<entry>Owner of the database, usually the user who created it</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>encoding</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>int4</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>Character encoding for this database</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>datistemplate</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>bool</type></entry>
<entry></entry>
<entry>
If true then this database can be used in the
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<literal>TEMPLATE</literal> clause of <command>CREATE
Restructure AclItem representation so that we can have more than eight different privilege bits (might as well make use of the space we were wasting on padding). EXECUTE and USAGE bits for procedures, languages now are separate privileges instead of being overlaid on SELECT. Add privileges for namespaces and databases. The GRANT and REVOKE commands work for these object types, but we don't actually enforce the privileges yet...
2002-04-21 02:26:44 +02:00
DATABASE</command> to create a new database as a clone of
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
this one.
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>datallowconn</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>bool</type></entry>
<entry></entry>
<entry>
If false then no one can connect to this database. This is
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
used to protect the <literal>template0</> database from being altered.
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>datlastsysoid</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>oid</type></entry>
<entry></entry>
<entry>
Transaction IDs wrap around, per my proposal of 13-Aug-01. More documentation to come, but the code is all here. initdb forced.
2001-08-26 18:56:03 +02:00
Last system OID in the database; useful
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
particularly to <application>pg_dump</application>
</entry>
</row>
Transaction IDs wrap around, per my proposal of 13-Aug-01. More documentation to come, but the code is all here. initdb forced.
2001-08-26 18:56:03 +02:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>datvacuumxid</structfield></entry>
Transaction IDs wrap around, per my proposal of 13-Aug-01. More documentation to come, but the code is all here. initdb forced.
2001-08-26 18:56:03 +02:00
<entry><type>xid</type></entry>
<entry></entry>
<entry>
Spell checking, consistent terminology.
2003-11-01 02:56:29 +01:00
All rows inserted or deleted by transaction IDs before this one
Transaction IDs wrap around, per my proposal of 13-Aug-01. More documentation to come, but the code is all here. initdb forced.
2001-08-26 18:56:03 +02:00
have been marked as known committed or known aborted in this database.
This is used to determine when commit-log space can be recycled.
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>datfrozenxid</structfield></entry>
Transaction IDs wrap around, per my proposal of 13-Aug-01. More documentation to come, but the code is all here. initdb forced.
2001-08-26 18:56:03 +02:00
<entry><type>xid</type></entry>
<entry></entry>
<entry>
Spell checking, consistent terminology.
2003-11-01 02:56:29 +01:00
All rows inserted by transaction IDs before this one have been
Transaction IDs wrap around, per my proposal of 13-Aug-01. More documentation to come, but the code is all here. initdb forced.
2001-08-26 18:56:03 +02:00
relabeled with a permanent (<quote>frozen</>) transaction ID in this
database. This is useful to check whether a database must be vacuumed
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
soon to avoid transaction ID wrap-around problems.
Transaction IDs wrap around, per my proposal of 13-Aug-01. More documentation to come, but the code is all here. initdb forced.
2001-08-26 18:56:03 +02:00
</entry>
</row>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<row>
Tablespaces. Alternate database locations are dead, long live tablespaces. There are various things left to do: contrib dbsize and oid2name modules need work, and so does the documentation. Also someone should think about COMMENT ON TABLESPACE and maybe RENAME TABLESPACE. Also initlocation is dead, it just doesn't know it yet. Gavin Sherry and Tom Lane.
2004-06-18 08:14:31 +02:00
<entry><structfield>dattablespace</structfield></entry>
<entry><type>oid</type></entry>
<entry><literal><link linkend="catalog-pg-tablespace"><structname>pg_tablespace</structname></link>.oid</literal></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>
Tablespaces. Alternate database locations are dead, long live tablespaces. There are various things left to do: contrib dbsize and oid2name modules need work, and so does the documentation. Also someone should think about COMMENT ON TABLESPACE and maybe RENAME TABLESPACE. Also initlocation is dead, it just doesn't know it yet. Gavin Sherry and Tom Lane.
2004-06-18 08:14:31 +02:00
The default tablespace for the database.
Within this database, all tables for which
<structname>pg_class</>.<structfield>reltablespace</> is zero
will be stored in this tablespace; in particular, all the non-shared
system catalogs will be there.
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</entry>
</row>
User and database-specific session defaults for run-time configuration variables. New commands ALTER DATABASE ... SET and ALTER USER ... SET.
2002-03-01 23:45:19 +01:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>datconfig</structfield></entry>
User and database-specific session defaults for run-time configuration variables. New commands ALTER DATABASE ... SET and ALTER USER ... SET.
2002-03-01 23:45:19 +01:00
<entry><type>text[]</type></entry>
<entry></entry>
<entry>Session defaults for run-time configuration variables</entry>
</row>
Restructure AclItem representation so that we can have more than eight different privilege bits (might as well make use of the space we were wasting on padding). EXECUTE and USAGE bits for procedures, languages now are separate privileges instead of being overlaid on SELECT. Add privileges for namespaces and databases. The GRANT and REVOKE commands work for these object types, but we don't actually enforce the privileges yet...
2002-04-21 02:26:44 +02:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>datacl</structfield></entry>
Restructure AclItem representation so that we can have more than eight different privilege bits (might as well make use of the space we were wasting on padding). EXECUTE and USAGE bits for procedures, languages now are separate privileges instead of being overlaid on SELECT. Add privileges for namespaces and databases. The GRANT and REVOKE commands work for these object types, but we don't actually enforce the privileges yet...
2002-04-21 02:26:44 +02:00
<entry><type>aclitem[]</type></entry>
<entry></entry>
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
<entry>
Access privileges; see
<xref linkend="sql-grant" endterm="sql-grant-title"> and
<xref linkend="sql-revoke" endterm="sql-revoke-title">
for details.
</entry>
Restructure AclItem representation so that we can have more than eight different privilege bits (might as well make use of the space we were wasting on padding). EXECUTE and USAGE bits for procedures, languages now are separate privileges instead of being overlaid on SELECT. Add privileges for namespaces and databases. The GRANT and REVOKE commands work for these object types, but we don't actually enforce the privileges yet...
2002-04-21 02:26:44 +02:00
</row>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</tbody>
</tgroup>
</table>
Use <sect1> rather than <section> to simplify formatting.
2001-11-09 00:44:01 +01:00
</sect1>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<sect1 id="catalog-pg-depend">
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_depend</structname></title>
<indexterm zone="catalog-pg-depend">
<primary>pg_depend</primary>
</indexterm>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<para>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
The catalog <structname>pg_depend</structname> records the dependency
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
relationships between database objects. This information allows
<command>DROP</> commands to find which other objects must be dropped
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
by <command>DROP CASCADE</> or prevent dropping in the <command>DROP
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
RESTRICT</> case.
</para>
Track dependencies on shared objects (which is to say, roles; we already have adequate mechanisms for tracking the contents of databases and tablespaces). This solves the longstanding problem that you can drop a user who still owns objects and/or has access permissions. Alvaro Herrera, with some kibitzing from Tom Lane.
2005-07-07 22:40:02 +02:00
<para>
See also <link linkend="catalog-pg-shdepend"><structname>pg_shdepend</structname></link>,
which performs a similar function for dependencies involving objects
that are shared across a database cluster.
</para>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<table>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_depend</> Columns</title>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>classid</structfield></entry>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.oid</literal></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>The OID of the system catalog the dependent object is in</entry>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>objid</structfield></entry>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<entry><type>oid</type></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>any OID column</entry>
<entry>The OID of the specific dependent object</entry>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>objsubid</structfield></entry>
Update some obsolete comments and column descriptions.
2002-09-24 23:26:44 +02:00
<entry><type>int4</type></entry>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>
For a table column, this is the column number (the
<structfield>objid</> and <structfield>classid</> refer to the
table itself). For all other object types, this column is
zero.
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>refclassid</structfield></entry>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<entry><type>oid</type></entry>
Update obsolete examples of error messages; various other minor editing.
2003-09-13 00:17:24 +02:00
<entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.oid</literal></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>The OID of the system catalog the referenced object is in</entry>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>refobjid</structfield></entry>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<entry><type>oid</type></entry>
Spell checking, consistent terminology.
2003-11-01 02:56:29 +01:00
<entry>any OID column</entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>The OID of the specific referenced object</entry>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>refobjsubid</structfield></entry>
Update some obsolete comments and column descriptions.
2002-09-24 23:26:44 +02:00
<entry><type>int4</type></entry>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>
For a table column, this is the column number (the
<structfield>refobjid</> and <structfield>refclassid</> refer
to the table itself). For all other object types, this column
is zero.
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>deptype</structfield></entry>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
<entry><type>char</type></entry>
<entry></entry>
<entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
A code defining the specific semantics of this dependency relationship; see text.
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
</entry>
</row>
</tbody>
</tgroup>
</table>
<para>
In all cases, a <structname>pg_depend</structname> entry indicates that the
referenced object may not be dropped without also dropping the dependent
object. However, there are several subflavors identified by
<structfield>deptype</>:
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<variablelist>
<varlistentry>
<term><symbol>DEPENDENCY_NORMAL</> (<literal>n</>)</term>
<listitem>
<para>
A normal relationship between separately-created objects. The
dependent object may be dropped without affecting the
referenced object. The referenced object may only be dropped
by specifying <literal>CASCADE</>, in which case the dependent
object is dropped, too. Example: a table column has a normal
dependency on its data type.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><symbol>DEPENDENCY_AUTO</> (<literal>a</>)</term>
<listitem>
<para>
The dependent object can be dropped separately from the
referenced object, and should be automatically dropped
(regardless of <literal>RESTRICT</> or <literal>CASCADE</>
mode) if the referenced object is dropped. Example: a named
constraint on a table is made autodependent on the table, so
that it will go away if the table is dropped.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><symbol>DEPENDENCY_INTERNAL</> (<literal>i</>)</term>
<listitem>
<para>
The dependent object was created as part of creation of the
referenced object, and is really just a part of its internal
implementation. A <command>DROP</> of the dependent object
will be disallowed outright (we'll tell the user to issue a
<command>DROP</> against the referenced object, instead). A
<command>DROP</> of the referenced object will be propagated
through to drop the dependent object whether
<command>CASCADE</> is specified or not. Example: a trigger
that's created to enforce a foreign-key constraint is made
internally dependent on the constraint's
<structname>pg_constraint</> entry.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><symbol>DEPENDENCY_PIN</> (<literal>p</>)</term>
<listitem>
<para>
There is no dependent object; this type of entry is a signal
that the system itself depends on the referenced object, and so
that object must never be deleted. Entries of this type are
created only by <command>initdb</command>. The columns for the
dependent object contain zeroes.
</para>
</listitem>
</varlistentry>
</variablelist>
Second phase of committing Rod Taylor's pg_depend/pg_constraint patch. pg_relcheck is gone; CHECK, UNIQUE, PRIMARY KEY, and FOREIGN KEY constraints all have real live entries in pg_constraint. pg_depend exists, and RESTRICT/CASCADE options work on most kinds of DROP; however, pg_depend is not yet very well populated with dependencies. (Most of the ones that are present at this point just replace formerly hardwired associations, such as the implicit drop of a relation's pg_type entry when the relation is dropped.) Need to add more logic to create dependency entries, improve pg_dump to dump constraints in place of indexes and triggers, and add some regression tests.
2002-07-12 20:43:19 +02:00
Other dependency flavors may be needed in future.
</para>
</sect1>
Use <sect1> rather than <section> to simplify formatting.
2001-11-09 00:44:01 +01:00
<sect1 id="catalog-pg-description">
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_description</structname></title>
<indexterm zone="catalog-pg-description">
<primary>pg_description</primary>
</indexterm>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<para>
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
The catalog <structname>pg_description</> stores optional descriptions
(comments) for each database object. Descriptions can be manipulated
Update some obsolete comments and column descriptions.
2002-09-24 23:26:44 +02:00
with the <command>COMMENT</command> command and viewed with
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<application>psql</application>'s <literal>\d</literal> commands.
Update some obsolete comments and column descriptions.
2002-09-24 23:26:44 +02:00
Descriptions of many built-in system objects are provided in the initial
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
contents of <structname>pg_description</structname>.
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</para>
<table>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_description</> Columns</title>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>objoid</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>oid</type></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>any OID column</entry>
<entry>The OID of the object this description pertains to</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
Make OIDs optional, per discussions in pghackers. WITH OIDS is still the default, but OIDS are removed from many system catalogs that don't need them. Some interesting side effects: TOAST pointers are 20 bytes not 32 now; pg_description has a three-column key instead of one. Bugs fixed in passing: BINARY cursors work again; pg_class.relhaspkey has some usefulness; pg_dump dumps comments on indexes, rules, and triggers in a valid order. initdb forced.
2001-08-10 20:57:42 +02:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>classoid</structfield></entry>
Make OIDs optional, per discussions in pghackers. WITH OIDS is still the default, but OIDS are removed from many system catalogs that don't need them. Some interesting side effects: TOAST pointers are 20 bytes not 32 now; pg_description has a three-column key instead of one. Bugs fixed in passing: BINARY cursors work again; pg_class.relhaspkey has some usefulness; pg_dump dumps comments on indexes, rules, and triggers in a valid order. initdb forced.
2001-08-10 20:57:42 +02:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.oid</literal></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>The OID of the system catalog this object appears in</entry>
Make OIDs optional, per discussions in pghackers. WITH OIDS is still the default, but OIDS are removed from many system catalogs that don't need them. Some interesting side effects: TOAST pointers are 20 bytes not 32 now; pg_description has a three-column key instead of one. Bugs fixed in passing: BINARY cursors work again; pg_class.relhaspkey has some usefulness; pg_dump dumps comments on indexes, rules, and triggers in a valid order. initdb forced.
2001-08-10 20:57:42 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>objsubid</structfield></entry>
Make OIDs optional, per discussions in pghackers. WITH OIDS is still the default, but OIDS are removed from many system catalogs that don't need them. Some interesting side effects: TOAST pointers are 20 bytes not 32 now; pg_description has a three-column key instead of one. Bugs fixed in passing: BINARY cursors work again; pg_class.relhaspkey has some usefulness; pg_dump dumps comments on indexes, rules, and triggers in a valid order. initdb forced.
2001-08-10 20:57:42 +02:00
<entry><type>int4</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>
For a comment on a table column, this is the column number (the
<structfield>objoid</> and <structfield>classoid</> refer to
the table itself). For all other object types, this column is
zero.
Make OIDs optional, per discussions in pghackers. WITH OIDS is still the default, but OIDS are removed from many system catalogs that don't need them. Some interesting side effects: TOAST pointers are 20 bytes not 32 now; pg_description has a three-column key instead of one. Bugs fixed in passing: BINARY cursors work again; pg_class.relhaspkey has some usefulness; pg_dump dumps comments on indexes, rules, and triggers in a valid order. initdb forced.
2001-08-10 20:57:42 +02:00
</entry>
</row>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>description</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>text</type></entry>
<entry></entry>
<entry>Arbitrary text that serves as the description of this object.</entry>
</row>
</tbody>
</tgroup>
</table>
Use <sect1> rather than <section> to simplify formatting.
2001-11-09 00:44:01 +01:00
</sect1>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
Use <sect1> rather than <section> to simplify formatting.
2001-11-09 00:44:01 +01:00
<sect1 id="catalog-pg-index">
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_index</structname></title>
<indexterm zone="catalog-pg-index">
<primary>pg_index</primary>
</indexterm>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<para>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
The catalog <structname>pg_index</structname> contains part of the information
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
about indexes. The rest is mostly in
<structname>pg_class</structname>.
</para>
<table>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_index</> Columns</title>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>indexrelid</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.oid</literal></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>The OID of the <structname>pg_class</> entry for this index</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>indrelid</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.oid</literal></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>The OID of the <structname>pg_class</> entry for the table this index is for</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
<row>
Replace functional-index facility with expressional indexes. Any column of an index can now be a computed expression instead of a simple variable. Restrictions on expressions are the same as for predicates (only immutable functions, no sub-selects). This fixes problems recently introduced with inlining SQL functions, because the inlining transformation is applied to both expression trees so the planner can still match them up. Along the way, improve efficiency of handling index predicates (both predicates and index expressions are now cached by the relcache) and fix 7.3 oversight that didn't record dependencies of predicate expressions.
2003-05-28 18:04:02 +02:00
<entry><structfield>indnatts</structfield></entry>
<entry><type>int2</type></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry></entry>
Replace functional-index facility with expressional indexes. Any column of an index can now be a computed expression instead of a simple variable. Restrictions on expressions are the same as for predicates (only immutable functions, no sub-selects). This fixes problems recently introduced with inlining SQL functions, because the inlining transformation is applied to both expression trees so the planner can still match them up. Along the way, improve efficiency of handling index predicates (both predicates and index expressions are now cached by the relcache) and fix 7.3 oversight that didn't record dependencies of predicate expressions.
2003-05-28 18:04:02 +02:00
<entry>The number of columns in the index (duplicates
<literal>pg_class.relnatts</literal>)</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>indisunique</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>bool</type></entry>
<entry></entry>
<entry>If true, this is a unique index.</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>indisprimary</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>bool</type></entry>
<entry></entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<entry>If true, this index represents the primary key of the table.
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
(<structfield>indisunique</> should always be true when this is true.)</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
<row>
Replace functional-index facility with expressional indexes. Any column of an index can now be a computed expression instead of a simple variable. Restrictions on expressions are the same as for predicates (only immutable functions, no sub-selects). This fixes problems recently introduced with inlining SQL functions, because the inlining transformation is applied to both expression trees so the planner can still match them up. Along the way, improve efficiency of handling index predicates (both predicates and index expressions are now cached by the relcache) and fix 7.3 oversight that didn't record dependencies of predicate expressions.
2003-05-28 18:04:02 +02:00
<entry><structfield>indisclustered</structfield></entry>
<entry><type>bool</type></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry></entry>
Replace functional-index facility with expressional indexes. Any column of an index can now be a computed expression instead of a simple variable. Restrictions on expressions are the same as for predicates (only immutable functions, no sub-selects). This fixes problems recently introduced with inlining SQL functions, because the inlining transformation is applied to both expression trees so the planner can still match them up. Along the way, improve efficiency of handling index predicates (both predicates and index expressions are now cached by the relcache) and fix 7.3 oversight that didn't record dependencies of predicate expressions.
2003-05-28 18:04:02 +02:00
<entry>If true, the table was last clustered on this index.</entry>
</row>
Convert oidvector and int2vector into variable-length arrays. This change saves a great deal of space in pg_proc and its primary index, and it eliminates the former requirement that INDEX_MAX_KEYS and FUNC_MAX_ARGS have the same value. INDEX_MAX_KEYS is still embedded in the on-disk representation (because it affects index tuple header size), but FUNC_MAX_ARGS is not. I believe it would now be possible to increase FUNC_MAX_ARGS at little cost, but haven't experimented yet. There are still a lot of vestigial references to FUNC_MAX_ARGS, which I will clean up in a separate pass. However, getting rid of it altogether would require changing the FunctionCallInfoData struct, and I'm not sure I want to buy into that.
2005-03-29 02:17:27 +02:00
<row>
<entry><structfield>indkey</structfield></entry>
<entry><type>int2vector</type></entry>
<entry><literal><link linkend="catalog-pg-attribute"><structname>pg_attribute</structname></link>.attnum</literal></entry>
<entry>
This is an array of <structfield>indnatts</structfield> values that
indicate which table columns this index indexes. For example a value
of <literal>1 3</literal> would mean that the first and the third table
columns make up the index key. A zero in this array indicates that the
corresponding index attribute is an expression over the table columns,
rather than a simple column reference.
</entry>
</row>
<row>
<entry><structfield>indclass</structfield></entry>
<entry><type>oidvector</type></entry>
<entry><literal><link linkend="catalog-pg-opclass"><structname>pg_opclass</structname></link>.oid</literal></entry>
<entry>
For each column in the index key this contains the OID of
the operator class to use. See
<structname>pg_opclass</structname> for details.
</entry>
</row>
Replace functional-index facility with expressional indexes. Any column of an index can now be a computed expression instead of a simple variable. Restrictions on expressions are the same as for predicates (only immutable functions, no sub-selects). This fixes problems recently introduced with inlining SQL functions, because the inlining transformation is applied to both expression trees so the planner can still match them up. Along the way, improve efficiency of handling index predicates (both predicates and index expressions are now cached by the relcache) and fix 7.3 oversight that didn't record dependencies of predicate expressions.
2003-05-28 18:04:02 +02:00
<row>
<entry><structfield>indexprs</structfield></entry>
<entry><type>text</type></entry>
<entry></entry>
<entry>Expression trees (in <function>nodeToString()</function> representation)
for index attributes that are not simple column references. This is a
list with one element for each zero entry in <structfield>indkey</>.
Null if all index attributes are simple references.</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>indpred</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>text</type></entry>
<entry></entry>
Replace functional-index facility with expressional indexes. Any column of an index can now be a computed expression instead of a simple variable. Restrictions on expressions are the same as for predicates (only immutable functions, no sub-selects). This fixes problems recently introduced with inlining SQL functions, because the inlining transformation is applied to both expression trees so the planner can still match them up. Along the way, improve efficiency of handling index predicates (both predicates and index expressions are now cached by the relcache) and fix 7.3 oversight that didn't record dependencies of predicate expressions.
2003-05-28 18:04:02 +02:00
<entry>Expression tree (in <function>nodeToString()</function> representation)
for partial index predicate. Null if not a partial index.</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
</tbody>
</tgroup>
</table>
Use <sect1> rather than <section> to simplify formatting.
2001-11-09 00:44:01 +01:00
</sect1>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
Use <sect1> rather than <section> to simplify formatting.
2001-11-09 00:44:01 +01:00
<sect1 id="catalog-pg-inherits">
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_inherits</structname></title>
<indexterm zone="catalog-pg-inherits">
<primary>pg_inherits</primary>
</indexterm>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<para>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
The catalog <structname>pg_inherits</> records information about
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
table inheritance hierarchies. There is one entry for each direct
child table in the database. (Indirect inheritance can be determined
by following chains of entries.)
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</para>
<table>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_inherits</> Columns</title>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>inhrelid</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.oid</literal></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>
Update some obsolete comments and column descriptions.
2002-09-24 23:26:44 +02:00
The OID of the child table.
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>inhparent</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.oid</literal></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>
Update some obsolete comments and column descriptions.
2002-09-24 23:26:44 +02:00
The OID of the parent table.
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>inhseqno</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>int4</type></entry>
<entry></entry>
<entry>
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
If there is more than one direct parent for a child table (multiple
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
inheritance), this number tells the order in which the
inherited columns are to be arranged. The count starts at 1.
</entry>
</row>
</tbody>
</tgroup>
</table>
Use <sect1> rather than <section> to simplify formatting.
2001-11-09 00:44:01 +01:00
</sect1>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
Use <sect1> rather than <section> to simplify formatting.
2001-11-09 00:44:01 +01:00
<sect1 id="catalog-pg-language">
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_language</structname></title>
<indexterm zone="catalog-pg-language">
<primary>pg_language</primary>
</indexterm>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<para>
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
The catalog <structname>pg_language</structname> registers
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
languages in which you can write functions or stored procedures.
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
See <xref linkend="sql-createlanguage" endterm="sql-createlanguage-title">
and <xref linkend="xplang"> for more information about language handlers.
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</para>
<table>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_language</> Columns</title>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>lanname</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>name</type></entry>
<entry></entry>
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
<entry>Name of the language</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>lanispl</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>bool</type></entry>
<entry></entry>
<entry>
Improvement to CREATE TRIGGER and catalog documentation. Neil Conway
2002-12-17 18:41:30 +01:00
This is false for internal languages (such as
<acronym>SQL</acronym>) and true for user-defined languages.
Currently, <application>pg_dump</application> still uses this
to determine which languages need to be dumped, but this may be
replaced by a different mechanism sometime.
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>lanpltrusted</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>bool</type></entry>
<entry></entry>
<entry>
Update misleading comment about the use of lanpltrusted ... it is significant regardless of the value of lanispl.
2005-05-06 16:28:53 +02:00
True if this is a trusted language, which means that it is believed
not to grant access to anything outside the normal SQL execution
environment. Only superusers may create functions in untrusted
languages.
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>lanplcallfoid</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
For noninternal languages this references the language
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
handler, which is a special function that is responsible for
executing all functions that are written in the particular
language.
</entry>
</row>
This patch updates the CREATE LANGUAGE & pg_language docs for the 7.3 table structure. Dave Page
2002-06-20 17:44:06 +02:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>lanvalidator</structfield></entry>
This patch updates the CREATE LANGUAGE & pg_language docs for the 7.3 table structure. Dave Page
2002-06-20 17:44:06 +02:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
This patch updates the CREATE LANGUAGE & pg_language docs for the 7.3 table structure. Dave Page
2002-06-20 17:44:06 +02:00
<entry>
This references a language validator function that is responsible
for checking the syntax and validity of new functions when they
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
are created. Zero if no validator is provided.
This patch updates the CREATE LANGUAGE & pg_language docs for the 7.3 table structure. Dave Page
2002-06-20 17:44:06 +02:00
</entry>
</row>
Privileges on functions and procedural languages
2002-02-19 00:11:58 +01:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>lanacl</structfield></entry>
Privileges on functions and procedural languages
2002-02-19 00:11:58 +01:00
<entry><type>aclitem[]</type></entry>
<entry></entry>
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
<entry>
Access privileges; see
<xref linkend="sql-grant" endterm="sql-grant-title"> and
<xref linkend="sql-revoke" endterm="sql-revoke-title">
for details.
</entry>
Privileges on functions and procedural languages
2002-02-19 00:11:58 +01:00
</row>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</tbody>
</tgroup>
</table>
Use <sect1> rather than <section> to simplify formatting.
2001-11-09 00:44:01 +01:00
</sect1>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
Use <sect1> rather than <section> to simplify formatting.
2001-11-09 00:44:01 +01:00
<sect1 id="catalog-pg-largeobject">
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_largeobject</structname></title>
<indexterm zone="catalog-pg-largeobject">
<primary>pg_largeobject</primary>
</indexterm>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<para>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
The catalog <structname>pg_largeobject</structname> holds the data making up
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<quote>large objects</quote>. A large object is identified by an
OID assigned when it is created. Each large object is broken into
segments or <quote>pages</> small enough to be conveniently stored as rows
in <structname>pg_largeobject</structname>.
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
The amount of data per page is defined to be <literal>LOBLKSIZE</> (which is currently
<literal>BLCKSZ/4</>, or typically 2 kB).
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
</para>
<table>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_largeobject</> Columns</title>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>loid</structfield></entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<entry><type>oid</type></entry>
<entry></entry>
<entry>Identifier of the large object that includes this page</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>pageno</structfield></entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<entry><type>int4</type></entry>
<entry></entry>
<entry>Page number of this page within its large object
(counting from zero)</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>data</structfield></entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<entry><type>bytea</type></entry>
<entry></entry>
<entry>
Actual data stored in the large object.
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
This will never be more than <symbol>LOBLKSIZE</> bytes and may be less.
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
</entry>
</row>
</tbody>
</tgroup>
</table>
<para>
Each row of <structname>pg_largeobject</structname> holds data
for one page of a large object, beginning at
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
byte offset (<literal>pageno * LOBLKSIZE</>) within the object. The implementation
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
allows sparse storage: pages may be missing, and may be shorter than
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<literal>LOBLKSIZE</> bytes even if they are not the last page of the object.
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
Missing regions within a large object read as zeroes.
</para>
Use <sect1> rather than <section> to simplify formatting.
2001-11-09 00:44:01 +01:00
</sect1>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
Use <sect1> rather than <section> to simplify formatting.
2001-11-09 00:44:01 +01:00
<sect1 id="catalog-pg-listener">
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_listener</structname></title>
<indexterm zone="catalog-pg-listener">
<primary>pg_listener</primary>
</indexterm>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<para>
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
The catalog <structname>pg_listener</structname> supports the
<xref linkend="sql-listen" endterm="sql-listen-title"> and
<xref linkend="sql-notify" endterm="sql-notify-title">
commands. A listener creates an entry in
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<structname>pg_listener</structname> for each notification name
it is listening for. A notifier scans <structname>pg_listener</structname>
and updates each matching entry to show that a notification has occurred.
The notifier also sends a signal (using the PID recorded in the table)
to awaken the listener from sleep.
</para>
<table>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_listener</> Columns</title>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>relname</structfield></entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<entry><type>name</type></entry>
<entry></entry>
<entry>Notify condition name. (The name need not match any actual
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
relation in the database; the name <structfield>relname</> is historical.)
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>listenerpid</structfield></entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<entry><type>int4</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>PID of the server process that created this entry.</entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>notification</structfield></entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<entry><type>int4</type></entry>
<entry></entry>
<entry>
Zero if no event is pending for this listener. If an event is
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
pending, the PID of the server process that sent the notification.
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
</entry>
</row>
</tbody>
</tgroup>
</table>
Use <sect1> rather than <section> to simplify formatting.
2001-11-09 00:44:01 +01:00
</sect1>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
Create the pg_namespace system catalog. Doesn't do much yet, but it's there and CREATE SCHEMA will make entries in it...
2002-03-22 22:34:44 +01:00
<sect1 id="catalog-pg-namespace">
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_namespace</structname></title>
<indexterm zone="catalog-pg-namespace">
<primary>pg_namespace</primary>
</indexterm>
Create the pg_namespace system catalog. Doesn't do much yet, but it's there and CREATE SCHEMA will make entries in it...
2002-03-22 22:34:44 +01:00
<para>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
The catalog <structname>pg_namespace</> stores namespaces.
A namespace is the structure underlying SQL schemas: each namespace
can have a separate collection of relations, types, etc. without name
Create the pg_namespace system catalog. Doesn't do much yet, but it's there and CREATE SCHEMA will make entries in it...
2002-03-22 22:34:44 +01:00
conflicts.
</para>
<table>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_namespace</> Columns</title>
Create the pg_namespace system catalog. Doesn't do much yet, but it's there and CREATE SCHEMA will make entries in it...
2002-03-22 22:34:44 +01:00
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>nspname</structfield></entry>
Create the pg_namespace system catalog. Doesn't do much yet, but it's there and CREATE SCHEMA will make entries in it...
2002-03-22 22:34:44 +01:00
<entry><type>name</type></entry>
<entry></entry>
<entry>Name of the namespace</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>nspowner</structfield></entry>
Replace pg_shadow and pg_group by new role-capable catalogs pg_authid and pg_auth_members. There are still many loose ends to finish in this patch (no documentation, no regression tests, no pg_dump support for instance). But I'm going to commit it now anyway so that Alvaro can make some progress on shared dependencies. The catalog changes should be pretty much done.
2005-06-28 07:09:14 +02:00
<entry><type>oid</type></entry>
<entry><literal><link linkend="catalog-pg-authid"><structname>pg_authid</structname></link>.oid</literal></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>Owner of the namespace</entry>
Create the pg_namespace system catalog. Doesn't do much yet, but it's there and CREATE SCHEMA will make entries in it...
2002-03-22 22:34:44 +01:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>nspacl</structfield></entry>
Create the pg_namespace system catalog. Doesn't do much yet, but it's there and CREATE SCHEMA will make entries in it...
2002-03-22 22:34:44 +01:00
<entry><type>aclitem[]</type></entry>
<entry></entry>
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
<entry>
Access privileges; see
<xref linkend="sql-grant" endterm="sql-grant-title"> and
<xref linkend="sql-revoke" endterm="sql-revoke-title">
for details.
</entry>
Create the pg_namespace system catalog. Doesn't do much yet, but it's there and CREATE SCHEMA will make entries in it...
2002-03-22 22:34:44 +01:00
</row>
</tbody>
</tgroup>
</table>
</sect1>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<sect1 id="catalog-pg-opclass">
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_opclass</structname></title>
<indexterm zone="catalog-pg-opclass">
<primary>pg_opclass</primary>
</indexterm>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<para>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
The catalog <structname>pg_opclass</structname> defines
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
index access method operator classes. Each operator class defines
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
semantics for index columns of a particular data type and a particular
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
index access method. Note that there can be multiple operator classes
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
for a given data type/access method combination, thus supporting multiple
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
behaviors.
</para>
<para>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
Operator classes are described at length in <xref linkend="xindex">.
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
</para>
<table>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_opclass</> Columns</title>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>opcamid</structfield></entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-am"><structname>pg_am</structname></link>.oid</literal></entry>
Spell checking, consistent terminology.
2003-11-01 02:56:29 +01:00
<entry>Index access method operator class is for</entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>opcname</structfield></entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<entry><type>name</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>Name of this operator class</entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>opcnamespace</structfield></entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-namespace"><structname>pg_namespace</structname></link>.oid</literal></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>Namespace of this operator class</entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>opcowner</structfield></entry>
Replace pg_shadow and pg_group by new role-capable catalogs pg_authid and pg_auth_members. There are still many loose ends to finish in this patch (no documentation, no regression tests, no pg_dump support for instance). But I'm going to commit it now anyway so that Alvaro can make some progress on shared dependencies. The catalog changes should be pretty much done.
2005-06-28 07:09:14 +02:00
<entry><type>oid</type></entry>
<entry><literal><link linkend="catalog-pg-authid"><structname>pg_authid</structname></link>.oid</literal></entry>
<entry>Owner of the operator class</entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>opcintype</structfield></entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-type"><structname>pg_type</structname></link>.oid</literal></entry>
Cross-data-type comparisons are now indexable by btrees, pursuant to my pghackers proposal of 8-Nov. All the existing cross-type comparison operators (int2/int4/int8 and float4/float8) have appropriate support. The original proposal of storing the right-hand-side datatype as part of the primary key for pg_amop and pg_amproc got modified a bit in the event; it is easier to store zero as the 'default' case and only store a nonzero when the operator is actually cross-type. Along the way, remove the long-since-defunct bigbox_ops operator class.
2003-11-12 22:15:59 +01:00
<entry>Data type that the operator class indexes</entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>opcdefault</structfield></entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<entry><type>bool</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>True if this operator class is the default for <structfield>opcintype</></entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>opckeytype</structfield></entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-type"><structname>pg_type</structname></link>.oid</literal></entry>
Cross-data-type comparisons are now indexable by btrees, pursuant to my pghackers proposal of 8-Nov. All the existing cross-type comparison operators (int2/int4/int8 and float4/float8) have appropriate support. The original proposal of storing the right-hand-side datatype as part of the primary key for pg_amop and pg_amproc got modified a bit in the event; it is easier to store zero as the 'default' case and only store a nonzero when the operator is actually cross-type. Along the way, remove the long-since-defunct bigbox_ops operator class.
2003-11-12 22:15:59 +01:00
<entry>Type of data stored in index, or zero if same as <structfield>opcintype</></entry>
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
</row>
</tbody>
</tgroup>
</table>
<para>
The majority of the information defining an operator class is actually
not in its <structname>pg_opclass</structname> row, but in the associated
rows in <structname>pg_amop</structname> and
<structname>pg_amproc</structname>. Those rows are considered to be
Replace "--" and "---" with "&mdash;" as appropriate, for better-looking output.
2004-11-15 07:32:15 +01:00
part of the operator class definition &mdash; this is not unlike the way
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
that a relation is defined by a single <structname>pg_class</structname>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
row plus associated rows in <structname>pg_attribute</structname> and
Rewrite xindex.sgml for CREATE OPERATOR CLASS. catalogs.sgml finally contains descriptions of every single system table. Update 'complex' tutorial example too.
2002-07-30 07:24:56 +02:00
other tables.
</para>
</sect1>
Use <sect1> rather than <section> to simplify formatting.
2001-11-09 00:44:01 +01:00
<sect1 id="catalog-pg-operator">
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_operator</structname></title>
<indexterm zone="catalog-pg-operator">
<primary>pg_operator</primary>
</indexterm>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<para>
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
The catalog <structname>pg_operator</> stores information about operators.
See <xref linkend="sql-createoperator" endterm="sql-createoperator-title">
and <xref linkend="xoper"> for more information.
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</para>
<table>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_operator</> Columns</title>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>oprname</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>name</type></entry>
<entry></entry>
<entry>Name of the operator</entry>
</row>
Operators live in namespaces. CREATE/DROP/COMMENT ON OPERATOR take qualified operator names directly, for example CREATE OPERATOR myschema.+ ( ... ). To qualify an operator name in an expression you need to write OPERATOR(myschema.+) (thanks to Peter for suggesting an escape hatch). I also took advantage of having to reformat pg_operator to fix something that'd been bugging me for a while: mergejoinable operators should have explicit links to the associated cross-data-type comparison operators, rather than hardwiring an assumption that they are named < and >.
2002-04-17 01:08:12 +02:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>oprnamespace</structfield></entry>
Operators live in namespaces. CREATE/DROP/COMMENT ON OPERATOR take qualified operator names directly, for example CREATE OPERATOR myschema.+ ( ... ). To qualify an operator name in an expression you need to write OPERATOR(myschema.+) (thanks to Peter for suggesting an escape hatch). I also took advantage of having to reformat pg_operator to fix something that'd been bugging me for a while: mergejoinable operators should have explicit links to the associated cross-data-type comparison operators, rather than hardwiring an assumption that they are named < and >.
2002-04-17 01:08:12 +02:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-namespace"><structname>pg_namespace</structname></link>.oid</literal></entry>
Operators live in namespaces. CREATE/DROP/COMMENT ON OPERATOR take qualified operator names directly, for example CREATE OPERATOR myschema.+ ( ... ). To qualify an operator name in an expression you need to write OPERATOR(myschema.+) (thanks to Peter for suggesting an escape hatch). I also took advantage of having to reformat pg_operator to fix something that'd been bugging me for a while: mergejoinable operators should have explicit links to the associated cross-data-type comparison operators, rather than hardwiring an assumption that they are named < and >.
2002-04-17 01:08:12 +02:00
<entry>
The OID of the namespace that contains this operator
</entry>
</row>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>oprowner</structfield></entry>
Replace pg_shadow and pg_group by new role-capable catalogs pg_authid and pg_auth_members. There are still many loose ends to finish in this patch (no documentation, no regression tests, no pg_dump support for instance). But I'm going to commit it now anyway so that Alvaro can make some progress on shared dependencies. The catalog changes should be pretty much done.
2005-06-28 07:09:14 +02:00
<entry><type>oid</type></entry>
<entry><literal><link linkend="catalog-pg-authid"><structname>pg_authid</structname></link>.oid</literal></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>Owner of the operator</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>oprkind</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>char</type></entry>
<entry></entry>
<entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<literal>b</> = infix (<quote>both</quote>), <literal>l</> = prefix
(<quote>left</quote>), <literal>r</> = postfix (<quote>right</quote>)
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>oprcanhash</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>bool</type></entry>
<entry></entry>
Revise hash join and hash aggregation code to use the same datatype- specific hash functions used by hash indexes, rather than the old not-datatype-aware ComputeHashFunc routine. This makes it safe to do hash joining on several datatypes that previously couldn't use hashing. The sets of datatypes that are hash indexable and hash joinable are now exactly the same, whereas before each had some that weren't in the other.
2003-06-23 00:04:55 +02:00
<entry>This operator supports hash joins</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>oprleft</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-type"><structname>pg_type</structname></link>.oid</literal></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>Type of the left operand</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>oprright</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-type"><structname>pg_type</structname></link>.oid</literal></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>Type of the right operand</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>oprresult</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-type"><structname>pg_type</structname></link>.oid</literal></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>Type of the result</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>oprcom</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-operator"><structname>pg_operator</structname></link>.oid</literal></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>Commutator of this operator, if any</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>oprnegate</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-operator"><structname>pg_operator</structname></link>.oid</literal></entry>
Change to Negator.
2000-12-11 19:26:37 +01:00
<entry>Negator of this operator, if any</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>oprlsortop</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-operator"><structname>pg_operator</structname></link>.oid</literal></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>
If this operator supports merge joins, the operator that sorts
Operators live in namespaces. CREATE/DROP/COMMENT ON OPERATOR take qualified operator names directly, for example CREATE OPERATOR myschema.+ ( ... ). To qualify an operator name in an expression you need to write OPERATOR(myschema.+) (thanks to Peter for suggesting an escape hatch). I also took advantage of having to reformat pg_operator to fix something that'd been bugging me for a while: mergejoinable operators should have explicit links to the associated cross-data-type comparison operators, rather than hardwiring an assumption that they are named < and >.
2002-04-17 01:08:12 +02:00
the type of the left-hand operand (<literal>L&lt;L</>)
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>oprrsortop</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-operator"><structname>pg_operator</structname></link>.oid</literal></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>
If this operator supports merge joins, the operator that sorts
Operators live in namespaces. CREATE/DROP/COMMENT ON OPERATOR take qualified operator names directly, for example CREATE OPERATOR myschema.+ ( ... ). To qualify an operator name in an expression you need to write OPERATOR(myschema.+) (thanks to Peter for suggesting an escape hatch). I also took advantage of having to reformat pg_operator to fix something that'd been bugging me for a while: mergejoinable operators should have explicit links to the associated cross-data-type comparison operators, rather than hardwiring an assumption that they are named < and >.
2002-04-17 01:08:12 +02:00
the type of the right-hand operand (<literal>R&lt;R</>)
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>oprltcmpop</structfield></entry>
Operators live in namespaces. CREATE/DROP/COMMENT ON OPERATOR take qualified operator names directly, for example CREATE OPERATOR myschema.+ ( ... ). To qualify an operator name in an expression you need to write OPERATOR(myschema.+) (thanks to Peter for suggesting an escape hatch). I also took advantage of having to reformat pg_operator to fix something that'd been bugging me for a while: mergejoinable operators should have explicit links to the associated cross-data-type comparison operators, rather than hardwiring an assumption that they are named < and >.
2002-04-17 01:08:12 +02:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-operator"><structname>pg_operator</structname></link>.oid</literal></entry>
Operators live in namespaces. CREATE/DROP/COMMENT ON OPERATOR take qualified operator names directly, for example CREATE OPERATOR myschema.+ ( ... ). To qualify an operator name in an expression you need to write OPERATOR(myschema.+) (thanks to Peter for suggesting an escape hatch). I also took advantage of having to reformat pg_operator to fix something that'd been bugging me for a while: mergejoinable operators should have explicit links to the associated cross-data-type comparison operators, rather than hardwiring an assumption that they are named < and >.
2002-04-17 01:08:12 +02:00
<entry>
If this operator supports merge joins, the less-than operator that
compares the left and right operand types (<literal>L&lt;R</>)
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>oprgtcmpop</structfield></entry>
Operators live in namespaces. CREATE/DROP/COMMENT ON OPERATOR take qualified operator names directly, for example CREATE OPERATOR myschema.+ ( ... ). To qualify an operator name in an expression you need to write OPERATOR(myschema.+) (thanks to Peter for suggesting an escape hatch). I also took advantage of having to reformat pg_operator to fix something that'd been bugging me for a while: mergejoinable operators should have explicit links to the associated cross-data-type comparison operators, rather than hardwiring an assumption that they are named < and >.
2002-04-17 01:08:12 +02:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-operator"><structname>pg_operator</structname></link>.oid</literal></entry>
Operators live in namespaces. CREATE/DROP/COMMENT ON OPERATOR take qualified operator names directly, for example CREATE OPERATOR myschema.+ ( ... ). To qualify an operator name in an expression you need to write OPERATOR(myschema.+) (thanks to Peter for suggesting an escape hatch). I also took advantage of having to reformat pg_operator to fix something that'd been bugging me for a while: mergejoinable operators should have explicit links to the associated cross-data-type comparison operators, rather than hardwiring an assumption that they are named < and >.
2002-04-17 01:08:12 +02:00
<entry>
If this operator supports merge joins, the greater-than operator that
compares the left and right operand types (<literal>L&gt;R</>)
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>oprcode</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>regproc</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>Function that implements this operator</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>oprrest</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>regproc</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>Restriction selectivity estimation function for this operator</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>oprjoin</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>regproc</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>Join selectivity estimation function for this operator</entry>
</row>
</tbody>
</tgroup>
</table>
Update some obsolete comments and column descriptions.
2002-09-24 23:26:44 +02:00
<para>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
Unused column contain zeroes, for example <structfield>oprleft</structfield> is zero for a
Update some obsolete comments and column descriptions.
2002-09-24 23:26:44 +02:00
prefix operator.
</para>
Use <sect1> rather than <section> to simplify formatting.
2001-11-09 00:44:01 +01:00
</sect1>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
Use <sect1> rather than <section> to simplify formatting.
2001-11-09 00:44:01 +01:00
<sect1 id="catalog-pg-proc">
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_proc</structname></title>
<indexterm zone="catalog-pg-proc">
<primary>pg_proc</primary>
</indexterm>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<para>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
The catalog <structname>pg_proc</> stores information about functions (or procedures).
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
See <xref linkend="sql-createfunction" endterm="sql-createfunction-title">
and <xref linkend="xfunc"> for more information.
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</para>
Restructure representation of aggregate functions so that they have pg_proc entries, per pghackers discussion. This fixes aggregates to live in namespaces, and also simplifies/speeds up lookup in parse_func.c. Also, add a 'proimplicit' flag to pg_proc that controls whether a type coercion function may be invoked implicitly, or only explicitly. The current settings of these flags are more permissive than I would like, but we will need to debate and refine the behavior; for now, I avoided breaking regression tests as much as I could.
2002-04-11 22:00:18 +02:00
<para>
The table contains data for aggregate functions as well as plain functions.
If <structfield>proisagg</structfield> is true, there should be a matching
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
row in <structfield>pg_aggregate</structfield>.
Restructure representation of aggregate functions so that they have pg_proc entries, per pghackers discussion. This fixes aggregates to live in namespaces, and also simplifies/speeds up lookup in parse_func.c. Also, add a 'proimplicit' flag to pg_proc that controls whether a type coercion function may be invoked implicitly, or only explicitly. The current settings of these flags are more permissive than I would like, but we will need to debate and refine the behavior; for now, I avoided breaking regression tests as much as I could.
2002-04-11 22:00:18 +02:00
</para>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<table>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_proc</> Columns</title>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>proname</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>name</type></entry>
<entry></entry>
<entry>Name of the function</entry>
</row>
Divide functions into three volatility classes (immutable, stable, and volatile), rather than the old cachable/noncachable distinction. This allows indexscan optimizations in many places where we formerly didn't. Also, add a pronamespace column to pg_proc (it doesn't do anything yet, however).
2002-04-05 02:31:36 +02:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>pronamespace</structfield></entry>
Divide functions into three volatility classes (immutable, stable, and volatile), rather than the old cachable/noncachable distinction. This allows indexscan optimizations in many places where we formerly didn't. Also, add a pronamespace column to pg_proc (it doesn't do anything yet, however).
2002-04-05 02:31:36 +02:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-namespace"><structname>pg_namespace</structname></link>.oid</literal></entry>
Divide functions into three volatility classes (immutable, stable, and volatile), rather than the old cachable/noncachable distinction. This allows indexscan optimizations in many places where we formerly didn't. Also, add a pronamespace column to pg_proc (it doesn't do anything yet, however).
2002-04-05 02:31:36 +02:00
<entry>
The OID of the namespace that contains this function
</entry>
</row>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>proowner</structfield></entry>
Replace pg_shadow and pg_group by new role-capable catalogs pg_authid and pg_auth_members. There are still many loose ends to finish in this patch (no documentation, no regression tests, no pg_dump support for instance). But I'm going to commit it now anyway so that Alvaro can make some progress on shared dependencies. The catalog changes should be pretty much done.
2005-06-28 07:09:14 +02:00
<entry><type>oid</type></entry>
<entry><literal><link linkend="catalog-pg-authid"><structname>pg_authid</structname></link>.oid</literal></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>Owner of the function</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>prolang</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>oid</type></entry>
Fix misspellings: langauge -> language.
2004-07-05 01:34:24 +02:00
<entry><literal><link linkend="catalog-pg-language"><structname>pg_language</structname></link>.oid</literal></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>Implementation language or call interface of this function</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>proisagg</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>bool</type></entry>
<entry></entry>
Restructure representation of aggregate functions so that they have pg_proc entries, per pghackers discussion. This fixes aggregates to live in namespaces, and also simplifies/speeds up lookup in parse_func.c. Also, add a 'proimplicit' flag to pg_proc that controls whether a type coercion function may be invoked implicitly, or only explicitly. The current settings of these flags are more permissive than I would like, but we will need to debate and refine the behavior; for now, I avoided breaking regression tests as much as I could.
2002-04-11 22:00:18 +02:00
<entry>Function is an aggregate function</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>prosecdef</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>bool</type></entry>
<entry></entry>
Update some obsolete comments and column descriptions.
2002-09-24 23:26:44 +02:00
<entry>Function is a security definer (i.e., a <quote>setuid</>
function)</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>proisstrict</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>bool</type></entry>
<entry></entry>
<entry>
Function returns null if any call argument is null. In that
case the function won't actually be called at all. Functions
that are not <quote>strict</quote> must be prepared to handle
null inputs.
</entry>
</row>
Restructure representation of aggregate functions so that they have pg_proc entries, per pghackers discussion. This fixes aggregates to live in namespaces, and also simplifies/speeds up lookup in parse_func.c. Also, add a 'proimplicit' flag to pg_proc that controls whether a type coercion function may be invoked implicitly, or only explicitly. The current settings of these flags are more permissive than I would like, but we will need to debate and refine the behavior; for now, I avoided breaking regression tests as much as I could.
2002-04-11 22:00:18 +02:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>proretset</structfield></entry>
Restructure representation of aggregate functions so that they have pg_proc entries, per pghackers discussion. This fixes aggregates to live in namespaces, and also simplifies/speeds up lookup in parse_func.c. Also, add a 'proimplicit' flag to pg_proc that controls whether a type coercion function may be invoked implicitly, or only explicitly. The current settings of these flags are more permissive than I would like, but we will need to debate and refine the behavior; for now, I avoided breaking regression tests as much as I could.
2002-04-11 22:00:18 +02:00
<entry><type>bool</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>Function returns a set (i.e., multiple values of the specified
Restructure representation of aggregate functions so that they have pg_proc entries, per pghackers discussion. This fixes aggregates to live in namespaces, and also simplifies/speeds up lookup in parse_func.c. Also, add a 'proimplicit' flag to pg_proc that controls whether a type coercion function may be invoked implicitly, or only explicitly. The current settings of these flags are more permissive than I would like, but we will need to debate and refine the behavior; for now, I avoided breaking regression tests as much as I could.
2002-04-11 22:00:18 +02:00
data type)</entry>
</row>
Divide functions into three volatility classes (immutable, stable, and volatile), rather than the old cachable/noncachable distinction. This allows indexscan optimizations in many places where we formerly didn't. Also, add a pronamespace column to pg_proc (it doesn't do anything yet, however).
2002-04-05 02:31:36 +02:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>provolatile</structfield></entry>
Divide functions into three volatility classes (immutable, stable, and volatile), rather than the old cachable/noncachable distinction. This allows indexscan optimizations in many places where we formerly didn't. Also, add a pronamespace column to pg_proc (it doesn't do anything yet, however).
2002-04-05 02:31:36 +02:00
<entry><type>char</type></entry>
<entry></entry>
<entry>
<structfield>provolatile</structfield> tells whether the function's
result depends only on its input arguments, or is affected by outside
factors.
It is <literal>i</literal> for <quote>immutable</> functions,
which always deliver the same result for the same inputs.
It is <literal>s</literal> for <quote>stable</> functions,
whose results (for fixed inputs) do not change within a scan.
It is <literal>v</literal> for <quote>volatile</> functions,
whose results may change at any time. (Use <literal>v</literal> also
for functions with side-effects, so that calls to them cannot get
optimized away.)
</entry>
</row>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>pronargs</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>int2</type></entry>
<entry></entry>
<entry>Number of arguments</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>prorettype</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-type"><structname>pg_type</structname></link>.oid</literal></entry>
Update some obsolete comments and column descriptions.
2002-09-24 23:26:44 +02:00
<entry>Data type of the return value</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>proargtypes</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>oidvector</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-type"><structname>pg_type</structname></link>.oid</literal></entry>
Add proallargtypes and proargmodes columns to pg_proc, as per my earlier proposal for OUT parameter support. The columns don't actually *do* anything yet, they are just left NULLs. But I thought I'd commit this part separately as a fairly pure example of the tasks needed when adding a column to pg_proc or one of the other core system tables.
2005-03-29 21:44:23 +02:00
<entry>
An array with the data types of the function arguments. This includes
only input arguments (including INOUT arguments), and thus represents
the call signature of the function.
</entry>
</row>
<row>
<entry><structfield>proallargtypes</structfield></entry>
<entry><type>oid[]</type></entry>
<entry><literal><link linkend="catalog-pg-type"><structname>pg_type</structname></link>.oid</literal></entry>
<entry>
An array with the data types of the function arguments. This includes
all arguments (including OUT and INOUT arguments); however, if all the
arguments are IN arguments, this field will be null.
Note that subscripting is 1-based, whereas for historical reasons
<structfield>proargtypes</> is subscripted from 0.
</entry>
</row>
<row>
<entry><structfield>proargmodes</structfield></entry>
Track dependencies on shared objects (which is to say, roles; we already have adequate mechanisms for tracking the contents of databases and tablespaces). This solves the longstanding problem that you can drop a user who still owns objects and/or has access permissions. Alvaro Herrera, with some kibitzing from Tom Lane.
2005-07-07 22:40:02 +02:00
<entry><type>char[]</type></entry>
Add proallargtypes and proargmodes columns to pg_proc, as per my earlier proposal for OUT parameter support. The columns don't actually *do* anything yet, they are just left NULLs. But I thought I'd commit this part separately as a fairly pure example of the tasks needed when adding a column to pg_proc or one of the other core system tables.
2005-03-29 21:44:23 +02:00
<entry></entry>
<entry>
An array with the modes of the function arguments, encoded as
<literal>i</literal> for IN arguments,
<literal>o</literal> for OUT arguments,
<literal>b</literal> for INOUT arguments.
If all the arguments are IN arguments, this field will be null.
Note that subscripts correspond to positions of
<structfield>proallargtypes</> not <structfield>proargtypes</>.
</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
Apply the core parts of Dennis Bjorklund's patch to allow function parameters to be declared with names. pg_proc has a column to store names, and CREATE FUNCTION can insert data into it, but that's all as yet. I need to do more work on the pg_dump and plpgsql portions of the patch before committing those, but I thought I'd get the bulky changes in before the tree drifts under me. initdb forced due to pg_proc change.
2004-01-07 00:55:19 +01:00
<row>
<entry><structfield>proargnames</structfield></entry>
<entry><type>text[]</type></entry>
<entry></entry>
<entry>
An array with the names of the function arguments.
Arguments without a name are set to empty strings in the array.
Add proallargtypes and proargmodes columns to pg_proc, as per my earlier proposal for OUT parameter support. The columns don't actually *do* anything yet, they are just left NULLs. But I thought I'd commit this part separately as a fairly pure example of the tasks needed when adding a column to pg_proc or one of the other core system tables.
2005-03-29 21:44:23 +02:00
If none of the arguments have a name, this field will be null.
Note that subscripts correspond to positions of
<structfield>proallargtypes</> not <structfield>proargtypes</>.
Apply the core parts of Dennis Bjorklund's patch to allow function parameters to be declared with names. pg_proc has a column to store names, and CREATE FUNCTION can insert data into it, but that's all as yet. I need to do more work on the pg_dump and plpgsql portions of the patch before committing those, but I thought I'd get the bulky changes in before the tree drifts under me. initdb forced due to pg_proc change.
2004-01-07 00:55:19 +01:00
</entry>
</row>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>prosrc</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>text</type></entry>
<entry></entry>
<entry>
This tells the function handler how to invoke the function. It
might be the actual source code of the function for interpreted
languages, a link symbol, a file name, or just about anything
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
else, depending on the implementation language/call convention.
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>probin</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>bytea</type></entry>
<entry></entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<entry>Additional information about how to invoke the function.
Again, the interpretation is language-specific.
</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
Privileges on functions and procedural languages
2002-02-19 00:11:58 +01:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>proacl</structfield></entry>
Privileges on functions and procedural languages
2002-02-19 00:11:58 +01:00
<entry><type>aclitem[]</type></entry>
<entry></entry>
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
<entry>
Access privileges; see
<xref linkend="sql-grant" endterm="sql-grant-title"> and
<xref linkend="sql-revoke" endterm="sql-revoke-title">
for details.
</entry>
Privileges on functions and procedural languages
2002-02-19 00:11:58 +01:00
</row>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</tbody>
</tgroup>
</table>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<para>
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
For compiled functions, both built-in and dynamically loaded,
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<structfield>prosrc</structfield> contains the function's C-language
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
name (link symbol). For all other currently-known language types,
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<structfield>prosrc</structfield> contains the function's source
text. <structfield>probin</structfield> is unused except for
dynamically-loaded C functions, for which it gives the name of the
shared library file containing the function.
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
</para>
Use <sect1> rather than <section> to simplify formatting.
2001-11-09 00:44:01 +01:00
</sect1>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
Use <sect1> rather than <section> to simplify formatting.
2001-11-09 00:44:01 +01:00
<sect1 id="catalog-pg-rewrite">
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_rewrite</structname></title>
<indexterm zone="catalog-pg-rewrite">
<primary>pg_rewrite</primary>
</indexterm>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<para>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
The catalog <structname>pg_rewrite</structname> stores rewrite rules for tables and views.
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
</para>
<table>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_rewrite</> Columns</title>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>rulename</structfield></entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<entry><type>name</type></entry>
<entry></entry>
<entry>Rule name</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>ev_class</structfield></entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.oid</literal></entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<entry>The table this rule is for</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>ev_attr</structfield></entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<entry><type>int2</type></entry>
<entry></entry>
<entry>The column this rule is for (currently, always zero to
indicate the whole table)</entry>
</row>
Update some obsolete comments and column descriptions.
2002-09-24 23:26:44 +02:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>ev_type</structfield></entry>
Update some obsolete comments and column descriptions.
2002-09-24 23:26:44 +02:00
<entry><type>char</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>
Event type that the rule is for: 1 = <command>SELECT</>, 2 =
<command>UPDATE</>, 3 = <command>INSERT</>, 4 =
<command>DELETE</>
</entry>
Update some obsolete comments and column descriptions.
2002-09-24 23:26:44 +02:00
</row>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>is_instead</structfield></entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<entry><type>bool</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>True if the rule is an <literal>INSTEAD</literal> rule</entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>ev_qual</structfield></entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<entry><type>text</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>
Expression tree (in the form of a
<function>nodeToString()</function> representation) for the
rule's qualifying condition
</entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>ev_action</structfield></entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<entry><type>text</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>
Query tree (in the form of a
<function>nodeToString()</function> representation) for the
rule's action
</entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
</row>
</tbody>
</tgroup>
</table>
<note>
<para>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<literal>pg_class.relhasrules</literal>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
must be true if a table has any rules in this catalog.
</para>
</note>
Use <sect1> rather than <section> to simplify formatting.
2001-11-09 00:44:01 +01:00
</sect1>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
Track dependencies on shared objects (which is to say, roles; we already have adequate mechanisms for tracking the contents of databases and tablespaces). This solves the longstanding problem that you can drop a user who still owns objects and/or has access permissions. Alvaro Herrera, with some kibitzing from Tom Lane.
2005-07-07 22:40:02 +02:00
<sect1 id="catalog-pg-shdepend">
<title><structname>pg_shdepend</structname></title>
<indexterm zone="catalog-pg-shdepend">
<primary>pg_shdepend</primary>
</indexterm>
<para>
The catalog <structname>pg_shdepend</structname> records the
dependency relationships between database objects and shared objects,
such as roles. This information allows
<productname>PostgreSQL</productname> to ensure that those objects are
unreferenced before attempting to delete them.
</para>
<para>
See also <link linkend="catalog-pg-depend"><structname>pg_depend</structname></link>,
which performs a similar function for dependencies involving objects
within a single database.
</para>
<para>
Unlike most system catalogs, <structname>pg_shdepend</structname>
is shared across all databases of a cluster: there is only one
copy of <structname>pg_shdepend</structname> per cluster, not
one per database.
</para>
<table>
<title><structname>pg_shdepend</> Columns</title>
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><structfield>dbid</structfield></entry>
<entry><type>oid</type></entry>
<entry><literal><link linkend="catalog-pg-database"><structname>pg_database</structname></link>.oid</literal></entry>
<entry>The OID of the database the dependent object is in,
or zero for a shared object</entry>
</row>
<row>
<entry><structfield>classid</structfield></entry>
<entry><type>oid</type></entry>
<entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.oid</literal></entry>
<entry>The OID of the system catalog the dependent object is in</entry>
</row>
<row>
<entry><structfield>objid</structfield></entry>
<entry><type>oid</type></entry>
<entry>any OID column</entry>
<entry>The OID of the specific dependent object</entry>
</row>
<row>
<entry><structfield>refclassid</structfield></entry>
<entry><type>oid</type></entry>
<entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.oid</literal></entry>
<entry>The OID of the system catalog the referenced object is in
(must be a shared catalog)</entry>
</row>
<row>
<entry><structfield>refobjid</structfield></entry>
<entry><type>oid</type></entry>
<entry>any OID column</entry>
<entry>The OID of the specific referenced object</entry>
</row>
<row>
<entry><structfield>deptype</structfield></entry>
<entry><type>char</type></entry>
<entry></entry>
<entry>
A code defining the specific semantics of this dependency relationship; see text.
</entry>
</row>
</tbody>
</tgroup>
</table>
<para>
In all cases, a <structname>pg_shdepend</structname> entry indicates that
the referenced object may not be dropped without also dropping the dependent
object. However, there are several subflavors identified by
<structfield>deptype</>:
<variablelist>
<varlistentry>
<term><symbol>SHARED_DEPENDENCY_OWNER</> (<literal>o</>)</term>
<listitem>
<para>
The referenced object (which must be a role) is the owner of the
dependent object.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><symbol>SHARED_DEPENDENCY_ACL</> (<literal>a</>)</term>
<listitem>
<para>
The referenced object (which must be a role) is mentioned in the
ACL (access control list, i.e., privileges list) of the
dependent object. (A <symbol>SHARED_DEPENDENCY_ACL</> entry is
not made for the owner of the object, since the owner will have
a <symbol>SHARED_DEPENDENCY_OWNER</> entry anyway.)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><symbol>SHARED_DEPENDENCY_PIN</> (<literal>p</>)</term>
<listitem>
<para>
There is no dependent object; this type of entry is a signal
that the system itself depends on the referenced object, and so
that object must never be deleted. Entries of this type are
created only by <command>initdb</command>. The columns for the
dependent object contain zeroes.
</para>
</listitem>
</varlistentry>
</variablelist>
Other dependency flavors may be needed in future. Note in particular
that the current definition only supports roles as referenced objects.
</para>
</sect1>
Replace pg_shadow and pg_group by new role-capable catalogs pg_authid and pg_auth_members. There are still many loose ends to finish in this patch (no documentation, no regression tests, no pg_dump support for instance). But I'm going to commit it now anyway so that Alvaro can make some progress on shared dependencies. The catalog changes should be pretty much done.
2005-06-28 07:09:14 +02:00
<sect1 id="catalog-pg-statistic">
<title><structname>pg_statistic</structname></title>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
Replace pg_shadow and pg_group by new role-capable catalogs pg_authid and pg_auth_members. There are still many loose ends to finish in this patch (no documentation, no regression tests, no pg_dump support for instance). But I'm going to commit it now anyway so that Alvaro can make some progress on shared dependencies. The catalog changes should be pretty much done.
2005-06-28 07:09:14 +02:00
<indexterm zone="catalog-pg-statistic">
<primary>pg_statistic</primary>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
</indexterm>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<para>
Replace pg_shadow and pg_group by new role-capable catalogs pg_authid and pg_auth_members. There are still many loose ends to finish in this patch (no documentation, no regression tests, no pg_dump support for instance). But I'm going to commit it now anyway so that Alvaro can make some progress on shared dependencies. The catalog changes should be pretty much done.
2005-06-28 07:09:14 +02:00
The catalog <structname>pg_statistic</structname> stores statistical data
about the contents of the database. Entries are created by
<command>ANALYZE</command> and subsequently used by the query planner.
There is one entry for each table column that has been analyzed.
Note that all the statistical data is inherently approximate,
even assuming that it is up-to-date.
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</para>
<para>
Replace pg_shadow and pg_group by new role-capable catalogs pg_authid and pg_auth_members. There are still many loose ends to finish in this patch (no documentation, no regression tests, no pg_dump support for instance). But I'm going to commit it now anyway so that Alvaro can make some progress on shared dependencies. The catalog changes should be pretty much done.
2005-06-28 07:09:14 +02:00
<structname>pg_statistic</structname> also stores statistical data about
the values of index expressions. These are described as if they were
actual data columns; in particular, <structfield>starelid</structfield>
references the index. No entry is made for an ordinary non-expression
index column, however, since it would be redundant with the entry
for the underlying table column.
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</para>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<para>
Replace pg_shadow and pg_group by new role-capable catalogs pg_authid and pg_auth_members. There are still many loose ends to finish in this patch (no documentation, no regression tests, no pg_dump support for instance). But I'm going to commit it now anyway so that Alvaro can make some progress on shared dependencies. The catalog changes should be pretty much done.
2005-06-28 07:09:14 +02:00
Since different kinds of statistics may be appropriate for different
kinds of data, <structname>pg_statistic</structname> is designed not
to assume very much about what sort of statistics it stores. Only
extremely general statistics (such as nullness) are given dedicated
columns in <structname>pg_statistic</structname>. Everything else
is stored in <quote>slots</quote>, which are groups of associated columns
whose content is identified by a code number in one of the slot's columns.
For more information see
<filename>src/include/catalog/pg_statistic.h</filename>.
Rewrite of planner statistics-gathering code. ANALYZE is now available as a separate statement (though it can still be invoked as part of VACUUM, too). pg_statistic redesigned to be more flexible about what statistics are stored. ANALYZE now collects a list of several of the most common values, not just one, plus a histogram (not just the min and max values). Random sampling is used to make the process reasonably fast even on very large tables. The number of values and histogram bins collected is now user-settable via an ALTER TABLE command. There is more still to do; the new stats are not being used everywhere they could be in the planner. But the remaining changes for this project should be localized, and the behavior is already better than before. A not-very-related change is that sorting now makes use of btree comparison routines if it can find one, rather than invoking '<' twice.
2001-05-07 02:43:27 +02:00
</para>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<para>
<structname>pg_statistic</structname> should not be readable by the
public, since even statistical information about a table's contents
may be considered sensitive. (Example: minimum and maximum values
of a salary column might be quite interesting.)
Document all the system views created by initdb (several of these were never documented anywhere, sigh). Centralize the detailed documentation of system views into catalogs.sgml, and provide cross-references.
2003-10-18 00:38:20 +02:00
<link linkend="view-pg-stats"><structname>pg_stats</structname></link>
is a publicly readable view on
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<structname>pg_statistic</structname> that only exposes information
about those tables that are readable by the current user.
</para>
Rewrite of planner statistics-gathering code. ANALYZE is now available as a separate statement (though it can still be invoked as part of VACUUM, too). pg_statistic redesigned to be more flexible about what statistics are stored. ANALYZE now collects a list of several of the most common values, not just one, plus a histogram (not just the min and max values). Random sampling is used to make the process reasonably fast even on very large tables. The number of values and histogram bins collected is now user-settable via an ALTER TABLE command. There is more still to do; the new stats are not being used everywhere they could be in the planner. But the remaining changes for this project should be localized, and the behavior is already better than before. A not-very-related change is that sorting now makes use of btree comparison routines if it can find one, rather than invoking '<' twice.
2001-05-07 02:43:27 +02:00
<table>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_statistic</> Columns</title>
Rewrite of planner statistics-gathering code. ANALYZE is now available as a separate statement (though it can still be invoked as part of VACUUM, too). pg_statistic redesigned to be more flexible about what statistics are stored. ANALYZE now collects a list of several of the most common values, not just one, plus a histogram (not just the min and max values). Random sampling is used to make the process reasonably fast even on very large tables. The number of values and histogram bins collected is now user-settable via an ALTER TABLE command. There is more still to do; the new stats are not being used everywhere they could be in the planner. But the remaining changes for this project should be localized, and the behavior is already better than before. A not-very-related change is that sorting now makes use of btree comparison routines if it can find one, rather than invoking '<' twice.
2001-05-07 02:43:27 +02:00
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>starelid</structfield></entry>
Rewrite of planner statistics-gathering code. ANALYZE is now available as a separate statement (though it can still be invoked as part of VACUUM, too). pg_statistic redesigned to be more flexible about what statistics are stored. ANALYZE now collects a list of several of the most common values, not just one, plus a histogram (not just the min and max values). Random sampling is used to make the process reasonably fast even on very large tables. The number of values and histogram bins collected is now user-settable via an ALTER TABLE command. There is more still to do; the new stats are not being used everywhere they could be in the planner. But the remaining changes for this project should be localized, and the behavior is already better than before. A not-very-related change is that sorting now makes use of btree comparison routines if it can find one, rather than invoking '<' twice.
2001-05-07 02:43:27 +02:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.oid</literal></entry>
First steps towards statistics on expressional (nee functional) indexes. This commit teaches ANALYZE to store such stats in pg_statistic, but nothing is done yet about teaching the planner to use 'em. Also, repair longstanding oversight in separate ANALYZE command: it updated the pg_class.relpages and reltuples counts for the table proper, but not for indexes.
2004-02-15 22:01:39 +01:00
<entry>The table or index that the described column belongs to</entry>
Rewrite of planner statistics-gathering code. ANALYZE is now available as a separate statement (though it can still be invoked as part of VACUUM, too). pg_statistic redesigned to be more flexible about what statistics are stored. ANALYZE now collects a list of several of the most common values, not just one, plus a histogram (not just the min and max values). Random sampling is used to make the process reasonably fast even on very large tables. The number of values and histogram bins collected is now user-settable via an ALTER TABLE command. There is more still to do; the new stats are not being used everywhere they could be in the planner. But the remaining changes for this project should be localized, and the behavior is already better than before. A not-very-related change is that sorting now makes use of btree comparison routines if it can find one, rather than invoking '<' twice.
2001-05-07 02:43:27 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>staattnum</structfield></entry>
Rewrite of planner statistics-gathering code. ANALYZE is now available as a separate statement (though it can still be invoked as part of VACUUM, too). pg_statistic redesigned to be more flexible about what statistics are stored. ANALYZE now collects a list of several of the most common values, not just one, plus a histogram (not just the min and max values). Random sampling is used to make the process reasonably fast even on very large tables. The number of values and histogram bins collected is now user-settable via an ALTER TABLE command. There is more still to do; the new stats are not being used everywhere they could be in the planner. But the remaining changes for this project should be localized, and the behavior is already better than before. A not-very-related change is that sorting now makes use of btree comparison routines if it can find one, rather than invoking '<' twice.
2001-05-07 02:43:27 +02:00
<entry><type>int2</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-attribute"><structname>pg_attribute</structname></link>.attnum</literal></entry>
Rewrite of planner statistics-gathering code. ANALYZE is now available as a separate statement (though it can still be invoked as part of VACUUM, too). pg_statistic redesigned to be more flexible about what statistics are stored. ANALYZE now collects a list of several of the most common values, not just one, plus a histogram (not just the min and max values). Random sampling is used to make the process reasonably fast even on very large tables. The number of values and histogram bins collected is now user-settable via an ALTER TABLE command. There is more still to do; the new stats are not being used everywhere they could be in the planner. But the remaining changes for this project should be localized, and the behavior is already better than before. A not-very-related change is that sorting now makes use of btree comparison routines if it can find one, rather than invoking '<' twice.
2001-05-07 02:43:27 +02:00
<entry>The number of the described column</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>stanullfrac</structfield></entry>
Rewrite of planner statistics-gathering code. ANALYZE is now available as a separate statement (though it can still be invoked as part of VACUUM, too). pg_statistic redesigned to be more flexible about what statistics are stored. ANALYZE now collects a list of several of the most common values, not just one, plus a histogram (not just the min and max values). Random sampling is used to make the process reasonably fast even on very large tables. The number of values and histogram bins collected is now user-settable via an ALTER TABLE command. There is more still to do; the new stats are not being used everywhere they could be in the planner. But the remaining changes for this project should be localized, and the behavior is already better than before. A not-very-related change is that sorting now makes use of btree comparison routines if it can find one, rather than invoking '<' twice.
2001-05-07 02:43:27 +02:00
<entry><type>float4</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>The fraction of the column's entries that are null</entry>
Rewrite of planner statistics-gathering code. ANALYZE is now available as a separate statement (though it can still be invoked as part of VACUUM, too). pg_statistic redesigned to be more flexible about what statistics are stored. ANALYZE now collects a list of several of the most common values, not just one, plus a histogram (not just the min and max values). Random sampling is used to make the process reasonably fast even on very large tables. The number of values and histogram bins collected is now user-settable via an ALTER TABLE command. There is more still to do; the new stats are not being used everywhere they could be in the planner. But the remaining changes for this project should be localized, and the behavior is already better than before. A not-very-related change is that sorting now makes use of btree comparison routines if it can find one, rather than invoking '<' twice.
2001-05-07 02:43:27 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>stawidth</structfield></entry>
Rewrite of planner statistics-gathering code. ANALYZE is now available as a separate statement (though it can still be invoked as part of VACUUM, too). pg_statistic redesigned to be more flexible about what statistics are stored. ANALYZE now collects a list of several of the most common values, not just one, plus a histogram (not just the min and max values). Random sampling is used to make the process reasonably fast even on very large tables. The number of values and histogram bins collected is now user-settable via an ALTER TABLE command. There is more still to do; the new stats are not being used everywhere they could be in the planner. But the remaining changes for this project should be localized, and the behavior is already better than before. A not-very-related change is that sorting now makes use of btree comparison routines if it can find one, rather than invoking '<' twice.
2001-05-07 02:43:27 +02:00
<entry><type>int4</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>The average stored width, in bytes, of nonnull entries</entry>
Rewrite of planner statistics-gathering code. ANALYZE is now available as a separate statement (though it can still be invoked as part of VACUUM, too). pg_statistic redesigned to be more flexible about what statistics are stored. ANALYZE now collects a list of several of the most common values, not just one, plus a histogram (not just the min and max values). Random sampling is used to make the process reasonably fast even on very large tables. The number of values and histogram bins collected is now user-settable via an ALTER TABLE command. There is more still to do; the new stats are not being used everywhere they could be in the planner. But the remaining changes for this project should be localized, and the behavior is already better than before. A not-very-related change is that sorting now makes use of btree comparison routines if it can find one, rather than invoking '<' twice.
2001-05-07 02:43:27 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>stadistinct</structfield></entry>
Rewrite of planner statistics-gathering code. ANALYZE is now available as a separate statement (though it can still be invoked as part of VACUUM, too). pg_statistic redesigned to be more flexible about what statistics are stored. ANALYZE now collects a list of several of the most common values, not just one, plus a histogram (not just the min and max values). Random sampling is used to make the process reasonably fast even on very large tables. The number of values and histogram bins collected is now user-settable via an ALTER TABLE command. There is more still to do; the new stats are not being used everywhere they could be in the planner. But the remaining changes for this project should be localized, and the behavior is already better than before. A not-very-related change is that sorting now makes use of btree comparison routines if it can find one, rather than invoking '<' twice.
2001-05-07 02:43:27 +02:00
<entry><type>float4</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>The number of distinct nonnull data values in the column.
Rewrite of planner statistics-gathering code. ANALYZE is now available as a separate statement (though it can still be invoked as part of VACUUM, too). pg_statistic redesigned to be more flexible about what statistics are stored. ANALYZE now collects a list of several of the most common values, not just one, plus a histogram (not just the min and max values). Random sampling is used to make the process reasonably fast even on very large tables. The number of values and histogram bins collected is now user-settable via an ALTER TABLE command. There is more still to do; the new stats are not being used everywhere they could be in the planner. But the remaining changes for this project should be localized, and the behavior is already better than before. A not-very-related change is that sorting now makes use of btree comparison routines if it can find one, rather than invoking '<' twice.
2001-05-07 02:43:27 +02:00
A value greater than zero is the actual number of distinct values.
A value less than zero is the negative of a fraction of the number
of rows in the table (for example, a column in which values appear about
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
twice on the average could be represented by <structfield>stadistinct</> = -0.5).
Rewrite of planner statistics-gathering code. ANALYZE is now available as a separate statement (though it can still be invoked as part of VACUUM, too). pg_statistic redesigned to be more flexible about what statistics are stored. ANALYZE now collects a list of several of the most common values, not just one, plus a histogram (not just the min and max values). Random sampling is used to make the process reasonably fast even on very large tables. The number of values and histogram bins collected is now user-settable via an ALTER TABLE command. There is more still to do; the new stats are not being used everywhere they could be in the planner. But the remaining changes for this project should be localized, and the behavior is already better than before. A not-very-related change is that sorting now makes use of btree comparison routines if it can find one, rather than invoking '<' twice.
2001-05-07 02:43:27 +02:00
A zero value means the number of distinct values is unknown.
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>stakind<replaceable>N</></structfield></entry>
Rewrite of planner statistics-gathering code. ANALYZE is now available as a separate statement (though it can still be invoked as part of VACUUM, too). pg_statistic redesigned to be more flexible about what statistics are stored. ANALYZE now collects a list of several of the most common values, not just one, plus a histogram (not just the min and max values). Random sampling is used to make the process reasonably fast even on very large tables. The number of values and histogram bins collected is now user-settable via an ALTER TABLE command. There is more still to do; the new stats are not being used everywhere they could be in the planner. But the remaining changes for this project should be localized, and the behavior is already better than before. A not-very-related change is that sorting now makes use of btree comparison routines if it can find one, rather than invoking '<' twice.
2001-05-07 02:43:27 +02:00
<entry><type>int2</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>
A code number indicating the kind of statistics stored in the
<replaceable>N</>th <quote>slot</quote> of the
<structname>pg_statistic</structname> row.
Rewrite of planner statistics-gathering code. ANALYZE is now available as a separate statement (though it can still be invoked as part of VACUUM, too). pg_statistic redesigned to be more flexible about what statistics are stored. ANALYZE now collects a list of several of the most common values, not just one, plus a histogram (not just the min and max values). Random sampling is used to make the process reasonably fast even on very large tables. The number of values and histogram bins collected is now user-settable via an ALTER TABLE command. There is more still to do; the new stats are not being used everywhere they could be in the planner. But the remaining changes for this project should be localized, and the behavior is already better than before. A not-very-related change is that sorting now makes use of btree comparison routines if it can find one, rather than invoking '<' twice.
2001-05-07 02:43:27 +02:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>staop<replaceable>N</></structfield></entry>
Rewrite of planner statistics-gathering code. ANALYZE is now available as a separate statement (though it can still be invoked as part of VACUUM, too). pg_statistic redesigned to be more flexible about what statistics are stored. ANALYZE now collects a list of several of the most common values, not just one, plus a histogram (not just the min and max values). Random sampling is used to make the process reasonably fast even on very large tables. The number of values and histogram bins collected is now user-settable via an ALTER TABLE command. There is more still to do; the new stats are not being used everywhere they could be in the planner. But the remaining changes for this project should be localized, and the behavior is already better than before. A not-very-related change is that sorting now makes use of btree comparison routines if it can find one, rather than invoking '<' twice.
2001-05-07 02:43:27 +02:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-operator"><structname>pg_operator</structname></link>.oid</literal></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>
An operator used to derive the statistics stored in the
<replaceable>N</>th <quote>slot</quote>. For example, a
histogram slot would show the <literal>&lt;</literal> operator
that defines the sort order of the data.
Rewrite of planner statistics-gathering code. ANALYZE is now available as a separate statement (though it can still be invoked as part of VACUUM, too). pg_statistic redesigned to be more flexible about what statistics are stored. ANALYZE now collects a list of several of the most common values, not just one, plus a histogram (not just the min and max values). Random sampling is used to make the process reasonably fast even on very large tables. The number of values and histogram bins collected is now user-settable via an ALTER TABLE command. There is more still to do; the new stats are not being used everywhere they could be in the planner. But the remaining changes for this project should be localized, and the behavior is already better than before. A not-very-related change is that sorting now makes use of btree comparison routines if it can find one, rather than invoking '<' twice.
2001-05-07 02:43:27 +02:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>stanumbers<replaceable>N</></structfield></entry>
Rewrite of planner statistics-gathering code. ANALYZE is now available as a separate statement (though it can still be invoked as part of VACUUM, too). pg_statistic redesigned to be more flexible about what statistics are stored. ANALYZE now collects a list of several of the most common values, not just one, plus a histogram (not just the min and max values). Random sampling is used to make the process reasonably fast even on very large tables. The number of values and histogram bins collected is now user-settable via an ALTER TABLE command. There is more still to do; the new stats are not being used everywhere they could be in the planner. But the remaining changes for this project should be localized, and the behavior is already better than before. A not-very-related change is that sorting now makes use of btree comparison routines if it can find one, rather than invoking '<' twice.
2001-05-07 02:43:27 +02:00
<entry><type>float4[]</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>
Numerical statistics of the appropriate kind for the
<replaceable>N</>th <quote>slot</quote>, or null if the slot
kind does not involve numerical values.
Rewrite of planner statistics-gathering code. ANALYZE is now available as a separate statement (though it can still be invoked as part of VACUUM, too). pg_statistic redesigned to be more flexible about what statistics are stored. ANALYZE now collects a list of several of the most common values, not just one, plus a histogram (not just the min and max values). Random sampling is used to make the process reasonably fast even on very large tables. The number of values and histogram bins collected is now user-settable via an ALTER TABLE command. There is more still to do; the new stats are not being used everywhere they could be in the planner. But the remaining changes for this project should be localized, and the behavior is already better than before. A not-very-related change is that sorting now makes use of btree comparison routines if it can find one, rather than invoking '<' twice.
2001-05-07 02:43:27 +02:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>stavalues<replaceable>N</></structfield></entry>
Instead of storing pg_statistic stavalues entries as text strings, store them as arrays of the internal datatype. This requires treating the stavalues columns as 'anyarray' rather than 'text[]', which is not 100% kosher but seems to work fine for the purposes we need for pg_statistic. Perhaps in the future 'anyarray' will be allowed more generally.
2003-03-23 06:14:37 +01:00
<entry><type>anyarray</type></entry>
Rewrite of planner statistics-gathering code. ANALYZE is now available as a separate statement (though it can still be invoked as part of VACUUM, too). pg_statistic redesigned to be more flexible about what statistics are stored. ANALYZE now collects a list of several of the most common values, not just one, plus a histogram (not just the min and max values). Random sampling is used to make the process reasonably fast even on very large tables. The number of values and histogram bins collected is now user-settable via an ALTER TABLE command. There is more still to do; the new stats are not being used everywhere they could be in the planner. But the remaining changes for this project should be localized, and the behavior is already better than before. A not-very-related change is that sorting now makes use of btree comparison routines if it can find one, rather than invoking '<' twice.
2001-05-07 02:43:27 +02:00
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>
Column data values of the appropriate kind for the
<replaceable>N</>th <quote>slot</quote>, or null if the slot
kind does not store any data values. Each array's element
values are actually of the specific column's data type, so there
is no way to define these columns' type more specifically than
<type>anyarray</>.
Rewrite of planner statistics-gathering code. ANALYZE is now available as a separate statement (though it can still be invoked as part of VACUUM, too). pg_statistic redesigned to be more flexible about what statistics are stored. ANALYZE now collects a list of several of the most common values, not just one, plus a histogram (not just the min and max values). Random sampling is used to make the process reasonably fast even on very large tables. The number of values and histogram bins collected is now user-settable via an ALTER TABLE command. There is more still to do; the new stats are not being used everywhere they could be in the planner. But the remaining changes for this project should be localized, and the behavior is already better than before. A not-very-related change is that sorting now makes use of btree comparison routines if it can find one, rather than invoking '<' twice.
2001-05-07 02:43:27 +02:00
</entry>
</row>
</tbody>
</tgroup>
</table>
Use <sect1> rather than <section> to simplify formatting.
2001-11-09 00:44:01 +01:00
</sect1>
Rewrite of planner statistics-gathering code. ANALYZE is now available as a separate statement (though it can still be invoked as part of VACUUM, too). pg_statistic redesigned to be more flexible about what statistics are stored. ANALYZE now collects a list of several of the most common values, not just one, plus a histogram (not just the min and max values). Random sampling is used to make the process reasonably fast even on very large tables. The number of values and histogram bins collected is now user-settable via an ALTER TABLE command. There is more still to do; the new stats are not being used everywhere they could be in the planner. But the remaining changes for this project should be localized, and the behavior is already better than before. A not-very-related change is that sorting now makes use of btree comparison routines if it can find one, rather than invoking '<' twice.
2001-05-07 02:43:27 +02:00
Tablespaces. Alternate database locations are dead, long live tablespaces. There are various things left to do: contrib dbsize and oid2name modules need work, and so does the documentation. Also someone should think about COMMENT ON TABLESPACE and maybe RENAME TABLESPACE. Also initlocation is dead, it just doesn't know it yet. Gavin Sherry and Tom Lane.
2004-06-18 08:14:31 +02:00
<sect1 id="catalog-pg-tablespace">
<title><structname>pg_tablespace</structname></title>
<indexterm zone="catalog-pg-tablespace">
<primary>pg_tablespace</primary>
</indexterm>
<para>
The catalog <structname>pg_tablespace</structname> stores information
about the available tablespaces. Tables can be placed in particular
tablespaces to aid administration of disk layout.
</para>
<para>
Unlike most system catalogs, <structname>pg_tablespace</structname>
is shared across all databases of a cluster: there is only one
copy of <structname>pg_tablespace</structname> per cluster, not
one per database.
</para>
<table>
<title><structname>pg_tablespace</> Columns</title>
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><structfield>spcname</structfield></entry>
<entry><type>name</type></entry>
<entry></entry>
<entry>Tablespace name</entry>
</row>
<row>
<entry><structfield>spcowner</structfield></entry>
Replace pg_shadow and pg_group by new role-capable catalogs pg_authid and pg_auth_members. There are still many loose ends to finish in this patch (no documentation, no regression tests, no pg_dump support for instance). But I'm going to commit it now anyway so that Alvaro can make some progress on shared dependencies. The catalog changes should be pretty much done.
2005-06-28 07:09:14 +02:00
<entry><type>oid</type></entry>
<entry><literal><link linkend="catalog-pg-authid"><structname>pg_authid</structname></link>.oid</literal></entry>
Tablespaces. Alternate database locations are dead, long live tablespaces. There are various things left to do: contrib dbsize and oid2name modules need work, and so does the documentation. Also someone should think about COMMENT ON TABLESPACE and maybe RENAME TABLESPACE. Also initlocation is dead, it just doesn't know it yet. Gavin Sherry and Tom Lane.
2004-06-18 08:14:31 +02:00
<entry>Owner of the tablespace, usually the user who created it</entry>
</row>
<row>
<entry><structfield>spclocation</structfield></entry>
<entry><type>text</type></entry>
<entry></entry>
<entry>Location (directory path) of the tablespace</entry>
</row>
<row>
<entry><structfield>spcacl</structfield></entry>
<entry><type>aclitem[]</type></entry>
<entry></entry>
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
<entry>
Access privileges; see
<xref linkend="sql-grant" endterm="sql-grant-title"> and
<xref linkend="sql-revoke" endterm="sql-revoke-title">
for details.
</entry>
Tablespaces. Alternate database locations are dead, long live tablespaces. There are various things left to do: contrib dbsize and oid2name modules need work, and so does the documentation. Also someone should think about COMMENT ON TABLESPACE and maybe RENAME TABLESPACE. Also initlocation is dead, it just doesn't know it yet. Gavin Sherry and Tom Lane.
2004-06-18 08:14:31 +02:00
</row>
</tbody>
</tgroup>
</table>
</sect1>
Use <sect1> rather than <section> to simplify formatting.
2001-11-09 00:44:01 +01:00
<sect1 id="catalog-pg-trigger">
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_trigger</structname></title>
<indexterm zone="catalog-pg-trigger">
<primary>pg_trigger</primary>
</indexterm>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<para>
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
The catalog <structname>pg_trigger</structname> stores triggers on tables.
See <xref linkend="sql-createtrigger" endterm="sql-createtrigger-title">
for more information.
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
</para>
<table>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_trigger</> Columns</title>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>tgrelid</structfield></entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.oid</literal></entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<entry>The table this trigger is on</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>tgname</structfield></entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<entry><type>name</type></entry>
<entry></entry>
Update some obsolete comments and column descriptions.
2002-09-24 23:26:44 +02:00
<entry>Trigger name (must be unique among triggers of same table)</entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>tgfoid</structfield></entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<entry>The function to be called</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>tgtype</structfield></entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<entry><type>int2</type></entry>
<entry></entry>
Spell checking, consistent terminology.
2003-11-01 02:56:29 +01:00
<entry>Bit mask identifying trigger conditions</entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>tgenabled</structfield></entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<entry><type>bool</type></entry>
<entry></entry>
<entry>True if trigger is enabled (not presently checked everywhere
it should be, so disabling a trigger by setting this false does not
work reliably)</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>tgisconstraint</structfield></entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<entry><type>bool</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>True if trigger implements a referential integrity constraint</entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>tgconstrname</structfield></entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<entry><type>name</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>Referential integrity constraint name</entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>tgconstrrelid</structfield></entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.oid</literal></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>The table referenced by an referential integrity constraint</entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>tgdeferrable</structfield></entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<entry><type>bool</type></entry>
<entry></entry>
<entry>True if deferrable</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>tginitdeferred</structfield></entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<entry><type>bool</type></entry>
<entry></entry>
<entry>True if initially deferred</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>tgnargs</structfield></entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<entry><type>int2</type></entry>
<entry></entry>
<entry>Number of argument strings passed to trigger function</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>tgattr</structfield></entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<entry><type>int2vector</type></entry>
<entry></entry>
<entry>Currently unused</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>tgargs</structfield></entry>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<entry><type>bytea</type></entry>
<entry></entry>
<entry>Argument strings to pass to trigger, each null-terminated</entry>
</row>
</tbody>
</tgroup>
</table>
<note>
<para>
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
<literal>pg_class.reltriggers</literal> needs to agree with the
number of triggers found in this table for the given relation.
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
</para>
</note>
Use <sect1> rather than <section> to simplify formatting.
2001-11-09 00:44:01 +01:00
</sect1>
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
Use <sect1> rather than <section> to simplify formatting.
2001-11-09 00:44:01 +01:00
<sect1 id="catalog-pg-type">
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_type</structname></title>
<indexterm zone="catalog-pg-type">
<primary>pg_type</primary>
</indexterm>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
<para>
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
The catalog <structname>pg_type</structname> stores information about data
types. Base types (scalar types) are created with
<xref linkend="sql-createtype" endterm="sql-createtype-title">, and
domains with
<xref linkend="sql-createdomain" endterm="sql-createdomain-title">.
Reinstate pg_type's typsend and typreceive columns. They don't do much yet, but they're there. Also some editorial work on CREATE TYPE reference page.
2003-05-09 00:19:58 +02:00
A composite type is automatically created for each table in the database, to
Code review for DOMAIN patch.
2002-03-20 20:45:13 +01:00
represent the row structure of the table. It is also possible to create
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
composite types with <command>CREATE TYPE AS</command>.
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
</para>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<table>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<title><structname>pg_type</> Columns</title>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>typname</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>name</type></entry>
<entry></entry>
<entry>Data type name</entry>
</row>
pg_type has a typnamespace column; system now supports creating types in different namespaces. Also, cleanup work on relation namespace support: drop, alter, rename commands work for tables in non-default namespaces.
2002-03-29 20:06:29 +01:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>typnamespace</structfield></entry>
pg_type has a typnamespace column; system now supports creating types in different namespaces. Also, cleanup work on relation namespace support: drop, alter, rename commands work for tables in non-default namespaces.
2002-03-29 20:06:29 +01:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-namespace"><structname>pg_namespace</structname></link>.oid</literal></entry>
pg_type has a typnamespace column; system now supports creating types in different namespaces. Also, cleanup work on relation namespace support: drop, alter, rename commands work for tables in non-default namespaces.
2002-03-29 20:06:29 +01:00
<entry>
The OID of the namespace that contains this type
</entry>
</row>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>typowner</structfield></entry>
Replace pg_shadow and pg_group by new role-capable catalogs pg_authid and pg_auth_members. There are still many loose ends to finish in this patch (no documentation, no regression tests, no pg_dump support for instance). But I'm going to commit it now anyway so that Alvaro can make some progress on shared dependencies. The catalog changes should be pretty much done.
2005-06-28 07:09:14 +02:00
<entry><type>oid</type></entry>
<entry><literal><link linkend="catalog-pg-authid"><structname>pg_authid</structname></link>.oid</literal></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>Owner of the type</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>typlen</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>int2</type></entry>
<entry></entry>
The cstring datatype can now be copied, passed around, etc. The typlen value '-2' is used to indicate a variable-width type whose width is computed as strlen(datum)+1. Everything that looks at typlen is updated except for array support, which Joe Conway is working on; at the moment it wouldn't work to try to create an array of cstring.
2002-08-24 17:00:47 +02:00
<entry>
For a fixed-size type, <structfield>typlen</structfield> is the number
of bytes in the internal representation of the type. But for a
variable-length type, <structfield>typlen</structfield> is negative.
-1 indicates a <quote>varlena</> type (one that has a length word),
-2 indicates a null-terminated C string.
</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>typbyval</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>bool</type></entry>
<entry></entry>
<entry>
<structfield>typbyval</structfield> determines whether internal
routines pass a value of this type by value or by reference.
Reinstate pg_type's typsend and typreceive columns. They don't do much yet, but they're there. Also some editorial work on CREATE TYPE reference page.
2003-05-09 00:19:58 +02:00
<structfield>typbyval</structfield> had better be false if
<structfield>typlen</structfield> is not 1, 2, or 4 (or 8 on machines
where Datum is 8 bytes).
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
Variable-length types are always passed by reference. Note that
<structfield>typbyval</structfield> can be false even if the
length would allow pass-by-value; this is currently true for
type <type>float4</type>, for example.
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>typtype</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>char</type></entry>
<entry></entry>
<entry>
<structfield>typtype</structfield> is <literal>b</literal> for
Some preliminary documentation for composite-type stuff.
2004-06-07 06:04:47 +02:00
a base type, <literal>c</literal> for a composite type (e.g., a
Call domains "domains", not "derived types".
2003-11-02 13:53:57 +01:00
table's row type), <literal>d</literal> for a domain, or
<literal>p</literal> for a pseudo-type. See also
<structfield>typrelid</structfield> and
<structfield>typbasetype</structfield>.
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>typisdefined</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>bool</type></entry>
<entry></entry>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry>
True if the type is defined, false if this is a placeholder
entry for a not-yet-defined type. When
<structfield>typisdefined</structfield> is false, nothing
except the type name, namespace, and OID can be relied on.
Add note about pg_stats to pg_statistic entry; add sections for pg_largeobject, pg_listener, pg_rewrite, pg_trigger; miscellaneous small improvements.
2001-10-16 00:47:47 +02:00
</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>typdelim</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>char</type></entry>
<entry></entry>
Clean up wrong, misleading, or obsolete documentation about array types, particularly in the CREATE TYPE reference page. Fix some other errors in the CREATE TYPE page, too.
2001-11-03 22:42:47 +01:00
<entry>Character that separates two values of this type when parsing
array input. Note that the delimiter is associated with the array
Spell checking and markup additions
2002-03-22 20:20:45 +01:00
element data type, not the array data type.</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>typrelid</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.oid</literal></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>
Reinstate pg_type's typsend and typreceive columns. They don't do much yet, but they're there. Also some editorial work on CREATE TYPE reference page.
2003-05-09 00:19:58 +02:00
If this is a composite type (see
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<structfield>typtype</structfield>), then this column points to
Update info about relkind and pg_type entries for composite-types patch.
2002-08-28 17:02:55 +02:00
the <structname>pg_class</structname> entry that defines the
corresponding table. (For a free-standing composite type, the
<structname>pg_class</structname> entry doesn't really represent
a table, but it is needed anyway for the type's
<structname>pg_attribute</structname> entries to link to.)
Some preliminary documentation for composite-type stuff.
2004-06-07 06:04:47 +02:00
Zero for non-composite types.
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>typelem</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>oid</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-type"><structname>pg_type</structname></link>.oid</literal></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry>
If <structfield>typelem</structfield> is not 0 then it
identifies another row in <structname>pg_type</structname>.
The current type can then be subscripted like an array yielding
Clean up wrong, misleading, or obsolete documentation about array types, particularly in the CREATE TYPE reference page. Fix some other errors in the CREATE TYPE page, too.
2001-11-03 22:42:47 +01:00
values of type <structfield>typelem</structfield>. A
<quote>true</quote> array type is variable length
(<structfield>typlen</structfield> = -1),
but some fixed-length (<structfield>typlen</structfield> &gt; 0) types
also have nonzero <structfield>typelem</structfield>, for example
Convert oidvector and int2vector into variable-length arrays. This change saves a great deal of space in pg_proc and its primary index, and it eliminates the former requirement that INDEX_MAX_KEYS and FUNC_MAX_ARGS have the same value. INDEX_MAX_KEYS is still embedded in the on-disk representation (because it affects index tuple header size), but FUNC_MAX_ARGS is not. I believe it would now be possible to increase FUNC_MAX_ARGS at little cost, but haven't experimented yet. There are still a lot of vestigial references to FUNC_MAX_ARGS, which I will clean up in a separate pass. However, getting rid of it altogether would require changing the FunctionCallInfoData struct, and I'm not sure I want to buy into that.
2005-03-29 02:17:27 +02:00
<type>name</type> and <type>point</type>.
Clean up wrong, misleading, or obsolete documentation about array types, particularly in the CREATE TYPE reference page. Fix some other errors in the CREATE TYPE page, too.
2001-11-03 22:42:47 +01:00
If a fixed-length type has a <structfield>typelem</structfield> then
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
its internal representation must be some number of values of the
Spell checking and markup additions
2002-03-22 20:20:45 +01:00
<structfield>typelem</structfield> data type with no other data.
Clean up wrong, misleading, or obsolete documentation about array types, particularly in the CREATE TYPE reference page. Fix some other errors in the CREATE TYPE page, too.
2001-11-03 22:42:47 +01:00
Variable-length array types have a header defined by the array
subroutines.
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>typinput</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>regproc</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
Reinstate pg_type's typsend and typreceive columns. They don't do much yet, but they're there. Also some editorial work on CREATE TYPE reference page.
2003-05-09 00:19:58 +02:00
<entry>Input conversion function (text format)</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>typoutput</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>regproc</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
Reinstate pg_type's typsend and typreceive columns. They don't do much yet, but they're there. Also some editorial work on CREATE TYPE reference page.
2003-05-09 00:19:58 +02:00
<entry>Output conversion function (text format)</entry>
</row>
<row>
<entry><structfield>typreceive</structfield></entry>
<entry><type>regproc</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
Reinstate pg_type's typsend and typreceive columns. They don't do much yet, but they're there. Also some editorial work on CREATE TYPE reference page.
2003-05-09 00:19:58 +02:00
<entry>Input conversion function (binary format), or 0 if none</entry>
</row>
<row>
<entry><structfield>typsend</structfield></entry>
<entry><type>regproc</type></entry>
Create <link> entries for the foreign keys in the system catalog chapter. I got tired of hitting the 'up' link, then finding the table in the table of contents, and following it back down. Rod Taylor
2003-06-25 03:14:37 +02:00
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
Reinstate pg_type's typsend and typreceive columns. They don't do much yet, but they're there. Also some editorial work on CREATE TYPE reference page.
2003-05-09 00:19:58 +02:00
<entry>Output conversion function (binary format), or 0 if none</entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
Add hooks for type-specific calculation of ANALYZE statistics. Idea and coding by Mark Cave-Ayland, some kibitzing by Tom Lane. initdb forced due to new column in pg_type.
2004-02-13 00:41:04 +01:00
<row>
<entry><structfield>typanalyze</structfield></entry>
<entry><type>regproc</type></entry>
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
<entry>Custom ANALYZE function, or 0 to use the standard function</entry>
</row>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>typalign</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>char</type></entry>
<entry></entry>
<entry><para>
<structfield>typalign</structfield> is the alignment required
when storing a value of this type. It applies to storage on
disk as well as most representations of the value inside
Deprecate 'current' for date/time input. Fix up references to "PostgreSQL" rather than "Postgres". Was roughly evenly split between the two before. ref/ files not yet done.
2001-11-21 06:53:41 +01:00
<productname>PostgreSQL</>.
Replace pg_attribute.attisinherited with attislocal and attinhcount columns, to allow more correct behavior in multiple-inheritance cases. Patch by Alvaro Herrera, review by Tom Lane.
2002-09-22 21:42:52 +02:00
When multiple values are stored consecutively, such
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
as in the representation of a complete row on disk, padding is
inserted before a datum of this type so that it begins on the
specified boundary. The alignment reference is the beginning
of the first datum in the sequence.
</para><para>
Possible values are:
<itemizedlist>
<listitem>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<para><literal>c</> = <type>char</type> alignment, i.e., no alignment needed.</para>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</listitem>
<listitem>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<para><literal>s</> = <type>short</type> alignment (2 bytes on most machines).</para>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</listitem>
<listitem>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<para><literal>i</> = <type>int</type> alignment (4 bytes on most machines).</para>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</listitem>
<listitem>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<para><literal>d</> = <type>double</type> alignment (8 bytes on many machines, but by no means all).</para>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</listitem>
</itemizedlist>
</para><note>
<para>
For types used in system tables, it is critical that the size
and alignment defined in <structname>pg_type</structname>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
agree with the way that the compiler will lay out the column in
Spell checking, consistent terminology.
2003-11-01 02:56:29 +01:00
a structure representing a table row.
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</para>
</note></entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>typstorage</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>char</type></entry>
<entry></entry>
<entry><para>
The cstring datatype can now be copied, passed around, etc. The typlen value '-2' is used to indicate a variable-width type whose width is computed as strlen(datum)+1. Everything that looks at typlen is updated except for array support, which Joe Conway is working on; at the moment it wouldn't work to try to create an array of cstring.
2002-08-24 17:00:47 +02:00
<structfield>typstorage</structfield> tells for varlena
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
types (those with <structfield>typlen</structfield> = -1) if
the type is prepared for toasting and what the default strategy
for attributes of this type should be.
Possible values are
<itemizedlist>
<listitem>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<para><literal>p</>: Value must always be stored plain.</para>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</listitem>
<listitem>
<para>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<literal>e</>: Value can be stored in a <quote>secondary</quote>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
relation (if relation has one, see
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<literal>pg_class.reltoastrelid</literal>).
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</para>
</listitem>
<listitem>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<para><literal>m</>: Value can be stored compressed inline.</para>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</listitem>
<listitem>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<para><literal>x</>: Value can be stored compressed inline or stored in <quote>secondary</quote> storage.</para>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</listitem>
</itemizedlist>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
Note that <literal>m</> columns can also be moved out to secondary
storage, but only as a last resort (<literal>e</> and <literal>x</> columns are
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
moved first).
</para></entry>
</row>
Add DOMAIN support. Includes manual pages and regression tests, from Rod Taylor.
2002-03-19 03:18:25 +01:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>typnotnull</structfield></entry>
Code review for DOMAIN patch.
2002-03-20 20:45:13 +01:00
<entry><type>bool</type></entry>
Add DOMAIN support. Includes manual pages and regression tests, from Rod Taylor.
2002-03-19 03:18:25 +01:00
<entry></entry>
<entry><para>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<structfield>typnotnull</structfield> represents a not-null
constraint on a type. Used for domains only.
Add DOMAIN support. Includes manual pages and regression tests, from Rod Taylor.
2002-03-19 03:18:25 +01:00
</para></entry>
</row>
Code review for DOMAIN patch.
2002-03-20 20:45:13 +01:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>typbasetype</structfield></entry>
Code review for DOMAIN patch.
2002-03-20 20:45:13 +01:00
<entry><type>oid</type></entry>
Update obsolete examples of error messages; various other minor editing.
2003-09-13 00:17:24 +02:00
<entry><literal><link linkend="catalog-pg-type"><structname>pg_type</structname></link>.oid</literal></entry>
Code review for DOMAIN patch.
2002-03-20 20:45:13 +01:00
<entry><para>
Call domains "domains", not "derived types".
2003-11-02 13:53:57 +01:00
If this is a domain (see <structfield>typtype</structfield>),
Code review for DOMAIN patch.
2002-03-20 20:45:13 +01:00
then <structfield>typbasetype</structfield> identifies
Call domains "domains", not "derived types".
2003-11-02 13:53:57 +01:00
the type that this one is based on. Zero if not a domain.
Code review for DOMAIN patch.
2002-03-20 20:45:13 +01:00
</para></entry>
</row>
Add DOMAIN support. Includes manual pages and regression tests, from Rod Taylor.
2002-03-19 03:18:25 +01:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>typtypmod</structfield></entry>
Code review for DOMAIN patch.
2002-03-20 20:45:13 +01:00
<entry><type>int4</type></entry>
Add DOMAIN support. Includes manual pages and regression tests, from Rod Taylor.
2002-03-19 03:18:25 +01:00
<entry></entry>
<entry><para>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
Domains use <structfield>typtypmod</structfield> to record the <literal>typmod</>
Update some obsolete comments and column descriptions.
2002-09-24 23:26:44 +02:00
to be applied to their base type (-1 if base type does not use a
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<literal>typmod</>). -1 if this type is not a domain.
Update some obsolete comments and column descriptions.
2002-09-24 23:26:44 +02:00
</para></entry>
Code review for DOMAIN patch.
2002-03-20 20:45:13 +01:00
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>typndims</structfield></entry>
Code review for DOMAIN patch.
2002-03-20 20:45:13 +01:00
<entry><type>int4</type></entry>
<entry></entry>
<entry><para>
<structfield>typndims</structfield> is the number of array dimensions
Spell checking, consistent terminology.
2003-11-01 02:56:29 +01:00
for a domain that is an array (that is, <structfield>typbasetype</> is an array type;
the domain's <structfield>typelem</> will match the base type's <structfield>typelem</structfield>).
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
Zero for types other than array domains.
Add DOMAIN support. Includes manual pages and regression tests, from Rod Taylor.
2002-03-19 03:18:25 +01:00
</para></entry>
</row>
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>typdefaultbin</structfield></entry>
Add DOMAIN support. Includes manual pages and regression tests, from Rod Taylor.
2002-03-19 03:18:25 +01:00
<entry><type>text</type></entry>
<entry></entry>
<entry><para>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
If <structfield>typdefaultbin</> is not null, it is the <function>nodeToString()</function>
representation of a default expression for the type. This is
Code review for DOMAIN patch.
2002-03-20 20:45:13 +01:00
only used for domains.
Add DOMAIN support. Includes manual pages and regression tests, from Rod Taylor.
2002-03-19 03:18:25 +01:00
</para></entry>
</row>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<row>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<entry><structfield>typdefault</structfield></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
<entry><type>text</type></entry>
<entry></entry>
Fix handling of pg_type.typdefault per bug report from Dave Blasby. If there's anyone out there who's actually using datatype-defined default values, this will be an incompatible change in behavior ... but the old behavior was so broken that I doubt anyone was using it.
2001-09-06 04:07:42 +02:00
<entry><para>
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<structfield>typdefault</> is null if the type has no associated
default value. If <structfield>typdefaultbin</> is not null,
Code review for DOMAIN patch.
2002-03-20 20:45:13 +01:00
<structfield>typdefault</> must contain a human-readable version of the
default expression represented by <structfield>typdefaultbin</>. If
Add better markup and improve some text here and there.
2003-04-15 15:23:35 +02:00
<structfield>typdefaultbin</> is null and <structfield>typdefault</> is
Code review for DOMAIN patch.
2002-03-20 20:45:13 +01:00
not, then <structfield>typdefault</> is the external representation of
the type's default value, which may be fed to the type's input
converter to produce a constant.
Fix handling of pg_type.typdefault per bug report from Dave Blasby. If there's anyone out there who's actually using datatype-defined default values, this will be an incompatible change in behavior ... but the old behavior was so broken that I doubt anyone was using it.
2001-09-06 04:07:42 +02:00
</para></entry>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</row>
</tbody>
</tgroup>
</table>
Use <sect1> rather than <section> to simplify formatting.
2001-11-09 00:44:01 +01:00
</sect1>
Document all the system views created by initdb (several of these were never documented anywhere, sigh). Centralize the detailed documentation of system views into catalogs.sgml, and provide cross-references.
2003-10-18 00:38:20 +02:00
<sect1 id="views-overview">
<title>System Views</title>
<para>
In addition to the system catalogs, <productname>PostgreSQL</productname>
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
provides a number of built-in views. Some system views provide convenient
access to some commonly used queries on the system catalogs. Other views
provide access to internal server state.
Document all the system views created by initdb (several of these were never documented anywhere, sigh). Centralize the detailed documentation of system views into catalogs.sgml, and provide cross-references.
2003-10-18 00:38:20 +02:00
</para>
<para>
The information schema (<xref linkend="information-schema">) provides
an alternative set of views which overlap the functionality of the system
views. Since the information schema is SQL-standard whereas the views
described here are <productname>PostgreSQL</productname>-specific,
it's usually better to use the information schema if it provides all
the information you need.
</para>
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
<para>
<xref linkend="view-table"> lists the system views described here.
More detailed documentation of each view follows below.
There are some additional views that provide access to the results of
the statistics collector; they are described in <xref
linkend="monitoring-stats-views-table">.
</para>
Document all the system views created by initdb (several of these were never documented anywhere, sigh). Centralize the detailed documentation of system views into catalogs.sgml, and provide cross-references.
2003-10-18 00:38:20 +02:00
<para>
Except where noted, all the views described here are read-only.
</para>
<table id="view-table">
<title>System Views</title>
<tgroup cols="2">
<thead>
<row>
<entry>View Name</entry>
<entry>Purpose</entry>
</row>
</thead>
<tbody>
Replace pg_shadow and pg_group by new role-capable catalogs pg_authid and pg_auth_members. There are still many loose ends to finish in this patch (no documentation, no regression tests, no pg_dump support for instance). But I'm going to commit it now anyway so that Alvaro can make some progress on shared dependencies. The catalog changes should be pretty much done.
2005-06-28 07:09:14 +02:00
<row>
<entry><link linkend="view-pg-group"><structname>pg_group</structname></link></entry>
<entry>groups of database users</entry>
</row>
Document all the system views created by initdb (several of these were never documented anywhere, sigh). Centralize the detailed documentation of system views into catalogs.sgml, and provide cross-references.
2003-10-18 00:38:20 +02:00
<row>
<entry><link linkend="view-pg-indexes"><structname>pg_indexes</structname></link></entry>
<entry>indexes</entry>
</row>
<row>
<entry><link linkend="view-pg-locks"><structname>pg_locks</structname></link></entry>
<entry>currently held locks</entry>
</row>
Two-phase commit. Original patch by Heikki Linnakangas, with additional hacking by Alvaro Herrera and Tom Lane.
2005-06-18 00:32:51 +02:00
<row>
<entry><link linkend="view-pg-prepared-xacts"><structname>pg_prepared_xacts</structname></link></entry>
<entry>currently prepared transactions</entry>
</row>
Replace pg_shadow and pg_group by new role-capable catalogs pg_authid and pg_auth_members. There are still many loose ends to finish in this patch (no documentation, no regression tests, no pg_dump support for instance). But I'm going to commit it now anyway so that Alvaro can make some progress on shared dependencies. The catalog changes should be pretty much done.
2005-06-28 07:09:14 +02:00
<row>
<entry><link linkend="view-pg-roles"><structname>pg_roles</structname></link></entry>
<entry>database roles</entry>
</row>
Document all the system views created by initdb (several of these were never documented anywhere, sigh). Centralize the detailed documentation of system views into catalogs.sgml, and provide cross-references.
2003-10-18 00:38:20 +02:00
<row>
<entry><link linkend="view-pg-rules"><structname>pg_rules</structname></link></entry>
<entry>rules</entry>
</row>
<row>
<entry><link linkend="view-pg-settings"><structname>pg_settings</structname></link></entry>
<entry>parameter settings</entry>
</row>
Replace pg_shadow and pg_group by new role-capable catalogs pg_authid and pg_auth_members. There are still many loose ends to finish in this patch (no documentation, no regression tests, no pg_dump support for instance). But I'm going to commit it now anyway so that Alvaro can make some progress on shared dependencies. The catalog changes should be pretty much done.
2005-06-28 07:09:14 +02:00
<row>
<entry><link linkend="view-pg-shadow"><structname>pg_shadow</structname></link></entry>
<entry>database users</entry>
</row>
Document all the system views created by initdb (several of these were never documented anywhere, sigh). Centralize the detailed documentation of system views into catalogs.sgml, and provide cross-references.
2003-10-18 00:38:20 +02:00
<row>
<entry><link linkend="view-pg-stats"><structname>pg_stats</structname></link></entry>
<entry>planner statistics</entry>
</row>
<row>
<entry><link linkend="view-pg-tables"><structname>pg_tables</structname></link></entry>
<entry>tables</entry>
</row>
<row>
<entry><link linkend="view-pg-user"><structname>pg_user</structname></link></entry>
<entry>database users</entry>
</row>
<row>
<entry><link linkend="view-pg-views"><structname>pg_views</structname></link></entry>
<entry>views</entry>
</row>
</tbody>
</tgroup>
</table>
</sect1>
Replace pg_shadow and pg_group by new role-capable catalogs pg_authid and pg_auth_members. There are still many loose ends to finish in this patch (no documentation, no regression tests, no pg_dump support for instance). But I'm going to commit it now anyway so that Alvaro can make some progress on shared dependencies. The catalog changes should be pretty much done.
2005-06-28 07:09:14 +02:00
<sect1 id="view-pg-group">
<title><structname>pg_group</structname></title>
<indexterm zone="view-pg-group">
<primary>pg_group</primary>
</indexterm>
<para>
The view <structname>pg_group</structname> exists for backwards
compatibility: it emulates a catalog that existed in
<productname>PostgreSQL</productname> before version 8.1.
It shows the names and members of all roles that are marked as not
<structfield>rolcanlogin</>, which is an approximation to the set
of roles that are being used as groups.
</para>
<table>
<title><structname>pg_group</> Columns</title>
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><structfield>groname</structfield></entry>
<entry><type>name</type></entry>
<entry><literal><link linkend="catalog-pg-authid"><structname>pg_authid</structname></link>.rolname</literal></entry>
<entry>Name of the group</entry>
</row>
<row>
<entry><structfield>grosysid</structfield></entry>
<entry><type>oid</type></entry>
<entry><literal><link linkend="catalog-pg-authid"><structname>pg_authid</structname></link>.oid</literal></entry>
<entry>ID of this group</entry>
</row>
<row>
<entry><structfield>grolist</structfield></entry>
<entry><type>oid[]</type></entry>
<entry><literal><link linkend="catalog-pg-authid"><structname>pg_authid</structname></link>.oid</literal></entry>
<entry>An array containing the IDs of the roles in this group</entry>
</row>
</tbody>
</tgroup>
</table>
</sect1>
Document all the system views created by initdb (several of these were never documented anywhere, sigh). Centralize the detailed documentation of system views into catalogs.sgml, and provide cross-references.
2003-10-18 00:38:20 +02:00
<sect1 id="view-pg-indexes">
<title><structname>pg_indexes</structname></title>
<indexterm zone="view-pg-indexes">
<primary>pg_indexes</primary>
</indexterm>
<para>
The view <structname>pg_indexes</structname> provides access to
useful information about each index in the database.
</para>
<table>
<title><structname>pg_indexes</> Columns</title>
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><structfield>schemaname</structfield></entry>
<entry><type>name</type></entry>
<entry><literal><link linkend="catalog-pg-namespace"><structname>pg_namespace</structname></link>.nspname</literal></entry>
<entry>name of schema containing table and index</entry>
</row>
<row>
<entry><structfield>tablename</structfield></entry>
<entry><type>name</type></entry>
<entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.relname</literal></entry>
<entry>name of table the index is for</entry>
</row>
<row>
<entry><structfield>indexname</structfield></entry>
<entry><type>name</type></entry>
<entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.relname</literal></entry>
<entry>name of index</entry>
</row>
Fix pg_indexes view so that it shows the index's tablespace not the parent table's tablespace, as per gripe from Michael Kleiser. Choose a more plausible column order for this view and pg_tables. Update documentation of these views, which was missed in original patch.
2004-10-11 19:24:41 +02:00
<row>
<entry><structfield>tablespace</structfield></entry>
<entry><type>name</type></entry>
<entry><literal><link linkend="catalog-pg-tablespace"><structname>pg_tablespace</structname></link>.spcname</literal></entry>
<entry>name of tablespace containing index (NULL if default for database)</entry>
</row>
Document all the system views created by initdb (several of these were never documented anywhere, sigh). Centralize the detailed documentation of system views into catalogs.sgml, and provide cross-references.
2003-10-18 00:38:20 +02:00
<row>
<entry><structfield>indexdef</structfield></entry>
<entry><type>text</type></entry>
<entry></entry>
<entry>index definition (a reconstructed creation command)</entry>
</row>
</tbody>
</tgroup>
</table>
</sect1>
<sect1 id="view-pg-locks">
<title><structname>pg_locks</structname></title>
<indexterm zone="view-pg-locks">
<primary>pg_locks</primary>
</indexterm>
<para>
The view <structname>pg_locks</structname> provides access to
information about the locks held by open transactions within the
database server. See <xref linkend="mvcc"> for more discussion
of locking.
</para>
<para>
<structname>pg_locks</structname> contains one row per active lockable
object, requested lock mode, and relevant transaction. Thus, the same
lockable object may
appear many times, if multiple transactions are holding or waiting
for locks on it. However, an object that currently has no locks on it
Extend the pg_locks system view so that it can fully display all lock types, as per recent discussion.
2005-05-17 23:46:11 +02:00
will not appear at all.
Document all the system views created by initdb (several of these were never documented anywhere, sigh). Centralize the detailed documentation of system views into catalogs.sgml, and provide cross-references.
2003-10-18 00:38:20 +02:00
</para>
<para>
Extend the pg_locks system view so that it can fully display all lock types, as per recent discussion.
2005-05-17 23:46:11 +02:00
There are several distinct types of lockable objects:
whole relations (e.g., tables), individual pages of relations,
individual tuples of relations,
transaction IDs,
and general database objects (identified by class OID and object OID,
in the same way as in <structname>pg_description</structname> or
<structname>pg_depend</structname>). Also, the right to extend a
relation is represented as a separate lockable object.
Document all the system views created by initdb (several of these were never documented anywhere, sigh). Centralize the detailed documentation of system views into catalogs.sgml, and provide cross-references.
2003-10-18 00:38:20 +02:00
</para>
<table>
<title><structname>pg_locks</> Columns</title>
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
Extend the pg_locks system view so that it can fully display all lock types, as per recent discussion.
2005-05-17 23:46:11 +02:00
<entry><structfield>locktype</structfield></entry>
<entry><type>text</type></entry>
<entry></entry>
Document all the system views created by initdb (several of these were never documented anywhere, sigh). Centralize the detailed documentation of system views into catalogs.sgml, and provide cross-references.
2003-10-18 00:38:20 +02:00
<entry>
Extend the pg_locks system view so that it can fully display all lock types, as per recent discussion.
2005-05-17 23:46:11 +02:00
type of the lockable object:
<literal>relation</>,
<literal>extend</>,
<literal>page</>,
<literal>tuple</>,
Add a time-of-preparation column to the pg_prepared_xacts view, per an old suggestion by Oliver Jowett. Also, add a transaction column to the pg_locks view to show the xid of each transaction holding or awaiting locks; this allows prepared transactions to be properly associated with the locks they own. There was already a column named 'transaction', and I chose to rename it to 'transactionid' --- since this column is new in the current devel cycle there should be no backwards compatibility issue to worry about.
2005-06-18 21:33:42 +02:00
<literal>transactionid</>,
Extend the pg_locks system view so that it can fully display all lock types, as per recent discussion.
2005-05-17 23:46:11 +02:00
<literal>object</>, or
<literal>userlock</>
Document all the system views created by initdb (several of these were never documented anywhere, sigh). Centralize the detailed documentation of system views into catalogs.sgml, and provide cross-references.
2003-10-18 00:38:20 +02:00
</entry>
</row>
<row>
<entry><structfield>database</structfield></entry>
<entry><type>oid</type></entry>
<entry><literal><link linkend="catalog-pg-database"><structname>pg_database</structname></link>.oid</literal></entry>
<entry>
Extend the pg_locks system view so that it can fully display all lock types, as per recent discussion.
2005-05-17 23:46:11 +02:00
OID of the database in which the object exists, or
Track dependencies on shared objects (which is to say, roles; we already have adequate mechanisms for tracking the contents of databases and tablespaces). This solves the longstanding problem that you can drop a user who still owns objects and/or has access permissions. Alvaro Herrera, with some kibitzing from Tom Lane.
2005-07-07 22:40:02 +02:00
zero if the object is a shared object, or
Extend the pg_locks system view so that it can fully display all lock types, as per recent discussion.
2005-05-17 23:46:11 +02:00
NULL if the object is a transaction ID
</entry>
</row>
<row>
<entry><structfield>relation</structfield></entry>
<entry><type>oid</type></entry>
<entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.oid</literal></entry>
<entry>
OID of the relation, or NULL if the object is not
a relation or part of a relation
</entry>
</row>
<row>
<entry><structfield>page</structfield></entry>
<entry><type>integer</type></entry>
<entry></entry>
<entry>
page number within the relation, or NULL if the object
is not a tuple or relation page
</entry>
</row>
<row>
<entry><structfield>tuple</structfield></entry>
<entry><type>smallint</type></entry>
<entry></entry>
<entry>
tuple number within the page, or NULL if the object is not a tuple
Document all the system views created by initdb (several of these were never documented anywhere, sigh). Centralize the detailed documentation of system views into catalogs.sgml, and provide cross-references.
2003-10-18 00:38:20 +02:00
</entry>
</row>
<row>
Add a time-of-preparation column to the pg_prepared_xacts view, per an old suggestion by Oliver Jowett. Also, add a transaction column to the pg_locks view to show the xid of each transaction holding or awaiting locks; this allows prepared transactions to be properly associated with the locks they own. There was already a column named 'transaction', and I chose to rename it to 'transactionid' --- since this column is new in the current devel cycle there should be no backwards compatibility issue to worry about.
2005-06-18 21:33:42 +02:00
<entry><structfield>transactionid</structfield></entry>
Document all the system views created by initdb (several of these were never documented anywhere, sigh). Centralize the detailed documentation of system views into catalogs.sgml, and provide cross-references.
2003-10-18 00:38:20 +02:00
<entry><type>xid</type></entry>
<entry></entry>
<entry>
Extend the pg_locks system view so that it can fully display all lock types, as per recent discussion.
2005-05-17 23:46:11 +02:00
ID of a transaction, or NULL if the object is not a transaction ID
</entry>
</row>
<row>
<entry><structfield>classid</structfield></entry>
<entry><type>oid</type></entry>
<entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.oid</literal></entry>
<entry>
OID of the system catalog containing the object, or NULL if the
object is not a general database object
</entry>
</row>
<row>
<entry><structfield>objid</structfield></entry>
<entry><type>oid</type></entry>
<entry>any OID column</entry>
<entry>
OID of the object within its system catalog, or NULL if the
object is not a general database object
</entry>
</row>
<row>
<entry><structfield>objsubid</structfield></entry>
<entry><type>smallint</type></entry>
<entry></entry>
<entry>
For a table column, this is the column number (the
<structfield>classid</> and <structfield>objid</> refer to the
table itself). For all other object types, this column is
zero. NULL if the object is not a general database object
Document all the system views created by initdb (several of these were never documented anywhere, sigh). Centralize the detailed documentation of system views into catalogs.sgml, and provide cross-references.
2003-10-18 00:38:20 +02:00
</entry>
</row>
Add a time-of-preparation column to the pg_prepared_xacts view, per an old suggestion by Oliver Jowett. Also, add a transaction column to the pg_locks view to show the xid of each transaction holding or awaiting locks; this allows prepared transactions to be properly associated with the locks they own. There was already a column named 'transaction', and I chose to rename it to 'transactionid' --- since this column is new in the current devel cycle there should be no backwards compatibility issue to worry about.
2005-06-18 21:33:42 +02:00
<row>
<entry><structfield>transaction</structfield></entry>
<entry><type>xid</type></entry>
<entry></entry>
<entry>
ID of the transaction that is holding or awaiting this lock.
</entry>
</row>
Document all the system views created by initdb (several of these were never documented anywhere, sigh). Centralize the detailed documentation of system views into catalogs.sgml, and provide cross-references.
2003-10-18 00:38:20 +02:00
<row>
<entry><structfield>pid</structfield></entry>
<entry><type>integer</type></entry>
<entry></entry>
Two-phase commit. Original patch by Heikki Linnakangas, with additional hacking by Alvaro Herrera and Tom Lane.
2005-06-18 00:32:51 +02:00
<entry>
Process ID of the server process holding or awaiting this
Add a time-of-preparation column to the pg_prepared_xacts view, per an old suggestion by Oliver Jowett. Also, add a transaction column to the pg_locks view to show the xid of each transaction holding or awaiting locks; this allows prepared transactions to be properly associated with the locks they own. There was already a column named 'transaction', and I chose to rename it to 'transactionid' --- since this column is new in the current devel cycle there should be no backwards compatibility issue to worry about.
2005-06-18 21:33:42 +02:00
lock. Null if the lock is held by a prepared transaction.
Two-phase commit. Original patch by Heikki Linnakangas, with additional hacking by Alvaro Herrera and Tom Lane.
2005-06-18 00:32:51 +02:00
</entry>
Document all the system views created by initdb (several of these were never documented anywhere, sigh). Centralize the detailed documentation of system views into catalogs.sgml, and provide cross-references.
2003-10-18 00:38:20 +02:00
</row>
<row>
<entry><structfield>mode</structfield></entry>
<entry><type>text</type></entry>
<entry></entry>
<entry>name of the lock mode held or desired by this process (see <xref
linkend="locking-tables">)</entry>
</row>
<row>
<entry><structfield>granted</structfield></entry>
<entry><type>boolean</type></entry>
<entry></entry>
<entry>true if lock is held, false if lock is awaited</entry>
</row>
</tbody>
</tgroup>
</table>
<para>
<structfield>granted</structfield> is true in a row representing a lock
Add a time-of-preparation column to the pg_prepared_xacts view, per an old suggestion by Oliver Jowett. Also, add a transaction column to the pg_locks view to show the xid of each transaction holding or awaiting locks; this allows prepared transactions to be properly associated with the locks they own. There was already a column named 'transaction', and I chose to rename it to 'transactionid' --- since this column is new in the current devel cycle there should be no backwards compatibility issue to worry about.
2005-06-18 21:33:42 +02:00
held by the indicated transaction. False indicates that this transaction is
Document all the system views created by initdb (several of these were never documented anywhere, sigh). Centralize the detailed documentation of system views into catalogs.sgml, and provide cross-references.
2003-10-18 00:38:20 +02:00
currently waiting to acquire this lock, which implies that some other
Add a time-of-preparation column to the pg_prepared_xacts view, per an old suggestion by Oliver Jowett. Also, add a transaction column to the pg_locks view to show the xid of each transaction holding or awaiting locks; this allows prepared transactions to be properly associated with the locks they own. There was already a column named 'transaction', and I chose to rename it to 'transactionid' --- since this column is new in the current devel cycle there should be no backwards compatibility issue to worry about.
2005-06-18 21:33:42 +02:00
transaction is holding a conflicting lock mode on the same lockable object.
The waiting transaction will sleep until the other lock is released (or a
deadlock situation is detected). A single transaction can be waiting to
acquire at most one lock at a time.
Document all the system views created by initdb (several of these were never documented anywhere, sigh). Centralize the detailed documentation of system views into catalogs.sgml, and provide cross-references.
2003-10-18 00:38:20 +02:00
</para>
<para>
Every transaction holds an exclusive lock on its transaction ID for its
entire duration. If one transaction finds it necessary to wait specifically
for another transaction, it does so by attempting to acquire share lock on
the other transaction ID. That will succeed only when the other transaction
terminates and releases its locks.
</para>
Extend the pg_locks system view so that it can fully display all lock types, as per recent discussion.
2005-05-17 23:46:11 +02:00
<para>
Although tuples are a lockable type of object,
information about row-level locks is stored on disk, not in memory,
and therefore row-level locks normally do not appear in this view.
If a transaction is waiting for a
row-level lock, it will usually appear in the view as waiting for the
transaction ID of the current holder of that row lock.
</para>
<para>
If user-defined locks are in use, they are displayed using the columns
for general database objects. However, the actual meaning of the lock
fields in such cases is up to the user.
</para>
Document all the system views created by initdb (several of these were never documented anywhere, sigh). Centralize the detailed documentation of system views into catalogs.sgml, and provide cross-references.
2003-10-18 00:38:20 +02:00
<para>
When the <structname>pg_locks</structname> view is accessed, the
internal lock manager data structures are momentarily locked, and
a copy is made for the view to display. This ensures that the
view produces a consistent set of results, while not blocking
normal lock manager operations longer than necessary. Nonetheless
there could be some impact on database performance if this view is
read often.
</para>
<para>
<structname>pg_locks</structname> provides a global view of all locks
in the database cluster, not only those relevant to the current database.
Although its <structfield>relation</structfield> column can be joined
against <structname>pg_class</>.<structfield>oid</> to identify locked
relations, this will only work correctly for relations in the current
database (those for which the <structfield>database</structfield> column
is either the current database's OID or zero).
</para>
<para>
If you have enabled the statistics collector, the
<structfield>pid</structfield> column can be joined to the
<structfield>procpid</structfield> column of the
<structname>pg_stat_activity</structname> view to get more
information on the session holding or waiting to hold the lock.
Add a time-of-preparation column to the pg_prepared_xacts view, per an old suggestion by Oliver Jowett. Also, add a transaction column to the pg_locks view to show the xid of each transaction holding or awaiting locks; this allows prepared transactions to be properly associated with the locks they own. There was already a column named 'transaction', and I chose to rename it to 'transactionid' --- since this column is new in the current devel cycle there should be no backwards compatibility issue to worry about.
2005-06-18 21:33:42 +02:00
Also, if you are using prepared transactions, the
<structfield>transaction</> column can be joined to the
<structfield>transaction</structfield> column of the
<structname>pg_prepared_xacts</structname> view to get more
information on prepared transactions that hold locks.
(A prepared transaction can never be waiting for a lock,
but it continues to hold the locks it acquired while running.)
Document all the system views created by initdb (several of these were never documented anywhere, sigh). Centralize the detailed documentation of system views into catalogs.sgml, and provide cross-references.
2003-10-18 00:38:20 +02:00
</para>
</sect1>
Two-phase commit. Original patch by Heikki Linnakangas, with additional hacking by Alvaro Herrera and Tom Lane.
2005-06-18 00:32:51 +02:00
<sect1 id="view-pg-prepared-xacts">
<title><structname>pg_prepared_xacts</structname></title>
<indexterm zone="view-pg-prepared-xacts">
<primary>pg_prepared_xacts</primary>
</indexterm>
<para>
The view <structname>pg_prepared_xacts</structname> displays
information about transactions that are currently prepared for two-phase
commit (see <xref linkend="sql-prepare-transaction"
endterm="sql-prepare-transaction-title"> for details).
</para>
<para>
<structname>pg_prepared_xacts</structname> contains one row per prepared
transaction. An entry is removed when the transaction is committed or
rolled back.
</para>
<table>
<title><structname>pg_prepared_xacts</> Columns</title>
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><structfield>transaction</structfield></entry>
<entry><type>xid</type></entry>
<entry></entry>
<entry>
Numeric transaction identifier of the prepared transaction
</entry>
</row>
<row>
<entry><structfield>gid</structfield></entry>
<entry><type>text</type></entry>
<entry></entry>
<entry>
Global transaction identifier that was assigned to the transaction
</entry>
</row>
Add a time-of-preparation column to the pg_prepared_xacts view, per an old suggestion by Oliver Jowett. Also, add a transaction column to the pg_locks view to show the xid of each transaction holding or awaiting locks; this allows prepared transactions to be properly associated with the locks they own. There was already a column named 'transaction', and I chose to rename it to 'transactionid' --- since this column is new in the current devel cycle there should be no backwards compatibility issue to worry about.
2005-06-18 21:33:42 +02:00
<row>
<entry><structfield>prepared</structfield></entry>
<entry><type>timestamp with time zone</type></entry>
<entry></entry>
<entry>
Time at which the transaction was prepared for commit
</entry>
</row>
Two-phase commit. Original patch by Heikki Linnakangas, with additional hacking by Alvaro Herrera and Tom Lane.
2005-06-18 00:32:51 +02:00
<row>
<entry><structfield>owner</structfield></entry>
<entry><type>name</type></entry>
Replace pg_shadow and pg_group by new role-capable catalogs pg_authid and pg_auth_members. There are still many loose ends to finish in this patch (no documentation, no regression tests, no pg_dump support for instance). But I'm going to commit it now anyway so that Alvaro can make some progress on shared dependencies. The catalog changes should be pretty much done.
2005-06-28 07:09:14 +02:00
<entry><literal><link linkend="catalog-pg-authid"><structname>pg_authid</structname></link>.rolname</literal></entry>
Two-phase commit. Original patch by Heikki Linnakangas, with additional hacking by Alvaro Herrera and Tom Lane.
2005-06-18 00:32:51 +02:00
<entry>
Name of the user that executed the transaction
</entry>
</row>
<row>
<entry><structfield>database</structfield></entry>
<entry><type>name</type></entry>
<entry><literal><link linkend="catalog-pg-database"><structname>pg_database</structname></link>.datname</literal></entry>
<entry>
Name of the database in which the transaction was executed
</entry>
</row>
</tbody>
</tgroup>
</table>
<para>
When the <structname>pg_prepared_xacts</structname> view is accessed, the
internal transaction manager data structures are momentarily locked, and
a copy is made for the view to display. This ensures that the
view produces a consistent set of results, while not blocking
normal operations longer than necessary. Nonetheless
there could be some impact on database performance if this view is
read often.
</para>
</sect1>
Replace pg_shadow and pg_group by new role-capable catalogs pg_authid and pg_auth_members. There are still many loose ends to finish in this patch (no documentation, no regression tests, no pg_dump support for instance). But I'm going to commit it now anyway so that Alvaro can make some progress on shared dependencies. The catalog changes should be pretty much done.
2005-06-28 07:09:14 +02:00
<sect1 id="view-pg-roles">
<title><structname>pg_roles</structname></title>
<indexterm zone="view-pg-roles">
<primary>pg_roles</primary>
</indexterm>
<para>
The view <structname>pg_roles</structname> provides access to
information about database roles. This is simply a publicly
readable view of
<link linkend="catalog-pg-authid"><structname>pg_authid</structname></link>
that blanks out the password field.
</para>
<table>
<title><structname>pg_roles</> Columns</title>
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><structfield>rolname</structfield></entry>
<entry><type>name</type></entry>
<entry></entry>
<entry>Role name</entry>
</row>
<row>
<entry><structfield>rolsuper</structfield></entry>
<entry><type>bool</type></entry>
<entry></entry>
<entry>Role has superuser privileges</entry>
</row>
<row>
<entry><structfield>rolcreaterole</structfield></entry>
<entry><type>bool</type></entry>
<entry></entry>
<entry>Role may create more roles</entry>
</row>
<row>
<entry><structfield>rolcreatedb</structfield></entry>
<entry><type>bool</type></entry>
<entry></entry>
<entry>Role may create databases</entry>
</row>
<row>
<entry><structfield>rolcatupdate</structfield></entry>
<entry><type>bool</type></entry>
<entry></entry>
<entry>
Role may update system catalogs directly. (Even a superuser may not do
this unless this column is true.)
</entry>
</row>
<row>
<entry><structfield>rolcanlogin</structfield></entry>
<entry><type>bool</type></entry>
<entry></entry>
<entry>
Role may log in, that is, this role can be given as the initial
session authorization identifier.
</entry>
</row>
<row>
<entry><structfield>rolpassword</structfield></entry>
<entry><type>text</type></entry>
<entry></entry>
<entry>Not the password (always reads as <literal>********</>)</entry>
</row>
<row>
<entry><structfield>rolvaliduntil</structfield></entry>
<entry><type>timestamptz</type></entry>
<entry></entry>
<entry>Password expiry time (only used for password authentication);
NULL if no expiration</entry>
</row>
<row>
<entry><structfield>rolconfig</structfield></entry>
<entry><type>text[]</type></entry>
<entry></entry>
<entry>Session defaults for run-time configuration variables</entry>
</row>
</tbody>
</tgroup>
</table>
</sect1>
Document all the system views created by initdb (several of these were never documented anywhere, sigh). Centralize the detailed documentation of system views into catalogs.sgml, and provide cross-references.
2003-10-18 00:38:20 +02:00
<sect1 id="view-pg-rules">
<title><structname>pg_rules</structname></title>
<indexterm zone="view-pg-rules">
<primary>pg_rules</primary>
</indexterm>
<para>
The view <structname>pg_rules</structname> provides access to
useful information about query rewrite rules.
</para>
<table>
<title><structname>pg_rules</> Columns</title>
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><structfield>schemaname</structfield></entry>
<entry><type>name</type></entry>
<entry><literal><link linkend="catalog-pg-namespace"><structname>pg_namespace</structname></link>.nspname</literal></entry>
<entry>name of schema containing table</entry>
</row>
<row>
<entry><structfield>tablename</structfield></entry>
<entry><type>name</type></entry>
<entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.relname</literal></entry>
<entry>name of table the rule is for</entry>
</row>
<row>
<entry><structfield>rulename</structfield></entry>
<entry><type>name</type></entry>
<entry><literal><link linkend="catalog-pg-rewrite"><structname>pg_rewrite</structname></link>.rulename</literal></entry>
<entry>name of rule</entry>
</row>
<row>
<entry><structfield>definition</structfield></entry>
<entry><type>text</type></entry>
<entry></entry>
<entry>rule definition (a reconstructed creation command)</entry>
</row>
</tbody>
</tgroup>
</table>
<para>
The <structname>pg_rules</structname> view excludes the ON SELECT rules of
views; those can be seen in <structname>pg_views</structname>.
</para>
</sect1>
<sect1 id="view-pg-settings">
<title><structname>pg_settings</structname></title>
<indexterm zone="view-pg-settings">
<primary>pg_settings</primary>
</indexterm>
<para>
The view <structname>pg_settings</structname> provides access to
run-time parameters of the server. It is essentially an alternative
interface to the <command>SHOW</> and <command>SET</> commands.
It also provides access to some facts about each parameter that are
not directly available from <command>SHOW</>, such as minimum and
maximum values.
</para>
<table>
<title><structname>pg_settings</> Columns</title>
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><structfield>name</structfield></entry>
<entry><type>text</type></entry>
<entry></entry>
<entry>run-time configuration parameter name</entry>
</row>
<row>
<entry><structfield>setting</structfield></entry>
<entry><type>text</type></entry>
<entry></entry>
<entry>current value of the parameter</entry>
</row>
Documentation update for previously committed changes: read-only GUC variables and pg_settings view.
2003-12-07 00:10:23 +01:00
<row>
<entry><structfield>category</structfield></entry>
<entry><type>text</type></entry>
<entry></entry>
<entry>logical group of the parameter</entry>
</row>
<row>
<entry><structfield>short_desc</structfield></entry>
<entry><type>text</type></entry>
<entry></entry>
<entry>a brief description of the parameter</entry>
</row>
<row>
<entry><structfield>extra_desc</structfield></entry>
<entry><type>text</type></entry>
<entry></entry>
<entry>additional, more detailed, information about the parameter</entry>
</row>
Document all the system views created by initdb (several of these were never documented anywhere, sigh). Centralize the detailed documentation of system views into catalogs.sgml, and provide cross-references.
2003-10-18 00:38:20 +02:00
<row>
<entry><structfield>context</structfield></entry>
<entry><type>text</type></entry>
<entry></entry>
<entry>context required to set the parameter's value</entry>
</row>
<row>
<entry><structfield>vartype</structfield></entry>
<entry><type>text</type></entry>
<entry></entry>
<entry>parameter type (<literal>bool</>, <literal>integer</>,
<literal>real</>, or <literal>string</>)
</entry>
</row>
<row>
<entry><structfield>source</structfield></entry>
<entry><type>text</type></entry>
<entry></entry>
<entry>source of the current parameter value</entry>
</row>
<row>
<entry><structfield>min_val</structfield></entry>
<entry><type>text</type></entry>
<entry></entry>
<entry>minimum allowed value of the parameter (NULL for nonnumeric
values)</entry>
</row>
<row>
<entry><structfield>max_val</structfield></entry>
<entry><type>text</type></entry>
<entry></entry>
<entry>maximum allowed value of the parameter (NULL for nonnumeric
values)</entry>
</row>
</tbody>
</tgroup>
</table>
<para>
The <structname>pg_settings</structname> view cannot be inserted into or
deleted from, but it can be updated. An <command>UPDATE</command> applied
to a row of <structname>pg_settings</structname> is equivalent to executing
the <xref linkend="SQL-SET" endterm="SQL-SET-title"> command on that named
parameter. The change only affects the value used by the current
session. If an <command>UPDATE</command> is issued within a transaction
that is later aborted, the effects of the <command>UPDATE</command> command
disappear when the transaction is rolled back. Once the surrounding
transaction is committed, the effects will persist until the end of the
session, unless overridden by another <command>UPDATE</command> or
<command>SET</command>.
</para>
</sect1>
Replace pg_shadow and pg_group by new role-capable catalogs pg_authid and pg_auth_members. There are still many loose ends to finish in this patch (no documentation, no regression tests, no pg_dump support for instance). But I'm going to commit it now anyway so that Alvaro can make some progress on shared dependencies. The catalog changes should be pretty much done.
2005-06-28 07:09:14 +02:00
<sect1 id="view-pg-shadow">
<title><structname>pg_shadow</structname></title>
<indexterm zone="view-pg-shadow">
<primary>pg_shadow</primary>
</indexterm>
<para>
The view <structname>pg_shadow</structname> exists for backwards
compatibility: it emulates a catalog that existed in
<productname>PostgreSQL</productname> before version 8.1.
It shows properties of all roles that are marked as
<structfield>rolcanlogin</>.
</para>
<para>
The name stems from the fact that this table
should not be readable by the public since it contains passwords.
<link linkend="view-pg-user"><structname>pg_user</structname></link>
is a publicly readable view on
<structname>pg_shadow</structname> that blanks out the password field.
</para>
<table>
<title><structname>pg_shadow</> Columns</title>
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><structfield>usename</structfield></entry>
<entry><type>name</type></entry>
<entry><literal><link linkend="catalog-pg-authid"><structname>pg_authid</structname></link>.rolname</literal></entry>
<entry>User name</entry>
</row>
<row>
<entry><structfield>usesysid</structfield></entry>
<entry><type>oid</type></entry>
<entry><literal><link linkend="catalog-pg-authid"><structname>pg_authid</structname></link>.oid</literal></entry>
<entry>ID of this user</entry>
</row>
<row>
<entry><structfield>usecreatedb</structfield></entry>
<entry><type>bool</type></entry>
<entry></entry>
<entry>User may create databases</entry>
</row>
<row>
<entry><structfield>usesuper</structfield></entry>
<entry><type>bool</type></entry>
<entry></entry>
<entry>User is a superuser</entry>
</row>
<row>
<entry><structfield>usecatupd</structfield></entry>
<entry><type>bool</type></entry>
<entry></entry>
<entry>
User may update system catalogs. (Even a superuser may not do
this unless this column is true.)
</entry>
</row>
<row>
<entry><structfield>passwd</structfield></entry>
<entry><type>text</type></entry>
<entry></entry>
<entry>Password (possibly encrypted)</entry>
</row>
<row>
<entry><structfield>valuntil</structfield></entry>
<entry><type>abstime</type></entry>
<entry></entry>
<entry>Password expiry time (only used for password authentication)</entry>
</row>
<row>
<entry><structfield>useconfig</structfield></entry>
<entry><type>text[]</type></entry>
<entry></entry>
<entry>Session defaults for run-time configuration variables</entry>
</row>
</tbody>
</tgroup>
</table>
</sect1>
Document all the system views created by initdb (several of these were never documented anywhere, sigh). Centralize the detailed documentation of system views into catalogs.sgml, and provide cross-references.
2003-10-18 00:38:20 +02:00
<sect1 id="view-pg-stats">
<title><structname>pg_stats</structname></title>
<indexterm zone="view-pg-stats">
<primary>pg_stats</primary>
</indexterm>
<para>
The view <structname>pg_stats</structname> provides access to
the information stored in the <link
linkend="catalog-pg-statistic"><structname>pg_statistic</structname></link>
catalog. This view allows access only to rows of
<structname>pg_statistic</structname> that correspond to tables the
user has permission to read, and therefore it is safe to allow public
read access to this view.
</para>
<para>
<structname>pg_stats</structname> is also designed to present the
information in a more readable format than the underlying catalog
Replace "--" and "---" with "&mdash;" as appropriate, for better-looking output.
2004-11-15 07:32:15 +01:00
&mdash; at the cost that its schema must be extended whenever new slot types
Document all the system views created by initdb (several of these were never documented anywhere, sigh). Centralize the detailed documentation of system views into catalogs.sgml, and provide cross-references.
2003-10-18 00:38:20 +02:00
are defined for <structname>pg_statistic</structname>.
</para>
<table>
<title><structname>pg_stats</> Columns</title>
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><structfield>schemaname</structfield></entry>
<entry><type>name</type></entry>
<entry><literal><link linkend="catalog-pg-namespace"><structname>pg_namespace</structname></link>.nspname</literal></entry>
<entry>name of schema containing table</entry>
</row>
<row>
<entry><structfield>tablename</structfield></entry>
<entry><type>name</type></entry>
<entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.relname</literal></entry>
<entry>name of table</entry>
</row>
<row>
<entry><structfield>attname</structfield></entry>
<entry><type>name</type></entry>
<entry><literal><link linkend="catalog-pg-attribute"><structname>pg_attribute</structname></link>.attname</literal></entry>
<entry>name of the column described by this row</entry>
</row>
<row>
<entry><structfield>null_frac</structfield></entry>
<entry><type>real</type></entry>
<entry></entry>
<entry>fraction of column entries that are null</entry>
</row>
<row>
<entry><structfield>avg_width</structfield></entry>
<entry><type>integer</type></entry>
<entry></entry>
<entry>average width in bytes of column's entries</entry>
</row>
<row>
<entry><structfield>n_distinct</structfield></entry>
<entry><type>real</type></entry>
<entry></entry>
<entry>If greater than zero, the estimated number of distinct values
in the column. If less than zero, the negative of the number of
distinct values divided by the number of rows. (The negated form
is used when <command>ANALYZE</> believes that the number of distinct
values
is likely to increase as the table grows; the positive form is used
when the column seems to have a fixed number of possible values.)
For example, -1 indicates a unique column in which the number of
distinct values is the same as the number of rows.
</entry>
</row>
<row>
<entry><structfield>most_common_vals</structfield></entry>
<entry><type>anyarray</type></entry>
<entry></entry>
<entry>A list of the most common values in the column. (NULL if
no values seem to be more common than any others.)</entry>
</row>
<row>
<entry><structfield>most_common_freqs</structfield></entry>
<entry><type>real[]</type></entry>
<entry></entry>
<entry>A list of the frequencies of the most common values,
i.e., number of occurrences of each divided by total number of rows.
(NULL when <structfield>most_common_vals</structfield> is.)
</entry>
</row>
<row>
<entry><structfield>histogram_bounds</structfield></entry>
<entry><type>anyarray</type></entry>
<entry></entry>
<entry>A list of values that divide the column's values into
groups of approximately equal population. The values in
<structfield>most_common_vals</>, if present, are omitted from this
histogram calculation. (This column is NULL if the column data type
does not have a <literal>&lt;</> operator or if the
<structfield>most_common_vals</> list accounts for the entire
population.)
</entry>
</row>
<row>
<entry><structfield>correlation</structfield></entry>
<entry><type>real</type></entry>
<entry></entry>
<entry>Statistical correlation between physical row ordering and
logical ordering of the column values. This ranges from -1 to +1.
When the value is near -1 or +1, an index scan on the column will
be estimated to be cheaper than when it is near zero, due to reduction
of random access to the disk. (This column is NULL if the column data
type does not have a <literal>&lt;</> operator.)
</entry>
</row>
</tbody>
</tgroup>
</table>
<para>
The maximum number of entries in the <structfield>most_common_vals</>
and <structfield>histogram_bounds</> arrays can be set on a
column-by-column basis using the <command>ALTER TABLE SET STATISTICS</>
command, or globally by setting the
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
<xref linkend="guc-default-statistics-target"> runtime parameter.
Document all the system views created by initdb (several of these were never documented anywhere, sigh). Centralize the detailed documentation of system views into catalogs.sgml, and provide cross-references.
2003-10-18 00:38:20 +02:00
</para>
</sect1>
<sect1 id="view-pg-tables">
<title><structname>pg_tables</structname></title>
<indexterm zone="view-pg-tables">
<primary>pg_tables</primary>
</indexterm>
<para>
The view <structname>pg_tables</structname> provides access to
useful information about each table in the database.
</para>
<table>
<title><structname>pg_tables</> Columns</title>
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><structfield>schemaname</structfield></entry>
<entry><type>name</type></entry>
<entry><literal><link linkend="catalog-pg-namespace"><structname>pg_namespace</structname></link>.nspname</literal></entry>
<entry>name of schema containing table</entry>
</row>
<row>
<entry><structfield>tablename</structfield></entry>
<entry><type>name</type></entry>
<entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.relname</literal></entry>
<entry>name of table</entry>
</row>
<row>
<entry><structfield>tableowner</structfield></entry>
<entry><type>name</type></entry>
Replace pg_shadow and pg_group by new role-capable catalogs pg_authid and pg_auth_members. There are still many loose ends to finish in this patch (no documentation, no regression tests, no pg_dump support for instance). But I'm going to commit it now anyway so that Alvaro can make some progress on shared dependencies. The catalog changes should be pretty much done.
2005-06-28 07:09:14 +02:00
<entry><literal><link linkend="catalog-pg-authid"><structname>pg_authid</structname></link>.rolname</literal></entry>
Document all the system views created by initdb (several of these were never documented anywhere, sigh). Centralize the detailed documentation of system views into catalogs.sgml, and provide cross-references.
2003-10-18 00:38:20 +02:00
<entry>name of table's owner</entry>
</row>
Fix pg_indexes view so that it shows the index's tablespace not the parent table's tablespace, as per gripe from Michael Kleiser. Choose a more plausible column order for this view and pg_tables. Update documentation of these views, which was missed in original patch.
2004-10-11 19:24:41 +02:00
<row>
<entry><structfield>tablespace</structfield></entry>
<entry><type>name</type></entry>
<entry><literal><link linkend="catalog-pg-tablespace"><structname>pg_tablespace</structname></link>.spcname</literal></entry>
<entry>name of tablespace containing table (NULL if default for database)</entry>
</row>
Document all the system views created by initdb (several of these were never documented anywhere, sigh). Centralize the detailed documentation of system views into catalogs.sgml, and provide cross-references.
2003-10-18 00:38:20 +02:00
<row>
<entry><structfield>hasindexes</structfield></entry>
<entry><type>boolean</type></entry>
<entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.relhasindex</literal></entry>
<entry>true if table has (or recently had) any indexes</entry>
</row>
<row>
<entry><structfield>hasrules</structfield></entry>
<entry><type>boolean</type></entry>
<entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.relhasrules</literal></entry>
<entry>true if table has rules</entry>
</row>
<row>
<entry><structfield>hastriggers</structfield></entry>
<entry><type>boolean</type></entry>
<entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.reltriggers</literal></entry>
<entry>true if table has triggers</entry>
</row>
</tbody>
</tgroup>
</table>
</sect1>
<sect1 id="view-pg-user">
<title><structname>pg_user</structname></title>
<indexterm zone="view-pg-user">
<primary>pg_user</primary>
</indexterm>
<para>
The view <structname>pg_user</structname> provides access to
information about database users. This is simply a publicly
readable view of
Replace pg_shadow and pg_group by new role-capable catalogs pg_authid and pg_auth_members. There are still many loose ends to finish in this patch (no documentation, no regression tests, no pg_dump support for instance). But I'm going to commit it now anyway so that Alvaro can make some progress on shared dependencies. The catalog changes should be pretty much done.
2005-06-28 07:09:14 +02:00
<link linkend="view-pg-shadow"><structname>pg_shadow</structname></link>
Document all the system views created by initdb (several of these were never documented anywhere, sigh). Centralize the detailed documentation of system views into catalogs.sgml, and provide cross-references.
2003-10-18 00:38:20 +02:00
that blanks out the password field.
</para>
<table>
<title><structname>pg_user</> Columns</title>
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><structfield>usename</structfield></entry>
<entry><type>name</type></entry>
<entry></entry>
<entry>User name</entry>
</row>
<row>
<entry><structfield>usesysid</structfield></entry>
<entry><type>int4</type></entry>
<entry></entry>
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
<entry>User ID (arbitrary number used to reference this user)</entry>
Document all the system views created by initdb (several of these were never documented anywhere, sigh). Centralize the detailed documentation of system views into catalogs.sgml, and provide cross-references.
2003-10-18 00:38:20 +02:00
</row>
<row>
<entry><structfield>usecreatedb</structfield></entry>
<entry><type>bool</type></entry>
<entry></entry>
<entry>User may create databases</entry>
</row>
<row>
<entry><structfield>usesuper</structfield></entry>
<entry><type>bool</type></entry>
<entry></entry>
<entry>User is a superuser</entry>
</row>
<row>
<entry><structfield>usecatupd</structfield></entry>
<entry><type>bool</type></entry>
<entry></entry>
<entry>
User may update system catalogs. (Even a superuser may not do
this unless this column is true.)
</entry>
</row>
<row>
<entry><structfield>passwd</structfield></entry>
<entry><type>text</type></entry>
<entry></entry>
<entry>Not the password (always reads as <literal>********</>)</entry>
</row>
<row>
<entry><structfield>valuntil</structfield></entry>
<entry><type>abstime</type></entry>
<entry></entry>
More minor updates and copy-editing.
2005-01-06 00:42:03 +01:00
<entry>Password expiry time (only used for password authentication)</entry>
Document all the system views created by initdb (several of these were never documented anywhere, sigh). Centralize the detailed documentation of system views into catalogs.sgml, and provide cross-references.
2003-10-18 00:38:20 +02:00
</row>
<row>
<entry><structfield>useconfig</structfield></entry>
<entry><type>text[]</type></entry>
<entry></entry>
<entry>Session defaults for run-time configuration variables</entry>
</row>
</tbody>
</tgroup>
</table>
</sect1>
<sect1 id="view-pg-views">
<title><structname>pg_views</structname></title>
<indexterm zone="view-pg-views">
<primary>pg_views</primary>
</indexterm>
<para>
The view <structname>pg_views</structname> provides access to
useful information about each view in the database.
</para>
<table>
<title><structname>pg_views</> Columns</title>
<tgroup cols=4>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>References</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><structfield>schemaname</structfield></entry>
<entry><type>name</type></entry>
<entry><literal><link linkend="catalog-pg-namespace"><structname>pg_namespace</structname></link>.nspname</literal></entry>
<entry>name of schema containing view</entry>
</row>
<row>
<entry><structfield>viewname</structfield></entry>
<entry><type>name</type></entry>
<entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.relname</literal></entry>
<entry>name of view</entry>
</row>
<row>
<entry><structfield>viewowner</structfield></entry>
<entry><type>name</type></entry>
Replace pg_shadow and pg_group by new role-capable catalogs pg_authid and pg_auth_members. There are still many loose ends to finish in this patch (no documentation, no regression tests, no pg_dump support for instance). But I'm going to commit it now anyway so that Alvaro can make some progress on shared dependencies. The catalog changes should be pretty much done.
2005-06-28 07:09:14 +02:00
<entry><literal><link linkend="catalog-pg-authid"><structname>pg_authid</structname></link>.rolname</literal></entry>
Document all the system views created by initdb (several of these were never documented anywhere, sigh). Centralize the detailed documentation of system views into catalogs.sgml, and provide cross-references.
2003-10-18 00:38:20 +02:00
<entry>name of view's owner</entry>
</row>
<row>
<entry><structfield>definition</structfield></entry>
<entry><type>text</type></entry>
<entry></entry>
<entry>view definition (a reconstructed SELECT query)</entry>
</row>
</tbody>
</tgroup>
</table>
</sect1>
Rewrite system catalog documentation man page in DocBook with more recent information.
2000-11-29 21:15:59 +01:00
</chapter>
Deprecate 'current' for date/time input. Fix up references to "PostgreSQL" rather than "Postgres". Was roughly evenly split between the two before. ref/ files not yet done.
2001-11-21 06:53:41 +01:00
<!-- Keep this comment at the end of the file
Local variables:
mode:sgml
sgml-omittag:nil
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-tabs-mode:nil
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"./reference.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:("/usr/share/sgml/catalog")
sgml-local-ecat-files:nil
End:
-->