<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/advanced.sgml,v 1.34 2003/03/25 16:15:35 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/advanced.sgml,v 1.35 2003/08/31 17:32:18 petere Exp $
-->
<chapter id="tutorial-advanced">
<title>Transactions</title>
<indexterm zone="tutorial-transactions">
- <primary>transactions</primary>
+ <primary>transaction</primary>
</indexterm>
<para>
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/array.sgml,v 1.30 2003/08/19 06:06:43 tgl Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/array.sgml,v 1.31 2003/08/31 17:32:18 petere Exp $ -->
<sect1 id="arrays">
<title>Arrays</title>
<indexterm>
- <primary>arrays</primary>
+ <primary>array</primary>
</indexterm>
<para>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/backup.sgml,v 2.29 2003/08/17 22:05:13 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/backup.sgml,v 2.30 2003/08/31 17:32:18 petere Exp $
-->
<chapter id="backup">
<title>Backup and Restore</title>
</para>
<para>
- For reasons of backward compatibility, <application>pg_dump</> does
- not dump large objects by default. To dump large objects you must use
- either the custom or the TAR output format, and use the <option>-b</> option in
- <application>pg_dump</>. See the reference pages for details.
- The directory <filename>contrib/pg_dumplo</> of the
- <productname>PostgreSQL</> source tree also contains a program that can
- dump large objects.
+ For reasons of backward compatibility, <application>pg_dump</>
+ does not dump large objects by default.<indexterm><primary>large
+ object</primary><secondary>backup</secondary></indexterm> To dump
+ large objects you must use either the custom or the TAR output
+ format, and use the <option>-b</> option in
+ <application>pg_dump</>. See the reference pages for details. The
+ directory <filename>contrib/pg_dumplo</> of the
+ <productname>PostgreSQL</> source tree also contains a program
+ that can dump large objects.
</para>
<para>
<sect1 id="migration">
<title>Migration between releases</title>
- <indexterm zone="migration"><primary>upgrading</></>
+
+ <indexterm zone="migration">
+ <primary>upgrading</primary>
+ </indexterm>
+
+ <indexterm zone="migration">
+ <primary>version</primary>
+ <secondary>compatibility</secondary>
+ </indexterm>
<para>
As a general rule, the internal data storage format is subject to
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/charset.sgml,v 2.37 2003/08/04 04:03:03 tgl Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/charset.sgml,v 2.38 2003/08/31 17:32:18 petere Exp $ -->
<chapter id="charset">
<title>Localization</>
<listitem>
<para>
Sort order in queries using <command>ORDER BY</>
- <indexterm><primary>ORDER BY</></>
+ <indexterm><primary>ORDER BY</><secondary>and locales</></indexterm>
</para>
</listitem>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/client-auth.sgml,v 1.55 2003/08/17 04:39:11 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/client-auth.sgml,v 1.56 2003/08/31 17:32:18 petere Exp $
-->
<chapter id="client-authentication">
</indexterm>
<indexterm>
<primary>password</primary>
+ <secondary>authentication</secondary>
</indexterm>
<para>
<sect2 id="auth-pam">
<title>PAM Authentication</title>
+ <indexterm zone="auth-pam">
+ <primary>PAM</primary>
+ </indexterm>
+
<para>
This authentication method operates similarly to
<literal>password</literal> except that it uses PAM (Pluggable
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/datatype.sgml,v 1.122 2003/08/09 22:50:21 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/datatype.sgml,v 1.123 2003/08/31 17:32:18 petere Exp $
-->
<chapter id="datatype">
<title id="datatype-title">Data Types</title>
<indexterm zone="datatype">
- <primary>data types</primary>
+ <primary>data type</primary>
</indexterm>
<indexterm>
- <primary>types</primary>
- <see>data types</see>
+ <primary>type</primary>
+ <see>data type</see>
</indexterm>
<para>
<title>Numeric Types</title>
<indexterm zone="datatype-numeric">
- <primary>data types</primary>
+ <primary>data type</primary>
<secondary>numeric</secondary>
</indexterm>
- <indexterm zone="datatype-numeric">
- <primary>integer</primary>
- </indexterm>
-
- <indexterm zone="datatype-numeric">
- <primary>smallint</primary>
- </indexterm>
-
- <indexterm zone="datatype-numeric">
- <primary>bigint</primary>
- </indexterm>
-
- <indexterm>
- <primary>int4</primary>
- <see>integer</see>
- </indexterm>
-
- <indexterm>
- <primary>int2</primary>
- <see>smallint</see>
- </indexterm>
-
- <indexterm>
- <primary>int8</primary>
- <see>bigint</see>
- </indexterm>
-
- <indexterm zone="datatype-numeric">
- <primary>numeric (data type)</primary>
- </indexterm>
-
- <indexterm>
- <primary>decimal</primary>
- <see>numeric</see>
- </indexterm>
-
- <indexterm zone="datatype-numeric">
- <primary>real</primary>
- </indexterm>
-
- <indexterm zone="datatype-numeric">
- <primary>double precision</primary>
- </indexterm>
-
- <indexterm>
- <primary>float4</primary>
- <see>real</see>
- </indexterm>
-
- <indexterm>
- <primary>float8</primary>
- <see>double precision</see>
- </indexterm>
-
- <indexterm zone="datatype-numeric">
- <primary>floating point</primary>
- </indexterm>
-
<para>
Numeric types consist of two-, four-, and eight-byte integers,
four- and eight-byte floating-point numbers, and fixed-precision
<sect2 id="datatype-int">
<title>Integer Types</title>
+ <indexterm zone="datatype-int">
+ <primary>integer</primary>
+ </indexterm>
+
+ <indexterm zone="datatype-int">
+ <primary>smallint</primary>
+ </indexterm>
+
+ <indexterm zone="datatype-int">
+ <primary>bigint</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>int4</primary>
+ <see>integer</see>
+ </indexterm>
+
+ <indexterm>
+ <primary>int2</primary>
+ <see>smallint</see>
+ </indexterm>
+
+ <indexterm>
+ <primary>int8</primary>
+ <see>bigint</see>
+ </indexterm>
+
<para>
The types <type>smallint</type>, <type>integer</type>, and
<type>bigint</type> store whole numbers, that is, numbers without
<sect2 id="datatype-numeric-decimal">
<title>Arbitrary Precision Numbers</title>
+ <indexterm zone="datatype-numeric-decimal">
+ <primary>numeric (data type)</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>decimal</primary>
+ <see>numeric</see>
+ </indexterm>
+
<para>
The type <type>numeric</type> can store numbers with up to 1000
digits of precision and perform calculations exactly. It is
<sect2 id="datatype-float">
<title>Floating-Point Types</title>
+ <indexterm zone="datatype-float">
+ <primary>real</primary>
+ </indexterm>
+
+ <indexterm zone="datatype-float">
+ <primary>double precision</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>float4</primary>
+ <see>real</see>
+ </indexterm>
+
+ <indexterm>
+ <primary>float8</primary>
+ <see>double precision</see>
+ </indexterm>
+
+ <indexterm zone="datatype-float">
+ <primary>floating point</primary>
+ </indexterm>
+
<para>
The data types <type>real</type> and <type>double
precision</type> are inexact, variable-precision numeric types.
</indexterm>
<indexterm>
- <primary>sequences</primary>
+ <primary>sequence</primary>
<secondary>and serial type</secondary>
</indexterm>
<title>Character Types</title>
<indexterm zone="datatype-character">
- <primary>character strings</primary>
+ <primary>character string</primary>
<secondary>data types</secondary>
</indexterm>
<indexterm>
- <primary>strings</primary>
- <see>character strings</see>
+ <primary>string</primary>
+ <see>character string</see>
</indexterm>
- <indexterm>
+ <indexterm zone="datatype-character">
+ <primary>character</primary>
+ </indexterm>
+
+ <indexterm zone="datatype-character">
+ <primary>character varying</primary>
+ </indexterm>
+
+ <indexterm zone="datatype-character">
<primary>text</primary>
- <see>character strings</see>
+ </indexterm>
+
+ <indexterm zone="datatype-character">
+ <primary>char</primary>
+ </indexterm>
+
+ <indexterm zone="datatype-character">
+ <primary>varchar</primary>
</indexterm>
<table id="datatype-character-table">
<sect1 id="datatype-binary">
<title>Binary Data Types</title>
+
+ <indexterm zone="datatype-binary">
+ <primary>binary data</primary>
+ </indexterm>
+
+ <indexterm zone="datatype-binary">
+ <primary>bytea</primary>
+ </indexterm>
+
<para>
The <type>bytea</type> data type allows storage of binary strings;
see <xref linkend="datatype-binary-table">.
<sect1 id="datatype-datetime">
<title>Date/Time Types</title>
+ <indexterm zone="datatype-datetime">
+ <primary>date</primary>
+ </indexterm>
+ <indexterm zone="datatype-datetime">
+ <primary>time</primary>
+ </indexterm>
+ <indexterm zone="datatype-datetime">
+ <primary>time without time zone</primary>
+ </indexterm>
+ <indexterm zone="datatype-datetime">
+ <primary>time with time zone</primary>
+ </indexterm>
+ <indexterm zone="datatype-datetime">
+ <primary>timestamp</primary>
+ </indexterm>
+ <indexterm zone="datatype-datetime">
+ <primary>timestamp with time zone</primary>
+ </indexterm>
+ <indexterm zone="datatype-datetime">
+ <primary>timestamp without time zone</primary>
+ </indexterm>
+ <indexterm zone="datatype-datetime">
+ <primary>interval</primary>
+ </indexterm>
+ <indexterm zone="datatype-datetime">
+ <primary>time span</primary>
+ </indexterm>
+
<para>
<productname>PostgreSQL</productname> supports the full set of
<acronym>SQL</acronym> date and time types, shown in <xref
<indexterm>
<primary>date</primary>
- <secondary>data type</secondary>
</indexterm>
<para>
<indexterm>
<primary>time</primary>
- <secondary>data type</secondary>
</indexterm>
<indexterm>
<primary>time without time zone</primary>
- <secondary>time</secondary>
</indexterm>
<indexterm>
<primary>time with time zone</primary>
- <secondary>data type</secondary>
</indexterm>
<para>
<indexterm>
<primary>timestamp</primary>
- <secondary>data type</secondary>
</indexterm>
<indexterm>
<primary>timestamp with time zone</primary>
- <secondary>data type</secondary>
</indexterm>
<indexterm>
<primary>timestamp without time zone</primary>
- <secondary>data type</secondary>
</indexterm>
<para>
<indexterm>
<primary>date</primary>
<secondary>output format</secondary>
- <seealso>Formatting</seealso>
+ <seealso>formatting</seealso>
</indexterm>
<indexterm>
<primary>time</primary>
<secondary>output format</secondary>
- <seealso>Formatting</seealso>
+ <seealso>formatting</seealso>
</indexterm>
<para>
<title>Time Zones</title>
<indexterm zone="datatype-timezones">
- <primary>time zones</primary>
+ <primary>time zone</primary>
</indexterm>
<para>
<title>Line Segments</title>
<indexterm>
- <primary>line</primary>
+ <primary>lseg</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>line segment</primary>
</indexterm>
<para>
<primary>box (data type)</primary>
</indexterm>
+ <indexterm>
+ <primary>rectangle</primary>
+ </indexterm>
+
<para>
Boxes are represented by pairs of points that are opposite
corners of the box.
<indexterm zone="datatype-net-types">
<primary>network</primary>
- <secondary>addresses</secondary>
+ <secondary>data types</secondary>
</indexterm>
<para>
<title>Bit String Types</title>
<indexterm zone="datatype-bit">
- <primary>bit strings</primary>
+ <primary>bit string</primary>
<secondary>data type</secondary>
</indexterm>
</thead>
<tbody>
- <row>
- <entry><type>record</></entry>
- <entry>Identifies a function returning an unspecified row type.</entry>
- </row>
-
<row>
<entry><type>any</></entry>
<entry>Indicates that a function accepts any input data type whatever.</entry>
<row>
<entry><type>anyarray</></entry>
<entry>Indicates that a function accepts any array data type
- (see <xref linkend="types-polymorphic">).</entry>
+ (see <xref linkend="extend-types-polymorphic">).</entry>
</row>
<row>
<entry><type>anyelement</></entry>
<entry>Indicates that a function accepts any data type
- (see <xref linkend="types-polymorphic">).</entry>
+ (see <xref linkend="extend-types-polymorphic">).</entry>
</row>
<row>
- <entry><type>void</></entry>
- <entry>Indicates that a function returns no value.</entry>
+ <entry><type>cstring</></entry>
+ <entry>Indicates that a function accepts or returns a null-terminated C string.</entry>
</row>
<row>
- <entry><type>trigger</></entry>
- <entry>A trigger function is declared to return <type>trigger.</></entry>
+ <entry><type>internal</></entry>
+ <entry>Indicates that a function accepts or returns a server-internal
+ data type.</entry>
</row>
<row>
</row>
<row>
- <entry><type>cstring</></entry>
- <entry>Indicates that a function accepts or returns a null-terminated C string.</entry>
+ <entry><type>record</></entry>
+ <entry>Identifies a function returning an unspecified row type.</entry>
</row>
<row>
- <entry><type>internal</></entry>
- <entry>Indicates that a function accepts or returns a server-internal
- data type.</entry>
+ <entry><type>trigger</></entry>
+ <entry>A trigger function is declared to return <type>trigger.</></entry>
+ </row>
+
+ <row>
+ <entry><type>void</></entry>
+ <entry>Indicates that a function returns no value.</entry>
</row>
<row>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/datetime.sgml,v 2.33 2003/08/25 23:30:25 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/datetime.sgml,v 2.34 2003/08/31 17:32:18 petere Exp $
-->
<appendix id="datetime-appendix">
</para>
<indexterm>
- <primary>time zones</primary>
+ <primary>time zone</primary>
+ <secondary>abbreviations</secondary>
</indexterm>
<para>
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ddl.sgml,v 1.17 2003/08/14 23:13:27 tgl Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ddl.sgml,v 1.18 2003/08/31 17:32:18 petere Exp $ -->
<chapter id="ddl">
<title>Data Definition</title>
<sect1 id="ddl-basics">
<title>Table Basics</title>
+ <indexterm zone="ddl-basics">
+ <primary>table</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>row</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>column</primary>
+ </indexterm>
+
<para>
A table in a relational database is much like a table on paper: It
consists of rows and columns. The number and order of the columns
containing both date and time.
</para>
+ <indexterm>
+ <primary>table</primary>
+ <secondary>creating</secondary>
+ </indexterm>
+
<para>
To create a table, you use the aptly named <literal>CREATE
TABLE</literal> command. In this command you specify at least a
highly unusual and often a questionable design.
</para>
+ <indexterm>
+ <primary>table</primary>
+ <secondary>removing</secondary>
+ </indexterm>
+
<para>
If you no longer need a table, you can remove it using the
<command>DROP TABLE</command> command. For example:
</para>
<indexterm>
- <primary>columns</primary>
- <secondary>system columns</secondary>
+ <primary>column</primary>
+ <secondary>system column</secondary>
</indexterm>
<variablelist>
<para>
<indexterm>
<primary>OID</primary>
+ <secondary>column</secondary>
</indexterm>
The object identifier (object ID) of a row. This is a serial
number that is automatically added by
<varlistentry>
<term><structfield>tableoid</></term>
<listitem>
+ <indexterm>
+ <primary>tableoid</primary>
+ </indexterm>
+
<para>
The OID of the table containing this row. This column is
particularly handy for queries that select from inheritance
<varlistentry>
<term><structfield>xmin</></term>
<listitem>
+ <indexterm>
+ <primary>xmin</primary>
+ </indexterm>
+
<para>
The identity (transaction ID) of the inserting transaction for
this tuple. (Note: In this context, a tuple is an individual
<varlistentry>
<term><structfield>cmin</></term>
<listitem>
+ <indexterm>
+ <primary>cmin</primary>
+ </indexterm>
+
<para>
The command identifier (starting at zero) within the inserting
transaction.
<varlistentry>
<term><structfield>xmax</></term>
<listitem>
+ <indexterm>
+ <primary>xmax</primary>
+ </indexterm>
+
<para>
The identity (transaction ID) of the deleting transaction, or
zero for an undeleted tuple. It is possible for this column to
<varlistentry>
<term><structfield>cmax</></term>
<listitem>
+ <indexterm>
+ <primary>cmax</primary>
+ </indexterm>
+
<para>
The command identifier within the deleting transaction, or zero.
</para>
<varlistentry>
<term><structfield>ctid</></term>
<listitem>
+ <indexterm>
+ <primary>ctid</primary>
+ </indexterm>
+
<para>
The physical location of the tuple within its table. Note that
although the <structfield>ctid</structfield> can be used to
<sect1 id="ddl-default">
<title>Default Values</title>
+ <indexterm zone="ddl-default">
+ <primary>default value</primary>
+ </indexterm>
+
<para>
A column can be assigned a default value. When a new row is
created and no values are specified for some of the columns, the
</para>
<para>
+ <indexterm><primary>null value</primary><secondary>default value</secondary></indexterm>
If no default value is declared explicitly, the null value is the
default value. This usually makes sense because a null value can
be thought to represent unknown data.
<sect1 id="ddl-constraints">
<title>Constraints</title>
+ <indexterm zone="ddl-constraints">
+ <primary>constraint</primary>
+ </indexterm>
+
<para>
Data types are a way to limit the kind of data that can be stored
in a table. For many applications, however, the constraint they
<sect2>
<title>Check Constraints</title>
+ <indexterm>
+ <primary>check constraint</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>constraint</primary>
+ <secondary>check</secondary>
+ </indexterm>
+
<para>
A check constraint is the most generic constraint type. It allows
you to specify that the value in a certain column must satisfy an
would not make too much sense.
</para>
+ <indexterm>
+ <primary>constraint</primary>
+ <secondary>name</secondary>
+ </indexterm>
+
<para>
You can also give the constraint a separate name. This clarifies
error messages and allows you to refer to the constraint when you
It's a matter of taste.
</para>
+ <indexterm>
+ <primary>null value</primary>
+ <secondary sortas="check constraints">with check constraints</secondary>
+ </indexterm>
+
<para>
It should be noted that a check constraint is satisfied if the
check expression evaluates to true or the null value. Since most
<sect2>
<title>Not-Null Constraints</title>
+ <indexterm>
+ <primary>not-null constraint</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>constraint</primary>
+ <secondary>NOT NULL</secondary>
+ </indexterm>
+
<para>
A not-null constraint simply specifies that a column must not
assume the null value. A syntax example:
<sect2>
<title>Unique Constraints</title>
+ <indexterm>
+ <primary>unique constraint</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>constraint</primary>
+ <secondary>unique</secondary>
+ </indexterm>
+
<para>
Unique constraints ensure that the data contained in a column or a
group of columns is unique with respect to all the rows in the
</programlisting>
</para>
+ <indexterm>
+ <primary>null value</primary>
+ <secondary sortas="unique constraints">with unique constraints</secondary>
+ </indexterm>
+
<para>
In general, a unique constraint is violated when there are (at
least) two rows in the table where the values of each of the
<sect2>
<title>Primary Keys</title>
+ <indexterm>
+ <primary>primary key</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>constraint</primary>
+ <secondary>primary key</secondary>
+ </indexterm>
+
<para>
Technically, a primary key constraint is simply a combination of a
unique constraint and a not-null constraint. So, the following
<sect2 id="ddl-constraints-fk">
<title>Foreign Keys</title>
+ <indexterm>
+ <primary>foreign key</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>constraint</primary>
+ <secondary>foreign key</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>referential integrity</primary>
+ </indexterm>
+
<para>
A foreign key constraint specifies that the values in a column (or
a group of columns) must match the values appearing in some row
the last table.
</para>
+ <indexterm>
+ <primary>CASCADE</primary>
+ <secondary>foreign key action</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>RESTRICT</primary>
+ <secondary>foreign key action</secondary>
+ </indexterm>
+
<para>
We know that the foreign keys disallow creation of orders that
do not relate to any products. But what if a product is removed
<sect1 id="ddl-alter">
<title>Modifying Tables</title>
+ <indexterm zone="ddl-alter">
+ <primary>table</primary>
+ <secondary>modifying</secondary>
+ </indexterm>
+
<para>
When you create a table and you realize that you made a mistake, or
the requirements of the application changed, then you can drop the
<sect2>
<title>Adding a Column</title>
+ <indexterm>
+ <primary>column</primary>
+ <secondary>adding</secondary>
+ </indexterm>
+
<para>
To add a column, use this command:
<programlisting>
<sect2>
<title>Removing a Column</title>
+ <indexterm>
+ <primary>column</primary>
+ <secondary>removing</secondary>
+ </indexterm>
+
<para>
To remove a column, use this command:
<programlisting>
<sect2>
<title>Adding a Constraint</title>
+ <indexterm>
+ <primary>constraint</primary>
+ <secondary>adding</secondary>
+ </indexterm>
+
<para>
To add a constraint, the table constraint syntax is used. For example:
<programlisting>
<sect2>
<title>Removing a Constraint</title>
+ <indexterm>
+ <primary>constraint</primary>
+ <secondary>removing</secondary>
+ </indexterm>
+
<para>
To remove a constraint you need to know its name. If you gave it
a name then that's easy. Otherwise the system assigned a
<sect2>
<title>Changing the Default</title>
+ <indexterm>
+ <primary>default value</primary>
+ <secondary>changing</secondary>
+ </indexterm>
+
<para>
To set a new default for a column, use a command like this:
<programlisting>
<sect2>
<title>Renaming a Column</title>
+ <indexterm>
+ <primary>column</primary>
+ <secondary>renaming</secondary>
+ </indexterm>
+
<para>
To rename a column:
<programlisting>
<sect2>
<title>Renaming a Table</title>
+ <indexterm>
+ <primary>table</primary>
+ <secondary>renaming</secondary>
+ </indexterm>
+
<para>
To rename a table:
<programlisting>
<sect1 id="ddl-priv">
<title>Privileges</title>
+ <indexterm zone="ddl-priv">
+ <primary>privilege</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>permission</primary>
+ <see>privilege</see>
+ </indexterm>
+
<para>
When you create a database object, you become its owner. By
default, only the owner of an object can do anything with the
<sect1 id="ddl-schemas">
<title>Schemas</title>
- <indexterm>
- <primary>schemas</primary>
- </indexterm>
-
- <indexterm>
- <primary>namespaces</primary>
+ <indexterm zone="ddl-schemas">
+ <primary>schema</primary>
</indexterm>
<para>
<sect2 id="ddl-schemas-create">
<title>Creating a Schema</title>
+ <indexterm zone="ddl-schemas-create">
+ <primary>schema</primary>
+ <secondary>creating</secondary>
+ </indexterm>
+
<para>
To create a separate schema, use the command <literal>CREATE
SCHEMA</literal>. Give the schema a name of your choice. For
</para>
<indexterm>
- <primary>qualified names</primary>
+ <primary>qualified name</primary>
</indexterm>
<indexterm>
- <primary>names</primary>
+ <primary>name</primary>
<secondary>qualified</secondary>
</indexterm>
the following chapters.
</para>
+ <indexterm>
+ <primary>schema</primary>
+ <secondary>removing</secondary>
+ </indexterm>
+
<para>
To drop a schema if it's empty (all objects in it have been
dropped), use
<sect2 id="ddl-schemas-public">
<title>The Public Schema</title>
+ <indexterm zone="ddl-schemas-public">
+ <primary>schema</primary>
+ <secondary>public</secondary>
+ </indexterm>
+
<para>
In the previous sections we created tables without specifying any
schema names. By default, such tables (and other objects) are
</indexterm>
<indexterm>
- <primary>unqualified names</primary>
+ <primary>unqualified name</primary>
</indexterm>
<indexterm>
- <primary>names</primary>
+ <primary>name</primary>
<secondary>unqualified</secondary>
</indexterm>
in other schemas in the database.
</para>
+ <indexterm>
+ <primary>schema</primary>
+ <secondary>current</secondary>
+ </indexterm>
+
<para>
The first schema named in the search path is called the current schema.
Aside from being the first schema searched, it is also the schema in
command does not specify a schema name.
</para>
+ <indexterm>
+ <primary>search_path</primary>
+ </indexterm>
+
<para>
To show the current search path, use the following command:
<programlisting>
<sect2 id="ddl-schemas-priv">
<title>Schemas and Privileges</title>
+ <indexterm zone="ddl-schemas-priv">
+ <primary>privilege</primary>
+ <secondary sortas="schemas">for schemas</secondary>
+ </indexterm>
+
<para>
By default, users cannot see the objects in schemas they do not
own. To allow that, the owner of the schema needs to grant the
</para>
</sect2>
- <sect2>
+ <sect2 id="ddl-schemas-catalog">
<title>The System Catalog Schema</title>
+ <indexterm zone="ddl-schemas-catalog">
+ <primary>system catalog</primary>
+ <secondary>schema</secondary>
+ </indexterm>
+
<para>
In addition to <literal>public</> and user-created schemas, each
database contains a <literal>pg_catalog</> schema, which contains
<sect1 id="ddl-depend">
<title>Dependency Tracking</title>
+ <indexterm zone="ddl-depend">
+ <primary>CASCADE</primary>
+ <secondary sortas="DROP">with DROP</secondary>
+ </indexterm>
+
+ <indexterm zone="ddl-depend">
+ <primary>RESTRICT</primary>
+ <secondary sortas="DROP">with DROP</secondary>
+ </indexterm>
+
<para>
When you create complex database structures involving many tables
with foreign key constraints, views, triggers, functions, etc. you
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/dfunc.sgml,v 1.25 2003/04/10 01:22:44 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/dfunc.sgml,v 1.26 2003/08/31 17:32:18 petere Exp $
-->
<sect2 id="dfunc">
<para>
Before you are able to use your
<productname>PostgreSQL</productname> extension functions written in
- C, they must be compiled and linked in a special way to produce a file
- that can be dynamically loaded by the server. To be
- precise, a <firstterm>shared library</firstterm> needs to be created.
+ C, they must be compiled and linked in a special way to produce a
+ file that can be dynamically loaded by the server. To be precise, a
+ <firstterm>shared library</firstterm> needs to be
+ created.<indexterm><primary>shared library</></indexterm>
+
</para>
<para>
</para>
<para>
- <indexterm><primary>PIC</></>
- Creating shared libraries is generally analogous to linking
- executables: first the source files are compiled into object files,
- then the object files are linked together. The object files need to
- be created as <firstterm>position-independent code</firstterm>
- (<acronym>PIC</acronym>), which conceptually means that they can be
- placed at an arbitrary location in memory when they are loaded by the
- executable. (Object files intended for executables are usually not compiled
- that way.) The command to link a shared library contains special
- flags to distinguish it from linking an executable. --- At least
- this is the theory. On some systems the practice is much uglier.
+ <indexterm><primary>PIC</></> Creating shared libraries is generally
+ analogous to linking executables: first the source files are
+ compiled into object files, then the object files are linked
+ together. The object files need to be created as
+ <firstterm>position-independent code</firstterm>
+ (<acronym>PIC</acronym>),<indexterm><primary>PIC</></> which
+ conceptually means that they can be placed at an arbitrary location
+ in memory when they are loaded by the executable. (Object files
+ intended for executables are usually not compiled that way.) The
+ command to link a shared library contains special flags to
+ distinguish it from linking an executable. --- At least this is the
+ theory. On some systems the practice is much uglier.
</para>
<para>
<variablelist>
<varlistentry>
<term><systemitem class="osname">BSD/OS</></term>
- <indexterm><primary>BSD/OS</></>
+ <indexterm><primary>BSD/OS</><secondary>shared library</></>
<listitem>
<para>
The compiler flag to create <acronym>PIC</acronym> is
<varlistentry>
<term><systemitem class="osname">FreeBSD</></term>
- <indexterm><primary>FreeBSD</></>
+ <indexterm><primary>FreeBSD</><secondary>shared library</></>
<listitem>
<para>
The compiler flag to create <acronym>PIC</acronym> is
<varlistentry>
<term><systemitem class="osname">HP-UX</></term>
- <indexterm><primary>HP-UX</></>
+ <indexterm><primary>HP-UX</><secondary>shared library</></>
<listitem>
<para>
The compiler flag of the system compiler to create
<varlistentry>
<term><systemitem class="osname">IRIX</></term>
- <indexterm><primary>IRIX</></>
+ <indexterm><primary>IRIX</><secondary>shared library</></>
<listitem>
<para>
<acronym>PIC</acronym> is the default, no special compiler
<varlistentry>
<term><systemitem class="osname">Linux</></term>
- <indexterm><primary>Linux</></>
+ <indexterm><primary>Linux</><secondary>shared library</></>
<listitem>
<para>
The compiler flag to create <acronym>PIC</acronym> is
<varlistentry>
<term><systemitem class="osname">MacOS X</></term>
- <indexterm><primary>MacOS X</></>
+ <indexterm><primary>MacOS X</><secondary>shared library</></>
<listitem>
<para>
Here is an example. It assumes the developer tools are installed.
<varlistentry>
<term><systemitem class="osname">NetBSD</></term>
- <indexterm><primary>NetBSD</></>
+ <indexterm><primary>NetBSD</><secondary>shared library</></>
<listitem>
<para>
The compiler flag to create <acronym>PIC</acronym> is
<varlistentry>
<term><systemitem class="osname">OpenBSD</></term>
- <indexterm><primary>OpenBSD</></>
+ <indexterm><primary>OpenBSD</><secondary>shared library</></>
<listitem>
<para>
The compiler flag to create <acronym>PIC</acronym> is
<varlistentry>
<term><systemitem class="osname">Solaris</></term>
- <indexterm><primary>Solaris</></>
+ <indexterm><primary>Solaris</><secondary>shared library</></>
<listitem>
<para>
The compiler flag to create <acronym>PIC</acronym> is
<varlistentry>
<term><systemitem class="osname">Tru64 UNIX</></term>
- <indexterm><primary>Tru64 UNIX</></>
+ <indexterm><primary>Tru64 UNIX</><secondary>shared library</></>
<indexterm><primary>Digital UNIX</><see>Tru64 UNIX</></>
<listitem>
<para>
<varlistentry>
<term><systemitem class="osname">UnixWare</></term>
- <indexterm><primary>UnixWare</></>
+ <indexterm><primary>UnixWare</><secondary>shared library</></>
<listitem>
<para>
The compiler flag to create <acronym>PIC</acronym> is <option>-K
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/dml.sgml,v 1.5 2003/08/10 01:20:34 tgl Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/dml.sgml,v 1.6 2003/08/31 17:32:18 petere Exp $ -->
<chapter id="dml">
<title>Data Manipulation</title>
<sect1 id="dml-insert">
<title>Inserting Data</title>
+ <indexterm zone="dml-insert">
+ <primary>inserting</primary>
+ </indexterm>
+
+ <indexterm zone="dml-insert">
+ <primary>INSERT</primary>
+ </indexterm>
+
<para>
When a table is created, it contains no data. The first thing to
do before a database can be of much use is to insert data. Data is
<sect1 id="dml-update">
<title>Updating Data</title>
+ <indexterm zone="dml-update">
+ <primary>updating</primary>
+ </indexterm>
+
+ <indexterm zone="dml-update">
+ <primary>UPDATE</primary>
+ </indexterm>
+
<para>
The modification of data that is already in the database is
referred to as updating. You can update individual rows, all the
<sect1 id="dml-delete">
<title>Deleting Data</title>
+ <indexterm zone="dml-delete">
+ <primary>deleting</primary>
+ </indexterm>
+
+ <indexterm zone="dml-delete">
+ <primary>DELETE</primary>
+ </indexterm>
+
<para>
So far we have explained how to add data to tables and how to
change data. What remains is to discuss how to remove data that is
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ecpg.sgml,v 1.48 2003/08/07 04:17:21 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ecpg.sgml,v 1.49 2003/08/31 17:32:18 petere Exp $
-->
<chapter id="ecpg">
<title><application>ECPG</application> - Embedded <acronym>SQL</acronym> in C</title>
<indexterm zone="ecpg"><primary>embedded SQL</primary><secondary>in C</secondary></indexterm>
+ <indexterm zone="ecpg"><primary>C</primary></indexterm>
+ <indexterm zone="ecpg"><primary>ECPG</primary></indexterm>
<para>
This chapter describes the embedded <acronym>SQL</acronym> package
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/extend.sgml,v 1.23 2003/08/09 22:50:21 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/extend.sgml,v 1.24 2003/08/31 17:32:18 petere Exp $
-->
<chapter id="extend">
</para>
</sect1>
- <sect1 id="type-system">
+ <sect1 id="extend-type-system">
<title>The <productname>PostgreSQL</productname> Type System</title>
- <indexterm zone="type-system">
- <primary>extending SQL</primary>
- <secondary>types</secondary>
+ <indexterm zone="extend-type-system">
+ <primary>base type</primary>
+ </indexterm>
+
+ <indexterm zone="extend-type-system">
+ <primary>data type</primary>
+ <secondary>base</secondary>
+ </indexterm>
+
+ <indexterm zone="extend-type-system">
+ <primary>composite type</primary>
</indexterm>
- <indexterm zone="type-system">
- <primary>data types</primary>
+ <indexterm zone="extend-type-system">
+ <primary>data type</primary>
+ <secondary>composite</secondary>
</indexterm>
<para>
pseudo-types.
</para>
- <sect2 id="types-polymorphic">
+ <sect2 id="extend-types-polymorphic">
<title>Polymorphic Types and Functions</title>
- <indexterm>
- <primary>polymorphic types</primary>
+ <indexterm zone="extend-types-polymorphic">
+ <primary>polymorphic type</primary>
+ </indexterm>
+
+ <indexterm zone="extend-types-polymorphic">
+ <primary>polymorphic function</primary>
+ </indexterm>
+
+ <indexterm zone="extend-types-polymorphic">
+ <primary>type</primary>
+ <secondary>polymorphic</secondary>
</indexterm>
- <indexterm>
- <primary>polymorphic functions</primary>
+ <indexterm zone="extend-types-polymorphic">
+ <primary>function</primary>
+ <secondary>polymorphic</secondary>
</indexterm>
<para>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/func.sgml,v 1.168 2003/08/19 06:06:43 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/func.sgml,v 1.169 2003/08/31 17:32:18 petere Exp $
PostgreSQL documentation
-->
<title>Functions and Operators</title>
<indexterm zone="functions">
- <primary>functions</primary>
+ <primary>function</primary>
</indexterm>
<indexterm zone="functions">
- <primary>operators</primary>
+ <primary>operator</primary>
</indexterm>
<para>
<title>Logical Operators</title>
<indexterm zone="functions-logical">
- <primary>operators</primary>
+ <primary>operator</primary>
<secondary>logical</secondary>
</indexterm>
The usual logical operators are available:
<indexterm>
- <primary>and</primary>
- <secondary>operator</secondary>
+ <primary>AND (operator)</primary>
</indexterm>
<indexterm>
- <primary>or</primary>
- <secondary>operator</secondary>
+ <primary>OR (operator)</primary>
</indexterm>
<indexterm>
- <primary>not</primary>
- <secondary>operator</secondary>
+ <primary>NOT (operator)</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>conjunction</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>disjunction</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>negation</primary>
</indexterm>
<simplelist>
<primary>between</primary>
</indexterm>
In addition to the comparison operators, the special
- <token>BETWEEN</token> construct is available.
+ <token>BETWEEN</token> construct is available.<indexterm><primary>BETWEEN</primary></indexterm>
<synopsis>
<replaceable>a</replaceable> BETWEEN <replaceable>x</replaceable> AND <replaceable>y</replaceable>
</synopsis>
<replaceable>expression</replaceable> ISNULL
<replaceable>expression</replaceable> NOTNULL
</synopsis>
+ <indexterm><primary>null value</primary><secondary>comparing</secondary></indexterm>
</para>
<para>
<entry>
String concatenation
<indexterm>
- <primary>character strings</primary>
+ <primary>character string</primary>
<secondary>concatenation</secondary>
</indexterm>
</entry>
<entry>
Number of characters in string
<indexterm>
- <primary>character strings</primary>
+ <primary>character string</primary>
<secondary>length</secondary>
</indexterm>
<indexterm>
<primary>length</primary>
- <secondary>character strings</secondary>
+ <secondary sortas="character string">of a character string</secondary>
<see>character strings, length</see>
</indexterm>
</entry>
<entry>
Number of characters in string
<indexterm>
- <primary>character strings</primary>
+ <primary>character string</primary>
<secondary>length</secondary>
</indexterm>
<indexterm>
<primary>length</primary>
- <secondary>character strings</secondary>
+ <secondary sortas="character string">of a character string</secondary>
<see>character strings, length</see>
</indexterm>
</entry>
</row>
<row>
- <entry><literal><function>quote_ident</function>(<parameter>string</parameter> text)</literal></entry>
+ <entry><literal><function>quote_ident</function>(<parameter>string</parameter> text)</literal><indexterm><primary>quote_ident</></></entry>
<entry><type>text</type></entry>
<entry>
Return the given string suitably quoted to be used as an identifier
</row>
<row>
- <entry><literal><function>quote_literal</function>(<parameter>string</parameter> text)</literal></entry>
+ <entry><literal><function>quote_literal</function>(<parameter>string</parameter> text)</literal><indexterm><primary>quote_literal</></></entry>
<entry><type>text</type></entry>
<entry>
Return the given string suitably quoted to be used as a string literal
<sect1 id="functions-binarystring">
<title>Binary String Functions and Operators</title>
+ <indexterm zone="functions-binarystring">
+ <primary>binary data</primary>
+ <secondary>functions</secondary>
+ </indexterm>
+
<para>
This section describes functions and operators for examining and
manipulating values of type <type>bytea</type>.
<entry>
String concatenation
<indexterm>
- <primary>binary strings</primary>
+ <primary>binary string</primary>
<secondary>concatenation</secondary>
</indexterm>
</entry>
<entry>
Length of binary string
<indexterm>
- <primary>binary strings</primary>
+ <primary>binary string</primary>
<secondary>length</secondary>
</indexterm>
<indexterm>
<primary>length</primary>
- <secondary>binary strings</secondary>
+ <secondary sortas="binary string">of a binary string</secondary>
<see>binary strings, length</see>
</indexterm>
</entry>
<sect2 id="functions-like">
<title><function>LIKE</function></title>
- <indexterm>
- <primary>like</primary>
+ <indexterm zone="functions-like">
+ <primary>LIKE</primary>
</indexterm>
<synopsis>
Regular Expressions</title>
<indexterm zone="functions-sql99-regexp">
- <primary>regular expressions</primary>
+ <primary>regular expression</primary>
<!-- <seealso>pattern matching</seealso> breaks index build -->
</indexterm>
<indexterm>
- <primary>similar to</primary>
+ <primary>SIMILAR TO</primary>
</indexterm>
<indexterm>
<title><acronym>POSIX</acronym> Regular Expressions</title>
<indexterm zone="functions-posix-regexp">
- <primary>regular expressions</primary>
+ <primary>regular expression</primary>
<seealso>pattern matching</seealso>
</indexterm>
<primary>formatting</primary>
</indexterm>
+ <indexterm zone="functions-formatting">
+ <primary>to_char</primary>
+ </indexterm>
+
<para>
The <productname>PostgreSQL</productname> formatting functions
provide a powerful set of tools for converting various data types
<title>Sequence-Manipulation Functions</title>
<indexterm>
- <primary>sequences</primary>
+ <primary>sequence</primary>
</indexterm>
<indexterm>
<primary>nextval</primary>
<title>Conditional Expressions</title>
<indexterm>
- <primary>case</primary>
+ <primary>CASE</primary>
</indexterm>
<indexterm>
- <primary>conditionals</primary>
+ <primary>conditional expression</primary>
</indexterm>
<para>
<sect2>
<title><literal>COALESCE</></title>
+ <indexterm>
+ <primary>COALESCE</primary>
+ </indexterm>
+
<synopsis>
-<function>COALESCE</function>(<replaceable>value</replaceable> <optional>, ...</optional>)
+<function>coalesce</function>(<replaceable>value</replaceable> <optional>, ...</optional>)
</synopsis>
<para>
<indexterm zone="functions-misc">
<primary>configuration</primary>
- <secondary>server</secondary>
+ <secondary sortas="server">of the server</secondary>
+ <tertiary>functions</tertiary>
</indexterm>
<para>
</programlisting>
</para>
+ <indexterm>
+ <primary>privilege</primary>
+ <secondary>querying</secondary>
+ </indexterm>
+
<para>
<xref linkend="functions-misc-access-table"> lists functions that
allow the user to query object access privileges programmatically.
<primary>col_description</primary>
</indexterm>
+ <indexterm zone="functions-misc">
+ <primary>comment</primary>
+ <secondary sortas="database objects">about database objects</secondary>
+ </indexterm>
+
<para>
The function shown in <xref
linkend="functions-misc-comment-table"> extract comments
<sect1 id="functions-aggregate">
<title>Aggregate Functions</title>
+ <indexterm zone="functions-aggregate">
+ <primary>aggregate function</primary>
+ <secondary>built-in</secondary>
+ </indexterm>
+
<para>
<firstterm>Aggregate functions</firstterm> compute a single result
value from a set of input values. <xref
<entry>
<indexterm>
<primary>average</primary>
- <secondary>function</secondary>
</indexterm>
<function>avg(<replaceable class="parameter">expression</replaceable>)</function>
</entry>
<title>Subquery Expressions</title>
<indexterm>
- <primary>exists</primary>
+ <primary>EXISTS</primary>
</indexterm>
<indexterm>
- <primary>in</primary>
+ <primary>IN</primary>
</indexterm>
<indexterm>
- <primary>not in</primary>
+ <primary>NOT IN</primary>
</indexterm>
<indexterm>
- <primary>any</primary>
+ <primary>ANY</primary>
</indexterm>
<indexterm>
- <primary>all</primary>
+ <primary>ALL</primary>
</indexterm>
<indexterm>
- <primary>some</primary>
+ <primary>SOME</primary>
</indexterm>
<indexterm>
- <primary>subqueries</primary>
+ <primary>subquery</primary>
</indexterm>
<para>
<sect2>
<title>Row-wise Comparison</title>
+ <indexterm>
+ <primary>comparison</primary>
+ <secondary>of rows</secondary>
+ </indexterm>
+
<synopsis>
(<replaceable>expression</replaceable> <optional>, <replaceable>expression</replaceable> ...</optional>) <replaceable>operator</replaceable> (<replaceable>subquery</replaceable>)
</synopsis>
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/indices.sgml,v 1.42 2003/05/28 16:03:55 tgl Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/indices.sgml,v 1.43 2003/08/31 17:32:19 petere Exp $ -->
<chapter id="indexes">
<title id="indexes-title">Indexes</title>
<indexterm zone="indexes">
- <primary>indexes</primary>
+ <primary>index</primary>
</indexterm>
<para>
B-tree, R-tree, GiST, and Hash. Each index type is more appropriate for
a particular query type because of the algorithm it uses.
<indexterm>
- <primary>indexes</primary>
+ <primary>index</primary>
<secondary>B-tree</secondary>
</indexterm>
<indexterm>
<primary>B-tree</primary>
- <see>indexes</see>
+ <see>index</see>
</indexterm>
By
default, the <command>CREATE INDEX</command> command will create a
<para>
<indexterm>
- <primary>indexes</primary>
+ <primary>index</primary>
<secondary>R-tree</secondary>
</indexterm>
<indexterm>
<primary>R-tree</primary>
- <see>indexes</see>
+ <see>index</see>
</indexterm>
R-tree indexes are especially suited for spatial data. To create
an R-tree index, use a command of the form
<para>
<indexterm>
- <primary>indexes</primary>
+ <primary>index</primary>
<secondary>hash</secondary>
</indexterm>
<indexterm>
<primary>hash</primary>
- <see>indexes</see>
+ <see>index</see>
</indexterm>
The query planner will consider using a hash index whenever an
indexed column is involved in a comparison using the
<title>Multicolumn Indexes</title>
<indexterm zone="indexes-multicolumn">
- <primary>indexes</primary>
+ <primary>index</primary>
<secondary>multicolumn</secondary>
</indexterm>
<title>Unique Indexes</title>
<indexterm zone="indexes-unique">
- <primary>indexes</primary>
+ <primary>index</primary>
<secondary>unique</secondary>
</indexterm>
<title>Indexes on Expressions</title>
<indexterm zone="indexes-expressional">
- <primary>indexes</primary>
- <secondary>on expressions</secondary>
+ <primary>index</primary>
+ <secondary sortas="expressions">on expressions</secondary>
</indexterm>
<para>
<sect1 id="indexes-opclass">
<title>Operator Classes</title>
+ <indexterm zone="indexes-opclass">
+ <primary>operator class</primary>
+ </indexterm>
+
<para>
An index definition may specify an <firstterm>operator
class</firstterm> for each column of an index.
<title>Partial Indexes</title>
<indexterm zone="indexes-partial">
- <primary>indexes</primary>
+ <primary>index</primary>
<secondary>partial</secondary>
</indexterm>
<sect1 id="indexes-examine">
<title>Examining Index Usage</title>
+ <indexterm zone="indexes-examine">
+ <primary>index</primary>
+ <secondary>examining usage</secondary>
+ </indexterm>
+
<para>
Although indexes in <productname>PostgreSQL</> do not need
maintenance and tuning, it is still important to check
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/installation.sgml,v 1.138 2003/08/04 04:03:03 tgl Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/installation.sgml,v 1.139 2003/08/31 17:32:19 petere Exp $ -->
<chapter id="installation">
<title><![%standalone-include[<productname>PostgreSQL</>]]>
<para>
<indexterm>
<primary>pg_dumpall</primary>
+ <secondary>use during upgrade</secondary>
</indexterm>
To back up your database installation, type:
<term><option>--with-pam</option></term>
<listitem>
<para>
- Build with <acronym>PAM</> (Pluggable Authentication Modules)
- support.
+ Build with <acronym>PAM</><indexterm><primary>PAM</></>
+ (Pluggable Authentication Modules) support.
</para>
</listitem>
</varlistentry>
<title>Shared Libraries</title>
<indexterm>
- <primary>shared libraries</primary>
+ <primary>shared library</primary>
</indexterm>
<para>
<para>
<indexterm>
<primary><envar>MANPATH</envar></primary>
- <seealso>man pages</seealso>
</indexterm>
To enable your system to find the <application>man</>
documentation, you need to add lines like the following to a
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/Attic/jdbc.sgml,v 1.47 2003/08/07 05:06:40 barry Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/Attic/jdbc.sgml,v 1.48 2003/08/31 17:32:19 petere Exp $
-->
<chapter id="jdbc">
<title><acronym>JDBC</acronym> Interface</title>
+ <indexterm zone="jdbc">
+ <primary>JDBC</primary>
+ </indexterm>
+
+ <indexterm zone="jdbc">
+ <primary>Java</primary>
+ </indexterm>
+
<para>
<acronym>JDBC</acronym> is a core <acronym>API</acronym> of Java 1.1 and later.
It provides a standard set of
<sect2 id="jdbc-classpath">
<title>Setting up the Class Path</title>
+ <indexterm zone="jdbc-classpath">
+ <primary>class path</primary>
+ </indexterm>
+
+ <indexterm zone="jdbc-classpath">
+ <primary>CLASSPATH</primary>
+ </indexterm>
+
<para>
To use the driver, the JAR archive (named
<filename>postgresql.jar</filename> if you built from source, otherwise
<sect1 id="jdbc-query">
<title>Issuing a Query and Processing the Result</title>
+ <indexterm zone="jdbc-query">
+ <primary>Statement</primary>
+ </indexterm>
+
+ <indexterm zone="jdbc-query">
+ <primary>PreparedStatement</primary>
+ </indexterm>
+
+ <indexterm zone="jdbc-query">
+ <primary>ResultSet</primary>
+ </indexterm>
+
<para>
Any time you want to issue <acronym>SQL</acronym> statements to
the database, you require a <classname>Statement</classname> or
<sect1 id="jdbc-binary-data">
<title>Storing Binary Data</title>
+ <indexterm zone="jdbc-binary-data">
+ <primary>bytea</primary>
+ <secondary sortas="JDBC">in JDBC</secondary>
+ </indexterm>
+
+ <indexterm zone="jdbc-binary-data">
+ <primary>large object</primary>
+ <secondary sortas="JDBC">in JDBC</secondary>
+ </indexterm>
+
<para>
<application>PostgreSQL</application> provides two distinct ways to
store binary data. Binary data can be stored in a table using
<sect1 id="jdbc-thread">
<title>Using the Driver in a Multithreaded or a Servlet Environment</title>
+ <indexterm zone="jdbc-thread">
+ <primary>threads</primary>
+ <secondary sortas="JDBC">with JDBC</secondary>
+ </indexterm>
+
<para>
A problem with many <acronym>JDBC</acronym> drivers is that only
one thread can use a <classname>Connection</classname> at any one
<sect1 id="jdbc-datasource">
<title>Connection Pools and Data Sources</title>
+ <indexterm zone="jdbc-datasource">
+ <primary>connection pool</primary>
+ <secondary sortas="JDBC">in JDBC</secondary>
+ </indexterm>
+
+ <indexterm zone="jdbc-datasource">
+ <primary>DataSource</primary>
+ </indexterm>
+
<para>
<acronym>JDBC</> 2 introduced standard connection pooling features in an
add-on <acronym>API</> known as the <acronym>JDBC</acronym> 2.0 Optional
</sect2>
<sect2 id="jdbc-jndi">
- <title>Data Sources and <acronym>JNDI</acronym></title>
+ <title>Data Sources and <acronym>JNDI</acronym></title>
+
+ <indexterm zone="jdbc-jndi">
+ <primary>JNDI</primary>
+ </indexterm>
<para>
All the <literal>ConnectionPoolDataSource</literal> and
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/keywords.sgml,v 2.9 2003/06/12 07:49:43 momjian Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/keywords.sgml,v 2.10 2003/08/31 17:32:19 petere Exp $ -->
<appendix id="sql-keywords-appendix">
<title><acronym>SQL</acronym> Key Words</title>
<indexterm zone="sql-keywords-appendix">
- <primary>key words</primary>
+ <primary>key word</primary>
<secondary>list of</secondary>
</indexterm>
<para>
The <function>pg_lo_*</function> commands are interfaces to the
large object features of
- <ProductName>PostgreSQL</ProductName>.<indexterm><primary>Large
- Object</></> The functions are designed to mimic the analogous file
+ <ProductName>PostgreSQL</ProductName>.<indexterm><primary>large
+ object</><secondary>in pgctl</></> The functions are designed to mimic the analogous file
system functions in the standard Unix file system interface. The
<function>pg_lo_*</function> commands should be used within a
<command>BEGIN</command>/<command>COMMIT</command> transaction
message bearing the given name arrives from the server. This
occurs when any <productname>PostgreSQL</productname> client
application issues a
- <command>NOTIFY</command><indexterm><primary>NOTIFY</><secondary>in
- pgtcl</></> command referencing that name. The command string is
- executed from the Tcl idle loop. That is the normal idle state of
- an application written with Tk. In non-Tk Tcl shells, you can
- execute <function>update</function> or <function>vwait</function>
- to cause the idle loop to be entered.
+ <command>NOTIFY</command><indexterm><primary>NOTIFY</><secondary
+ sortas="pgtcl">in pgtcl</></> command referencing that name. The
+ command string is executed from the Tcl idle loop. That is the
+ normal idle state of an application written with Tk. In non-Tk Tcl
+ shells, you can execute <function>update</function> or
+ <function>vwait</function> to cause the idle loop to be entered.
</para>
<para>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/libpq.sgml,v 1.132 2003/08/24 18:36:38 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/libpq.sgml,v 1.133 2003/08/31 17:32:19 petere Exp $
-->
<chapter id="libpq">
<primary>libpq</primary>
</indexterm>
+ <indexterm zone="libpq">
+ <primary>C</primary>
+ </indexterm>
+
<para>
<application>libpq</application> is the <acronym>C</acronym>
application programmer's interface to
</para>
<para>
- Client programs that use <application>libpq</application> must include the
- header file <filename>libpq-fe.h</filename> and must link with the
- <application>libpq</application> library.
+ Client programs that use <application>libpq</application> must
+ include the header file
+ <filename>libpq-fe.h</filename><indexterm><primary>libpq-fe.h</></>
+ and must link with the <application>libpq</application> library.
</para>
<sect1 id="libpq-connect">
application program can have several backend connections open at
one time. (One reason to do that is to access more than one
database.) Each connection is represented by a
- <structname>PGconn</> object which is obtained from the function
- <function>PQconnectdb</> or <function>PQsetdbLogin</>. Note that
- these functions will always return a non-null object pointer,
- unless perhaps there is too little memory even to allocate the
- <structname>PGconn</> object. The <function>PQstatus</> function
- should be called to check whether a connection was successfully
- made before queries are sent via the connection object.
+ <structname>PGconn</><indexterm><primary>PGconn</></> object which
+ is obtained from the function <function>PQconnectdb</> or
+ <function>PQsetdbLogin</>. Note that these functions will always
+ return a non-null object pointer, unless perhaps there is too
+ little memory even to allocate the <structname>PGconn</> object.
+ The <function>PQstatus</> function should be called to check
+ whether a connection was successfully made before queries are sent
+ via the connection object.
<variablelist>
<varlistentry>
- <term><function>PQconnectdb</function></term>
+ <term><function>PQconnectdb</function><indexterm><primary>PQconnectdb</></></term>
<listitem>
<para>
Makes a new connection to the database server.
<term><literal>host</literal></term>
<listitem>
<para>
- Name of host to connect to.
- If this begins with a slash, it specifies Unix-domain communication
- rather than TCP/IP communication; the value is the name of the
- directory in which the socket file is stored.
- The default is to connect to a Unix-domain socket in
- <filename>/tmp</filename>.
+ Name of host to connect to.<indexterm><primary>host name</></>
+ If this begins with a slash, it specifies Unix-domain
+ communication rather than TCP/IP communication; the value is the
+ name of the directory in which the socket file is stored. The
+ default is to connect to a Unix-domain socket in
+ <filename>/tmp</filename>.<indexterm><primary>Unix domain
+ socket</></>
</para>
</listitem>
</varlistentry>
<term><literal>port</literal></term>
<listitem>
<para>
- Port number to connect to at the server host,
- or socket file name extension for Unix-domain connections.
+ Port number to connect to at the server host, or socket file
+ name extension for Unix-domain
+ connections.<indexterm><primary>port</></>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>sslmode</literal></term>
<listitem>
- <para>
- This option determines whether or with what priority an <acronym>SSL</>
- connection will be negotiated with the server. There are four
- modes: <literal>disable</> will attempt only an unencrypted
- <acronym>SSL</> connection; <literal>allow</> will negotiate,
- trying first a non-<acronym>SSL</> connection, then if that fails,
- trying an <acronym>SSL</> connection; <literal>prefer</>
- (the default) will negotiate, trying first an <acronym>SSL</> connection,
- then if that fails, trying a regular non-<acronym>SSL</> connection;
- <literal>require</> will try only an <acronym>SSL</> connection.
- </para>
- <para>
- If <productname>PostgreSQL</> is compiled without SSL support,
- using option <literal>require</> will cause an error, and options
- <literal>allow</> and <literal>prefer</> will be tolerated but
- <application>libpq</> will be unable to negotiate an <acronym>SSL</>
- connection.
- </para>
+ <para>
+ This option determines whether or with what priority an
+ <acronym>SSL</> connection will be negotiated with the
+ server. There are four modes: <literal>disable</> will attempt
+ only an unencrypted <acronym>SSL</> connection;
+ <literal>allow</> will negotiate, trying first a
+ non-<acronym>SSL</> connection, then if that fails, trying an
+ <acronym>SSL</> connection; <literal>prefer</> (the default)
+ will negotiate, trying first an <acronym>SSL</> connection,
+ then if that fails, trying a regular non-<acronym>SSL</>
+ connection; <literal>require</> will try only an
+ <acronym>SSL</> connection.
+ </para>
+
+ <para>
+ If <productname>PostgreSQL</> is compiled without SSL support,
+ using option <literal>require</> will cause an error, and
+ options <literal>allow</> and <literal>prefer</> will be
+ tolerated but <application>libpq</> will be unable to negotiate
+ an <acronym>SSL</>
+ connection.<indexterm><primary>SSL</><secondary
+ sortas="libpq">with libpq</></indexterm>
+ </para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>requiressl</literal></term>
<listitem>
- <para>
- This option is deprecated in favor of the <literal>sslmode</>
- setting.
- </para>
- <para>
- If set to 1, an <acronym>SSL</acronym> connection to the server is required
- (this is equivalent to <literal>sslmode</> <literal>require</>).
- <application>libpq</> will then refuse to connect if the server does not
- accept an <acronym>SSL</acronym> connection.
- If set to 0 (default), <application>libpq</> will negotiate the connection
- type with the server (equivalent to <literal>sslmode</> <literal>prefer</>).
- This option is only available if
- <productname>PostgreSQL</> is compiled with SSL support.
- </para>
+ <para>
+ This option is deprecated in favor of the <literal>sslmode</>
+ setting.
+ </para>
+
+ <para>
+ If set to 1, an <acronym>SSL</acronym> connection to the server
+ is required (this is equivalent to <literal>sslmode</>
+ <literal>require</>). <application>libpq</> will then refuse
+ to connect if the server does not accept an
+ <acronym>SSL</acronym> connection. If set to 0 (default),
+ <application>libpq</> will negotiate the connection type with
+ the server (equivalent to <literal>sslmode</>
+ <literal>prefer</>). This option is only available if
+ <productname>PostgreSQL</> is compiled with SSL support.
+ </para>
</listitem>
</varlistentry>
</varlistentry>
<varlistentry>
- <term><function>PQsetdbLogin</function></term>
+ <term><function>PQsetdbLogin</function><indexterm><primary>PQsetdbLogin</></></term>
<listitem>
<para>
Makes a new connection to the database server.
</varlistentry>
<varlistentry>
- <term><function>PQsetdb</function></term>
+ <term><function>PQsetdb</function><indexterm><primary>PQsetdb</></></term>
<listitem>
<para>
Makes a new connection to the database server.
</varlistentry>
<varlistentry>
- <term><function>PQconnectStart</function></term>
- <term><function>PQconnectPoll</function></term>
+ <term><function>PQconnectStart</function><indexterm><primary>PQconnectStart</></></term>
+ <term><function>PQconnectPoll</function><indexterm><primary>PQconnectPoll</></></term>
<listitem>
<para>
<indexterm><primary>nonblocking connection</primary></indexterm>
</varlistentry>
<varlistentry>
- <term><function>PQconndefaults</function></term>
+ <term><function>PQconndefaults</function><indexterm><primary>PQconndefaults</></></term>
<listitem>
<para>
Returns the default connection options.
</varlistentry>
<varlistentry>
- <term><function>PQfinish</function></term>
+ <term><function>PQfinish</function><indexterm><primary>PQfinish</></></term>
<listitem>
<para>
Closes the connection to the server. Also frees
</varlistentry>
<varlistentry>
- <term><function>PQreset</function></term>
+ <term><function>PQreset</function><indexterm><primary>PQreset</></></term>
<listitem>
<para>
Resets the communication channel to the server.
</varlistentry>
<varlistentry>
- <term><function>PQresetStart</function></term>
- <term><function>PQresetPoll</function></term>
+ <term><function>PQresetStart</function><indexterm><primary>PQresetStart</></></term>
+ <term><function>PQresetPoll</function><indexterm><primary>PQresetPoll</></></term>
<listitem>
<para>
Reset the communication channel to the server, in a nonblocking manner.
<variablelist>
<varlistentry>
-<term><function>PQdb</function></term>
+<term><function>PQdb</function><indexterm><primary>PQdb</></></term>
<listitem>
<para>
Returns the database name of the connection.
</varlistentry>
<varlistentry>
-<term><function>PQuser</function></term>
+<term><function>PQuser</function><indexterm><primary>PQuser</></></term>
<listitem>
<para>
Returns the user name of the connection.
</varlistentry>
<varlistentry>
-<term><function>PQpass</function></term>
+<term><function>PQpass</function><indexterm><primary>PQpass</></></term>
<listitem>
<para>
Returns the password of the connection.
</varlistentry>
<varlistentry>
-<term><function>PQhost</function></term>
+<term><function>PQhost</function><indexterm><primary>PQhost</></></term>
<listitem>
<para>
Returns the server host name of the connection.
</varlistentry>
<varlistentry>
-<term><function>PQport</function></term>
+<term><function>PQport</function><indexterm><primary>PQport</></></term>
<listitem>
<para>
Returns the port of the connection.
</varlistentry>
<varlistentry>
-<term><function>PQtty</function></term>
+<term><function>PQtty</function><indexterm><primary>PQtty</></></term>
<listitem>
<para>
Returns the debug <acronym>TTY</acronym> of the connection.
- (This is obsolete, since the server no longer pays attention
- to the <acronym>TTY</acronym> setting, but the function remains
- for backwards compatibility.)
+ (This is obsolete, since the server no longer pays attention
+
to the <acronym>TTY</acronym> setting, but the function remains
+ for backwards compatibility.)
<synopsis>
char *PQtty(const PGconn *conn);
</synopsis>
</varlistentry>
<varlistentry>
-<term><function>PQoptions</function></term>
+<term><function>PQoptions</function><indexterm><primary>PQoptions</></></term>
<listitem>
<para>
Returns the command-line options passed in the connection request.
<variablelist>
<varlistentry>
-<term><function>PQstatus</function></term>
+<term><function>PQstatus</function><indexterm><primary>PQstatus</></></term>
<listitem>
<para>
Returns the status of the connection.
</varlistentry>
<varlistentry>
-<term><function>PQtransactionStatus</function></term>
+<term><function>PQtransactionStatus</function><indexterm><primary>PQtransactionStatus</></></term>
<listitem>
<para>
Returns the current in-transaction status of the server.
</varlistentry>
<varlistentry>
-<term><function>PQparameterStatus</function></term>
+<term><function>PQparameterStatus</function><indexterm><primary>PQparameterStatus</></></term>
<listitem>
<para>
Looks up a current parameter setting of the server.
</varlistentry>
<varlistentry>
-<term><function>PQprotocolVersion</function></term>
+<term><function>PQprotocolVersion</function><indexterm><primary>PQprotocolVersion</></></term>
<listitem>
<para>
Interrogates the frontend/backend protocol being used.
</varlistentry>
<varlistentry>
- <term><function>PQerrorMessage</function></term>
+ <term><function>PQerrorMessage</function><indexterm><primary>PQerrorMessage</></></term>
<listitem>
<para>
<indexterm><primary>error message</></>
</varlistentry>
<varlistentry>
- <term><function>PQsocket</function></term>
+ <term><function>PQsocket</function><indexterm><primary>PQsocket</></></term>
<listitem>
<para>
Obtains the file descriptor number of the connection socket to
</varlistentry>
<varlistentry>
- <term><function>PQbackendPID</function></term>
+ <term><function>PQbackendPID</function><indexterm><primary>PQbackendPID</></></term>
<listitem>
<para>
- Returns the process <acronym>ID</acronym> of the backend server process
- handling this connection.
+ Returns the process <acronym>ID</acronym>
+ (PID)<indexterm><primary>PID</><secondary>determining PID of
+ server process</><tertiary>in libpq</></> of the backend server
+ process handling this connection.
<synopsis>
int PQbackendPID(const PGconn *conn);
</synopsis>
</varlistentry>
<varlistentry>
- <term><function>PQgetssl</function></term>
+ <term><function>PQgetssl</function><indexterm><primary>PQgetssl</></></term>
<listitem>
<para>
- <indexterm><primary>SSL</></>
+ <indexterm><primary>SSL</><secondary sortas="libpq">in libpq</secondary></indexterm>
Returns the SSL structure used in the connection, or null
if SSL is not in use.
<synopsis>
<para>
<variablelist>
<varlistentry>
-<term><function>PQexec</function></term>
+<term><function>PQexec</function><indexterm><primary>PQexec</></></term>
<listitem>
<para>
Submits a command to the server
out-of-memory conditions or serious errors such as inability
to send the command to the server.
If a null pointer is returned, it
- should be treated like a <symbol>PGRES_FATAL_ERROR</symbol> result. Use
- <function>PQerrorMessage</function> to get more information about the error.
+ should be treated like a <symbol>PGRES_FATAL_ERROR</symbol> result. Use
+ <function>PQerrorMessage</function> to get more information about the error.
</para>
</listitem>
</varlistentry>
<para>
<variablelist>
<varlistentry>
-<term><function>PQexecParams</function></term>
+<term><function>PQexecParams</function><indexterm><primary>PQexecParams</></></term>
<listitem>
<para>
Submits a command to the server and waits for the result,
- with the ability to pass parameters separately from the SQL
- command text.
+ with the ability to pass parameters separately from the SQL
+ command text.
<synopsis>
PGresult *PQexecParams(PGconn *conn,
const char *command,
<para>
<variablelist>
<varlistentry>
-<term><function>PQexecPrepared</function></term>
+<term><function>PQexecPrepared</function><indexterm><primary>PQexecPrepared</></></term>
<listitem>
<para>
Sends a request to execute a prepared statement with given
- parameters, and waits for the result.
+ parameters, and waits for the result.
<synopsis>
PGresult *PQexecPrepared(PGconn *conn,
const char *stmtName,
</para>
<para>
-The <structname>PGresult</structname> structure encapsulates the result
-returned by the server.
-<application>libpq</application> application programmers should be careful to
-maintain the <structname>PGresult</structname> abstraction. Use the accessor functions below to get
-at the contents of <structname>PGresult</structname>. Avoid directly referencing the fields of the
-<structname>PGresult</structname> structure because they are subject to change in the future.
+The
+<structname>PGresult</structname><indexterm><primary>PGresult</></>
+structure encapsulates the result returned by the server.
+<application>libpq</application> application programmers should be
+careful to maintain the <structname>PGresult</structname> abstraction.
+Use the accessor functions below to get at the contents of
+<structname>PGresult</structname>. Avoid directly referencing the
+fields of the <structname>PGresult</structname> structure because they
+are subject to change in the future.
<variablelist>
<varlistentry>
-<term><function>PQresultStatus</function></term>
+<term><function>PQresultStatus</function><indexterm><primary>PQresultStatus</></></term>
<listitem>
<para>
Returns the result status of the command.
</varlistentry>
<varlistentry>
-<term><function>PQresStatus</function></term>
+<term><function>PQresStatus</function><indexterm><primary>PQresStatus</></></term>
<listitem>
<para>
- Converts the enumerated type returned by <function>PQresultStatus</> into
- a string constant describing the status code.
+ Converts the enumerated type returned by <function>PQresultStatus</> into
+ a string constant describing the status code.
<synopsis>
char *PQresStatus(ExecStatusType status);
</synopsis>
</varlistentry>
<varlistentry>
-<term><function>PQresultErrorMessage</function></term>
+<term><function>PQresultErrorMessage</function><indexterm><primary>PQresultErrorMessage</></></term>
<listitem>
<para>
Returns the error message associated with the command, or an empty string
</varlistentry>
<varlistentry>
-<term><function>PQresultErrorField</function></term>
+<term><function>PQresultErrorField</function><indexterm><primary>PQresultErrorField</></></term>
<listitem>
<para>
Returns an individual field of an error report.
</varlistentry>
<varlistentry>
-<term><function>PQclear</function></term>
+<term><function>PQclear</function><indexterm><primary>PQclear</></></term>
<listitem>
<para>
Frees the storage associated with a <structname>PGresult</structname>.
</varlistentry>
<varlistentry>
-<term><function>PQmakeEmptyPGresult</function></term>
+<term><function>PQmakeEmptyPGresult</function><indexterm><primary>PQmakeEmptyPGresult</></></term>
<listitem>
<para>
Constructs an empty <structname>PGresult</structname> object with the given status.
<variablelist>
<varlistentry>
-<term><function>PQntuples</function></term>
+<term><function>PQntuples</function><indexterm><primary>PQntuples</></></term>
<listitem>
<para>
Returns the number of rows (tuples)
</varlistentry>
<varlistentry>
-<term><function>PQnfields</function></term>
+<term><function>PQnfields</function><indexterm><primary>PQnfields</></></term>
<listitem>
<para>
Returns the number of columns (fields)
</varlistentry>
<varlistentry>
-<term><function>PQfname</function></term>
+<term><function>PQfname</function><indexterm><primary>PQfname</></></term>
<listitem>
<para>
Returns the column name associated with the given column number.
</varlistentry>
<varlistentry>
-<term><function>PQfnumber</function></term>
+<term><function>PQfnumber</function><indexterm><primary>PQfnumber</></></term>
<listitem>
<para>
Returns the column number
</varlistentry>
<varlistentry>
-<term><function>PQftable</function></term>
+<term><function>PQftable</function><indexterm><primary>PQftable</></></term>
<listitem>
<para>
Returns the OID of the table from which the given column was fetched.
</varlistentry>
<varlistentry>
-<term><function>PQftablecol</function></term>
+<term><function>PQftablecol</function><indexterm><primary>PQftablecol</></></term>
<listitem>
<para>
Returns the column number (within its table) of the column making up
</varlistentry>
<varlistentry>
-<term><function>PQfformat</function></term>
+<term><function>PQfformat</function><indexterm><primary>PQfformat</></></term>
<listitem>
<para>
Returns the format code indicating the format of the given column.
</varlistentry>
<varlistentry>
-<term><function>PQftype</function></term>
+<term><function>PQftype</function><indexterm><primary>PQftype</></></term>
<listitem>
<para>
Returns the data type associated with the
</varlistentry>
<varlistentry>
-<term><function>PQfmod</function></term>
+<term><function>PQfmod</function><indexterm><primary>PQfmod</></></term>
<listitem>
<para>
Returns the type modifier of the column
</varlistentry>
<varlistentry>
-<term><function>PQfsize</function></term>
+<term><function>PQfsize</function><indexterm><primary>PQfsize</></></term>
<listitem>
<para>
Returns the size in bytes of the column
</varlistentry>
<varlistentry>
-<term><function>PQbinaryTuples</function></term>
+<term><function>PQbinaryTuples</function><indexterm><primary>PQbinaryTuples</></></term>
<listitem>
<para>
Returns 1 if the <structname>PGresult</> contains binary data
</varlistentry>
<varlistentry>
-<term><function>PQgetvalue</function></term>
+<term><function>PQgetvalue</function><indexterm><primary>PQgetvalue</></></term>
<listitem>
<para>
Returns a single field value of one row
- of a <structname>PGresult</structname>.
+ of a <structname>PGresult</structname>.
Row and column numbers start at 0.
<synopsis>
char* PQgetvalue(const PGresult *res,
</varlistentry>
<varlistentry>
-<term><function>PQgetisnull</function></term>
-<listitem>
+<term><function>PQgetisnull</function><indexterm><primary>PQgetisnull</></></term>
+<indexterm><primary>null value</><secondary sortas="libpq">in libpq</></indexterm><listitem>
<para>
Tests a field for a null value.
Row and column numbers start at 0.
</varlistentry>
<varlistentry>
-<term><function>PQgetlength</function></term>
+<term><function>PQgetlength</function><indexterm><primary>PQgetlength</></></term>
<listitem>
<para>
Returns the actual length of a field value in bytes.
</varlistentry>
<varlistentry>
-<term><function>PQprint</function></term>
+<term><function>PQprint</function><indexterm><primary>PQprint</></></term>
<listitem>
<para>
Prints out all the rows and, optionally, the
<variablelist>
<varlistentry>
-<term><function>PQcmdStatus</function></term>
+<term><function>PQcmdStatus</function><indexterm><primary>PQcmdStatus</></></term>
<listitem>
<para>
Returns the command status tag from the SQL command that
- generated the <structname>PGresult</structname>.
+ generated the <structname>PGresult</structname>.
<synopsis>
char * PQcmdStatus(PGresult *res);
</synopsis>
</varlistentry>
<varlistentry>
-<term><function>PQcmdTuples</function></term>
+<term><function>PQcmdTuples</function><indexterm><primary>PQcmdTuples</></></term>
<listitem>
<para>
- Returns the number of rows affected by the SQL command.
+ Returns the number of rows affected by the SQL command.
<synopsis>
char * PQcmdTuples(PGresult *res);
</synopsis>
<para>
If the <acronym>SQL</acronym> command that generated the
- <structname>PGresult</structname> was <command>INSERT</>,
- <command>UPDATE</>, <command>DELETE</command>, <command>MOVE</>,
- or <command>FETCH</>, this returns a
- string containing the number of rows affected. If the
+ <structname>PGresult</structname> was <command>INSERT</>,
+ <command>UPDATE</>, <command>DELETE</command>, <command>MOVE</>,
+ or <command>FETCH</>, this returns a
+ string containing the number of rows affected. If the
command was anything else, it returns the empty string.
</para>
</listitem>
</varlistentry>
<varlistentry>
-<term><function>PQoidValue</function></term>
+<term><function>PQoidValue</function><indexterm><primary>PQoidValue</></></term>
<listitem>
<para>
- Returns the OID of the inserted row, if the
- <acronym>SQL</acronym> command was an <command>INSERT</command>
- that inserted exactly one row into a table that has OIDs.
- Otherwise, returns <literal>InvalidOid</literal>.
+ Returns the OID<indexterm><primary>OID</><secondary>in
+ libpq</></> of the inserted row, if the
+ <acronym>SQL</acronym> command was an
+ <command>INSERT</command> that inserted exactly one row into
+ a table that has OIDs. Otherwise, returns
+ <literal>InvalidOid</literal>.
<synopsis>
Oid PQoidValue(const PGresult *res);
</synopsis>
</varlistentry>
<varlistentry>
-<term><function>PQoidStatus</function></term>
+<term><function>PQoidStatus</function><indexterm><primary>PQoidStatus</></></term>
<listitem>
<para>
Returns a string with the OID of the inserted row, if the
<sect2 id="libpq-exec-escape-string">
<title>Escaping Strings for Inclusion in SQL Commands</title>
+ <indexterm zone="libpq-exec-escape-string"><primary>PQescapeString</></>
<indexterm zone="libpq-exec-escape-string"><primary>escaping strings</></>
<para>
<sect2 id="libpq-exec-escape-bytea">
<title>Escaping Binary Strings for Inclusion in SQL Commands</title>
+
<indexterm zone="libpq-exec-escape-bytea">
- <primary>escaping binary strings</primary>
+ <primary>bytea</>
+ <secondary sortas="libpq">in libpq</>
</indexterm>
<variablelist>
<varlistentry>
- <term><function>PQescapeBytea</function></term>
+ <term><function>PQescapeBytea</function><indexterm><primary>PQescapeBytea</></></term>
<listitem>
<para>
Escapes binary data for use within an SQL command with the type
</varlistentry>
<varlistentry>
- <term><function>PQunescapeBytea</function></term>
+ <term><function>PQunescapeBytea</function><indexterm><primary>PQunescapeBytea</></></term>
<listitem>
<para>
Converts an escaped string representation of binary data into binary
</varlistentry>
<varlistentry>
- <term><function>PQfreemem</function></term>
+ <term><function>PQfreemem</function><indexterm><primary>PQfreemem</></></term>
<listitem>
<para>
Frees memory allocated by <application>libpq</>.
<variablelist>
<varlistentry>
-<term><function>PQsendQuery</function></term>
+<term><function>PQsendQuery</function><indexterm><primary>PQsendQuery</></></term>
<listitem>
<para>
Submits a command to the server without
- waiting for the result(s). 1 is returned if the command was
- successfully dispatched and 0 if not (in which case, use
- <function>PQerrorMessage</> to get more information about the failure).
+ waiting for the result(s). 1 is returned if the command was
+ successfully dispatched and 0 if not (in which case, use
+ <function>PQerrorMessage</> to get more information about the failure).
<synopsis>
int PQsendQuery(PGconn *conn, const char *command);
</synopsis>
- After successfully calling <function>PQsendQuery</function>, call
+ After successfully calling <function>PQsendQuery</function>, call
<function>PQgetResult</function> one or more
- times to obtain the results. <function>PQsendQuery</function> may not be called
- again (on the same connection) until <function>PQgetResult</function> has returned a null pointer,
- indicating that the command is done.
+ times to obtain the results. <function>PQsendQuery</function> may not be called
+ again (on the same connection) until <function>PQgetResult</function> has returned a null pointer,
+ indicating that the command is done.
</para>
</listitem>
</varlistentry>
<varlistentry>
-<term><function>PQsendQueryParams</function></term>
+<term><function>PQsendQueryParams</function><indexterm><primary>PQsendQueryParams</></></term>
<listitem>
<para>
Submits a command and separate parameters to the server without
- waiting for the result(s).
+ waiting for the result(s).
<synopsis>
int PQsendQueryParams(PGconn *conn,
const char *command,
int resultFormat);
</synopsis>
- This is equivalent to <function>PQsendQuery</function> except that
- query parameters can be specified separately from the query string.
- The function's parameters are handled identically to
- <function>PQexecParams</function>. Like
- <function>PQexecParams</function>, it will not work on 2.0-protocol
- connections, and it allows only one command in the query string.
+ This is equivalent to <function>PQsendQuery</function> except that
+ query parameters can be specified separately from the query string.
+ The function's parameters are handled identically to
+ <function>PQexecParams</function>. Like
+ <function>PQexecParams</function>, it will not work on 2.0-protocol
+ connections, and it allows only one command in the query string.
</para>
</listitem>
</varlistentry>
<varlistentry>
-<term><function>PQsendQueryPrepared</function></term>
+<term><function>PQsendQueryPrepared</function><indexterm><primary>PQsendQueryPrepared</></></term>
<listitem>
<para>
Sends a request to execute a prepared statement with given
- parameters, without waiting for the result(s).
+ parameters, without waiting for the result(s).
<synopsis>
int PQsendQueryPrepared(PGconn *conn,
const char *stmtName,
int resultFormat);
</synopsis>
- This is similar to <function>PQsendQueryParams</function>, but the
- command to be executed is specified by naming a previously-prepared
- statement, instead of giving a query string.
- The function's parameters are handled identically to
- <function>PQexecPrepared</function>. Like
- <function>PQexecPrepared</function>, it will not work on 2.0-protocol
- connections.
+ This is similar to <function>PQsendQueryParams</function>, but the
+ command to be executed is specified by naming a previously-prepared
+ statement, instead of giving a query string.
+ The function's parameters are handled identically to
+ <function>PQexecPrepared</function>. Like
+ <function>PQexecPrepared</function>, it will not work on 2.0-protocol
+ connections.
</para>
</listitem>
</varlistentry>
<varlistentry>
-<term><function>PQgetResult</function></term>
+<term><function>PQgetResult</function><indexterm><primary>PQgetResult</></></term>
<listitem>
<para>
Waits for the next result from a prior
- <function>PQsendQuery</function>,
- <function>PQsendQueryParams</function>, or
- <function>PQsendQueryPrepared</function> call,
- and returns it. A null pointer is returned when the command is complete
- and there will be no more results.
+ <function>PQsendQuery</function>,
+ <function>PQsendQueryParams</function>, or
+ <function>PQsendQueryPrepared</function> call,
+ and returns it. A null pointer is returned when the command is complete
+ and there will be no more results.
<synopsis>
PGresult *PQgetResult(PGconn *conn);
</synopsis>
</para>
<para>
- <function>PQgetResult</function> must be called repeatedly until it returns a null pointer,
- indicating that the command is done. (If called when no command is
- active, <function>PQgetResult</function> will just return a null pointer at once.)
- Each non-null result from <function>PQgetResult</function> should be processed using
- the same <structname>PGresult</> accessor functions previously described.
- Don't forget to free each result object with <function>PQclear</function> when done with it.
- Note that <function>PQgetResult</function> will block only if a command is active and the
- necessary response data has not yet been read by <function>PQconsumeInput</function>.
+ <function>PQgetResult</function> must be called repeatedly until it returns a null pointer,
+ indicating that the command is done. (If called when no command is
+ active, <function>PQgetResult</function> will just return a null pointer at once.)
+ Each non-null result from <function>PQgetResult</function> should be processed using
+ the same <structname>PGresult</> accessor functions previously described.
+ Don't forget to free each result object with <function>PQclear</function> when done with it.
+ Note that <function>PQgetResult</function> will block only if a command is active and the
+ necessary response data has not yet been read by <function>PQconsumeInput</function>.
</para>
</listitem>
</varlistentry>
<variablelist>
<varlistentry>
-<term><function>PQconsumeInput</function></term>
+<term><function>PQconsumeInput</function><indexterm><primary>PQconsumeInput</></></term>
<listitem>
<para>
- If input is available from the server, consume it.
+ If input is available from the server, consume it.
<synopsis>
int PQconsumeInput(PGconn *conn);
</synopsis>
</varlistentry>
<varlistentry>
-<term><function>PQisBusy</function></term>
+<term><function>PQisBusy</function><indexterm><primary>PQisBusy</></></term>
<listitem>
<para>
Returns 1 if a command is busy, that is, <function>PQgetResult</function> would block
</para>
<para>
-A client that uses <function>PQsendQuery</function>/<function>PQgetResult</function>
-can also attempt to cancel a command that is still being processed by the server.
+A client that uses
+<function>PQsendQuery</function>/<function>PQgetResult</function> can
+also attempt to cancel a command that is still being processed by the
+server.<indexterm><primary>canceling</><secondary>SQL command</></>
<variablelist>
<varlistentry>
-<term><function>PQrequestCancel</function></term>
+<term><function>PQrequestCancel</function><indexterm><primary>PQrequestCancel</></></term>
<listitem>
<para>
- Requests that the server abandon
- processing of the current command.
+ Requests that the server abandon
+ processing of the current command.
<synopsis>
int PQrequestCancel(PGconn *conn);
</synopsis>
<variablelist>
<varlistentry>
- <term><function>PQsetnonblocking</function></term>
+ <term><function>PQsetnonblocking</function><indexterm><primary>PQsetnonblocking</></></term>
<listitem>
<para>
Sets the nonblocking status of the connection.
</varlistentry>
<varlistentry>
-<term><function>PQisnonblocking</function></term>
+<term><function>PQisnonblocking</function><indexterm><primary>PQisnonblocking</></></term>
<listitem>
<para>
Returns the blocking status of the database connection.
</varlistentry>
<varlistentry>
-<term><function>PQflush</function></term>
+<term><function>PQflush</function><indexterm><primary>PQflush</></></term>
<listitem>
<para>
Attempts to flush any queued output data to the server.
<sect1 id="libpq-fastpath">
<title>The Fast-Path Interface</title>
+<indexterm zone="libpq-fastpath"><primary>fast path</></>
+
<para>
<productname>PostgreSQL</productname> provides a fast-path interface to send
simple function calls to the server.
</tip>
<para>
-The function <function>PQfn</function> requests execution of a server
-function via the fast-path interface:
+The function <function>PQfn</function><indexterm><primary>PQfn</></>
+requests execution of a server function via the fast-path interface:
<synopsis>
PGresult* PQfn(PGconn* conn,
int fnid,
<sect1 id="libpq-notify">
<title>Asynchronous Notification</title>
- <indexterm zone="libpq-notify"><primary>NOTIFY</primary></indexterm>
+ <indexterm zone="libpq-notify">
+ <primary>NOTIFY</primary>
+ <secondary>in libpq</secondary>
+ </indexterm>
<para>
<productname>PostgreSQL</productname> offers asynchronous notification via the
</para>
<para>
-<application>libpq</application> applications submit <command>LISTEN</command> and <command>UNLISTEN</command>
-commands as ordinary SQL commands. The arrival of <command>NOTIFY</command>
-messages can subsequently be detected by calling <function>PQnotifies</function>.
+<application>libpq</application> applications submit
+<command>LISTEN</command> and <command>UNLISTEN</command> commands as
+ordinary SQL commands. The arrival of <command>NOTIFY</command>
+messages can subsequently be detected by calling
+<function>PQnotifies</function>.<indexterm><primary>PQnotifies</></>
</para>
<para>
returns the next notification from a list of unhandled
notification messages received from the server. It returns a null pointer if
there are no pending notifications. Once a notification is
- returned from <function>PQnotifies</>, it is considered handled and will be
- removed from the list of notifications.
+ returned from <function>PQnotifies</>, it is considered handled and will be
+ removed from the list of notifications.
<synopsis>
PGnotify* PQnotifies(PGconn *conn);
<variablelist>
<varlistentry>
-<term><function>PQnfields</function></term>
+<term><function>PQnfields</function><indexterm><primary>PQnfields</><secondary>with COPY</></></term>
<listitem>
<para>
Returns the number of columns (fields) to be copied.
</varlistentry>
<varlistentry>
-<term><function>PQbinaryTuples</function></term>
+<term><function>PQbinaryTuples</function><indexterm><primary>PQbinaryTuples</><secondary>with COPY</></></term>
<listitem>
<para>
0 indicates the overall copy format is textual (rows
- separated by newlines, columns separated by separator
- characters, etc).
- 1 indicates the overall copy format is binary.
- See <xref linkend="sql-copy" endterm="sql-copy-title">
- for more information.
+ separated by newlines, columns separated by separator
+ characters, etc).
+ 1 indicates the overall copy format is binary.
+ See <xref linkend="sql-copy" endterm="sql-copy-title">
+ for more information.
</para>
</listitem>
</varlistentry>
<varlistentry>
-<term><function>PQfformat</function></term>
+<term><function>PQfformat</function><indexterm><primary>PQfformat</><secondary>with COPY</></></term>
<listitem>
<para>
Returns the format code (0 for text, 1 for binary) associated
- with each column of the copy operation. The per-column format
- codes will always be zero when the overall copy format is textual,
- but the binary format can support both text and binary columns.
- (However, as of the current implementation of <command>COPY</>,
- only binary columns appear in a binary copy; so the per-column
- formats always match the overall format at present.)
+ with each column of the copy operation. The per-column format
+ codes will always be zero when the overall copy format is textual,
+ but the binary format can support both text and binary columns.
+ (However, as of the current implementation of <command>COPY</>,
+ only binary columns appear in a binary copy; so the per-column
+ formats always match the overall format at present.)
</para>
</listitem>
</varlistentry>
<variablelist>
<varlistentry>
-<term><function>PQputCopyData</function></term>
+<term><function>PQputCopyData</function><indexterm><primary>PQputCopyData</></></term>
<listitem>
<para>
Sends data to the server during <literal>COPY_IN</> state.
</varlistentry>
<varlistentry>
-<term><function>PQputCopyEnd</function></term>
+<term><function>PQputCopyEnd</function><indexterm><primary>PQputCopyEnd</></></term>
<listitem>
<para>
Sends end-of-data indication to the server during <literal>COPY_IN</> state.
<variablelist>
<varlistentry>
-<term><function>PQgetCopyData</function></term>
+<term><function>PQgetCopyData</function><indexterm><primary>PQgetCopyData</></></term>
<listitem>
<para>
Receives data from the server during <literal>COPY_OUT</> state.
<variablelist>
<varlistentry>
-<term><function>PQgetline</function></term>
+<term><function>PQgetline</function><indexterm><primary>PQgetline</></></term>
<listitem>
<para>
Reads a newline-terminated line of characters
</varlistentry>
<varlistentry>
-<term><function>PQgetlineAsync</function></term>
+<term><function>PQgetlineAsync</function><indexterm><primary>PQgetlineAsync</></></term>
<listitem>
<para>
Reads a row of COPY data
</varlistentry>
<varlistentry>
-<term><function>PQputline</function></term>
+<term><function>PQputline</function><indexterm><primary>PQputline</></></term>
<listitem>
<para>
Sends a null-terminated string to the server.
</varlistentry>
<varlistentry>
-<term><function>PQputnbytes</function></term>
+<term><function>PQputnbytes</function><indexterm><primary>PQputnbytes</></></term>
<listitem>
<para>
Sends a non-null-terminated string to the server.
</varlistentry>
<varlistentry>
-<term><function>PQendcopy</function></term>
+<term><function>PQendcopy</function><indexterm><primary>PQendcopy</></></term>
<listitem>
<para>
Synchronizes with the server.
<variablelist>
<varlistentry>
-<term><function>PQsetErrorVerbosity</function></term>
+<term><function>PQsetErrorVerbosity</function><indexterm><primary>PQsetErrorVerbosity</></></term>
<listitem>
<para>
Determines the verbosity of messages returned by
</varlistentry>
<varlistentry>
-<term><function>PQtrace</function></term>
+<term><function>PQtrace</function><indexterm><primary>PQtrace</></></term>
<listitem>
<para>
Enables tracing of the client/server communication to a debugging file stream.
</varlistentry>
<varlistentry>
-<term><function>PQuntrace</function></term>
+<term><function>PQuntrace</function><indexterm><primary>PQuntrace</></></term>
<listitem>
<para>
Disables tracing started by <function>PQtrace</function>.
<sect1 id="libpq-notice-processing">
<title>Notice Processing</title>
+<indexterm zone="libpq-notice-processing">
+ <primary>notice processing</primary>
+ <secondary>in libpq</secondary>
+</indexterm>
+
<para>
Notice and warning messages generated by the server are not returned by the
query execution functions, since they do not imply failure of the query.
<para>
The function <function>PQsetNoticeReceiver</function>
-<indexterm><primary>notice receiver</></>
+<indexterm><primary>notice receiver</></><indexterm><primary>PQsetNoticeReceiver</></>
sets or examines the current notice receiver for a connection object.
Similarly, <function>PQsetNoticeProcessor</function>
-<indexterm><primary>notice processor</></>
+<indexterm><primary>notice processor</></><indexterm><primary>PQsetNoticeProcessor</></>
sets or examines the current notice processor.
<synopsis>
<title>Environment Variables</title>
<indexterm zone="libpq-envars">
- <primary>environment variables</primary>
+ <primary>environment variable</primary>
</indexterm>
<para>
</para>
<para>
-<application>libpq</application> applications that use the <literal>crypt</literal>
-authentication method rely on the <literal>crypt()</literal> operating
-system function, which is often not thread-safe. It is better to use the
-<literal>md5</literal> method, which is thread-safe on all
-platforms.
+<application>libpq</application> applications that use the
+<literal>crypt</literal> authentication method rely on the
+<literal>crypt()</literal> operating system function, which is often
+not thread-safe.<indexterm><primary>crypt</><secondary>thread
+safety</></> It is better to use the <literal>md5</literal> method,
+which is thread-safe on all platforms.
</para>
</sect1>
<sect1 id="libpq-build">
<title>Building <application>libpq</application> Programs</title>
+ <indexterm zone="libpq-build">
+ <primary>compiling</primary>
+ <secondary>libpq applications</secondary>
+ </indexterm>
+
<para>
To build (i.e., compile and link) your <application>libpq</application> programs you need to
do all of the following things:
</para>
<para>
- <indexterm><primary>pg_config</></>
If there is any chance that your program might be compiled by
other users then you should not hardcode the directory location
like that. Instead, you can run the utility
- <command>pg_config</command> to find out where the header files
- are on the local system:
+ <command>pg_config</command><indexterm><primary>pg_config</><secondary
+ sortas="libpq">with libpq</></> to find out where the header
+ files are on the local system:
<screen>
<prompt>$</prompt> pg_config --includedir
<computeroutput>/usr/local/include</computeroutput>
/*
* testlibpq.c
*
- * Test the C version of LIBPQ, the POSTGRES frontend library.
+ * Test the C version of LIBPQ, the POSTGRES frontend library.
*/
#include <stdio.h>
#include <stdlib.h>
static void
exit_nicely(PGconn *conn)
{
- PQfinish(conn);
- exit(1);
+ PQfinish(conn);
+ exit(1);
}
int
main(int argc, char **argv)
{
- const char *conninfo;
- PGconn *conn;
- PGresult *res;
- int nFields;
- int i,
- j;
-
- /*
- * If the user supplies a parameter on the command line, use it as
- * the conninfo string; otherwise default to setting dbname=template1
- * and using environment variables or defaults for all other connection
- * parameters.
- */
- if (argc > 1)
- conninfo = argv[1];
- else
- conninfo = "dbname = template1";
-
- /* Make a connection to the database */
- conn = PQconnectdb(conninfo);
-
- /* Check to see that the backend connection was successfully made */
- if (PQstatus(conn) != CONNECTION_OK)
- {
- fprintf(stderr, "Connection to database '%s' failed.\n", PQdb(conn));
- fprintf(stderr, "%s", PQerrorMessage(conn));
- exit_nicely(conn);
- }
-
- /*
- * Our test case here involves using a cursor, for which we must be
- * inside a transaction block. We could do the whole thing with a
- * single PQexec() of "select * from pg_database", but that's too
- * trivial to make a good example.
- */
-
- /* Start a transaction block */
- res = PQexec(conn, "BEGIN");
- if (PQresultStatus(res) != PGRES_COMMAND_OK)
- {
- fprintf(stderr, "BEGIN command failed: %s", PQerrorMessage(conn));
- PQclear(res);
- exit_nicely(conn);
- }
-
- /*
- * Should PQclear PGresult whenever it is no longer needed to avoid
- * memory leaks
- */
- PQclear(res);
-
- /*
- * Fetch rows from pg_database, the system catalog of databases
- */
- res = PQexec(conn, "DECLARE myportal CURSOR FOR select * from pg_database");
- if (PQresultStatus(res) != PGRES_COMMAND_OK)
- {
- fprintf(stderr, "DECLARE CURSOR failed: %s", PQerrorMessage(conn));
- PQclear(res);
- exit_nicely(conn);
- }
- PQclear(res);
-
- res = PQexec(conn, "FETCH ALL in myportal");
- if (PQresultStatus(res) != PGRES_TUPLES_OK)
- {
- fprintf(stderr, "FETCH ALL failed: %s", PQerrorMessage(conn));
- PQclear(res);
- exit_nicely(conn);
- }
-
- /* first, print out the attribute names */
- nFields = PQnfields(res);
- for (i = 0; i < nFields; i++)
- printf("%-15s", PQfname(res, i));
- printf("\n\n");
-
- /* next, print out the rows */
- for (i = 0; i < PQntuples(res); i++)
- {
- for (j = 0; j < nFields; j++)
- printf("%-15s", PQgetvalue(res, i, j));
- printf("\n");
- }
-
- PQclear(res);
-
- /* close the portal ... we don't bother to check for errors ... */
- res = PQexec(conn, "CLOSE myportal");
- PQclear(res);
-
- /* end the transaction */
- res = PQexec(conn, "END");
- PQclear(res);
-
- /* close the connection to the database and cleanup */
- PQfinish(conn);
-
- return 0;
+ const char *conninfo;
+ PGconn *conn;
+ PGresult *res;
+ int nFields;
+ int i,
+ j;
+
+ /*
+ * If the user supplies a parameter on the command line, use it as
+ * the conninfo string; otherwise default to setting dbname=template1
+ * and using environment variables or defaults for all other connection
+ * parameters.
+ */
+ if (argc > 1)
+ conninfo = argv[1];
+ else
+ conninfo = "dbname = template1";
+
+ /* Make a connection to the database */
+ conn = PQconnectdb(conninfo);
+
+ /* Check to see that the backend connection was successfully made */
+ if (PQstatus(conn) != CONNECTION_OK)
+ {
+ fprintf(stderr, "Connection to database '%s' failed.\n", PQdb(conn));
+ fprintf(stderr, "%s", PQerrorMessage(conn));
+ exit_nicely(conn);
+ }
+
+ /*
+ * Our test case here involves using a cursor, for which we must be
+ * inside a transaction block. We could do the whole thing with a
+ * single PQexec() of "select * from pg_database", but that's too
+ * trivial to make a good example.
+ */
+
+ /* Start a transaction block */
+ res = PQexec(conn, "BEGIN");
+ if (PQresultStatus(res) != PGRES_COMMAND_OK)
+ {
+ fprintf(stderr, "BEGIN command failed: %s", PQerrorMessage(conn));
+ PQclear(res);
+ exit_nicely(conn);
+ }
+
+ /*
+ * Should PQclear PGresult whenever it is no longer needed to avoid
+ * memory leaks
+ */
+ PQclear(res);
+
+ /*
+ * Fetch rows from pg_database, the system catalog of databases
+ */
+ res = PQexec(conn, "DECLARE myportal CURSOR FOR select * from pg_database");
+ if (PQresultStatus(res) != PGRES_COMMAND_OK)
+ {
+ fprintf(stderr, "DECLARE CURSOR failed: %s", PQerrorMessage(conn));
+ PQclear(res);
+ exit_nicely(conn);
+ }
+ PQclear(res);
+
+ res = PQexec(conn, "FETCH ALL in myportal");
+ if (PQresultStatus(res) != PGRES_TUPLES_OK)
+ {
+ fprintf(stderr, "FETCH ALL failed: %s", PQerrorMessage(conn));
+ PQclear(res);
+ exit_nicely(conn);
+ }
+
+ /* first, print out the attribute names */
+ nFields = PQnfields(res);
+ for (i = 0; i < nFields; i++)
+ printf("%-15s", PQfname(res, i));
+ printf("\n\n");
+
+ /* next, print out the rows */
+ for (i = 0; i < PQntuples(res); i++)
+ {
+ for (j = 0; j < nFields; j++)
+ printf("%-15s", PQgetvalue(res, i, j));
+ printf("\n");
+ }
+
+ PQclear(res);
+
+ /* close the portal ... we don't bother to check for errors ... */
+ res = PQexec(conn, "CLOSE myportal");
+ PQclear(res);
+
+ /* end the transaction */
+ res = PQexec(conn, "END");
+ PQclear(res);
+
+ /* close the connection to the database and cleanup */
+ PQfinish(conn);
+
+ return 0;
}
</programlisting>
</example>
<programlisting>
/*
* testlibpq2.c
- * Test of the asynchronous notification interface
+ * Test of the asynchronous notification interface
*
* Start this program, then from psql in another window do
* NOTIFY TBL2;
static void
exit_nicely(PGconn *conn)
{
- PQfinish(conn);
- exit(1);
+ PQfinish(conn);
+ exit(1);
}
int
main(int argc, char **argv)
{
- const char *conninfo;
- PGconn *conn;
- PGresult *res;
- PGnotify *notify;
- int nnotifies;
-
- /*
- * If the user supplies a parameter on the command line, use it as
- * the conninfo string; otherwise default to setting dbname=template1
- * and using environment variables or defaults for all other connection
- * parameters.
- */
- if (argc > 1)
- conninfo = argv[1];
- else
- conninfo = "dbname = template1";
-
- /* Make a connection to the database */
- conn = PQconnectdb(conninfo);
-
- /* Check to see that the backend connection was successfully made */
- if (PQstatus(conn) != CONNECTION_OK)
- {
- fprintf(stderr, "Connection to database '%s' failed.\n", PQdb(conn));
- fprintf(stderr, "%s", PQerrorMessage(conn));
- exit_nicely(conn);
- }
-
- /*
- * Issue LISTEN command to enable notifications from the rule's NOTIFY.
- */
- res = PQexec(conn, "LISTEN TBL2");
- if (PQresultStatus(res) != PGRES_COMMAND_OK)
- {
- fprintf(stderr, "LISTEN command failed: %s", PQerrorMessage(conn));
- PQclear(res);
- exit_nicely(conn);
- }
-
- /*
- * should PQclear PGresult whenever it is no longer needed to avoid
- * memory leaks
- */
- PQclear(res);
-
- /* Quit after four notifies are received. */
- nnotifies = 0;
- while (nnotifies < 4)
- {
- /*
- * Sleep until something happens on the connection. We use select(2)
- * to wait for input, but you could also use poll() or similar
- * facilities.
- */
- int sock;
- fd_set input_mask;
-
- sock = PQsocket(conn);
-
- if (sock < 0)
- break; /* shouldn't happen */
-
- FD_ZERO(&input_mask);
- FD_SET(sock, &input_mask);
-
- if (select(sock + 1, &input_mask, NULL, NULL, NULL) < 0)
- {
- fprintf(stderr, "select() failed: %s\n", strerror(errno));
- exit_nicely(conn);
- }
-
- /* Now check for input */
- PQconsumeInput(conn);
- while ((notify = PQnotifies(conn)) != NULL)
- {
- fprintf(stderr,
- "ASYNC NOTIFY of '%s' received from backend pid %d\n",
- notify->relname, notify->be_pid);
- PQfreemem(notify);
- nnotifies++;
- }
- }
-
- fprintf(stderr, "Done.\n");
-
- /* close the connection to the database and cleanup */
- PQfinish(conn);
-
- return 0;
+ const char *conninfo;
+ PGconn *conn;
+ PGresult *res;
+ PGnotify *notify;
+ int nnotifies;
+
+ /*
+ * If the user supplies a parameter on the command line, use it as
+ * the conninfo string; otherwise default to setting dbname=template1
+ * and using environment variables or defaults for all other connection
+ * parameters.
+ */
+ if (argc > 1)
+ conninfo = argv[1];
+ else
+ conninfo = "dbname = template1";
+
+ /* Make a connection to the database */
+ conn = PQconnectdb(conninfo);
+
+ /* Check to see that the backend connection was successfully made */
+ if (PQstatus(conn) != CONNECTION_OK)
+ {
+ fprintf(stderr, "Connection to database '%s' failed.\n", PQdb(conn));
+ fprintf(stderr, "%s", PQerrorMessage(conn));
+ exit_nicely(conn);
+ }
+
+ /*
+ * Issue LISTEN command to enable notifications from the rule's NOTIFY.
+ */
+ res = PQexec(conn, "LISTEN TBL2");
+ if (PQresultStatus(res) != PGRES_COMMAND_OK)
+ {
+ fprintf(stderr, "LISTEN command failed: %s", PQerrorMessage(conn));
+ PQclear(res);
+ exit_nicely(conn);
+ }
+
+ /*
+ * should PQclear PGresult whenever it is no longer needed to avoid
+ * memory leaks
+ */
+ PQclear(res);
+
+ /* Quit after four notifies are received. */
+ nnotifies = 0;
+ while (nnotifies < 4)
+ {
+ /*
+ * Sleep until something happens on the connection. We use select(2)
+ * to wait for input, but you could also use poll() or similar
+ * facilities.
+ */
+ int sock;
+ fd_set input_mask;
+
+ sock = PQsocket(conn);
+
+ if (sock < 0)
+ break; /* shouldn't happen */
+
+ FD_ZERO(&input_mask);
+ FD_SET(sock, &input_mask);
+
+ if (select(sock + 1, &input_mask, NULL, NULL, NULL) < 0)
+ {
+ fprintf(stderr, "select() failed: %s\n", strerror(errno));
+ exit_nicely(conn);
+ }
+
+ /* Now check for input */
+ PQconsumeInput(conn);
+ while ((notify = PQnotifies(conn)) != NULL)
+ {
+ fprintf(stderr,
+ "ASYNC NOTIFY of '%s' received from backend pid %d\n",
+ notify->relname, notify->be_pid);
+ PQfreemem(notify);
+ nnotifies++;
+ }
+ }
+
+ fprintf(stderr, "Done.\n");
+
+ /* close the connection to the database and cleanup */
+ PQfinish(conn);
+
+ return 0;
}
</programlisting>
</example>
<programlisting>
/*
* testlibpq3.c
- * Test out-of-line parameters and binary I/O.
+ * Test out-of-line parameters and binary I/O.
*
* Before running this, populate a database with the following commands
* (provided in src/test/examples/testlibpq3.sql):
static void
exit_nicely(PGconn *conn)
{
- PQfinish(conn);
- exit(1);
+ PQfinish(conn);
+ exit(1);
}
int
main(int argc, char **argv)
{
- const char *conninfo;
- PGconn *conn;
- PGresult *res;
- const char *paramValues[1];
- int i,
- j;
- int i_fnum,
- t_fnum,
- b_fnum;
-
- /*
- * If the user supplies a parameter on the command line, use it as
- * the conninfo string; otherwise default to setting dbname=template1
- * and using environment variables or defaults for all other connection
- * parameters.
- */
- if (argc > 1)
- conninfo = argv[1];
- else
- conninfo = "dbname = template1";
-
- /* Make a connection to the database */
- conn = PQconnectdb(conninfo);
-
- /* Check to see that the backend connection was successfully made */
- if (PQstatus(conn) != CONNECTION_OK)
- {
- fprintf(stderr, "Connection to database '%s' failed.\n", PQdb(conn));
- fprintf(stderr, "%s", PQerrorMessage(conn));
- exit_nicely(conn);
- }
-
- /*
- * The point of this program is to illustrate use of PQexecParams()
- * with out-of-line parameters, as well as binary transmission of
- * results. By using out-of-line parameters we can avoid a lot of
- * tedious mucking about with quoting and escaping. Notice how we
- * don't have to do anything special with the quote mark in the
- * parameter value.
- */
-
- /* Here is our out-of-line parameter value */
- paramValues[0] = "joe's place";
-
- res = PQexecParams(conn,
- "SELECT * FROM test1 WHERE t = $1",
- 1, /* one param */
- NULL, /* let the backend deduce param type */
- paramValues,
- NULL, /* don't need param lengths since text */
- NULL, /* default to all text params */
- 1); /* ask for binary results */
-
- if (PQresultStatus(res) != PGRES_TUPLES_OK)
- {
- fprintf(stderr, "SELECT failed: %s", PQerrorMessage(conn));
- PQclear(res);
- exit_nicely(conn);
- }
-
- /* Use PQfnumber to avoid assumptions about field order in result */
- i_fnum = PQfnumber(res, "i");
- t_fnum = PQfnumber(res, "t");
- b_fnum = PQfnumber(res, "b");
-
- for (i = 0; i < PQntuples(res); i++)
- {
- char *iptr;
- char *tptr;
- char *bptr;
- int blen;
- int ival;
-
- /* Get the field values (we ignore possibility they are null!) */
- iptr = PQgetvalue(res, i, i_fnum);
- tptr = PQgetvalue(res, i, t_fnum);
- bptr = PQgetvalue(res, i, b_fnum);
-
- /*
- * The binary representation of INT4 is in network byte order,
- * which we'd better coerce to the local byte order.
- */
- ival = ntohl(*((uint32_t *) iptr));
-
- /*
- * The binary representation of TEXT is, well, text, and since
- * libpq was nice enough to append a zero byte to it, it'll work
- * just fine as a C string.
- *
- * The binary representation of BYTEA is a bunch of bytes, which
- * could include embedded nulls so we have to pay attention to
- * field length.
- */
- blen = PQgetlength(res, i, b_fnum);
-
- printf("tuple %d: got\n", i);
- printf(" i = (%d bytes) %d\n",
- PQgetlength(res, i, i_fnum), ival);
- printf(" t = (%d bytes) '%s'\n",
- PQgetlength(res, i, t_fnum), tptr);
- printf(" b = (%d bytes) ", blen);
- for (j = 0; j < blen; j++)
- printf("\\%03o", bptr[j]);
- printf("\n\n");
- }
-
- PQclear(res);
-
- /* close the connection to the database and cleanup */
- PQfinish(conn);
-
- return 0;
+ const char *conninfo;
+ PGconn *conn;
+ PGresult *res;
+ const char *paramValues[1];
+ int i,
+ j;
+ int i_fnum,
+ t_fnum,
+ b_fnum;
+
+ /*
+ * If the user supplies a parameter on the command line, use it as
+ * the conninfo string; otherwise default to setting dbname=template1
+ * and using environment variables or defaults for all other connection
+ * parameters.
+ */
+ if (argc > 1)
+ conninfo = argv[1];
+ else
+ conninfo = "dbname = template1";
+
+ /* Make a connection to the database */
+ conn = PQconnectdb(conninfo);
+
+ /* Check to see that the backend connection was successfully made */
+ if (PQstatus(conn) != CONNECTION_OK)
+ {
+ fprintf(stderr, "Connection to database '%s' failed.\n", PQdb(conn));
+ fprintf(stderr, "%s", PQerrorMessage(conn));
+ exit_nicely(conn);
+ }
+
+ /*
+ * The point of this program is to illustrate use of PQexecParams()
+ * with out-of-line parameters, as well as binary transmission of
+ * results. By using out-of-line parameters we can avoid a lot of
+ * tedious mucking about with quoting and escaping. Notice how we
+ * don't have to do anything special with the quote mark in the
+ * parameter value.
+ */
+
+ /* Here is our out-of-line parameter value */
+ paramValues[0] = "joe's place";
+
+ res = PQexecParams(conn,
+ "SELECT * FROM test1 WHERE t = $1",
+ 1, /* one param */
+ NULL, /* let the backend deduce param type */
+ paramValues,
+ NULL, /* don't need param lengths since text */
+ NULL, /* default to all text params */
+ 1); /* ask for binary results */
+
+ if (PQresultStatus(res) != PGRES_TUPLES_OK)
+ {
+ fprintf(stderr, "SELECT failed: %s", PQerrorMessage(conn));
+ PQclear(res);
+ exit_nicely(conn);
+ }
+
+ /* Use PQfnumber to avoid assumptions about field order in result */
+ i_fnum = PQfnumber(res, "i");
+ t_fnum = PQfnumber(res, "t");
+ b_fnum = PQfnumber(res, "b");
+
+ for (i = 0; i < PQntuples(res); i++)
+ {
+ char *iptr;
+ char *tptr;
+ char *bptr;
+ int blen;
+ int ival;
+
+ /* Get the field values (we ignore possibility they are null!) */
+ iptr = PQgetvalue(res, i, i_fnum);
+ tptr = PQgetvalue(res, i, t_fnum);
+ bptr = PQgetvalue(res, i, b_fnum);
+
+ /*
+ * The binary representation of INT4 is in network byte order,
+ * which we'd better coerce to the local byte order.
+ */
+ ival = ntohl(*((uint32_t *) iptr));
+
+ /*
+ * The binary representation of TEXT is, well, text, and since
+ * libpq was nice enough to append a zero byte to it, it'll work
+ * just fine as a C string.
+ *
+ * The binary representation of BYTEA is a bunch of bytes, which
+ * could include embedded nulls so we have to pay attention to
+ * field length.
+ */
+ blen = PQgetlength(res, i, b_fnum);
+
+ printf("tuple %d: got\n", i);
+ printf(" i = (%d bytes) %d\n",
+ PQgetlength(res, i, i_fnum), ival);
+ printf(" t = (%d bytes) '%s'\n",
+ PQgetlength(res, i, t_fnum), tptr);
+ printf(" b = (%d bytes) ", blen);
+ for (j = 0; j < blen; j++)
+ printf("\\%03o", bptr[j]);
+ printf("\n\n");
+ }
+
+ PQclear(res);
+
+ /* close the connection to the database and cleanup */
+ PQfinish(conn);
+
+ return 0;
}
</programlisting>
</example>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/lobj.sgml,v 1.29 2003/06/21 21:51:33 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/lobj.sgml,v 1.30 2003/08/31 17:32:19 petere Exp $
-->
<chapter id="largeObjects">
<synopsis>
Oid lo_creat(PGconn *conn, int mode);
</synopsis>
+ <indexterm><primary>lo_creat</></>
creates a new large object.
<replaceable class="parameter">mode</replaceable> is a bit mask
describing several different attributes of the new
<synopsis>
Oid lo_import(PGconn *conn, const char *filename);
</synopsis>
- <replaceable class="parameter">filename</replaceable>
+ <indexterm><primary>lo_import</></>
+ <replaceable class="parameter">filename</replaceable>
specifies the operating system name of
the file to be imported as a large object.
The return value is the OID that was assigned to the new large object.
<synopsis>
int lo_export(PGconn *conn, Oid lobjId, const char *filename);
</synopsis>
+ <indexterm><primary>lo_export</></>
The <parameter>lobjId</parameter> argument specifies the OID of the large
object to export and the <parameter>filename</parameter> argument specifies
the operating system name name of the file.
<synopsis>
int lo_open(PGconn *conn, Oid lobjId, int mode);
</synopsis>
+ <indexterm><primary>lo_open</></>
The <parameter>lobjId</parameter> argument specifies the OID of the large
object to open. The <parameter>mode</parameter> bits control whether the
object is opened for reading (<symbol>INV_READ</>), writing (<symbol>INV_WRITE</symbol>), or
<synopsis>
int lo_write(PGconn *conn, int fd, const char *buf, size_t len);
</synopsis>
- writes <parameter>len</parameter> bytes from <parameter>buf</parameter> to large object <parameter>fd</>. The <parameter>fd</parameter>
- argument must have been returned by a previous <function>lo_open</function>.
- The number of bytes actually written is returned. In
- the event of an error, the return value is negative.
+ <indexterm><primary>lo_write</></> writes
+ <parameter>len</parameter> bytes from <parameter>buf</parameter>
+ to large object <parameter>fd</>. The <parameter>fd</parameter>
+ argument must have been returned by a previous
+ <function>lo_open</function>. The number of bytes actually
+ written is returned. In the event of an error, the return value
+ is negative.
</para>
</sect2>
<synopsis>
int lo_read(PGconn *conn, int fd, char *buf, size_t len);
</synopsis>
- reads <parameter>len</parameter> bytes from large object <parameter>fd</parameter> into <parameter>buf</parameter>. The <parameter>fd</parameter>
- argument must have been returned by a previous <function>lo_open</function>.
- The number of bytes actually read is returned. In
- the event of an error, the return value is negative.
+ <indexterm><primary>lo_read</></> reads
+ <parameter>len</parameter> bytes from large object
+ <parameter>fd</parameter> into <parameter>buf</parameter>. The
+ <parameter>fd</parameter> argument must have been returned by a
+ previous <function>lo_open</function>. The number of bytes
+ actually read is returned. In the event of an error, the return
+ value is negative.
</para>
</sect2>
<synopsis>
int lo_lseek(PGconn *conn, int fd, int offset, int whence);
</synopsis>
- This function moves the current location pointer for the
- large object described by <parameter>fd</> to the new location specified
- by <parameter>offset</>. The valid values for <parameter>whence</> are
- <symbol>SEEK_SET</> (seek from object start), <symbol>SEEK_CUR</> (seek from current position), and <symbol>SEEK_END</> (seek from object end). The return value is the new location pointer.
+ <indexterm><primary>lo_lseek</></> This function moves the
+ current location pointer for the large object described by
+ <parameter>fd</> to the new location specified by
+ <parameter>offset</>. The valid values for <parameter>whence</>
+ are <symbol>SEEK_SET</> (seek from object start),
+ <symbol>SEEK_CUR</> (seek from current position), and
+ <symbol>SEEK_END</> (seek from object end). The return value is
+ the new location pointer.
</para>
</sect2>
<synopsis>
int lo_tell(PGconn *conn, int fd);
</synopsis>
- If there is an error, the return value is negative.
+ <indexterm><primary>lo_tell</></> If there is an error, the
+ return value is negative.
</para>
</sect2>
<synopsis>
int lo_close(PGconn *conn, int fd);
</synopsis>
- where <parameter>fd</> is a large object descriptor returned by
- <function>lo_open</function>. On success, <function>lo_close</function>
- returns zero. On error, the return value is negative.
+ <indexterm><primary>lo_close</></> where <parameter>fd</> is a
+ large object descriptor returned by <function>lo_open</function>.
+ On success, <function>lo_close</function> returns zero. On
+ error, the return value is negative.
</para>
<para>
<synopsis>
int lo_unlink(PGconn *conn, Oid lobjId);
</synopsis>
- The <parameter>lobjId</parameter> argument specifies the OID of the large
- object to remove. In the event of an error, the return value is negative.
+ <indexterm><primary>lo_unlink</></> The
+ <parameter>lobjId</parameter> argument specifies the OID of the
+ large object to remove. In the event of an error, the return
+ value is negative.
</para>
</sect2>
<title>Server-side Functions</title>
<para>
- There are two built-in server-side functions, <function>lo_import</function>
- and <function>lo_export</function>, for large object access, which are available for use
- in <acronym>SQL</acronym>
- commands.
- Here is an example of their use:
+ There are two built-in server-side functions,
+ <function>lo_import</function><indexterm><primary>lo_import</></>
+ and
+ <function>lo_export</function>,<indexterm><primary>lo_export</></>
+ for large object access, which are available for use in
+ <acronym>SQL</acronym> commands. Here is an example of their
+ use:
<programlisting>
CREATE TABLE image (
name text,
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/maintenance.sgml,v 1.23 2003/06/18 12:19:11 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/maintenance.sgml,v 1.24 2003/08/31 17:32:19 petere Exp $
-->
<chapter id="maintenance">
<title>Routine Database Maintenance Tasks</title>
+ <indexterm zone="maintenance">
+ <primary>maintenance</primary>
+ </indexterm>
+
<para>
There are a few routine maintenance chores that must be performed on
a regular basis to keep a <productname>PostgreSQL</productname>
<sect2 id="vacuum-for-statistics">
<title>Updating planner statistics</title>
+ <indexterm zone="vacuum-for-statistics">
+ <primary>statistics</primary>
+ <secondary>of the planner</secondary>
+ </indexterm>
+
+ <indexterm zone="vacuum-for-statistics">
+ <primary>ANALYZE</primary>
+ </indexterm>
+
<para>
The <productname>PostgreSQL</productname> query planner relies on
statistical information about the contents of tables in order to
<title>Log File Maintenance</title>
<indexterm zone="logfile-maintenance">
- <primary>log files</primary>
+ <primary>server log</primary>
+ <secondary>log file maintenance</secondary>
</indexterm>
<para>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/manage-ag.sgml,v 2.27 2003/03/25 16:15:37 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/manage-ag.sgml,v 2.28 2003/08/31 17:32:19 petere Exp $
-->
<chapter id="managing-databases">
<sect1 id="manage-ag-overview">
<title>Overview</title>
+ <indexterm zone="manage-ag-overview">
+ <primary>schema</primary>
+ </indexterm>
+
<para>
A database is a named collection of <acronym>SQL</acronym> objects
(<quote>database objects</quote>). Generally, every database
</para>
<para>
- Databases are created with the SQL command
- <command>CREATE DATABASE</command>:
+ Databases are created with the SQL command <command>CREATE
+ DATABASE</command>:<indexterm><primary>CREATE DATABASE</></>
<synopsis>
CREATE DATABASE <replaceable>name</>;
</synopsis>
question remains how the <emphasis>first</> database at any given
site can be created. The first database is always created by the
<command>initdb</> command when the data storage area is
- initialized. (See <xref linkend="creating-cluster">.)
- This database is called <literal>template1</>. So to create the
- first <quote>real</> database you can connect to
+ initialized. (See <xref linkend="creating-cluster">.) This
+ database is called
+ <literal>template1</>.<indexterm><primary>template1</></> So to
+ create the first <quote>real</> database you can connect to
<literal>template1</>.
</para>
<para>
As an extra convenience, there is also a program that you can
execute from the shell to create new databases,
- <command>createdb</>.
+ <command>createdb</>.<indexterm><primary>createdb</></>
<synopsis>
createdb <replaceable class="parameter">dbname</replaceable>
<para>
<command>CREATE DATABASE</> actually works by copying an existing
database. By default, it copies the standard system database named
- <literal>template1</>. Thus that database is the <quote>template</>
- from which new databases are made. If you add objects to
- <literal>template1</>, these objects
+ <literal>template1</>.<indexterm><primary>template1</></> Thus that
+ database is the <quote>template</> from which new databases are
+ made. If you add objects to <literal>template1</>, these objects
will be copied into subsequently created user databases. This
behavior allows site-local modifications to the standard set of
objects in databases. For example, if you install the procedural
language <application>PL/pgSQL</> in <literal>template1</>, it will
- automatically be available in user databases without any extra action
- being taken when those databases are made.
+ automatically be available in user databases without any extra
+ action being taken when those databases are made.
</para>
<para>
- There is a second standard system database named <literal>template0</>.
- This database contains the same data as the initial contents of
- <literal>template1</>, that is, only the standard objects predefined by
- your version of <productname>PostgreSQL</productname>.
- <literal>template0</> should never be changed
- after <command>initdb</>. By instructing <command>CREATE DATABASE</> to
- copy <literal>template0</> instead of <literal>template1</>, you can
- create a <quote>virgin</> user database that contains none of the
- site-local additions in <literal>template1</>. This is particularly
- handy when restoring a <literal>pg_dump</> dump: the dump script should
- be restored in a virgin database to ensure that one recreates the
- correct contents of the dumped database, without any conflicts with
- additions that may now be present in <literal>template1</>.
+ There is a second standard system database named
+ <literal>template0</>.<indexterm><primary>template0</></> This
+ database contains the same data as the initial contents of
+ <literal>template1</>, that is, only the standard objects
+ predefined by your version of
+ <productname>PostgreSQL</productname>. <literal>template0</>
+ should never be changed after <command>initdb</>. By instructing
+ <command>CREATE DATABASE</> to copy <literal>template0</> instead
+ of <literal>template1</>, you can create a <quote>virgin</> user
+ database that contains none of the site-local additions in
+ <literal>template1</>. This is particularly handy when restoring a
+ <literal>pg_dump</> dump: the dump script should be restored in a
+ virgin database to ensure that one recreates the correct contents
+ of the dumped database, without any conflicts with additions that
+ may now be present in <literal>template1</>.
</para>
<para>
</para>
<para>
- Two useful flags exist in <literal>pg_database</literal> for each
+ Two useful flags exist in <literal>pg_database</literal><indexterm><primary>pg_database</></> for each
database: the columns <literal>datistemplate</literal> and
<literal>datallowconn</literal>. <literal>datistemplate</literal>
may be set to indicate that a database is intended as a template for
<title>Destroying a Database</title>
<para>
- Databases are destroyed with the command <command>DROP DATABASE</command>:
+ Databases are destroyed with the command <command>DROP
+ DATABASE</command>:<indexterm><primary>DROP DATABASE</></>
<synopsis>
DROP DATABASE <replaceable>name</>;
</synopsis>
</para>
<para>
- For convenience, there is also a shell program to drop databases:
+ For convenience, there is also a shell program to drop
+ databases:<indexterm><primary>dropdb</></>
<synopsis>
dropdb <replaceable class="parameter">dbname</replaceable>
</synopsis>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/monitoring.sgml,v 1.20 2003/04/04 03:03:53 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/monitoring.sgml,v 1.21 2003/08/31 17:32:19 petere Exp $
-->
<chapter id="monitoring">
<title>Monitoring Database Activity</title>
+ <indexterm zone="monitoring">
+ <primary>monitoring</primary>
+ <secondary>database activity</secondary>
+ </indexterm>
+
+ <indexterm zone="monitoring">
+ <primary>database activity</primary>
+ <secondary>monitoring</secondary>
+ </indexterm>
+
<para>
A database administrator frequently wonders, <quote>What is the system
doing right now?</quote>
<sect1 id="monitoring-locks">
<title>Viewing Locks</title>
+ <indexterm zone="monitoring-locks">
+ <primary>lock</primary>
+ <secondary>monitoring</secondary>
+ </indexterm>
+
<para>
Another useful tool for monitoring database activity is the
<literal>pg_locks</literal> system table. It allows the
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/mvcc.sgml,v 2.35 2003/03/25 16:15:37 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/mvcc.sgml,v 2.36 2003/08/31 17:32:19 petere Exp $
-->
<chapter id="mvcc">
<sect1 id="mvcc-intro">
<title>Introduction</title>
+ <indexterm>
+ <primary>MVCC</primary>
+ </indexterm>
+
<para>
Unlike traditional database systems which use locks for concurrency control,
<productname>PostgreSQL</productname>
<sect1 id="transaction-iso">
<title>Transaction Isolation</title>
+ <indexterm>
+ <primary>transaction isolation</primary>
+ </indexterm>
+
<para>
The <acronym>SQL</acronym> standard defines four levels of
transaction isolation in terms of three phenomena that must be
<para>
<indexterm>
- <primary>isolation levels</primary>
+ <primary>transaction isolation level</primary>
</indexterm>
The four transaction isolation levels and the corresponding
behaviors are described in <xref linkend="mvcc-isolevel-table">.
<title>Read Committed Isolation Level</title>
<indexterm>
- <primary>isolation levels</primary>
+ <primary>transaction isolation level</primary>
<secondary>read committed</secondary>
</indexterm>
<title>Serializable Isolation Level</title>
<indexterm>
- <primary>isolation levels</primary>
+ <primary>transaction isolation level</primary>
<secondary>serializable</secondary>
</indexterm>
<title>Explicit Locking</title>
<indexterm>
- <primary>locking</primary>
+ <primary>lock</primary>
</indexterm>
<para>
<sect2 id="locking-tables">
<title>Table-Level Locks</title>
+ <indexterm zone="locking-tables">
+ <primary>LOCK</primary>
+ </indexterm>
+
<para>
The list below shows the available lock modes and the contexts in
which they are used automatically by
<sect2 id="locking-deadlocks">
<title>Deadlocks</title>
+ <indexterm zone="locking-deadlocks">
+ <primary>deadlock</primary>
+ </indexterm>
+
<para>
The use of explicit locking can increase the likelyhood of
<firstterm>deadlocks</>, wherein two (or more) transactions each
<sect1 id="locking-indexes">
<title>Locking and Indexes</title>
+ <indexterm zone="locking-indexes">
+ <primary>index</primary>
+ <secondary>locks</secondary>
+ </indexterm>
+
<para>
Though <productname>PostgreSQL</productname>
provides nonblocking read/write access to table
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/perform.sgml,v 1.30 2003/06/25 02:07:33 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/perform.sgml,v 1.31 2003/08/31 17:32:19 petere Exp $
-->
<chapter id="performance-tips">
<sect1 id="using-explain">
<title>Using <command>EXPLAIN</command></title>
+ <indexterm zone="using-explain">
+ <primary>EXPLAIN</primary>
+ </indexterm>
+
+ <indexterm zone="using-explain">
+ <primary>query plan</primary>
+ </indexterm>
+
<para>
<productname>PostgreSQL</productname> devises a <firstterm>query
plan</firstterm> for each query it is given. Choosing the right
<sect1 id="planner-stats">
<title>Statistics Used by the Planner</title>
+ <indexterm zone="planner-stats">
+ <primary>statistics</primary>
+ <secondary>of the planner</secondary>
+ </indexterm>
+
<para>
As we saw in the previous section, the query planner needs to estimate
the number of rows retrieved by a query in order to make good choices
since it does not read every row of the table.
</para>
+ <indexterm>
+ <primary>pg_statistic</primary>
+ </indexterm>
+
<para>
Most queries retrieve only a fraction of the rows in a table, due
to having <literal>WHERE</> clauses that restrict the rows to be examined.
and are always approximate even when freshly updated.
</para>
+ <indexterm>
+ <primary>pg_stats</primary>
+ </indexterm>
+
<para>
Rather than look at <structname>pg_statistic</structname> directly,
it's better to look at its view <structname>pg_stats</structname>
<sect1 id="explicit-joins">
<title>Controlling the Planner with Explicit <literal>JOIN</> Clauses</title>
+ <indexterm zone="explicit-joins">
+ <primary>join</primary>
+ <secondary>controlling the order</secondary>
+ </indexterm>
+
<para>
It is possible
to control the query planner to some extent by using the explicit <literal>JOIN</>
<sect2 id="disable-autocommit">
<title>Disable Autocommit</title>
+ <indexterm zone="disable-autocommit">
+ <primary>autocommit</primary>
+ </indexterm>
+
<para>
Turn off autocommit and just do one commit at
the end. (In plain SQL, this means issuing <command>BEGIN</command>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/plperl.sgml,v 2.19 2003/04/07 01:29:25 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/plperl.sgml,v 2.20 2003/08/31 17:32:19 petere Exp $
-->
<chapter id="plperl">
</para>
<para>
- If an SQL null value is passed to a function, the argument value
- will appear as <quote>undefined</> in Perl. The above function
- definition will not behave very nicely with null inputs (in fact,
- it will act as though they are zeroes). We could add
- <literal>STRICT</> to the function definition to make
+ If an SQL null value<indexterm><primary>null value</><secondary
+ sortas="PL/Perl">in PL/Perl</></indexterm> is passed to a function,
+ the argument value will appear as <quote>undefined</> in Perl. The
+ above function definition will not behave very nicely with null
+ inputs (in fact, it will act as though they are zeroes). We could
+ add <literal>STRICT</> to the function definition to make
<productname>PostgreSQL</productname> do something more reasonable:
if a null value is passed, the function will not be called at all,
but will just return a null result automatically. Alternatively,
mirror sites</ulink>). This module makes available a
<acronym>DBI</>-compliant database-handle named
<varname>$pg_dbh</varname> that can be used to perform queries
- with normal <acronym>DBI</> syntax.
+ with normal <acronym>DBI</> syntax.<indexterm><primary>DBI</></indexterm>
</para>
<para>
<varlistentry>
<indexterm>
<primary>elog</primary>
- <secondary>PL/Perl</secondary>
+ <secondary>in PL/Perl</secondary>
</indexterm>
<term><function>elog</> <replaceable>level</replaceable>, <replaceable>msg</replaceable></term>
<sect1 id="plperl-trusted">
<title>Trusted and Untrusted PL/Perl</title>
+ <indexterm zone="plperl-trusted">
+ <primary>trusted</primary>
+ <secondary>PL/Perl</secondary>
+ </indexterm>
+
<para>
Normally, PL/Perl is installed as a <quote>trusted</> programming
language named <literal>plperl</>. In this setup, certain Perl
<para>
Sometimes it is desirable to write Perl functions that are not
- restricted. For example, one might want a Perl function that
- sends mail. To handle these cases, PL/Perl can also be installed
- as an <quote>untrusted</> language (usually called
- <application>PL/PerlU</application>). In this case the full Perl language is
- available. If the <command>createlang</command> program is used to
- install the language, the language name <literal>plperlu</literal>
- will select the untrusted PL/Perl variant.
+ restricted. For example, one might want a Perl function that sends
+ mail. To handle these cases, PL/Perl can also be installed as an
+ <quote>untrusted</> language (usually called
+ <application>PL/PerlU</application><indexterm><primary>PL/PerlU</></indexterm>).
+ In this case the full Perl language is available. If the
+ <command>createlang</command> program is used to install the
+ language, the language name <literal>plperlu</literal> will select
+ the untrusted PL/Perl variant.
</para>
<para>
<listitem>
<para>
- PL/Perl cannot be used to write trigger functions.
+ PL/Perl cannot be used to write trigger
+ functions.<indexterm><primary>trigger</><secondary>in
+ PL/Perl</></indexterm>
</para>
</listitem>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/plpgsql.sgml,v 1.20 2003/08/09 22:50:22 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/plpgsql.sgml,v 1.21 2003/08/31 17:32:19 petere Exp $
-->
<chapter id="plpgsql">
</para>
<para>
- As each expression and <acronym>SQL</acronym> command is first used
- in the function, the <application>PL/pgSQL</> interpreter creates
- a prepared execution plan (using the <acronym>SPI</acronym>
- manager's <function>SPI_prepare</function> and
- <function>SPI_saveplan</function> functions). Subsequent visits
- to that expression or command reuse the prepared plan. Thus, a
- function with conditional code that contains many statements for
- which execution plans might be required will only prepare and save
- those plans that are really used during the lifetime of the
- database connection. This can substantially reduce the total
- amount of time required to parse, and generate execution plans for the
- statements in a <application>PL/pgSQL</> function. A disadvantage is
- that errors in a specific expression or command may not be detected
- until that part of the function is reached in execution.
+ As each expression and <acronym>SQL</acronym> command is first
+ used in the function, the <application>PL/pgSQL</> interpreter
+ creates a prepared execution plan (using the
+ <acronym>SPI</acronym> manager's <function>SPI_prepare</function>
+ and <function>SPI_saveplan</function>
+ functions).<indexterm><primary>preparing a query</><secondary>in
+ PL/pgSQL</></> Subsequent visits to that expression or command
+ reuse the prepared plan. Thus, a function with conditional code
+ that contains many statements for which execution plans might be
+ required will only prepare and save those plans that are really
+ used during the lifetime of the database connection. This can
+ substantially reduce the total amount of time required to parse,
+ and generate execution plans for the statements in a
+ <application>PL/pgSQL</> function. A disadvantage is that errors
+ in a specific expression or command may not be detected until that
+ part of the function is reached in execution.
</para>
<para>
and return the <quote>polymorphic</> types
<type>anyelement</type> and <type>anyarray</type>. The actual
datatypes handled by a polymorphic function can vary from call to
- call, as discussed in <xref linkend="types-polymorphic">.
+ call, as discussed in <xref linkend="extend-types-polymorphic">.
An example is shown in <xref linkend="plpgsql-declaration-aliases">.
</para>
or <type>anyarray</type>), a special parameter <literal>$0</literal>
is created. Its datatype is the actual return type of the function,
as deduced from the actual input types (see <xref
- linkend="types-polymorphic">).
+ linkend="extend-types-polymorphic">).
This allows the function to access its actual return type
as shown in <xref linkend="plpgsql-declaration-type">.
<literal>$0</literal> is initialized to NULL and can be modified by
<sect2 id="plpgsql-select-into">
<title><command>SELECT INTO</command></title>
+ <indexterm zone="plpgsql-select-into">
+ <primary>SELECT INTO</primary>
+ <secondary>in PL/pgSQL</secondary>
+ </indexterm>
+
<para>
The result of a <command>SELECT</command> command yielding multiple columns (but
only one row) can be assigned to a record variable, row-type
<para>
This example shows use of the functions
<function>quote_ident(<type>text</type>)</function> and
- <function>quote_literal(<type>text</type>)</function>.
- Variables containing column and table identifiers should be
- passed to function <function>quote_ident</function>.
- Variables containing values that should be literal strings in the
- constructed command should be passed to
- <function>quote_literal</function>. Both take the
- appropriate steps to return the input text enclosed in double
- or single quotes respectively, with any embedded special characters
+ <function>quote_literal(<type>text</type>)</function>.<indexterm><primary>quote_ident</><secondary>use
+ in
+ PL/pgSQL</></indexterm><indexterm><primary>quote_literal</><secondary>use
+ in PL/pgSQL</></indexterm> Variables containing column and table
+ identifiers should be passed to function
+ <function>quote_ident</function>. Variables containing values
+ that should be literal strings in the constructed command should
+ be passed to <function>quote_literal</function>. Both take the
+ appropriate steps to return the input text enclosed in double or
+ single quotes respectively, with any embedded special characters
properly escaped.
</para>
<sect2 id="plpgsql-control-structures-loops">
<title>Simple Loops</title>
+ <indexterm zone="plpgsql-control-structures-loops">
+ <primary>loop</primary>
+ <secondary>in PL/pgSQL</secondary>
+ </indexterm>
+
<para>
With the <literal>LOOP</>, <literal>EXIT</>, <literal>WHILE</>,
and <literal>FOR</> statements, you can arrange for your
<sect1 id="plpgsql-cursors">
<title>Cursors</title>
+ <indexterm zone="plpgsql-cursors">
+ <primary>cursor</primary>
+ <secondary>in PL/pgSQL</secondary>
+ </indexterm>
+
<para>
Rather than executing a whole query at once, it is possible to set
up a <firstterm>cursor</> that encapsulates the query, and then read
<sect1 id="plpgsql-trigger">
<title>Trigger Procedures</title>
+ <indexterm zone="plpgsql-trigger">
+ <primary>trigger</primary>
+ <secondary>in PL/pgSQL</secondary>
+ </indexterm>
+
<para>
<application>PL/pgSQL</application> can be used to define trigger
procedures. A trigger procedure is created with the
<indexterm zone="plpgsql-porting">
<primary>Oracle</primary>
+ <secondary>porting from PL/SQL to PL/pgSQL</secondary>
</indexterm>
<indexterm zone="plpgsql-porting">
- <primary>PL/SQL</primary>
+ <primary>PL/SQL (Oracle)</primary>
+ <secondary>porting to PL/pgSQL</secondary>
</indexterm>
<para>
with <literal>OUT</> parameters and string manipulation.
<productname>PostgreSQL</> does not have an
<function>instr</function> function, but you can work around it
- using a combination of other functions. In <xref
+ using a combination of other
+ functions.<indexterm><primary>instr</></indexterm> In <xref
linkend="plpgsql-porting-appendix"> there is a
<application>PL/pgSQL</application> implementation of
<function>instr</function> that you can use to make your porting
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/plpython.sgml,v 1.18 2003/07/01 13:52:29 tgl Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/plpython.sgml,v 1.19 2003/08/31 17:32:19 petere Exp $ -->
<chapter id="plpython">
<title>PL/Python - Python Procedural Language</title>
<para>
If you do not provide a return value, Python returns the default
- <symbol>None</symbol>. The
- language module translates Python's <symbol>None</symbol> into the
- SQL null value.
+ <symbol>None</symbol>. The language module translates Python's
+ <symbol>None</symbol> into the SQL null
+ value.<indexterm><primary>null value</><secondary
+ sortas="PL/Python">in PL/Python</></indexterm>
</para>
<para>
The global dictionary <varname>SD</varname> is available to store
data between function calls. This variable is private static data.
The global dictionary <varname>GD</varname> is public data,
- available to all Python functions within a session. Use with care.
+ available to all Python functions within a session. Use with
+ care.<indexterm><primary>global data</><secondary>in
+ PL/Python</></indexterm>
</para>
<para>
<sect1 id="plpython-trigger">
<title>Trigger Functions</title>
+ <indexterm zone="plpython-trigger">
+ <primary>trigger</primary>
+ <secondary>in PL/Python</secondary>
+ </indexterm>
+
<para>
When a function is used in a trigger, the dictionary
<literal>TD</literal> contains trigger-related values. The trigger
<literal>plpy.error("msg")</literal>, and
<literal>plpy.fatal("msg")</literal>. They are mostly equivalent
to calling <literal>elog(<replaceable>LEVEL</>, "msg")</literal>
- from C code. <function>plpy.error</function> and
+ from C code.<indexterm><primary>elog</><secondary>in
+ PL/Python</></indexterm> <function>plpy.error</function> and
<function>plpy.fatal</function> actually raise a Python exception
which, if uncaught, causes the PL/Python module to call
<literal>elog(ERROR, msg)</literal> when the function handler
</para>
<para>
- The second function, <function>plpy.prepare</function>, prepares the
- execution plan for a query. It is called with a query string and a
- list of parameter types, if you have parameter references in the
- query. For example:
+ <indexterm><primary>preparing a query</><secondary>in PL/Python</></indexterm>
+ The second function, <function>plpy.prepare</function>, prepares
+ the execution plan for a query. It is called with a query string
+ and a list of parameter types, if you have parameter references in
+ the query. For example:
<programlisting>
plan = plpy.prepare("SELECT last_name FROM my_users WHERE first_name = $1", [ "text" ])
</programlisting>
</para>
</sect1>
-<!-- NOT CURRENTLY SUPPORTED
+<![IGNORE[
+ <!-- NOT CURRENTLY SUPPORTED -->
<sect1 id="plpython-trusted">
<title>Restricted Environment</title>
</para>
</sect1>
--->
+]]>
</chapter>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/pltcl.sgml,v 2.24 2003/06/22 16:17:00 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/pltcl.sgml,v 2.25 2003/08/31 17:32:19 petere Exp $
-->
<chapter id="pltcl">
<sect1 id="pltcl-global">
<title>Global Data in PL/Tcl</title>
+ <indexterm zone="pltcl-global">
+ <primary>global data</primary>
+ <secondary>in PL/Tcl</secondary>
+ </indexterm>
+
<para>
Sometimes it
is useful to have some global data that is held between two
<term><function>spi_prepare</function> <replaceable>query</replaceable> <replaceable>typelist</replaceable></term>
<listitem>
<para>
- Prepares and saves a query plan for later execution. The saved plan
- will be retained for the life of the current session.
+ Prepares and saves a query plan for later execution. The
+ saved plan will be retained for the life of the current
+ session.<indexterm><primary>preparing a query</><secondary>in
+ PL/Tcl</></>
</para>
<para>
The query may use parameters, that is, placeholders for
<varlistentry>
<indexterm>
<primary>elog</primary>
- <secondary>PL/Tcl</secondary>
+ <secondary>in PL/Tcl</secondary>
</indexterm>
<term><function>elog</> <replaceable>level</replaceable> <replaceable>msg</replaceable></term>
<listitem>
<title>Trigger Procedures in PL/Tcl</title>
<indexterm>
- <primary>triggers</primary>
+ <primary>trigger</primary>
<secondary>in PL/Tcl</secondary>
</indexterm>
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/queries.sgml,v 1.22 2003/08/14 23:13:27 tgl Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/queries.sgml,v 1.23 2003/08/31 17:32:19 petere Exp $ -->
<chapter id="queries">
<title>Queries</title>
+ <indexterm zone="queries">
+ <primary>query</primary>
+ </indexterm>
+
+ <indexterm zone="queries">
+ <primary>SELECT</primary>
+ </indexterm>
+
<para>
The previous chapters explained how to create tables, how to fill
them with data, and how to manipulate that data. Now we finally
<sect1 id="queries-table-expressions">
<title>Table Expressions</title>
+ <indexterm zone="queries-table-expressions">
+ <primary>table expression</primary>
+ </indexterm>
+
<para>
A <firstterm>table expression</firstterm> computes a table. The
table expression contains a <literal>FROM</> clause that is
overall table expression.
</para>
+ <indexterm>
+ <primary>ONLY</primary>
+ </indexterm>
+
<para>
When a table reference names a table that is the supertable of a
table inheritance hierarchy, the table reference produces rows of
<title>Joined Tables</title>
<indexterm zone="queries-join">
- <primary>joins</primary>
+ <primary>join</primary>
</indexterm>
<para>
<term>Cross join</term>
<indexterm>
- <primary>joins</primary>
+ <primary>join</primary>
<secondary>cross</secondary>
</indexterm>
+ <indexterm>
+ <primary>cross join</primary>
+ </indexterm>
+
<listitem>
<synopsis>
<replaceable>T1</replaceable> CROSS JOIN <replaceable>T2</replaceable>
<term>Qualified joins</term>
<indexterm>
- <primary>joins</primary>
+ <primary>join</primary>
<secondary>outer</secondary>
</indexterm>
+ <indexterm>
+ <primary>outer join</primary>
+ </indexterm>
+
<listitem>
<synopsis>
<replaceable>T1</replaceable> { <optional>INNER</optional> | { LEFT | RIGHT | FULL } <optional>OUTER</optional> } JOIN <replaceable>T2</replaceable> ON <replaceable>boolean_expression</replaceable>
<para>
<indexterm>
- <primary>joins</primary>
+ <primary>join</primary>
<secondary>natural</secondary>
</indexterm>
+ <indexterm>
+ <primary>natural join</primary>
+ </indexterm>
Finally, <literal>NATURAL</> is a shorthand form of
<literal>USING</>: it forms a <literal>USING</> list
consisting of exactly those column names that appear in both
<term><literal>LEFT OUTER JOIN</></term>
<indexterm>
- <primary>joins</primary>
+ <primary>join</primary>
<secondary>left</secondary>
</indexterm>
+ <indexterm>
+ <primary>left join</primary>
+ </indexterm>
+
<listitem>
<para>
First, an inner join is performed. Then, for each row in
<varlistentry>
<term><literal>RIGHT OUTER JOIN</></term>
+ <indexterm>
+ <primary>join</primary>
+ <secondary>right</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>right join</primary>
+ </indexterm>
+
<listitem>
<para>
First, an inner join is performed. Then, for each row in
<title>Table and Column Aliases</title>
<indexterm zone="queries-table-aliases">
- <primary>label</primary>
- <secondary>table</secondary>
+ <primary>alias</primary>
+ <secondary>in the FROM clause</secondary>
</indexterm>
<indexterm>
- <primary>alias</primary>
- <see>label</see>
+ <primary>label</primary>
+ <see>alias</see>
</indexterm>
<para>
<title>Subqueries</title>
<indexterm zone="queries-subqueries">
- <primary>subqueries</primary>
+ <primary>subquery</primary>
</indexterm>
<para>
<indexterm zone="queries-tablefunctions"><primary>table function</></>
+ <indexterm zone="queries-tablefunctions">
+ <primary>function</>
+ <secondary>in the FROM clause</>
+ </indexterm>
+
<para>
Table functions are functions that produce a set of rows, made up
of either base data types (scalar types) or composite data types
<title>The WHERE Clause</title>
<indexterm zone="queries-where">
- <primary>where</primary>
+ <primary>WHERE</primary>
</indexterm>
<para>
<title>The GROUP BY and HAVING Clauses</title>
<indexterm zone="queries-group">
- <primary>group</primary>
+ <primary>GROUP BY</primary>
+ </indexterm>
+
+ <indexterm zone="queries-group">
+ <primary>grouping</primary>
</indexterm>
<para>
column names is also allowed.
</para>
+ <indexterm>
+ <primary>HAVING</primary>
+ </indexterm>
+
<para>
If a table has been grouped using a <literal>GROUP BY</literal>
clause, but then only certain groups are of interest, the
<title>Select Lists</title>
<indexterm>
- <primary>select</primary>
+ <primary>SELECT</primary>
<secondary>select list</secondary>
</indexterm>
<sect2 id="queries-select-list-items">
<title>Select-List Items</title>
+ <indexterm>
+ <primary>*</primary>
+ </indexterm>
+
<para>
The simplest kind of select list is <literal>*</literal> which
emits all columns that the table expression produces. Otherwise,
<title>Column Labels</title>
<indexterm zone="queries-column-labels">
- <primary>label</primary>
- <secondary>column</secondary>
+ <primary>alias</primary>
+ <secondary>in the select list</secondary>
</indexterm>
<para>
<title>DISTINCT</title>
<indexterm zone="queries-distinct">
- <primary>distinct</primary>
+ <primary>DISTINCT</primary>
+ </indexterm>
+
+ <indexterm zone="queries-distinct">
+ <primary>duplicates</primary>
</indexterm>
<para>
</para>
<para>
+ <indexterm><primary>null value</><secondary sortas="DISTINCT">in
+ DISTINCT</></indexterm>
Obviously, two rows are considered distinct if they differ in at
least one column value. Null values are considered equal in this
comparison.
<title>Combining Queries</title>
<indexterm zone="queries-union">
- <primary>union</primary>
+ <primary>UNION</primary>
+ </indexterm>
+ <indexterm zone="queries-union">
+ <primary>INTERSECT</primary>
+ </indexterm>
+ <indexterm zone="queries-union">
+ <primary>EXCEPT</primary>
+ </indexterm>
+ <indexterm zone="queries-union">
+ <primary>set union</primary>
+ </indexterm>
+ <indexterm zone="queries-union">
+ <primary>set intersection</primary>
</indexterm>
<indexterm zone="queries-union">
- <primary>intersection</primary>
+ <primary>set difference</primary>
</indexterm>
<indexterm zone="queries-union">
- <primary>except</primary>
+ <primary>set operation</primary>
</indexterm>
<para>
<indexterm zone="queries-order">
<primary>sorting</primary>
- <secondary>query results</secondary>
+ </indexterm>
+
+ <indexterm zone="queries-order">
+ <primary>ORDER BY</primary>
</indexterm>
<para>
<title>LIMIT and OFFSET</title>
<indexterm zone="queries-limit">
- <primary>limit</primary>
+ <primary>LIMIT</primary>
</indexterm>
<indexterm zone="queries-limit">
- <primary>offset</primary>
- <secondary>with query results</secondary>
+ <primary>OFFSET</primary>
</indexterm>
<para>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/query.sgml,v 1.32 2003/06/24 23:27:24 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/query.sgml,v 1.33 2003/08/31 17:32:19 petere Exp $
-->
<chapter id="tutorial-sql">
</para>
<para>
- <indexterm><primary>cluster</primary></indexterm>
+ <indexterm><primary>database cluster</primary></indexterm>
+ <indexterm><primary>cluster</primary><secondary>of databases</secondary><see>database cluster</see></indexterm>
Tables are grouped into databases, and a collection of databases
managed by a single <productname>PostgreSQL</productname> server
<title>Aggregate Functions</title>
<indexterm zone="tutorial-agg">
- <primary>aggregate</primary>
+ <primary>aggregate function</primary>
</indexterm>
<para>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/abort.sgml,v 1.13 2003/04/26 23:56:51 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/abort.sgml,v 1.14 2003/08/31 17:32:21 petere Exp $
PostgreSQL documentation
-->
<refpurpose>abort the current transaction</refpurpose>
</refnamediv>
+ <indexterm zone="sql-abort">
+ <primary>ABORT</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
ABORT [ WORK | TRANSACTION ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_aggregate.sgml,v 1.1 2003/06/27 14:45:25 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_aggregate.sgml,v 1.2 2003/08/31 17:32:21 petere Exp $
PostgreSQL documentation
-->
<refpurpose>change the definition of an aggregate function</refpurpose>
</refnamediv>
+ <indexterm zone="sql-alteraggregate">
+ <primary>ALTER AGGREGATE</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
ALTER AGGREGATE <replaceable>name</replaceable> ( <replaceable>type</replaceable> ) RENAME TO <replaceable>newname</replaceable>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_conversion.sgml,v 1.1 2003/06/27 14:45:25 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_conversion.sgml,v 1.2 2003/08/31 17:32:21 petere Exp $
PostgreSQL documentation
-->
<refpurpose>change the definition of a conversion</refpurpose>
</refnamediv>
+ <indexterm zone="sql-alterconversion">
+ <primary>ALTER CONVERSION</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
ALTER CONVERSION <replaceable>name</replaceable> RENAME TO <replaceable>newname</replaceable>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_database.sgml,v 1.7 2003/06/27 14:45:25 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_database.sgml,v 1.8 2003/08/31 17:32:21 petere Exp $
PostgreSQL documentation
-->
<refpurpose>change a database</refpurpose>
</refnamediv>
+ <indexterm zone="sql-alterdatabase">
+ <primary>ALTER DATABASE</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
ALTER DATABASE <replaceable class="PARAMETER">name</replaceable> SET <replaceable>variable</replaceable> { TO | = } { <replaceable>value</replaceable> | DEFAULT }
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_domain.sgml,v 1.7 2003/01/06 00:31:44 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_domain.sgml,v 1.8 2003/08/31 17:32:21 petere Exp $
PostgreSQL documentation
-->
<refentrytitle id="sql-alterdomain-title">ALTER DOMAIN</refentrytitle>
<refmiscinfo>SQL - Language Statements</refmiscinfo>
</refmeta>
+
<refnamediv>
<refname>
ALTER DOMAIN
change the definition of a domain
</refpurpose>
</refnamediv>
+
+ <indexterm zone="sql-alterdomain">
+ <primary>ALTER DOMAIN</primary>
+ </indexterm>
+
<refsynopsisdiv>
<refsynopsisdivinfo>
<date>2002-11-27</date>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_function.sgml,v 1.1 2003/06/27 14:45:25 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_function.sgml,v 1.2 2003/08/31 17:32:21 petere Exp $
PostgreSQL documentation
-->
<refpurpose>change the definition of a function</refpurpose>
</refnamediv>
+ <indexterm zone="sql-alterfunction">
+ <primary>ALTER FUNCTION</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
ALTER FUNCTION <replaceable>name</replaceable> ( [ <replaceable class="parameter">type</replaceable> [, ...] ] ) RENAME TO <replaceable>newname</replaceable>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_group.sgml,v 1.10 2003/06/27 14:45:25 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_group.sgml,v 1.11 2003/08/31 17:32:21 petere Exp $
PostgreSQL documentation
-->
<refpurpose>change a user group</refpurpose>
</refnamediv>
+ <indexterm zone="sql-altergroup">
+ <primary>ALTER GROUP</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
ALTER GROUP <replaceable class="PARAMETER">groupname</replaceable> ADD USER <replaceable class="PARAMETER">username</replaceable> [, ... ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_language.sgml,v 1.1 2003/06/27 14:45:25 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_language.sgml,v 1.2 2003/08/31 17:32:21 petere Exp $
PostgreSQL documentation
-->
<refpurpose>change the definition of a procedural language</refpurpose>
</refnamediv>
+ <indexterm zone="sql-alterlanguage">
+ <primary>ALTER LANGUAGE</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
ALTER LANGUAGE <replaceable>name</replaceable> RENAME TO <replaceable>newname</replaceable>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_opclass.sgml,v 1.1 2003/06/27 14:45:26 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_opclass.sgml,v 1.2 2003/08/31 17:32:21 petere Exp $
PostgreSQL documentation
-->
<refpurpose>change the definition of an operator class</refpurpose>
</refnamediv>
+ <indexterm zone="sql-alteropclass">
+ <primary>ALTER OPERATOR CLASS</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
ALTER OPERATOR CLASS <replaceable>name</replaceable> USING <replaceable class="parameter">index_method</replaceable> RENAME TO <replaceable>newname</replaceable>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_schema.sgml,v 1.1 2003/06/27 14:45:26 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_schema.sgml,v 1.2 2003/08/31 17:32:21 petere Exp $
PostgreSQL documentation
-->
<refpurpose>change the definition of a schema</refpurpose>
</refnamediv>
+ <indexterm zone="sql-alterschema">
+ <primary>ALTER SCHEMA</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
ALTER SCHEMA <replaceable>name</replaceable> RENAME TO <replaceable>newname</replaceable>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_sequence.sgml,v 1.2 2003/06/12 07:49:43 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_sequence.sgml,v 1.3 2003/08/31 17:32:21 petere Exp $
PostgreSQL documentation
-->
<refentrytitle id="SQL-ALTERSEQUENCE-TITLE">ALTER SEQUENCE</refentrytitle>
<refmiscinfo>SQL - Language Statements</refmiscinfo>
</refmeta>
+
<refnamediv>
<refname>
ALTER SEQUENCE
alter the definition of a sequence generator
</refpurpose>
</refnamediv>
+
+ <indexterm zone="sql-altersequence">
+ <primary>ALTER SEQUENCE</primary>
+ </indexterm>
+
<refsynopsisdiv>
<refsynopsisdivinfo>
<date>1999-07-20</date>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_table.sgml,v 1.59 2003/04/15 13:25:08 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_table.sgml,v 1.60 2003/08/31 17:32:21 petere Exp $
PostgreSQL documentation
-->
<refpurpose>change the definition of a table</refpurpose>
</refnamediv>
+ <indexterm zone="sql-altertable">
+ <primary>ALTER TABLE</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
ALTER TABLE [ ONLY ] <replaceable class="PARAMETER">table</replaceable> [ * ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_trigger.sgml,v 1.4 2003/04/15 13:25:08 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_trigger.sgml,v 1.5 2003/08/31 17:32:21 petere Exp $
PostgreSQL documentation
-->
<refpurpose>change the definition of a trigger</refpurpose>
</refnamediv>
+ <indexterm zone="sql-altertrigger">
+ <primary>ALTER TRIGGER</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
ALTER TRIGGER <replaceable class="PARAMETER">trigger</replaceable> ON <replaceable class="PARAMETER">table</replaceable>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_user.sgml,v 1.28 2003/06/27 14:45:26 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_user.sgml,v 1.29 2003/08/31 17:32:21 petere Exp $
PostgreSQL documentation
-->
<refpurpose>change a database user account</refpurpose>
</refnamediv>
+ <indexterm zone="sql-alteruser">
+ <primary>ALTER USER</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
ALTER USER <replaceable class="PARAMETER">username</replaceable> [ [ WITH ] <replaceable class="PARAMETER">option</replaceable> [ ... ] ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/analyze.sgml,v 1.12 2003/04/15 13:25:08 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/analyze.sgml,v 1.13 2003/08/31 17:32:21 petere Exp $
PostgreSQL documentation
-->
<refpurpose>collect statistics about a database</refpurpose>
</refnamediv>
+ <indexterm zone="sql-analyze">
+ <primary>ANALYZE</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
ANALYZE [ VERBOSE ] [ <replaceable class="PARAMETER">table</replaceable> [ (<replaceable class="PARAMETER">column</replaceable> [, ...] ) ] ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/begin.sgml,v 1.24 2003/05/14 03:26:00 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/begin.sgml,v 1.25 2003/08/31 17:32:21 petere Exp $
PostgreSQL documentation
-->
<refpurpose>start a transaction block</refpurpose>
</refnamediv>
+ <indexterm zone="sql-begin">
+ <primary>BEGIN</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
BEGIN [ WORK | TRANSACTION ]
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/checkpoint.sgml,v 1.9 2003/04/15 13:25:08 petere Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/checkpoint.sgml,v 1.10 2003/08/31 17:32:21 petere Exp $ -->
<refentry id="sql-checkpoint">
<refmeta>
<refpurpose>force a transaction log checkpoint</refpurpose>
</refnamediv>
+ <indexterm zone="sql-checkpoint">
+ <primary>CHECKPOINT</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
CHECKPOINT
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/close.sgml,v 1.16 2003/08/24 21:02:42 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/close.sgml,v 1.17 2003/08/31 17:32:21 petere Exp $
PostgreSQL documentation
-->
<refpurpose>close a cursor</refpurpose>
</refnamediv>
+ <indexterm zone="sql-close">
+ <primary>CLOSE</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
CLOSE <replaceable class="PARAMETER">cursor</replaceable>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/cluster.sgml,v 1.26 2003/04/15 13:25:08 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/cluster.sgml,v 1.27 2003/08/31 17:32:21 petere Exp $
PostgreSQL documentation
-->
<refpurpose>cluster a table according to an index</refpurpose>
</refnamediv>
+ <indexterm zone="sql-cluster">
+ <primary>CLUSTER</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
CLUSTER <replaceable class="PARAMETER">indexname</replaceable> ON <replaceable class="PARAMETER">tablename</replaceable>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/clusterdb.sgml,v 1.11 2003/08/17 04:46:59 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/clusterdb.sgml,v 1.12 2003/08/31 17:32:21 petere Exp $
PostgreSQL documentation
-->
<refpurpose>cluster a <productname>PostgreSQL</productname> database</refpurpose>
</refnamediv>
+ <indexterm zone="app-clusterdb">
+ <primary>clusterdb</primary>
+ </indexterm>
+
<refsynopsisdiv>
<cmdsynopsis>
<command>clusterdb</command>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/comment.sgml,v 1.21 2003/04/15 13:25:08 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/comment.sgml,v 1.22 2003/08/31 17:32:21 petere Exp $
PostgreSQL documentation
-->
<refpurpose>define or change the comment of an object</refpurpose>
</refnamediv>
+ <indexterm zone="sql-comment">
+ <primary>COMMENT</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
COMMENT ON
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/commit.sgml,v 1.15 2003/04/15 13:25:08 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/commit.sgml,v 1.16 2003/08/31 17:32:21 petere Exp $
PostgreSQL documentation
-->
<refpurpose>commit the current transaction</refpurpose>
</refnamediv>
+ <indexterm zone="sql-commit">
+ <primary>COMMIT</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
COMMIT [ WORK | TRANSACTION ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/copy.sgml,v 1.47 2003/08/17 04:33:02 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/copy.sgml,v 1.48 2003/08/31 17:32:21 petere Exp $
PostgreSQL documentation
-->
<refpurpose>copy data between files and tables</refpurpose>
</refnamediv>
+ <indexterm zone="sql-copy">
+ <primary>COPY</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
COPY <replaceable class="parameter">table</replaceable> [ ( <replaceable class="parameter">column</replaceable> [, ...] ) ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_aggregate.sgml,v 1.26 2003/06/27 14:45:26 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_aggregate.sgml,v 1.27 2003/08/31 17:32:21 petere Exp $
PostgreSQL documentation
-->
<refpurpose>define a new aggregate function</refpurpose>
</refnamediv>
+ <indexterm zone="sql-createaggregate">
+ <primary>CREATE AGGREGATE</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
CREATE AGGREGATE <replaceable class="PARAMETER">name</replaceable> (
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/create_cast.sgml,v 1.11 2003/04/22 10:08:08 petere Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/create_cast.sgml,v 1.12 2003/08/31 17:32:21 petere Exp $ -->
<refentry id="SQL-CREATECAST">
<refmeta>
<refpurpose>define a user-defined cast</refpurpose>
</refnamediv>
+ <indexterm zone="sql-createcast">
+ <primary>CREATE CAST</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
CREATE CAST (<replaceable>sourcetype</replaceable> AS <replaceable>targettype</replaceable>)
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_constraint.sgml,v 1.9 2003/04/22 10:08:08 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_constraint.sgml,v 1.10 2003/08/31 17:32:21 petere Exp $
PostgreSQL documentation
-->
<refpurpose>define a new constraint trigger</refpurpose>
</refnamediv>
+ <indexterm zone="sql-createconstraint">
+ <primary>CREATE CONSTRAINT</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
CREATE CONSTRAINT TRIGGER <replaceable class="parameter">name</replaceable>
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/create_conversion.sgml,v 1.10 2003/06/27 14:45:26 petere Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/create_conversion.sgml,v 1.11 2003/08/31 17:32:21 petere Exp $ -->
<refentry id="SQL-CREATECONVERSION">
<refmeta>
<refpurpose>define a user-defined conversion</refpurpose>
</refnamediv>
+ <indexterm zone="sql-createconversion">
+ <primary>CREATE CONVERSION</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
CREATE [DEFAULT] CONVERSION <replaceable>name</replaceable>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_database.sgml,v 1.34 2003/04/22 10:08:08 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_database.sgml,v 1.35 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refpurpose>create a new database</refpurpose>
</refnamediv>
+ <indexterm zone="sql-createdatabase">
+ <primary>CREATE DATABASE</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
CREATE DATABASE <replaceable class="PARAMETER">name</replaceable>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_domain.sgml,v 1.13 2003/04/22 10:08:08 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_domain.sgml,v 1.14 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refpurpose>define a new domain</refpurpose>
</refnamediv>
+ <indexterm zone="sql-createdomain">
+ <primary>CREATE DOMAIN</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
CREATE DOMAIN <replaceable class="parameter">domainname</replaceable> [AS] <replaceable class="parameter">data_type</replaceable>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_function.sgml,v 1.48 2003/06/27 14:45:26 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_function.sgml,v 1.49 2003/08/31 17:32:22 petere Exp $
-->
<refentry id="SQL-CREATEFUNCTION">
<refpurpose>define a new function</refpurpose>
</refnamediv>
+ <indexterm zone="sql-createfunction">
+ <primary>CREATE FUNCTION</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
CREATE [ OR REPLACE ] FUNCTION <replaceable class="parameter">name</replaceable> ( [ <replaceable class="parameter">argtype</replaceable> [, ...] ] )
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_group.sgml,v 1.11 2003/04/22 10:08:08 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_group.sgml,v 1.12 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refpurpose>define a new user group</refpurpose>
</refnamediv>
+ <indexterm zone="sql-creategroup">
+ <primary>CREATE GROUP</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
CREATE GROUP <replaceable class="PARAMETER">name</replaceable> [ [ WITH ] <replaceable class="PARAMETER">option</replaceable> [ ... ] ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_index.sgml,v 1.39 2003/05/28 16:03:55 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_index.sgml,v 1.40 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refpurpose>define a new index</refpurpose>
</refnamediv>
+ <indexterm zone="sql-createindex">
+ <primary>CREATE INDEX</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
CREATE [ UNIQUE ] INDEX <replaceable class="parameter">index_name</replaceable> ON <replaceable class="parameter">table</replaceable> [ USING <replaceable class="parameter">method</replaceable> ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_language.sgml,v 1.33 2003/06/27 14:45:26 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_language.sgml,v 1.34 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refpurpose>define a new procedural language</refpurpose>
</refnamediv>
+ <indexterm zone="sql-createlanguage">
+ <primary>CREATE LANGUAGE</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
CREATE [ TRUSTED ] [ PROCEDURAL ] LANGUAGE <replaceable class="parameter">langname</replaceable>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_opclass.sgml,v 1.8 2003/06/27 14:45:26 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_opclass.sgml,v 1.9 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refpurpose>define a new operator class for indexes</refpurpose>
</refnamediv>
+ <indexterm zone="sql-createopclass">
+ <primary>CREATE OPERATOR CLASS</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
CREATE OPERATOR CLASS <replaceable class="parameter">name</replaceable> [ DEFAULT ] FOR TYPE <replaceable class="parameter">data_type</replaceable> USING <replaceable class="parameter">index_method</replaceable> AS
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_operator.sgml,v 1.36 2003/08/17 22:09:00 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_operator.sgml,v 1.37 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refpurpose>define a new operator</refpurpose>
</refnamediv>
+ <indexterm zone="sql-createoperator">
+ <primary>CREATE OPERATOR</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
CREATE OPERATOR <replaceable>name</replaceable> (
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_rule.sgml,v 1.39 2003/04/22 10:08:08 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_rule.sgml,v 1.40 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refpurpose>define a new rewrite rule</refpurpose>
</refnamediv>
+ <indexterm zone="sql-createrule">
+ <primary>CREATE RULE</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
CREATE [ OR REPLACE ] RULE <replaceable class="parameter">name</replaceable> AS ON <replaceable class="parameter">event</replaceable>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_schema.sgml,v 1.6 2003/06/27 14:45:26 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_schema.sgml,v 1.7 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refpurpose>define a new schema</refpurpose>
</refnamediv>
+ <indexterm zone="sql-createschema">
+ <primary>CREATE SCHEMA</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
CREATE SCHEMA <replaceable class="parameter">schemaname</replaceable> [ AUTHORIZATION <replaceable class="parameter">username</replaceable> ] [ <replaceable class="parameter">schema_element</replaceable> [ ... ] ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_sequence.sgml,v 1.33 2003/04/22 10:08:08 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_sequence.sgml,v 1.34 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refpurpose>define a new sequence generator</refpurpose>
</refnamediv>
+ <indexterm zone="sql-createsequence">
+ <primary>CREATE SEQUENCE</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
CREATE [ TEMPORARY | TEMP ] SEQUENCE <replaceable class="parameter">seqname</replaceable> [ INCREMENT [ BY ] <replaceable class="parameter">increment</replaceable> ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_table.sgml,v 1.70 2003/06/12 18:34:06 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_table.sgml,v 1.71 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refpurpose>define a new table</refpurpose>
</refnamediv>
+ <indexterm zone="sql-createtable">
+ <primary>CREATE TABLE</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
CREATE [ [ GLOBAL | LOCAL ] { TEMPORARY | TEMP } ] TABLE <replaceable class="PARAMETER">table_name</replaceable> (
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_table_as.sgml,v 1.14 2003/07/01 00:04:31 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_table_as.sgml,v 1.15 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refpurpose>create a new table from the results of a query</refpurpose>
</refnamediv>
+ <indexterm zone="sql-createtableas">
+ <primary>CREATE TABLE AS</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
CREATE [ [ GLOBAL | LOCAL ] { TEMPORARY | TEMP } ] TABLE <replaceable>table_name</replaceable> [ (<replaceable>column_name</replaceable> [, ...] ) ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_trigger.sgml,v 1.34 2003/04/22 10:08:08 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_trigger.sgml,v 1.35 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refpurpose>define a new trigger</refpurpose>
</refnamediv>
+ <indexterm zone="sql-createtrigger">
+ <primary>CREATE TRIGGER</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
CREATE TRIGGER <replaceable class="PARAMETER">name</replaceable> { BEFORE | AFTER } { <replaceable class="PARAMETER">event</replaceable> [ OR ... ] }
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_type.sgml,v 1.43 2003/05/09 23:01:44 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_type.sgml,v 1.44 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refpurpose>define a new data type</refpurpose>
</refnamediv>
+ <indexterm zone="sql-createtype">
+ <primary>CREATE TYPE</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
CREATE TYPE <replaceable class="parameter">typename</replaceable> AS
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_user.sgml,v 1.26 2003/04/22 10:08:08 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_user.sgml,v 1.27 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refpurpose>define a new database user account</refpurpose>
</refnamediv>
+ <indexterm zone="sql-createuser">
+ <primary>CREATE USER</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
CREATE USER <replaceable class="PARAMETER">username</replaceable> [ [ WITH ] <replaceable class="PARAMETER">option</replaceable> [ ... ] ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_view.sgml,v 1.22 2003/04/22 10:08:08 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_view.sgml,v 1.23 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refpurpose>define a new view</refpurpose>
</refnamediv>
+ <indexterm zone="sql-createview">
+ <primary>CREATE VIEW</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
CREATE [ OR REPLACE ] VIEW <replaceable class="PARAMETER">name</replaceable> [ ( <replaceable
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/createdb.sgml,v 1.33 2003/05/26 17:50:09 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/createdb.sgml,v 1.34 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refpurpose>create a new <productname>PostgreSQL</productname> database</refpurpose>
</refnamediv>
+ <indexterm zone="app-createdb">
+ <primary>createdb</primary>
+ </indexterm>
+
<refsynopsisdiv>
<cmdsynopsis>
<command>createdb</command>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/createlang.sgml,v 1.31 2003/03/24 14:32:51 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/createlang.sgml,v 1.32 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refpurpose>define a new <productname>PostgreSQL</productname> procedural language</refpurpose>
</refnamediv>
+ <indexterm zone="app-createlang">
+ <primary>createlang</primary>
+ </indexterm>
+
<refsynopsisdiv>
<cmdsynopsis>
<command>createlang</command>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/createuser.sgml,v 1.35 2003/08/17 04:46:59 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/createuser.sgml,v 1.36 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refpurpose>define a new <productname>PostgreSQL</productname> user account</refpurpose>
</refnamediv>
+ <indexterm zone="app-createuser">
+ <primary>createuser</primary>
+ </indexterm>
+
<refsynopsisdiv>
<cmdsynopsis>
<command>createuser</command>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/deallocate.sgml,v 1.2 2003/04/26 23:56:51 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/deallocate.sgml,v 1.3 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refpurpose>deallocate a prepared statement</refpurpose>
</refnamediv>
+ <indexterm zone="sql-deallocate">
+ <primary>DEALLOCATE</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
DEALLOCATE [ PREPARE ] <replaceable class="parameter">plan_name</replaceable>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/declare.sgml,v 1.25 2003/08/24 21:02:42 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/declare.sgml,v 1.26 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refpurpose>define a cursor</refpurpose>
</refnamediv>
+ <indexterm zone="sql-declare">
+ <primary>DECLARE</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
DECLARE <replaceable class="parameter">cursorname</replaceable> [ BINARY ] [ INSENSITIVE ] [ [ NO ] SCROLL ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/delete.sgml,v 1.17 2003/04/26 23:56:51 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/delete.sgml,v 1.18 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refpurpose>delete rows of a table</refpurpose>
</refnamediv>
+ <indexterm zone="sql-delete">
+ <primary>DELETE</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
DELETE FROM [ ONLY ] <replaceable class="PARAMETER">table</replaceable> [ WHERE <replaceable class="PARAMETER">condition</replaceable> ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_aggregate.sgml,v 1.23 2003/06/27 14:45:26 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_aggregate.sgml,v 1.24 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refpurpose>remove a user-defined aggregate function</refpurpose>
</refnamediv>
+ <indexterm zone="sql-dropaggregate">
+ <primary>DROP AGGREGATE</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
DROP AGGREGATE <replaceable class="PARAMETER">name</replaceable> ( <replaceable class="PARAMETER">type</replaceable> ) [ CASCADE | RESTRICT ]
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_cast.sgml,v 1.3 2003/05/04 02:23:16 petere Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_cast.sgml,v 1.4 2003/08/31 17:32:22 petere Exp $ -->
<refentry id="SQL-DROPCAST">
<refmeta>
<refpurpose>remove a user-defined cast</refpurpose>
</refnamediv>
+ <indexterm zone="sql-dropcast">
+ <primary>DROP CAST</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
DROP CAST (<replaceable>sourcetype</replaceable> AS <replaceable>targettype</replaceable>) [ CASCADE | RESTRICT ]
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_conversion.sgml,v 1.5 2003/06/27 14:45:26 petere Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_conversion.sgml,v 1.6 2003/08/31 17:32:22 petere Exp $ -->
<refentry id="SQL-DROPCONVERSION">
<refmeta>
<refpurpose>remove a user-defined conversion</refpurpose>
</refnamediv>
+ <indexterm zone="sql-dropconversion">
+ <primary>DROP CONVERSION</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
DROP CONVERSION <replaceable>conversion_name</replaceable> [ CASCADE | RESTRICT ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_database.sgml,v 1.16 2003/05/04 02:23:16 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_database.sgml,v 1.17 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refpurpose>remove a database</refpurpose>
</refnamediv>
+ <indexterm zone="sql-dropdatabase">
+ <primary>DROP DATABASE</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
DROP DATABASE <replaceable class="PARAMETER">name</replaceable>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_domain.sgml,v 1.10 2003/05/04 02:23:16 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_domain.sgml,v 1.11 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refpurpose>remove a domain</refpurpose>
</refnamediv>
+ <indexterm zone="sql-dropdomain">
+ <primary>DROP DOMAIN</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
DROP DOMAIN <replaceable class="PARAMETER">domainname</replaceable> [, ...] [ CASCADE | RESTRICT ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_function.sgml,v 1.25 2003/06/27 14:45:26 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_function.sgml,v 1.26 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refpurpose>remove a user-defined function</refpurpose>
</refnamediv>
+ <indexterm zone="sql-dropfunction">
+ <primary>DROP FUNCTION</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
DROP FUNCTION <replaceable class="parameter">name</replaceable> ( [ <replaceable class="parameter">type</replaceable> [, ...] ] ) [ CASCADE | RESTRICT ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_group.sgml,v 1.5 2003/05/04 02:23:16 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_group.sgml,v 1.6 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refpurpose>remove a user group</refpurpose>
</refnamediv>
+ <indexterm zone="sql-dropgroup">
+ <primary>DROP GROUP</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
DROP GROUP <replaceable class="PARAMETER">name</replaceable>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_index.sgml,v 1.18 2003/06/24 23:29:25 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_index.sgml,v 1.19 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refpurpose>remove an index</refpurpose>
</refnamediv>
+ <indexterm zone="sql-dropindex">
+ <primary>DROP INDEX</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
DROP INDEX <replaceable class="PARAMETER">name</replaceable> [, ...] [ CASCADE | RESTRICT ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_language.sgml,v 1.17 2003/06/27 14:45:26 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_language.sgml,v 1.18 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refpurpose>remove a user-defined procedural language</refpurpose>
</refnamediv>
+ <indexterm zone="sql-droplanguage">
+ <primary>DROP LANGUAGE</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
DROP [ PROCEDURAL ] LANGUAGE <replaceable class="PARAMETER">name</replaceable> [ CASCADE | RESTRICT ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_opclass.sgml,v 1.4 2003/06/27 14:45:26 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_opclass.sgml,v 1.5 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refpurpose>remove a user-defined operator class</refpurpose>
</refnamediv>
+ <indexterm zone="sql-dropopclass">
+ <primary>DROP OPERATOR CLASS</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
DROP OPERATOR CLASS <replaceable class="PARAMETER">name</replaceable> USING <replaceable class="PARAMETER">index_method</replaceable> [ CASCADE | RESTRICT ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_operator.sgml,v 1.19 2003/05/04 02:23:16 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_operator.sgml,v 1.20 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refpurpose>remove a user-defined operator</refpurpose>
</refnamediv>
+ <indexterm zone="sql-dropoperator">
+ <primary>DROP OPERATOR</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
DROP OPERATOR <replaceable class="PARAMETER">name</replaceable> ( <replaceable class="PARAMETER">lefttype</replaceable> | NONE , <replaceable class="PARAMETER">righttype</replaceable> | NONE ) [ CASCADE | RESTRICT ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_rule.sgml,v 1.17 2003/05/04 02:23:16 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_rule.sgml,v 1.18 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refpurpose>remove a rewrite rule</refpurpose>
</refnamediv>
+ <indexterm zone="sql-droprule">
+ <primary>DROP RULE</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
DROP RULE <replaceable class="PARAMETER">name</replaceable> ON <replaceable class="PARAMETER">relation</replaceable> [ CASCADE | RESTRICT ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_schema.sgml,v 1.3 2003/06/27 14:45:26 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_schema.sgml,v 1.4 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refpurpose>remove a schema</refpurpose>
</refnamediv>
+ <indexterm zone="sql-dropschema">
+ <primary>DROP SCHEMA</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
DROP SCHEMA <replaceable class="PARAMETER">name</replaceable> [, ...] [ CASCADE | RESTRICT ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_sequence.sgml,v 1.17 2003/05/04 02:23:16 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_sequence.sgml,v 1.18 2003/08/31 17:32:22 petere Exp $
PostgreSQL documentation
-->
<refpurpose>remove a sequence</refpurpose>
</refnamediv>
+ <indexterm zone="sql-dropsequence">
+ <primary>DROP SEQUENCE</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
DROP SEQUENCE <replaceable class="PARAMETER">name</replaceable> [, ...] [ CASCADE | RESTRICT ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_table.sgml,v 1.18 2003/05/04 02:23:16 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_table.sgml,v 1.19 2003/08/31 17:32:23 petere Exp $
PostgreSQL documentation
-->
<refpurpose>remove a table</refpurpose>
</refnamediv>
+ <indexterm zone="sql-droptable">
+ <primary>DROP TABLE</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
DROP TABLE <replaceable class="PARAMETER">name</replaceable> [, ...] [ CASCADE | RESTRICT ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_trigger.sgml,v 1.15 2003/05/04 02:23:16 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_trigger.sgml,v 1.16 2003/08/31 17:32:23 petere Exp $
PostgreSQL documentation
-->
<refpurpose>remove a trigger</refpurpose>
</refnamediv>
+ <indexterm zone="sql-droptrigger">
+ <primary>DROP TRIGGER</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
DROP TRIGGER <replaceable class="PARAMETER">name</replaceable> ON <replaceable class="PARAMETER">table</replaceable> [ CASCADE | RESTRICT ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_type.sgml,v 1.21 2003/05/04 02:23:16 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_type.sgml,v 1.22 2003/08/31 17:32:23 petere Exp $
PostgreSQL documentation
-->
<refpurpose>remove a user-defined data type</refpurpose>
</refnamediv>
+ <indexterm zone="sql-droptype">
+ <primary>DROP TYPE</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
DROP TYPE <replaceable class="PARAMETER">typename</replaceable> [, ...] [ CASCADE | RESTRICT ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_user.sgml,v 1.16 2003/05/04 02:23:16 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_user.sgml,v 1.17 2003/08/31 17:32:23 petere Exp $
PostgreSQL documentation
-->
<refpurpose>remove a database user account</refpurpose>
</refnamediv>
+ <indexterm zone="sql-dropuser">
+ <primary>DROP USER</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
DROP USER <replaceable class="PARAMETER">name</replaceable>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_view.sgml,v 1.17 2003/05/04 02:23:16 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_view.sgml,v 1.18 2003/08/31 17:32:23 petere Exp $
PostgreSQL documentation
-->
<refpurpose>remove a view</refpurpose>
</refnamediv>
+ <indexterm zone="sql-dropview">
+ <primary>DROP VIEW</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
DROP VIEW <replaceable class="PARAMETER">name</replaceable> [, ...] [ CASCADE | RESTRICT ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropdb.sgml,v 1.22 2003/05/26 17:50:09 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropdb.sgml,v 1.23 2003/08/31 17:32:23 petere Exp $
PostgreSQL documentation
-->
<refpurpose>remove a <productname>PostgreSQL</productname> database</refpurpose>
</refnamediv>
+ <indexterm zone="app-dropdb">
+ <primary>dropdb</primary>
+ </indexterm>
+
<refsynopsisdiv>
<cmdsynopsis>
<command>dropdb</command>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/droplang.sgml,v 1.23 2003/03/24 14:32:51 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/droplang.sgml,v 1.24 2003/08/31 17:32:23 petere Exp $
PostgreSQL documentation
-->
<refpurpose>remove a <productname>PostgreSQL</productname> procedural language</refpurpose>
</refnamediv>
+ <indexterm zone="app-droplang">
+ <primary>droplang</primary>
+ </indexterm>
+
<refsynopsisdiv>
<cmdsynopsis>
<command>droplang</command>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropuser.sgml,v 1.27 2003/08/17 04:46:59 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropuser.sgml,v 1.28 2003/08/31 17:32:23 petere Exp $
PostgreSQL documentation
-->
<refpurpose>remove a <productname>PostgreSQL</productname> user account</refpurpose>
</refnamediv>
+ <indexterm zone="app-dropuser">
+ <primary>dropuser</primary>
+ </indexterm>
+
<refsynopsisdiv>
<cmdsynopsis>
<command>dropuser</command>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/ecpg-ref.sgml,v 1.26 2003/03/25 16:15:39 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/ecpg-ref.sgml,v 1.27 2003/08/31 17:32:23 petere Exp $
PostgreSQL documentation
-->
<refpurpose>embedded SQL C preprocessor</refpurpose>
</refnamediv>
+ <indexterm zone="app-ecpg">
+ <primary>ecpg</primary>
+ </indexterm>
+
<refsynopsisdiv>
<cmdsynopsis>
<command>ecpg</command>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/end.sgml,v 1.9 2003/04/26 23:56:51 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/end.sgml,v 1.10 2003/08/31 17:32:23 petere Exp $
PostgreSQL documentation
-->
<refpurpose>commit the current transaction</refpurpose>
</refnamediv>
+ <indexterm zone="sql-end">
+ <primary>END</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
END [ WORK | TRANSACTION ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/execute.sgml,v 1.5 2003/07/01 00:04:31 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/execute.sgml,v 1.6 2003/08/31 17:32:23 petere Exp $
PostgreSQL documentation
-->
<refpurpose>execute a prepared statement</refpurpose>
</refnamediv>
+ <indexterm zone="sql-execute">
+ <primary>EXECUTE</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
EXECUTE <replaceable class="PARAMETER">plan_name</replaceable> [ (<replaceable class="PARAMETER">parameter</replaceable> [, ...] ) ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/explain.sgml,v 1.26 2003/04/26 23:56:51 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/explain.sgml,v 1.27 2003/08/31 17:32:23 petere Exp $
PostgreSQL documentation
-->
<refpurpose>show the execution plan of a statement</refpurpose>
</refnamediv>
+ <indexterm zone="sql-explain">
+ <primary>EXPLAIN</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
EXPLAIN [ ANALYZE ] [ VERBOSE ] <replaceable class="parameter">statement</replaceable>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/fetch.sgml,v 1.30 2003/08/24 21:02:43 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/fetch.sgml,v 1.31 2003/08/31 17:32:23 petere Exp $
PostgreSQL documentation
-->
<refpurpose>retrieve rows from a query using a cursor</refpurpose>
</refnamediv>
+ <indexterm zone="sql-fetch">
+ <primary>FETCH</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
FETCH [ <replaceable class="PARAMETER">direction</replaceable> { FROM | IN } ] <replaceable class="PARAMETER">cursor</replaceable>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/grant.sgml,v 1.33 2003/04/26 23:56:51 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/grant.sgml,v 1.34 2003/08/31 17:32:23 petere Exp $
PostgreSQL documentation
-->
<refpurpose>define access privileges</refpurpose>
</refnamediv>
+ <indexterm zone="sql-grant">
+ <primary>GRANT</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
GRANT { { SELECT | INSERT | UPDATE | DELETE | RULE | REFERENCES | TRIGGER }
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/initdb.sgml,v 1.26 2003/03/25 16:15:41 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/initdb.sgml,v 1.27 2003/08/31 17:32:23 petere Exp $
PostgreSQL documentation
-->
<refpurpose>create a new <productname>PostgreSQL</productname> database cluster</refpurpose>
</refnamediv>
+ <indexterm zone="app-initdb">
+ <primary>initdb</primary>
+ </indexterm>
+
<refsynopsisdiv>
<cmdsynopsis>
<command>initdb</command>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/initlocation.sgml,v 1.20 2003/03/25 16:15:42 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/initlocation.sgml,v 1.21 2003/08/31 17:32:23 petere Exp $
PostgreSQL documentation
-->
<refpurpose>create a secondary <productname>PostgreSQL</productname> database storage area</refpurpose>
</refnamediv>
+ <indexterm zone="app-initlocation">
+ <primary>initlocation</primary>
+ </indexterm>
+
<refsynopsisdiv>
<cmdsynopsis>
<command>initlocation</command>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/insert.sgml,v 1.23 2003/07/03 16:32:03 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/insert.sgml,v 1.24 2003/08/31 17:32:23 petere Exp $
PostgreSQL documentation
-->
<refpurpose>create new rows in a table</refpurpose>
</refnamediv>
+ <indexterm zone="sql-insert">
+ <primary>INSERT</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
INSERT INTO <replaceable class="PARAMETER">table</replaceable> [ ( <replaceable class="PARAMETER">column</replaceable> [, ...] ) ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/ipcclean.sgml,v 1.8 2003/03/24 14:32:51 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/ipcclean.sgml,v 1.9 2003/08/31 17:32:23 petere Exp $
PostgreSQL documentation
-->
<refpurpose>remove shared memory and semaphores from an aborted <productname>PostgreSQL</productname> server</refpurpose>
</refnamediv>
+ <indexterm zone="app-ipcclean">
+ <primary>ipcclean</primary>
+ </indexterm>
+
<refsynopsisdiv>
<cmdsynopsis>
<command>ipcclean</command>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/listen.sgml,v 1.16 2003/04/26 23:56:51 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/listen.sgml,v 1.17 2003/08/31 17:32:23 petere Exp $
PostgreSQL documentation
-->
<refpurpose>listen for a notification</refpurpose>
</refnamediv>
+ <indexterm zone="sql-listen">
+ <primary>LISTEN</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
LISTEN <replaceable class="PARAMETER">name</replaceable>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/load.sgml,v 1.17 2003/04/26 23:56:51 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/load.sgml,v 1.18 2003/08/31 17:32:23 petere Exp $
-->
<refentry id="SQL-LOAD">
<refpurpose>load or reload a shared library file</refpurpose>
</refnamediv>
+ <indexterm zone="sql-load">
+ <primary>LOAD</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
LOAD '<replaceable class="PARAMETER">filename</replaceable>'
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/lock.sgml,v 1.35 2003/04/26 23:56:51 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/lock.sgml,v 1.36 2003/08/31 17:32:23 petere Exp $
PostgreSQL documentation
-->
<refpurpose>lock a table</refpurpose>
</refnamediv>
+ <indexterm zone="sql-lock">
+ <primary>LOCK</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
LOCK [ TABLE ] <replaceable class="PARAMETER">name</replaceable> [, ...] [ IN <replaceable class="PARAMETER">lockmode</replaceable> MODE ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/move.sgml,v 1.22 2003/05/04 02:23:16 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/move.sgml,v 1.23 2003/08/31 17:32:23 petere Exp $
PostgreSQL documentation
-->
<refpurpose>reposition a cursor</refpurpose>
</refnamediv>
+ <indexterm zone="sql-move">
+ <primary>MOVE</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
MOVE [ <replaceable class="PARAMETER">direction</replaceable> { FROM | IN } ] <replaceable class="PARAMETER">cursor</replaceable>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/notify.sgml,v 1.20 2003/04/26 23:56:51 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/notify.sgml,v 1.21 2003/08/31 17:32:23 petere Exp $
PostgreSQL documentation
-->
<refpurpose>generate a notification</refpurpose>
</refnamediv>
+ <indexterm zone="sql-notify">
+ <primary>NOTIFY</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
NOTIFY <replaceable class="PARAMETER">name</replaceable>
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_config-ref.sgml,v 1.15 2003/03/25 16:15:42 petere Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_config-ref.sgml,v 1.16 2003/08/31 17:32:23 petere Exp $ -->
<refentry id="app-pgconfig">
<refmeta>
<refpurpose>retrieve information about the installed version of <productname>PostgreSQL</></refpurpose>
</refnamediv>
+ <indexterm zone="app-pgconfig">
+ <primary>pg_config</primary>
+ </indexterm>
+
<refsynopsisdiv>
<cmdsynopsis>
<command>pg_config</command>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_controldata.sgml,v 1.5 2003/03/24 14:32:51 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_controldata.sgml,v 1.6 2003/08/31 17:32:23 petere Exp $
PostgreSQL documentation
-->
<refpurpose>display control information of a <productname>PostgreSQL</productname> database cluster</refpurpose>
</refnamediv>
+ <indexterm zone="app-pgcontroldata">
+ <primary>pg_controldata</primary>
+ </indexterm>
+
<refsynopsisdiv>
<cmdsynopsis>
<command>pg_controldata</command>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_ctl-ref.sgml,v 1.22 2003/03/25 16:15:42 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_ctl-ref.sgml,v 1.23 2003/08/31 17:32:23 petere Exp $
PostgreSQL documentation
-->
<refpurpose>start, stop, or restart a <productname>PostgreSQL</productname> server</refpurpose>
</refnamediv>
+ <indexterm zone="app-pg-ctl">
+ <primary>pg_ctl</primary>
+ </indexterm>
+
<refsynopsisdiv>
<cmdsynopsis>
<command>pg_ctl</command>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.62 2003/06/11 16:29:42 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.63 2003/08/31 17:32:23 petere Exp $
PostgreSQL documentation
-->
</refpurpose>
</refnamediv>
+ <indexterm zone="app-pgdump">
+ <primary>pg_dump</primary>
+ </indexterm>
+
<refsynopsisdiv>
<cmdsynopsis>
<command>pg_dump</command>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dumpall.sgml,v 1.39 2003/05/30 23:55:10 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dumpall.sgml,v 1.40 2003/08/31 17:32:24 petere Exp $
PostgreSQL documentation
-->
<refpurpose>extract a <productname>PostgreSQL</productname> database cluster into a script file</refpurpose>
</refnamediv>
+ <indexterm zone="app-pg-dumpall">
+ <primary>pg_dumpall</primary>
+ </indexterm>
+
<refsynopsisdiv>
<cmdsynopsis>
<command>pg_dumpall</command>
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.40 2003/08/28 20:44:02 tgl Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.41 2003/08/31 17:32:24 petere Exp $ -->
<refentry id="APP-PGRESTORE">
<refmeta>
</refpurpose>
</refnamediv>
+ <indexterm zone="app-pgrestore">
+ <primary>pg_restore</primary>
+ </indexterm>
+
<refsynopsisdiv>
<cmdsynopsis>
<command>pg_restore</command>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pgtclsh.sgml,v 1.8 2003/03/25 16:15:43 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pgtclsh.sgml,v 1.9 2003/08/31 17:32:24 petere Exp $
PostgreSQL documentation
-->
</refpurpose>
</refnamediv>
+ <indexterm zone="app-pgtclsh">
+ <primary>pgtclsh</primary>
+ </indexterm>
+
<refsynopsisdiv>
<cmdsynopsis>
<command>pgtclsh</command>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pgtksh.sgml,v 1.8 2003/03/25 16:15:43 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pgtksh.sgml,v 1.9 2003/08/31 17:32:24 petere Exp $
PostgreSQL documentation
-->
</refpurpose>
</refnamediv>
+ <indexterm zone="app-pgtksh">
+ <primary>pgtksh</primary>
+ </indexterm>
+
<refsynopsisdiv>
<cmdsynopsis>
<command>pgtksh</command>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/postgres-ref.sgml,v 1.34 2003/07/29 00:03:17 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/postgres-ref.sgml,v 1.35 2003/08/31 17:32:24 petere Exp $
PostgreSQL documentation
-->
<refpurpose>run a <productname>PostgreSQL</productname> server in single-user mode</refpurpose>
</refnamediv>
+ <indexterm zone="app-postgres">
+ <primary>postgres (the program)</primary>
+ </indexterm>
+
<refsynopsisdiv>
<cmdsynopsis>
<!-- standalone call -->
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/postmaster.sgml,v 1.36 2003/03/25 16:15:43 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/postmaster.sgml,v 1.37 2003/08/31 17:32:24 petere Exp $
PostgreSQL documentation
-->
<refpurpose><productname>PostgreSQL</productname> multiuser database server</refpurpose>
</refnamediv>
+ <indexterm zone="app-postmaster">
+ <primary>postmaster</primary>
+ </indexterm>
+
<refsynopsisdiv>
<cmdsynopsis>
<command>postmaster</command>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/prepare.sgml,v 1.5 2003/08/17 04:46:59 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/prepare.sgml,v 1.6 2003/08/31 17:32:24 petere Exp $
PostgreSQL documentation
-->
<refpurpose>prepare a statement for execution</refpurpose>
</refnamediv>
+ <indexterm zone="sql-prepare">
+ <primary>PREPARE</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
PREPARE <replaceable class="PARAMETER">plan_name</replaceable> [ (<replaceable class="PARAMETER">datatype</replaceable> [, ...] ) ] AS <replaceable class="PARAMETER">statement</replaceable>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/psql-ref.sgml,v 1.94 2003/08/02 02:44:38 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/psql-ref.sgml,v 1.95 2003/08/31 17:32:24 petere Exp $
PostgreSQL documentation
-->
</refpurpose>
</refnamediv>
+ <indexterm zone="app-psql">
+ <primary>psql</primary>
+ </indexterm>
+
<refsynopsisdiv>
<cmdsynopsis>
<command>psql</command>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/reindex.sgml,v 1.17 2003/04/26 23:56:51 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/reindex.sgml,v 1.18 2003/08/31 17:32:24 petere Exp $
PostgreSQL documentation
-->
<refpurpose>rebuild indexes</refpurpose>
</refnamediv>
+ <indexterm zone="sql-reindex">
+ <primary>REINDEX</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
REINDEX { DATABASE | TABLE | INDEX } <replaceable class="PARAMETER">name</replaceable> [ FORCE ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/reset.sgml,v 1.20 2003/05/04 02:23:16 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/reset.sgml,v 1.21 2003/08/31 17:32:24 petere Exp $
PostgreSQL documentation
-->
<refpurpose>restore the value of a run-time parameter to the default value</refpurpose>
</refnamediv>
+ <indexterm zone="sql-reset">
+ <primary>RESET</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
RESET <replaceable class="PARAMETER">parameter</replaceable>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/revoke.sgml,v 1.26 2003/04/26 23:56:51 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/revoke.sgml,v 1.27 2003/08/31 17:32:24 petere Exp $
PostgreSQL documentation
-->
<refpurpose>remove access privileges</refpurpose>
</refnamediv>
+ <indexterm zone="sql-revoke">
+ <primary>REVOKE</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
REVOKE [ GRANT OPTION FOR ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/rollback.sgml,v 1.14 2003/04/26 23:56:51 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/rollback.sgml,v 1.15 2003/08/31 17:32:24 petere Exp $
PostgreSQL documentation
-->
<refpurpose>abort the current transaction</refpurpose>
</refnamediv>
+ <indexterm zone="sql-rollback">
+ <primary>ROLLBACK</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
ROLLBACK [ WORK | TRANSACTION ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/select.sgml,v 1.68 2003/08/17 22:09:00 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/select.sgml,v 1.69 2003/08/31 17:32:24 petere Exp $
PostgreSQL documentation
-->
<refpurpose>retrieve rows from a table or view</refpurpose>
</refnamediv>
+ <indexterm zone="sql-select">
+ <primary>SELECT</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
SELECT [ ALL | DISTINCT [ ON ( <replaceable class="parameter">expression</replaceable> [, ...] ) ] ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/select_into.sgml,v 1.22 2003/05/04 02:23:16 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/select_into.sgml,v 1.23 2003/08/31 17:32:24 petere Exp $
PostgreSQL documentation
-->
<refpurpose>create a new table from the results of a query</refpurpose>
</refnamediv>
+ <indexterm zone="sql-selectinto">
+ <primary>SELECT INTO</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
SELECT [ ALL | DISTINCT [ ON ( <replaceable class="PARAMETER">expression</replaceable> [, ...] ) ] ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/set.sgml,v 1.80 2003/07/29 00:03:17 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/set.sgml,v 1.81 2003/08/31 17:32:24 petere Exp $
PostgreSQL documentation
-->
<refpurpose>change a run-time parameter</refpurpose>
</refnamediv>
+ <indexterm zone="sql-set">
+ <primary>SET</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
SET [ SESSION | LOCAL ] <replaceable class="PARAMETER">variable</replaceable> { TO | = } { <replaceable class="PARAMETER">value</replaceable> | '<replaceable class="PARAMETER">value</replaceable>' | DEFAULT }
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/set_constraints.sgml,v 1.6 2003/05/04 02:23:16 petere Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/set_constraints.sgml,v 1.7 2003/08/31 17:32:24 petere Exp $ -->
<refentry id="SQL-SET-CONSTRAINTS">
<refmeta>
<refentrytitle id="SQL-SET-CONSTRAINTS-title">SET CONSTRAINTS</refentrytitle>
<refpurpose>set the constraint mode of the current transaction</refpurpose>
</refnamediv>
+ <indexterm zone="sql-set-constraints">
+ <primary>SET CONSTRAINTS</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
SET CONSTRAINTS { ALL | <replaceable class="parameter">constraint</replaceable> [, ...] } { DEFERRED | IMMEDIATE }
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/set_session_auth.sgml,v 1.9 2003/05/04 02:23:16 petere Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/set_session_auth.sgml,v 1.10 2003/08/31 17:32:24 petere Exp $ -->
<refentry id="SQL-SET-SESSION-AUTHORIZATION">
<refmeta>
<refentrytitle id="sql-set-session-authorization-title">SET SESSION AUTHORIZATION</refentrytitle>
<refpurpose>set the session user identifier and the current user identifier of the current session</refpurpose>
</refnamediv>
+ <indexterm zone="sql-set-session-authorization">
+ <primary>SET SESSION AUTHORIZATION</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
SET [ SESSION | LOCAL ] SESSION AUTHORIZATION <replaceable class="parameter">username</replaceable>
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/set_transaction.sgml,v 1.14 2003/05/04 02:23:16 petere Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/set_transaction.sgml,v 1.15 2003/08/31 17:32:24 petere Exp $ -->
<refentry id="SQL-SET-TRANSACTION">
<refmeta>
<refentrytitle id="SQL-SET-TRANSACTION-TITLE">SET TRANSACTION</refentrytitle>
<refpurpose>set the characteristics of the current transaction</refpurpose>
</refnamediv>
+ <indexterm zone="sql-set-transaction">
+ <primary>SET TRANSACTION</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
SET TRANSACTION
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/show.sgml,v 1.30 2003/07/29 00:03:17 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/show.sgml,v 1.31 2003/08/31 17:32:24 petere Exp $
PostgreSQL documentation
-->
<refpurpose>show the value of a run-time parameter</refpurpose>
</refnamediv>
+ <indexterm zone="sql-show">
+ <primary>SHOW</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
SHOW <replaceable class="PARAMETER">name</replaceable>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/start_transaction.sgml,v 1.5 2003/04/26 23:56:51 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/start_transaction.sgml,v 1.6 2003/08/31 17:32:24 petere Exp $
PostgreSQL documentation
-->
<refpurpose>start a transaction block</refpurpose>
</refnamediv>
+ <indexterm zone="sql-start-transaction">
+ <primary>START TRANSACTION</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
START TRANSACTION [ ISOLATION LEVEL { READ COMMITTED | SERIALIZABLE } ] [ READ WRITE | READ ONLY ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/truncate.sgml,v 1.10 2003/04/26 23:56:51 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/truncate.sgml,v 1.11 2003/08/31 17:32:24 petere Exp $
PostgreSQL documentation
-->
<refpurpose>empty a table</refpurpose>
</refnamediv>
+ <indexterm zone="sql-truncate">
+ <primary>TRUNCATE</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
TRUNCATE [ TABLE ] <replaceable class="PARAMETER">name</replaceable>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/unlisten.sgml,v 1.21 2003/04/26 23:56:51 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/unlisten.sgml,v 1.22 2003/08/31 17:32:24 petere Exp $
PostgreSQL documentation
-->
<refpurpose>stop listening for a notification</refpurpose>
</refnamediv>
+ <indexterm zone="sql-unlisten">
+ <primary>UNLISTEN</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
UNLISTEN { <replaceable class="PARAMETER">name</replaceable> | * }
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/update.sgml,v 1.23 2003/07/03 16:32:12 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/update.sgml,v 1.24 2003/08/31 17:32:24 petere Exp $
PostgreSQL documentation
-->
<refpurpose>update rows of a table</refpurpose>
</refnamediv>
+ <indexterm zone="sql-update">
+ <primary>UPDATE</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
UPDATE [ ONLY ] <replaceable class="PARAMETER">table</replaceable> SET <replaceable class="PARAMETER">column</replaceable> = { <replaceable class="PARAMETER">expression</replaceable> | DEFAULT } [, ...]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/vacuum.sgml,v 1.31 2003/04/26 23:56:51 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/vacuum.sgml,v 1.32 2003/08/31 17:32:24 petere Exp $
PostgreSQL documentation
-->
<refpurpose>garbage-collect and optionally analyze a database</refpurpose>
</refnamediv>
+ <indexterm zone="sql-vacuum">
+ <primary>VACUUM</primary>
+ </indexterm>
+
<refsynopsisdiv>
<synopsis>
VACUUM [ FULL ] [ FREEZE ] [ VERBOSE ] [ <replaceable class="PARAMETER">table</replaceable> ]
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/vacuumdb.sgml,v 1.30 2003/08/17 04:46:59 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/vacuumdb.sgml,v 1.31 2003/08/31 17:32:24 petere Exp $
PostgreSQL documentation
-->
<refpurpose>garbage-collect and analyze a <productname>PostgreSQL</productname> database</refpurpose>
</refnamediv>
+ <indexterm zone="app-vacuumdb">
+ <primary>vacuumdb</primary>
+ </indexterm>
+
<refsynopsisdiv>
<cmdsynopsis>
<command>vacuumdb</command>
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/regress.sgml,v 1.32 2003/04/06 17:47:24 tgl Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/regress.sgml,v 1.33 2003/08/31 17:32:19 petere Exp $ -->
<chapter id="regress">
<title id="regress-title">Regression Tests</title>
+ <indexterm zone="regress">
+ <primary>regression tests</primary>
+ </indexterm>
+
+ <indexterm zone="regress">
+ <primary>test</primary>
+ </indexterm>
+
<para>
The regression tests are a comprehensive set of tests for the SQL
implementation in <productname>PostgreSQL</productname>. They test
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/rules.sgml,v 1.28 2003/04/11 13:22:35 petere Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/rules.sgml,v 1.29 2003/08/31 17:32:19 petere Exp $ -->
<Chapter Id="rules">
<Title>The Rule System</Title>
<indexterm zone="rules">
- <primary>rules</primary>
+ <primary>rule</primary>
</indexterm>
<Para>
<Sect1 id="querytree">
<Title>The Query Tree</Title>
+<indexterm zone="querytree">
+ <primary>query tree</primary>
+</indexterm>
+
<Para>
To understand how the rule system works it is necessary to know
when it is invoked and what its input and results are.
<Term>
the target list
</Term>
+ <indexterm><primary>target list</></>
<ListItem>
<Para>
The target list is a list of expressions that define the
<Sect1 id="rules-views">
<Title>Views and the Rule System</Title>
-<indexterm zone="rules-views"><primary>rules</><secondary>and views</></>
+
+<indexterm zone="rules-views">
+ <primary>rule</primary>
+ <secondary>and views</secondary>
+</indexterm>
+
+<indexterm zone="rules-views">
+ <primary>view</>
+ <secondary>implementation through rules</>
+</indexterm>
<Para>
Views in <ProductName>PostgreSQL</ProductName> are implemented
same thing: relations.
</Para>
-<Sect2>
+<Sect2 id="rules-select">
<Title>How <command>SELECT</command> Rules Work</Title>
+<indexterm zone="rules-select">
+ <primary>rule</primary>
+ <secondary sortas="SELECT">for SELECT</secondary>
+</indexterm>
+
<Para>
Rules <literal>ON SELECT</> are applied to all queries as the last step, even
if the command given is an <command>INSERT</command>,
To resolve this problem, another entry is added to the target list
in <command>UPDATE</command> (and also in
<command>DELETE</command>) statements: the current tuple ID
- (<acronym>CTID</>). This is a system column containing the
+ (<acronym>CTID</>).<indexterm><primary>CTID</></> This is a system column containing the
file block number and position in the block for the row. Knowing
the table, the <acronym>CTID</> can be used to retrieve the
original row of <literal>t1</> to be updated. After adding the <acronym>CTID</>
<Sect1 id="rules-update">
<Title>Rules on <command>INSERT</>, <command>UPDATE</>, and <command>DELETE</></Title>
+<indexterm zone="rules-update">
+ <primary>rule</primary>
+ <secondary sortas="INSERT">for INSERT</secondary>
+</indexterm>
+
+<indexterm zone="rules-update">
+ <primary>rule</primary>
+ <secondary sortas="UPDATE">for UPDATE</secondary>
+</indexterm>
+
+<indexterm zone="rules-update">
+ <primary>rule</primary>
+ <secondary sortas="DELETE">for DELETE</secondary>
+</indexterm>
+
<Para>
Rules that are defined on <command>INSERT</>, <command>UPDATE</>,
and <command>DELETE</> are significantly different from the view rules
<Sect2 id="rules-update-views">
<Title>Cooperation with Views</Title>
-<indexterm zone="rules-update-views"><primary>views</><secondary>updating</></>
+<indexterm zone="rules-update-views"><primary>view</><secondary>updating</></>
<Para>
A simple way to protect view relations from the mentioned
<Sect1 id="rules-privileges">
<Title>Rules and Privileges</Title>
+<indexterm zone="rules-privileges">
+ <primary>privilege</primary>
+ <secondary sortas="Regeln">with rules</secondary>
+</indexterm>
+
+<indexterm zone="rules-privileges">
+ <primary>privilege</primary>
+ <secondary sortas="Sichten">with views</secondary>
+</indexterm>
+
<Para>
Due to rewriting of queries by the <ProductName>PostgreSQL</ProductName>
rule system, other tables/views than those used in the original
<Sect1 id="rules-triggers">
<Title>Rules versus Triggers</Title>
+<indexterm zone="rules-triggers">
+ <primary>rule</primary>
+ <secondary sortas="Trigger">compared with triggers</secondary>
+</indexterm>
+
+<indexterm zone="rules-triggers">
+ <primary>trigger</primary>
+ <secondary sortas="Regeln">compared with rules</secondary>
+</indexterm>
+
<Para>
Many things that can be done using triggers can also be
implemented using the <ProductName>PostgreSQL</ProductName>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/runtime.sgml,v 1.200 2003/08/17 22:19:10 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/runtime.sgml,v 1.201 2003/08/31 17:32:19 petere Exp $
-->
<Chapter Id="runtime">
default, although locations such as
<filename>/usr/local/pgsql/data</filename> or
<filename>/var/lib/pgsql/data</filename> are popular. To initialize a
- database cluster, use the command <command>initdb</command>, which is
+ database cluster, use the command <command>initdb</command>,<indexterm><primary>initdb</></> which is
installed with <productname>PostgreSQL</productname>. The desired
file system location of your database system is indicated by the
<option>-D</option> option, for example
<para>
However, while the directory contents are secure, the default
client authentication setup allows any local user to connect to the
- database and even become the database superuser. If you do not trust
- other local users, we recommend you use <command>initdb</command>'s
- <option>-W</option> or <option>--pwprompt</option> option to assign a
- password to the database superuser. After <command>initdb</command>,
- modify the <filename>pg_hba.conf</filename> file to use <literal>md5</> or
+ database and even become the database superuser. If you do not
+ trust other local users, we recommend you use
+ <command>initdb</command>'s <option>-W</option> or
+ <option>--pwprompt</option> option to assign a password to the
+ database superuser.<indexterm><primary>password</><secondary>of the
+ superuser</></indexterm> After <command>initdb</command>, modify
+ the <filename>pg_hba.conf</filename> file to use <literal>md5</> or
<literal>password</> instead of <literal>trust</> authentication
<emphasis>before</> you start the server for the first time. (Other
approaches include using <literal>ident</literal> authentication or
<para>
Normally, you will want to start the database server when the
- computer boots. Autostart scripts are operating system-specific.
- There are a few distributed with
+ computer boots.<indexterm><primary>booting</><secondary>starting
+ the server during</></> Autostart scripts are operating
+ system-specific. There are a few distributed with
<productname>PostgreSQL</productname> in the
<filename>contrib/start-scripts</> directory. This may require root
privileges.
For <productname>FreeBSD</productname>, look at the file
<filename>contrib/start-scripts/freebsd</filename> in the
<productname>PostgreSQL</productname> source distribution.
- <indexterm><primary>FreeBSD</></>
+ <indexterm><primary>FreeBSD</><secondary>start script</secondary></>
</para>
</listitem>
<para>
On <productname>OpenBSD</productname>, add the following lines
to the file <filename>/etc/rc.local</filename>:
- <indexterm><primary>OpenBSD</></>
+ <indexterm><primary>OpenBSD</><secondary>start script</secondary></>
<programlisting>
if [ -x /usr/local/pgsql/bin/pg_ctl -a -x /usr/local/pgsql/bin/postmaster ]; then
su - -c '/usr/local/pgsql/bin/pg_ctl start -l /var/postgresql/log -s' postgres
<listitem>
<para>
On <productname>Linux</productname> systems either add
- <indexterm><primary>Linux</></>
+ <indexterm><primary>Linux</><secondary>start script</secondary></>
<programlisting>
/usr/local/pgsql/bin/pg_ctl start -l logfile -D /usr/local/pgsql/data
</programlisting>
On <productname>NetBSD</productname>, either use the
<productname>FreeBSD</productname> or
<productname>Linux</productname> start scripts, depending on
- preference. <indexterm><primary>NetBSD</></>
+ preference. <indexterm><primary>NetBSD</><secondary>start script</secondary></>
</para>
</listitem>
On <productname>Solaris</productname>, create a file called
<filename>/etc/init.d/postgresql</filename> that contains
the following line:
- <indexterm><primary>Solaris</></>
+ <indexterm><primary>Solaris</><secondary>start script</secondary></>
<programlisting>
su - postgres -c "/usr/local/pgsql/bin/pg_ctl start -l logfile -D /usr/local/pgsql/data"
</programlisting>
<indexterm>
<primary>configuration</primary>
- <secondary>server</secondary>
+ <secondary>of the server</secondary>
</indexterm>
<para>
<para>
One way to set these options is to edit the file
- <filename>postgresql.conf</filename> in the data directory. (A
+ <filename>postgresql.conf</filename><indexterm><primary>postgresql.conf</></> in the data directory. (A
default file is installed there.) An example of what this file might
look like is:
<programlisting>
<term><varname>TCPIP_SOCKET</varname> (<type>boolean</type>)</term>
<listitem>
<para>
- If this is true, then the server will accept TCP/IP connections.
+ If this is true, then the server will accept TCP/IP connections.<indexterm><primary>TCP/IP</></>
Otherwise only local Unix domain socket connections are
accepted. It is off by default. This option can only be set at
server start.
<variablelist>
<varlistentry>
<term><varname>AUTHENTICATION_TIMEOUT</varname> (<type>integer</type>)</term>
- <indexterm><primary>timeout</><secondary>authentication</></indexterm>
+ <indexterm><primary>timeout</><secondary>client authentication</></indexterm>
+ <indexterm><primary>client authentication</><secondary>timeout during</></indexterm>
<listitem>
<para>
Maximum time to complete client authentication, in seconds. If a
<sect2 id="runtime-config-logging">
<title>Error Reporting and Logging</title>
+ <indexterm zone="runtime-config-logging">
+ <primary>server log</primary>
+ </indexterm>
+
<sect3 id="runtime-config-logging-syslog">
<title>Syslog</title>
+
+ <indexterm zone="runtime-config-logging-syslog">
+ <primary>syslog</primary>
+ </indexterm>
+
<variablelist>
<varlistentry>
<varlistentry>
<term><varname>AUSTRALIAN_TIMEZONES</varname> (<type>boolean</type>)</term>
- <indexterm><primary>Australian time zones</></>
+ <indexterm><primary>time zone</><secondary>Australian</></>
<listitem>
<para>
If set to true, <literal>ACST</literal>,
<primary>significant digits</primary>
</indexterm>
<indexterm>
- <primary>display</primary>
- <secondary>of float numbers</secondary>
+ <primary>floating-point</primary>
+ <secondary>display</secondary>
</indexterm>
<term><varname>EXTRA_FLOAT_DIGITS</varname> (<type>integer</type>)</term>
<varlistentry>
<term><varname>CLIENT_ENCODING</varname> (<type>string</type>)</term>
- <indexterm><primary>character set encoding</></>
+ <indexterm><primary>character set</></>
<listitem>
<para>
Sets the client-side encoding (character set).
<varlistentry>
<indexterm>
<primary>deadlock</primary>
- <secondary>timeout</secondary>
+ <secondary>timeout during</secondary>
</indexterm>
<indexterm>
<primary>timeout</primary>
<title>Version and Platform Compatibility</title>
<sect3 id="runtime-config-compatible-version">
- <title>Previous Postgres Versions</title>
+ <title>Previous PostgreSQL Versions</title>
<variablelist>
<varlistentry>
<term><varname>ADD_MISSING_FROM</varname> (<type>boolean</type>)</term>
- <indexterm><primary>missing from</></>
+ <indexterm><primary>FROM</><secondary>missing</></>
<listitem>
<para>
When <literal>true</>, tables that are referenced by a query will be
<varlistentry>
<term><systemitem class="osname">BSD/OS</></term>
- <indexterm><primary>BSD/OS</></>
+ <indexterm><primary>BSD/OS</><secondary>IPC configuration</></>
<listitem>
<formalpara>
<title>Shared Memory</>
<term><systemitem class="osname">FreeBSD</></term>
<term><systemitem class="osname">NetBSD</></term>
<term><systemitem class="osname">OpenBSD</></term>
- <indexterm><primary>FreeBSD</></>
- <indexterm><primary>NetBSD</></>
- <indexterm><primary>OpenBSD</></>
+ <indexterm><primary>FreeBSD</><secondary>IPC configuration</></>
+ <indexterm><primary>NetBSD</><secondary>IPC configuration</></>
+ <indexterm><primary>OpenBSD</><secondary>IPC configuration</></>
<listitem>
<para>
The options <varname>SYSVSHM</> and <varname>SYSVSEM</> need
<varlistentry>
<term><systemitem class="osname">HP-UX</></term>
- <indexterm><primary>HP-UX</></>
+ <indexterm><primary>HP-UX</><secondary>IPC configuration</></>
<listitem>
<para>
The default settings tend to suffice for normal installations.
<varlistentry>
<term><systemitem class="osname">Linux</></term>
- <indexterm><primary>Linux</></>
+ <indexterm><primary>Linux</><secondary>IPC configuration</></>
<listitem>
<para>
The default shared memory limit (both
<varlistentry>
<term><systemitem class="osname">MacOS X</></term>
- <indexterm><primary>MacOS X</></>
+ <indexterm><primary>MacOS X</><secondary>IPC configuration</></>
<listitem>
<para>
Edit the file
<varlistentry>
<term><systemitem class="osname">SCO OpenServer</></term>
- <indexterm><primary>SCO OpenServer</></>
+ <indexterm><primary>SCO OpenServer</><secondary>IPC configuration</></>
<listitem>
<para>
In the default configuration, only 512 kB of shared memory per
<varlistentry>
<term><systemitem class="osname">Solaris</></term>
- <indexterm><primary>Solaris</></>
+ <indexterm><primary>Solaris</><secondary>IPC configuration</></>
<listitem>
<para>
At least in version 2.6, the default maximum size of a shared
<varlistentry>
<term><systemitem class="osname">UnixWare</></term>
- <indexterm><primary>UnixWare</></>
+ <indexterm><primary>UnixWare</><secondary>IPC configuration</></>
<listitem>
<para>
On <productname>UnixWare</> 7, the maximum size for shared
<sect1 id="postmaster-shutdown">
<title>Shutting Down the Server</title>
+ <indexterm zone="postmaster-shutdown">
+ <primary>shutdown</>
+ </indexterm>
+
<para>
There are several ways to shut down the database server. You control
the type of shutdown by sending different signals to the server
process.
<variablelist>
<varlistentry>
- <term><systemitem>SIGTERM</systemitem></term>
+ <term><systemitem>SIGTERM</systemitem><indexterm><primary>SIGTERM</></></term>
<listitem>
<para>
After receiving <systemitem>SIGTERM</systemitem>, the server
</varlistentry>
<varlistentry>
- <term><systemitem>SIGINT</systemitem></term>
+ <term><systemitem>SIGINT</systemitem><indexterm><primary>SIGINT</></></term>
<listitem>
<para>
The server disallows new connections and sends all existing
</varlistentry>
<varlistentry>
- <term><systemitem>SIGQUIT</systemitem></term>
+ <term><systemitem>SIGQUIT</systemitem><indexterm><primary>SIGQUIT</></></term>
<listitem>
<para>
This is the <firstterm>Immediate Shutdown</firstterm>, which
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/spi.sgml,v 1.26 2003/08/27 22:13:35 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/spi.sgml,v 1.27 2003/08/31 17:32:20 petere Exp $
-->
<chapter id="spi">
<para>
<productname>PostgreSQL</productname> allocates memory within
<firstterm>memory contexts</firstterm><indexterm><primary>memory
- context</primary></indexterm>, which provide a convenient method of
+ context</primary><secondary>in SPI</secondary></indexterm>, which provide a convenient method of
managing allocations made in many different places that need to
live for differing amounts of time. Destroying a context releases
all the memory that was allocated in it. Thus, it is not necessary
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/syntax.sgml,v 1.83 2003/08/19 06:06:48 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/syntax.sgml,v 1.84 2003/08/31 17:32:20 petere Exp $
-->
<chapter id="sql-syntax">
<sect1 id="sql-syntax-lexical">
<title>Lexical Structure</title>
+ <indexterm>
+ <primary>token</primary>
+ </indexterm>
+
<para>
SQL input consists of a sequence of
<firstterm>commands</firstterm>. A command is composed of a
<title>Identifiers and Key Words</title>
<indexterm zone="sql-syntax-identifiers">
- <primary>identifiers</primary>
+ <primary>identifier</primary>
+ <secondary>syntax of</secondary>
</indexterm>
<indexterm zone="sql-syntax-identifiers">
- <primary>key words</primary>
- <secondary>syntax</secondary>
+ <primary>name</primary>
+ <secondary>syntax of</secondary>
+ </indexterm>
+
+ <indexterm zone="sql-syntax-identifiers">
+ <primary>key word</primary>
+ <secondary>syntax of</secondary>
</indexterm>
<para>
</para>
<para>
+ <indexterm><primary>identifier</primary><secondary>length</secondary></indexterm>
The system uses no more than <symbol>NAMEDATALEN</symbol>-1
characters of an identifier; longer names can be written in
commands, but they will be truncated. By default,
<para>
<indexterm>
<primary>case sensitivity</primary>
- <secondary>SQL commands</secondary>
+ <secondary>of SQL commands</secondary>
</indexterm>
Identifier and key word names are case insensitive. Therefore
<programlisting>
<para>
<indexterm>
- <primary>quotes</primary>
+ <primary>quotation marks</primary>
<secondary>and identifiers</secondary>
</indexterm>
There is a second kind of identifier: the <firstterm>delimited
<title>Constants</title>
<indexterm zone="sql-syntax-constants">
- <primary>constants</primary>
+ <primary>constant</primary>
</indexterm>
<para>
<title>String Constants</title>
<indexterm zone="sql-syntax-strings">
- <primary>character strings</primary>
- <secondary>constants</secondary>
+ <primary>character string</primary>
+ <secondary>constant</secondary>
</indexterm>
<para>
<indexterm>
- <primary>quotes</primary>
+ <primary>quotation marks</primary>
<secondary>escaping</secondary>
</indexterm>
A string constant in SQL is an arbitrary sequence of characters
<title>Bit-String Constants</title>
<indexterm zone="sql-syntax-bit-strings">
- <primary>bit strings</primary>
- <secondary>constants</secondary>
+ <primary>bit string</primary>
+ <secondary>constant</secondary>
</indexterm>
<para>
<title>Numeric Constants</title>
<indexterm>
- <primary>numeric</primary>
- <secondary>constants</secondary>
+ <primary>number</primary>
+ <secondary>constant</secondary>
</indexterm>
<para>
</para>
<para>
+ <indexterm><primary>integer</primary></indexterm>
+ <indexterm><primary>bigint</primary></indexterm>
+ <indexterm><primary>numeric</primary></indexterm>
A numeric constant that contains neither a decimal point nor an
exponent is initially presumed to be type <type>integer</> if its
value fits in type <type>integer</> (32 bits); otherwise it is
<para>
The initially assigned data type of a numeric constant is just a
- starting point for the type resolution algorithms. In most
- cases the constant will be automatically coerced to the most
- appropriate type depending on context. When necessary, you
- can force a numeric value to be interpreted as a specific
- data type by casting it. For example, you can force a numeric
- value to be treated as type <type>real</> (<type>float4</>)
- by writing
+ starting point for the type resolution algorithms. In most cases
+ the constant will be automatically coerced to the most
+ appropriate type depending on context. When necessary, you can
+ force a numeric value to be interpreted as a specific data type
+ by casting it.<indexterm><primary>type cast</primary></indexterm>
+ For example, you can force a numeric value to be treated as type
+ <type>real</> (<type>float4</>) by writing
<programlisting>
REAL '1.23' -- string style
<title>Constants of Other Types</title>
<indexterm>
- <primary>data types</primary>
- <secondary>constants</secondary>
+ <primary>data type</primary>
+ <secondary>constant</secondary>
</indexterm>
<para>
<title>Array constants</title>
<indexterm>
- <primary>arrays</primary>
- <secondary>constants</secondary>
+ <primary>array</primary>
+ <secondary>constant</secondary>
</indexterm>
<para>
<title>Operators</title>
<indexterm zone="sql-syntax-operators">
- <primary>operators</primary>
+ <primary>operator</primary>
<secondary>syntax</secondary>
</indexterm>
<title>Comments</title>
<indexterm zone="sql-syntax-comments">
- <primary>comments</primary>
- <secondary>in SQL</secondary>
+ <primary>comment</primary>
+ <secondary sortas="SQL">in SQL</secondary>
</indexterm>
<para>
<title>Lexical Precedence</title>
<indexterm zone="sql-precedence">
- <primary>operators</primary>
+ <primary>operator</primary>
<secondary>precedence</secondary>
</indexterm>
<sect1 id="sql-expressions">
<title>Value Expressions</title>
+ <indexterm zone="sql-expressions">
+ <primary>expression</primary>
+ <secondary>syntax</secondary>
+ </indexterm>
+
+ <indexterm zone="sql-expressions">
+ <primary>value expression</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>scalar</primary>
+ <see>expression</see>
+ </indexterm>
+
<para>
Value expressions are used in a variety of contexts, such
as in the target list of the <command>SELECT</command> command, as
<listitem>
<para>
- Another value expression in parentheses, useful to group subexpressions and override precedence.
+ Another value expression in parentheses, useful to group
+ subexpressions and override
+ precedence.<indexterm><primary>parenthesis</></>
</para>
</listitem>
</itemizedlist>
<sect2>
<title>Column References</title>
+ <indexterm>
+ <primary>column reference</primary>
+ </indexterm>
+
<para>
A column can be referenced in the form
<synopsis>
<sect2>
<title>Positional Parameters</title>
+ <indexterm>
+ <primary>parameter</primary>
+ <secondary>syntax</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>$</primary>
+ </indexterm>
+
<para>
A positional parameter reference is used to indicate a value
that is supplied externally to an SQL statement. Parameters are
<sect2>
<title>Operator Invocations</title>
+ <indexterm>
+ <primary>operator</primary>
+ <secondary>invocation</secondary>
+ </indexterm>
+
<para>
There are three possible syntaxes for an operator invocation:
<simplelist>
<sect2>
<title>Function Calls</title>
+ <indexterm>
+ <primary>function</primary>
+ <secondary>invocation</secondary>
+ </indexterm>
+
<para>
The syntax for a function call is the name of a function
(possibly qualified with a schema name), followed by its argument list
<title>Aggregate Expressions</title>
<indexterm zone="syntax-aggregates">
- <primary>aggregate functions</primary>
+ <primary>aggregate function</primary>
+ <secondary>invocation</secondary>
</indexterm>
<para>
<sect2 id="sql-syntax-type-casts">
<title>Type Casts</title>
- <indexterm>
- <primary>data types</primary>
- <secondary>type casts</secondary>
- </indexterm>
+ <indexterm>
+ <primary>data type</primary>
+ <secondary>type cast</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>type cast</primary>
+ </indexterm>
<para>
A type cast specifies a conversion from one data type to another.
<sect2 id="sql-syntax-scalar-subqueries">
<title>Scalar Subqueries</title>
+ <indexterm>
+ <primary>subquery</primary>
+ </indexterm>
+
<para>
A scalar subquery is an ordinary
<command>SELECT</command> query in parentheses that returns exactly one
<sect2 id="sql-syntax-array-constructors">
<title>Array Constructors</title>
- <indexterm>
- <primary>arrays</primary>
- <secondary>constructors</secondary>
- </indexterm>
+ <indexterm>
+ <primary>array</primary>
+ <secondary>constructor</secondary>
+ </indexterm>
<para>
An <firstterm>array constructor</> is an expression that builds an
<sect2 id="syntax-express-eval">
<title>Expression Evaluation Rules</title>
+ <indexterm>
+ <primary>expression</primary>
+ <secondary>order of evaluation</secondary>
+ </indexterm>
+
<para>
The order of evaluation of subexpressions is not defined. In
particular, the inputs of an operator or function are not necessarily
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/trigger.sgml,v 1.29 2003/08/10 01:20:34 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/trigger.sgml,v 1.30 2003/08/31 17:32:20 petere Exp $
-->
<chapter id="triggers">
<title>Triggers</title>
+ <indexterm zone="triggers">
+ <primary>trigger</primary>
+ </indexterm>
+
<para>
This chapter describes how to write trigger functions. In
particular, it describes the C-language interface for trigger
<para>
When a trigger is being defined, arguments can be specified for
- it. The purpose of including arguments in the trigger definition
- is to allow different triggers with similar requirements to call
- the same function. As an example, there could be a generalized
- trigger function that takes as its arguments two column names and
- puts the current user in one and the current time stamp in the
- other. Properly written, this trigger function would be
- independent of the specific table it is triggering on. So the
- same function could be used for <command>INSERT</command> events
- on any table with suitable columns, to automatically track creation
- of records in a transaction table for example. It could also be
- used to track last-update events if defined as an
- <command>UPDATE</command> trigger.
+ it.<indexterm><primary>trigger</><secondary>arguments for trigger
+ functions</></indexterm> The purpose of including arguments in the
+ trigger definition is to allow different triggers with similar
+ requirements to call the same function. As an example, there
+ could be a generalized trigger function that takes as its
+ arguments two column names and puts the current user in one and
+ the current time stamp in the other. Properly written, this
+ trigger function would be independent of the specific table it is
+ triggering on. So the same function could be used for
+ <command>INSERT</command> events on any table with suitable
+ columns, to automatically track creation of records in a
+ transaction table for example. It could also be used to track
+ last-update events if defined as an <command>UPDATE</command>
+ trigger.
</para>
</sect1>
<sect1 id="trigger-manager">
<title>Interaction with the Trigger Manager</title>
+ <indexterm zone="trigger-manager">
+ <primary>trigger</primary>
+ <secondary>in C</secondary>
+ </indexterm>
+
<para>
This section describes the low-level details of the interface to a
trigger function. This information is only needed when writing a
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/typeconv.sgml,v 1.32 2003/08/14 23:13:27 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/typeconv.sgml,v 1.33 2003/08/31 17:32:20 petere Exp $
-->
<chapter Id="typeconv">
<title>Type Conversion</title>
+<indexterm zone="typeconv">
+ <primary>data type</primary>
+ <secondary>conversion</secondary>
+</indexterm>
+
<para>
<acronym>SQL</acronym> statements can, intentionally or not, require
mixing of different data types in the same expression.
altered.)
</para>
+<indexterm>
+ <primary>data type</primary>
+ <secondary>category</secondary>
+</indexterm>
+
<para>
An additional heuristic is provided in the parser to allow better guesses
at proper behavior for <acronym>SQL</acronym> standard types. There are
<sect1 id="typeconv-oper">
<title>Operators</title>
+<indexterm zone="typeconv-oper">
+ <primary>operator</primary>
+ <secondary>type resolution in an invocation</secondary>
+</indexterm>
+
<para>
The specific operator to be used in an operator invocation is determined
by following
<sect1 id="typeconv-func">
<title>Functions</title>
+<indexterm zone="typeconv-func">
+ <primary>function</primary>
+ <secondary>type resolution in an invocation</secondary>
+</indexterm>
+
<para>
The specific function to be used in a function invocation is determined
according to the following steps.
</sect1>
<sect1 id="typeconv-union-case">
-<title><literal>UNION</literal>, <literal>CASE</literal>, and
-<literal>ARRAY</literal> Constructs</title>
+<title><literal>UNION</literal>, <literal>CASE</literal>, and <literal>ARRAY</literal> Constructs</title>
+
+<indexterm zone="typeconv-union-case">
+ <primary>UNION</primary>
+ <secondary>determination of result type</secondary>
+</indexterm>
+
+<indexterm zone="typeconv-union-case">
+ <primary>CASE</primary>
+ <secondary>determination of result type</secondary>
+</indexterm>
+
+<indexterm zone="typeconv-union-case">
+ <primary>ARRAY</primary>
+ <secondary>determination of result type</secondary>
+</indexterm>
<para>
SQL <literal>UNION</> constructs must match up possibly dissimilar types to
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/user-manag.sgml,v 1.21 2003/08/10 01:20:34 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/user-manag.sgml,v 1.22 2003/08/31 17:32:20 petere Exp $
-->
<chapter id="user-manag">
<sect1 id="database-users">
<title>Database Users</title>
+ <indexterm zone="database-users">
+ <primary>user</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>CREATE USER</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>DROP USER</primary>
+ </indexterm>
+
<para>
Database users are conceptually completely separate from
operating system users. In practice it might be convenient to
</synopsis>
</para>
+ <indexterm>
+ <primary>createuser</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>dropuser</primary>
+ </indexterm>
+
<para>
For convenience, the programs <command>createuser</command>
and <command>dropuser</command> are provided as wrappers
<variablelist>
<varlistentry>
- <term>superuser</term>
+ <term>superuser<indexterm><primary>superuser</></></term>
<listitem>
<para>
A database superuser bypasses all permission checks. Also,
</varlistentry>
<varlistentry>
- <term>database creation</term>
+ <term>database creation<indexterm><primary>database</><secondary>privilege to create</></></term>
<listitem>
<para>
A user must be explicitly given permission to create databases
</varlistentry>
<varlistentry>
- <term>password</term>
+ <term>password<indexterm><primary>password</></></term>
<listitem>
<para>
A password is only significant if the client authentication
</variablelist>
A user's attributes can be modified after creation with
- <command>ALTER USER</command>.
+ <command>ALTER USER</command>.<indexterm><primary>ALTER USER</></>
See the reference pages for <command>CREATE USER</command> and
<command>ALTER USER</command> for details.
</para>
<sect1 id="groups">
<title>Groups</title>
+ <indexterm zone="groups">
+ <primary>group</primary>
+ </indexterm>
+
<para>
As in Unix, groups are a way of logically grouping users to ease
management of privileges: privileges can be granted to, or revoked
<sect1 id="privileges">
<title>Privileges</title>
+ <indexterm zone="privileges">
+ <primary>privilege</primary>
+ </indexterm>
+
+ <indexterm zone="privileges">
+ <primary>owner</primary>
+ </indexterm>
+
+ <indexterm zone="privileges">
+ <primary>GRANT</primary>
+ </indexterm>
+
+ <indexterm zone="privileges">
+ <primary>REVOKE</primary>
+ </indexterm>
+
<comment>Being moved to the DDL chapter. Will eventually disappear here.</comment>
<para>
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/wal.sgml,v 1.23 2003/03/24 14:32:51 petere Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/wal.sgml,v 1.24 2003/08/31 17:32:20 petere Exp $ -->
<chapter id="wal">
<title>Write-Ahead Logging (<acronym>WAL</acronym>)</title>
+ <indexterm zone="wal">
+ <primary>WAL</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>transaction log</primary>
+ <see>WAL</see>
+ </indexterm>
+
<para>
<firstterm>Write-Ahead Logging</firstterm> (<acronym>WAL</acronym>)
is a standard approach to transaction logging. Its detailed
<sect1 id="wal-benefits-now">
<title>Benefits of <acronym>WAL</acronym></title>
+ <indexterm zone="wal-benefits-now">
+ <primary>fsync</primary>
+ </indexterm>
+
<para>
The first obvious benefit of using <acronym>WAL</acronym> is a
significantly reduced number of disk writes, since only the log
<para>
With UNDO, it will also be possible to implement
- <firstterm>savepoints</firstterm> to allow partial rollback of
+ <firstterm>savepoints</firstterm><indexterm><primary>savepoint</></> to allow partial rollback of
invalid transaction operations (parser errors caused by mistyping
commands, insertion of duplicate primary/unique keys and so on)
with the ability to continue or commit valid operations made by
</para>
<para>
- <firstterm>Checkpoints</firstterm> are points in the sequence of
+ <firstterm>Checkpoints</firstterm><indexterm><primary>checkpoint</></> are points in the sequence of
transactions at which it is guaranteed that the data files have
been updated with all information logged before the checkpoint. At
checkpoint time, all dirty data pages are flushed to disk and a
<para>
The aim of <acronym>WAL</acronym>, to ensure that the log is
written before database records are altered, may be subverted by
- disk drives that falsely report a successful write to the kernel,
+ disk drives<indexterm><primary>disk drive</></> that falsely report a successful write to the kernel,
when, in fact, they have only cached the data and not yet stored it
on the disk. A power failure in such a situation may still lead to
irrecoverable data corruption. Administrators should try to ensure
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/xaggr.sgml,v 1.21 2003/08/09 22:50:22 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/xaggr.sgml,v 1.22 2003/08/31 17:32:20 petere Exp $
-->
<sect1 id="xaggr">
<title>User-Defined Aggregates</title>
<indexterm zone="xaggr">
- <primary>aggregate functions</primary>
- <secondary>extending</secondary>
+ <primary>aggregate function</primary>
+ <secondary>user-defined</secondary>
</indexterm>
<para>
Aggregate functions may use polymorphic
state transition functions or final functions, so that the same functions
can be used to implement multiple aggregates.
- See <xref linkend="types-polymorphic">
+ See <xref linkend="extend-types-polymorphic">
for an explanation of polymorphic functions.
Going a step further, the aggregate function itself may be specified
with a polymorphic base type and state type, allowing a single
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/xfunc.sgml,v 1.72 2003/08/10 01:20:34 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/xfunc.sgml,v 1.73 2003/08/31 17:32:20 petere Exp $
-->
<sect1 id="xfunc">
<title>User-Defined Functions</title>
- <indexterm zone="xfunc"><primary>function</></>
+ <indexterm zone="xfunc">
+ <primary>function</primary>
+ <secondary>user-defined</secondary>
+ </indexterm>
<para>
<productname>PostgreSQL</productname> provides four kinds of
<sect1 id="xfunc-sql">
<title>Query Language (<acronym>SQL</acronym>) Functions</title>
- <indexterm zone="xfunc-sql"><primary>function</><secondary>SQL</></>
+ <indexterm zone="xfunc-sql">
+ <primary>function</primary>
+ <secondary>user-defined</secondary>
+ <tertiary>in SQL</tertiary>
+ </indexterm>
<para>
SQL functions execute an arbitrary list of SQL statements, returning
</para>
<para>
- <indexterm><primary>SETOF</><seealso>function</></>
- Alternatively, an SQL function may be declared to return a set,
- by specifying the function's return type
- as <literal>SETOF <replaceable>sometype</></literal>. In this case
- all rows of the last query's result are returned. Further details
- appear below.
+ <indexterm><primary>SETOF</><seealso>function</></> Alternatively,
+ an SQL function may be declared to return a set, by specifying the
+ function's return type as <literal>SETOF
+ <replaceable>sometype</></literal>.<indexterm><primary>SETOF</></>
+ In this case all rows of the last query's result are returned.
+ Further details appear below.
</para>
<para>
<acronym>SQL</acronym> functions may be declared to accept and
return the <quote>polymorphic</> types
<type>anyelement</type> and <type>anyarray</type>.
- See <xref linkend="types-polymorphic"> for a more detailed explanation
+ See <xref linkend="extend-types-polymorphic"> for a more detailed explanation
of polymorphic functions. Here is a polymorphic function
<function>make_array</function> that builds up an array from two
arbitrary data type elements:
<sect1 id="xfunc-c">
<title>C-Language Functions</title>
+ <indexterm zone="xfunc-sql">
+ <primary>function</primary>
+ <secondary>user-defined</secondary>
+ <tertiary>in C</tertiary>
+ </indexterm>
+
<para>
User-defined functions can be written in C (or a language that can
be made compatible with C, such as C++). Such functions are
<sect2 id="xfunc-c-dynload">
<title>Dynamic Loading</title>
+ <indexterm zone="xfunc-c-dynload">
+ <primary>dynamic loading</primary>
+ </indexterm>
+
<para>
The first time a user-defined function in a particular
loadable object file is called in a session,
</sect2>
- <sect2>
+ <sect2 id="xfunc-c-basetype">
<title>Base Types in C-Language Functions</title>
+ <indexterm zone="xfunc-c-basetype">
+ <primary>data type</primary>
+ <secondary>internal organisation</secondary>
+ </indexterm>
+
<para>
To know how to write C-language functions, you need to know how
PostgreSQL internally represents base data types and how they can
<listitem>
<para>
Use <literal>pg_config
- --includedir-server</literal><indexterm><primary>pg_config</></>
+ --includedir-server</literal><indexterm><primary>pg_config</><secondary>with user-defined C functions</></>
to find out where the <productname>PostgreSQL</> server header
files are installed on your system (or the system that your
users will be running on). This option is new with
<para>
When allocating memory, use the
<productname>PostgreSQL</productname> functions
- <function>palloc</function> and <function>pfree</function>
+ <function>palloc</function><indexterm><primary>palloc</></> and <function>pfree</function><indexterm><primary>pfree</></>
instead of the corresponding C library functions
<function>malloc</function> and <function>free</function>.
The memory allocated by <function>palloc</function> will be
C-language functions may be declared to accept and
return the <quote>polymorphic</> types
<type>anyelement</type> and <type>anyarray</type>.
- See <xref linkend="types-polymorphic"> for a more detailed explanation
+ See <xref linkend="extend-types-polymorphic"> for a more detailed explanation
of polymorphic functions. When function arguments or return types
are defined as polymorphic types, the function author cannot know
in advance what data type it will be called with, or
<sect1 id="xfunc-overload">
<title>Function Overloading</title>
- <indexterm zone="xfunc-overload"><primary>overloading</></>
+ <indexterm zone="xfunc-overload">
+ <primary>overloading</primary>
+ <secondary>functions</secondary>
+ </indexterm>
<para>
More than one function may be defined with the same SQL name, so long
<sect1 id="xfunc-plhandler">
<title>Procedural Language Handlers</title>
+ <indexterm zone="xfunc-plhandler">
+ <primary>procedural language</primary>
+ <secondary>handler for</secondary>
+ </indexterm>
+
<para>
All calls to functions that are written in a language other than
the current <quote>version 1</quote> interface for compiled
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/xindex.sgml,v 1.31 2003/08/17 22:09:00 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/xindex.sgml,v 1.32 2003/08/31 17:32:21 petere Exp $
-->
<sect1 id="xindex">
<title>Interfacing Extensions To Indexes</title>
+ <indexterm zone="xindex">
+ <primary>index</primary>
+ <secondary>for user-defined data type</secondary>
+ </indexterm>
+
<para>
The procedures described thus far let you define new types, new
functions, and new operators. However, we cannot yet define an
<para>
The routines for an index method do not directly know anything
- about the data types that the index method will operate on. Instead, an
- <firstterm>operator class</> identifies the set of operations that the
- index method needs to use to work with a particular data type.
- Operator classes are so called because one thing they specify is the set
- of <literal>WHERE</>-clause operators that can be used with an index (i.e., can be
- converted into an index-scan qualification). An operator class may also
- specify some <firstterm>support procedures</> that are needed by the
- internal operations of the index method, but do not directly
- correspond to any <literal>WHERE</>-clause operator that can be used with the index.
+ about the data types that the index method will operate on.
+ Instead, an <firstterm>operator
+ class</><indexterm><primary>operator class</></indexterm>
+ identifies the set of operations that the index method needs to use
+ to work with a particular data type. Operator classes are so
+ called because one thing they specify is the set of
+ <literal>WHERE</>-clause operators that can be used with an index
+ (i.e., can be converted into an index-scan qualification). An
+ operator class may also specify some <firstterm>support
+ procedures</> that are needed by the internal operations of the
+ index method, but do not directly correspond to any
+ <literal>WHERE</>-clause operator that can be used with the index.
</para>
<para>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/xoper.sgml,v 1.25 2003/08/17 22:09:00 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/xoper.sgml,v 1.26 2003/08/31 17:32:21 petere Exp $
-->
<sect1 id="xoper">
<title>User-defined Operators</title>
+ <indexterm zone="xoper">
+ <primary>operator</primary>
+ <secondary>user-defined</secondary>
+ </indexterm>
+
<Para>
Every operator is <quote>syntactic sugar</quote> for a call to an
underlying function that does the real work; so you must
<Para>
<productname>PostgreSQL</productname> supports left unary, right
- unary, and binary operators. Operators can be overloaded; that is,
- the same operator name can be used for different operators that
- have different numbers and types of operands. When a query is
+ unary, and binary operators. Operators can be
+ overloaded;<indexterm><primary>overloading</primary><secondary>operators</secondary></indexterm>
+ that is, the same operator name can be used for different operators
+ that have different numbers and types of operands. When a query is
executed, the system determines the operator to call from the
number and types of the provided operands.
</Para>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/xplang.sgml,v 1.22 2003/06/30 18:31:42 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/xplang.sgml,v 1.23 2003/08/31 17:32:21 petere Exp $
-->
<chapter id="xplang">
<title id="xplang-title">Procedural Languages</title>
+ <indexterm zone="xplang">
+ <primary>procedural language</primary>
+ </indexterm>
+
<para>
<productname>PostgreSQL</productname> allows users to add new
programming languages to be available for writing functions and
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/xtypes.sgml,v 1.19 2003/08/10 01:20:34 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/xtypes.sgml,v 1.20 2003/08/31 17:32:21 petere Exp $
-->
<sect1 id="xtypes">
<title>User-Defined Types</title>
<indexterm zone="xtypes">
- <primary>data types</primary>
- <secondary>extending</secondary>
+ <primary>data type</primary>
+ <secondary>user-defined</secondary>
</indexterm>
<comment>
<indexterm>
<primary>output function</primary>
</indexterm>
- A user-defined type must always have input and output functions.
+ A user-defined type must always have input and output
+ functions.<indexterm><primary>input function</primary><secondary>of
+ a data type</secondary></indexterm><indexterm><primary>output
+ function</primary><secondary>of a data type</secondary></indexterm>
These functions determine how the type appears in strings (for input
by the user and output to the user) and how the type is organized in
memory. The input function takes a null-terminated character string
- as its argument and returns the internal (in memory) representation of
- the type. The output function takes the internal representation of
- the type as argument and returns a null-terminated character string.
+ as its argument and returns the internal (in memory) representation
+ of the type. The output function takes the internal representation
+ of the type as argument and returns a null-terminated character
+ string.
</para>
<para>
projects / postgresql / commitdiff