Skip to content

P
Postgres FD Implementation
Commit a75f2d21 authored by Thomas G. Lockhart's avatar Thomas G. Lockhart
Browse files
Options

Clean up to ensure tag completion as required by the newest versions 

 of Norm's Modular Style Sheets and jade/docbook.
From Vince Vielhaber <vev@michvhf.com>.
parent 6d7735e7
Hide whitespace changes
Inline Side-by-side
Showing with 10677 additions and 8090 deletions
doc/src/sgml/about.sgml
View file @ a75f2d21
...@@ -4,15 +4,15 @@ ...@@ -4,15 +4,15 @@
<Para> <Para>
<ProductName>PostgreSQL</ProductName> is available without cost. This manual <ProductName>PostgreSQL</ProductName> is available without cost. This manual
describes version 6.4 of <ProductName>PostgreSQL</ProductName>. describes version 6.4 of <ProductName>PostgreSQL</ProductName>.
</Para>
<Para> <Para>
We will use <ProductName>Postgres</ProductName> We will use <ProductName>Postgres</ProductName>
to mean the version distributed as <ProductName>PostgreSQL</ProductName>. to mean the version distributed as <ProductName>PostgreSQL</ProductName>.
</Para>
<Para> <Para>
Check the Administrator's Guide for a list of currently supported machines. Check the Administrator's Guide for a list of currently supported machines.
In general, In general,
<ProductName>Postgres</ProductName> is portable to any Unix/Posix-compatible system <ProductName>Postgres</ProductName> is portable to any Unix/Posix-compatible system
with full libc library support. with full libc library support.
</Para>
</Sect1> </Sect1>
doc/src/sgml/advanced.sgml
View file @ a75f2d21
...@@ -66,6 +66,7 @@ SELECT name, altitude ...@@ -66,6 +66,7 @@ SELECT name, altitude
|Mariposa | 1953 | |Mariposa | 1953 |
+----------+----------+ +----------+----------+
</ProgramListing> </ProgramListing>
</Para>
<Para> <Para>
On the other hand, to find the names of all cities, On the other hand, to find the names of all cities,
...@@ -111,6 +112,7 @@ SELECT c.name, c.altitude ...@@ -111,6 +112,7 @@ SELECT c.name, c.altitude
sub-values that can be accessed from the query sub-values that can be accessed from the query
language. For example, you can create attributes that language. For example, you can create attributes that
are arrays of base types. are arrays of base types.
</Para>
<Sect2> <Sect2>
<Title>Arrays</Title> <Title>Arrays</Title>
...@@ -210,7 +212,7 @@ SELECT SAL_EMP.schedule[1:2][1:1] ...@@ -210,7 +212,7 @@ SELECT SAL_EMP.schedule[1:2][1:1]
+-------------------+ +-------------------+
</ProgramListing> </ProgramListing>
</Para> </Para>
</sect2>
</Sect1> </Sect1>
<Sect1> <Sect1>
...@@ -286,6 +288,7 @@ On UNIX systems, this is always midnight, January 1, 1970 GMT. ...@@ -286,6 +288,7 @@ On UNIX systems, this is always midnight, January 1, 1970 GMT.
|Mariposa | 1320 | |Mariposa | 1320 |
+---------+------------+ +---------+------------+
</ProgramListing> </ProgramListing>
</Para>
<Para> <Para>
The default beginning of a time range is the earliest The default beginning of a time range is the earliest
...@@ -293,6 +296,7 @@ On UNIX systems, this is always midnight, January 1, 1970 GMT. ...@@ -293,6 +296,7 @@ On UNIX systems, this is always midnight, January 1, 1970 GMT.
the current time; thus, the above time range can be the current time; thus, the above time range can be
abbreviated as ``[,].'' abbreviated as ``[,].''
</Para> </Para>
</sect1>
<Sect1> <Sect1>
<Title>More Advanced Features</Title> <Title>More Advanced Features</Title>
...@@ -301,5 +305,7 @@ On UNIX systems, this is always midnight, January 1, 1970 GMT. ...@@ -301,5 +305,7 @@ On UNIX systems, this is always midnight, January 1, 1970 GMT.
<ProductName>Postgres</ProductName> has many features not touched upon in this <ProductName>Postgres</ProductName> has many features not touched upon in this
tutorial introduction, which has been oriented toward newer users of <Acronym>SQL</Acronym>. tutorial introduction, which has been oriented toward newer users of <Acronym>SQL</Acronym>.
These are discussed in more detail in both the User's and Programmer's Guides. These are discussed in more detail in both the User's and Programmer's Guides.
</Para>
</sect1>
</Chapter> </Chapter>
doc/src/sgml/arch-dev.sgml
View file @ a75f2d21
...@@ -30,6 +30,7 @@ ...@@ -30,6 +30,7 @@
</Para> </Para>
</ListItem> </ListItem>
</ItemizedList> </ItemizedList>
</Para>
<Para> <Para>
A single <Application>postmaster</Application> manages a given collection of A single <Application>postmaster</Application> manages a given collection of
...@@ -76,5 +77,5 @@ ...@@ -76,5 +77,5 @@
case, all files relating to a database should belong to case, all files relating to a database should belong to
this <ProductName>Postgres</ProductName> superuser. this <ProductName>Postgres</ProductName> superuser.
</Para> </Para>
</sect1>
</Chapter> </Chapter>
doc/src/sgml/arch-pg.sgml
View file @ a75f2d21
...@@ -30,7 +30,7 @@ ...@@ -30,7 +30,7 @@
</Para> </Para>
</ListItem> </ListItem>
</ItemizedList> </ItemizedList>
</para>
<Para> <Para>
A single <Application>postmaster</Application> manages a given collection of A single <Application>postmaster</Application> manages a given collection of
databases on a single host. Such a collection of databases on a single host. Such a collection of
...@@ -79,5 +79,5 @@ Furthermore, the <ProductName>Postgres</ProductName> superuser should ...@@ -79,5 +79,5 @@ Furthermore, the <ProductName>Postgres</ProductName> superuser should
case, all files relating to a database should belong to case, all files relating to a database should belong to
this <ProductName>Postgres</ProductName> superuser. this <ProductName>Postgres</ProductName> superuser.
</Para> </Para>
</sect1>
</Chapter> </Chapter>
doc/src/sgml/arch.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ ...@@ -12,6 +12,7 @@
In database jargon, <ProductName>Postgres</ProductName> uses a simple "process In database jargon, <ProductName>Postgres</ProductName> uses a simple "process
per-user" client/server model. A <ProductName>Postgres</ProductName> session per-user" client/server model. A <ProductName>Postgres</ProductName> session
consists of the following cooperating UNIX processes (programs): consists of the following cooperating UNIX processes (programs):
</Para>
<ItemizedList> <ItemizedList>
<ListItem> <ListItem>
...@@ -53,6 +54,7 @@ ...@@ -53,6 +54,7 @@
<Application>postmaster</Application>. Hence, the <Application>postmaster</Application> is always running, waiting <Application>postmaster</Application>. Hence, the <Application>postmaster</Application> is always running, waiting
for requests, whereas frontend and backend processes for requests, whereas frontend and backend processes
come and go. come and go.
</Para>
<Para> <Para>
The <FileName>libpq</FileName> library allows a single The <FileName>libpq</FileName> library allows a single
...@@ -69,6 +71,7 @@ ...@@ -69,6 +71,7 @@
machine may not be accessible (or may only be accessed machine may not be accessible (or may only be accessed
using a different filename) on the database server using a different filename) on the database server
machine. machine.
</Para>
<Para> <Para>
You should also be aware that the <Application>postmaster</Application> and You should also be aware that the <Application>postmaster</Application> and
...@@ -81,5 +84,5 @@ ...@@ -81,5 +84,5 @@
case, all files relating to a database should belong to case, all files relating to a database should belong to
this <ProductName>Postgres</ProductName> superuser. this <ProductName>Postgres</ProductName> superuser.
</Para> </Para>
</sect1>
</Chapter> </Chapter>
doc/src/sgml/bki.sgml
View file @ a75f2d21
<!-- <!--
$Header: /cvsroot/pgsql/doc/src/sgml/bki.sgml,v 1.1 1998/08/15 06:49:33 thomas Exp $ $Header: /cvsroot/pgsql/doc/src/sgml/bki.sgml,v 1.2 1998/12/29 02:24:13 thomas Exp $
Transcribed from the original bki.man.5 documentation Transcribed from the original bki.man.5 documentation
- Thomas Lockhart 1998-08-03 - Thomas Lockhart 1998-08-03
...@@ -28,12 +28,14 @@ takes as input <productname>Postgres</productname> source files that double as ...@@ -28,12 +28,14 @@ takes as input <productname>Postgres</productname> source files that double as
<application>genbki</application> <application>genbki</application>
input that builds tables and C header files that describe those input that builds tables and C header files that describe those
tables. tables.
</para>
<para> <para>
Related information may be found in documentation for Related information may be found in documentation for
<application>initdb</application>, <application>initdb</application>,
<application>createdb</application>, <application>createdb</application>,
and the <acronym>SQL</acronym> command <command>CREATE DATABASE</command>. and the <acronym>SQL</acronym> command <command>CREATE DATABASE</command>.
</para>
<sect1> <sect1>
<title><acronym>BKI</acronym> File Format</title> <title><acronym>BKI</acronym> File Format</title>
...@@ -44,6 +46,7 @@ description will be easier to understand if the <filename>global1.bki.source</fi ...@@ -44,6 +46,7 @@ description will be easier to understand if the <filename>global1.bki.source</fi
at hand as an example. (As explained above, this .source file isn't quite at hand as an example. (As explained above, this .source file isn't quite
a <acronym>BKI</acronym> file, but you'll be able to guess what the resulting <acronym>BKI</acronym> file would be a <acronym>BKI</acronym> file, but you'll be able to guess what the resulting <acronym>BKI</acronym> file would be
anyway). anyway).
</para>
<para> <para>
Commands are composed of a command name followed by space separated Commands are composed of a command name followed by space separated
...@@ -56,6 +59,7 @@ value. Otherwise, the characters following the <quote>$</quote> are ...@@ -56,6 +59,7 @@ value. Otherwise, the characters following the <quote>$</quote> are
interpreted as the name of a macro causing the argument to be replaced interpreted as the name of a macro causing the argument to be replaced
with the macro's value. It is an error for this macro to be with the macro's value. It is an error for this macro to be
undefined. undefined.
</para>
<para> <para>
Macros are defined using Macros are defined using
...@@ -67,10 +71,13 @@ and are undefined using ...@@ -67,10 +71,13 @@ and are undefined using
undefine macro macro_name undefine macro macro_name
</programlisting> </programlisting>
and redefined using the same syntax as define. and redefined using the same syntax as define.
</para>
<para> <para>
Lists of general commands and macro commands Lists of general commands and macro commands
follow. follow.
</para>
</sect1>
<sect1> <sect1>
<title>General Commands</title> <title>General Commands</title>
...@@ -85,6 +92,9 @@ OPEN <replaceable class="parameter">classname</replaceable> ...@@ -85,6 +92,9 @@ OPEN <replaceable class="parameter">classname</replaceable>
Open the class called Open the class called
<replaceable class="parameter">classname</replaceable> <replaceable class="parameter">classname</replaceable>
for further manipulation. for further manipulation.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
...@@ -99,6 +109,9 @@ It is an error if ...@@ -99,6 +109,9 @@ It is an error if
is not already opened. If no is not already opened. If no
<replaceable class="parameter">classname</replaceable> <replaceable class="parameter">classname</replaceable>
is given, then the currently open class is closed. is given, then the currently open class is closed.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
...@@ -107,6 +120,9 @@ PRINT ...@@ -107,6 +120,9 @@ PRINT
<listitem> <listitem>
<para> <para>
Print the currently open class. Print the currently open class.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
...@@ -123,6 +139,9 @@ for its OID. If ...@@ -123,6 +139,9 @@ for its OID. If
<replaceable class="parameter">oid_value</replaceable> <replaceable class="parameter">oid_value</replaceable>
is not <quote>0</quote>, then this value will be used as the instance's is not <quote>0</quote>, then this value will be used as the instance's
object identifier. Otherwise, it is an error. object identifier. Otherwise, it is an error.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
...@@ -131,6 +150,9 @@ INSERT (<replaceable class="parameter">value1</replaceable> <replaceable class=" ...@@ -131,6 +150,9 @@ INSERT (<replaceable class="parameter">value1</replaceable> <replaceable class="
<listitem> <listitem>
<para> <para>
As above, but the system generates a unique object identifier. As above, but the system generates a unique object identifier.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
...@@ -141,6 +163,9 @@ CREATE <replaceable class="parameter">classname</replaceable> (<replaceable clas ...@@ -141,6 +163,9 @@ CREATE <replaceable class="parameter">classname</replaceable> (<replaceable clas
Create a class named Create a class named
<replaceable class="parameter">classname</replaceable> <replaceable class="parameter">classname</replaceable>
with the attributes given in parentheses. with the attributes given in parentheses.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
...@@ -152,6 +177,9 @@ Open a class named ...@@ -152,6 +177,9 @@ Open a class named
<replaceable class="parameter">classname</replaceable> <replaceable class="parameter">classname</replaceable>
for writing but do not record its existence in the system catalogs. for writing but do not record its existence in the system catalogs.
(This is primarily to aid in bootstrapping.) (This is primarily to aid in bootstrapping.)
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
...@@ -161,6 +189,9 @@ DESTROY <replaceable class="parameter">classname</replaceable> ...@@ -161,6 +189,9 @@ DESTROY <replaceable class="parameter">classname</replaceable>
<para> <para>
Destroy the class named Destroy the class named
<replaceable class="parameter">classname</replaceable>. <replaceable class="parameter">classname</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
...@@ -182,14 +213,18 @@ etc., and the operator collections to use are ...@@ -182,14 +213,18 @@ etc., and the operator collections to use are
<replaceable class="parameter">collection_1</replaceable>, <replaceable class="parameter">collection_1</replaceable>,
<replaceable class="parameter">collection_2</replaceable> <replaceable class="parameter">collection_2</replaceable>
etc., respectively. etc., respectively.
</para>
</listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
<note> <note>
<para> <para>
This last sentence doesn't reference anything in the example. Should be changed to make sense. - Thomas 1998-08-04 This last sentence doesn't reference anything in the example. Should be changed to make sense. - Thomas 1998-08-04
</para>
</note> </note>
</sect1>
<sect1> <sect1>
<title>Macro Commands</title> <title>Macro Commands</title>
...@@ -211,6 +246,9 @@ computed from the execution ...@@ -211,6 +246,9 @@ computed from the execution
with the arguments with the arguments
<replaceable class="parameter">args</replaceable> <replaceable class="parameter">args</replaceable>
declared in a C-like manner. declared in a C-like manner.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
...@@ -223,9 +261,13 @@ Define a macro named ...@@ -223,9 +261,13 @@ Define a macro named
which has its value which has its value
read from the file called read from the file called
<replaceable class="parameter">filename</replaceable>. <replaceable class="parameter">filename</replaceable>.
</para>
</listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</para>
</sect1>
<sect1> <sect1>
<title>Debugging Commands</title> <title>Debugging Commands</title>
...@@ -234,6 +276,7 @@ read from the file called ...@@ -234,6 +276,7 @@ read from the file called
<note> <note>
<para> <para>
This section on debugging commands was commented-out in the original documentation. Thomas 1998-08-05 This section on debugging commands was commented-out in the original documentation. Thomas 1998-08-05
</para>
</note> </note>
<variablelist> <variablelist>
...@@ -244,6 +287,9 @@ r ...@@ -244,6 +287,9 @@ r
<listitem> <listitem>
<para> <para>
Randomly print the open class. Randomly print the open class.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
...@@ -252,6 +298,9 @@ m -1 ...@@ -252,6 +298,9 @@ m -1
<listitem> <listitem>
<para> <para>
Toggle display of time information. Toggle display of time information.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
...@@ -260,6 +309,9 @@ m 0 ...@@ -260,6 +309,9 @@ m 0
<listitem> <listitem>
<para> <para>
Set retrievals to now. Set retrievals to now.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
...@@ -268,6 +320,9 @@ m 1 Jan 1 01:00:00 1988 ...@@ -268,6 +320,9 @@ m 1 Jan 1 01:00:00 1988
<listitem> <listitem>
<para> <para>
Set retrievals to snapshots of the specfied time. Set retrievals to snapshots of the specfied time.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
...@@ -278,6 +333,9 @@ m 2 Jan 1 01:00:00 1988, Feb 1 01:00:00 1988 ...@@ -278,6 +333,9 @@ m 2 Jan 1 01:00:00 1988, Feb 1 01:00:00 1988
Set retrievals to ranges of the specified times. Set retrievals to ranges of the specified times.
Either time may be replaced with space Either time may be replaced with space
if an unbounded time range is desired. if an unbounded time range is desired.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
...@@ -296,6 +354,9 @@ types ...@@ -296,6 +354,9 @@ types
<replaceable class="parameter">type2</replaceable>, <replaceable class="parameter">type2</replaceable>,
etc. to the class etc. to the class
<replaceable class="parameter">classname</replaceable>. <replaceable class="parameter">classname</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
...@@ -307,6 +368,9 @@ Rename the ...@@ -307,6 +368,9 @@ Rename the
<replaceable class="parameter">oldclassname</replaceable> <replaceable class="parameter">oldclassname</replaceable>
class to class to
<replaceable class="parameter">newclassname</replaceable>. <replaceable class="parameter">newclassname</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
...@@ -323,9 +387,12 @@ attribute in the class named ...@@ -323,9 +387,12 @@ attribute in the class named
<replaceable class="parameter">classname</replaceable> <replaceable class="parameter">classname</replaceable>
to to
<replaceable class="parameter">newattname</replaceable>. <replaceable class="parameter">newattname</replaceable>.
</para>
</listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</para>
</sect1>
<sect1> <sect1>
<title>Example</title> <title>Example</title>
...@@ -344,5 +411,6 @@ insert oid=421 (int_ops) ...@@ -344,5 +411,6 @@ insert oid=421 (int_ops)
print print
close pg_opclass close pg_opclass
</programlisting> </programlisting>
</para>
</sect1>
</chapter> </chapter>
doc/src/sgml/compiler.sgml
View file @ a75f2d21
...@@ -17,6 +17,7 @@ ...@@ -17,6 +17,7 @@
Contributed by <ULink url="mailto:geek+@cmu.edu">Brian Gallew</ULink> Contributed by <ULink url="mailto:geek+@cmu.edu">Brian Gallew</ULink>
</Para> </Para>
</Note> </Note>
</para>
<Para> <Para>
Configuring gcc to use certain flags by default is a simple matter of Configuring gcc to use certain flags by default is a simple matter of
...@@ -28,6 +29,7 @@ sections, each of which is three lines long. The first line is ...@@ -28,6 +29,7 @@ sections, each of which is three lines long. The first line is
"*<Replaceable>section_name</Replaceable>:" (e.g. "*asm:"). "*<Replaceable>section_name</Replaceable>:" (e.g. "*asm:").
The second line is a list of flags, The second line is a list of flags,
and the third line is blank. and the third line is blank.
</para>
<Para> <Para>
The easiest change to make is to append The easiest change to make is to append
...@@ -64,10 +66,12 @@ box lying around, I'd have to make it look like this: ...@@ -64,10 +66,12 @@ box lying around, I'd have to make it look like this:
</ProgramListing> </ProgramListing>
This will always omit frame pointers, any will build 486-optimized This will always omit frame pointers, any will build 486-optimized
code unless -m386 is specified on the command line. code unless -m386 is specified on the command line.
</para>
<Para> <Para>
You can actually do quite a lot of customization with the specs file. You can actually do quite a lot of customization with the specs file.
Always remember, however, that these changes are global, and affect Always remember, however, that these changes are global, and affect
all users of the system. all users of the system.
</para>
</Chapter> </Chapter>
doc/src/sgml/config.sgml
View file @ a75f2d21
<chapter id="config"> <chapter id="config">
<title id="install-config">Configuration Options</title> <title id="install-config">Configuration Options</title>
<sect1> <sect1>
<title>Parameters for Configuration (<application>configure</application>)</title> <title>Parameters for Configuration (<application>configure</application>)</title>
<para> <para>
The full set of parameters available in <application>configure</application> The full set of parameters available in <application>configure</application>
can be obtained by typing can be obtained by typing
<programlisting> <programlisting>
$ ./configure --help $ ./configure --help
</programlisting> </programlisting>
</para>
<para> <para>
The following parameters may be of interest to installers: The following parameters may be of interest to installers:
<programlisting> <programlisting>
Directory and file names: Directory and file names:
--prefix=PREFIX install architecture-independent files in PREFIX --prefix=PREFIX install architecture-independent files in PREFIX
[/usr/local/pgsql] [/usr/local/pgsql]
...@@ -47,143 +47,174 @@ Features and packages: ...@@ -47,143 +47,174 @@ Features and packages:
--enable-cassert enable assertion checks (debugging) --enable-cassert enable assertion checks (debugging)
--with-CC=<replaceable>compiler</replaceable> use specific C compiler --with-CC=<replaceable>compiler</replaceable> use specific C compiler
--with-CXX=<replaceable>compiler</replaceable> use specific C++ compiler --with-CXX=<replaceable>compiler</replaceable> use specific C++ compiler
</programlisting> </programlisting>
</para>
<para> <para>
Some systems may have trouble building a specific feature of Some systems may have trouble building a specific feature of
<productname>Postgres</productname>. For example, systems with a damaged <productname>Postgres</productname>. For example, systems with a damaged
C++ compiler may need to specify <option>--without-CXX</option> to encourage C++ compiler may need to specify <option>--without-CXX</option> to encourage
the build procedure to ignore the <filename>libpq++</filename> construction. the build procedure to ignore the <filename>libpq++</filename> construction.
</para>
<sect1> </sect1>
<title>Parameters for Building (<application>make</application>)</title> <sect1>
<title>Parameters for Building (<application>make</application>)</title>
<para>
Many installation-related parameters can be set in the building <para>
stage of <productname>Postgres</productname> installation. Many installation-related parameters can be set in the building
stage of <productname>Postgres</productname> installation.
<para> </para>
In most cases, these parameters should be place in a file, <para>
<filename>Makefile.custom</filename>, intended just for that purpose. In most cases, these parameters should be place in a file,
The default distribution does not contain this optional file, so you <filename>Makefile.custom</filename>, intended just for that purpose.
will create it using a text editor of your choice. When upgrading installations, The default distribution does not contain this optional file, so you
you can simply copy your old Makefile.custom to the new installation before will create it using a text editor of your choice. When upgrading installations,
doing the build. you can simply copy your old Makefile.custom to the new installation before
doing the build.
<synopsis>
make [ <replaceable>variable</replaceable>=<replaceable class="parameter">value</replaceable> [,...] ] <synopsis>
</synopsis> make [ <replaceable>variable</replaceable>=<replaceable class="parameter">value</replaceable> [,...] ]
</synopsis>
<para> </para>
A few of the many variables which can be specified are: <para>
A few of the many variables which can be specified are:
<variablelist>
<varlistentry> <variablelist>
<term> <varlistentry>
<envar>POSTGRESDIR</envar> <term>
<envar>POSTGRESDIR</envar>
<listitem> </term>
<para> <listitem>
Top of the installation tree. <para>
Top of the installation tree.
<varlistentry> </para>
<term> </listitem>
<envar>BINDIR</envar> </varlistentry>
<listitem> <varlistentry>
<para> <term>
Location of applications and utilities. <envar>BINDIR</envar>
</term>
<varlistentry> <listitem>
<term> <para>
<envar>LIBDIR</envar> Location of applications and utilities.
</para>
<listitem> </listitem>
<para> </varlistentry>
Location of object libraries, including shared libraries.
<varlistentry>
<varlistentry> <term>
<term> <envar>LIBDIR</envar>
<envar>HEADERDIR</envar> </term>
<listitem>
<listitem> <para>
<para> Location of object libraries, including shared libraries.
Location of include files. </para>
</listitem>
<varlistentry> </varlistentry>
<term>
<envar>ODBCINST</envar> <varlistentry>
<term>
<listitem> <envar>HEADERDIR</envar>
<para> </term>
Location of installation-wide <application>psqlODBC</application> <listitem>
(<acronym>ODBC</acronym>) configuration file. <para>
Location of include files.
</variablelist> </para>
</listitem>
<para> </varlistentry>
There are other optional parameters which are not as commonly used.
Many of those listed below are appropriate when doing <varlistentry>
<application>Postgres</application> server code development. <term>
<envar>ODBCINST</envar>
<variablelist> </term>
<varlistentry> <listitem>
<term> <para>
<envar>CFLAGS</envar> Location of installation-wide <application>psqlODBC</application>
(<acronym>ODBC</acronym>) configuration file.
<listitem> </para>
<para> </listitem>
Set flags for the C compiler. </varlistentry>
Should be assigned with "+=" to retain relevant default parameters.
</variablelist>
<varlistentry> </para>
<term> <para>
YFLAGS There are other optional parameters which are not as commonly used.
Many of those listed below are appropriate when doing
<listitem> <application>Postgres</application> server code development.
<para>
Set flags for the yacc/bison parser. <option>-v</option> might be <variablelist>
used to help diagnose problems building a new parser. <varlistentry>
Should be assigned with "+=" to retain relevant default parameters. <term>
<envar>CFLAGS</envar>
<varlistentry> </term>
<term> <listitem>
<envar>USE_TCL</envar> <para>
Set flags for the C compiler.
<listitem> Should be assigned with "+=" to retain relevant default parameters.
<para> </para>
Enable Tcl interface building. </listitem>
</varlistentry>
<varlistentry>
<term> <varlistentry>
<envar>HSTYLE</envar> <term>
YFLAGS
<listitem> </term>
<para> <listitem>
DocBook <acronym>HTML</acronym> style sheets for building the <para>
documentation from scratch. Set flags for the yacc/bison parser. <option>-v</option> might be
Not used unless you are developing new documentation from the used to help diagnose problems building a new parser.
DocBook-compatible <acronym>SGML</acronym> source documents in Should be assigned with "+=" to retain relevant default parameters.
<filename>doc/src/sgml/</filename>. </para>
</listitem>
<varlistentry> </varlistentry>
<term>
<envar>PSTYLE</envar> <varlistentry>
<term>
<listitem> <envar>USE_TCL</envar>
<para> </term>
DocBook style sheets for building printed documentation from scratch. <listitem>
Not used unless you are developing new documentation from the <para>
DocBook-compatible <acronym>SGML</acronym> source documents in Enable Tcl interface building.
<filename>doc/src/sgml/</filename>. </para>
</listitem>
</variablelist> </varlistentry>
<para> <varlistentry>
Here is an example <filename>Makefile.custom</filename> for a <term>
PentiumPro Linux system: <envar>HSTYLE</envar>
</term>
<programlisting> <listitem>
<para>
DocBook <acronym>HTML</acronym> style sheets for building the
documentation from scratch.
Not used unless you are developing new documentation from the
DocBook-compatible <acronym>SGML</acronym> source documents in
<filename>doc/src/sgml/</filename>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<envar>PSTYLE</envar>
</term>
<listitem>
<para>
DocBook style sheets for building printed documentation from scratch.
Not used unless you are developing new documentation from the
DocBook-compatible <acronym>SGML</acronym> source documents in
<filename>doc/src/sgml/</filename>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
Here is an example <filename>Makefile.custom</filename> for a
PentiumPro Linux system:
<programlisting>
# Makefile.custom # Makefile.custom
# Thomas Lockhart 1998-03-01 # Thomas Lockhart 1998-03-01
...@@ -198,275 +229,297 @@ TK_LIB= -ltk ...@@ -198,275 +229,297 @@ TK_LIB= -ltk
HSTYLE= /home/tgl/SGML/db118.d/docbook/html HSTYLE= /home/tgl/SGML/db118.d/docbook/html
PSTYLE= /home/tgl/SGML/db118.d/docbook/print PSTYLE= /home/tgl/SGML/db118.d/docbook/print
</programlisting> </programlisting>
</para>
<Sect1> </sect1>
<Title>Locale Support</Title> <Sect1>
<Title>Locale Support</Title>
<Para>
<Note> <Para>
<Para> <Note>
Written by Oleg Bartunov. <Para>
See <ULink url="http://www.sai.msu.su/~megera/postgres/">Oleg's web page</ULink> Written by Oleg Bartunov.
for additional information on locale and Russian language support. See <ULink url="http://www.sai.msu.su/~megera/postgres/">Oleg's web page</ULink>
for additional information on locale and Russian language support.
</Para>
</Note> </Para>
While doing a project for a company in Moscow, Russia, </Note>
I encountered the problem that postgresql had no While doing a project for a company in Moscow, Russia,
support of national alphabets. After looking for possible workarounds I encountered the problem that postgresql had no
I decided to develop support of locale myself. support of national alphabets. After looking for possible workarounds
I'm not a C-programer but already had some experience with locale programming I decided to develop support of locale myself.
when I work with perl I'm not a C-programer but already had some experience with locale programming
(debugging) and glimpse. After several days of digging through when I work with perl
the <ProductName>Postgres</ProductName> source tree I made very minor corections to (debugging) and glimpse. After several days of digging through
src/backend/utils/adt/varlena.c and src/backend/main/main.c and got what I needed! the <ProductName>Postgres</ProductName> source tree I made very minor corections to
I did support only for src/backend/utils/adt/varlena.c and src/backend/main/main.c and got what I needed!
<envar>LC_CTYPE</envar> and <envar>LC_COLLATE</envar>, I did support only for
but later <envar>LC_MONETARY</envar> was added by others. I got many <envar>LC_CTYPE</envar> and <envar>LC_COLLATE</envar>,
messages from people about this patch so I decided to send it to developers but later <envar>LC_MONETARY</envar> was added by others. I got many
and (to my surprise) it was messages from people about this patch so I decided to send it to developers
incorporated into the <productname>Postgres</productname> distribution. and (to my surprise) it was
incorporated into the <productname>Postgres</productname> distribution.
<Para> </para>
People often complain that locale doesn't work for them. <Para>
There are several common mistakes: People often complain that locale doesn't work for them.
There are several common mistakes:
<ItemizedList>
<ListItem> <ItemizedList>
<Para> <ListItem>
Didn't properly configure postgresql before compilation. <Para>
You must run configure with --enable-locale option to enable locale support. Didn't properly configure postgresql before compilation.
Didn't setup environment correctly when starting postmaster. You must run configure with --enable-locale option to enable locale support.
You must define environment variables Didn't setup environment correctly when starting postmaster.
<envar>LC_CTYPE</envar> and <envar>LC_COLLATE</envar> You must define environment variables
before running postmaster <envar>LC_CTYPE</envar> and <envar>LC_COLLATE</envar>
because backend gets information about locale from environment. before running postmaster
I use following shell script because backend gets information about locale from environment.
(runpostgres): I use following shell script
(runpostgres):
<ProgramListing>
#!/bin/sh <ProgramListing>
#!/bin/sh
export LC_CTYPE=koi8-r
export LC_COLLATE=koi8-r export LC_CTYPE=koi8-r
postmaster -B 1024 -S -D/usr/local/pgsql/data/ -o '-Fe' export LC_COLLATE=koi8-r
</ProgramListing> postmaster -B 1024 -S -D/usr/local/pgsql/data/ -o '-Fe'
</ProgramListing>
and run it from rc.local as
and run it from rc.local as
<ProgramListing>
/bin/su - postgres -c "/home/postgres/runpostgres" <ProgramListing>
</ProgramListing> /bin/su - postgres -c "/home/postgres/runpostgres"
</ProgramListing>
</Para>
</ListItem> </Para>
<ListItem> </ListItem>
<Para> <ListItem>
Broken locale support in OS (for example, locale support in libc <Para>
under Linux several times has changed Broken locale support in OS (for example, locale support in libc
and this caused a lot of problems). Latest perl has also support of under Linux several times has changed
locale and if locale is broken <command>perl -v</command> will and this caused a lot of problems). Latest perl has also support of
complain something like: locale and if locale is broken <command>perl -v</command> will
complain something like:
<programlisting>
8:17[mira]:~/WWW/postgres>setenv LC_CTYPE not_exist <programlisting>
8:18[mira]:~/WWW/postgres>perl -v 8:17[mira]:~/WWW/postgres>setenv LC_CTYPE not_exist
perl: warning: Setting locale failed. 8:18[mira]:~/WWW/postgres>perl -v
perl: warning: Please check that your locale settings: perl: warning: Setting locale failed.
LC_ALL = (unset), perl: warning: Please check that your locale settings:
LC_CTYPE = "not_exist", LC_ALL = (unset),
LANG = (unset) LC_CTYPE = "not_exist",
are supported and installed on your system. LANG = (unset)
perl: warning: Falling back to the standard locale ("C"). are supported and installed on your system.
</programlisting> perl: warning: Falling back to the standard locale ("C").
</programlisting>
</Para>
</ListItem> </Para>
<ListItem> </ListItem>
<Para> <ListItem>
Wrong location of locale files! <Para>
Wrong location of locale files!
Possible locations include:
<filename>/usr/lib/locale</filename> Possible locations include:
(Linux, Solaris), <filename>/usr/share/locale</filename> (Linux), <filename>/usr/lib/locale</filename>
<filename>/usr/lib/nls/loc</filename> (DUX 4.0). (Linux, Solaris), <filename>/usr/share/locale</filename> (Linux),
<filename>/usr/lib/nls/loc</filename> (DUX 4.0).
Check <command>man locale</command> to find the correct location.
Under Linux I did a symbolic link between <filename>/usr/lib/locale</filename> and Check <command>man locale</command> to find the correct location.
<filename>/usr/share/locale</filename> to be sure that Under Linux I did a symbolic link between <filename>/usr/lib/locale</filename> and
the next libc will not break my locale. <filename>/usr/share/locale</filename> to be sure that
</Para> the next libc will not break my locale.
</ListItem> </Para>
</ItemizedList> </ListItem>
</ItemizedList>
<Sect2> </para>
<Title>What are the Benefits?</Title>
<Sect2>
<Para> <Title>What are the Benefits?</Title>
You can use ~* and order by operators for strings contain characters
from national alphabets. Non-english users <Para>
definitely need that. If you won't use locale stuff just undefine You can use ~* and order by operators for strings contain characters
the USE_LOCALE variable. from national alphabets. Non-english users
definitely need that. If you won't use locale stuff just undefine
<Sect2> the USE_LOCALE variable.
<Title>What are the Drawbacks?</Title> </para>
</sect2>
<Para>
There is one evident drawback of using locale - it's speed! <Sect2>
So, use locale only if you really need it. <Title>What are the Drawbacks?</Title>
<Para>
<Sect1> There is one evident drawback of using locale - it's speed!
<Title>Kerberos Authentication</Title> So, use locale only if you really need it.
</para>
<Para> </sect2>
<productname>Kerberos</productname> is an industry-standard secure authentication </sect1>
system suitable for distributed computing over a public network.
<Sect1>
<sect2> <Title>Kerberos Authentication</Title>
<title>Availability</title>
<Para>
<para> <productname>Kerberos</productname> is an industry-standard secure authentication
The system suitable for distributed computing over a public network.
<productname>Kerberos</productname> </para>
authentication system is not distributed with <Productname>Postgres</Productname>. Versions of
<productname>Kerberos</productname> <sect2>
are typically available as optional software from operating system <title>Availability</title>
vendors. In addition, a source code distribution may be obtained through
<ulink url="ftp://athena-dist.mit.edu">MIT Project Athena</ulink>. <para>
The
<note> <productname>Kerberos</productname>
<para> authentication system is not distributed with <Productname>Postgres</Productname>. Versions of
You may wish to obtain the MIT version even if your <productname>Kerberos</productname>
vendor provides a version, since some vendor ports have been are typically available as optional software from operating system
deliberately crippled or rendered non-interoperable with the MIT vendors. In addition, a source code distribution may be obtained through
version. <ulink url="ftp://athena-dist.mit.edu">MIT Project Athena</ulink>.
</note> </para>
Users located outside the United States of America and <note>
Canada are warned that distribution of the actual encryption code in <para>
<productname>Kerberos</productname> You may wish to obtain the MIT version even if your
is restricted by U. S. Government export regulations. vendor provides a version, since some vendor ports have been
deliberately crippled or rendered non-interoperable with the MIT
<para> version.
Inquiries regarding your <productname>Kerberos</productname> </para>
should be directed to your vendor or </note>
<ulink url="info-kerberos@athena.mit.edu">MIT Project Athena</ulink>. <para>
Note that <acronym>FAQL</acronym>s Users located outside the United States of America and
(Frequently-Asked Questions Lists) are periodically posted to the Canada are warned that distribution of the actual encryption code in
<ulink url="mailto:kerberos@ATHENA.MIT.EDU"><productname>Kerberos</productname> mailing list</ulink> <productname>Kerberos</productname>
(send is restricted by U. S. Government export regulations.
<ulink url="mailto:kerberos-request@ATHENA.MIT.EDU">mail to subscribe</ulink>), </para>
and <para>
<ulink url="news:comp.protocols.kerberos">USENET news group</ulink>. Inquiries regarding your <productname>Kerberos</productname>
should be directed to your vendor or
<sect2> <ulink url="info-kerberos@athena.mit.edu">MIT Project Athena</ulink>.
<title>Installation</title> Note that <acronym>FAQL</acronym>s
(Frequently-Asked Questions Lists) are periodically posted to the
<para> <ulink url="mailto:kerberos@ATHENA.MIT.EDU"><productname>Kerberos</productname> mailing list</ulink>
Installation of (send
<productname>Kerberos</productname> <ulink url="mailto:kerberos-request@ATHENA.MIT.EDU">mail to subscribe</ulink>),
itself is covered in detail in the and
<citetitle>Kerberos Installation Notes</citetitle> . <ulink url="news:comp.protocols.kerberos">USENET news group</ulink>.
Make sure that the server key file (the <filename>srvtab</filename> </para>
or <filename>keytab</filename>) </sect2>
is somehow readable by the <productname>Postgres</productname> account.
<sect2>
<para> <title>Installation</title>
<Productname>Postgres</Productname> and its clients can be compiled to use
either Version 4 or Version 5 of the MIT <para>
<productname>Kerberos</productname> Installation of
protocols by setting the <productname>Kerberos</productname>
<envar>KRBVERS</envar> itself is covered in detail in the
variable in the file <filename>src/Makefile.global</filename> to the <citetitle>Kerberos Installation Notes</citetitle> .
appropriate value. You can also change the location where Make sure that the server key file (the <filename>srvtab</filename>
<Productname>Postgres</Productname> or <filename>keytab</filename>)
expects to find the associated libraries, header files and its own is somehow readable by the <productname>Postgres</productname> account.
server key file. </para>
<para>
<para> <Productname>Postgres</Productname> and its clients can be compiled to use
After compilation is complete, <Productname>Postgres</Productname> either Version 4 or Version 5 of the MIT
must be registered as a <productname>Kerberos</productname> <productname>Kerberos</productname>
service. See the protocols by setting the
<citetitle>Kerberos Operations Notes</citetitle> <envar>KRBVERS</envar>
and related manual pages for more details on registering services. variable in the file <filename>src/Makefile.global</filename> to the
appropriate value. You can also change the location where
<sect2> <Productname>Postgres</Productname>
<title>Operation</title> expects to find the associated libraries, header files and its own
server key file.
<para> </para>
After initial installation, <Productname>Postgres</Productname> <para>
should operate in all ways as a normal After compilation is complete, <Productname>Postgres</Productname>
<productname>Kerberos</productname> must be registered as a <productname>Kerberos</productname>
service. For details on the use of authentication, see the service. See the
<citetitle>PostgreSQL User's Guide</citetitle> reference sections <citetitle>Kerberos Operations Notes</citetitle>
for <application>postmaster</application> and related manual pages for more details on registering services.
and <application>psql</application>. </para>
</sect2>
<para>
In the <sect2>
<productname>Kerberos</productname> <title>Operation</title>
Version 5 hooks, the following assumptions are made about user
and service naming: <para>
After initial installation, <Productname>Postgres</Productname>
<itemizedlist> should operate in all ways as a normal
<listitem> <productname>Kerberos</productname>
<para> service. For details on the use of authentication, see the
User principal names (anames) are assumed to <citetitle>PostgreSQL User's Guide</citetitle> reference sections
contain the actual Unix/<Productname>Postgres</Productname> user name for <application>postmaster</application>
in the first component. and <application>psql</application>.
</para>
<listitem> <para>
<para> In the
The <Productname>Postgres</Productname> service is assumed to be have two components, <productname>Kerberos</productname>
the service name and a hostname, canonicalized as in Version 4 (i.e., with all domain Version 5 hooks, the following assumptions are made about user
suffixes removed). and service naming:
</itemizedlist> <itemizedlist>
<listitem>
<para> <para>
<table tocentry="1"> User principal names (anames) are assumed to
<title>Kerberos Parameter Examples</title> contain the actual Unix/<Productname>Postgres</Productname> user name
<titleabbrev>Kerberos</titleabbrev> in the first component.
</para>
<tgroup cols="2"> </listitem>
<thead> <listitem>
<row> <para>
<entry> The <Productname>Postgres</Productname> service is assumed to be have two components,
Parameter the service name and a hostname, canonicalized as in Version 4 (i.e., with all domain
</entry> suffixes removed).
<entry> </para>
Example </listitem>
</entry>
</itemizedlist>
<tbody> </para>
<row> <para>
<entry> <table tocentry="1">
user <title>Kerberos Parameter Examples</title>
</entry> <titleabbrev>Kerberos</titleabbrev>
<entry>
frew@S2K.ORG <tgroup cols="2">
</entry> <thead>
<row>
<row> <entry>
<entry> Parameter
user </entry>
</entry> <entry>
<entry> Example
aoki/HOST=miyu.S2K.Berkeley.EDU@S2K.ORG </entry>
</entry> </row>
</thead>
<row> <tbody>
<entry> <row>
host <entry>
</entry> user
<entry> </entry>
postgres_dbms/ucbvax@S2K.ORG <entry>
</entry> frew@S2K.ORG
</tbody> </entry>
</tgroup> </row>
</table> <row>
<entry>
<para> user
Support for Version 4 will disappear sometime after the production </entry>
release of Version 5 by MIT. <entry>
aoki/HOST=miyu.S2K.Berkeley.EDU@S2K.ORG
</entry>
</row>
<row>
<entry>
host
</entry>
<entry>
postgres_dbms/ucbvax@S2K.ORG
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
Support for Version 4 will disappear sometime after the production
release of Version 5 by MIT.
</para>
</sect2>
</sect1>
</chapter>
doc/src/sgml/current.sgml
View file @ a75f2d21
...@@ -24,21 +24,28 @@ Here is a brief, incomplete summary: ...@@ -24,21 +24,28 @@ Here is a brief, incomplete summary:
Views and rules are now functional thanks to extensive new code in the Views and rules are now functional thanks to extensive new code in the
rewrite rules system from Jan Wieck. He also wrote a chapter on it rewrite rules system from Jan Wieck. He also wrote a chapter on it
for the <citetitle>Programmer's Guide</citetitle>. for the <citetitle>Programmer's Guide</citetitle>.
</para>
</listitem>
<listitem> <listitem>
<para> <para>
Jan also contributed a second procedural language, PL/pgSQL, to go with the Jan also contributed a second procedural language, PL/pgSQL, to go with the
original PL/pgTCL procedural language he contributed last release. original PL/pgTCL procedural language he contributed last release.
</para>
</listitem>
<listitem> <listitem>
<para> <para>
We have optional multiple-byte character set support from Tatsuo Iishi We have optional multiple-byte character set support from Tatsuo Iishi
to complement our existing locale support. to complement our existing locale support.
</para>
</listitem>
<listitem> <listitem>
<para> <para>
Client/server communications has been cleaned up, with better support for Client/server communications has been cleaned up, with better support for
asynchronous messages and interrupts thanks to Tom Lane. asynchronous messages and interrupts thanks to Tom Lane.
</para>
</listitem>
<listitem> <listitem>
<para> <para>
...@@ -48,6 +55,8 @@ with target columns. This uses a generic mechanism which supports ...@@ -48,6 +55,8 @@ with target columns. This uses a generic mechanism which supports
the type extensibility features of <productname>Postgres</productname>. the type extensibility features of <productname>Postgres</productname>.
There is a new chapter in the <citetitle>User's Guide</citetitle> There is a new chapter in the <citetitle>User's Guide</citetitle>
which covers this topic. which covers this topic.
</para>
</listitem>
<listitem> <listitem>
<para> <para>
...@@ -58,20 +67,26 @@ type available on some platforms. See the chapter on data types ...@@ -58,20 +67,26 @@ type available on some platforms. See the chapter on data types
in the <citetitle>User's Guide</citetitle> for details. in the <citetitle>User's Guide</citetitle> for details.
A fourth type, <type>serial</type>, is now supported by the parser as an A fourth type, <type>serial</type>, is now supported by the parser as an
amalgam of the <type>int4</type> type, a sequence, and a unique index. amalgam of the <type>int4</type> type, a sequence, and a unique index.
</para>
</listitem>
<listitem> <listitem>
<para> <para>
Several more <acronym>SQL92</acronym>-compatible syntax features have been Several more <acronym>SQL92</acronym>-compatible syntax features have been
added, including <command>INSERT DEFAULT VALUES</command> added, including <command>INSERT DEFAULT VALUES</command>
</para>
</listitem>
<listitem> <listitem>
<para> <para>
The automatic configuration and installation system has received some The automatic configuration and installation system has received some
attention, and should be more robust for more platforms than it has ever attention, and should be more robust for more platforms than it has ever
been. been.
</para>
</listitem>
</itemizedlist> </itemizedlist>
</para>
<sect2> <sect2>
<title>Migration to v6.4</title> <title>Migration to v6.4</title>
...@@ -81,8 +96,8 @@ A dump/restore using <application>pg_dump</application> ...@@ -81,8 +96,8 @@ A dump/restore using <application>pg_dump</application>
or <application>pg_dumpall</application> or <application>pg_dumpall</application>
is required for those wishing to migrate data from any is required for those wishing to migrate data from any
previous release of <productname>Postgres</productname>. previous release of <productname>Postgres</productname>.
</para>
</sect2>
<sect2> <sect2>
<title>Detailed Change List</title> <title>Detailed Change List</title>
...@@ -282,6 +297,6 @@ configure uses supplied install-sh if no install script found(Tom) ...@@ -282,6 +297,6 @@ configure uses supplied install-sh if no install script found(Tom)
new Makefile.shlib for shared library configuration(Tom) new Makefile.shlib for shared library configuration(Tom)
</programlisting> </programlisting>
</Para> </Para>
</sect2>
</Sect1> </Sect1>
doc/src/sgml/dfunc.sgml
View file @ a75f2d21
...@@ -33,9 +33,11 @@ mechanism. On the other hand, the object file must be ...@@ -33,9 +33,11 @@ mechanism. On the other hand, the object file must be
postprocessed a bit before it can be loaded into <ProductName>Postgres</ProductName>. We postprocessed a bit before it can be loaded into <ProductName>Postgres</ProductName>. We
hope that the large increase in speed and reliability will hope that the large increase in speed and reliability will
make up for the slight decrease in convenience. make up for the slight decrease in convenience.
<Para> </para>
</Tip> </Tip>
You should expect to read (and reread, and re-reread) the </para>
<para>
You should expect to read (and reread, and re-reread) the
manual pages for the C compiler, cc(1), and the link manual pages for the C compiler, cc(1), and the link
editor, ld(1), if you have specific questions. In editor, ld(1), if you have specific questions. In
addition, the regression test suites in the directory addition, the regression test suites in the directory
...@@ -120,6 +122,7 @@ The GNU C compiler usually does not provide the special ...@@ -120,6 +122,7 @@ The GNU C compiler usually does not provide the special
</Para> </Para>
</ListItem> </ListItem>
</ItemizedList> </ItemizedList>
</para>
<Sect1> <Sect1>
<Title><Acronym>ULTRIX</Acronym></Title> <Title><Acronym>ULTRIX</Acronym></Title>
......
doc/src/sgml/docguide.sgml
View file @ a75f2d21
<!-- <!--
$Header: /cvsroot/pgsql/doc/src/sgml/docguide.sgml,v 1.12 1998/12/18 16:17:29 thomas Exp $ $Header: /cvsroot/pgsql/doc/src/sgml/docguide.sgml,v 1.13 1998/12/29 02:24:14 thomas Exp $
Documentation Guide Documentation Guide
Thomas Lockhart Thomas Lockhart
$Log: docguide.sgml,v $ $Log: docguide.sgml,v $
Revision 1.13 1998/12/29 02:24:14 thomas
Clean up to ensure tag completion as required by the newest versions
of Norm's Modular Style Sheets and jade/docbook.
From Vince Vielhaber <vev@michvhf.com>.
Revision 1.12 1998/12/18 16:17:29 thomas Revision 1.12 1998/12/18 16:17:29 thomas
Include more details on editing with Emacs. Include more details on editing with Emacs.
Remove mention of the old "migration" flat files. Remove mention of the old "migration" flat files.
...@@ -59,6 +64,7 @@ system, language, and interfaces. ...@@ -59,6 +64,7 @@ system, language, and interfaces.
It should be able to answer It should be able to answer
common questions and to allow a user to find those answers on his own common questions and to allow a user to find those answers on his own
without resorting to mailing list support. without resorting to mailing list support.
</para>
<sect1> <sect1>
<title>Documentation Roadmap</title> <title>Documentation Roadmap</title>
...@@ -81,6 +87,7 @@ Hardcopy, for in-depth reading and reference. ...@@ -81,6 +87,7 @@ Hardcopy, for in-depth reading and reference.
<acronym>man pages</acronym>, for quick reference. <acronym>man pages</acronym>, for quick reference.
</para></listitem> </para></listitem>
</itemizedlist> </itemizedlist>
</para>
<para> <para>
<table tocentry="1"> <table tocentry="1">
...@@ -115,11 +122,14 @@ Description ...@@ -115,11 +122,14 @@ Description
</tbody> </tbody>
</tgroup> </tgroup>
</table> </table>
</para>
<para> <para>
There are man pages available for installation, as well as a large number There are man pages available for installation, as well as a large number
of plain-text README-type files throughout the <productname>Postgres</productname> of plain-text README-type files throughout the <productname>Postgres</productname>
source tree. source tree.
</para>
</sect1>
<sect1> <sect1>
<title>The Documentation Project</title> <title>The Documentation Project</title>
...@@ -131,6 +141,7 @@ formats. These are available as part of the standard ...@@ -131,6 +141,7 @@ formats. These are available as part of the standard
<productname>Postgres</productname> installation. We discuss here <productname>Postgres</productname> installation. We discuss here
working with the documentation sources and generating documentation working with the documentation sources and generating documentation
packages. packages.
</para>
<para> <para>
The purpose of <productname>DocBook</productname> <acronym>SGML</acronym> The purpose of <productname>DocBook</productname> <acronym>SGML</acronym>
...@@ -141,6 +152,7 @@ have a document style define how that content is rendered into a ...@@ -141,6 +152,7 @@ have a document style define how that content is rendered into a
final form (e.g. using Norm Walsh's final form (e.g. using Norm Walsh's
<productname>Modular Style Sheets</productname>).</para> <productname>Modular Style Sheets</productname>).</para>
<para> <para>
See <ulink url="http://nis-www.lanl.gov/~rosalia/mydocs/docbook-intro.html"> See <ulink url="http://nis-www.lanl.gov/~rosalia/mydocs/docbook-intro.html">
Introduction to DocBook</ulink> for a nice "quickstart" summary of Introduction to DocBook</ulink> for a nice "quickstart" summary of
...@@ -148,6 +160,7 @@ DocBook features. ...@@ -148,6 +160,7 @@ DocBook features.
<ulink url="http://www.ora.com/homepages/dtdparse/docbook/3.0/"> DocBook Elements</ulink> <ulink url="http://www.ora.com/homepages/dtdparse/docbook/3.0/"> DocBook Elements</ulink>
provides a powerful cross-reference for features of provides a powerful cross-reference for features of
<productname>DocBook</productname>. <productname>DocBook</productname>.
</para>
<para> <para>
This documentation set is constructed using several tools, including This documentation set is constructed using several tools, including
...@@ -155,6 +168,7 @@ James Clark's ...@@ -155,6 +168,7 @@ James Clark's
<ulink url="http://www.jclark.com/jade/"> <productname>jade</productname></ulink> <ulink url="http://www.jclark.com/jade/"> <productname>jade</productname></ulink>
and Norm Walsh's and Norm Walsh's
<ulink url="http://www.berkshire.net/~norm/docbook/dsssl">Modular DocBook Stylesheets</ulink>. <ulink url="http://www.berkshire.net/~norm/docbook/dsssl">Modular DocBook Stylesheets</ulink>.
</para>
<para> <para>
Currently, hardcopy is produced by importing <firstterm>Rich Text Currently, hardcopy is produced by importing <firstterm>Rich Text
...@@ -163,6 +177,7 @@ Format</firstterm> (<acronym>RTF</acronym>) output from ...@@ -163,6 +177,7 @@ Format</firstterm> (<acronym>RTF</acronym>) output from
<productname>ApplixWare</productname> for minor formatting fixups then <productname>ApplixWare</productname> for minor formatting fixups then
exporting as a Postscript file.</para> exporting as a Postscript file.</para>
<para> <para>
<ulink url="http://sunsite.unc.edu/pub/packages/TeX/systems/unix/"> <ulink url="http://sunsite.unc.edu/pub/packages/TeX/systems/unix/">
<productname>TeX</productname></ulink> is a supported format for <productname>TeX</productname></ulink> is a supported format for
...@@ -172,6 +187,8 @@ fixes before committing to hardcopy and generally inadequate table ...@@ -172,6 +187,8 @@ fixes before committing to hardcopy and generally inadequate table
support in the <productname>TeX</productname> support in the <productname>TeX</productname>
stylesheets.</para> stylesheets.</para>
</sect1>
<sect1> <sect1>
<title>Documentation Sources</title> <title>Documentation Sources</title>
...@@ -183,6 +200,7 @@ most new <productname>Postgres</productname> documentation will be written using ...@@ -183,6 +200,7 @@ most new <productname>Postgres</productname> documentation will be written using
<ulink url="http://www.ora.com/davenport/"> <productname>DocBook</productname></ulink> <ulink url="http://www.ora.com/davenport/"> <productname>DocBook</productname></ulink>
<firstterm>Document Type Definition</firstterm> (<acronym>DTD</acronym>). <firstterm>Document Type Definition</firstterm> (<acronym>DTD</acronym>).
Much of the existing documentation has been or will be converted to <acronym>SGML</acronym>. Much of the existing documentation has been or will be converted to <acronym>SGML</acronym>.
</para>
<para> <para>
The purpose of <acronym>SGML</acronym> is to allow an author to The purpose of <acronym>SGML</acronym> is to allow an author to
...@@ -190,6 +208,7 @@ specify the structure and content of a document (e.g. using the ...@@ -190,6 +208,7 @@ specify the structure and content of a document (e.g. using the
<productname>DocBook</productname> <acronym>DTD</acronym>), and to <productname>DocBook</productname> <acronym>DTD</acronym>), and to
have the document style define how that content is rendered into a have the document style define how that content is rendered into a
final form (e.g. using Norm Walsh's stylesheets). final form (e.g. using Norm Walsh's stylesheets).
</para>
<para> <para>
Documentation has accumulated from several sources. As we integrate Documentation has accumulated from several sources. As we integrate
...@@ -198,6 +217,7 @@ the older versions will become obsolete and will be removed from the ...@@ -198,6 +217,7 @@ the older versions will become obsolete and will be removed from the
distribution. However, this will not happen immediately, and will not distribution. However, this will not happen immediately, and will not
happen to all documents at the same time. To ease the transition, and happen to all documents at the same time. To ease the transition, and
to help guide developers and writers, we have defined a transition roadmap. to help guide developers and writers, we have defined a transition roadmap.
</para>
<para> <para>
Here is the documentation plan for v6.5: Here is the documentation plan for v6.5:
...@@ -206,30 +226,41 @@ Here is the documentation plan for v6.5: ...@@ -206,30 +226,41 @@ Here is the documentation plan for v6.5:
<listitem> <listitem>
<para> <para>
Start compiling index information for the User's and Administrator's Guides. Start compiling index information for the User's and Administrator's Guides.
</para>
</listitem>
<listitem> <listitem>
<para> <para>
Write more sections for the User's Guide covering areas outside the reference pages. Write more sections for the User's Guide covering areas outside the reference pages.
This would include introductory information and suggestions for approaches to typical This would include introductory information and suggestions for approaches to typical
design problems. design problems.
</para>
</listitem>
<listitem> <listitem>
<para> <para>
Merge information in the existing man pages into the reference pages and User's Guide. Merge information in the existing man pages into the reference pages and User's Guide.
Condense the man pages down to reminder information, with references into the Condense the man pages down to reminder information, with references into the
primary doc set. primary doc set.
</para>
</listitem>
<listitem> <listitem>
<para> <para>
Convert the new sgml reference pages to new man pages, replacing the existing man pages. Convert the new sgml reference pages to new man pages, replacing the existing man pages.
</para>
</listitem>
<listitem> <listitem>
<para> <para>
Convert all source graphics to CGM format files for portability. Currently we mostly have Convert all source graphics to CGM format files for portability. Currently we mostly have
Applix Graphics sources from which we can generate .gif output. One graphic is only Applix Graphics sources from which we can generate .gif output. One graphic is only
available in .gif and .ps, and should be redrawn or removed. available in .gif and .ps, and should be redrawn or removed.
</para>
</listitem>
</itemizedlist> </itemizedlist>
</para>
<sect2> <sect2>
<title>Document Structure</title> <title>Document Structure</title>
...@@ -304,12 +335,14 @@ The Administrator's Guide. Include installation and release notes. ...@@ -304,12 +335,14 @@ The Administrator's Guide. Include installation and release notes.
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</para>
<!-- <!--
Disable for the hardcopy production release. Disable for the hardcopy production release.
Too much tabular info and not very helpful in hardcopy. Too much tabular info and not very helpful in hardcopy.
- thomas 1998-10-27 - thomas 1998-10-27
--> -->
</sect2>
<sect2> <sect2>
<title>Documentation Files</title> <title>Documentation Files</title>
...@@ -482,6 +515,8 @@ Status ...@@ -482,6 +515,8 @@ Status
</tbody> </tbody>
</tgroup> </tgroup>
</table> </table>
</para>
</sect2>
<sect2> <sect2>
<title>Document Conversion</title> <title>Document Conversion</title>
...@@ -719,7 +754,8 @@ Status ...@@ -719,7 +754,8 @@ Status
</tbody> </tbody>
</tgroup> </tgroup>
</table> </table>
</para>
</sect2>
<sect2> <sect2>
<title>Styles and Conventions</title> <title>Styles and Conventions</title>
...@@ -766,6 +802,7 @@ be included below. ...@@ -766,6 +802,7 @@ be included below.
</table> </table>
</para> </para>
--> -->
</sect2>
<sect2> <sect2>
<title>SGML Authoring Tools</title> <title>SGML Authoring Tools</title>
...@@ -774,12 +811,14 @@ be included below. ...@@ -774,12 +811,14 @@ be included below.
The current <acronym>Postgres</acronym> documentation set was written using The current <acronym>Postgres</acronym> documentation set was written using
a plain text editor (or emacs/psgml; see below) with the content marked up using a plain text editor (or emacs/psgml; see below) with the content marked up using
<acronym>SGML</acronym> DocBook tags. <acronym>SGML</acronym> DocBook tags.
</para>
<para> <para>
<acronym>SGML</acronym> and <productname>DocBook</productname> do not suffer <acronym>SGML</acronym> and <productname>DocBook</productname> do not suffer
from an oversupply of open-source authoring tools. The most common toolset is from an oversupply of open-source authoring tools. The most common toolset is
the emacs/xemacs editing package with the psgml feature extension. the emacs/xemacs editing package with the psgml feature extension.
On some systems (e.g. RedHat Linux) these tools are provided in a typical full installation. On some systems (e.g. RedHat Linux) these tools are provided in a typical full installation.
</para>
<sect3> <sect3>
<title>emacs/psgml</title> <title>emacs/psgml</title>
...@@ -789,6 +828,7 @@ On some systems (e.g. RedHat Linux) these tools are provided in a typical full i ...@@ -789,6 +828,7 @@ On some systems (e.g. RedHat Linux) these tools are provided in a typical full i
an <acronym>SGML</acronym> <firstterm>major mode</firstterm>. When properly configured, an <acronym>SGML</acronym> <firstterm>major mode</firstterm>. When properly configured,
this will allow you to use <application>emacs</application> to insert tags and this will allow you to use <application>emacs</application> to insert tags and
check markup consistancy. check markup consistancy.
</para>
<para> <para>
Put the following in your <filename>~/.emacs</filename> environment file: Put the following in your <filename>~/.emacs</filename> environment file:
...@@ -832,13 +872,15 @@ sgml-exposed-tags:nil ...@@ -832,13 +872,15 @@ sgml-exposed-tags:nil
sgml-local-catalogs:"/usr/lib/sgml/catalog" sgml-local-catalogs:"/usr/lib/sgml/catalog"
sgml-local-ecat-files:nil sgml-local-ecat-files:nil
End: End:
--<sgmltag> --</sgmltag>
</programlisting> </programlisting>
</para>
<para> <para>
The <productname>Postgres</productname> distribution includes a The <productname>Postgres</productname> distribution includes a
parsed DTD definitions file <filename>reference.ced</filename>. parsed DTD definitions file <filename>reference.ced</filename>.
You may find that You may find that
</para>
<para> <para>
When using <application>emacs</application>/psgml, a comfortable way of working with When using <application>emacs</application>/psgml, a comfortable way of working with
...@@ -853,6 +895,7 @@ a DocBook document by making the first line look like this: ...@@ -853,6 +895,7 @@ a DocBook document by making the first line look like this:
This means that anything and everything that reads <acronym>SGML</acronym> will get it This means that anything and everything that reads <acronym>SGML</acronym> will get it
right, and I can verify the document with "nsgmls -s docguide.sgml". right, and I can verify the document with "nsgmls -s docguide.sgml".
</para>
</sect3> </sect3>
</sect2> </sect2>
...@@ -893,6 +936,7 @@ On many systems, these stylesheets will be found in packages installed in ...@@ -893,6 +936,7 @@ On many systems, these stylesheets will be found in packages installed in
<filename>/usr/share/lib/sgml/</filename>, <filename>/usr/share/lib/sgml/</filename>,
or or
<filename>/usr/local/lib/sgml/</filename>. <filename>/usr/local/lib/sgml/</filename>.
</para>
<para> <para>
<acronym>HTML</acronym> documentation packages can be generated from the <acronym>SGML</acronym> source by <acronym>HTML</acronym> documentation packages can be generated from the <acronym>SGML</acronym> source by
...@@ -926,6 +970,7 @@ The hardcopy Postscript documentation is generated by converting the ...@@ -926,6 +970,7 @@ The hardcopy Postscript documentation is generated by converting the
importing into <productname>ApplixWare-4.4.1</productname>. importing into <productname>ApplixWare-4.4.1</productname>.
After a little cleanup (see the following After a little cleanup (see the following
section) the output is "printed" to a postscript file. section) the output is "printed" to a postscript file.
</para>
<para> <para>
Some figures were redrawn to avoid having bitmap Some figures were redrawn to avoid having bitmap
...@@ -1066,6 +1111,7 @@ We understand that there are some other packaged distributions for ...@@ -1066,6 +1111,7 @@ We understand that there are some other packaged distributions for
these tools. <productname>FreeBSD</productname> seems to have them these tools. <productname>FreeBSD</productname> seems to have them
available. Please report package status to the docs mailing list and available. Please report package status to the docs mailing list and
we will include that information here. we will include that information here.
</para>
<sect2> <sect2>
<title><acronym>RPM</acronym> installation on <title><acronym>RPM</acronym> installation on
...@@ -1086,6 +1132,7 @@ This is a brief run-through of the process of obtaining and ...@@ -1086,6 +1132,7 @@ This is a brief run-through of the process of obtaining and
installing the software you'll need to edit DocBook source with Emacs installing the software you'll need to edit DocBook source with Emacs
and process it with Norman Walsh's DSSSL style sheets to create <acronym>HTML</acronym> and process it with Norman Walsh's DSSSL style sheets to create <acronym>HTML</acronym>
and <acronym>RTF</acronym>. and <acronym>RTF</acronym>.
</para>
<para> <para>
These instructions do not cover new <application>jade</application>/DocBook These instructions do not cover new <application>jade</application>/DocBook
...@@ -1093,6 +1140,7 @@ support in the ...@@ -1093,6 +1140,7 @@ support in the
<ulink url="http://www.sgmltools.org/"><productname>sgml-tools</productname></ulink> <ulink url="http://www.sgmltools.org/"><productname>sgml-tools</productname></ulink>
package. The authors have not tried this package since it adopted DocBook, package. The authors have not tried this package since it adopted DocBook,
but it is almost certainly a good candidate for use. but it is almost certainly a good candidate for use.
</para>
<sect3><title>Prerequisites</title> <sect3><title>Prerequisites</title>
...@@ -1150,12 +1198,12 @@ Steve Pepper's Whirlwind Guide</ulink></para></listitem> ...@@ -1150,12 +1198,12 @@ Steve Pepper's Whirlwind Guide</ulink></para></listitem>
<listitem><para><ulink url="http://www.sil.org/sgml/publicSW.html"> <listitem><para><ulink url="http://www.sil.org/sgml/publicSW.html">
Robin Cover's database of <acronym>SGML</acronym> software</ulink></para></listitem> Robin Cover's database of <acronym>SGML</acronym> software</ulink></para></listitem>
</itemizedlist> </itemizedlist>
</para>
</sect3> </sect3>
<sect3> <sect3>
<title>Installing Jade</title> <title>Installing Jade</title>
<para>
<procedure> <procedure>
<title>Installing Jade</title> <title>Installing Jade</title>
...@@ -1164,6 +1212,8 @@ Robin Cover's database of <acronym>SGML</acronym> software</ulink></para></listi ...@@ -1164,6 +1212,8 @@ Robin Cover's database of <acronym>SGML</acronym> software</ulink></para></listi
<para> <para>
Read the installation instructions at the above listed Read the installation instructions at the above listed
URL. URL.
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
...@@ -1173,6 +1223,7 @@ this will be something like ...@@ -1173,6 +1223,7 @@ this will be something like
unzip -aU jade1_1.zip unzip -aU jade1_1.zip
</programlisting> </programlisting>
</para> </para>
</step>
<step performance="required"> <step performance="required">
<para><productname>Jade</productname> is not built using <para><productname>Jade</productname> is not built using
...@@ -1215,21 +1266,23 @@ doesn't need the above settings for the math library and the ...@@ -1215,21 +1266,23 @@ doesn't need the above settings for the math library and the
<command>ranlib</command> command, leave them as they are in the <command>ranlib</command> command, leave them as they are in the
<filename>Makefile</filename>. <filename>Makefile</filename>.
</para> </para>
</step>
<step performance="required"> <step performance="required">
<para>Type <command>make</command> to build Jade and the various <para>Type <command>make</command> to build Jade and the various
<productname>SP</productname> tools.</para> <productname>SP</productname> tools.</para>
</step>
<step performance="required"> <step performance="required">
<para>Once the software is built, <command>make install</command> will <para>Once the software is built, <command>make install</command> will
do the obvious.</para> do the obvious.</para>
</step>
</procedure> </procedure>
</sect3>
<sect3> <sect3>
<title>Installing the <productname>DocBook</productname> <acronym>DTD</acronym> Kit</title> <title>Installing the <productname>DocBook</productname> <acronym>DTD</acronym> Kit</title>
<para>
<procedure> <procedure>
<title>Installing the <productname>DocBook</productname> <acronym>DTD</acronym> Kit</title> <title>Installing the <productname>DocBook</productname> <acronym>DTD</acronym> Kit</title>
...@@ -1255,6 +1308,8 @@ the former, by giving it the single line of content: ...@@ -1255,6 +1308,8 @@ the former, by giving it the single line of content:
<programlisting> <programlisting>
CATALOG /usr/local/share/sgml/CATALOG CATALOG /usr/local/share/sgml/CATALOG
</programlisting> </programlisting>
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
...@@ -1274,6 +1329,8 @@ PUBLIC "-//Davenport//ELEMENTS DocBook Information Pool V3.0//EN" dbpool.mod ...@@ -1274,6 +1329,8 @@ PUBLIC "-//Davenport//ELEMENTS DocBook Information Pool V3.0//EN" dbpool.mod
PUBLIC "-//Davenport//ELEMENTS DocBook Document Hierarchy V3.0//EN" dbhier.mod PUBLIC "-//Davenport//ELEMENTS DocBook Document Hierarchy V3.0//EN" dbhier.mod
PUBLIC "-//Davenport//ENTITIES DocBook Additional General Entities V3.0//EN" dbgenent.mod PUBLIC "-//Davenport//ENTITIES DocBook Additional General Entities V3.0//EN" dbgenent.mod
</programlisting> </programlisting>
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
...@@ -1296,12 +1353,13 @@ we've placed the <acronym>ISO</acronym> entity files in a subdirectory ...@@ -1296,12 +1353,13 @@ we've placed the <acronym>ISO</acronym> entity files in a subdirectory
named <filename>ISO</filename>. Again, proper catalog entries should named <filename>ISO</filename>. Again, proper catalog entries should
accompany the entity kit you fetch. accompany the entity kit you fetch.
</para> </para>
</step>
</procedure> </procedure>
</sect3>
<sect3> <sect3>
<title>Installing Norman Walsh's <acronym>DSSSL</acronym> Style Sheets</title> <title>Installing Norman Walsh's <acronym>DSSSL</acronym> Style Sheets</title>
<para>
<procedure> <procedure>
<title>Installing Norman Walsh's <acronym>DSSSL</acronym> Style Sheets</title> <title>Installing Norman Walsh's <acronym>DSSSL</acronym> Style Sheets</title>
...@@ -1309,6 +1367,7 @@ accompany the entity kit you fetch. ...@@ -1309,6 +1367,7 @@ accompany the entity kit you fetch.
<step performance="required"> <step performance="required">
<para>Read the installation instructions at the above listed <para>Read the installation instructions at the above listed
URL.</para> URL.</para>
</step>
<step performance="required"> <step performance="required">
<para>To install Norman's style sheets, simply unzip the distribution <para>To install Norman's style sheets, simply unzip the distribution
...@@ -1320,11 +1379,13 @@ The command will be something like ...@@ -1320,11 +1379,13 @@ The command will be something like
unzip -aU db119.zip unzip -aU db119.zip
</programlisting> </programlisting>
</para> </para>
</step>
<step performance="required"> <step performance="required">
<para>One way to test the installation is to build the <para>One way to test the installation is to build the
<acronym>HTML</acronym> and <acronym>RTF</acronym> forms of the <acronym>HTML</acronym> and <acronym>RTF</acronym> forms of the
<citetitle><productname>PostgreSQL</productname> User's Guide</citetitle>. <citetitle><productname>PostgreSQL</productname> User's Guide</citetitle>.
</para>
<substeps> <substeps>
...@@ -1336,9 +1397,12 @@ directory, <filename>doc/src/sgml</filename>, and say ...@@ -1336,9 +1397,12 @@ directory, <filename>doc/src/sgml</filename>, and say
<programlisting> <programlisting>
jade -t sgml -d /usr/local/share/docbook/html/docbook.dsl -D ../graphics postgres.sgml jade -t sgml -d /usr/local/share/docbook/html/docbook.dsl -D ../graphics postgres.sgml
</programlisting> </programlisting>
</para>
<para> <para>
<filename>book1.htm</filename> is the top level node of the output.. <filename>book1.htm</filename> is the top level node of the output..
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
...@@ -1347,14 +1411,17 @@ into your favorite word processing system and printing, type: ...@@ -1347,14 +1411,17 @@ into your favorite word processing system and printing, type:
<programlisting> <programlisting>
jade -t rtf -d /usr/local/share/docbook/print/docbook.dsl -D ../graphics postgres.sgml jade -t rtf -d /usr/local/share/docbook/print/docbook.dsl -D ../graphics postgres.sgml
</programlisting> </programlisting>
</para>
</step>
</substeps> </substeps>
</step>
</procedure> </procedure>
</sect3>
<sect3> <sect3>
<title>Installing <productname>PSGML</productname></title> <title>Installing <productname>PSGML</productname></title>
<para>
<procedure> <procedure>
<title>Installing <productname>PSGML</productname></title> <title>Installing <productname>PSGML</productname></title>
...@@ -1362,10 +1429,13 @@ jade -t rtf -d /usr/local/share/docbook/print/docbook.dsl -D ../graphics postgre ...@@ -1362,10 +1429,13 @@ jade -t rtf -d /usr/local/share/docbook/print/docbook.dsl -D ../graphics postgre
<step performance="required"> <step performance="required">
<para>Read the installation instructions at the above listed <para>Read the installation instructions at the above listed
URL.</para> URL.</para>
</step>
<step performance="required"> <step performance="required">
<para>Unpack the distribution file, run configure, make and make <para>Unpack the distribution file, run configure, make and make
install to put the byte-compiled files and info library in place. install to put the byte-compiled files and info library in place.
</para>
</step>
<step performance="required" id="psgml-setup"> <step performance="required" id="psgml-setup">
<para> <para>
...@@ -1378,6 +1448,8 @@ file to make <productname>Emacs</productname> properly load ...@@ -1378,6 +1448,8 @@ file to make <productname>Emacs</productname> properly load
(cons "/usr/local/share/emacs/site-lisp/psgml" load-path)) (cons "/usr/local/share/emacs/site-lisp/psgml" load-path))
(autoload 'sgml-mode "psgml" "Major mode to edit SGML files." t) (autoload 'sgml-mode "psgml" "Major mode to edit SGML files." t)
</programlisting> </programlisting>
</para>
</step>
<step performance="optional"> <step performance="optional">
<para> <para>
...@@ -1388,7 +1460,7 @@ If you want to use <productname>PSGML</productname> when editing ...@@ -1388,7 +1460,7 @@ If you want to use <productname>PSGML</productname> when editing
(cons '("\\.s?html?\\'" . sgml-mode) auto-mode-alist)) (cons '("\\.s?html?\\'" . sgml-mode) auto-mode-alist))
</programlisting> </programlisting>
</para> </para>
</step>
<step performance="optional"> <step performance="optional">
<para>There is one important thing to note with <para>There is one important thing to note with
...@@ -1397,18 +1469,23 @@ If you want to use <productname>PSGML</productname> when editing ...@@ -1397,18 +1469,23 @@ If you want to use <productname>PSGML</productname> when editing
<filename>/usr/local/lib/sgml</filename>. If, as in the examples in <filename>/usr/local/lib/sgml</filename>. If, as in the examples in
this chapter, you use <filename>/usr/local/share/sgml</filename>, you this chapter, you use <filename>/usr/local/share/sgml</filename>, you
have to compensate for this. have to compensate for this.
</para>
<substeps> <substeps>
<step performance="optional"> <step performance="optional">
<para> <para>
You can set the You can set the
<filename>SGML_CATALOG_FILES</filename> environment variable. <filename>SGML_CATALOG_FILES</filename> environment variable.
</para>
</step>
<step performance="optional"> <step performance="optional">
<para> <para>
You can You can
customize your <productname>PSGML</productname> installation (its customize your <productname>PSGML</productname> installation (its
manual tells you how). manual tells you how).
</para>
</step>
<step performance="optional"> <step performance="optional">
<para> <para>
...@@ -1416,10 +1493,13 @@ You can even edit the source file ...@@ -1416,10 +1493,13 @@ You can even edit the source file
<filename>psgml.el</filename> before compiling and installing <filename>psgml.el</filename> before compiling and installing
<productname>PSGML</productname>, changing the hard-coded paths to <productname>PSGML</productname>, changing the hard-coded paths to
match your own default.</para> match your own default.</para>
</step>
</substeps> </substeps>
</step>
</procedure> </procedure>
</sect3>
<sect3><title>Installing <productname>JadeTeX</productname></title> <sect3><title>Installing <productname>JadeTeX</productname></title>
...@@ -1503,6 +1583,7 @@ now supports <application>jade</application> ...@@ -1503,6 +1583,7 @@ now supports <application>jade</application>
and <productname>DocBook</productname>. It may be the preferred toolset and <productname>DocBook</productname>. It may be the preferred toolset
for working with <acronym>SGML</acronym> but we have not had a chance to for working with <acronym>SGML</acronym> but we have not had a chance to
evaluate the new package. evaluate the new package.
</para>
<!-- <!--
...@@ -1570,7 +1651,7 @@ Run <productname>texhash</productname> to update the tex database. ...@@ -1570,7 +1651,7 @@ Run <productname>texhash</productname> to update the tex database.
</para></sect2></sect1> </para></sect2></sect1>
--> -->
</sect1>
</appendix> </appendix>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
......
doc/src/sgml/ecpg.sgml
View file @ a75f2d21
...@@ -37,7 +37,7 @@ Permission is granted to copy and use in the same way as you are allowed ...@@ -37,7 +37,7 @@ Permission is granted to copy and use in the same way as you are allowed
to copy and use the rest of the <ProductName>PostgreSQL</ProductName>. to copy and use the rest of the <ProductName>PostgreSQL</ProductName>.
</Para> </Para>
</Note> </Note>
</para>
<Sect1> <Sect1>
<Title>Why Embedded <Acronym>SQL</Acronym>?</Title> <Title>Why Embedded <Acronym>SQL</Acronym>?</Title>
...@@ -48,6 +48,7 @@ queries. It takes care of all the tedious moving of information to and ...@@ -48,6 +48,7 @@ queries. It takes care of all the tedious moving of information to and
from variables in your <Acronym>C</Acronym> program. from variables in your <Acronym>C</Acronym> program.
Many <Acronym>RDBMS</Acronym> packages Many <Acronym>RDBMS</Acronym> packages
support this embedded language. support this embedded language.
</Para>
<Para> There is an ANSI-standard describing how the embedded language should <Para> There is an ANSI-standard describing how the embedded language should
work. <Application>ecpg</Application> was designed to meet this standard work. <Application>ecpg</Application> was designed to meet this standard
...@@ -56,7 +57,8 @@ possible to port programs with embedded <Acronym>SQL</Acronym> written for ...@@ -56,7 +57,8 @@ possible to port programs with embedded <Acronym>SQL</Acronym> written for
other <Acronym>RDBMS</Acronym> packages to other <Acronym>RDBMS</Acronym> packages to
<ProductName>Postgres</ProductName> and thus promoting the spirit of free <ProductName>Postgres</ProductName> and thus promoting the spirit of free
software. software.
</Para>
</sect1>
<Sect1> <Sect1>
<Title>The Concept</Title> <Title>The Concept</Title>
...@@ -67,6 +69,7 @@ For declaring variables that can be used in ...@@ -67,6 +69,7 @@ For declaring variables that can be used in
<Acronym>SQL</Acronym> statements you need to <Acronym>SQL</Acronym> statements you need to
put them in a special declare section. put them in a special declare section.
You use a special syntax for the <Acronym>SQL</Acronym> queries. You use a special syntax for the <Acronym>SQL</Acronym> queries.
</Para>
<Para> <Para>
Before compiling you run the file through Before compiling you run the file through
...@@ -77,6 +80,7 @@ calls with the variables used as arguments. Both variables that are used ...@@ -77,6 +80,7 @@ calls with the variables used as arguments. Both variables that are used
as input to the <Acronym>SQL</Acronym> statements and variables that will as input to the <Acronym>SQL</Acronym> statements and variables that will
contain the contain the
result are passed. result are passed.
</Para>
<Para> <Para>
Then you compile and at link time you link with a special library that Then you compile and at link time you link with a special library that
...@@ -85,6 +89,7 @@ single function) fetches the information from the arguments, performs ...@@ -85,6 +89,7 @@ single function) fetches the information from the arguments, performs
the <Acronym>SQL</Acronym> query using the ordinary interface the <Acronym>SQL</Acronym> query using the ordinary interface
(<FileName>libpq</FileName>) and puts back (<FileName>libpq</FileName>) and puts back
the result in the arguments dedicated for output. the result in the arguments dedicated for output.
</Para>
<Para> <Para>
Then you run your program and when the control arrives to Then you run your program and when the control arrives to
...@@ -92,24 +97,27 @@ the <Acronym>SQL</Acronym> ...@@ -92,24 +97,27 @@ the <Acronym>SQL</Acronym>
statement the <Acronym>SQL</Acronym> statement is performed against statement the <Acronym>SQL</Acronym> statement is performed against
the database and you the database and you
can continue with the result. can continue with the result.
</Para>
</sect1>
<Sect1> <Sect1>
<Title>How To Use <Application>egpc</Application></Title> <Title>How To Use <Application>egpc</Application></Title>
<Para> <Para>
This section describes how to use the <Application>egpc</Application> tool. This section describes how to use the <Application>egpc</Application> tool.
</Para>
<Sect2> <Sect2>
<Title>Preprocessor <Title>Preprocessor</title>
<Para> <Para>
The preprocessor is called <Application>ecpg</Application>. The preprocessor is called <Application>ecpg</Application>.
After installation it resides in After installation it resides in
the <ProductName>Postgres</ProductName> <FileName>bin/</FileName> directory. the <ProductName>Postgres</ProductName> <FileName>bin/</FileName> directory.
</Para>
</sect2>
<Sect2> <Sect2>
<Title>Library <Title>Library</title>
<Para> <Para>
The <Application>ecpg</Application> library is called The <Application>ecpg</Application> library is called
...@@ -118,6 +126,7 @@ The <Application>ecpg</Application> library is called ...@@ -118,6 +126,7 @@ The <Application>ecpg</Application> library is called
uses the <FileName>libpq</FileName> library for communication to the uses the <FileName>libpq</FileName> library for communication to the
<ProductName>Postgres</ProductName> server so you will <ProductName>Postgres</ProductName> server so you will
have to link your program with <Parameter>-lecpg -lpq</Parameter>. have to link your program with <Parameter>-lecpg -lpq</Parameter>.
</Para>
<Para> <Para>
The library has some methods that are "hidden" but that could prove very The library has some methods that are "hidden" but that could prove very
...@@ -130,6 +139,7 @@ useful sometime. ...@@ -130,6 +139,7 @@ useful sometime.
turns on debug logging if called with the first argument non-zero. turns on debug logging if called with the first argument non-zero.
Debug logging is done on <replaceable class="parameter">stream</replaceable>. Debug logging is done on <replaceable class="parameter">stream</replaceable>.
Most <Acronym>SQL</Acronym> statement logs its arguments and result. Most <Acronym>SQL</Acronym> statement logs its arguments and result.
</Para>
<Para> <Para>
The most important one (<Function>ECPGdo</Function>) The most important one (<Function>ECPGdo</Function>)
...@@ -152,9 +162,11 @@ This method returns TRUE if we are connected to a database and FALSE if not. ...@@ -152,9 +162,11 @@ This method returns TRUE if we are connected to a database and FALSE if not.
</Para> </Para>
</ListItem> </ListItem>
</itemizedlist> </itemizedlist>
</Para>
</sect2>
<Sect2> <Sect2>
<Title>Error handling <Title>Error handling</title>
<Para> <Para>
To be able to detect errors from the <ProductName>Postgres</ProductName> To be able to detect errors from the <ProductName>Postgres</ProductName>
...@@ -173,6 +185,7 @@ struct sqlca { ...@@ -173,6 +185,7 @@ struct sqlca {
} sqlerrm; } sqlerrm;
} sqlca; } sqlca;
</ProgramListing> </ProgramListing>
</Para>
<Para> <Para>
If an error occured in the last <Acronym>SQL</Acronym> statement If an error occured in the last <Acronym>SQL</Acronym> statement
...@@ -182,12 +195,14 @@ will be non-zero. If <Parameter>sqlca.sqlcode</Parameter> is less that 0 ...@@ -182,12 +195,14 @@ will be non-zero. If <Parameter>sqlca.sqlcode</Parameter> is less that 0
some kind of serious error, like the database definition does not match some kind of serious error, like the database definition does not match
the query given. If it is bigger than 0 then this is a normal error like the query given. If it is bigger than 0 then this is a normal error like
the table did not contain the requested row. the table did not contain the requested row.
</Para>
<Para> <Para>
sqlca.sqlerrm.sqlerrmc will contain a string that describes the error. sqlca.sqlerrm.sqlerrmc will contain a string that describes the error.
The string ends with <Quote>line 23.</Quote> where the line is the line number The string ends with <Quote>line 23.</Quote> where the line is the line number
in the source file (actually the file generated by the preprocessor but in the source file (actually the file generated by the preprocessor but
I hope I can fix this to be the line number in the input file.) I hope I can fix this to be the line number in the input file.)
</Para>
<Para> <Para>
List of errors that can occur: List of errors that can occur:
...@@ -394,8 +409,9 @@ The connect to the database did not work. ...@@ -394,8 +409,9 @@ The connect to the database did not work.
</ListItem> </ListItem>
</VarListEntry> </VarListEntry>
</VariableList> </VariableList>
</Para>
</Sect2> </Sect2>
</sect1>
<Sect1> <Sect1>
<Title>Limitations</Title> <Title>Limitations</Title>
...@@ -415,6 +431,7 @@ application in a so called single tasking way. Instead of starting one ...@@ -415,6 +431,7 @@ application in a so called single tasking way. Instead of starting one
client process per application process both the database part and the client process per application process both the database part and the
application part is run in the same process. In later versions of oracle application part is run in the same process. In later versions of oracle
this is no longer supported. this is no longer supported.
</Para>
<Para> <Para>
This would require a total redesign of the <ProductName>Postgres</ProductName> access model and This would require a total redesign of the <ProductName>Postgres</ProductName> access model and
...@@ -423,6 +440,8 @@ that effort can not justify the performance gained. ...@@ -423,6 +440,8 @@ that effort can not justify the performance gained.
</ListItem> </ListItem>
</VarListEntry> </VarListEntry>
</VariableList> </VariableList>
</Para>
</sect1>
<Sect1> <Sect1>
<Title>Porting From Other <Acronym>RDBMS</Acronym> Packages</Title> <Title>Porting From Other <Acronym>RDBMS</Acronym> Packages</Title>
...@@ -431,6 +450,8 @@ that effort can not justify the performance gained. ...@@ -431,6 +450,8 @@ that effort can not justify the performance gained.
To be written by someone who knows the different To be written by someone who knows the different
<Acronym>RDBMS</Acronym> packages and who <Acronym>RDBMS</Acronym> packages and who
actually does port something... actually does port something...
</Para>
</sect1>
<Sect1> <Sect1>
<Title>Installation</Title> <Title>Installation</Title>
...@@ -440,6 +461,8 @@ Since version 0.5 <Application>ecpg</Application> is distributed ...@@ -440,6 +461,8 @@ Since version 0.5 <Application>ecpg</Application> is distributed
together with <ProductName>Postgres</ProductName>. So you together with <ProductName>Postgres</ProductName>. So you
should get your precompiler, libraries and header files compiled and should get your precompiler, libraries and header files compiled and
installed by default as a part of your installation. installed by default as a part of your installation.
</Para>
</sect1>
<Sect1> <Sect1>
<Title>For the Developer</Title> <Title>For the Developer</Title>
...@@ -454,6 +477,7 @@ on How to use it should be enough for all normal questions. ...@@ -454,6 +477,7 @@ on How to use it should be enough for all normal questions.
So, read this before looking at the internals of the So, read this before looking at the internals of the
<Application>ecpg</Application>. If <Application>ecpg</Application>. If
you are not interested in how it really works, skip this section. you are not interested in how it really works, skip this section.
</Para>
<Sect2> <Sect2>
<Title>ToDo List</Title> <Title>ToDo List</Title>
...@@ -499,7 +523,7 @@ to_date et al. ...@@ -499,7 +523,7 @@ to_date et al.
<ListItem> <ListItem>
<Para> <Para>
Records or structures have to be defined in the declare section. Records or structures have to be defined in the declare section.
</Para>
</ListItem> </ListItem>
</VarListEntry> </VarListEntry>
...@@ -513,31 +537,43 @@ The following statements are not implemented thus far: ...@@ -513,31 +537,43 @@ The following statements are not implemented thus far:
<Term> exec sql type</Term> <Term> exec sql type</Term>
<ListItem> <ListItem>
<Para> <Para>
</Para>
</listitem>
</VarListEntry> </VarListEntry>
<VarListEntry> <VarListEntry>
<Term> exec sql prepare</Term> <Term> exec sql prepare</Term>
<ListItem> <ListItem>
<Para> <Para>
</Para>
</listitem>
</VarListEntry> </VarListEntry>
<VarListEntry> <VarListEntry>
<Term> exec sql allocate</Term> <Term> exec sql allocate</Term>
<ListItem> <ListItem>
<Para> <Para>
</Para>
</listitem>
</VarListEntry> </VarListEntry>
<VarListEntry> <VarListEntry>
<Term> exec sql free</Term> <Term> exec sql free</Term>
<ListItem> <ListItem>
<Para> <Para>
</Para>
</listitem>
</VarListEntry> </VarListEntry>
<VarListEntry> <VarListEntry>
<Term> exec sql whenever sqlwarning</Term> <Term> exec sql whenever sqlwarning</Term>
<ListItem> <ListItem>
<Para> <Para>
</Para>
</listitem>
</VarListEntry> </VarListEntry>
<VarListEntry> <VarListEntry>
<Term> SQLSTATE</Term> <Term> SQLSTATE</Term>
<ListItem> <ListItem>
<Para> <Para>
</Para>
</listitem>
</VarListEntry> </VarListEntry>
</VariableList> </VariableList>
</Para> </Para>
...@@ -571,6 +607,7 @@ To set up a database you need a few scripts with table definitions and ...@@ -571,6 +607,7 @@ To set up a database you need a few scripts with table definitions and
other configuration parameters. If you have these scripts for an old other configuration parameters. If you have these scripts for an old
database you would like to just apply them to get a database you would like to just apply them to get a
<ProductName>Postgres</ProductName> database that works in the same way. <ProductName>Postgres</ProductName> database that works in the same way.
</Para>
<Para> <Para>
To set up a database you need a few scripts with table definitions and To set up a database you need a few scripts with table definitions and
...@@ -582,6 +619,8 @@ than could be realised in a script. ...@@ -582,6 +619,8 @@ than could be realised in a script.
</ListItem> </ListItem>
</VarListEntry> </VarListEntry>
</VariableList> </VariableList>
</Para>
</sect2>
<Sect2> <Sect2>
<Title>The Preprocessor</Title> <Title>The Preprocessor</Title>
...@@ -589,11 +628,13 @@ than could be realised in a script. ...@@ -589,11 +628,13 @@ than could be realised in a script.
<Para> <Para>
First four lines are written to the output. Two comments and two include First four lines are written to the output. Two comments and two include
lines necessary for the interface to the library. lines necessary for the interface to the library.
</Para>
<Para> <Para>
Then the preprocessor works in one pass only reading the input file and Then the preprocessor works in one pass only reading the input file and
writing to the output as it goes along. Normally it just echoes writing to the output as it goes along. Normally it just echoes
everything to the output without looking at it further. everything to the output without looking at it further.
</Para>
<Para> <Para>
When it comes to an <Command>EXEC SQL</Command> statements it interviens and When it comes to an <Command>EXEC SQL</Command> statements it interviens and
...@@ -616,10 +657,12 @@ exec sql end declare section; ...@@ -616,10 +657,12 @@ exec sql end declare section;
In the section only variable declarations are allowed. Every variable In the section only variable declarations are allowed. Every variable
declare within this section is also entered in a list of variables declare within this section is also entered in a list of variables
indexed on their name together with the corresponding type. indexed on their name together with the corresponding type.
</Para>
<Para> <Para>
The declaration is echoed to the file to make the variable a normal The declaration is echoed to the file to make the variable a normal
C-variable also. C-variable also.
</Para>
<Para> <Para>
The special types VARCHAR and VARCHAR2 are converted into a named struct The special types VARCHAR and VARCHAR2 are converted into a named struct
...@@ -720,6 +763,7 @@ Other <Acronym>SQL</Acronym> statements are other statements that start with ...@@ -720,6 +763,7 @@ Other <Acronym>SQL</Acronym> statements are other statements that start with
<Command>exec sql</Command> and ends with <Command>;</Command>. <Command>exec sql</Command> and ends with <Command>;</Command>.
Everything inbetween is treated Everything inbetween is treated
as an <Acronym>SQL</Acronym> statement and parsed for variable substitution. as an <Acronym>SQL</Acronym> statement and parsed for variable substitution.
</Para>
<Para> <Para>
Variable substitution occur when a symbol starts with a colon Variable substitution occur when a symbol starts with a colon
...@@ -730,6 +774,7 @@ whether or not the <Acronym>SQL</Acronym> statements knows it to be ...@@ -730,6 +774,7 @@ whether or not the <Acronym>SQL</Acronym> statements knows it to be
a variable for input or a variable for input or
output the pointers to the variables are written to the output to allow output the pointers to the variables are written to the output to allow
for access by the function. for access by the function.
</Para>
<Para> <Para>
For every variable that is part of the <Acronym>SQL</Acronym> request For every variable that is part of the <Acronym>SQL</Acronym> request
...@@ -742,6 +787,7 @@ the function gets another five arguments: ...@@ -742,6 +787,7 @@ the function gets another five arguments:
<Member>Number of elements in the array (for array fetches)</Member> <Member>Number of elements in the array (for array fetches)</Member>
<Member>The offset to the next element in the array (for array fetches)</Member> <Member>The offset to the next element in the array (for array fetches)</Member>
</SimpleList> </SimpleList>
</Para>
<Para> <Para>
Since the array fetches are not implemented yet the two last arguments Since the array fetches are not implemented yet the two last arguments
...@@ -750,7 +796,7 @@ are not really important. They could perhaps have been left out. ...@@ -750,7 +796,7 @@ are not really important. They could perhaps have been left out.
</ListItem> </ListItem>
</VarListEntry> </VarListEntry>
</VariableList> </VariableList>
</Para>
</Sect2> </Sect2>
<Sect2> <Sect2>
...@@ -786,6 +832,8 @@ is translated into: ...@@ -786,6 +832,8 @@ is translated into:
</ProgramListing> </ProgramListing>
(the indentation in this manual is added for readability and not (the indentation in this manual is added for readability and not
something that the preprocessor can do.) something that the preprocessor can do.)
</Para>
</sect2>
<Sect2> <Sect2>
<Title>The Library</Title> <Title>The Library</Title>
...@@ -796,6 +844,7 @@ function. It takes a variable amount of arguments. Hopefully we wont run ...@@ -796,6 +844,7 @@ function. It takes a variable amount of arguments. Hopefully we wont run
into machines with limits on the amount of variables that can be into machines with limits on the amount of variables that can be
accepted by a varchar function. This could easily add up to 50 or so accepted by a varchar function. This could easily add up to 50 or so
arguments. arguments.
</Para>
<Para> <Para>
The arguments are: The arguments are:
...@@ -861,14 +910,18 @@ An enum telling that there are no more variables. ...@@ -861,14 +910,18 @@ An enum telling that there are no more variables.
</ListItem> </ListItem>
</VarListEntry> </VarListEntry>
</VariableList> </VariableList>
</Para>
<Para> <Para>
All the <Acronym>SQL</Acronym> statements are performed in one transaction All the <Acronym>SQL</Acronym> statements are performed in one transaction
unless you issue unless you issue
a commit transaction. This works so that the first transaction or the a commit transaction. This works so that the first transaction or the
first after a commit or rollback always begins a transaction. first after a commit or rollback always begins a transaction.
</Para>
<Para> <Para>
To be completed: entries describing the other entries. To be completed: entries describing the other entries.
</Para>
</sect2>
</sect1>
</Chapter> </Chapter>
doc/src/sgml/extend.sgml
View file @ a75f2d21
...@@ -243,8 +243,10 @@ interchangably. ...@@ -243,8 +243,10 @@ interchangably.
and will be described in depth (in the section and will be described in depth (in the section
on interfacing types and operators to indices) on interfacing types and operators to indices)
after we have discussed basic extensions. after we have discussed basic extensions.
</para>
</ListItem> </ListItem>
</ItemizedList> </ItemizedList>
</Para> </Para>
</sect1>
</Chapter> </Chapter>
doc/src/sgml/func.sgml
View file @ a75f2d21
...@@ -63,6 +63,7 @@ available through operators and may be documented as operators only. ...@@ -63,6 +63,7 @@ available through operators and may be documented as operators only.
</TGROUP> </TGROUP>
</TABLE> </TABLE>
</Para> </Para>
</sect1>
<sect1> <sect1>
<title>String Functions</title> <title>String Functions</title>
...@@ -230,6 +231,7 @@ Some are used internally to implement the SQL92 string functions listed above. ...@@ -230,6 +231,7 @@ Some are used internally to implement the SQL92 string functions listed above.
<para> <para>
Most functions explicitly defined for text will work for char() and varchar() arguments. Most functions explicitly defined for text will work for char() and varchar() arguments.
</para> </para>
</sect1>
<sect1> <sect1>
<title>Date/Time Functions</title> <title>Date/Time Functions</title>
...@@ -345,6 +347,7 @@ as well as the more specialized quantities ...@@ -345,6 +347,7 @@ as well as the more specialized quantities
to return day of week and `epoch' to return seconds since 1970 (for <Type>datetime</Type>) to return day of week and `epoch' to return seconds since 1970 (for <Type>datetime</Type>)
or 'epoch' to return total elapsed seconds (for <Type>timespan</Type>). or 'epoch' to return total elapsed seconds (for <Type>timespan</Type>).
</Para> </Para>
</sect1>
<sect1> <sect1>
<title>Geometric Functions</title> <title>Geometric Functions</title>
...@@ -623,6 +626,7 @@ support functions. ...@@ -623,6 +626,7 @@ support functions.
</TGROUP> </TGROUP>
</TABLE> </TABLE>
</Para> </Para>
</sect1>
<sect1> <sect1>
<title id="cidr-funcs">IP V4 Functions</title> <title id="cidr-funcs">IP V4 Functions</title>
......
doc/src/sgml/geqo.sgml
View file @ a75f2d21
<!-- <!--
$Header: /cvsroot/pgsql/doc/src/sgml/geqo.sgml,v 1.4 1998/08/15 06:55:05 thomas Exp $ $Header: /cvsroot/pgsql/doc/src/sgml/geqo.sgml,v 1.5 1998/12/29 02:24:15 thomas Exp $
Genetic Optimizer Genetic Optimizer
$Log: geqo.sgml,v $ $Log: geqo.sgml,v $
Revision 1.5 1998/12/29 02:24:15 thomas
Clean up to ensure tag completion as required by the newest versions
of Norm's Modular Style Sheets and jade/docbook.
From Vince Vielhaber <vev@michvhf.com>.
Revision 1.4 1998/08/15 06:55:05 thomas Revision 1.4 1998/08/15 06:55:05 thomas
Change Id field in chapter tag to change html output file name. Change Id field in chapter tag to change html output file name.
...@@ -43,6 +48,7 @@ Written by <ULink url="utesch@aut.tu-freiberg.de">Martin Utesch</ULink> ...@@ -43,6 +48,7 @@ Written by <ULink url="utesch@aut.tu-freiberg.de">Martin Utesch</ULink>
for the Institute of Automatic Control at the University of Mining and Technology in Freiberg, Germany. for the Institute of Automatic Control at the University of Mining and Technology in Freiberg, Germany.
</Para> </Para>
</Note> </Note>
</para>
<Sect1> <Sect1>
<Title>Query Handling as a Complex Optimization Problem</Title> <Title>Query Handling as a Complex Optimization Problem</Title>
...@@ -55,6 +61,7 @@ optimization effort is caused by the support of a variety of <FirstTerm>join met ...@@ -55,6 +61,7 @@ optimization effort is caused by the support of a variety of <FirstTerm>join met
(e.g., nested loop, index scan, merge join in <ProductName>Postgres</ProductName>) to (e.g., nested loop, index scan, merge join in <ProductName>Postgres</ProductName>) to
process individual <Command>join</Command>s and a diversity of <FirstTerm>indices</FirstTerm> (e.g., r-tree, process individual <Command>join</Command>s and a diversity of <FirstTerm>indices</FirstTerm> (e.g., r-tree,
b-tree, hash in <ProductName>Postgres</ProductName>) as access paths for relations. b-tree, hash in <ProductName>Postgres</ProductName>) as access paths for relations.
</para>
<Para> <Para>
The current <ProductName>Postgres</ProductName> optimizer implementation performs a <FirstTerm>near- The current <ProductName>Postgres</ProductName> optimizer implementation performs a <FirstTerm>near-
...@@ -62,6 +69,7 @@ exhaustive search</FirstTerm> over the space of alternative strategies. This que ...@@ -62,6 +69,7 @@ exhaustive search</FirstTerm> over the space of alternative strategies. This que
optimization technique is inadequate to support database application optimization technique is inadequate to support database application
domains that involve the need for extensive queries, such as artificial domains that involve the need for extensive queries, such as artificial
intelligence. intelligence.
</para>
<Para> <Para>
The Institute of Automatic Control at the University of Mining and The Institute of Automatic Control at the University of Mining and
...@@ -70,15 +78,18 @@ folks wanted to take the <ProductName>Postgres</ProductName> DBMS as the backend ...@@ -70,15 +78,18 @@ folks wanted to take the <ProductName>Postgres</ProductName> DBMS as the backend
support knowledge based system for the maintenance of an electrical support knowledge based system for the maintenance of an electrical
power grid. The DBMS needed to handle large <Command>join</Command> queries for the power grid. The DBMS needed to handle large <Command>join</Command> queries for the
inference machine of the knowledge based system. inference machine of the knowledge based system.
</para>
<Para> <Para>
Performance difficulties within exploring the space of possible query Performance difficulties within exploring the space of possible query
plans arose the demand for a new optimization technique being developed. plans arose the demand for a new optimization technique being developed.
</para>
<Para> <Para>
In the following we propose the implementation of a <FirstTerm>Genetic Algorithm</FirstTerm> In the following we propose the implementation of a <FirstTerm>Genetic Algorithm</FirstTerm>
as an option for the database query optimization problem. as an option for the database query optimization problem.
</para>
</sect1>
<Sect1> <Sect1>
<Title>Genetic Algorithms (<Acronym>GA</Acronym>)</Title> <Title>Genetic Algorithms (<Acronym>GA</Acronym>)</Title>
...@@ -89,6 +100,7 @@ determined, randomized search. The set of possible solutions for the ...@@ -89,6 +100,7 @@ determined, randomized search. The set of possible solutions for the
optimization problem is considered as a <FirstTerm>population</FirstTerm> of <FirstTerm>individuals</FirstTerm>. optimization problem is considered as a <FirstTerm>population</FirstTerm> of <FirstTerm>individuals</FirstTerm>.
The degree of adaption of an individual to its environment is specified The degree of adaption of an individual to its environment is specified
by its <FirstTerm>fitness</FirstTerm>. by its <FirstTerm>fitness</FirstTerm>.
</para>
<Para> <Para>
The coordinates of an individual in the search space are represented The coordinates of an individual in the search space are represented
...@@ -96,11 +108,13 @@ by <FirstTerm>chromosomes</FirstTerm>, in essence a set of character strings. A ...@@ -96,11 +108,13 @@ by <FirstTerm>chromosomes</FirstTerm>, in essence a set of character strings. A
subsection of a chromosome which encodes the value of a single parameter subsection of a chromosome which encodes the value of a single parameter
being optimized. Typical encodings for a gene could be <FirstTerm>binary</FirstTerm> or being optimized. Typical encodings for a gene could be <FirstTerm>binary</FirstTerm> or
<FirstTerm>integer</FirstTerm>. <FirstTerm>integer</FirstTerm>.
</para>
<Para> <Para>
Through simulation of the evolutionary operations <FirstTerm>recombination</FirstTerm>, Through simulation of the evolutionary operations <FirstTerm>recombination</FirstTerm>,
<FirstTerm>mutation</FirstTerm>, and <FirstTerm>selection</FirstTerm> new generations of search points are found <FirstTerm>mutation</FirstTerm>, and <FirstTerm>selection</FirstTerm> new generations of search points are found
that show a higher average fitness than their ancestors. that show a higher average fitness than their ancestors.
</para>
<Para> <Para>
According to the "comp.ai.genetic" <Acronym>FAQ</Acronym> it cannot be stressed too According to the "comp.ai.genetic" <Acronym>FAQ</Acronym> it cannot be stressed too
...@@ -137,6 +151,8 @@ P''(t) generation of descendants at a time t ...@@ -137,6 +151,8 @@ P''(t) generation of descendants at a time t
| | t := t + 1 | | | t := t + 1 |
+===+=====================================+ +===+=====================================+
</ProgramListing> </ProgramListing>
</para>
</sect1>
<Sect1> <Sect1>
<Title>Genetic Query Optimization (<Acronym>GEQO</Acronym>) in Postgres</Title> <Title>Genetic Query Optimization (<Acronym>GEQO</Acronym>) in Postgres</Title>
...@@ -156,10 +172,12 @@ E. g., the query tree ...@@ -156,10 +172,12 @@ E. g., the query tree
is encoded by the integer string '4-1-3-2', is encoded by the integer string '4-1-3-2',
which means, first join relation '4' and '1', then '3', and which means, first join relation '4' and '1', then '3', and
then '2', where 1, 2, 3, 4 are relids in <ProductName>Postgres</ProductName>. then '2', where 1, 2, 3, 4 are relids in <ProductName>Postgres</ProductName>.
</para>
<Para> <Para>
Parts of the <Acronym>GEQO</Acronym> module are adapted from D. Whitley's Genitor Parts of the <Acronym>GEQO</Acronym> module are adapted from D. Whitley's Genitor
algorithm. algorithm.
</para>
<Para> <Para>
Specific characteristics of the <Acronym>GEQO</Acronym> implementation in <ProductName>Postgres</ProductName> Specific characteristics of the <Acronym>GEQO</Acronym> implementation in <ProductName>Postgres</ProductName>
...@@ -189,6 +207,7 @@ Mutation as genetic operator is deprecated so that no repair ...@@ -189,6 +207,7 @@ Mutation as genetic operator is deprecated so that no repair
</Para> </Para>
</ListItem> </ListItem>
</ItemizedList> </ItemizedList>
</para>
<Para> <Para>
The <Acronym>GEQO</Acronym> module gives the following benefits to the <ProductName>Postgres</ProductName> DBMS The <Acronym>GEQO</Acronym> module gives the following benefits to the <ProductName>Postgres</ProductName> DBMS
...@@ -209,6 +228,7 @@ Improved cost size approximation of query plans since no longer ...@@ -209,6 +228,7 @@ Improved cost size approximation of query plans since no longer
</Para> </Para>
</ListItem> </ListItem>
</ItemizedList> </ItemizedList>
</para>
</Sect1> </Sect1>
...@@ -231,6 +251,8 @@ Debugging showed that it get stucked in a loop of routine ...@@ -231,6 +251,8 @@ Debugging showed that it get stucked in a loop of routine
<Function>OrderedElemPop</Function>, file <FileName>backend/utils/mmgr/oset.c</FileName>. <Function>OrderedElemPop</Function>, file <FileName>backend/utils/mmgr/oset.c</FileName>.
The same problems arise with long queries when using the normal The same problems arise with long queries when using the normal
<ProductName>Postgres</ProductName> query optimization algorithm. <ProductName>Postgres</ProductName> query optimization algorithm.
</para>
</sect3>
<Sect3> <Sect3>
<Title>Improve genetic algorithm parameter settings</Title> <Title>Improve genetic algorithm parameter settings</Title>
...@@ -252,6 +274,8 @@ Computing time ...@@ -252,6 +274,8 @@ Computing time
</Para> </Para>
</ListItem> </ListItem>
</ItemizedList> </ItemizedList>
</para>
</sect3>
<Sect3> <Sect3>
<Title>Find better solution for integer overflow</Title> <Title>Find better solution for integer overflow</Title>
...@@ -263,6 +287,8 @@ the present hack for MAXINT overflow is to set the <ProductName>Postgres</Produc ...@@ -263,6 +287,8 @@ the present hack for MAXINT overflow is to set the <ProductName>Postgres</Produc
value of <StructField>rel->size</StructField> to its logarithm. value of <StructField>rel->size</StructField> to its logarithm.
Modifications of <StructName>Rel</StructName> in <FileName>backend/nodes/relation.h</FileName> will Modifications of <StructName>Rel</StructName> in <FileName>backend/nodes/relation.h</FileName> will
surely have severe impacts on the whole <ProductName>Postgres</ProductName> implementation. surely have severe impacts on the whole <ProductName>Postgres</ProductName> implementation.
</para>
</sect3>
<Sect3> <Sect3>
<Title>Find solution for exhausted memory</Title> <Title>Find solution for exhausted memory</Title>
...@@ -275,7 +301,9 @@ Maybe I forgot something to be freed correctly, but I dunno what. ...@@ -275,7 +301,9 @@ Maybe I forgot something to be freed correctly, but I dunno what.
Of course the <StructName>rel</StructName> data structure of the <Command>join</Command> keeps growing and Of course the <StructName>rel</StructName> data structure of the <Command>join</Command> keeps growing and
growing the more relations are packed into it. growing the more relations are packed into it.
Suggestions are welcome :-( Suggestions are welcome :-(
</para>
</sect3>
</sect2>
<Sect2> <Sect2>
<Title>Further Improvements</Title> <Title>Further Improvements</Title>
...@@ -283,6 +311,7 @@ Suggestions are welcome :-( ...@@ -283,6 +311,7 @@ Suggestions are welcome :-(
<Para> <Para>
Enable bushy query tree processing within <ProductName>Postgres</ProductName>; Enable bushy query tree processing within <ProductName>Postgres</ProductName>;
that may improve the quality of query plans. that may improve the quality of query plans.
</para>
<BIBLIOGRAPHY Id="geqo-biblio"> <BIBLIOGRAPHY Id="geqo-biblio">
<TITLE> <TITLE>
...@@ -365,4 +394,6 @@ The Benjamin/Cummings Pub., Inc. ...@@ -365,4 +394,6 @@ The Benjamin/Cummings Pub., Inc.
</BIBLIOENTRY> </BIBLIOENTRY>
</BIBLIOGRAPHY> </BIBLIOGRAPHY>
</sect2>
</sect1>
</Chapter> </Chapter>
doc/src/sgml/gist.sgml
View file @ a75f2d21
...@@ -19,7 +19,7 @@ with more on different indexing and sorting schemes at ...@@ -19,7 +19,7 @@ with more on different indexing and sorting schemes at
And there is more interesting reading at the Berkely database site at And there is more interesting reading at the Berkely database site at
<ULink url="http://epoch.cs.berkeley.edu:8000/">http://epoch.cs.berkeley.edu:8000/</ULink>. <ULink url="http://epoch.cs.berkeley.edu:8000/">http://epoch.cs.berkeley.edu:8000/</ULink>.
</para>
<Para> <Para>
<Note> <Note>
...@@ -32,12 +32,12 @@ on GiST. Hopefully we will learn more in the future and update this information. ...@@ -32,12 +32,12 @@ on GiST. Hopefully we will learn more in the future and update this information.
- thomas 1998-03-01 - thomas 1998-03-01
</Para> </Para>
</Note> </Note>
</para>
<Para> <Para>
Well, I can't say I quite understand what's going on, but at least Well, I can't say I quite understand what's going on, but at least
I (almost) succeeded in porting GiST examples to linux. The GiST access I (almost) succeeded in porting GiST examples to linux. The GiST access
method is already in the postgres tree (<FileName>src/backend/access/gist</FileName>). method is already in the postgres tree (<FileName>src/backend/access/gist</FileName>).
</para>
<Para> <Para>
<ULink url="ftp://s2k-ftp.cs.berkeley.edu/pub/gist/pggist/pggist.tgz">Examples at Berkeley</ULink> <ULink url="ftp://s2k-ftp.cs.berkeley.edu/pub/gist/pggist/pggist.tgz">Examples at Berkeley</ULink>
come with an overview of the methods and demonstrate spatial index come with an overview of the methods and demonstrate spatial index
...@@ -56,7 +56,7 @@ ERROR: cannot open pix ...@@ -56,7 +56,7 @@ ERROR: cannot open pix
(PostgreSQL 6.3 Sun Feb 1 14:57:30 EST 1998) (PostgreSQL 6.3 Sun Feb 1 14:57:30 EST 1998)
</ProgramListing> </ProgramListing>
</para>
<Para> <Para>
I could not get sense of this error message; it appears to be something I could not get sense of this error message; it appears to be something
we'd rather ask the developers about (see also Note 4 below). What I we'd rather ask the developers about (see also Note 4 below). What I
...@@ -64,28 +64,28 @@ would suggest here is that someone of you linux guys (linux==gcc?) fetch the ...@@ -64,28 +64,28 @@ would suggest here is that someone of you linux guys (linux==gcc?) fetch the
original sources quoted above and apply my patch (see attachment) and original sources quoted above and apply my patch (see attachment) and
tell us what you feel about it. Looks cool to me, but I would not like tell us what you feel about it. Looks cool to me, but I would not like
to hold it up while there are so many competent people around. to hold it up while there are so many competent people around.
</para>
<Para> <Para>
A few notes on the sources: A few notes on the sources:
</para>
<Para> <Para>
1. I failed to make use of the original (HPUX) Makefile and rearranged 1. I failed to make use of the original (HPUX) Makefile and rearranged
the Makefile from the ancient postgres95 tutorial to do the job. I tried the Makefile from the ancient postgres95 tutorial to do the job. I tried
to keep it generic, but I am a very poor makefile writer -- just did to keep it generic, but I am a very poor makefile writer -- just did
some monkey work. Sorry about that, but I guess it is now a little some monkey work. Sorry about that, but I guess it is now a little
more portable that the original makefile. more portable that the original makefile.
</para>
<Para> <Para>
2. I built the example sources right under pgsql/src (just extracted the 2. I built the example sources right under pgsql/src (just extracted the
tar file there). The aforementioned Makefile assumes it is one level tar file there). The aforementioned Makefile assumes it is one level
below pgsql/src (in our case, in pgsql/src/pggist). below pgsql/src (in our case, in pgsql/src/pggist).
</para>
<Para> <Para>
3. The changes I made to the *.c files were all about #include's, 3. The changes I made to the *.c files were all about #include's,
function prototypes and typecasting. Other than that, I just threw function prototypes and typecasting. Other than that, I just threw
away a bunch of unused vars and added a couple parentheses to please away a bunch of unused vars and added a couple parentheses to please
gcc. I hope I did not screw up too much :) gcc. I hope I did not screw up too much :)
</para>
<Para> <Para>
4. There is a comment in polyproc.sql: 4. There is a comment in polyproc.sql:
...@@ -98,11 +98,11 @@ A few notes on the sources: ...@@ -98,11 +98,11 @@ A few notes on the sources:
<ProductName>Postgres</ProductName> versions <ProductName>Postgres</ProductName> versions
back and tried the query. My system went nuts and I had to shoot down back and tried the query. My system went nuts and I had to shoot down
the postmaster in about ten minutes. the postmaster in about ten minutes.
</para>
<Para> <Para>
I will continue to look into GiST for a while, but I would also I will continue to look into GiST for a while, but I would also
appreciate appreciate
more examples of R-tree usage. more examples of R-tree usage.
</para>
</Chapter> </Chapter>
doc/src/sgml/history.sgml
View file @ a75f2d21
...@@ -170,6 +170,7 @@ At the same time, the version numbering ...@@ -170,6 +170,7 @@ At the same time, the version numbering
was reset to start at 6.0, was reset to start at 6.0,
putting the numbers back into the sequence originally begun by putting the numbers back into the sequence originally begun by
the <ProductName>Postgres</ProductName> Project. the <ProductName>Postgres</ProductName> Project.
</Para>
<Para> <Para>
The emphasis on development for the v1.0.x releases of The emphasis on development for the v1.0.x releases of
...@@ -180,9 +181,11 @@ the emphasis has shifted from ...@@ -180,9 +181,11 @@ the emphasis has shifted from
identifying and understanding existing problems in the backend identifying and understanding existing problems in the backend
to augmenting features and capabilities, although to augmenting features and capabilities, although
work continues in all areas. work continues in all areas.
</Para>
<Para> <Para>
Major enhancements include: Major enhancements include:
</Para>
<ItemizedList> <ItemizedList>
<ListItem> <ListItem>
...@@ -203,6 +206,7 @@ type casting, and binary and hexadecimal integer input. ...@@ -203,6 +206,7 @@ type casting, and binary and hexadecimal integer input.
Built-in types have been improved, including new wide-range date/time types Built-in types have been improved, including new wide-range date/time types
and additional geometric type support. and additional geometric type support.
</Para> </Para>
</ListItem> </ListItem>
<ListItem> <ListItem>
<Para> <Para>
...@@ -211,7 +215,6 @@ and backend startup time has decreased 80% since v6.0 was released. ...@@ -211,7 +215,6 @@ and backend startup time has decreased 80% since v6.0 was released.
</Para> </Para>
</ListItem> </ListItem>
</ItemizedList> </ItemizedList>
</Para>
</Sect2> </Sect2>
</sect1> </sect1>
\ No newline at end of file
doc/src/sgml/info.sgml
View file @ a75f2d21
...@@ -3,6 +3,7 @@ ...@@ -3,6 +3,7 @@
<Para> <Para>
This manual set is organized into several parts: This manual set is organized into several parts:
</Para>
<VariableList> <VariableList>
<VarListEntry> <VarListEntry>
...@@ -69,6 +70,7 @@ Currently included in the <citetitle>User's Guide</citetitle>. ...@@ -69,6 +70,7 @@ Currently included in the <citetitle>User's Guide</citetitle>.
<Para> <Para>
In addition to this manual set, there are other resources to help you with In addition to this manual set, there are other resources to help you with
<ProductName>Postgres</ProductName> installation and use: <ProductName>Postgres</ProductName> installation and use:
</Para>
<VariableList> <VariableList>
<VarListEntry> <VarListEntry>
......
doc/src/sgml/inherit.sgml
View file @ a75f2d21
...@@ -51,6 +51,7 @@ SELECT name, altitude ...@@ -51,6 +51,7 @@ SELECT name, altitude
|Mariposa | 1953 | |Mariposa | 1953 |
+----------+----------+ +----------+----------+
</ProgramListing> </ProgramListing>
</para>
<Para> <Para>
On the other hand, to find the names of all cities, On the other hand, to find the names of all cities,
......
doc/src/sgml/install.sgml
View file @ a75f2d21
...@@ -44,7 +44,7 @@ The runtime path is <filename>/usr/local/pgsql</filename> (other paths are possi ...@@ -44,7 +44,7 @@ The runtime path is <filename>/usr/local/pgsql</filename> (other paths are possi
</Para> </Para>
</ListItem> </ListItem>
</ItemizedList> </ItemizedList>
</para>
<Para> <Para>
Commands were tested on RedHat Linux version 4.2 using the tcsh shell. Commands were tested on RedHat Linux version 4.2 using the tcsh shell.
Except where noted, they will probably work on most systems. Commands Except where noted, they will probably work on most systems. Commands
...@@ -74,14 +74,14 @@ http://www.postgresql.org/docs/admin/install.htm</ulink>. ...@@ -74,14 +74,14 @@ http://www.postgresql.org/docs/admin/install.htm</ulink>.
In general, most Unix-compatible In general, most Unix-compatible
platforms with modern libraries should be able to run <ProductName>Postgres</ProductName>. platforms with modern libraries should be able to run <ProductName>Postgres</ProductName>.
</para>
<para> <para>
Although the minimum required memory for running <ProductName>Postgres</ProductName> Although the minimum required memory for running <ProductName>Postgres</ProductName>
is as little as 8MB, there are noticable improvements in runtimes for the regression is as little as 8MB, there are noticable improvements in runtimes for the regression
tests when expanding memory up to 96MB on a relatively fast dual-processor system tests when expanding memory up to 96MB on a relatively fast dual-processor system
running X-Windows. running X-Windows.
The rule is you can never have too much memory. The rule is you can never have too much memory.
</para>
<Para> <Para>
Check that you have sufficient disk space. You will need about Check that you have sufficient disk space. You will need about
30 Mbytes for <filename>/usr/src/pgsql</filename>, 30 Mbytes for <filename>/usr/src/pgsql</filename>,
...@@ -107,13 +107,12 @@ about 5 Mbytes for <filename>/usr/local/pgsql</filename> ...@@ -107,13 +107,12 @@ about 5 Mbytes for <filename>/usr/local/pgsql</filename>
<programlisting> <programlisting>
$ df -k $ df -k
</programlisting> </programlisting>
</para>
</Sect1> </Sect1>
<Sect1> <Sect1>
<Title>Installation Procedure</Title> <Title>Installation Procedure</Title>
<Para>
<Procedure> <Procedure>
<Title><ProductName>Postgres</ProductName> Installation</Title> <Title><ProductName>Postgres</ProductName> Installation</Title>
...@@ -151,19 +150,20 @@ Read any last minute information and platform specific porting ...@@ -151,19 +150,20 @@ Read any last minute information and platform specific porting
<Para> <Para>
Create the <ProductName>Postgres</ProductName> superuser account Create the <ProductName>Postgres</ProductName> superuser account
(<literal>postgres</literal> is commonly used) if it does not already exist. (<literal>postgres</literal> is commonly used) if it does not already exist.
</para>
<para> <para>
The owner of the Postgres files can be any unprivileged user account. The owner of the Postgres files can be any unprivileged user account.
It <emphasis>must not</emphasis> be <literal>root</literal>, <literal>bin</literal>, It <emphasis>must not</emphasis> be <literal>root</literal>, <literal>bin</literal>,
or any other account with special access rights, as that would create a security risk. or any other account with special access rights, as that would create a security risk.
</para>
</Step> </Step>
<Step Performance="required"> <Step Performance="required">
<Para> <Para>
Log in to the <ProductName>Postgres</ProductName> superuser account. Most of the Log in to the <ProductName>Postgres</ProductName> superuser account. Most of the
remaining steps in the installation will happen in this account. remaining steps in the installation will happen in this account.
</para>
</step>
<Step Performance="required"> <Step Performance="required">
<Para> <Para>
Ftp file Ftp file
...@@ -244,12 +244,13 @@ If you are upgrading an existing system then back up your database. ...@@ -244,12 +244,13 @@ If you are upgrading an existing system then back up your database.
in the HACKERS mailing list. Full releases always require a dump/reload in the HACKERS mailing list. Full releases always require a dump/reload
from previous releases. It is therefore a bad idea to skip this from previous releases. It is therefore a bad idea to skip this
step. step.
</para>
<tip> <tip>
<para> <para>
Do not use the <application>pg_dumpall</application> Do not use the <application>pg_dumpall</application>
script from v6.0 or everything script from v6.0 or everything
will be owned by the <ProductName>Postgres</ProductName> super user. will be owned by the <ProductName>Postgres</ProductName> super user.
</para>
</tip> </tip>
<para> <para>
...@@ -258,7 +259,7 @@ To dump your fairly recent post-v6.0 database installation, type ...@@ -258,7 +259,7 @@ To dump your fairly recent post-v6.0 database installation, type
<programlisting> <programlisting>
$ pg_dumpall -z > db.out $ pg_dumpall -z > db.out
</programlisting> </programlisting>
</para>
<para> <para>
To use the latest <application>pg_dumpall</application> script on your To use the latest <application>pg_dumpall</application> script on your
existing older database before upgrading <productname>Postgres</productname>, existing older database before upgrading <productname>Postgres</productname>,
...@@ -341,6 +342,7 @@ Linux system I can type ...@@ -341,6 +342,7 @@ Linux system I can type
$ /etc/rc.d/init.d/postgres.init stop $ /etc/rc.d/init.d/postgres.init stop
</programlisting> </programlisting>
to halt <productname>Postgres</productname>. to halt <productname>Postgres</productname>.
</para>
</tip> </tip>
</Para> </Para>
</Step> </Step>
...@@ -379,12 +381,14 @@ $ exit ...@@ -379,12 +381,14 @@ $ exit
<Para> <Para>
Make new source and install directories. The actual paths can be Make new source and install directories. The actual paths can be
different for your installation but you must be consistant throughout this procedure. different for your installation but you must be consistant throughout this procedure.
</para>
<note> <note>
<para> <para>
There are two places in this installation procedure where you will have an opportunity There are two places in this installation procedure where you will have an opportunity
to specify installation locations for programs, libraries, documentation, and other files. to specify installation locations for programs, libraries, documentation, and other files.
Usually it is sufficient to specify these at the <command>make install</command> stage Usually it is sufficient to specify these at the <command>make install</command> stage
of installation. of installation.
</para>
</note> </note>
<para> <para>
...@@ -443,10 +447,11 @@ If your system is not automatically recognized by configure and you have to do t ...@@ -443,10 +447,11 @@ If your system is not automatically recognized by configure and you have to do t
send email to send email to
<ulink url="mailto:scrappy@hub.org">scrappy@hub.org</ulink> with the output of the program <ulink url="mailto:scrappy@hub.org">scrappy@hub.org</ulink> with the output of the program
<application>./config.guess</application>. Indicate what the template file should be. <application>./config.guess</application>. Indicate what the template file should be.
</para>
</note> </note>
</Para> </Para>
</step>
<Step Performance="optional"> <Step Performance="optional">
<Para> <Para>
Choose configuration options. Check <xref linkend="config" endterm="install-config"> Choose configuration options. Check <xref linkend="config" endterm="install-config">
...@@ -488,7 +493,7 @@ extra options specified. ...@@ -488,7 +493,7 @@ extra options specified.
present.) present.)
</ProgramListing> </ProgramListing>
</Para> </Para>
</step>
<Step Performance="required"> <Step Performance="required">
<Para> <Para>
Here is the configure script used on a Sparc Solaris 2.5 system Here is the configure script used on a Sparc Solaris 2.5 system
...@@ -505,13 +510,14 @@ $ ./configure --prefix=/opt/postgres \ ...@@ -505,13 +510,14 @@ $ ./configure --prefix=/opt/postgres \
<para> <para>
Of course, you may type these three lines all Of course, you may type these three lines all
on the same line. on the same line.
</para>
</tip> </tip>
</Para> </Para>
</Step> </Step>
</substeps> </substeps>
</step>
<Step Performance="required"> <Step Performance="required">
<Para> <Para>
Install the <application>man</application> and Install the <application>man</application> and
...@@ -521,11 +527,12 @@ Install the <application>man</application> and ...@@ -521,11 +527,12 @@ Install the <application>man</application> and
$ cd /usr/src/pgsql/doc $ cd /usr/src/pgsql/doc
$ gmake install $ gmake install
</ProgramListing> </ProgramListing>
</para>
<para> <para>
The documentation is also available in Postscript format. Look for files The documentation is also available in Postscript format. Look for files
ending with <filename>.ps.gz</filename> in the same directory. ending with <filename>.ps.gz</filename> in the same directory.
</para>
</step>
<Step Performance="required"> <Step Performance="required">
<Para> <Para>
Compile the program. Type Compile the program. Type
...@@ -553,8 +560,9 @@ All of PostgreSQL is successfully made. Ready to install. ...@@ -553,8 +560,9 @@ All of PostgreSQL is successfully made. Ready to install.
You will probably find a number of warning You will probably find a number of warning
messages in make.log. Unless you have problems later on, these messages in make.log. Unless you have problems later on, these
messages may be safely ignored. messages may be safely ignored.
</para>
</note> </note>
</para>
<Para> <Para>
If the compiler fails with a message stating that If the compiler fails with a message stating that
the <application>flex</application> command the <application>flex</application> command
...@@ -603,7 +611,7 @@ At this point, or earlier if you wish, ...@@ -603,7 +611,7 @@ At this point, or earlier if you wish,
<Para> <Para>
If necessary, tell your system how to find the new shared libraries. You can If necessary, tell your system how to find the new shared libraries. You can
do <emphasis>one</emphasis> of the following, preferably the first: do <emphasis>one</emphasis> of the following, preferably the first:
</para>
<SubSteps> <SubSteps>
<Step Performance="optional"> <Step Performance="optional">
<Para> <Para>
...@@ -629,6 +637,7 @@ to the file. Then run command <Command>/sbin/ldconfig</Command>. ...@@ -629,6 +637,7 @@ to the file. Then run command <Command>/sbin/ldconfig</Command>.
<ProgramListing> <ProgramListing>
setenv LD_LIBRARY_PATH /usr/local/pgsql/lib setenv LD_LIBRARY_PATH /usr/local/pgsql/lib
</ProgramListing> </ProgramListing>
</para>
</Step> </Step>
</SubSteps> </SubSteps>
...@@ -648,93 +657,94 @@ pg_id: can't load library 'libpq.so' ...@@ -648,93 +657,94 @@ pg_id: can't load library 'libpq.so'
</Para> </Para>
</Step> </Step>
<Step Performance="optional"> <Step Performance="optional">
<Para> <Para>
If you used the <option>--with-perl</option> option to configure, check If you used the <option>--with-perl</option> option to configure, check
the install log to see whether the Perl module was actually installed. the install log to see whether the Perl module was actually installed.
If you've followed our advice to make the Postgres files be owned by If you've followed our advice to make the Postgres files be owned by
an unprivileged userid, then the Perl module won't have been installed, an unprivileged userid, then the Perl module won't have been installed,
for lack of write privileges on the Perl library directories. You can for lack of write privileges on the Perl library directories. You can
complete its installation, either now or later, by becoming the user that complete its installation, either now or later, by becoming the user that
does own the Perl library (often root) (via <command>su</command>) and doing does own the Perl library (often root) (via <command>su</command>) and doing
<ProgramListing> <ProgramListing>
$ cd /usr/src/pgsql/src/interfaces/perl5 $ cd /usr/src/pgsql/src/interfaces/perl5
$ gmake install $ gmake install
</ProgramListing> </ProgramListing>
</Para> </Para>
</Step> </Step>
<Step Performance="required"> <Step Performance="required">
<Para> <Para>
If it has not already been done, then prepare account <literal>postgres</literal> If it has not already been done, then prepare account <literal>postgres</literal>
for using <ProductName>Postgres</ProductName>. for using <ProductName>Postgres</ProductName>.
Any account that will use <ProductName>Postgres</ProductName> must Any account that will use <ProductName>Postgres</ProductName> must
be similarly prepared. be similarly prepared.
</para>
<para> <para>
There are several ways to influence the runtime environment of the There are several ways to influence the runtime environment of the
<ProductName>Postgres</ProductName> <ProductName>Postgres</ProductName>
server. Refer to the <citetitle>Administrator's Guide</citetitle> server. Refer to the <citetitle>Administrator's Guide</citetitle>
for more information. for more information.
<note>
<note> <para>
<para> The following instructions are for a
The following instructions are for a bash/sh shell. Adapt accordingly for other shells.
bash/sh shell. Adapt accordingly for other shells. </para>
</note> </note>
</Para>
</Para>
<substeps>
<substeps>
<Step Performance="required">
<Step Performance="required"> <Para>
<Para> Add the following lines to your login environment:
Add the following lines to your login environment:
shell, <filename>~/.bash_profile</filename>:
shell, <filename>~/.bash_profile</filename>: <ProgramListing>
<ProgramListing> PATH=$PATH:/usr/local/pgsql/bin
PATH=$PATH:/usr/local/pgsql/bin MANPATH=$MANPATH:/usr/local/pgsql/man
MANPATH=$MANPATH:/usr/local/pgsql/man PGLIB=/usr/local/pgsql/lib
PGLIB=/usr/local/pgsql/lib PGDATA=/usr/local/pgsql/data
PGDATA=/usr/local/pgsql/data export PATH MANPATH PGLIB PGDATA
export PATH MANPATH PGLIB PGDATA </ProgramListing>
</ProgramListing> </Para>
</Para> </step>
<Step Performance="required">
<Step Performance="required"> <para>
<para> Several regression tests could failed if the user's locale collation
Several regression tests could failed if the user's locale collation scheme is different from that of standard C locale.
scheme is different from that of standard C locale. </para>
<para>
<para> If you configure and compile <ProductName>Postgres</ProductName>
If you configure and compile <ProductName>Postgres</ProductName> with the <option>--enable-locale</option> option then
with the <option>--enable-locale</option> option then set locale environment to C (or unset all LC_* variables)
set locale environment to C (or unset all LC_* variables) by putting these additional lines to your login environment
by putting these additional lines to your login environment before starting postmaster:
before starting postmaster: <ProgramListing>
<ProgramListing> LC_COLLATE=C
LC_COLLATE=C LC_CTYPE=C
LC_CTYPE=C LC_COLLATE=C
LC_COLLATE=C export LC_COLLATE LC_CTYPE LC_COLLATE
export LC_COLLATE LC_CTYPE LC_COLLATE </ProgramListing>
</ProgramListing>
<ProgramListing>
<ProgramListing>
</ProgramListing>
</ProgramListing> </para>
</step>
<Step Performance="required"> <Step Performance="required">
<Para> <Para>
Make sure that you have defined these variables before continuing Make sure that you have defined these variables before continuing
with the remaining steps. The easiest way to do this is to type: with the remaining steps. The easiest way to do this is to type:
<ProgramListing> <ProgramListing>
$ source ~/.bash_profile $ source ~/.bash_profile
</ProgramListing> </ProgramListing>
</Para> </Para>
</Step> </Step>
</substeps> </substeps>
</step>
<Step Performance="required"> <Step Performance="required">
<Para> <Para>
...@@ -768,7 +778,7 @@ $ initdb ...@@ -768,7 +778,7 @@ $ initdb
<para> <para>
Briefly test that the backend will start and run by running it from Briefly test that the backend will start and run by running it from
the command line. the command line.
</para>
<substeps> <substeps>
<Step Performance="required"> <Step Performance="required">
...@@ -787,55 +797,60 @@ Create a database by typing ...@@ -787,55 +797,60 @@ Create a database by typing
<ProgramListing> <ProgramListing>
$ createdb $ createdb
</ProgramListing> </ProgramListing>
</para>
</step>
<Step Performance="required"> <Step Performance="required">
<para> <para>
Connect to the new database: Connect to the new database:
<ProgramListing> <ProgramListing>
$ psql $ psql
</ProgramListing> </ProgramListing>
</para>
</step>
<Step Performance="required"> <Step Performance="required">
<para> <para>
And run a sample query: And run a sample query:
<ProgramListing> <ProgramListing>
postgres=> SELECT datetime 'now'; postgres=> SELECT datetime 'now';
</ProgramListing> </ProgramListing>
</para>
</step>
<Step Performance="required"> <Step Performance="required">
<para> <para>
Exit <application>psql</application>: Exit <application>psql</application>:
<ProgramListing> <ProgramListing>
postgres=> \q postgres=> \q
</ProgramListing> </ProgramListing>
</para>
</step>
<Step Performance="required"> <Step Performance="required">
<para> <para>
Remove the test database (unless you will want to use it later for other tests): Remove the test database (unless you will want to use it later for other tests):
<ProgramListing> <ProgramListing>
$ destroydb $ destroydb
</ProgramListing> </ProgramListing>
</para>
</step>
</substeps> </substeps>
</step>
<Step Performance="required"> <Step Performance="required">
<Para> <Para>
Run postmaster in the background from your <ProductName>Postgres</ProductName> Run postmaster in the background from your <ProductName>Postgres</ProductName>
superuser account (typically account <literal>postgres</literal>). superuser account (typically account <literal>postgres</literal>).
<emphasis>Do not run <application>postmaster</application> <emphasis>Do not run <application>postmaster</application>
from the root account!</emphasis> from the root account!</emphasis>
</para>
<Para> <Para>
Usually, you will want to modify Usually, you will want to modify
your computer so that it will automatically start postmaster whenever your computer so that it will automatically start postmaster whenever
it boots. It is not required; the <ProductName>Postgres</ProductName> it boots. It is not required; the <ProductName>Postgres</ProductName>
server can server can
be run successfully from non-privileged accounts without root intervention. be run successfully from non-privileged accounts without root intervention.
</para>
<para> <para>
Here are some suggestions on how to do this, contributed by various Here are some suggestions on how to do this, contributed by various
users. users.
</para>
<para> <para>
Whatever you do, postmaster must be run by Whatever you do, postmaster must be run by
the <ProductName>Postgres</ProductName> superuser (<literal>postgres</literal>?) the <ProductName>Postgres</ProductName> superuser (<literal>postgres</literal>?)
...@@ -856,7 +871,8 @@ start the <application>postmaster</application> and send it to the background: ...@@ -856,7 +871,8 @@ start the <application>postmaster</application> and send it to the background:
$ cd $ cd
$ nohup postmaster > regress.log 2>&1 & $ nohup postmaster > regress.log 2>&1 &
</ProgramListing> </ProgramListing>
</para>
</listitem>
<listitem> <listitem>
<para> <para>
Edit file rc.local on NetBSD or file rc2.d on SPARC Solaris Edit file rc.local on NetBSD or file rc2.d on SPARC Solaris
...@@ -864,6 +880,8 @@ Edit file rc.local on NetBSD or file rc2.d on SPARC Solaris ...@@ -864,6 +880,8 @@ Edit file rc.local on NetBSD or file rc2.d on SPARC Solaris
<programlisting> <programlisting>
su postgres -c "/usr/local/pgsql/bin/postmaster -S -D /usr/local/pgsql/data" su postgres -c "/usr/local/pgsql/bin/postmaster -S -D /usr/local/pgsql/data"
</programlisting> </programlisting>
</para>
</listitem>
<listitem> <listitem>
<para> <para>
...@@ -885,6 +903,8 @@ In FreeBSD 2.2-RELEASE edit /usr/local/etc/rc.d/pgsql.sh to ...@@ -885,6 +903,8 @@ In FreeBSD 2.2-RELEASE edit /usr/local/etc/rc.d/pgsql.sh to
enough to keep parsing beyond end-of-line if there is an enough to keep parsing beyond end-of-line if there is an
expression unfinished. The exec saves one layer of shell under expression unfinished. The exec saves one layer of shell under
the postmaster process so the parent is init. the postmaster process so the parent is init.
</para>
</listitem>
<listitem> <listitem>
<para> <para>
...@@ -892,6 +912,8 @@ In RedHat Linux add a file <filename>/etc/rc.d/init.d/postgres.init</filename> ...@@ -892,6 +912,8 @@ In RedHat Linux add a file <filename>/etc/rc.d/init.d/postgres.init</filename>
which is based on the example in <filename>contrib/linux/</filename>. which is based on the example in <filename>contrib/linux/</filename>.
Then make a softlink to this file from Then make a softlink to this file from
<filename>/etc/rc.d/rc5.d/S98postgres.init</filename>. <filename>/etc/rc.d/rc5.d/S98postgres.init</filename>.
</para>
</listitem>
<listitem> <listitem>
<para> <para>
...@@ -907,6 +929,8 @@ pg:2345:respawn:/bin/su - postgres -c ...@@ -907,6 +929,8 @@ pg:2345:respawn:/bin/su - postgres -c
(The author of this example says this example will revive the (The author of this example says this example will revive the
postmaster if it dies, but he doesn't know if there are other side postmaster if it dies, but he doesn't know if there are other side
effects.) effects.)
</para>
</listitem>
</itemizedlist> </itemizedlist>
...@@ -967,6 +991,7 @@ For example, ...@@ -967,6 +991,7 @@ For example,
For a i686/Linux-ELF platform, no tests failed since this is the For a i686/Linux-ELF platform, no tests failed since this is the
v6.4 regression testing reference platform. v6.4 regression testing reference platform.
</Para> </Para>
</listitem>
<listitem> <listitem>
<Para> <Para>
...@@ -976,8 +1001,10 @@ For example, ...@@ -976,8 +1001,10 @@ For example,
floating point numbers. select_views produces massively different output, floating point numbers. select_views produces massively different output,
but the differences are due to minor floating point differences. but the differences are due to minor floating point differences.
</Para> </Para>
</itemizedlist> </listitem>
</itemizedlist>
</para>
<Para> <Para>
Even if a test result clearly indicates a real failure, it may be a Even if a test result clearly indicates a real failure, it may be a
localized problem that will not affect you. An example is that the localized problem that will not affect you. An example is that the
...@@ -1009,13 +1036,13 @@ $ gmake clean ...@@ -1009,13 +1036,13 @@ $ gmake clean
</Step> </Step>
</substeps> </substeps>
</step>
<Step Performance="required"> <Step Performance="required">
<Para> <Para>
If you haven't already done so, this would be a good time to modify If you haven't already done so, this would be a good time to modify
your computer to do regular maintainence. The following should be your computer to do regular maintainence. The following should be
done at regular intervals: done at regular intervals:
</para>
<procedure> <procedure>
<title>Minimal Backup Procedure</title> <title>Minimal Backup Procedure</title>
...@@ -1023,13 +1050,15 @@ $ gmake clean ...@@ -1023,13 +1050,15 @@ $ gmake clean
<para> <para>
Run the <acronym>SQL</acronym> command <command>VACUUM</command>. Run the <acronym>SQL</acronym> command <command>VACUUM</command>.
This will clean up your database. This will clean up your database.
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Back up your system. (You should probably keep the last few Back up your system. (You should probably keep the last few
backups on hand.) Preferably, no one else should be using the backups on hand.) Preferably, no one else should be using the
system at the time. system at the time.
</para>
</step>
</procedure> </procedure>
<para> <para>
...@@ -1100,7 +1129,7 @@ simply type ...@@ -1100,7 +1129,7 @@ simply type
$ cd /usr/local/pgsql/doc $ cd /usr/local/pgsql/doc
$ gunzip user.ps.tz | lpr $ gunzip user.ps.tz | lpr
</programlisting> </programlisting>
</para>
<para> <para>
Here is how Here is how
you might do it if you have Ghostscript on your system and are you might do it if you have Ghostscript on your system and are
...@@ -1114,7 +1143,7 @@ $ gshp -sOUTPUTFILE=user.hp user.ps ...@@ -1114,7 +1143,7 @@ $ gshp -sOUTPUTFILE=user.hp user.ps
$ gzip user.ps $ gzip user.ps
$ lpr -l -s -r manpage.hp $ lpr -l -s -r manpage.hp
</programlisting> </programlisting>
</para>
</Step> </Step>
<Step Performance="required"> <Step Performance="required">
...@@ -1132,14 +1161,20 @@ $ lpr -l -s -r manpage.hp ...@@ -1132,14 +1161,20 @@ $ lpr -l -s -r manpage.hp
<listitem> <listitem>
<para> <para>
The version of <ProductName>Postgres</ProductName> (v6.4, 6.3.2, beta 981014, etc.). The version of <ProductName>Postgres</ProductName> (v6.4, 6.3.2, beta 981014, etc.).
</para>
</listitem>
<listitem> <listitem>
<para> <para>
Your operating system (i.e. RedHat v5.1 Linux v2.0.34). Your operating system (i.e. RedHat v5.1 Linux v2.0.34).
</para>
</listitem>
<listitem> <listitem>
<para> <para>
Your hardware (SPARC, i486, etc.). Your hardware (SPARC, i486, etc.).
</para>
</listitem>
<listitem> <listitem>
<para> <para>
...@@ -1148,6 +1183,8 @@ Did you compile, install and run the regression tests cleanly? ...@@ -1148,6 +1183,8 @@ Did you compile, install and run the regression tests cleanly?
applied, changes you made, etc.), what tests failed, etc. applied, changes you made, etc.), what tests failed, etc.
It is normal to get many warning when you compile. You do It is normal to get many warning when you compile. You do
not need to report these. not need to report these.
</para>
</listitem>
</itemizedlist> </itemizedlist>
...@@ -1161,6 +1198,7 @@ Did you compile, install and run the regression tests cleanly? ...@@ -1161,6 +1198,7 @@ Did you compile, install and run the regression tests cleanly?
</Para> </Para>
</Step> </Step>
</Procedure> </Procedure>
</sect1>
<Sect1> <Sect1>
<Title>Playing with <ProductName>Postgres</ProductName></Title> <Title>Playing with <ProductName>Postgres</ProductName></Title>
...@@ -1282,41 +1320,42 @@ the source distribution. For some ports, the notes below may be out of date. ...@@ -1282,41 +1320,42 @@ the source distribution. For some ports, the notes below may be out of date.
</Para> </Para>
</Note> </Note>
<Sect2> <Sect2>
<Title>Ultrix4.x</Title> <Title>Ultrix4.x</Title>
<para> <para>
<note> <note>
<para> <para>
There have been no recent reports of Ultrix usage with <productname>Postgres</productname>. There have been no recent reports of Ultrix usage with <productname>Postgres</productname>.
</note> </para>
</note>
<para> </para>
You need to install the libdl-1.1 package since Ultrix 4.x doesn't <para>
have a dynamic loader. It's available in You need to install the libdl-1.1 package since Ultrix 4.x doesn't
s2k-ftp.CS.Berkeley.EDU:pub/personal/andrew/libdl-1.1.tar.Z have a dynamic loader. It's available in
</Para> s2k-ftp.CS.Berkeley.EDU:pub/personal/andrew/libdl-1.1.tar.Z
</Sect2> </Para>
</Sect2>
<Sect2>
<Title>Linux</Title> <Sect2>
<Title>Linux</Title>
<Sect3>
<Sect3Info> <Sect3>
<Author> <Sect3Info>
<FirstName>Thomas G.</FirstName> <Author>
<SurName>Lockhart</SurName> <FirstName>Thomas G.</FirstName>
</Author> <SurName>Lockhart</SurName>
<Date>1998-02-19</Date> </Author>
</Sect3Info> <Date>1998-02-19</Date>
<Title>Linux ELF</Title> </Sect3Info>
<Title>Linux ELF</Title>
<Para>
The regression test reference machine is <Para>
a linux-2.0.30/libc-5.3.12/RedHat-4.2 installation running on a dual processor i686. The regression test reference machine is
The linux-elf port installs cleanly. See the Linux FAQ for more details. a linux-2.0.30/libc-5.3.12/RedHat-4.2 installation running on a dual processor i686.
</Para> The linux-elf port installs cleanly. See the Linux FAQ for more details.
</Sect3> </Para>
</Sect3>
<Sect3> <Sect3>
<Sect3Info> <Sect3Info>
...@@ -1353,7 +1392,7 @@ The linux-elf port installs cleanly. See the Linux FAQ for more details. ...@@ -1353,7 +1392,7 @@ The linux-elf port installs cleanly. See the Linux FAQ for more details.
a product so contact him for information. He has also indicated that a product so contact him for information. He has also indicated that
binary releases of <ProductName>Postgres</ProductName> for NEXTSTEP will be made available to binary releases of <ProductName>Postgres</ProductName> for NEXTSTEP will be made available to
the general public. Contact Info@RnA.nl for information. the general public. Contact Info@RnA.nl for information.
</para>
<Para> <Para>
We have no recent reports of successful NeXT installations (as of v6.2.1). We have no recent reports of successful NeXT installations (as of v6.2.1).
However, the client-side libraries should work even However, the client-side libraries should work even
......
doc/src/sgml/intro.sgml
View file @ a75f2d21
...@@ -65,6 +65,7 @@ are not as well suited to supporting the traditional relational database languag ...@@ -65,6 +65,7 @@ are not as well suited to supporting the traditional relational database languag
So, although <ProductName>Postgres</ProductName> has some object-oriented features, So, although <ProductName>Postgres</ProductName> has some object-oriented features,
it is firmly in the relational database world. In fact, some commercial databases it is firmly in the relational database world. In fact, some commercial databases
have recently incorporated features pioneered by <ProductName>Postgres</ProductName>. have recently incorporated features pioneered by <ProductName>Postgres</ProductName>.
</Para>
</Sect1> </Sect1>
......
doc/src/sgml/jdbc.sgml
View file @ a75f2d21
...@@ -7,24 +7,26 @@ ...@@ -7,24 +7,26 @@
<para> <para>
Written by <ulink url="peter@retep.org.uk">Peter T. Mount</ulink>, the Written by <ulink url="peter@retep.org.uk">Peter T. Mount</ulink>, the
author of the <acronym>JDBC</acronym> driver. author of the <acronym>JDBC</acronym> driver.
</para>
</note> </note>
</para>
<para> <para>
<acronym>JDBC</acronym> is a core <acronym>API</acronym> of Java 1.1 and later. <acronym>JDBC</acronym> is a core <acronym>API</acronym> of Java 1.1 and later.
It provides a standard set of It provides a standard set of
interfaces to <acronym>SQL</acronym>-compliant databases. interfaces to <acronym>SQL</acronym>-compliant databases.
</para>
<para> <para>
<application>Postgres</application> provides <application>Postgres</application> provides
a type 4 <acronym>JDBC</acronym> Driver. Type 4 indicates that the driver a type 4 <acronym>JDBC</acronym> Driver. Type 4 indicates that the driver
is written in Pure Java, and communicates in the database's own network is written in Pure Java, and communicates in the database's own network
protocol. Because of this, the driver is platform independent. Once compiled, protocol. Because of this, the driver is platform independent. Once compiled,
the driver can be used on any platform. the driver can be used on any platform.
</para>
<sect1> <sect1>
<title>Building the <acronym>JDBC</acronym> Interface</title> <title>Building the <acronym>JDBC</acronym> Interface</title>
<para>
<sect2> <sect2>
<title>Compiling the Driver</title> <title>Compiling the Driver</title>
...@@ -36,6 +38,7 @@ source tree. To compile simply change directory to that directory, and type: ...@@ -36,6 +38,7 @@ source tree. To compile simply change directory to that directory, and type:
<programlisting> <programlisting>
% make % make
</programlisting> </programlisting>
</para>
<para> <para>
Upon completion, you will find the archive <filename>postgresql.jar</filename> Upon completion, you will find the archive <filename>postgresql.jar</filename>
...@@ -50,7 +53,10 @@ as the driver uses some dynamic ...@@ -50,7 +53,10 @@ as the driver uses some dynamic
loading techniques for performance reasons, loading techniques for performance reasons,
and <application>javac</application> cannot cope. and <application>javac</application> cannot cope.
The <filename>Makefile</filename> will generate the jar archive. The <filename>Makefile</filename> will generate the jar archive.
</para>
</note> </note>
</para>
</sect2>
<sect2> <sect2>
<title>Installing the Driver</title> <title>Installing the Driver</title>
...@@ -58,22 +64,29 @@ The <filename>Makefile</filename> will generate the jar archive. ...@@ -58,22 +64,29 @@ The <filename>Makefile</filename> will generate the jar archive.
<para> <para>
To use the driver, the jar archive postgresql.jar needs to be included in To use the driver, the jar archive postgresql.jar needs to be included in
the CLASSPATH. the CLASSPATH.
</para>
<para> <para>
Example: Example:
</para>
<para> <para>
I have an application that uses the <acronym>JDBC</acronym> driver to access a large database I have an application that uses the <acronym>JDBC</acronym> driver to access a large database
containing astronomical objects. I have the application and the jdbc driver containing astronomical objects. I have the application and the jdbc driver
installed in the /usr/local/lib directory, and the java jdk installed in /usr/local/jdk1.1.6. installed in the /usr/local/lib directory, and the java jdk installed in /usr/local/jdk1.1.6.
</para>
<para> <para>
To run the application, I would use: To run the application, I would use:
</para>
<para> <para>
export CLASSPATH = \ export CLASSPATH = \
/usr/local/lib/finder.jar:/usr/local/lib/postgresql.jar:. /usr/local/lib/finder.jar:/usr/local/lib/postgresql.jar:.
java uk.org.retep.finder.Main java uk.org.retep.finder.Main
</para>
<para> <para>
Loading the driver is covered later on in this chapter. Loading the driver is covered later on in this chapter.
<para> </para>
</sect2>
</sect1>
<sect1> <sect1>
<title>Preparing the Database for <acronym>JDBC</acronym></title> <title>Preparing the Database for <acronym>JDBC</acronym></title>
...@@ -81,22 +94,26 @@ Loading the driver is covered later on in this chapter. ...@@ -81,22 +94,26 @@ Loading the driver is covered later on in this chapter.
<para> <para>
Because Java can only use TCP/IP connections, the <application>Postgres</application> postmaster Because Java can only use TCP/IP connections, the <application>Postgres</application> postmaster
must be running with the -i flag. must be running with the -i flag.
</para>
<para> <para>
Also, the <filename>pg_hba.conf</filename> file must be configured. It's located in the PGDATA Also, the <filename>pg_hba.conf</filename> file must be configured. It's located in the PGDATA
directory. In a default installation, this file permits access only by UNIX directory. In a default installation, this file permits access only by UNIX
domain sockets. For the <acronym>JDBC</acronym> driver to connect to the same localhost, you need domain sockets. For the <acronym>JDBC</acronym> driver to connect to the same localhost, you need
to add something like: to add something like:
</para>
<para> <para>
host all 127.0.0.1 255.255.255.255 password host all 127.0.0.1 255.255.255.255 password
</para>
<para> <para>
Here access to all databases are possible from the local machine Here access to all databases are possible from the local machine
with <acronym>JDBC</acronym>. with <acronym>JDBC</acronym>.
</para>
<para> <para>
The <acronym>JDBC</acronym> Driver supports trust, ident, The <acronym>JDBC</acronym> Driver supports trust, ident,
password and crypt authentication methods. password and crypt authentication methods.
</para>
<para> </sect1>
<sect1> <sect1>
<title>Using the Driver</title> <title>Using the Driver</title>
...@@ -106,10 +123,12 @@ This section is not intended as a complete guide to ...@@ -106,10 +123,12 @@ This section is not intended as a complete guide to
<acronym>JDBC</acronym> programming, but <acronym>JDBC</acronym> programming, but
should help to get you started. For more information refer to the standard should help to get you started. For more information refer to the standard
<acronym>JDBC</acronym> <acronym>API</acronym> documentation. <acronym>JDBC</acronym> <acronym>API</acronym> documentation.
</para>
<para> <para>
Also, take a look at the examples included with the source. The basic Also, take a look at the examples included with the source. The basic
example is used here. example is used here.
<para> </para>
</sect1>
<sect1> <sect1>
<title>Importing <acronym>JDBC</acronym></title> <title>Importing <acronym>JDBC</acronym></title>
...@@ -126,7 +145,10 @@ import java.sql.*; ...@@ -126,7 +145,10 @@ import java.sql.*;
<para> <para>
Do not import the postgresql package. If you do, your source will not Do not import the postgresql package. If you do, your source will not
compile, as javac will get confused. compile, as javac will get confused.
</para>
</important> </important>
</para>
</sect1>
<sect1> <sect1>
<title>Loading the Driver</title> <title>Loading the Driver</title>
...@@ -134,6 +156,7 @@ compile, as javac will get confused. ...@@ -134,6 +156,7 @@ compile, as javac will get confused.
<para> <para>
Before you can connect to a database, you need to load the driver. There Before you can connect to a database, you need to load the driver. There
are two methods available, and it depends on your code to the best one to use. are two methods available, and it depends on your code to the best one to use.
</para>
<para> <para>
In the first method, your code implicitly loads the driver using the In the first method, your code implicitly loads the driver using the
...@@ -145,36 +168,43 @@ Class.forName(<literal>postgresql.Driver</literal>); ...@@ -145,36 +168,43 @@ Class.forName(<literal>postgresql.Driver</literal>);
This will load the driver, and while loading, the driver will automatically This will load the driver, and while loading, the driver will automatically
register itself with <acronym>JDBC</acronym>. register itself with <acronym>JDBC</acronym>.
</para>
<para> <para>
Note: The <function>forName()</function> method Note: The <function>forName()</function> method
can throw a ClassNotFoundException, so you will can throw a ClassNotFoundException, so you will
need to catch it if the driver is not available. need to catch it if the driver is not available.
</para>
<para> <para>
This is the most common method to use, but restricts your code to use just This is the most common method to use, but restricts your code to use just
<application>Postgres</application>. <application>Postgres</application>.
If your code may access another database in the future, and you If your code may access another database in the future, and you
don't use our extensions, then the second method is advisable. don't use our extensions, then the second method is advisable.
</para>
<para> <para>
The second method passes the driver as a parameter to the JVM as it starts, The second method passes the driver as a parameter to the JVM as it starts,
using the -D argument. using the -D argument.
</para>
<para> <para>
Example: Example:
<programlisting> <programlisting>
% java -Djdbc.drivers=postgresql.Driver example.ImageViewer % java -Djdbc.drivers=postgresql.Driver example.ImageViewer
</programlisting> </programlisting>
</para>
<para> <para>
In this example, the JVM will attempt to load the driver as part of it's In this example, the JVM will attempt to load the driver as part of it's
initialisation. Once done, the ImageViewer is started. initialisation. Once done, the ImageViewer is started.
</para>
<para> <para>
Now, this method is the better one to use because it allows your code to Now, this method is the better one to use because it allows your code to
be used with other databases, without recompiling the code. The only thing be used with other databases, without recompiling the code. The only thing
that would also change is the URL, which is covered next. that would also change is the URL, which is covered next.
</para>
<para> <para>
One last thing. When your code then tries to open a Connection, and you get One last thing. When your code then tries to open a Connection, and you get
...@@ -182,6 +212,8 @@ a <literal>No driver available</literal> SQLException being thrown, ...@@ -182,6 +212,8 @@ a <literal>No driver available</literal> SQLException being thrown,
this is probably this is probably
caused by the driver not being in the classpath, or the value in the parameter caused by the driver not being in the classpath, or the value in the parameter
not being correct. not being correct.
</para>
</sect1>
<sect1> <sect1>
<title>Connecting to the Database</title> <title>Connecting to the Database</title>
...@@ -196,14 +228,21 @@ forms: ...@@ -196,14 +228,21 @@ forms:
<listitem> <listitem>
<para> <para>
jdbc:postgresql:<replaceable class="parameter">database</replaceable> jdbc:postgresql:<replaceable class="parameter">database</replaceable>
</para>
</listitem>
<listitem> <listitem>
<para> <para>
jdbc:postgresql://<replaceable class="parameter">host</replaceable>/<replaceable class="parameter">database</replaceable> jdbc:postgresql://<replaceable class="parameter">host</replaceable>/<replaceable class="parameter">database</replaceable>
</para>
</listitem>
<listitem> <listitem>
<para> <para>
jdbc:postgresql://<replaceable class="parameter">host</replaceable>:<replaceable class="parameter">port</replaceable>/<replaceable class="parameter">database</replaceable> jdbc:postgresql://<replaceable class="parameter">host</replaceable>:<replaceable class="parameter">port</replaceable>/<replaceable class="parameter">database</replaceable>
</para>
</listitem>
</itemizedlist> </itemizedlist>
where: where:
...@@ -212,37 +251,49 @@ where: ...@@ -212,37 +251,49 @@ where:
<varlistentry> <varlistentry>
<term> <term>
<replaceable class="parameter">host</replaceable> <replaceable class="parameter">host</replaceable>
</term>
<listitem> <listitem>
<para> <para>
The hostname of the server. Defaults to "localhost". The hostname of the server. Defaults to "localhost".
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<replaceable class="parameter">port</replaceable> <replaceable class="parameter">port</replaceable>
</term>
<listitem> <listitem>
<para> <para>
The port number the server is listening on. Defaults to the Postgres The port number the server is listening on. Defaults to the Postgres
standard port number (5432). standard port number (5432).
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<replaceable class="parameter">database</replaceable> <replaceable class="parameter">database</replaceable>
</term>
<listitem> <listitem>
<para> <para>
The database name. The database name.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</para>
<para> <para>
To connect, you need to get a Connection instance from To connect, you need to get a Connection instance from
<acronym>JDBC</acronym>. To do this, <acronym>JDBC</acronym>. To do this,
you would use the DriverManager.getConnection() method: you would use the DriverManager.getConnection() method:
</para>
<para> <para>
Connection db = DriverManager.getConnection(url,user,pwd); Connection db = DriverManager.getConnection(url,user,pwd);
<para> </para>
</sect1>
<sect1> <sect1>
<title>Issuing a Query and Processing the Result</title> <title>Issuing a Query and Processing the Result</title>
...@@ -252,7 +303,7 @@ Any time you want to issue SQL statements to the database, you require a ...@@ -252,7 +303,7 @@ Any time you want to issue SQL statements to the database, you require a
Statement instance. Once you have a Statement, you can use the executeQuery() Statement instance. Once you have a Statement, you can use the executeQuery()
method to issue a query. This will return a ResultSet instance, which contains method to issue a query. This will return a ResultSet instance, which contains
the entire result. the entire result.
<para> </para>
<sect2> <sect2>
<title>Using the Statement Interface</title> <title>Using the Statement Interface</title>
...@@ -266,19 +317,26 @@ The following must be considered when using the Statement interface: ...@@ -266,19 +317,26 @@ The following must be considered when using the Statement interface:
You can use a Statement instance as many times as you want. You could You can use a Statement instance as many times as you want. You could
create one as soon as you open the connection, and use it for the connections create one as soon as you open the connection, and use it for the connections
lifetime. You have to remember that only one ResultSet can exist per Statement. lifetime. You have to remember that only one ResultSet can exist per Statement.
</para>
</listitem>
<listitem> <listitem>
<para> <para>
If you need to perform a query while processing a ResultSet, you can If you need to perform a query while processing a ResultSet, you can
simply create and use another Statement. simply create and use another Statement.
</para>
</listitem>
<listitem> <listitem>
<para> <para>
If you are using Threads, and several are using the database, you must If you are using Threads, and several are using the database, you must
use a separate Statement for each thread. Refer to the sections covering use a separate Statement for each thread. Refer to the sections covering
Threads and Servlets later in this document if you are thinking of using them, Threads and Servlets later in this document if you are thinking of using them,
as it covers some important points. as it covers some important points.
</para>
</listitem>
</itemizedlist> </itemizedlist>
</para>
</sect2>
<sect2> <sect2>
<title>Using the ResultSet Interface</title> <title>Using the ResultSet Interface</title>
...@@ -291,22 +349,31 @@ The following must be considered when using the ResultSet interface: ...@@ -291,22 +349,31 @@ The following must be considered when using the ResultSet interface:
<para> <para>
Before reading any values, you must call <function>next()</function>. This returns true if Before reading any values, you must call <function>next()</function>. This returns true if
there is a result, but more importantly, it prepares the row for processing. there is a result, but more importantly, it prepares the row for processing.
</para>
</listitem>
<listitem> <listitem>
<para> <para>
Under the <acronym>JDBC</acronym> spec, you should access a field only once. It's safest Under the <acronym>JDBC</acronym> spec, you should access a field only once. It's safest
to stick to this rule, although at the current time, the <application>Postgres</application> driver to stick to this rule, although at the current time, the <application>Postgres</application> driver
will allow you to access a field as many times as you want. will allow you to access a field as many times as you want.
</para>
</listitem>
<listitem> <listitem>
<para> <para>
You must close a ResultSet by calling <function>close()</function> once you have finished with it. You must close a ResultSet by calling <function>close()</function> once you have finished with it.
</para>
</listitem>
<listitem> <listitem>
<para> <para>
Once you request another query with the Statement used to create a Once you request another query with the Statement used to create a
ResultSet, the currently open instance is closed. ResultSet, the currently open instance is closed.
</para>
</listitem>
</itemizedlist> </itemizedlist>
</para>
<para> <para>
An example is as follows: An example is as follows:
...@@ -321,7 +388,9 @@ while(rs.next()) { ...@@ -321,7 +388,9 @@ while(rs.next()) {
rs.close(); rs.close();
st.close(); st.close();
</programlisting> </programlisting>
</para>
</sect2>
</sect1>
<sect1> <sect1>
<title>Performing Updates</title> <title>Performing Updates</title>
...@@ -333,7 +402,8 @@ result), you simply use the executeUpdate() method: ...@@ -333,7 +402,8 @@ result), you simply use the executeUpdate() method:
<programlisting> <programlisting>
st.executeUpdate(<literal>create table basic (a int2, b int2)</literal>); st.executeUpdate(<literal>create table basic (a int2, b int2)</literal>);
</programlisting> </programlisting>
</para>
</sect1>
<sect1> <sect1>
<title>Closing the Connection</title> <title>Closing the Connection</title>
...@@ -344,6 +414,8 @@ To close the database connection, simply call the close() method to the Connecti ...@@ -344,6 +414,8 @@ To close the database connection, simply call the close() method to the Connecti
<programlisting> <programlisting>
db.close(); db.close();
</programlisting> </programlisting>
</para>
</sect1>
<sect1> <sect1>
<title>Using Large Objects</title> <title>Using Large Objects</title>
...@@ -353,6 +425,7 @@ In <application>Postgres</application>, ...@@ -353,6 +425,7 @@ In <application>Postgres</application>,
large objects (also known as <firstterm>blobs</firstterm>) are used to hold data in large objects (also known as <firstterm>blobs</firstterm>) are used to hold data in
the database that cannot be stored in a normal SQL table. They are stored as a the database that cannot be stored in a normal SQL table. They are stored as a
Table/Index pair, and are refered to from your own tables, by an OID value. Table/Index pair, and are refered to from your own tables, by an OID value.
</para>
<para> <para>
Now, there are you methods of using Large Objects. The first is the Now, there are you methods of using Large Objects. The first is the
...@@ -360,11 +433,13 @@ standard <acronym>JDBC</acronym> way, and is documented here. The other, uses ou ...@@ -360,11 +433,13 @@ standard <acronym>JDBC</acronym> way, and is documented here. The other, uses ou
to the api, which presents the libpq large object <acronym>API</acronym> to Java, providing even to the api, which presents the libpq large object <acronym>API</acronym> to Java, providing even
better access to large objects than the standard. Internally, the driver uses better access to large objects than the standard. Internally, the driver uses
the extension to provide large object support. the extension to provide large object support.
</para>
<para> <para>
In <acronym>JDBC</acronym>, the standard way to access them is using the getBinaryStream() In <acronym>JDBC</acronym>, the standard way to access them is using the getBinaryStream()
method in ResultSet, and setBinaryStream() method in PreparedStatement. These method in ResultSet, and setBinaryStream() method in PreparedStatement. These
methods make the large object appear as a Java stream, allowing you to use the methods make the large object appear as a Java stream, allowing you to use the
java.io package, and others, to manipulate the object. java.io package, and others, to manipulate the object.
</para>
<para> <para>
For example, suppose For example, suppose
...@@ -374,6 +449,7 @@ containing that image: ...@@ -374,6 +449,7 @@ containing that image:
<programlisting> <programlisting>
create table images (imgname name,imgoid oid); create table images (imgname name,imgoid oid);
</programlisting> </programlisting>
</para>
<para> <para>
To insert an image, you would use: To insert an image, you would use:
...@@ -388,11 +464,13 @@ ps.executeUpdate(); ...@@ -388,11 +464,13 @@ ps.executeUpdate();
ps.close(); ps.close();
fis.close(); fis.close();
</programlisting> </programlisting>
</para>
<para> <para>
Now in this example, setBinaryStream transfers a set number of bytes from a Now in this example, setBinaryStream transfers a set number of bytes from a
stream into a large object, and stores the OID into the field holding a stream into a large object, and stores the OID into the field holding a
reference to it. reference to it.
</para>
<para> <para>
Retrieving an image is even easier (I'm using PreparedStatement here, but Retrieving an image is even easier (I'm using PreparedStatement here, but
...@@ -412,13 +490,15 @@ if(rs!=null) { ...@@ -412,13 +490,15 @@ if(rs!=null) {
} }
ps.close(); ps.close();
</programlisting> </programlisting>
</para>
<para> <para>
Now here you can see where the Large Object is retrieved as an InputStream. Now here you can see where the Large Object is retrieved as an InputStream.
You'll also notice that we close the stream before processing the next row in You'll also notice that we close the stream before processing the next row in
the result. This is part of the <acronym>JDBC</acronym> Specification, which states that any the result. This is part of the <acronym>JDBC</acronym> Specification, which states that any
InputStream returned is closed when ResultSet.next() or ResultSet.close() is called. InputStream returned is closed when ResultSet.next() or ResultSet.close() is called.
</para>
</sect1>
<sect1> <sect1>
<title><application>Postgres</application> Extensions to the <acronym>JDBC</acronym> <acronym>API</acronym></title> <title><application>Postgres</application> Extensions to the <acronym>JDBC</acronym> <acronym>API</acronym></title>
...@@ -428,6 +508,7 @@ InputStream returned is closed when ResultSet.next() or ResultSet.close() is cal ...@@ -428,6 +508,7 @@ InputStream returned is closed when ResultSet.next() or ResultSet.close() is cal
You can add your own functions You can add your own functions
to the backend, which can then be called from queries, or even add your own to the backend, which can then be called from queries, or even add your own
data types. data types.
</para>
<para> <para>
Now, as these are facilities unique to us, we support them from Java, with Now, as these are facilities unique to us, we support them from Java, with
a set of extension <acronym>API</acronym>'s. Some features within a set of extension <acronym>API</acronym>'s. Some features within
...@@ -2511,6 +2592,8 @@ for each Connection. ...@@ -2511,6 +2592,8 @@ for each Connection.
It's up to you, and your applications requirements. It's up to you, and your applications requirements.
</programlisting> </programlisting>
</para>
</sect1>
<sect1> <sect1>
<title>Further Reading</title> <title>Further Reading</title>
...@@ -2522,10 +2605,12 @@ Documentation (supplied with Sun's <acronym>JDK</acronym>), ...@@ -2522,10 +2605,12 @@ Documentation (supplied with Sun's <acronym>JDK</acronym>),
and the <acronym>JDBC</acronym> Specification. and the <acronym>JDBC</acronym> Specification.
Both are available on Both are available on
<ulink url="http://www.javasoft.com">JavaSoft's web site</ulink>. <ulink url="http://www.javasoft.com">JavaSoft's web site</ulink>.
</para>
<para> <para>
<ulink url="http://www.retep.org.uk">My own web site</ulink> <ulink url="http://www.retep.org.uk">My own web site</ulink>
contains updated information not included in this contains updated information not included in this
document, and also includes precompiled drivers for v6.4, and earlier. document, and also includes precompiled drivers for v6.4, and earlier.
</para>
</chapter> </sect1>
\ No newline at end of file </chapter>
doc/src/sgml/keys.sgml
View file @ a75f2d21
<!-- <!--
$Header: /cvsroot/pgsql/doc/src/sgml/Attic/keys.sgml,v 1.2 1998/08/17 16:18:13 thomas Exp $ $Header: /cvsroot/pgsql/doc/src/sgml/Attic/keys.sgml,v 1.3 1998/12/29 02:24:16 thomas Exp $
Indices and Keys Indices and Keys
$Log: keys.sgml,v $ $Log: keys.sgml,v $
Revision 1.3 1998/12/29 02:24:16 thomas
Clean up to ensure tag completion as required by the newest versions
of Norm's Modular Style Sheets and jade/docbook.
From Vince Vielhaber <vev@michvhf.com>.
Revision 1.2 1998/08/17 16:18:13 thomas Revision 1.2 1998/08/17 16:18:13 thomas
Small sentence cleanups. Add tags for acronyms and products. Small sentence cleanups. Add tags for acronyms and products.
...@@ -110,6 +115,8 @@ Should not allow NULLs. ...@@ -110,6 +115,8 @@ Should not allow NULLs.
</Para> </Para>
</ListItem> </ListItem>
</itemizedlist> </itemizedlist>
</para>
</listitem>
<ListItem> <ListItem>
<Para> <Para>
...@@ -131,7 +138,10 @@ NULLs are acceptable. ...@@ -131,7 +138,10 @@ NULLs are acceptable.
</Para> </Para>
</ListItem> </ListItem>
</itemizedlist> </itemizedlist>
</para>
</listitem>
</itemizedlist> </itemizedlist>
</para>
<Para> <Para>
As for why no non-unique keys are defined explicitly in standard <acronym>SQL</acronym> syntax? As for why no non-unique keys are defined explicitly in standard <acronym>SQL</acronym> syntax?
......
doc/src/sgml/legal.sgml
View file @ a75f2d21
...@@ -5,6 +5,7 @@ ...@@ -5,6 +5,7 @@
<ProductName>PostgreSQL</ProductName> is copyright (C) 1996-8 <ProductName>PostgreSQL</ProductName> is copyright (C) 1996-8
by the PostgreSQL Global Development Group, by the PostgreSQL Global Development Group,
and is distributed under the terms of the Berkeley license. and is distributed under the terms of the Berkeley license.
</Para>
<Para> <Para>
<ProductName>Postgres95</ProductName> is copyright (C) 1994-5 <ProductName>Postgres95</ProductName> is copyright (C) 1994-5
...@@ -38,3 +39,5 @@ Equipment Corp. PA-RISC and HP-UX are trademarks of ...@@ -38,3 +39,5 @@ Equipment Corp. PA-RISC and HP-UX are trademarks of
Hewlett-Packard Co. OSF/1 is a trademark of the Open Hewlett-Packard Co. OSF/1 is a trademark of the Open
Software Foundation. Software Foundation.
</Para> </Para>
</Sect1>
doc/src/sgml/libpgtcl.sgml
View file @ a75f2d21
...@@ -281,6 +281,7 @@ Handles start with the prefix "pgsql". ...@@ -281,6 +281,7 @@ Handles start with the prefix "pgsql".
</TITLE> </TITLE>
<PARA><FUNCTION>pg_connect</FUNCTION> opens a connection to the <PARA><FUNCTION>pg_connect</FUNCTION> opens a connection to the
<ProductName>Postgres</ProductName> backend. <ProductName>Postgres</ProductName> backend.
</Para>
<para> <para>
Two syntaxes are available. In the older one, each possible option Two syntaxes are available. In the older one, each possible option
...@@ -421,8 +422,10 @@ None. ...@@ -421,8 +422,10 @@ None.
The result is a list describing the possible connection options and their The result is a list describing the possible connection options and their
current default values. current default values.
Each entry in the list is a sublist of the format: Each entry in the list is a sublist of the format:
</Para>
<para> <para>
{optname label dispchar dispsize value} {optname label dispchar dispsize value}
</Para>
<Para> <Para>
where the optname is usable as an option in where the optname is usable as an option in
<FUNCTION>pg_connect -conninfo</FUNCTION>. <FUNCTION>pg_connect -conninfo</FUNCTION>.
...@@ -540,6 +543,7 @@ to obtain the results of the query. ...@@ -540,6 +543,7 @@ to obtain the results of the query.
Query result handles start with the connection handle and add a period Query result handles start with the connection handle and add a period
and a result number. and a result number.
</Para>
<PARA> <PARA>
Note that lack of a Tcl error is not proof that the query succeeded! Note that lack of a Tcl error is not proof that the query succeeded!
...@@ -548,6 +552,7 @@ as a query result with failure status, not by generating a Tcl error ...@@ -548,6 +552,7 @@ as a query result with failure status, not by generating a Tcl error
in pg_exec. in pg_exec.
</PARA> </PARA>
</REFSECT1> </REFSECT1>
</refentry>
<REFENTRY ID="PGTCL-PGRESULT"> <REFENTRY ID="PGTCL-PGRESULT">
<REFMETA> <REFMETA>
...@@ -765,6 +770,7 @@ The result depends on the selected option, as described above. ...@@ -765,6 +770,7 @@ The result depends on the selected option, as described above.
<PARA> <PARA>
<FUNCTION>pg_result</FUNCTION> returns information about a query result <FUNCTION>pg_result</FUNCTION> returns information about a query result
created by a prior <FUNCTION>pg_exec</FUNCTION>. created by a prior <FUNCTION>pg_exec</FUNCTION>.
</Para>
<para> <para>
You can keep a query result around for as long as you need it, but when You can keep a query result around for as long as you need it, but when
...@@ -1012,6 +1018,7 @@ The command string is executed from the Tcl idle loop. That is the normal ...@@ -1012,6 +1018,7 @@ 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 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 execute <FUNCTION>update</FUNCTION> or <FUNCTION>vwait</FUNCTION> to cause
the idle loop to be entered. the idle loop to be entered.
</Para>
<para> <para>
You should not invoke the SQL statements LISTEN or UNLISTEN directly when You should not invoke the SQL statements LISTEN or UNLISTEN directly when
......
doc/src/sgml/libpq.sgml
View file @ a75f2d21
...@@ -24,6 +24,7 @@ following directories: ...@@ -24,6 +24,7 @@ following directories:
../src/test/examples ../src/test/examples
../src/bin/psql ../src/bin/psql
</ProgramListing> </ProgramListing>
</Para>
<Para> <Para>
Frontend programs which use <FileName>libpq</FileName> must include the Frontend programs which use <FileName>libpq</FileName> must include the
...@@ -317,6 +318,7 @@ char *PQoptions(PGconn *conn) ...@@ -317,6 +318,7 @@ char *PQoptions(PGconn *conn)
<synopsis> <synopsis>
ConnStatusType *PQstatus(PGconn *conn) ConnStatusType *PQstatus(PGconn *conn)
</synopsis> </synopsis>
</Para>
<Para> <Para>
A failed connection attempt is signaled by status CONNECTION_BAD. A failed connection attempt is signaled by status CONNECTION_BAD.
...@@ -324,6 +326,7 @@ Ordinarily, an OK status will remain so until PQfinish, but a ...@@ -324,6 +326,7 @@ Ordinarily, an OK status will remain so until PQfinish, but a
communications failure might result in the status changing to communications failure might result in the status changing to
CONNECTION_BAD prematurely. In that case the application could CONNECTION_BAD prematurely. In that case the application could
try to recover by calling PQreset. try to recover by calling PQreset.
</Para>
</ListItem> </ListItem>
<ListItem> <ListItem>
...@@ -334,11 +337,13 @@ try to recover by calling PQreset. ...@@ -334,11 +337,13 @@ try to recover by calling PQreset.
<synopsis> <synopsis>
char *PQerrorMessage(PGconn* conn); char *PQerrorMessage(PGconn* conn);
</synopsis> </synopsis>
</Para>
<Para> <Para>
Nearly all libpq functions will set PQerrorMessage if they fail. Nearly all libpq functions will set PQerrorMessage if they fail.
Note that by libpq convention, a non-empty PQerrorMessage will Note that by libpq convention, a non-empty PQerrorMessage will
include a trailing newline. include a trailing newline.
</Para>
</ListItem> </ListItem>
<ListItem> <ListItem>
...@@ -499,9 +504,11 @@ char *PQfname(PGresult *res, ...@@ -499,9 +504,11 @@ char *PQfname(PGresult *res,
int PQfnumber(PGresult *res, int PQfnumber(PGresult *res,
char* field_name); char* field_name);
</synopsis> </synopsis>
</Para>
<Para> <Para>
-1 is returned if the given name does not match any field. -1 is returned if the given name does not match any field.
</Para>
</ListItem> </ListItem>
<ListItem> <ListItem>
...@@ -752,7 +759,6 @@ as with a PGresult returned by libpq itself. ...@@ -752,7 +759,6 @@ as with a PGresult returned by libpq itself.
The PQexec function is adequate for submitting queries in simple synchronous The PQexec function is adequate for submitting queries in simple synchronous
applications. It has a couple of major deficiencies however: applications. It has a couple of major deficiencies however:
<Para>
<ItemizedList> <ItemizedList>
<ListItem> <ListItem>
<Para> <Para>
...@@ -783,7 +789,6 @@ Applications that do not like these limitations can instead use the ...@@ -783,7 +789,6 @@ Applications that do not like these limitations can instead use the
underlying functions that PQexec is built from: PQsendQuery and underlying functions that PQexec is built from: PQsendQuery and
PQgetResult. PQgetResult.
<Para>
<ItemizedList> <ItemizedList>
<ListItem> <ListItem>
<Para> <Para>
...@@ -837,7 +842,6 @@ still cause the frontend to block until the backend completes the ...@@ -837,7 +842,6 @@ still cause the frontend to block until the backend completes the
next SQL command. This can be avoided by proper use of three more next SQL command. This can be avoided by proper use of three more
functions: functions:
<Para>
<ItemizedList> <ItemizedList>
<ListItem> <ListItem>
<Para> <Para>
...@@ -908,10 +912,12 @@ to read the input. It can then call PQisBusy, followed by PQgetResult ...@@ -908,10 +912,12 @@ to read the input. It can then call PQisBusy, followed by PQgetResult
if PQisBusy returns FALSE. It can also call PQnotifies to detect NOTIFY if PQisBusy returns FALSE. It can also call PQnotifies to detect NOTIFY
messages (see "Asynchronous Notification", below). An example is given messages (see "Asynchronous Notification", below). An example is given
in the sample programs section. in the sample programs section.
</Para>
<Para> <Para>
A frontend that uses PQsendQuery/PQgetResult can also attempt to cancel A frontend that uses PQsendQuery/PQgetResult can also attempt to cancel
a query that is still being processed by the backend. a query that is still being processed by the backend.
</Para>
<Para> <Para>
<ItemizedList> <ItemizedList>
...@@ -941,6 +947,7 @@ int PQrequestCancel(PGconn *conn); ...@@ -941,6 +947,7 @@ int PQrequestCancel(PGconn *conn);
<Para> <Para>
Note that if the current query is part of a transaction, cancellation Note that if the current query is part of a transaction, cancellation
will abort the whole transaction. will abort the whole transaction.
</Para>
<Para> <Para>
PQrequestCancel can safely be invoked from a signal handler. So, it is PQrequestCancel can safely be invoked from a signal handler. So, it is
...@@ -950,6 +957,7 @@ PQrequestCancel from a SIGINT signal handler, thus allowing interactive ...@@ -950,6 +957,7 @@ PQrequestCancel from a SIGINT signal handler, thus allowing interactive
cancellation of queries that it issues through PQexec. Note that cancellation of queries that it issues through PQexec. Note that
PQrequestCancel will have no effect if the connection is not currently open PQrequestCancel will have no effect if the connection is not currently open
or the backend is not currently processing a query. or the backend is not currently processing a query.
</Para>
</Sect1> </Sect1>
...@@ -961,7 +969,6 @@ or the backend is not currently processing a query. ...@@ -961,7 +969,6 @@ or the backend is not currently processing a query.
function calls to the backend. This is a trapdoor into system internals and function calls to the backend. This is a trapdoor into system internals and
can be a potential security hole. Most users will not need this feature. can be a potential security hole. Most users will not need this feature.
<Para>
<ItemizedList> <ItemizedList>
<ListItem> <ListItem>
<Para> <Para>
...@@ -1023,13 +1030,13 @@ passed from the notifier to the listener. Thus, typically, any actual data ...@@ -1023,13 +1030,13 @@ passed from the notifier to the listener. Thus, typically, any actual data
that needs to be communicated is transferred through a database relation. that needs to be communicated is transferred through a database relation.
Commonly the condition name is the same as the associated relation, but it is Commonly the condition name is the same as the associated relation, but it is
not necessary for there to be any associated relation. not necessary for there to be any associated relation.
</Para>
<Para> <Para>
<FileName>libpq</FileName> applications submit LISTEN and UNLISTEN <FileName>libpq</FileName> applications submit LISTEN and UNLISTEN
commands as ordinary SQL queries. Subsequently, arrival of NOTIFY commands as ordinary SQL queries. Subsequently, arrival of NOTIFY
messages can be detected by calling PQnotifies(). messages can be detected by calling PQnotifies().
<Para>
<ItemizedList> <ItemizedList>
<ListItem> <ListItem>
<Para> <Para>
...@@ -1062,6 +1069,7 @@ typedef struct pgNotify ...@@ -1062,6 +1069,7 @@ typedef struct pgNotify
<Para> <Para>
The second sample program gives an example of the use The second sample program gives an example of the use
of asynchronous notification. of asynchronous notification.
</Para>
<Para> <Para>
PQnotifies() does not actually read backend data; it just returns messages PQnotifies() does not actually read backend data; it just returns messages
...@@ -1216,6 +1224,7 @@ specified directly. ...@@ -1216,6 +1224,7 @@ specified directly.
<synopsis> <synopsis>
int PQendcopy(PGconn *conn); int PQendcopy(PGconn *conn);
</synopsis> </synopsis>
</Para>
<Para> <Para>
As an example: As an example:
...@@ -1318,10 +1327,12 @@ defaultNoticeProcessor(void * arg, const char * message) ...@@ -1318,10 +1327,12 @@ defaultNoticeProcessor(void * arg, const char * message)
fprintf(stderr, "%s", message); fprintf(stderr, "%s", message);
} }
</ProgramListing> </ProgramListing>
</Para>
<Para> <Para>
To use a special notice processor, call <function>PQsetNoticeProcessor</function> just after To use a special notice processor, call <function>PQsetNoticeProcessor</function> just after
creation of a new PGconn object. creation of a new PGconn object.
</Para>
</Sect1> </Sect1>
...@@ -1951,7 +1962,7 @@ main() ...@@ -1951,7 +1962,7 @@ main()
} }
</ProgramListing> </ProgramListing>
<Para> </Para>
</Sect2> </Sect2>
</Sect1> </Sect1>
......
doc/src/sgml/lobj.sgml
View file @ a75f2d21
...@@ -200,6 +200,7 @@ int lo_close(PGconn *conn, int fd) ...@@ -200,6 +200,7 @@ int lo_close(PGconn *conn, int fd)
lo_open. On success, <Acronym>lo_close</Acronym> returns zero. On error, lo_open. On success, <Acronym>lo_close</Acronym> returns zero. On error,
the return value is negative. the return value is negative.
</Para> </Para>
</sect2>
</Sect1> </Sect1>
<Sect1> <Sect1>
......
doc/src/sgml/manage.sgml
View file @ a75f2d21
...@@ -82,6 +82,7 @@ It is possible to create a database in a location other than the default ...@@ -82,6 +82,7 @@ It is possible to create a database in a location other than the default
location for the installation. Remember that all database access actually location for the installation. Remember that all database access actually
occurs through the database backend, so that any location specified must occurs through the database backend, so that any location specified must
be accessible by the backend. be accessible by the backend.
</Para>
<Para> <Para>
Alternate database locations are created and referenced by an environment variable Alternate database locations are created and referenced by an environment variable
...@@ -94,6 +95,7 @@ Any valid environment variable name may be used to reference an alternate locati ...@@ -94,6 +95,7 @@ Any valid environment variable name may be used to reference an alternate locati
although using variable names with a prefix of <quote>PGDATA</quote> is recommended although using variable names with a prefix of <quote>PGDATA</quote> is recommended
to avoid confusion to avoid confusion
and conflict with other variables. and conflict with other variables.
</Para>
<Note> <Note>
<Para> <Para>
...@@ -112,10 +114,12 @@ The administrator's guide discusses how to enable this feature. ...@@ -112,10 +114,12 @@ The administrator's guide discusses how to enable this feature.
For security and integrity reasons, For security and integrity reasons,
any path or environment variable specified has some any path or environment variable specified has some
additional path fields appended. additional path fields appended.
</Para>
<Para> <Para>
Alternate database locations must be prepared by running Alternate database locations must be prepared by running
<Application>initlocation</Application>. <Application>initlocation</Application>.
</Para>
<Para> <Para>
To create a data storage area using the environment variable To create a data storage area using the environment variable
...@@ -128,9 +132,10 @@ Then, from the command line, type ...@@ -128,9 +132,10 @@ Then, from the command line, type
Creating Postgres database system directory /alt/postgres/data Creating Postgres database system directory /alt/postgres/data
Creating Postgres database system directory /alt/postgres/data/base Creating Postgres database system directory /alt/postgres/data/base
</ProgramListing> </ProgramListing>
</Para>
<Para> <Para>
To create a database in the alternate storage area <envar>PGDATA2<envar> To create a database in the alternate storage area <envar>PGDATA2</envar>
from the command line, use the following command: from the command line, use the following command:
<ProgramListing> <ProgramListing>
% createdb -D PGDATA2 mydb % createdb -D PGDATA2 mydb
...@@ -161,6 +166,7 @@ the following: ...@@ -161,6 +166,7 @@ the following:
ERROR: Unable to create database directory /alt/postgres/data/base/mydb ERROR: Unable to create database directory /alt/postgres/data/base/mydb
createdb: database creation failed on mydb. createdb: database creation failed on mydb.
</ProgramListing> </ProgramListing>
</Para>
</Sect1> </Sect1>
...@@ -260,6 +266,7 @@ mydb=> \q ...@@ -260,6 +266,7 @@ mydb=> \q
<Title>Database Privileges</Title> <Title>Database Privileges</Title>
<Para> <Para>
</para>
</Sect2> </Sect2>
<Sect2> <Sect2>
......
doc/src/sgml/notation.sgml
View file @ a75f2d21
...@@ -11,6 +11,7 @@ Since it is possible to install more than one set of ...@@ -11,6 +11,7 @@ Since it is possible to install more than one set of
databases on a single host, this term more precisely denotes any databases on a single host, this term more precisely denotes any
particular set of installed particular set of installed
<Productname>Postgres</Productname> binaries and databases. <Productname>Postgres</Productname> binaries and databases.
</para>
<para> <para>
The The
...@@ -27,6 +28,7 @@ Note that the <Productname>Postgres</Productname> superuser is ...@@ -27,6 +28,7 @@ Note that the <Productname>Postgres</Productname> superuser is
the same as the Unix superuser (which will be referred to as <firstterm>root</firstterm>). the same as the Unix superuser (which will be referred to as <firstterm>root</firstterm>).
The superuser should have a non-zero user identifier (<firstterm>UID</firstterm>) The superuser should have a non-zero user identifier (<firstterm>UID</firstterm>)
for security reasons. for security reasons.
</para>
<para> <para>
The The
...@@ -37,6 +39,7 @@ enforce a security policy for a site. The DBA can add new users by ...@@ -37,6 +39,7 @@ enforce a security policy for a site. The DBA can add new users by
the method described below the method described below
and maintain a set of template databases for use by and maintain a set of template databases for use by
<application>createdb</application>. <application>createdb</application>.
</para>
<para> <para>
The <application>postmaster</application> The <application>postmaster</application>
...@@ -48,6 +51,7 @@ backend processes. The <application>postmaster</application> ...@@ -48,6 +51,7 @@ backend processes. The <application>postmaster</application>
can take several command-line arguments to tune its behavior. can take several command-line arguments to tune its behavior.
However, supplying arguments is necessary only if you intend to run multiple However, supplying arguments is necessary only if you intend to run multiple
sites or a non-default site. sites or a non-default site.
</para>
<para> <para>
The <Productname>Postgres</Productname> backend The <Productname>Postgres</Productname> backend
...@@ -58,6 +62,8 @@ directly from the user shell by the ...@@ -58,6 +62,8 @@ directly from the user shell by the
doing this bypasses the shared buffer pool and lock table associated doing this bypasses the shared buffer pool and lock table associated
with a postmaster/site, therefore this is not recommended in a multiuser with a postmaster/site, therefore this is not recommended in a multiuser
site. site.
</para>
</sect1>
<sect1> <sect1>
<title>Notation</title> <title>Notation</title>
...@@ -66,6 +72,7 @@ site. ...@@ -66,6 +72,7 @@ site.
<quote>...</quote> or <filename>/usr/local/pgsql/</filename> <quote>...</quote> or <filename>/usr/local/pgsql/</filename>
at the front of a file name is used to represent the at the front of a file name is used to represent the
path to the <Productname>Postgres</Productname> superuser's home directory. path to the <Productname>Postgres</Productname> superuser's home directory.
</para>
<para> <para>
In a command synopsis, brackets In a command synopsis, brackets
...@@ -73,10 +80,12 @@ In a command synopsis, brackets ...@@ -73,10 +80,12 @@ In a command synopsis, brackets
Anything in braces Anything in braces
(<quote>{</quote> and <quote>}</quote>) and containing vertical bars (<quote>|</quote>) (<quote>{</quote> and <quote>}</quote>) and containing vertical bars (<quote>|</quote>)
indicates that you must choose one. indicates that you must choose one.
</para>
<para> <para>
In examples, parentheses (<quote>(</quote> and <quote>)</quote>) are used to group boolean In examples, parentheses (<quote>(</quote> and <quote>)</quote>) are used to group boolean
expressions. <quote>|</quote> is the boolean operator OR. expressions. <quote>|</quote> is the boolean operator OR.
</para>
<para> <para>
Examples will show commands executed from various accounts and programs. Examples will show commands executed from various accounts and programs.
...@@ -87,6 +96,7 @@ executed from an unprivileged user's account will be preceeded with ...@@ -87,6 +96,7 @@ executed from an unprivileged user's account will be preceeded with
<quote>$</quote>. <quote>$</quote>.
<acronym>SQL</acronym> commands will be preceeded with <quote>=&gt;</quote> <acronym>SQL</acronym> commands will be preceeded with <quote>=&gt;</quote>
or will have no leading prompt, depending on the context. or will have no leading prompt, depending on the context.
</para>
<note> <note>
<para> <para>
...@@ -94,6 +104,7 @@ At the time of writing (<Productname>Postgres</Productname> v6.4) the notation f ...@@ -94,6 +104,7 @@ At the time of writing (<Productname>Postgres</Productname> v6.4) the notation f
flagging commands is not universally consistant throughout the documentation set. flagging commands is not universally consistant throughout the documentation set.
Please report problems to Please report problems to
<ulink url="mailto:docs@postgresql.org">the Documentation Mailing List</ulink>. <ulink url="mailto:docs@postgresql.org">the Documentation Mailing List</ulink>.
</para>
</note> </note>
</sect1> </sect1>
doc/src/sgml/odbc.sgml
View file @ a75f2d21
...@@ -15,7 +15,6 @@ ...@@ -15,7 +15,6 @@
<Title>ODBC Interface</Title> <Title>ODBC Interface</Title>
<Para>
<Note> <Note>
<Para> <Para>
Background information originally by Background information originally by
...@@ -32,6 +31,7 @@ with various <acronym>RDBMS</acronym> servers. ...@@ -32,6 +31,7 @@ with various <acronym>RDBMS</acronym> servers.
between frontend applications and database servers, between frontend applications and database servers,
allowing a user or developer to write applications which are allowing a user or developer to write applications which are
transportable between servers from different manufacturers.. transportable between servers from different manufacturers..
</Para>
<Sect1> <Sect1>
<Title>Background</Title> <Title>Background</Title>
...@@ -41,6 +41,7 @@ The <acronym>ODBC</acronym> <acronym>API</acronym> matches up ...@@ -41,6 +41,7 @@ The <acronym>ODBC</acronym> <acronym>API</acronym> matches up
on the backend to an <acronym>ODBC</acronym>-compatible data source. on the backend to an <acronym>ODBC</acronym>-compatible data source.
This could be anything from a text file to an Oracle or This could be anything from a text file to an Oracle or
<productname>Postgres</productname> <acronym>RDBMS</acronym>. <productname>Postgres</productname> <acronym>RDBMS</acronym>.
</Para>
<Para> <Para>
The backend access come from <acronym>ODBC</acronym> drivers, The backend access come from <acronym>ODBC</acronym> drivers,
...@@ -48,12 +49,14 @@ or vendor specifc drivers that ...@@ -48,12 +49,14 @@ or vendor specifc drivers that
allow data access. <productname>psqlODBC</productname> is such a driver, allow data access. <productname>psqlODBC</productname> is such a driver,
along with others that are along with others that are
available, such as the OpenLink <acronym>ODBC</acronym> drivers. available, such as the OpenLink <acronym>ODBC</acronym> drivers.
</Para>
<Para> <Para>
Once you write an <acronym>ODBC</acronym> application, Once you write an <acronym>ODBC</acronym> application,
you <emphasis>should</emphasis> be able to connect to <emphasis>any</emphasis> you <emphasis>should</emphasis> be able to connect to <emphasis>any</emphasis>
back end database, regardless of the vendor, as long as the database schema back end database, regardless of the vendor, as long as the database schema
is the same. is the same.
</Para>
<Para> <Para>
For example. you could have <productname>MS SQL Server</productname> For example. you could have <productname>MS SQL Server</productname>
...@@ -62,6 +65,7 @@ exactly the same data. Using <acronym>ODBC</acronym>, ...@@ -62,6 +65,7 @@ exactly the same data. Using <acronym>ODBC</acronym>,
your Windows application would make exactly the your Windows application would make exactly the
same calls and the back end data source would look the same (to the Windows same calls and the back end data source would look the same (to the Windows
app). app).
</Para>
<para> <para>
<ulink url="http://www.insightdist.com/">Insight Distributors</ulink> <ulink url="http://www.insightdist.com/">Insight Distributors</ulink>
...@@ -71,6 +75,8 @@ They provide a ...@@ -71,6 +75,8 @@ They provide a
<ulink url="http://www.insightdist.com/psqlodbc/"><acronym>FAQ</acronym></ulink>, <ulink url="http://www.insightdist.com/psqlodbc/"><acronym>FAQ</acronym></ulink>,
ongoing development on the code base, and actively participate on the ongoing development on the code base, and actively participate on the
<ulink url="mailto:interfaces@postgresql.org">interfaces mailing list</ulink>. <ulink url="mailto:interfaces@postgresql.org">interfaces mailing list</ulink>.
</Para>
</sect1>
<sect1> <sect1>
<title><productname>Windows</productname> Applications</title> <title><productname>Windows</productname> Applications</title>
...@@ -84,11 +90,14 @@ lessens the potential of <acronym>ODBC</acronym>: ...@@ -84,11 +90,14 @@ lessens the potential of <acronym>ODBC</acronym>:
<ListItem> <ListItem>
<Para> <Para>
Access, Delphi, and Visual Basic all support <acronym>ODBC</acronym> directly. Access, Delphi, and Visual Basic all support <acronym>ODBC</acronym> directly.
</Para>
</listitem>
<ListItem> <ListItem>
<Para> <Para>
Under C++, such as Visual C++, Under C++, such as Visual C++,
you can use the C++ <acronym>ODBC</acronym> <acronym>API</acronym>. you can use the C++ <acronym>ODBC</acronym> <acronym>API</acronym>.
</Para>
</listitem>
<ListItem> <ListItem>
<Para> <Para>
...@@ -96,7 +105,10 @@ In Visual C++, you can use the CRecordSet class, which wraps the ...@@ -96,7 +105,10 @@ In Visual C++, you can use the CRecordSet class, which wraps the
<acronym>ODBC</acronym> <acronym>API</acronym> <acronym>ODBC</acronym> <acronym>API</acronym>
set within an MFC 4.2 class. This is the easiest route if you are doing set within an MFC 4.2 class. This is the easiest route if you are doing
Windows C++ development under Windows NT. Windows C++ development under Windows NT.
</Para>
</listitem>
</ItemizedList> </ItemizedList>
</Para>
<sect2> <sect2>
<title>Writing Applications</title> <title>Writing Applications</title>
...@@ -108,12 +120,13 @@ can I write it using <acronym>ODBC</acronym> calls ...@@ -108,12 +120,13 @@ can I write it using <acronym>ODBC</acronym> calls
to the <productname>Postgres</productname> server, to the <productname>Postgres</productname> server,
or is that only when another database program or is that only when another database program
like MS SQL Server or Access needs to access the data?</quote> like MS SQL Server or Access needs to access the data?</quote>
</para>
<Para> <Para>
The <acronym>ODBC</acronym> <acronym>API</acronym> The <acronym>ODBC</acronym> <acronym>API</acronym>
is the way to go. is the way to go.
For <productname>Visual C++</productname> coding you can find out more at For <productname>Visual C++</productname> coding you can find out more at
Microsoft's web site or in your <productname>VC++</productname> docs. Microsoft's web site or in your <productname>VC++</productname> docs.
</Para>
<Para> <Para>
Visual Basic and the other RAD tools have Recordset objects Visual Basic and the other RAD tools have Recordset objects
...@@ -121,10 +134,12 @@ that use <acronym>ODBC</acronym> ...@@ -121,10 +134,12 @@ that use <acronym>ODBC</acronym>
directly to access data. Using the data-aware controls, you can quickly directly to access data. Using the data-aware controls, you can quickly
link to the <acronym>ODBC</acronym> back end database link to the <acronym>ODBC</acronym> back end database
(<Emphasis>very</Emphasis> quickly). (<Emphasis>very</Emphasis> quickly).
</Para>
<Para> <Para>
Playing around with MS Access will help you sort this out. Try using Playing around with MS Access will help you sort this out. Try using
<literal>File->Get External Data</literal>. <literal>File->Get External Data</literal>.
</Para>
<Tip> <Tip>
<Para> <Para>
...@@ -140,6 +155,8 @@ The <productname>Postgres</productname> datetime type will break MS Access. ...@@ -140,6 +155,8 @@ The <productname>Postgres</productname> datetime type will break MS Access.
</Para> </Para>
</Tip> </Tip>
--> -->
</sect2>
</sect1>
<sect1> <sect1>
<title>Unix Installation</title> <title>Unix Installation</title>
...@@ -152,6 +169,7 @@ supported on at least some platforms. ...@@ -152,6 +169,7 @@ supported on at least some platforms.
demonstrated under Linux with <productname>Postgres</productname> v6.4 demonstrated under Linux with <productname>Postgres</productname> v6.4
using the <productname>psqlODBC</productname> using the <productname>psqlODBC</productname>
driver contained in the <productname>Postgres</productname> distribution. driver contained in the <productname>Postgres</productname> distribution.
</Para>
<sect2> <sect2>
<title>Building the Driver</title> <title>Building the Driver</title>
...@@ -171,11 +189,13 @@ Instructions for installing <productname>iodbc</productname> ...@@ -171,11 +189,13 @@ Instructions for installing <productname>iodbc</productname>
document, but there is a <filename>README</filename> document, but there is a <filename>README</filename>
that can be found inside the <productname>iodbc</productname> compressed that can be found inside the <productname>iodbc</productname> compressed
.shar file that should explain how to get it up and running. .shar file that should explain how to get it up and running.
</Para>
<para> <para>
Having said that, any driver manager that you can find for your platform Having said that, any driver manager that you can find for your platform
should support the <productname>psqlODBC</productname> driver should support the <productname>psqlODBC</productname> driver
or any <acronym>ODBC</acronym> driver. or any <acronym>ODBC</acronym> driver.
</Para>
<para> <para>
The Unix configuration files for <productname>psqlODBC</productname> The Unix configuration files for <productname>psqlODBC</productname>
...@@ -187,6 +207,7 @@ a simple process to build the driver on the supported platforms. Currently ...@@ -187,6 +207,7 @@ a simple process to build the driver on the supported platforms. Currently
these include Linux and FreeBSD but we are hoping other users will these include Linux and FreeBSD but we are hoping other users will
contribute the necessary information to quickly expand the number of contribute the necessary information to quickly expand the number of
platforms for which the driver can be built. platforms for which the driver can be built.
</Para>
<para> <para>
There are actually two separate methods to build the driver depending on There are actually two separate methods to build the driver depending on
...@@ -198,6 +219,7 @@ The standalone installation is convenient if you have <acronym>ODBC</acronym> ...@@ -198,6 +219,7 @@ The standalone installation is convenient if you have <acronym>ODBC</acronym>
client applications on multiple, heterogeneous platforms. The integrated client applications on multiple, heterogeneous platforms. The integrated
installation is convenient when the target client is the same as the installation is convenient when the target client is the same as the
server, or when the client and server have similar runtime configurations. server, or when the client and server have similar runtime configurations.
</Para>
<para> <para>
Specifically if you have received the <productname>psqlODBC</productname> Specifically if you have received the <productname>psqlODBC</productname>
...@@ -210,12 +232,14 @@ of the <productname>Postgres</productname> distribution ...@@ -210,12 +232,14 @@ of the <productname>Postgres</productname> distribution
If you received the driver as a standalone package than you will run If you received the driver as a standalone package than you will run
configure and make from the directory in which you unpacked the configure and make from the directory in which you unpacked the
driver source. driver source.
</Para>
<procedure> <procedure>
<title>Integrated Installation</title> <title>Integrated Installation</title>
<para> <para>
This installation procedure is appropriate for an integrated installation. This installation procedure is appropriate for an integrated installation.
</Para>
<step performance="required"> <step performance="required">
<para> <para>
...@@ -226,7 +250,8 @@ command-line argument for <application>src/configure</application>: ...@@ -226,7 +250,8 @@ command-line argument for <application>src/configure</application>:
% ./configure --with-odbc % ./configure --with-odbc
% make % make
</programlisting> </programlisting>
</Para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Rebuild the <productname>Postgres</productname> distribution: Rebuild the <productname>Postgres</productname> distribution:
...@@ -234,7 +259,8 @@ Rebuild the <productname>Postgres</productname> distribution: ...@@ -234,7 +259,8 @@ Rebuild the <productname>Postgres</productname> distribution:
<programlisting> <programlisting>
% make install % make install
</programlisting> </programlisting>
</Para>
</step>
</procedure> </procedure>
<para> <para>
...@@ -248,6 +274,7 @@ as ...@@ -248,6 +274,7 @@ as
<programlisting> <programlisting>
% make ODBCINST=<replaceable>filename</replaceable> install % make ODBCINST=<replaceable>filename</replaceable> install
</programlisting> </programlisting>
</Para>
<procedure> <procedure>
<title>Pre-v6.4 Integrated Installation</title> <title>Pre-v6.4 Integrated Installation</title>
...@@ -257,12 +284,14 @@ If you have a <productname>Postgres</productname> installation older than ...@@ -257,12 +284,14 @@ If you have a <productname>Postgres</productname> installation older than
v6.4, you have the original source tree available, v6.4, you have the original source tree available,
and you want to use the newest version of the <acronym>ODBC</acronym> and you want to use the newest version of the <acronym>ODBC</acronym>
driver, then you may want to try this form of installation. driver, then you may want to try this form of installation.
</Para>
<step performance="required"> <step performance="required">
<para> <para>
Copy the output tar file to your target system and unpack it into a Copy the output tar file to your target system and unpack it into a
clean directory. clean directory.
</Para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
From the directory containing the From the directory containing the
...@@ -273,6 +302,8 @@ sources, type: ...@@ -273,6 +302,8 @@ sources, type:
% make % make
% make POSTGRESDIR=<replaceable class="parameter">PostgresTopDir</replaceable> install % make POSTGRESDIR=<replaceable class="parameter">PostgresTopDir</replaceable> install
</programlisting> </programlisting>
</Para>
</step>
<step performance="optional"> <step performance="optional">
<para> <para>
...@@ -282,7 +313,8 @@ then you can specify various destinations explicitly: ...@@ -282,7 +313,8 @@ then you can specify various destinations explicitly:
<programlisting> <programlisting>
% make BINDIR=bindir LIBDIR=libdir HEADERDIR=headerdir ODBCINST=instfile install % make BINDIR=bindir LIBDIR=libdir HEADERDIR=headerdir ODBCINST=instfile install
</programlisting> </programlisting>
</Para>
</step>
</procedure> </procedure>
<procedure> <procedure>
...@@ -294,6 +326,7 @@ A standalone installation is not integrated with or built on the normal ...@@ -294,6 +326,7 @@ A standalone installation is not integrated with or built on the normal
for building the <acronym>ODBC</acronym> driver for multiple, heterogeneous for building the <acronym>ODBC</acronym> driver for multiple, heterogeneous
clients who do not have a locally-installed <productname>Postgres</productname> clients who do not have a locally-installed <productname>Postgres</productname>
source tree. source tree.
</Para>
<para> <para>
The default location for libraries and headers The default location for libraries and headers
...@@ -303,6 +336,7 @@ There is another system wide configuration file that gets installed ...@@ -303,6 +336,7 @@ There is another system wide configuration file that gets installed
as <filename>/share/odbcinst.ini</filename> (if <filename>/share</filename> as <filename>/share/odbcinst.ini</filename> (if <filename>/share</filename>
exists) or as <filename>/etc/odbcinst.ini</filename> exists) or as <filename>/etc/odbcinst.ini</filename>
(if <filename>/share</filename> does not exist). (if <filename>/share</filename> does not exist).
</Para>
<note> <note>
<para> <para>
...@@ -312,6 +346,7 @@ Most installation steps for <productname>Postgres</productname> do not ...@@ -312,6 +346,7 @@ Most installation steps for <productname>Postgres</productname> do not
have this requirement, and you can choose another destination which have this requirement, and you can choose another destination which
is writable by your non-root <productname>Postgres</productname> superuser is writable by your non-root <productname>Postgres</productname> superuser
account instead. account instead.
</Para>
</note> </note>
<step performance="required"> <step performance="required">
...@@ -320,6 +355,7 @@ The standalone installation distribution can be built from the ...@@ -320,6 +355,7 @@ The standalone installation distribution can be built from the
<productname>Postgres</productname> distribution or may be obtained from <productname>Postgres</productname> distribution or may be obtained from
<ulink url="http://www.insightdist.com/psqlodbc">Insight Distributors</ulink>, <ulink url="http://www.insightdist.com/psqlodbc">Insight Distributors</ulink>,
the current maintainers of the non-Unix sources. the current maintainers of the non-Unix sources.
</Para>
<para> <para>
Copy the zip Copy the zip
...@@ -332,6 +368,7 @@ unzip it with the command ...@@ -332,6 +368,7 @@ unzip it with the command
The <option>-a</option> option The <option>-a</option> option
is necessary to get rid of <acronym>DOS</acronym> is necessary to get rid of <acronym>DOS</acronym>
CR/LF pairs in the source files. CR/LF pairs in the source files.
</Para>
<para> <para>
If you have the gzipped tar package than simply run If you have the gzipped tar package than simply run
...@@ -339,6 +376,7 @@ If you have the gzipped tar package than simply run ...@@ -339,6 +376,7 @@ If you have the gzipped tar package than simply run
<programlisting> <programlisting>
tar -xzf <replaceable>packagename</replaceable> tar -xzf <replaceable>packagename</replaceable>
</programlisting> </programlisting>
</Para>
<substeps> <substeps>
...@@ -346,13 +384,15 @@ tar -xzf <replaceable>packagename</replaceable> ...@@ -346,13 +384,15 @@ tar -xzf <replaceable>packagename</replaceable>
<para> <para>
To create a tar file for a complete standalone installation To create a tar file for a complete standalone installation
from the main <productname>Postgres</productname> source tree: from the main <productname>Postgres</productname> source tree:
</Para>
</step>
</substeps> </substeps>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Configure the main <productname>Postgres</productname> distribution. Configure the main <productname>Postgres</productname> distribution.
</Para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Create the tar file: Create the tar file:
...@@ -361,16 +401,22 @@ Create the tar file: ...@@ -361,16 +401,22 @@ Create the tar file:
% cd interfaces/odbc % cd interfaces/odbc
% make standalone % make standalone
</programlisting> </programlisting>
</Para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Copy the output tar file to your target system. Be sure to transfer as Copy the output tar file to your target system. Be sure to transfer as
a binary file if using <application>ftp</application>. a binary file if using <application>ftp</application>.
</Para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Unpack the tar file into a clean Unpack the tar file into a clean
directory. directory.
</Para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
...@@ -379,6 +425,7 @@ Configure the standalone installation: ...@@ -379,6 +425,7 @@ Configure the standalone installation:
<programlisting> <programlisting>
% ./configure % ./configure
</programlisting> </programlisting>
</Para>
<para> <para>
The configuration can be done with options: The configuration can be done with options:
...@@ -392,6 +439,7 @@ the directories <filename><replaceable>rootdir</replaceable>/lib</filename> and ...@@ -392,6 +439,7 @@ the directories <filename><replaceable>rootdir</replaceable>/lib</filename> and
<filename><replaceable>rootdir</replaceable>/include/iodbc</filename>, and <filename><replaceable>rootdir</replaceable>/include/iodbc</filename>, and
<option>--with-odbc</option> installs <filename>odbcinst.ini</filename> in the <option>--with-odbc</option> installs <filename>odbcinst.ini</filename> in the
specified directory. specified directory.
</Para>
<para> <para>
Note that both of these options can also be used from the integrated build Note that both of these options can also be used from the integrated build
...@@ -400,6 +448,8 @@ but be aware that <emphasis>when used in the integrated build</emphasis> ...@@ -400,6 +448,8 @@ but be aware that <emphasis>when used in the integrated build</emphasis>
your <productname>Postgres</productname> installation. your <productname>Postgres</productname> installation.
<option>--with-odbc</option> applies only to the configuration file <option>--with-odbc</option> applies only to the configuration file
<filename>odbcinst.ini</filename>. <filename>odbcinst.ini</filename>.
</Para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
...@@ -408,6 +458,7 @@ Compile and link the source code: ...@@ -408,6 +458,7 @@ Compile and link the source code:
<programlisting> <programlisting>
% make ODBCINST=<replaceable>instdir</replaceable> % make ODBCINST=<replaceable>instdir</replaceable>
</programlisting> </programlisting>
</Para>
<para> <para>
You can also override the default location for installation on the You can also override the default location for installation on the
...@@ -418,6 +469,8 @@ that specifies its installation directory will probably cause you ...@@ -418,6 +469,8 @@ that specifies its installation directory will probably cause you
headaches. It is safest simply to allow the driver to install the headaches. It is safest simply to allow the driver to install the
odbcinst.ini file in the default directory or the directory you specified odbcinst.ini file in the default directory or the directory you specified
on the './configure' command line with --with-odbc. on the './configure' command line with --with-odbc.
</Para>
</step>
<!-- <!--
This doesn't currently work - thomas 1998-10-19 This doesn't currently work - thomas 1998-10-19
...@@ -435,6 +488,7 @@ Install the source code: ...@@ -435,6 +488,7 @@ Install the source code:
<programlisting> <programlisting>
% make POSTGRESDIR=<replaceable>targettree</replaceable> install % make POSTGRESDIR=<replaceable>targettree</replaceable> install
</programlisting> </programlisting>
</Para>
<para> <para>
To override the library and header installation directories separately To override the library and header installation directories separately
...@@ -446,6 +500,7 @@ Overriding <envar>POSTGRESDIR</envar> on the make command line will cause ...@@ -446,6 +500,7 @@ Overriding <envar>POSTGRESDIR</envar> on the make command line will cause
<envar>LIBDIR</envar> and <envar>HEADERDIR</envar> <envar>LIBDIR</envar> and <envar>HEADERDIR</envar>
to be rooted at the new directory you specify. to be rooted at the new directory you specify.
<envar>ODBCINST</envar> is independent of <envar>POSTGRESDIR</envar>. <envar>ODBCINST</envar> is independent of <envar>POSTGRESDIR</envar>.
</Para>
<para> <para>
Here is how you would specify the various destinations explicitly: Here is how you would specify the various destinations explicitly:
...@@ -453,6 +508,7 @@ Here is how you would specify the various destinations explicitly: ...@@ -453,6 +508,7 @@ Here is how you would specify the various destinations explicitly:
<programlisting> <programlisting>
% make BINDIR=<replaceable>bindir</replaceable> LIBDIR=<replaceable>libdir</replaceable> HEADERDIR=<replaceable>headerdir</replaceable> install % make BINDIR=<replaceable>bindir</replaceable> LIBDIR=<replaceable>libdir</replaceable> HEADERDIR=<replaceable>headerdir</replaceable> install
</programlisting> </programlisting>
</Para>
<para> <para>
For example, typing For example, typing
...@@ -466,6 +522,7 @@ For example, typing ...@@ -466,6 +522,7 @@ For example, typing
will cause the libraries and headers to be installed in the directories will cause the libraries and headers to be installed in the directories
<filename>/opt/psqlodbc/lib</filename> <filename>/opt/psqlodbc/lib</filename>
and <filename>/opt/psqlodbc/include/iodbc</filename> respectively. and <filename>/opt/psqlodbc/include/iodbc</filename> respectively.
</Para>
<para> <para>
The command The command
...@@ -477,8 +534,11 @@ The command ...@@ -477,8 +534,11 @@ The command
should cause the libraries to be installed in /opt/psqlodbc/lib and should cause the libraries to be installed in /opt/psqlodbc/lib and
the headers in /usr/local/include/iodbc. If this doesn't work as the headers in /usr/local/include/iodbc. If this doesn't work as
expected please contact one of the maintainers. expected please contact one of the maintainers.
</Para>
</step>
</procedure> </procedure>
</sect2>
</sect1>
<sect1> <sect1>
<title>Configuration Files</title> <title>Configuration Files</title>
...@@ -488,6 +548,7 @@ expected please contact one of the maintainers. ...@@ -488,6 +548,7 @@ expected please contact one of the maintainers.
for the <productname>psqlODBC</productname> driver. for the <productname>psqlODBC</productname> driver.
The file uses conventions typical for <productname>Windows</productname> The file uses conventions typical for <productname>Windows</productname>
Registry files, but despite this restriction can be made to work. Registry files, but despite this restriction can be made to work.
</Para>
<para> <para>
The <filename>.odbc.ini</filename> file has three required sections. The <filename>.odbc.ini</filename> file has three required sections.
...@@ -512,12 +573,14 @@ Remember that the <productname>Postgres</productname> database name is ...@@ -512,12 +573,14 @@ Remember that the <productname>Postgres</productname> database name is
usually a single word, without path names of any sort. usually a single word, without path names of any sort.
The <productname>Postgres</productname> server manages the actual access The <productname>Postgres</productname> server manages the actual access
to the database, and you need only specify the name from the client. to the database, and you need only specify the name from the client.
</Para>
</tip> </tip>
Other entries may be inserted to control the format of the display. Other entries may be inserted to control the format of the display.
The third required section is <literal>[ODBC]</literal> The third required section is <literal>[ODBC]</literal>
which must contain the <literal>InstallDir</literal> keyword which must contain the <literal>InstallDir</literal> keyword
and which may contain other options. and which may contain other options.
</Para>
<para> <para>
Here is an example <filename>.odbc.ini</filename> file, Here is an example <filename>.odbc.ini</filename> file,
...@@ -558,12 +621,11 @@ Driver = /opt/postgres/current/lib/libpsqlodbc.so ...@@ -558,12 +621,11 @@ Driver = /opt/postgres/current/lib/libpsqlodbc.so
[ODBC] [ODBC]
InstallDir = /opt/applix/axdata/axshlib InstallDir = /opt/applix/axdata/axshlib
</programlisting> </programlisting>
</Para>
</sect1>
<sect1> <sect1>
<title>ApplixWare</title> <title>ApplixWare</title>
<para>
<sect2> <sect2>
<title>Configuration</title> <title>Configuration</title>
...@@ -572,6 +634,7 @@ InstallDir = /opt/applix/axdata/axshlib ...@@ -572,6 +634,7 @@ InstallDir = /opt/applix/axdata/axshlib
in order for it to in order for it to
be able to access the <productname>Postgres</productname> be able to access the <productname>Postgres</productname>
<acronym>ODBC</acronym> software drivers. <acronym>ODBC</acronym> software drivers.
</Para>
<procedure> <procedure>
<title>Enabling ApplixWare Database Access</title> <title>Enabling ApplixWare Database Access</title>
...@@ -581,6 +644,7 @@ These instructions are for the 4.4.1 release of ...@@ -581,6 +644,7 @@ These instructions are for the 4.4.1 release of
<productname>ApplixWare</productname> on <productname>Linux</productname>. <productname>ApplixWare</productname> on <productname>Linux</productname>.
Refer to the <citetitle>Linux Sys Admin</citetitle> on-line book Refer to the <citetitle>Linux Sys Admin</citetitle> on-line book
for more detailed information. for more detailed information.
</Para>
<step performance="required"> <step performance="required">
<para> <para>
...@@ -591,10 +655,12 @@ find <filename>libodbc.so</filename> ...@@ -591,10 +655,12 @@ find <filename>libodbc.so</filename>
This library is included with the ApplixWare distribution, This library is included with the ApplixWare distribution,
but <filename>axnet.cnf</filename> needs to be modified to point to the but <filename>axnet.cnf</filename> needs to be modified to point to the
correct location. correct location.
</Para>
<para> <para>
As root, edit the file As root, edit the file
<filename><replaceable>applixroot</replaceable>/applix/axdata/axnet.cnf</filename>. <filename><replaceable>applixroot</replaceable>/applix/axdata/axnet.cnf</filename>.
</Para>
<substeps> <substeps>
...@@ -606,7 +672,8 @@ find the line that starts with ...@@ -606,7 +672,8 @@ find the line that starts with
<programlisting> <programlisting>
#libFor elfodbc /ax/<replaceable>...</replaceable> #libFor elfodbc /ax/<replaceable>...</replaceable>
</programlisting> </programlisting>
</Para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Change line to read Change line to read
...@@ -619,8 +686,10 @@ which will tell elfodbc to look in this directory ...@@ -619,8 +686,10 @@ which will tell elfodbc to look in this directory
for the <acronym>ODBC</acronym> support library. for the <acronym>ODBC</acronym> support library.
If you have installed applix somewhere else, If you have installed applix somewhere else,
change the path accordingly. change the path accordingly.
</Para>
</step>
</substeps> </substeps>
</step>
<step performance="required"> <step performance="required">
<para> <para>
...@@ -633,7 +702,8 @@ TextAsLongVarchar=0 ...@@ -633,7 +702,8 @@ TextAsLongVarchar=0
to the database-specific portion of <filename>.odbc.ini</filename> to the database-specific portion of <filename>.odbc.ini</filename>
so that text fields will not be shown as <literal>**BLOB**</literal>. so that text fields will not be shown as <literal>**BLOB**</literal>.
</Para>
</step>
</procedure> </procedure>
<procedure> <procedure>
...@@ -642,17 +712,21 @@ so that text fields will not be shown as <literal>**BLOB**</literal>. ...@@ -642,17 +712,21 @@ so that text fields will not be shown as <literal>**BLOB**</literal>.
<step performance="required"> <step performance="required">
<para> <para>
Bring up <application>Applix Data</application> Bring up <application>Applix Data</application>
</Para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Select the <productname>Postgres</productname> database of interest. Select the <productname>Postgres</productname> database of interest.
</Para>
<substeps> <substeps>
<step performance="required"> <step performance="required">
<para> <para>
Select <command>Query->Choose Server</command>. Select <command>Query->Choose Server</command>.
</Para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Select <acronym>ODBC</acronym>, and click <command>Browse</command>. Select <acronym>ODBC</acronym>, and click <command>Browse</command>.
...@@ -660,17 +734,20 @@ The database you configured in <filename>.odbc.ini</filename> ...@@ -660,17 +734,20 @@ The database you configured in <filename>.odbc.ini</filename>
should be shown. Make sure that the <option>Host: field</option> should be shown. Make sure that the <option>Host: field</option>
is empty (if it is not, axnet will try to contact axnet on another machine is empty (if it is not, axnet will try to contact axnet on another machine
to look for the database). to look for the database).
</Para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Select the database in the box that was launched by <command>Browse</command>, Select the database in the box that was launched by <command>Browse</command>,
then click <command>OK</command>. then click <command>OK</command>.
</Para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Enter username and password in the login identification dialog, Enter username and password in the login identification dialog,
and click <command>OK</command>. and click <command>OK</command>.
</Para>
</step>
</substeps> </substeps>
<para> <para>
...@@ -678,19 +755,23 @@ Enter username and password in the login identification dialog, ...@@ -678,19 +755,23 @@ Enter username and password in the login identification dialog,
in the lower left corner of the in the lower left corner of the
data window. If you get an error dialog box, see the debugging section data window. If you get an error dialog box, see the debugging section
below. below.
</Para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
The 'Ready' message will appear in the lower left corner of the data The 'Ready' message will appear in the lower left corner of the data
window. This indicates that you can now enter queries. window. This indicates that you can now enter queries.
</Para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Select a table from Query->Choose tables, and then select Query->Query Select a table from Query->Choose tables, and then select Query->Query
to access the database. The first 50 or so rows from the table should to access the database. The first 50 or so rows from the table should
appear. appear.
</Para>
</step>
</procedure> </procedure>
</sect2>
<sect2> <sect2>
<title>Common Problems</title> <title>Common Problems</title>
...@@ -704,25 +785,32 @@ The following messages can appear while trying to make an ...@@ -704,25 +785,32 @@ The following messages can appear while trying to make an
<varlistentry> <varlistentry>
<term> <term>
Cannot launch gateway on server Cannot launch gateway on server
</term>
<listitem> <listitem>
<para> <para>
<literal>elfodbc</literal> can't find <filename>libodbc.so</filename>. <literal>elfodbc</literal> can't find <filename>libodbc.so</filename>.
Check your <filename>axnet.cnf</filename>. Check your <filename>axnet.cnf</filename>.
</Para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
Error from ODBC Gateway: Error from ODBC Gateway:
IM003::[iODBC][Driver Manager]Specified driver could not be loaded IM003::[iODBC][Driver Manager]Specified driver could not be loaded
</term>
<listitem> <listitem>
<para> <para>
<filename>libodbc.so</filename> cannot find the driver listed in <filename>libodbc.so</filename> cannot find the driver listed in
<filename>.odbc.ini</filename>. Verify the settings. <filename>.odbc.ini</filename>. Verify the settings.
</Para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
Server: Broken Pipe Server: Broken Pipe
</term>
<listitem> <listitem>
<para> <para>
...@@ -730,10 +818,14 @@ Server: Broken Pipe ...@@ -730,10 +818,14 @@ Server: Broken Pipe
problem. You might not have an up-to-date version problem. You might not have an up-to-date version
of the <productname>Postgres</productname> of the <productname>Postgres</productname>
<acronym>ODBC</acronym> package. <acronym>ODBC</acronym> package.
</Para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
setuid to 256: failed to launch gateway setuid to 256: failed to launch gateway
</term>
<listitem> <listitem>
<para> <para>
...@@ -742,8 +834,12 @@ The September release of ApplixWare v4.4.1 (the first release with official ...@@ -742,8 +834,12 @@ The September release of ApplixWare v4.4.1 (the first release with official
exceed eight (8) characters in length. exceed eight (8) characters in length.
Problem description ontributed by Problem description ontributed by
<ulink url="mailto:scampbell@lear.com">Steve Campbell</ulink>. <ulink url="mailto:scampbell@lear.com">Steve Campbell</ulink>.
</Para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</para>
<para> <para>
<note> <note>
...@@ -753,6 +849,7 @@ Problem description ontributed by ...@@ -753,6 +849,7 @@ Problem description ontributed by
Contributed by Contributed by
<ulink url="mailto:scampbell@lear.com">Steve Campbell</ulink> on <ulink url="mailto:scampbell@lear.com">Steve Campbell</ulink> on
1998-10-20. 1998-10-20.
</para>
</note> </note>
The <application>axnet</application> program's security system The <application>axnet</application> program's security system
...@@ -762,6 +859,8 @@ The <application>axnet</application> program's security system ...@@ -762,6 +859,8 @@ The <application>axnet</application> program's security system
(so it can read/write in each user's directory). (so it can read/write in each user's directory).
I would hesitate to recommend this, however, since we have no idea what I would hesitate to recommend this, however, since we have no idea what
security holes this creates. security holes this creates.
</para>
</sect2>
<sect2> <sect2>
<title>Debugging ApplixWare ODBC Connections</title> <title>Debugging ApplixWare ODBC Connections</title>
...@@ -769,14 +868,15 @@ security holes this creates. ...@@ -769,14 +868,15 @@ security holes this creates.
<para> <para>
One good tool for debugging connection problems uses the Unix system One good tool for debugging connection problems uses the Unix system
utility <application>strace</application>. utility <application>strace</application>.
</para>
<procedure> <procedure>
<title>Debugging with strace</title> <title>Debugging with strace</title>
<step performance="required"> <step performance="required">
<para> <para>
Start applixware. Start applixware.
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Start an <application>strace</application> on Start an <application>strace</application> on
...@@ -792,6 +892,7 @@ shows ...@@ -792,6 +892,7 @@ shows
cary 10432 0.0 2.6 1740 392 ? S Oct 9 0:00 axnet cary 10432 0.0 2.6 1740 392 ? S Oct 9 0:00 axnet
cary 27883 0.9 31.0 12692 4596 ? S 10:24 0:04 axmain cary 27883 0.9 31.0 12692 4596 ? S 10:24 0:04 axmain
</programlisting> </programlisting>
</para>
<para> <para>
Then run Then run
...@@ -799,11 +900,13 @@ Then run ...@@ -799,11 +900,13 @@ Then run
<programlisting> <programlisting>
strace -f -s 1024 -p 10432 strace -f -s 1024 -p 10432
</programlisting> </programlisting>
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Check the strace output. Check the strace output.
</para>
<note> <note>
<title>Note from Cary</title> <title>Note from Cary</title>
...@@ -812,8 +915,9 @@ Many of the error messages from <productname>ApplixWare</productname> ...@@ -812,8 +915,9 @@ Many of the error messages from <productname>ApplixWare</productname>
go to <filename>stderr</filename>, go to <filename>stderr</filename>,
but I'm not sure where <filename>stderr</filename> but I'm not sure where <filename>stderr</filename>
is sent, so <application>strace</application> is the way to find out. is sent, so <application>strace</application> is the way to find out.
</para>
</note> </note>
</step>
</procedure> </procedure>
<para> <para>
...@@ -831,6 +935,8 @@ I ran strace on axnet and got ...@@ -831,6 +935,8 @@ I ran strace on axnet and got
</programlisting> </programlisting>
So what is happening is that applix elfodbc is searching for libodbc.so, but it So what is happening is that applix elfodbc is searching for libodbc.so, but it
can't find it. That is why axnet.cnf needed to be changed. can't find it. That is why axnet.cnf needed to be changed.
</para>
</sect2>
<sect2> <sect2>
<title>Running the ApplixWare Demo</title> <title>Running the ApplixWare Demo</title>
...@@ -842,9 +948,10 @@ the sample tables that the Tutorial refers to. The ELF Macro used to ...@@ -842,9 +948,10 @@ the sample tables that the Tutorial refers to. The ELF Macro used to
create the tables tries to use a NULL condition create the tables tries to use a NULL condition
on many of the database columns, on many of the database columns,
and <productname>Postgres</productname> does not currently allow this option. and <productname>Postgres</productname> does not currently allow this option.
</para>
<para> <para>
To get around this problem, you can do the following: To get around this problem, you can do the following:
</para>
<procedure> <procedure>
<title>Modifying the ApplixWare Demo</title> <title>Modifying the ApplixWare Demo</title>
...@@ -853,61 +960,84 @@ To get around this problem, you can do the following: ...@@ -853,61 +960,84 @@ To get around this problem, you can do the following:
<para> <para>
Copy <filename>/opt/applix/axdata/eng/Demos/sqldemo.am</filename> Copy <filename>/opt/applix/axdata/eng/Demos/sqldemo.am</filename>
to a local directory. to a local directory.
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Edit this local copy of <filename>sqldemo.am</filename>: Edit this local copy of <filename>sqldemo.am</filename>:
</para>
<substeps> <substeps>
<step performance="required"> <step performance="required">
<para> <para>
Search for 'null_clause = "NULL" Search for 'null_clause = "NULL"
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Change this to null_clause = "" Change this to null_clause = ""
</para>
</step>
</substeps> </substeps>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Start <application>Applix Macro Editor</application>. Start <application>Applix Macro Editor</application>.
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Open the sqldemo.am file from the <application>Macro Editor</application>. Open the sqldemo.am file from the <application>Macro Editor</application>.
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Select <command>File->Compile and Save</command>. Select <command>File->Compile and Save</command>.
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Exit <application>Macro Editor</application>. Exit <application>Macro Editor</application>.
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Start <application>Applix Data</application>. Start <application>Applix Data</application>.
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Select <command>*->Run Macro</command> Select <command>*->Run Macro</command>
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Enter the value <quote>sqldemo</quote>, then click <command>OK</command>. Enter the value <quote>sqldemo</quote>, then click <command>OK</command>.
</para>
<para> <para>
You should see the progress in the status line of the data window You should see the progress in the status line of the data window
(in the lower left corner). (in the lower left corner).
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
You should now be able to access the demo tables. You should now be able to access the demo tables.
</para>
</step>
</procedure> </procedure>
</sect2>
<sect2> <sect2>
<title>Useful Macros</title> <title>Useful Macros</title>
...@@ -922,7 +1052,7 @@ macro file. This is an example ...@@ -922,7 +1052,7 @@ macro file. This is an example
in order for it to in order for it to
be able to access the <productname>Postgres</productname> be able to access the <productname>Postgres</productname>
<acronym>ODBC</acronym> software drivers. <acronym>ODBC</acronym> software drivers.
</para>
<procedure> <procedure>
<title>Enabling ApplixWare Database Access</title> <title>Enabling ApplixWare Database Access</title>
...@@ -932,7 +1062,7 @@ these instructions are for the 4.4.1 release of ...@@ -932,7 +1062,7 @@ these instructions are for the 4.4.1 release of
<productname>ApplixWare</productname> on <productname>Linux</productname>. <productname>ApplixWare</productname> on <productname>Linux</productname>.
Refer to the <citetitle>Linux Sys Admin</citetitle> on-line book Refer to the <citetitle>Linux Sys Admin</citetitle> on-line book
for more detailed information. for more detailed information.
</para>
<step performance="required"> <step performance="required">
<para> <para>
You must modify <filename>axnet.cnf</filename> so that You must modify <filename>axnet.cnf</filename> so that
...@@ -942,11 +1072,11 @@ find <filename>libodbc.so</filename> ...@@ -942,11 +1072,11 @@ find <filename>libodbc.so</filename>
This library is included with the ApplixWare distribution, This library is included with the ApplixWare distribution,
but <filename>axnet.cnf</filename> needs to be modified to point to the but <filename>axnet.cnf</filename> needs to be modified to point to the
correct location. correct location.
</para>
<para> <para>
As root, edit the file As root, edit the file
<filename><replaceable>applixroot</replaceable>/applix/axdata/axnet.cnf</filename>. <filename><replaceable>applixroot</replaceable>/applix/axdata/axnet.cnf</filename>.
</para>
<substeps> <substeps>
<step performance="required"> <step performance="required">
...@@ -957,6 +1087,8 @@ find the line that starts with ...@@ -957,6 +1087,8 @@ find the line that starts with
<programlisting> <programlisting>
#libFor elfodbc /ax/<replaceable>...</replaceable> #libFor elfodbc /ax/<replaceable>...</replaceable>
</programlisting> </programlisting>
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
...@@ -970,8 +1102,11 @@ which will tell elfodbc to look in this directory ...@@ -970,8 +1102,11 @@ which will tell elfodbc to look in this directory
for the <acronym>ODBC</acronym> support library. for the <acronym>ODBC</acronym> support library.
If you have installed applix somewhere else, If you have installed applix somewhere else,
change the path accordingly. change the path accordingly.
</para>
</step>
</substeps> </substeps>
</step>
<step performance="required"> <step performance="required">
<para> <para>
...@@ -984,6 +1119,8 @@ TextAsLongVarchar=0 ...@@ -984,6 +1119,8 @@ TextAsLongVarchar=0
to the database-specific portion of <filename>.odbc.ini</filename> to the database-specific portion of <filename>.odbc.ini</filename>
so that text fields will not be shown as <literal>**BLOB**</literal>. so that text fields will not be shown as <literal>**BLOB**</literal>.
</para>
</step>
</procedure> </procedure>
...@@ -993,16 +1130,21 @@ so that text fields will not be shown as <literal>**BLOB**</literal>. ...@@ -993,16 +1130,21 @@ so that text fields will not be shown as <literal>**BLOB**</literal>.
<step performance="required"> <step performance="required">
<para> <para>
Bring up <application>Applix Data</application> Bring up <application>Applix Data</application>
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Select the <productname>Postgres</productname> database of interest. Select the <productname>Postgres</productname> database of interest.
</para>
<substeps> <substeps>
<step performance="required"> <step performance="required">
<para> <para>
Select <command>Query->Choose Server</command>. Select <command>Query->Choose Server</command>.
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
...@@ -1011,16 +1153,22 @@ The database you configured in <filename>.odbc.ini</filename> ...@@ -1011,16 +1153,22 @@ The database you configured in <filename>.odbc.ini</filename>
should be shown. Make sure that the <option>Host: field</option> should be shown. Make sure that the <option>Host: field</option>
is empty (if it is not, axnet will try to contact axnet on another machine is empty (if it is not, axnet will try to contact axnet on another machine
to look for the database). to look for the database).
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Select the database in the box that was launched by <command>Browse</command>, Select the database in the box that was launched by <command>Browse</command>,
then click <command>OK</command>. then click <command>OK</command>.
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Enter username and password in the login identification dialog, Enter username and password in the login identification dialog,
and click <command>OK</command>. and click <command>OK</command>.
</para>
</step>
</substeps> </substeps>
...@@ -1029,19 +1177,25 @@ Enter username and password in the login identification dialog, ...@@ -1029,19 +1177,25 @@ Enter username and password in the login identification dialog,
in the lower left corner of the in the lower left corner of the
data window. If you get an error dialog box, see the debugging section data window. If you get an error dialog box, see the debugging section
below. below.
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
The 'Ready' message will appear in the lower left corner of the data The 'Ready' message will appear in the lower left corner of the data
window. This indicates that you can now enter queries. window. This indicates that you can now enter queries.
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Select a table from Query->Choose tables, and then select Query->Query Select a table from Query->Choose tables, and then select Query->Query
to access the database. The first 50 or so rows from the table should to access the database. The first 50 or so rows from the table should
appear. appear.
</para>
</step>
</procedure> </procedure>
</sect2>
<sect2> <sect2>
<title>Common Problems</title> <title>Common Problems</title>
...@@ -1055,25 +1209,32 @@ The following messages can appear while trying to make an ...@@ -1055,25 +1209,32 @@ The following messages can appear while trying to make an
<varlistentry> <varlistentry>
<term> <term>
Cannot launch gateway on server Cannot launch gateway on server
</term>
<listitem> <listitem>
<para> <para>
<literal>elfodbc</literal> can't find <filename>libodbc.so</filename>. <literal>elfodbc</literal> can't find <filename>libodbc.so</filename>.
Check your <filename>axnet.cnf</filename>. Check your <filename>axnet.cnf</filename>.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
Error from ODBC Gateway: Error from ODBC Gateway:
IM003::[iODBC][Driver Manager]Specified driver could not be loaded IM003::[iODBC][Driver Manager]Specified driver could not be loaded
</term>
<listitem> <listitem>
<para> <para>
<filename>libodbc.so</filename> cannot find the driver listed in <filename>libodbc.so</filename> cannot find the driver listed in
<filename>.odbc.ini</filename>. Verify the settings. <filename>.odbc.ini</filename>. Verify the settings.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
Server: Broken Pipe Server: Broken Pipe
</term>
<listitem> <listitem>
<para> <para>
...@@ -1081,8 +1242,13 @@ Server: Broken Pipe ...@@ -1081,8 +1242,13 @@ Server: Broken Pipe
problem. You might not have an up-to-date version problem. You might not have an up-to-date version
of the <productname>Postgres</productname> of the <productname>Postgres</productname>
<acronym>ODBC</acronym> package. <acronym>ODBC</acronym> package.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</para>
</sect2>
<sect2> <sect2>
<title>Debugging ApplixWare ODBC Connections</title> <title>Debugging ApplixWare ODBC Connections</title>
...@@ -1090,14 +1256,15 @@ Server: Broken Pipe ...@@ -1090,14 +1256,15 @@ Server: Broken Pipe
<para> <para>
One good tool for debugging connection problems uses the Unix system One good tool for debugging connection problems uses the Unix system
utility <application>strace</application>. utility <application>strace</application>.
</para>
<procedure> <procedure>
<title>Debugging with strace</title> <title>Debugging with strace</title>
<step performance="required"> <step performance="required">
<para> <para>
Start applixware. Start applixware.
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Start an <application>strace</application> on Start an <application>strace</application> on
...@@ -1113,6 +1280,7 @@ shows ...@@ -1113,6 +1280,7 @@ shows
cary 10432 0.0 2.6 1740 392 ? S Oct 9 0:00 axnet cary 10432 0.0 2.6 1740 392 ? S Oct 9 0:00 axnet
cary 27883 0.9 31.0 12692 4596 ? S 10:24 0:04 axmain cary 27883 0.9 31.0 12692 4596 ? S 10:24 0:04 axmain
</programlisting> </programlisting>
</para>
<para> <para>
Then run Then run
...@@ -1120,10 +1288,12 @@ Then run ...@@ -1120,10 +1288,12 @@ Then run
<programlisting> <programlisting>
strace -f -s 1024 -p 10432 strace -f -s 1024 -p 10432
</programlisting> </programlisting>
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Check the strace output. Check the strace output.
</para>
<note> <note>
<title>Note from Cary</title> <title>Note from Cary</title>
...@@ -1133,8 +1303,9 @@ Many of the error messages from <productname>ApplixWare</productname> ...@@ -1133,8 +1303,9 @@ Many of the error messages from <productname>ApplixWare</productname>
go to <filename>stderr</filename>, go to <filename>stderr</filename>,
but I'm not sure where <filename>stderr</filename> but I'm not sure where <filename>stderr</filename>
is sent, so <application>strace</application> is the way to find out. is sent, so <application>strace</application> is the way to find out.
</para>
</note> </note>
</step>
</procedure> </procedure>
<para> <para>
...@@ -1152,7 +1323,8 @@ I ran strace on axnet and got ...@@ -1152,7 +1323,8 @@ I ran strace on axnet and got
</programlisting> </programlisting>
So what is happening is that applix elfodbc is searching for libodbc.so, but it So what is happening is that applix elfodbc is searching for libodbc.so, but it
can't find it. That is why axnet.cnf needed to be changed. can't find it. That is why axnet.cnf needed to be changed.
</para>
</sect2>
<sect2> <sect2>
<title>Running the ApplixWare Demo</title> <title>Running the ApplixWare Demo</title>
...@@ -1163,9 +1335,11 @@ the sample tables that the Tutorial refers to. The ELF Macro used to ...@@ -1163,9 +1335,11 @@ the sample tables that the Tutorial refers to. The ELF Macro used to
create the tables tries to use a NULL condition create the tables tries to use a NULL condition
on many of the database columns, on many of the database columns,
and <productname>Postgres</productname> does not currently allow this option. and <productname>Postgres</productname> does not currently allow this option.
</para>
<para> <para>
To get around this problem, you can do the following: To get around this problem, you can do the following:
</para>
<procedure> <procedure>
<title>Modifying the ApplixWare Demo</title> <title>Modifying the ApplixWare Demo</title>
...@@ -1174,60 +1348,83 @@ To get around this problem, you can do the following: ...@@ -1174,60 +1348,83 @@ To get around this problem, you can do the following:
<para> <para>
Copy <filename>/opt/applix/axdata/eng/Demos/sqldemo.am</filename> Copy <filename>/opt/applix/axdata/eng/Demos/sqldemo.am</filename>
to a local directory. to a local directory.
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Edit this local copy of <filename>sqldemo.am</filename>: Edit this local copy of <filename>sqldemo.am</filename>:
</para>
<substeps> <substeps>
<step performance="required"> <step performance="required">
<para> <para>
Search for 'null_clause = "NULL" Search for 'null_clause = "NULL"
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Change this to null_clause = "" Change this to null_clause = ""
</para>
</step>
</substeps> </substeps>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Start <application>Applix Macro Editor</application>. Start <application>Applix Macro Editor</application>.
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Open the sqldemo.am file from the <application>Macro Editor</application>. Open the sqldemo.am file from the <application>Macro Editor</application>.
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Select <command>File->Compile and Save</command>. Select <command>File->Compile and Save</command>.
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Exit <application>Macro Editor</application>. Exit <application>Macro Editor</application>.
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Start <application>Applix Data</application>. Start <application>Applix Data</application>.
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Select <command>*->Run Macro</command> Select <command>*->Run Macro</command>
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Enter the value <quote>sqldemo</quote>, then click <command>OK</command>. Enter the value <quote>sqldemo</quote>, then click <command>OK</command>.
</para>
<para> <para>
You should see the progress in the status line of the data window You should see the progress in the status line of the data window
(in the lower left corner). (in the lower left corner).
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
You should now be able to access the demo tables. You should now be able to access the demo tables.
</para>
</step>
</procedure> </procedure>
</sect2>
<sect2> <sect2>
<title>Useful Macros</title> <title>Useful Macros</title>
...@@ -1249,8 +1446,10 @@ endmacro ...@@ -1249,8 +1446,10 @@ endmacro
<para> <para>
You should be careful about the file protections on any file containing You should be careful about the file protections on any file containing
username and password information. username and password information.
</para>
</caution> </caution>
</para>
</sect2>
<sect2> <sect2>
<title>Supported Platforms</title> <title>Supported Platforms</title>
...@@ -1260,7 +1459,9 @@ on <productname>Linux</productname>. There have been reports of success ...@@ -1260,7 +1459,9 @@ on <productname>Linux</productname>. There have been reports of success
with FreeBSD and with Solaris. There are no known restrictions with FreeBSD and with Solaris. There are no known restrictions
on the basic code for other platforms which already support on the basic code for other platforms which already support
<productname>Postgres</productname>. <productname>Postgres</productname>.
</para>
</sect2>
</sect1>
</Chapter> </Chapter>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
...@@ -1273,9 +1474,9 @@ sgml-always-quote-attributes:t ...@@ -1273,9 +1474,9 @@ sgml-always-quote-attributes:t
sgml-indent-step:1 sgml-indent-step:1
sgml-indent-data:t sgml-indent-data:t
sgml-parent-document:nil sgml-parent-document:nil
sgml-default-dtd-file:"../reference.ced" sgml-default-dtd-file:"./reference.ced"
sgml-exposed-tags:nil sgml-exposed-tags:nil
sgml-local-catalogs:"/usr/lib/sgml/catalog" sgml-local-catalogs:"/usr/lib/sgml/CATALOG"
sgml-local-ecat-files:nil sgml-local-ecat-files:nil
End: End:
--> -->
doc/src/sgml/oper.sgml
View file @ a75f2d21
...@@ -15,6 +15,7 @@ These operators are declared in the system catalog ...@@ -15,6 +15,7 @@ These operators are declared in the system catalog
pg_operator. Every entry in pg_operator includes pg_operator. Every entry in pg_operator includes
the name of the procedure that implements the operator and the the name of the procedure that implements the operator and the
class <Acronym>OIDs</Acronym> of the input and output types. class <Acronym>OIDs</Acronym> of the input and output types.
</Para>
<Para> <Para>
To view all variations of the <Quote>||</Quote> string concatenation operator, To view all variations of the <Quote>||</Quote> string concatenation operator,
...@@ -45,11 +46,12 @@ as: ...@@ -45,11 +46,12 @@ as:
<ProgramListing> <ProgramListing>
select * from emp where int4lt(salary, 40000); select * from emp where int4lt(salary, 40000);
</ProgramListing> </ProgramListing>
</Para>
<Para> <Para>
<Application>psql</Application> <Application>psql</Application>
has a command (<Command>\dd</Command>) to show these operators. has a command (<Command>\dd</Command>) to show these operators.
</Para>
<sect1> <sect1>
<title>Lexical Precedence</title> <title>Lexical Precedence</title>
...@@ -70,180 +72,255 @@ Operator Ordering (decreasing precedence) ...@@ -70,180 +72,255 @@ Operator Ordering (decreasing precedence)
<row> <row>
<entry> <entry>
Element Element
</entry>
<entry> <entry>
Precedence Precedence
</entry>
<entry> <entry>
Description Description
</entry>
</row>
</thead> </thead>
<tbody> <tbody>
<row> <row>
<entry> <entry>
UNION UNION
</entry>
<entry> <entry>
left left
</entry>
<entry> <entry>
SQL select construct SQL select construct
</entry>
</row>
<row> <row>
<entry> <entry>
:: ::
</entry>
<entry> <entry>
</entry>
<entry> <entry>
<productname>Postgres</productname> typecasting <productname>Postgres</productname> typecasting
</entry>
</row>
<row> <row>
<entry> <entry>
[ ] [ ]
</entry>
<entry> <entry>
left left
</entry>
<entry> <entry>
array delimiters array delimiters
</entry>
</row>
<row> <row>
<entry> <entry>
. .
</entry>
<entry> <entry>
left left
</entry>
<entry> <entry>
table/column delimiter table/column delimiter
</entry>
</row>
<row> <row>
<entry> <entry>
- -
</entry>
<entry> <entry>
right right
</entry>
<entry> <entry>
unary minus unary minus
</entry>
</row>
<row> <row>
<entry> <entry>
; ;
</entry>
<entry> <entry>
left left
</entry>
<entry> <entry>
statement termination, logarithm statement termination, logarithm
</entry>
</row>
<row> <row>
<entry> <entry>
: :
</entry>
<entry> <entry>
right right
</entry>
<entry> <entry>
exponentiation exponentiation
</entry>
</row>
<row> <row>
<entry> <entry>
| |
</entry>
<entry> <entry>
left left
</entry>
<entry> <entry>
start of interval start of interval
</entry>
</row>
<row> <row>
<entry> <entry>
* / * /
</entry>
<entry> <entry>
left left
</entry>
<entry> <entry>
multiplication, division multiplication, division
</entry>
</row>
<row> <row>
<entry> <entry>
+ - + -
</entry>
<entry> <entry>
left left
</entry>
<entry> <entry>
addition, subtraction addition, subtraction
</entry>
</row>
<row> <row>
<entry> <entry>
IS IS
</entry>
<entry> <entry>
</entry>
<entry> <entry>
test for TRUE, FALSE, NULL test for TRUE, FALSE, NULL
</entry>
</row>
<row> <row>
<entry> <entry>
ISNULL ISNULL
</entry>
<entry> <entry>
</entry>
<entry> <entry>
test for NULL test for NULL
</entry>
</row>
<row> <row>
<entry> <entry>
NOTNULL NOTNULL
</entry>
<entry> <entry>
</entry>
<entry> <entry>
test for NOT NULL test for NOT NULL
</entry>
</row>
<row> <row>
<entry> <entry>
(all other operators) (all other operators)
</entry>
<entry> <entry>
</entry>
<entry> <entry>
native and user-defined native and user-defined
</entry>
</row>
<row> <row>
<entry> <entry>
IN IN
</entry>
<entry> <entry>
</entry>
<entry> <entry>
set membership set membership
</entry>
</row>
<row> <row>
<entry> <entry>
BETWEEN BETWEEN
</entry>
<entry> <entry>
</entry>
<entry> <entry>
containment containment
</entry>
</row>
<row> <row>
<entry> <entry>
LIKE LIKE
</entry>
<entry> <entry>
</entry>
<entry> <entry>
string pattern matching string pattern matching
</entry>
</row>
<row> <row>
<entry> <entry>
&lt; &gt; &lt; &gt;
</entry>
<entry> <entry>
</entry>
<entry> <entry>
boolean inequality boolean inequality
</entry>
</row>
<row> <row>
<entry> <entry>
= =
</entry>
<entry> <entry>
right right
</entry>
<entry> <entry>
equality equality
</entry>
</row>
<row> <row>
<entry> <entry>
NOT NOT
</entry>
<entry> <entry>
right right
</entry>
<entry> <entry>
negation negation
</entry>
</row>
<row> <row>
<entry> <entry>
AND AND
</entry>
<entry> <entry>
left left
</entry>
<entry> <entry>
logical intersection logical intersection
</entry>
</row>
<row> <row>
<entry> <entry>
OR OR
</entry>
<entry> <entry>
left left
</entry>
<entry> <entry>
logical union logical union
</entry>
</row>
</tbody> </tbody>
</tgroup>
</table> </table>
</para>
</sect1>
<sect1> <sect1>
<title>General Operators</title> <title>General Operators</title>
...@@ -251,7 +328,7 @@ logical union ...@@ -251,7 +328,7 @@ logical union
<para> <para>
The operators listed here are defined for a number of native data types, The operators listed here are defined for a number of native data types,
ranging from numeric types to data/time types. ranging from numeric types to data/time types.
</para>
<Para> <Para>
<TABLE TOCENTRY="1"> <TABLE TOCENTRY="1">
<TITLE><ProductName>Postgres</ProductName> Operators</TITLE> <TITLE><ProductName>Postgres</ProductName> Operators</TITLE>
...@@ -339,6 +416,7 @@ ranging from numeric types to data/time types. ...@@ -339,6 +416,7 @@ ranging from numeric types to data/time types.
</TGROUP> </TGROUP>
</TABLE> </TABLE>
</Para> </Para>
</sect1>
<sect1> <sect1>
<title id="math-opers">Numerical Operators</title> <title id="math-opers">Numerical Operators</title>
...@@ -430,6 +508,7 @@ ranging from numeric types to data/time types. ...@@ -430,6 +508,7 @@ ranging from numeric types to data/time types.
</TGROUP> </TGROUP>
</TABLE> </TABLE>
</Para> </Para>
</sect1>
<sect1> <sect1>
<title>Geometric Operators</title> <title>Geometric Operators</title>
...@@ -571,6 +650,7 @@ ranging from numeric types to data/time types. ...@@ -571,6 +650,7 @@ ranging from numeric types to data/time types.
</TGROUP> </TGROUP>
</TABLE> </TABLE>
</Para> </Para>
</sect1>
<sect1> <sect1>
<title>Time Interval Operators</title> <title>Time Interval Operators</title>
...@@ -651,6 +731,7 @@ are several operators for this type. ...@@ -651,6 +731,7 @@ are several operators for this type.
</TGROUP> </TGROUP>
</TABLE> </TABLE>
</Para> </Para>
</sect1>
<Sect1> <Sect1>
<title id="cidr-opers">IP V4 Operators</title> <title id="cidr-opers">IP V4 Operators</title>
......
doc/src/sgml/page.sgml
View file @ a75f2d21
...@@ -11,6 +11,7 @@ A description of the database file default page format. ...@@ -11,6 +11,7 @@ A description of the database file default page format.
<para> <para>
This section provides an overview of the page format used by <productname>Postgres</productname> This section provides an overview of the page format used by <productname>Postgres</productname>
classes. User-defined access methods need not use this page format. classes. User-defined access methods need not use this page format.
</para>
<para> <para>
In the following explanation, a In the following explanation, a
...@@ -18,6 +19,7 @@ In the following explanation, a ...@@ -18,6 +19,7 @@ In the following explanation, a
is assumed to contain 8 bits. In addition, the term is assumed to contain 8 bits. In addition, the term
<firstterm>item</firstterm> <firstterm>item</firstterm>
refers to data which is stored in <productname>Postgres</productname> classes. refers to data which is stored in <productname>Postgres</productname> classes.
</para>
<sect1> <sect1>
<title>Page Structure</title> <title>Page Structure</title>
...@@ -41,50 +43,73 @@ Description ...@@ -41,50 +43,73 @@ Description
</entry> </entry>
</row> </row>
</thead> </thead>
<tbody> <tbody>
<row> <row>
<entry> <entry>
itemPointerData itemPointerData
</entry> </entry>
</row>
<row> <row>
<entry> <entry>
filler filler
</entry> </entry>
</row>
<row> <row>
<entry> <entry>
itemData... itemData...
</entry> </entry>
</row>
<row> <row>
<entry> <entry>
Unallocated Space Unallocated Space
</entry> </entry>
</row>
<row> <row>
<entry> <entry>
ItemContinuationData ItemContinuationData
</entry> </entry>
</row>
<row> <row>
<entry> <entry>
Special Space Special Space
</entry> </entry>
</row>
<row> <row>
<entry> <entry>
``ItemData 2'' ``ItemData 2''
</entry> </entry>
</row>
<row> <row>
<entry> <entry>
``ItemData 1'' ``ItemData 1''
</entry> </entry>
</row>
<row> <row>
<entry> <entry>
ItemIdData ItemIdData
</entry> </entry>
</row>
<row> <row>
<entry> <entry>
PageHeaderData PageHeaderData
</entry> </entry>
</row>
</tbody> </tbody>
</tgroup> </tgroup>
</table> </table>
</para>
<!-- <!--
.\" Running .\" Running
...@@ -121,6 +146,7 @@ the page. Page size is stored in each page because frames in the ...@@ -121,6 +146,7 @@ the page. Page size is stored in each page because frames in the
buffer pool may be subdivided into equal sized pages on a frame by buffer pool may be subdivided into equal sized pages on a frame by
frame basis within a class. The internal fragmentation information is frame basis within a class. The internal fragmentation information is
used to aid in determining when page reorganization should occur. used to aid in determining when page reorganization should occur.
</para>
<para> <para>
Following the page header are item identifiers Following the page header are item identifiers
...@@ -134,6 +160,7 @@ created by <productname>Postgres</productname> consists of a frame number and an ...@@ -134,6 +160,7 @@ created by <productname>Postgres</productname> consists of a frame number and an
identifier. An item identifier contains a byte-offset to the start of identifier. An item identifier contains a byte-offset to the start of
an item, its length in bytes, and a set of attribute bits which affect an item, its length in bytes, and a set of attribute bits which affect
its interpretation. its interpretation.
</para>
<para> <para>
The items themselves are stored in space allocated backwards from The items themselves are stored in space allocated backwards from
...@@ -148,6 +175,8 @@ This structure contains ...@@ -148,6 +175,8 @@ This structure contains
itemPointerData itemPointerData
which points to the next piece and the piece itself. The last piece which points to the next piece and the piece itself. The last piece
is handled normally. is handled normally.
</para>
</sect1>
<sect1> <sect1>
<title>Files</title> <title>Files</title>
...@@ -161,6 +190,9 @@ is handled normally. ...@@ -161,6 +190,9 @@ is handled normally.
<listitem> <listitem>
<para> <para>
Location of shared (global) database files. Location of shared (global) database files.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
...@@ -169,8 +201,13 @@ Location of shared (global) database files. ...@@ -169,8 +201,13 @@ Location of shared (global) database files.
<listitem> <listitem>
<para> <para>
Location of local database files. Location of local database files.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</para>
</sect1>
<sect1> <sect1>
<title>Bugs</title> <title>Bugs</title>
...@@ -178,9 +215,11 @@ Location of local database files. ...@@ -178,9 +215,11 @@ Location of local database files.
<para> <para>
The page format may change in the future to provide more efficient The page format may change in the future to provide more efficient
access to large objects. access to large objects.
</para>
<para> <para>
This section contains insufficient detail to be of any assistance in This section contains insufficient detail to be of any assistance in
writing a new access method. writing a new access method.
</para>
</sect1>
</chapter> </chapter>
doc/src/sgml/pg_options.sgml
View file @ a75f2d21
...@@ -17,7 +17,7 @@ ...@@ -17,7 +17,7 @@
Contributed by <ULink url="mailto:dz@cs.unitn.it">Massimo Dal Zotto</ULink> Contributed by <ULink url="mailto:dz@cs.unitn.it">Massimo Dal Zotto</ULink>
</Para> </Para>
</Note> </Note>
</para>
<Para> <Para>
The optional file <filename>data/pg_options</filename> contains runtime The optional file <filename>data/pg_options</filename> contains runtime
options used by the backend to control trace messages and other backend options used by the backend to control trace messages and other backend
...@@ -32,7 +32,7 @@ parameters which can be used by the backend to control its behaviour. ...@@ -32,7 +32,7 @@ parameters which can be used by the backend to control its behaviour.
New options and parameters must be defined in New options and parameters must be defined in
<filename>backend/utils/misc/trace.c</filename> and <filename>backend/utils/misc/trace.c</filename> and
<filename>backend/include/utils/trace.h</filename>. <filename>backend/include/utils/trace.h</filename>.
</para>
<Para> <Para>
For example suppose we want to add conditional trace messages and a tunable For example suppose we want to add conditional trace messages and a tunable
numeric parameter to the code in file <filename>foo.c</filename>. numeric parameter to the code in file <filename>foo.c</filename>.
...@@ -78,7 +78,7 @@ foo_function(int x, int y) ...@@ -78,7 +78,7 @@ foo_function(int x, int y)
} }
} }
</programlisting> </programlisting>
</para>
<para> <para>
Existing files using private trace flags can be changed by simply adding Existing files using private trace flags can be changed by simply adding
the following code: the following code:
...@@ -88,7 +88,7 @@ the following code: ...@@ -88,7 +88,7 @@ the following code:
/* int my_own_flag = 0; -- removed */ /* int my_own_flag = 0; -- removed */
#define my_own_flag pg_options[OPT_MY_OWN_FLAG] #define my_own_flag pg_options[OPT_MY_OWN_FLAG]
</programlisting> </programlisting>
</para>
<para> <para>
All pg_options are initialized to zero at backend startup. If we need a All pg_options are initialized to zero at backend startup. If we need a
different default value we must add some initialization code at the beginning different default value we must add some initialization code at the beginning
...@@ -103,14 +103,14 @@ Now we can set the foo_param and enable foo trace by writing values into the ...@@ -103,14 +103,14 @@ Now we can set the foo_param and enable foo trace by writing values into the
foo=1 foo=1
fooparam=17 fooparam=17
</programlisting> </programlisting>
</para>
<para> <para>
The new options will be read by all new backends when they are started. The new options will be read by all new backends when they are started.
To make effective the changes for all running backends we need to send a To make effective the changes for all running backends we need to send a
SIGHUP to the postmaster. The signal will be automatically sent to all the SIGHUP to the postmaster. The signal will be automatically sent to all the
backends. We can also activate the changes only for a specific backend by backends. We can also activate the changes only for a specific backend by
sending the SIGHUP directly to it. sending the SIGHUP directly to it.
</para>
<para> <para>
pg_options can also be specified with the <option>-T</option> switch of pg_options can also be specified with the <option>-T</option> switch of
<productname>Postgres</productname>: <productname>Postgres</productname>:
...@@ -118,7 +118,7 @@ pg_options can also be specified with the <option>-T</option> switch of ...@@ -118,7 +118,7 @@ pg_options can also be specified with the <option>-T</option> switch of
<programlisting> <programlisting>
postgres <replaceable>options</replaceable> -T "verbose=2,query,hostlookup-" postgres <replaceable>options</replaceable> -T "verbose=2,query,hostlookup-"
</programlisting> </programlisting>
</para>
<Para> <Para>
The functions used for printing errors and debug messages can now make use The functions used for printing errors and debug messages can now make use
of the <citetitle>syslog(2)</citetitle> facility. Message printed to stdout of the <citetitle>syslog(2)</citetitle> facility. Message printed to stdout
...@@ -135,13 +135,13 @@ or stderr are prefixed by a timestamp containing also the backend pid: ...@@ -135,13 +135,13 @@ or stderr are prefixed by a timestamp containing also the backend pid:
980127.19:52:14.413 [29286] Async_NotifyFrontEnd done 980127.19:52:14.413 [29286] Async_NotifyFrontEnd done
980127.19:52:14.466 [29286] Async_NotifyHandler done 980127.19:52:14.466 [29286] Async_NotifyHandler done
</programlisting> </programlisting>
</para>
<para> <para>
This format improves readability of the logs and allows people to understand This format improves readability of the logs and allows people to understand
exactly which backend is doing what and at which time. It also makes exactly which backend is doing what and at which time. It also makes
easier to write simple awk or perl scripts which monitor the log to easier to write simple awk or perl scripts which monitor the log to
detect database errors or problem, or to compute transaction time statistics. detect database errors or problem, or to compute transaction time statistics.
</para>
<para> <para>
Messages printed to syslog use the log facility LOG_LOCAL0. Messages printed to syslog use the log facility LOG_LOCAL0.
The use of syslog can be controlled with the syslog pg_option. The use of syslog can be controlled with the syslog pg_option.
...@@ -207,313 +207,421 @@ The options currently defined in ...@@ -207,313 +207,421 @@ The options currently defined in
<varlistentry> <varlistentry>
<term> <term>
all all
</term>
<listitem> <listitem>
<para> <para>
Global trace flag. Allowed values are: Global trace flag. Allowed values are:
</para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>
0 0
</term>
<listitem> <listitem>
<para> <para>
Trace messages enabled individually Trace messages enabled individually
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
1 1
</term>
<listitem> <listitem>
<para> <para>
Enable all trace messages Enable all trace messages
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
-1 -1
</term>
<listitem> <listitem>
<para> <para>
Disable all trace messages Disable all trace messages
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
verbose verbose
</term>
<listitem> <listitem>
<para> <para>
Verbosity flag. Allowed values are: Verbosity flag. Allowed values are:
</para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>
0 0
</term>
<listitem> <listitem>
<para> <para>
No messages. This is the default. No messages. This is the default.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
1 1
</term>
<listitem> <listitem>
<para> <para>
Print information messages. Print information messages.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
2 2
</term>
<listitem> <listitem>
<para> <para>
Print more information messages. Print more information messages.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
query query
</term>
<listitem> <listitem>
<para> <para>
Query trace flag. Allowed values are: Query trace flag. Allowed values are:
</para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>
0 0
</term>
<listitem> <listitem>
<para> <para>
Don't print query. Don't print query.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
1 1
</term>
<listitem> <listitem>
<para> <para>
Print a condensed query in one line. Print a condensed query in one line.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
4 4
</term>
<listitem> <listitem>
<para> <para>
Print the full query. Print the full query.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
plan plan
</term>
<listitem> <listitem>
<para> <para>
Print query plan. Print query plan.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
parse parse
</term>
<listitem> <listitem>
<para> <para>
Print parser output. Print parser output.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
rewritten rewritten
</term>
<listitem> <listitem>
<para> <para>
Print rewritten query. Print rewritten query.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
parserstats parserstats
</term>
<listitem> <listitem>
<para> <para>
Print parser statistics. Print parser statistics.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
plannerstats plannerstats
</term>
<listitem> <listitem>
<para> <para>
Print planner statistics. Print planner statistics.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
executorstats executorstats
</term>
<listitem> <listitem>
<para> <para>
Print executor statistics. Print executor statistics.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
shortlocks shortlocks
</term>
<listitem> <listitem>
<para> <para>
Currently unused but needed to enable features in the future. Currently unused but needed to enable features in the future.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
locks locks
</term>
<listitem> <listitem>
<para> <para>
Trace locks. Trace locks.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
userlocks userlocks
</term>
<listitem> <listitem>
<para> <para>
Trace user locks. Trace user locks.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
spinlocks spinlocks
</term>
<listitem> <listitem>
<para> <para>
Trace spin locks. Trace spin locks.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
notify notify
</term>
<listitem> <listitem>
<para> <para>
Trace notify functions. Trace notify functions.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
malloc malloc
</term>
<listitem> <listitem>
<para> <para>
Currently unused. Currently unused.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
palloc palloc
</term>
<listitem> <listitem>
<para> <para>
Currently unused. Currently unused.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
lock_debug_oidmin lock_debug_oidmin
</term>
<listitem> <listitem>
<para> <para>
Minimum relation oid traced by locks. Minimum relation oid traced by locks.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
lock_debug_relid lock_debug_relid
</term>
<listitem> <listitem>
<para> <para>
oid, if not zero, of relation traced by locks. oid, if not zero, of relation traced by locks.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
lock_read_priority lock_read_priority
</term>
<listitem> <listitem>
<para> <para>
Currently unused. Currently unused.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
deadlock_timeout deadlock_timeout
</term>
<listitem> <listitem>
<para> <para>
Deadlock check timer. Deadlock check timer.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
syslog syslog
</term>
<listitem> <listitem>
<para> <para>
syslog flag. Allowed values are: syslog flag. Allowed values are:
</para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>
0 0
</term>
<listitem> <listitem>
<para> <para>
Messages to stdout/stderr. Messages to stdout/stderr.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
1 1
</term>
<listitem> <listitem>
<para> <para>
Messages to stdout/stderr and syslog. Messages to stdout/stderr and syslog.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
2 2
</term>
<listitem> <listitem>
<para> <para>
Messages only to syslog. Messages only to syslog.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
hostlookup hostlookup
</term>
<listitem> <listitem>
<para> <para>
Enable hostname lookup in ps_status. Enable hostname lookup in ps_status.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
showportnumber showportnumber
</term>
<listitem> <listitem>
<para> <para>
Show port number in ps_status. Show port number in ps_status.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
notifyunlock notifyunlock
</term>
<listitem> <listitem>
<para> <para>
Unlock of pg_listener after notify. Unlock of pg_listener after notify.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
notifyhack notifyhack
</term>
<listitem> <listitem>
<para> <para>
Remove duplicate tuples from pg_listener. Remove duplicate tuples from pg_listener.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
......
doc/src/sgml/ports.sgml
View file @ a75f2d21
...@@ -8,6 +8,7 @@ compiled and tested <ProductName>Postgres</ProductName> on a ...@@ -8,6 +8,7 @@ compiled and tested <ProductName>Postgres</ProductName> on a
number of platforms. Check number of platforms. Check
<ulink url="http://www.postgresql.org/docs/admin/ports.htm">the web site</ulink> <ulink url="http://www.postgresql.org/docs/admin/ports.htm">the web site</ulink>
for the latest information. for the latest information.
</para>
<Sect1> <Sect1>
<Title>Currently Supported Platforms</Title> <Title>Currently Supported Platforms</Title>
...@@ -226,11 +227,11 @@ At the time of publication, the following platforms have been tested: ...@@ -226,11 +227,11 @@ At the time of publication, the following platforms have been tested:
</TBODY> </TBODY>
</TGROUP> </TGROUP>
</TABLE> </TABLE>
</para>
<para> <para>
Platforms listed for v6.3.x should also work with v6.4, but we did not receive Platforms listed for v6.3.x should also work with v6.4, but we did not receive
confirmation of such at the time this list was compiled. confirmation of such at the time this list was compiled.
</para>
<note> <note>
<para> <para>
For <productname>Windows NT</productname>, For <productname>Windows NT</productname>,
...@@ -240,7 +241,9 @@ accomplished. Check ...@@ -240,7 +241,9 @@ accomplished. Check
for up to date information. You may also want to for up to date information. You may also want to
look for possible patches on the look for possible patches on the
<ulink url="http://postgresql.org">Postgres web site</ulink>. <ulink url="http://postgresql.org">Postgres web site</ulink>.
</para>
</note> </note>
</sect1>
<Sect1> <Sect1>
<Title>Unsupported Platforms</Title> <Title>Unsupported Platforms</Title>
...@@ -309,6 +312,7 @@ Others listed here do not provide sufficient library support for an attempt. ...@@ -309,6 +312,7 @@ Others listed here do not provide sufficient library support for an attempt.
</TBODY> </TBODY>
</TGROUP> </TGROUP>
</TABLE> </TABLE>
</para>
<Para> <Para>
Note that Windows ports of the frontend are apparently possible Note that Windows ports of the frontend are apparently possible
......
doc/src/sgml/protocol.sgml
View file @ a75f2d21
...@@ -15,6 +15,7 @@ Written by <ULink url="mailto:phil@river-bank.demon.co.uk">Phil Thompson</ULink> ...@@ -15,6 +15,7 @@ Written by <ULink url="mailto:phil@river-bank.demon.co.uk">Phil Thompson</ULink>
Updates for protocol 2.0 by <ULink url="mailto:tgl@sss.pgh.pa.us">Tom Lane</ULink>. Updates for protocol 2.0 by <ULink url="mailto:tgl@sss.pgh.pa.us">Tom Lane</ULink>.
</Para> </Para>
</Note> </Note>
</para>
<Para> <Para>
<ProductName>Postgres</ProductName> uses a message-based protocol for communication between frontends <ProductName>Postgres</ProductName> uses a message-based protocol for communication between frontends
...@@ -23,15 +24,18 @@ and backends. The protocol is implemented over <Acronym>TCP/IP</Acronym> and al ...@@ -23,15 +24,18 @@ and backends. The protocol is implemented over <Acronym>TCP/IP</Acronym> and al
This was done in such This was done in such
a way as to still allow connections from earlier versions of frontends, but a way as to still allow connections from earlier versions of frontends, but
this document does not cover the protocol used by those earlier versions. this document does not cover the protocol used by those earlier versions.
</para>
<Para> <Para>
This document describes version 2.0 of the protocol, implemented in This document describes version 2.0 of the protocol, implemented in
<ProductName>Postgres</ProductName> v6.4 and later. <ProductName>Postgres</ProductName> v6.4 and later.
</para>
<Para> <Para>
Higher level features built on this protocol (for example, how <FileName>libpq</FileName> passes Higher level features built on this protocol (for example, how <FileName>libpq</FileName> passes
certain environment variables after the connection is established) certain environment variables after the connection is established)
are covered elsewhere. are covered elsewhere.
</para>
<Sect1> <Sect1>
<Title>Overview</Title> <Title>Overview</Title>
...@@ -40,6 +44,7 @@ are covered elsewhere. ...@@ -40,6 +44,7 @@ are covered elsewhere.
The three major components are the frontend (running on the client) and the The three major components are the frontend (running on the client) and the
postmaster and backend (running on the server). The postmaster and backend postmaster and backend (running on the server). The postmaster and backend
have different roles but may be implemented by the same executable. have different roles but may be implemented by the same executable.
</para>
<Para> <Para>
A frontend sends a startup packet to the postmaster. This includes the names A frontend sends a startup packet to the postmaster. This includes the names
...@@ -47,6 +52,7 @@ of the user and the database the user wants to connect to. The postmaster then ...@@ -47,6 +52,7 @@ of the user and the database the user wants to connect to. The postmaster then
uses this, and the information in the pg_hba.conf(5) file to determine what uses this, and the information in the pg_hba.conf(5) file to determine what
further authentication information it requires the frontend to send (if any) further authentication information it requires the frontend to send (if any)
and responds to the frontend accordingly. and responds to the frontend accordingly.
</para>
<Para> <Para>
The frontend then sends any required authentication information. Once the The frontend then sends any required authentication information. Once the
...@@ -54,6 +60,7 @@ postmaster validates this it responds to the frontend that it is authenticated ...@@ -54,6 +60,7 @@ postmaster validates this it responds to the frontend that it is authenticated
and hands over the connection to a backend. The backend then sends a message and hands over the connection to a backend. The backend then sends a message
indicating successful startup (normal case) or failure (for example, an indicating successful startup (normal case) or failure (for example, an
invalid database name). invalid database name).
</para>
<Para> <Para>
Subsequent communications are query and result packets exchanged between the Subsequent communications are query and result packets exchanged between the
...@@ -61,16 +68,20 @@ frontend and the backend. The postmaster takes no further part in ordinary ...@@ -61,16 +68,20 @@ frontend and the backend. The postmaster takes no further part in ordinary
query/result communication. (However, the postmaster is involved when the query/result communication. (However, the postmaster is involved when the
frontend wishes to cancel a query currently being executed by its backend. frontend wishes to cancel a query currently being executed by its backend.
Further details about that appear below.) Further details about that appear below.)
</para>
<Para> <Para>
When the frontend wishes to disconnect it sends an appropriate packet and When the frontend wishes to disconnect it sends an appropriate packet and
closes the connection without waiting for a response for the backend. closes the connection without waiting for a response for the backend.
</para>
<Para> <Para>
Packets are sent as a data stream. The first byte determines what should be Packets are sent as a data stream. The first byte determines what should be
expected in the rest of the packet. The exception is packets sent from a expected in the rest of the packet. The exception is packets sent from a
frontend to the postmaster, which comprise a packet length then the packet frontend to the postmaster, which comprise a packet length then the packet
itself. The difference is historical. itself. The difference is historical.
</para>
</sect1>
<Sect1> <Sect1>
<Title>Protocol</Title> <Title>Protocol</Title>
...@@ -81,6 +92,7 @@ flows depending on the state of the connection: ...@@ -81,6 +92,7 @@ flows depending on the state of the connection:
startup, query, function call, and termination. startup, query, function call, and termination.
There are also special provisions for notification responses and command There are also special provisions for notification responses and command
cancellation, which can occur at any time after the startup phase. cancellation, which can occur at any time after the startup phase.
</para>
<Sect2> <Sect2>
...@@ -88,12 +100,14 @@ cancellation, which can occur at any time after the startup phase. ...@@ -88,12 +100,14 @@ cancellation, which can occur at any time after the startup phase.
<Para> <Para>
Startup is divided into an authentication phase and a backend startup phase. Startup is divided into an authentication phase and a backend startup phase.
</para>
<Para> <Para>
Initially, the frontend sends a StartupPacket. The postmaster uses this info Initially, the frontend sends a StartupPacket. The postmaster uses this info
and the contents of the pg_hba.conf(5) file to determine what authentication and the contents of the pg_hba.conf(5) file to determine what authentication
method the frontend must use. The postmaster then responds with one of the method the frontend must use. The postmaster then responds with one of the
following messages: following messages:
</para>
<Para> <Para>
<VariableList> <VariableList>
...@@ -176,6 +190,7 @@ following messages: ...@@ -176,6 +190,7 @@ following messages:
<Para> <Para>
If the frontend does not support the authentication method requested by the If the frontend does not support the authentication method requested by the
postmaster, then it should immediately close the connection. postmaster, then it should immediately close the connection.
</para>
<Para> <Para>
After sending AuthenticationOk, the postmaster attempts to launch a backend After sending AuthenticationOk, the postmaster attempts to launch a backend
...@@ -184,7 +199,6 @@ during startup, the frontend must wait for the backend to acknowledge ...@@ -184,7 +199,6 @@ during startup, the frontend must wait for the backend to acknowledge
successful startup. The frontend should send no messages at this point. successful startup. The frontend should send no messages at this point.
The possible messages from the backend during this phase are: The possible messages from the backend during this phase are:
<Para>
<VariableList> <VariableList>
<VarListEntry> <VarListEntry>
<Term> <Term>
...@@ -244,7 +258,8 @@ reasonable to consider ReadyForQuery as starting a query cycle (and then ...@@ -244,7 +258,8 @@ reasonable to consider ReadyForQuery as starting a query cycle (and then
BackendKeyData indicates successful conclusion of the startup phase), BackendKeyData indicates successful conclusion of the startup phase),
or to consider ReadyForQuery as ending the startup phase and each subsequent or to consider ReadyForQuery as ending the startup phase and each subsequent
query cycle. query cycle.
</para>
</sect2>
<Sect2> <Sect2>
<Title>Query</Title> <Title>Query</Title>
...@@ -255,11 +270,11 @@ backend. The backend then sends one or more response messages depending ...@@ -255,11 +270,11 @@ backend. The backend then sends one or more response messages depending
on the contents of the query command string, and finally a ReadyForQuery on the contents of the query command string, and finally a ReadyForQuery
response message. ReadyForQuery informs the frontend that it may safely response message. ReadyForQuery informs the frontend that it may safely
send a new query or function call. send a new query or function call.
</para>
<Para> <Para>
The possible response messages from the backend are: The possible response messages from the backend are:
<Para>
<VariableList> <VariableList>
<VarListEntry> <VarListEntry>
<Term> <Term>
...@@ -390,6 +405,7 @@ The possible response messages from the backend are: ...@@ -390,6 +405,7 @@ The possible response messages from the backend are:
<Para> <Para>
A frontend must be prepared to accept ErrorResponse and NoticeResponse A frontend must be prepared to accept ErrorResponse and NoticeResponse
messages whenever it is expecting any other type of message. messages whenever it is expecting any other type of message.
</para>
<Para> <Para>
Actually, it is possible for NoticeResponse to arrive even when the frontend Actually, it is possible for NoticeResponse to arrive even when the frontend
...@@ -398,11 +414,13 @@ is not expecting any kind of message, that is, the backend is nominally idle. ...@@ -398,11 +414,13 @@ is not expecting any kind of message, that is, the backend is nominally idle.
In that case it will send a NoticeResponse before closing the connection.) In that case it will send a NoticeResponse before closing the connection.)
It is recommended that the frontend check for such asynchronous notices just It is recommended that the frontend check for such asynchronous notices just
before issuing any new command. before issuing any new command.
</para>
<Para> <Para>
Also, if the frontend issues any listen(l) commands then it must be prepared Also, if the frontend issues any listen(l) commands then it must be prepared
to accept NotificationResponse messages at any time; see below. to accept NotificationResponse messages at any time; see below.
</para>
</sect2>
<Sect2> <Sect2>
<Title>Function Call</Title> <Title>Function Call</Title>
...@@ -413,11 +431,11 @@ message to the backend. The backend then sends one or more response messages ...@@ -413,11 +431,11 @@ message to the backend. The backend then sends one or more response messages
depending on the results of the function call, and finally a ReadyForQuery depending on the results of the function call, and finally a ReadyForQuery
response message. ReadyForQuery informs the frontend that it may safely send response message. ReadyForQuery informs the frontend that it may safely send
a new query or function call. a new query or function call.
</para>
<Para> <Para>
The possible response messages from the backend are: The possible response messages from the backend are:
<Para>
<VariableList> <VariableList>
<VarListEntry> <VarListEntry>
<Term> <Term>
...@@ -482,7 +500,8 @@ A frontend must be prepared to accept ErrorResponse and NoticeResponse ...@@ -482,7 +500,8 @@ A frontend must be prepared to accept ErrorResponse and NoticeResponse
messages whenever it is expecting any other type of message. Also, messages whenever it is expecting any other type of message. Also,
if it issues any listen(l) commands then it must be prepared to accept if it issues any listen(l) commands then it must be prepared to accept
NotificationResponse messages at any time; see below. NotificationResponse messages at any time; see below.
</para>
</sect2>
<Sect2> <Sect2>
<Title>Notification Responses</Title> <Title>Notification Responses</Title>
...@@ -491,6 +510,7 @@ NotificationResponse messages at any time; see below. ...@@ -491,6 +510,7 @@ NotificationResponse messages at any time; see below.
If a frontend issues a listen(l) command, then the backend will send a If a frontend issues a listen(l) command, then the backend will send a
NotificationResponse message (not to be confused with NoticeResponse!) NotificationResponse message (not to be confused with NoticeResponse!)
whenever a notify(l) command is executed for the same notification name. whenever a notify(l) command is executed for the same notification name.
</para>
<Para> <Para>
Notification responses are permitted at any point in the protocol (after Notification responses are permitted at any point in the protocol (after
...@@ -499,7 +519,6 @@ must be prepared to recognize a NotificationResponse message whenever it is ...@@ -499,7 +519,6 @@ must be prepared to recognize a NotificationResponse message whenever it is
expecting any message. Indeed, it should be able to handle expecting any message. Indeed, it should be able to handle
NotificationResponse messages even when it is not engaged in a query. NotificationResponse messages even when it is not engaged in a query.
<Para>
<VariableList> <VariableList>
<VarListEntry> <VarListEntry>
<Term> <Term>
...@@ -521,7 +540,8 @@ It may be worth pointing out that the names used in listen and notify ...@@ -521,7 +540,8 @@ It may be worth pointing out that the names used in listen and notify
commands need not have anything to do with names of relations (tables) commands need not have anything to do with names of relations (tables)
in the SQL database. Notification names are simply arbitrarily chosen in the SQL database. Notification names are simply arbitrarily chosen
condition names. condition names.
</para>
</sect2>
<Sect2> <Sect2>
<Title>Cancelling Requests in Progress</Title> <Title>Cancelling Requests in Progress</Title>
...@@ -534,6 +554,7 @@ we don't want to have the backend constantly checking for new input from ...@@ -534,6 +554,7 @@ we don't want to have the backend constantly checking for new input from
the frontend during query processing. Cancel requests should be relatively the frontend during query processing. Cancel requests should be relatively
infrequent, so we make them slightly cumbersome in order to avoid a penalty infrequent, so we make them slightly cumbersome in order to avoid a penalty
in the normal case. in the normal case.
</para>
<Para> <Para>
To issue a cancel request, the frontend opens a new connection to the To issue a cancel request, the frontend opens a new connection to the
...@@ -541,18 +562,21 @@ postmaster and sends a CancelRequest message, rather than the StartupPacket ...@@ -541,18 +562,21 @@ postmaster and sends a CancelRequest message, rather than the StartupPacket
message that would ordinarily be sent across a new connection. The postmaster message that would ordinarily be sent across a new connection. The postmaster
will process this request and then close the connection. For security will process this request and then close the connection. For security
reasons, no direct reply is made to the cancel request message. reasons, no direct reply is made to the cancel request message.
</para>
<Para> <Para>
A CancelRequest message will be ignored unless it contains the same key data A CancelRequest message will be ignored unless it contains the same key data
(PID and secret key) passed to the frontend during connection startup. If the (PID and secret key) passed to the frontend during connection startup. If the
request matches the PID and secret key for a currently executing backend, the request matches the PID and secret key for a currently executing backend, the
postmaster signals the backend to abort processing of the current query. postmaster signals the backend to abort processing of the current query.
</para>
<Para> <Para>
The cancellation signal may or may not have any effect --- for example, if it The cancellation signal may or may not have any effect --- for example, if it
arrives after the backend has finished processing the query, then it will have arrives after the backend has finished processing the query, then it will have
no effect. If the cancellation is effective, it results in the current no effect. If the cancellation is effective, it results in the current
command being terminated early with an error message. command being terminated early with an error message.
</para>
<Para> <Para>
The upshot of all this is that for reasons of both security and efficiency, The upshot of all this is that for reasons of both security and efficiency,
...@@ -561,6 +585,7 @@ It must continue to wait for the backend to respond to the query. Issuing a ...@@ -561,6 +585,7 @@ It must continue to wait for the backend to respond to the query. Issuing a
cancel simply improves the odds that the current query will finish soon, cancel simply improves the odds that the current query will finish soon,
and improves the odds that it will fail with an error message instead of and improves the odds that it will fail with an error message instead of
succeeding. succeeding.
</para>
<Para> <Para>
Since the cancel request is sent to the postmaster and not across the Since the cancel request is sent to the postmaster and not across the
...@@ -571,7 +596,8 @@ multiple-process applications. It also introduces a security risk, in that ...@@ -571,7 +596,8 @@ multiple-process applications. It also introduces a security risk, in that
unauthorized persons might try to cancel queries. The security risk is unauthorized persons might try to cancel queries. The security risk is
addressed by requiring a dynamically generated secret key to be supplied addressed by requiring a dynamically generated secret key to be supplied
in cancel requests. in cancel requests.
</para>
</sect2>
<Sect2> <Sect2>
<Title>Termination</Title> <Title>Termination</Title>
...@@ -580,6 +606,7 @@ in cancel requests. ...@@ -580,6 +606,7 @@ in cancel requests.
The normal, graceful termination procedure is that the frontend sends a The normal, graceful termination procedure is that the frontend sends a
Terminate message and immediately closes the connection. On receipt of the Terminate message and immediately closes the connection. On receipt of the
message, the backend immediately closes the connection and terminates. message, the backend immediately closes the connection and terminates.
</para>
<Para> <Para>
An ungraceful termination may occur due to software failure (i.e., core dump) An ungraceful termination may occur due to software failure (i.e., core dump)
...@@ -587,7 +614,9 @@ at either end. If either frontend or backend sees an unexpected closure of ...@@ -587,7 +614,9 @@ at either end. If either frontend or backend sees an unexpected closure of
the connection, it should clean up and terminate. The frontend has the option the connection, it should clean up and terminate. The frontend has the option
of launching a new backend by recontacting the postmaster, if it doesn't want of launching a new backend by recontacting the postmaster, if it doesn't want
to terminate itself. to terminate itself.
</para>
</sect2>
</sect1>
<Sect1> <Sect1>
<Title>Message Data Types</Title> <Title>Message Data Types</Title>
...@@ -595,7 +624,6 @@ to terminate itself. ...@@ -595,7 +624,6 @@ to terminate itself.
<Para> <Para>
This section describes the base data types used in messages. This section describes the base data types used in messages.
<Para>
<VariableList> <VariableList>
<VarListEntry> <VarListEntry>
<Term> <Term>
...@@ -655,6 +683,7 @@ Is 8193 bytes the largest allowed size? ...@@ -655,6 +683,7 @@ Is 8193 bytes the largest allowed size?
</VarListEntry> </VarListEntry>
</VariableList> </VariableList>
</Para> </Para>
</sect1>
<Sect1> <Sect1>
<Title>Message Formats</Title> <Title>Message Formats</Title>
...@@ -662,8 +691,7 @@ Is 8193 bytes the largest allowed size? ...@@ -662,8 +691,7 @@ Is 8193 bytes the largest allowed size?
<Para> <Para>
This section describes the detailed format of each message. Each can be sent This section describes the detailed format of each message. Each can be sent
by either a frontend (F), a postmaster/backend (B), or both (F & B). by either a frontend (F), a postmaster/backend (B), or both (F & B).
</para>
<Para>
<VariableList> <VariableList>
<VarListEntry> <VarListEntry>
...@@ -1402,9 +1430,8 @@ FunctionCall (F) ...@@ -1402,9 +1430,8 @@ FunctionCall (F)
</VarListEntry> </VarListEntry>
</VariableList> </VariableList>
<Para>
</Para> </Para>
</ListItem> </ListItem>
</VarListEntry> </VarListEntry>
<VarListEntry> <VarListEntry>
...@@ -1871,6 +1898,6 @@ UnencryptedPasswordPacket (F) ...@@ -1871,6 +1898,6 @@ UnencryptedPasswordPacket (F)
</ListItem> </ListItem>
</VarListEntry> </VarListEntry>
</VariableList> </VariableList>
</Para>
</sect1>
</Chapter> </Chapter>
doc/src/sgml/psql.sgml
View file @ a75f2d21
...@@ -26,6 +26,7 @@ To affect the paging behavior of your <Command>psql</Command> output, ...@@ -26,6 +26,7 @@ To affect the paging behavior of your <Command>psql</Command> output,
set or unset your PAGER environment variable. I always have to set mine set or unset your PAGER environment variable. I always have to set mine
before it will pause. And of course you have to do this before before it will pause. And of course you have to do this before
starting the program. starting the program.
</para>
<Para> <Para>
In csh/tcsh or other C shells: In csh/tcsh or other C shells:
...@@ -39,5 +40,6 @@ while in sh/bash or other Bourne shells: ...@@ -39,5 +40,6 @@ while in sh/bash or other Bourne shells:
<ProgramListing> <ProgramListing>
unset PAGER unset PAGER
</ProgramListing> </ProgramListing>
</para>
</sect1>
</Chapter> </Chapter>
doc/src/sgml/query-ug.sgml
View file @ a75f2d21
...@@ -54,6 +54,7 @@ identifier</FirstTerm> (<Acronym>OID</Acronym>) ...@@ -54,6 +54,7 @@ identifier</FirstTerm> (<Acronym>OID</Acronym>)
single <FileName>postmaster</FileName> process constitutes an installation single <FileName>postmaster</FileName> process constitutes an installation
or site. or site.
</Para> </Para>
</sect1>
<Sect1> <Sect1>
<Title>Creating a New Class</Title> <Title>Creating a New Class</Title>
...@@ -71,12 +72,14 @@ CREATE TABLE weather ( ...@@ -71,12 +72,14 @@ CREATE TABLE weather (
date date date date
); );
</ProgramListing> </ProgramListing>
</para>
<Para> <Para>
Note that keywords are case-insensitive and identifiers Note that keywords are case-insensitive and identifiers
are usually case-insensitive. are usually case-insensitive.
<Acronym>Postgres</Acronym> allows <Acronym>SQL92</Acronym> <FirstTerm>delimited identifiers</FirstTerm> <Acronym>Postgres</Acronym> allows <Acronym>SQL92</Acronym> <FirstTerm>delimited identifiers</FirstTerm>
(identifiers surrounded by double-quotes) to include mixed-case and spaces, tabs, etc. (identifiers surrounded by double-quotes) to include mixed-case and spaces, tabs, etc.
</para>
<Para> <Para>
<ProductName>Postgres</ProductName> <Acronym>SQL</Acronym> supports the usual <ProductName>Postgres</ProductName> <Acronym>SQL</Acronym> supports the usual
...@@ -95,6 +98,7 @@ a rich set of geometric types. As we will ...@@ -95,6 +98,7 @@ a rich set of geometric types. As we will
classes have properties that are extensions of the classes have properties that are extensions of the
relational model. relational model.
</Para> </Para>
</sect1>
<Sect1> <Sect1>
<Title>Populating a Class with Instances</Title> <Title>Populating a Class with Instances</Title>
...@@ -107,6 +111,7 @@ a rich set of geometric types. As we will ...@@ -107,6 +111,7 @@ a rich set of geometric types. As we will
INSERT INTO weather INSERT INTO weather
VALUES ('San Francisco', 46, 50, 0.25, '11/27/1994') VALUES ('San Francisco', 46, 50, 0.25, '11/27/1994')
</ProgramListing> </ProgramListing>
</para>
<Para> <Para>
You can also use the <Command>copy</Command> command to perform load large You can also use the <Command>copy</Command> command to perform load large
...@@ -121,6 +126,8 @@ COPY INTO weather FROM '/home/user/weather.txt' ...@@ -121,6 +126,8 @@ COPY INTO weather FROM '/home/user/weather.txt'
where the path name for the source file must be available to the backend server where the path name for the source file must be available to the backend server
machine, not just the client. machine, not just the client.
</para>
</sect1>
<Sect1> <Sect1>
<Title>Querying a Class</Title> <Title>Querying a Class</Title>
...@@ -153,6 +160,7 @@ SELECT * FROM WEATHER; ...@@ -153,6 +160,7 @@ SELECT * FROM WEATHER;
<ProgramListing> <ProgramListing>
SELECT city, (temp_hi+temp_lo)/2 AS temp_avg, date FROM weather; SELECT city, (temp_hi+temp_lo)/2 AS temp_avg, date FROM weather;
</ProgramListing> </ProgramListing>
</para>
<Para> <Para>
Arbitrary Boolean operators Arbitrary Boolean operators
...@@ -183,6 +191,7 @@ SELECT DISTINCT city ...@@ -183,6 +191,7 @@ SELECT DISTINCT city
ORDER BY city; ORDER BY city;
</ProgramListing> </ProgramListing>
</Para> </Para>
</sect1>
<Sect1> <Sect1>
<Title>Redirecting SELECT Queries</Title> <Title>Redirecting SELECT Queries</Title>
...@@ -192,6 +201,7 @@ SELECT DISTINCT city ...@@ -192,6 +201,7 @@ SELECT DISTINCT city
<ProgramListing> <ProgramListing>
SELECT * INTO TABLE temp FROM weather; SELECT * INTO TABLE temp FROM weather;
</ProgramListing> </ProgramListing>
</para>
<Para> <Para>
This forms an implicit <Command>create</Command> command, creating a new This forms an implicit <Command>create</Command> command, creating a new
...@@ -200,6 +210,7 @@ SELECT * INTO TABLE temp FROM weather; ...@@ -200,6 +210,7 @@ SELECT * INTO TABLE temp FROM weather;
then, of course, perform any operations on the resulting then, of course, perform any operations on the resulting
class that we can perform on other classes. class that we can perform on other classes.
</Para> </Para>
</sect1>
<Sect1> <Sect1>
<Title>Joins Between Classes</Title> <Title>Joins Between Classes</Title>
...@@ -258,6 +269,7 @@ The semantics of such a join are ...@@ -258,6 +269,7 @@ The semantics of such a join are
the <Command>select distinct</Command> statement. the <Command>select distinct</Command> statement.
</Para> </Para>
</Note> </Note>
</para>
<Para> <Para>
In this case, both W1 and W2 are surrogates for an In this case, both W1 and W2 are surrogates for an
...@@ -267,6 +279,7 @@ The semantics of such a join are ...@@ -267,6 +279,7 @@ The semantics of such a join are
A query can contain an arbitrary number of A query can contain an arbitrary number of
class names and surrogates. class names and surrogates.
</Para> </Para>
</sect1>
<Sect1> <Sect1>
<Title>Updates</Title> <Title>Updates</Title>
...@@ -283,6 +296,7 @@ UPDATE weather ...@@ -283,6 +296,7 @@ UPDATE weather
WHERE date > '11/28/1994'; WHERE date > '11/28/1994';
</ProgramListing> </ProgramListing>
</Para> </Para>
</sect1>
<Sect1> <Sect1>
<Title>Deletions</Title> <Title>Deletions</Title>
...@@ -304,6 +318,7 @@ DELETE FROM classname; ...@@ -304,6 +318,7 @@ DELETE FROM classname;
empty. The system will not request confirmation before empty. The system will not request confirmation before
doing this. doing this.
</Para> </Para>
</sect1>
<Sect1> <Sect1>
<Title>Using Aggregate Functions</Title> <Title>Using Aggregate Functions</Title>
...@@ -344,5 +359,5 @@ SELECT city, max(temp_lo) ...@@ -344,5 +359,5 @@ SELECT city, max(temp_lo)
GROUP BY city; GROUP BY city;
</ProgramListing> </ProgramListing>
</Para> </Para>
</sect1>
</Chapter> </Chapter>
doc/src/sgml/query.sgml
View file @ a75f2d21
...@@ -60,6 +60,7 @@ has a variety of <Literal>\d</Literal> commands for showing system information. ...@@ -60,6 +60,7 @@ has a variety of <Literal>\d</Literal> commands for showing system information.
Consult these commands for more details; Consult these commands for more details;
for a listing, type <Literal>\?</Literal> at the <Application>psql</Application> prompt. for a listing, type <Literal>\?</Literal> at the <Application>psql</Application> prompt.
</Para> </Para>
</sect1>
<Sect1> <Sect1>
<Title>Concepts</Title> <Title>Concepts</Title>
...@@ -81,6 +82,7 @@ for a listing, type <Literal>\?</Literal> at the <Application>psql</Application> ...@@ -81,6 +82,7 @@ for a listing, type <Literal>\?</Literal> at the <Application>psql</Application>
single <Application>postmaster</Application> process constitutes an installation single <Application>postmaster</Application> process constitutes an installation
or site. or site.
</Para> </Para>
</sect1>
<Sect1> <Sect1>
<Title>Creating a New Class</Title> <Title>Creating a New Class</Title>
...@@ -98,6 +100,7 @@ CREATE TABLE weather ( ...@@ -98,6 +100,7 @@ CREATE TABLE weather (
date date date date
); );
</ProgramListing> </ProgramListing>
</para>
<Para> <Para>
Note that both keywords and identifiers are case-insensitive; identifiers can become Note that both keywords and identifiers are case-insensitive; identifiers can become
...@@ -118,6 +121,7 @@ a rich set of geometric types. As we will ...@@ -118,6 +121,7 @@ a rich set of geometric types. As we will
classes have properties that are extensions of the classes have properties that are extensions of the
relational model. relational model.
</Para> </Para>
</sect1>
<Sect1> <Sect1>
<Title>Populating a Class with Instances</Title> <Title>Populating a Class with Instances</Title>
...@@ -130,11 +134,13 @@ a rich set of geometric types. As we will ...@@ -130,11 +134,13 @@ a rich set of geometric types. As we will
INSERT INTO weather INSERT INTO weather
VALUES ('San Francisco', 46, 50, 0.25, '11/27/1994') VALUES ('San Francisco', 46, 50, 0.25, '11/27/1994')
</ProgramListing> </ProgramListing>
</Para>
<Para> <Para>
You can also use the <Command>copy</Command> command to perform load large You can also use the <Command>copy</Command> command to perform load large
amounts of data from flat (<Acronym>ASCII</Acronym>) files. amounts of data from flat (<Acronym>ASCII</Acronym>) files.
</Para> </Para>
</sect1>
<Sect1> <Sect1>
<Title>Querying a Class</Title> <Title>Querying a Class</Title>
...@@ -167,6 +173,7 @@ SELECT * FROM WEATHER; ...@@ -167,6 +173,7 @@ SELECT * FROM WEATHER;
<ProgramListing> <ProgramListing>
SELECT city, (temp_hi+temp_lo)/2 AS temp_avg, date FROM weather; SELECT city, (temp_hi+temp_lo)/2 AS temp_avg, date FROM weather;
</ProgramListing> </ProgramListing>
</Para>
<Para> <Para>
Arbitrary Boolean operators Arbitrary Boolean operators
...@@ -197,6 +204,7 @@ SELECT DISTINCT city ...@@ -197,6 +204,7 @@ SELECT DISTINCT city
ORDER BY city; ORDER BY city;
</ProgramListing> </ProgramListing>
</Para> </Para>
</sect1>
<Sect1> <Sect1>
<Title>Redirecting SELECT Queries</Title> <Title>Redirecting SELECT Queries</Title>
...@@ -206,6 +214,7 @@ SELECT DISTINCT city ...@@ -206,6 +214,7 @@ SELECT DISTINCT city
<ProgramListing> <ProgramListing>
SELECT * INTO TABLE temp FROM weather; SELECT * INTO TABLE temp FROM weather;
</ProgramListing> </ProgramListing>
</Para>
<Para> <Para>
This forms an implicit <Command>create</Command> command, creating a new This forms an implicit <Command>create</Command> command, creating a new
...@@ -214,6 +223,7 @@ SELECT * INTO TABLE temp FROM weather; ...@@ -214,6 +223,7 @@ SELECT * INTO TABLE temp FROM weather;
then, of course, perform any operations on the resulting then, of course, perform any operations on the resulting
class that we can perform on other classes. class that we can perform on other classes.
</Para> </Para>
</sect1>
<Sect1> <Sect1>
<Title>Joins Between Classes</Title> <Title>Joins Between Classes</Title>
...@@ -272,6 +282,7 @@ The semantics of such a join are ...@@ -272,6 +282,7 @@ The semantics of such a join are
the <Command>select distinct</Command> statement. the <Command>select distinct</Command> statement.
</Para> </Para>
</Note> </Note>
</para>
<Para> <Para>
In this case, both W1 and W2 are surrogates for an In this case, both W1 and W2 are surrogates for an
...@@ -281,6 +292,7 @@ The semantics of such a join are ...@@ -281,6 +292,7 @@ The semantics of such a join are
A query can contain an arbitrary number of A query can contain an arbitrary number of
class names and surrogates. class names and surrogates.
</Para> </Para>
</sect1>
<Sect1> <Sect1>
<Title>Updates</Title> <Title>Updates</Title>
...@@ -297,6 +309,7 @@ UPDATE weather ...@@ -297,6 +309,7 @@ UPDATE weather
WHERE date > '11/28/1994'; WHERE date > '11/28/1994';
</ProgramListing> </ProgramListing>
</Para> </Para>
</sect1>
<Sect1> <Sect1>
<Title>Deletions</Title> <Title>Deletions</Title>
...@@ -318,6 +331,7 @@ DELETE FROM classname; ...@@ -318,6 +331,7 @@ DELETE FROM classname;
empty. The system will not request confirmation before empty. The system will not request confirmation before
doing this. doing this.
</Para> </Para>
</sect1>
<Sect1> <Sect1>
<Title>Using Aggregate Functions</Title> <Title>Using Aggregate Functions</Title>
...@@ -358,5 +372,5 @@ SELECT city, max(temp_lo) ...@@ -358,5 +372,5 @@ SELECT city, max(temp_lo)
GROUP BY city; GROUP BY city;
</ProgramListing> </ProgramListing>
</Para> </Para>
</sect1>
</Chapter> </Chapter>
doc/src/sgml/ref/abort.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ ABORT ...@@ -12,6 +12,7 @@ ABORT
<REFPURPOSE> <REFPURPOSE>
Aborts the current transaction Aborts the current transaction
</REFPURPOSE> </REFPURPOSE>
</REFNAMEDIV>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-27</DATE> <DATE>1998-09-27</DATE>
...@@ -29,6 +30,7 @@ Inputs ...@@ -29,6 +30,7 @@ Inputs
</TITLE> </TITLE>
<PARA> <PARA>
None. None.
</para>
</REFSECT2> </REFSECT2>
...@@ -49,7 +51,9 @@ Outputs ...@@ -49,7 +51,9 @@ Outputs
<LISTITEM> <LISTITEM>
<PARA> <PARA>
Message returned if successful. Message returned if successful.
</para>
</listitem>
</VARLISTENTRY>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
NOTICE: UserAbortTransactionBlock and not in in-progress state NOTICE: UserAbortTransactionBlock and not in in-progress state
...@@ -58,10 +62,11 @@ ABORT ...@@ -58,10 +62,11 @@ ABORT
<LISTITEM> <LISTITEM>
<PARA> <PARA>
If there is not any transaction currently in progress. If there is not any transaction currently in progress.
</para>
</listitem>
</VARLISTENTRY> </VARLISTENTRY>
</VARIABLELIST> </VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
...@@ -78,7 +83,7 @@ Description ...@@ -78,7 +83,7 @@ Description
This command is identical This command is identical
in behavior to the <acronym>SQL92</acronym> command <command>ROLLBACK</command>, in behavior to the <acronym>SQL92</acronym> command <command>ROLLBACK</command>,
and is present only for historical reasons. and is present only for historical reasons.
</para>
<REFSECT2 ID="R2-SQL-ABORT-3"> <REFSECT2 ID="R2-SQL-ABORT-3">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-09-27</DATE> <DATE>1998-09-27</DATE>
...@@ -89,7 +94,8 @@ Notes ...@@ -89,7 +94,8 @@ Notes
<para> <para>
Use the <command>COMMIT</command> statement to successfully Use the <command>COMMIT</command> statement to successfully
terminate a transaction. terminate a transaction.
</para>
</refsect2>
</REFSECT1> </REFSECT1>
<REFSECT1 ID="R1-SQL-ABORT-2"> <REFSECT1 ID="R1-SQL-ABORT-2">
...@@ -102,6 +108,7 @@ Usage ...@@ -102,6 +108,7 @@ Usage
-- --
ABORT WORK; ABORT WORK;
</ProgramListing> </ProgramListing>
</para>
</REFSECT1> </REFSECT1>
...@@ -109,7 +116,6 @@ ABORT WORK; ...@@ -109,7 +116,6 @@ ABORT WORK;
<TITLE> <TITLE>
Compatibility Compatibility
</TITLE> </TITLE>
<PARA>
<REFSECT2 ID="R2-SQL-ABORT-4"> <REFSECT2 ID="R2-SQL-ABORT-4">
<REFSECT2INFO> <REFSECT2INFO>
...@@ -123,5 +129,7 @@ This command is a <productname>Postgres</productname> extension present ...@@ -123,5 +129,7 @@ This command is a <productname>Postgres</productname> extension present
for historical reasons. <command>ROLLBACK</command> is the <acronym>SQL92</acronym> for historical reasons. <command>ROLLBACK</command> is the <acronym>SQL92</acronym>
equivalent command. equivalent command.
</PARA> </PARA>
</refsect2>
</refsect1>
</REFENTRY> </REFENTRY>
doc/src/sgml/ref/alter_table.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ ALTER TABLE ...@@ -12,6 +12,7 @@ ALTER TABLE
<REFPURPOSE> <REFPURPOSE>
Modifies table properties Modifies table properties
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-04-15</DATE> <DATE>1998-04-15</DATE>
...@@ -89,7 +90,7 @@ Inputs ...@@ -89,7 +90,7 @@ Inputs
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
</VARIABLELIST> </VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
<REFSECT2 ID="R2-SQL-ALTERTABLE-2"> <REFSECT2 ID="R2-SQL-ALTERTABLE-2">
...@@ -131,9 +132,11 @@ Outputs ...@@ -131,9 +132,11 @@ Outputs
<LISTITEM> <LISTITEM>
<PARA> <PARA>
Message returned if table or column is not available. Message returned if table or column is not available.
</para>
</listitem>
</VARLISTENTRY>
</VARIABLELIST> </VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
...@@ -153,6 +156,7 @@ Description ...@@ -153,6 +156,7 @@ Description
the affected table. Thus, the table or column will the affected table. Thus, the table or column will
remain of the same type and size after this command is remain of the same type and size after this command is
executed. executed.
</para>
<PARA> <PARA>
You must own the table in order to change its schema. You must own the table in order to change its schema.
</PARA> </PARA>
...@@ -166,18 +170,19 @@ Notes ...@@ -166,18 +170,19 @@ Notes
</TITLE> </TITLE>
<PARA> <PARA>
The keyword COLUMN is noise and can be omitted. The keyword COLUMN is noise and can be omitted.
</para>
<PARA> <PARA>
<Quote>[*]</Quote> following a name of a table indicates that statement <Quote>[*]</Quote> following a name of a table indicates that statement
should be run over that table and all tables below it in the should be run over that table and all tables below it in the
inheritance hierarchy. inheritance hierarchy.
The <citetitle>PostgreSQL User's Guide</citetitle> has further The <citetitle>PostgreSQL User's Guide</citetitle> has further
information on inheritance. information on inheritance.
</para>
<PARA> <PARA>
Refer to CREATE TABLE for a further description Refer to CREATE TABLE for a further description
of valid arguments. of valid arguments.
</para>
</REFSECT2> </REFSECT2>
</REFSECT1> </REFSECT1>
...@@ -190,18 +195,21 @@ Usage ...@@ -190,18 +195,21 @@ Usage
<ProgramListing> <ProgramListing>
ALTER TABLE distributors ADD COLUMN address VARCHAR(30); ALTER TABLE distributors ADD COLUMN address VARCHAR(30);
</ProgramListing> </ProgramListing>
</para>
<PARA> <PARA>
To rename an existing column: To rename an existing column:
<ProgramListing> <ProgramListing>
ALTER TABLE distributors RENAME COLUMN address TO city; ALTER TABLE distributors RENAME COLUMN address TO city;
</ProgramListing> </ProgramListing>
</para>
<PARA> <PARA>
To rename an existing table: To rename an existing table:
<ProgramListing> <ProgramListing>
ALTER TABLE distributors RENAME TO suppliers; ALTER TABLE distributors RENAME TO suppliers;
</ProgramListing> </ProgramListing>
</para>
</REFSECT1> </REFSECT1>
...@@ -220,11 +228,13 @@ SQL92 ...@@ -220,11 +228,13 @@ SQL92
<PARA> <PARA>
<command>ALTER TABLE/RENAME</command> <command>ALTER TABLE/RENAME</command>
is a <productname>Postgres</productname> language extension. is a <productname>Postgres</productname> language extension.
</para>
<PARA> <PARA>
SQL92 specifies some additional capabilities for <command>ALTER TABLE</command> SQL92 specifies some additional capabilities for <command>ALTER TABLE</command>
statement which are not yet directly supported by statement which are not yet directly supported by
<ProductName>Postgres</ProductName>: <ProductName>Postgres</ProductName>:
</para>
<VARIABLELIST> <VARIABLELIST>
<VARLISTENTRY> <VARLISTENTRY>
...@@ -247,6 +257,7 @@ ALTER TABLE <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE> ALTER [ COLUMN ] ...@@ -247,6 +257,7 @@ ALTER TABLE <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE> ALTER [ COLUMN ]
the new definition. If any constraints on this column already the new definition. If any constraints on this column already
exist, they will be retained using a boolean AND with the new exist, they will be retained using a boolean AND with the new
constraint. constraint.
</para>
<PARA> <PARA>
Currently, to set new default constraints on an existing column Currently, to set new default constraints on an existing column
...@@ -284,6 +295,7 @@ ALTER TABLE <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE> ...@@ -284,6 +295,7 @@ ALTER TABLE <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE>
constraints can be destroyed. constraints can be destroyed.
If CASCADE is specified, Any constraints that are dependent on If CASCADE is specified, Any constraints that are dependent on
this constraint are also dropped. this constraint are also dropped.
</para>
<PARA> <PARA>
Currently, to remove a default value or constraints on an Currently, to remove a default value or constraints on an
...@@ -295,7 +307,10 @@ DROP TABLE distributors; ...@@ -295,7 +307,10 @@ DROP TABLE distributors;
CREATE TABLE distributors AS SELECT * FROM temp; CREATE TABLE distributors AS SELECT * FROM temp;
DROP TABLE temp; DROP TABLE temp;
</ProgramListing> </ProgramListing>
</para>
</listitem>
</varlistentry>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<Synopsis> <Synopsis>
...@@ -310,6 +325,7 @@ ALTER TABLE <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE> ...@@ -310,6 +325,7 @@ ALTER TABLE <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE>
objects can be destroyed. objects can be destroyed.
If CASCADE is specified, all objects that are dependent on If CASCADE is specified, all objects that are dependent on
this column are also dropped. this column are also dropped.
</para>
<PARA> <PARA>
Currently, to remove an existing column the table must be Currently, to remove an existing column the table must be
...@@ -326,5 +342,9 @@ INSERT INTO distributors SELECT * FROM temp; ...@@ -326,5 +342,9 @@ INSERT INTO distributors SELECT * FROM temp;
DROP TABLE temp; DROP TABLE temp;
</ProgramListing> </ProgramListing>
</PARA> </PARA>
</listitem>
</varlistentry>
</VARIABLELIST> </VARIABLELIST>
</refsect2>
</refsect1>
</REFENTRY> </REFENTRY>
doc/src/sgml/ref/alter_user.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ ...@@ -12,6 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Modifies user account information Modifies user account information
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-08</DATE> <DATE>1998-09-08</DATE>
...@@ -91,32 +92,35 @@ ALTER USER <replaceable class="PARAMETER">username</replaceable> ...@@ -91,32 +92,35 @@ ALTER USER <replaceable class="PARAMETER">username</replaceable>
<TITLE> <TITLE>
Outputs Outputs
</TITLE> </TITLE>
<PARA> <PARA>
<VARIABLELIST> <VARIABLELIST>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<returnvalue>ALTER USER</returnvalue> <returnvalue>ALTER USER</returnvalue>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
Message returned if the alteration was successful. Message returned if the alteration was successful.
</PARA> </PARA>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<returnvalue>ERROR: alterUser: user "username" does not exist</returnvalue> <returnvalue>ERROR: alterUser: user "username" does not exist</returnvalue>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
Error message returned if the user specified doesn't Error message returned if the user specified doesn't
exist. exist.
</para>
</variablelist> </listitem>
</REFSECT2> </varlistentry>
</REFSYNOPSISDIV> </variablelist>
</para>
</REFSECT2>
</REFSYNOPSISDIV>
<REFSECT1 ID="R1-SQL-ALTERUSER-1"> <REFSECT1 ID="R1-SQL-ALTERUSER-1">
<REFSECT1INFO> <REFSECT1INFO>
<DATE>1998-09-08</DATE> <DATE>1998-09-08</DATE>
...@@ -223,6 +227,7 @@ ALTER USER miriam IN GROUP sales, payroll; ...@@ -223,6 +227,7 @@ ALTER USER miriam IN GROUP sales, payroll;
The standard leaves The standard leaves
the definition of users to the implementation. the definition of users to the implementation.
</PARA> </PARA>
</refsect2>
</refsect1> </refsect1>
</REFENTRY> </REFENTRY>
......
doc/src/sgml/ref/begin.sgml
View file @ a75f2d21
...@@ -13,7 +13,7 @@ ...@@ -13,7 +13,7 @@
Begins a transaction Begins a transaction
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-08</DATE> <DATE>1998-09-08</DATE>
...@@ -30,7 +30,8 @@ BEGIN [ WORK | TRANSACTION ] ...@@ -30,7 +30,8 @@ BEGIN [ WORK | TRANSACTION ]
Inputs Inputs
</TITLE> </TITLE>
<PARA> <PARA>
None None
</para>
</REFSECT2> </REFSECT2>
<REFSECT2 ID="R2-SQL-BEGINWORK-2"> <REFSECT2 ID="R2-SQL-BEGINWORK-2">
...@@ -58,11 +59,14 @@ BEGIN [ WORK | TRANSACTION ] ...@@ -58,11 +59,14 @@ BEGIN [ WORK | TRANSACTION ]
<returnvalue>NOTICE: BeginTransactionBlock and not in default state</returnvalue> <returnvalue>NOTICE: BeginTransactionBlock and not in default state</returnvalue>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
This indicates that a transaction was already in progress. This indicates that a transaction was already in progress.
The current transaction is not affected. The current transaction is not affected.
</para>
</VARIABLELIST> </listitem>
</varlistentry>
</VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
...@@ -109,6 +113,7 @@ The current transaction is not affected. ...@@ -109,6 +113,7 @@ The current transaction is not affected.
to terminate a transaction. to terminate a transaction.
</PARA> </PARA>
</REFSECT2> </REFSECT2>
</refsect1>
<REFSECT1 ID="R1-SQL-BEGINWORK-2"> <REFSECT1 ID="R1-SQL-BEGINWORK-2">
<TITLE> <TITLE>
...@@ -119,6 +124,7 @@ The current transaction is not affected. ...@@ -119,6 +124,7 @@ The current transaction is not affected.
<ProgramListing> <ProgramListing>
BEGIN WORK; BEGIN WORK;
</ProgramListing> </ProgramListing>
</para>
</REFSECT1> </REFSECT1>
<REFSECT1 ID="R1-SQL-BEGINWORK-3"> <REFSECT1 ID="R1-SQL-BEGINWORK-3">
...@@ -128,7 +134,7 @@ BEGIN WORK; ...@@ -128,7 +134,7 @@ BEGIN WORK;
<PARA> <PARA>
<command>BEGIN</command> <command>BEGIN</command>
is a <productname>Postgres</productname> language extension. is a <productname>Postgres</productname> language extension.
</para>
<REFSECT2 ID="R2-SQL-BEGINWORK-4"> <REFSECT2 ID="R2-SQL-BEGINWORK-4">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-09-08</DATE> <DATE>1998-09-08</DATE>
......
doc/src/sgml/ref/close.sgml
View file @ a75f2d21
...@@ -12,7 +12,7 @@ ...@@ -12,7 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Close a cursor Close a cursor
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-08</DATE> <DATE>1998-09-08</DATE>
...@@ -41,6 +41,7 @@ CLOSE <REPLACEABLE CLASS="PARAMETER">cursor</REPLACEABLE> ...@@ -41,6 +41,7 @@ CLOSE <REPLACEABLE CLASS="PARAMETER">cursor</REPLACEABLE>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
</variablelist> </variablelist>
</para>
</REFSECT2> </REFSECT2>
<REFSECT2 ID="R2-SQL-CLOSE-2"> <REFSECT2 ID="R2-SQL-CLOSE-2">
...@@ -71,9 +72,11 @@ CLOSE <REPLACEABLE CLASS="PARAMETER">cursor</REPLACEABLE> ...@@ -71,9 +72,11 @@ CLOSE <REPLACEABLE CLASS="PARAMETER">cursor</REPLACEABLE>
This warning is given if This warning is given if
<REPLACEABLE CLASS="PARAMETER">cursor</REPLACEABLE> is not <REPLACEABLE CLASS="PARAMETER">cursor</REPLACEABLE> is not
declared or has already been closed. declared or has already been closed.
</para>
</VARIABLELIST> </listitem>
</varlistentry>
</VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
......
doc/src/sgml/ref/cluster.sgml
View file @ a75f2d21
...@@ -12,14 +12,14 @@ ...@@ -12,14 +12,14 @@
<REFPURPOSE> <REFPURPOSE>
Gives storage clustering advice to the backend Gives storage clustering advice to the backend
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-08</DATE> <DATE>1998-09-08</DATE>
</REFSYNOPSISDIVINFO> </REFSYNOPSISDIVINFO>
<SYNOPSIS> <SYNOPSIS>
CLUSTER <REPLACEABLE CLASS="PARAMETER">indexname</REPLACEABLE> ON <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE> CLUSTER <REPLACEABLE CLASS="PARAMETER">indexname</REPLACEABLE> ON <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE>
</SYNOPSIS> </SYNOPSIS>
<REFSECT2 ID="R2-SQL-CLUSTER-1"> <REFSECT2 ID="R2-SQL-CLUSTER-1">
<REFSECT2INFO> <REFSECT2INFO>
...@@ -102,9 +102,9 @@ CLUSTER <REPLACEABLE CLASS="PARAMETER">indexname</REPLACEABLE> ON <REPLACEABLE C ...@@ -102,9 +102,9 @@ CLUSTER <REPLACEABLE CLASS="PARAMETER">indexname</REPLACEABLE> ON <REPLACEABLE C
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
</VARIABLELIST> </VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
<REFSECT1 ID="R1-SQL-CLUSTER-1"> <REFSECT1 ID="R1-SQL-CLUSTER-1">
...@@ -139,7 +139,7 @@ to cluster the class specified ...@@ -139,7 +139,7 @@ to cluster the class specified
<TITLE> <TITLE>
Notes Notes
</TITLE> </TITLE>
<PARA>
<para> <para>
The table is actually copied to a temporary table in index The table is actually copied to a temporary table in index
order, then renamed back to the original name. For this order, then renamed back to the original name. For this
...@@ -191,39 +191,40 @@ SELECT ... INTO TABLE <replaceable class="parameter">temp</replaceable> FROM ... ...@@ -191,39 +191,40 @@ SELECT ... INTO TABLE <replaceable class="parameter">temp</replaceable> FROM ...
will not be preserved. From then on, <command>CLUSTER</command> should be will not be preserved. From then on, <command>CLUSTER</command> should be
fast because most of the heap data has already been fast because most of the heap data has already been
ordered, and the existing index is used. ordered, and the existing index is used.
</para> </para>
</refsect2>
</refsect1>
<REFSECT1 ID="R1-SQL-CLUSTER-2"> <REFSECT1 ID="R1-SQL-CLUSTER-2">
<TITLE> <TITLE>
Usage Usage
</TITLE> </TITLE>
<PARA> <PARA>
Cluster the employees relation on the basis of its salary attribute Cluster the employees relation on the basis of its salary attribute
</PARA> </PARA>
<ProgramListing> <ProgramListing>
CLUSTER emp_ind ON emp CLUSTER emp_ind ON emp
</ProgramListing> </ProgramListing>
</REFSECT1> </REFSECT1>
<REFSECT1 ID="R1-SQL-CLUSTER-3"> <REFSECT1 ID="R1-SQL-CLUSTER-3">
<TITLE>
Compatibility
</TITLE>
<PARA>
</PARA>
<REFSECT2 ID="R2-SQL-CLUSTER-4">
<REFSECT2INFO>
<DATE>1998-09-08</DATE>
</REFSECT2INFO>
<TITLE> <TITLE>
SQL92 Compatibility
</TITLE> </TITLE>
<PARA> <PARA>
There is no <command>CLUSTER</command> statement in SQL92.
</PARA> </PARA>
</refsect2>
<REFSECT2 ID="R2-SQL-CLUSTER-4">
<REFSECT2INFO>
<DATE>1998-09-08</DATE>
</REFSECT2INFO>
<TITLE>
SQL92
</TITLE>
<PARA>
There is no <command>CLUSTER</command> statement in SQL92.
</PARA>
</refsect2>
</refsect1> </refsect1>
</REFENTRY> </REFENTRY>
......
doc/src/sgml/ref/commit.sgml
View file @ a75f2d21
...@@ -12,7 +12,7 @@ ...@@ -12,7 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Commits the current transaction Commits the current transaction
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
...@@ -30,8 +30,8 @@ COMMIT [ WORK | TRANSACTION ] ...@@ -30,8 +30,8 @@ COMMIT [ WORK | TRANSACTION ]
Inputs Inputs
</TITLE> </TITLE>
<PARA> <PARA>
None None
</para>
</REFSECT2> </REFSECT2>
<REFSECT2 ID="R2-SQL-COMMIT-2"> <REFSECT2 ID="R2-SQL-COMMIT-2">
...@@ -57,12 +57,15 @@ Message returned if the transaction is successfully committed. ...@@ -57,12 +57,15 @@ Message returned if the transaction is successfully committed.
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<returnvalue>NOTICE EndTransactionBlock and not inprogress/abort state</returnvalue> <returnvalue>NOTICE EndTransactionBlock and not inprogress/abort state</returnvalue>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
If there is no transaction in progress. If there is no transaction in progress.
</para>
</VARIABLELIST> </listitem>
</varlistentry>
</VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
......
doc/src/sgml/ref/copy.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ ...@@ -12,6 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Copies data between files and tables Copies data between files and tables
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-08</DATE> <DATE>1998-09-08</DATE>
...@@ -92,20 +93,21 @@ Specifies that input comes from a pipe or terminal. ...@@ -92,20 +93,21 @@ Specifies that input comes from a pipe or terminal.
<LISTITEM> <LISTITEM>
<PARA> <PARA>
Specifies that output goes to a pipe or terminal. Specifies that output goes to a pipe or terminal.
</PARA> </PARA>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<replaceable class="parameter">delimiter</replaceable> <replaceable class="parameter">delimiter</replaceable>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
A character that delimits the input or output fields. A character that delimits the input or output fields.
</PARA> </PARA>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
</variablelist> </variablelist>
</para>
</REFSECT2> </REFSECT2>
<REFSECT2 ID="R2-SQL-COPY-2"> <REFSECT2 ID="R2-SQL-COPY-2">
...@@ -131,12 +133,15 @@ Specifies that output goes to a pipe or terminal. ...@@ -131,12 +133,15 @@ Specifies that output goes to a pipe or terminal.
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<ReturnValue>ERROR: <replaceable>error message</replaceable></ReturnValue> <ReturnValue>ERROR: <replaceable>error message</replaceable></ReturnValue>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
The copy failed for the reason stated in the error message. The copy failed for the reason stated in the error message.
</para>
</VARIABLELIST> </listitem>
</varlistentry>
</VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
...@@ -147,19 +152,18 @@ Specifies that output goes to a pipe or terminal. ...@@ -147,19 +152,18 @@ Specifies that output goes to a pipe or terminal.
<TITLE> <TITLE>
Description Description
</TITLE> </TITLE>
<PARA> <para>
<command>COPY</command> moves data between <command>COPY</command> moves data between
<productname>Postgres</productname> tables and <productname>Postgres</productname> tables and
standard Unix files. standard Unix files.
<para> <command>COPY</command> instructs
<command>COPY</command> instructs the <productname>Postgres</productname> backend
the <productname>Postgres</productname> backend to directly read from or write to a file. The file must be directly visible to
to directly read from or write to a file. The file must be directly visible to the backend and the name must be specified from the viewpoint of the backend.
the backend and the name must be specified from the viewpoint of the backend. If <filename>stdin</filename> or <filename>stdout</filename> are specified, data flows through the client frontend to
If <filename>stdin</filename> or <filename>stdout</filename> are specified, data flows through the client frontend to the backend.
the backend. </para>
<REFSECT2 ID="R2-SQL-COPY-3"> <REFSECT2 ID="R2-SQL-COPY-3">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-09-08</DATE> <DATE>1998-09-08</DATE>
...@@ -167,41 +171,42 @@ the backend. ...@@ -167,41 +171,42 @@ the backend.
<TITLE> <TITLE>
Notes Notes
</TITLE> </TITLE>
<para> <para>
The BINARY keyword will force all data to be The BINARY keyword will force all data to be
stored/read as binary objects rather than as text. It is stored/read as binary objects rather than as text. It is
somewhat faster than the normal copy command, but is not somewhat faster than the normal copy command, but is not
generally portable, and the files generated are somewhat larger, generally portable, and the files generated are somewhat larger,
although this factor is highly dependent on the data itself. By although this factor is highly dependent on the data itself. By
default, a text copy uses a tab ("\t") character as a delimiter. default, a text copy uses a tab ("\t") character as a delimiter.
The delimiter may also be changed to any other single character The delimiter may also be changed to any other single character
with the keyword phrase USING DELIMITERS. Characters with the keyword phrase USING DELIMITERS. Characters
in data fields which happen to match the delimiter character will in data fields which happen to match the delimiter character will
be quoted. be quoted.
</para> </para>
<para> <para>
You must have select access on any table whose values are read by You must have select access on any table whose values are read by
<command>COPY</command>, and either insert or update access to a <command>COPY</command>, and either insert or update access to a
table into which values are being inserted by <command>COPY</command>. table into which values are being inserted by <command>COPY</command>.
The backend also needs appropriate Unix permissions for any file read The backend also needs appropriate Unix permissions for any file read
or written by <command>COPY</command>. or written by <command>COPY</command>.
</para> </para>
<para> <para>
The keyword phrase USING DELIMITERS specifies a single character The keyword phrase USING DELIMITERS specifies a single character
to be used for all delimiters between columns. If multiple characters to be used for all delimiters between columns. If multiple characters
are specified in the delimiter string, only the first character is are specified in the delimiter string, only the first character is
used. used.
<tip> <tip>
<para> <para>
Do not confuse <command>COPY</command> with the Do not confuse <command>COPY</command> with the
<application>psql</application> instruction <command>\copy</command>. <application>psql</application> instruction <command>\copy</command>.
</tip> </para>
</tip>
</para>
</REFSECT2> </REFSECT2>
</refsect1> </refsect1>
<refsect1 ID="R1-SQL-COPY-2"> <refsect1 ID="R1-SQL-COPY-2">
<refsect1info> <refsect1info>
<date>1998-05-04</date> <date>1998-05-04</date>
......
doc/src/sgml/ref/create_aggregate.sgml
View file @ a75f2d21
...@@ -13,6 +13,7 @@ ...@@ -13,6 +13,7 @@
<REFPURPOSE> <REFPURPOSE>
Defines a new aggregate function Defines a new aggregate function
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-09</DATE> <DATE>1998-09-09</DATE>
...@@ -150,11 +151,11 @@ The initial value for the first transition function argument. ...@@ -150,11 +151,11 @@ The initial value for the first transition function argument.
The initial value for the second transition function argument. The initial value for the second transition function argument.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</para>
</REFSECT2> </REFSECT2>
<REFSECT2 ID="R2-SQL-CREATEAGGREGATE-2"> <REFSECT2 ID="R2-SQL-CREATEAGGREGATE-2">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-09-09</DATE> <DATE>1998-09-09</DATE>
...@@ -163,20 +164,23 @@ The initial value for the second transition function argument. ...@@ -163,20 +164,23 @@ The initial value for the second transition function argument.
Outputs Outputs
</TITLE> </TITLE>
<PARA> <PARA>
<VARIABLELIST> <VARIABLELIST>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<ReturnValue>CREATE</ReturnValue> <ReturnValue>CREATE</ReturnValue>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
Message returned if the command completes successfully. Message returned if the command completes successfully.
</VARIABLELIST> </para>
</listitem>
</varlistentry>
</VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
<REFSECT1 ID="R1-SQL-CREATEAGGREGATE-1"> <REFSECT1 ID="R1-SQL-CREATEAGGREGATE-1">
<REFSECT1INFO> <REFSECT1INFO>
<DATE>1998-09-09</DATE> <DATE>1998-09-09</DATE>
...@@ -184,80 +188,80 @@ The initial value for the second transition function argument. ...@@ -184,80 +188,80 @@ The initial value for the second transition function argument.
<TITLE> <TITLE>
Description Description
</TITLE> </TITLE>
<para> <para>
<command>CREATE AGGREGATE</command> <command>CREATE AGGREGATE</command>
allows a user or programmer to extend <productname>Postgres</productname> allows a user or programmer to extend <productname>Postgres</productname>
functionality by defining new aggregate functions. Some aggregate functions functionality by defining new aggregate functions. Some aggregate functions
for base types such as <function>min(int4)</function> for base types such as <function>min(int4)</function>
and <function>avg(float8)</function> are already provided in the base and <function>avg(float8)</function> are already provided in the base
distribution. If one defines new types or needs an aggregate function not distribution. If one defines new types or needs an aggregate function not
already provided then <command>CREATE AGGREGATE</command> already provided then <command>CREATE AGGREGATE</command>
can be used to provide the desired features. can be used to provide the desired features.
</para>
<PARA> <PARA>
An aggregate function can require up to three functions, two An aggregate function can require up to three functions, two
state transition functions, state transition functions,
<REPLACEABLE CLASS="PARAMETER">sfunc1</REPLACEABLE> <REPLACEABLE CLASS="PARAMETER">sfunc1</REPLACEABLE>
and <REPLACEABLE CLASS="PARAMETER">sfunc2</REPLACEABLE>: and <REPLACEABLE CLASS="PARAMETER">sfunc2</REPLACEABLE>:
<programlisting> <programlisting>
<REPLACEABLE CLASS="PARAMETER">sfunc1</REPLACEABLE>( internal-state1, next-data_item ) ---> next-internal-state1 <REPLACEABLE CLASS="PARAMETER">sfunc1</REPLACEABLE>( internal-state1, next-data_item ) ---> next-internal-state1
<REPLACEABLE CLASS="PARAMETER">sfunc2</REPLACEABLE>( internal-state2 ) ---> next-internal-state2 <REPLACEABLE CLASS="PARAMETER">sfunc2</REPLACEABLE>( internal-state2 ) ---> next-internal-state2
</programlisting> </programlisting>
and a final calculation function, and a final calculation function,
<REPLACEABLE CLASS="PARAMETER">ffunc</REPLACEABLE>: <REPLACEABLE CLASS="PARAMETER">ffunc</REPLACEABLE>:
<programlisting> <programlisting>
<REPLACEABLE CLASS="PARAMETER">ffunc</REPLACEABLE>(internal-state1, internal-state2) ---> aggregate-value <REPLACEABLE CLASS="PARAMETER">ffunc</REPLACEABLE>(internal-state1, internal-state2) ---> aggregate-value
</programlisting> </programlisting>
</para>
<para> <para>
<productname>Postgres</productname> creates up to two temporary variables <productname>Postgres</productname> creates up to two temporary variables
(referred to here as <REPLACEABLE CLASS="PARAMETER">temp1</REPLACEABLE> (referred to here as <REPLACEABLE CLASS="PARAMETER">temp1</REPLACEABLE>
and <REPLACEABLE CLASS="PARAMETER">temp2</REPLACEABLE>) and <REPLACEABLE CLASS="PARAMETER">temp2</REPLACEABLE>)
to hold intermediate results used as arguments to the transition functions. to hold intermediate results used as arguments to the transition functions.
</para>
<para> <para>
These transition functions are required to have the following properties: These transition functions are required to have the following properties:
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
The arguments to The arguments to
<REPLACEABLE CLASS="PARAMETER">sfunc1</REPLACEABLE> <REPLACEABLE CLASS="PARAMETER">sfunc1</REPLACEABLE>
must be must be
<REPLACEABLE CLASS="PARAMETER">temp1</REPLACEABLE> <REPLACEABLE CLASS="PARAMETER">temp1</REPLACEABLE>
of type of type
<REPLACEABLE CLASS="PARAMETER">sfunc1_return_type</REPLACEABLE> <REPLACEABLE CLASS="PARAMETER">sfunc1_return_type</REPLACEABLE>
and and
<REPLACEABLE CLASS="PARAMETER">column_value</REPLACEABLE> <REPLACEABLE CLASS="PARAMETER">column_value</REPLACEABLE>
of type <REPLACEABLE CLASS="PARAMETER">data_type</REPLACEABLE>. of type <REPLACEABLE CLASS="PARAMETER">data_type</REPLACEABLE>.
The return value must be of type The return value must be of type
<REPLACEABLE CLASS="PARAMETER">sfunc1_return_type</REPLACEABLE> <REPLACEABLE CLASS="PARAMETER">sfunc1_return_type</REPLACEABLE>
and will be used as the first argument in the next call to and will be used as the first argument in the next call to
<REPLACEABLE CLASS="PARAMETER">sfunc1</REPLACEABLE>. <REPLACEABLE CLASS="PARAMETER">sfunc1</REPLACEABLE>.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
The argument and return value of The argument and return value of
<REPLACEABLE CLASS="PARAMETER">sfunc2</REPLACEABLE> <REPLACEABLE CLASS="PARAMETER">sfunc2</REPLACEABLE>
must be must be
<REPLACEABLE CLASS="PARAMETER">temp2</REPLACEABLE> <REPLACEABLE CLASS="PARAMETER">temp2</REPLACEABLE>
of type of type
<REPLACEABLE CLASS="PARAMETER">sfunc2_return_type</REPLACEABLE>. <REPLACEABLE CLASS="PARAMETER">sfunc2_return_type</REPLACEABLE>.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
The arguments to the final-calculation-function The arguments to the final-calculation-function
must be must be
<REPLACEABLE CLASS="PARAMETER">temp1</REPLACEABLE> <REPLACEABLE CLASS="PARAMETER">temp1</REPLACEABLE>
and and
<REPLACEABLE CLASS="PARAMETER">temp2</REPLACEABLE> <REPLACEABLE CLASS="PARAMETER">temp2</REPLACEABLE>
and its return value must and its return value must
be a <productname>Postgres</productname> be a <productname>Postgres</productname>
base type (not necessarily base type (not necessarily
<REPLACEABLE CLASS="PARAMETER">data_type</REPLACEABLE> <REPLACEABLE CLASS="PARAMETER">data_type</REPLACEABLE>
which had been specified for BASETYPE). which had been specified for BASETYPE).
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
...@@ -269,7 +273,7 @@ which had been specified for BASETYPE). ...@@ -269,7 +273,7 @@ which had been specified for BASETYPE).
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</PARA> </PARA>
<para> <para>
An aggregate function may also require one or two initial conditions, An aggregate function may also require one or two initial conditions,
one for one for
...@@ -301,41 +305,42 @@ which had been specified for BASETYPE). ...@@ -301,41 +305,42 @@ which had been specified for BASETYPE).
well as a FINALFUNC (a division function) to produce its well as a FINALFUNC (a division function) to produce its
answer. In any case, at least one state function must be answer. In any case, at least one state function must be
defined, and any SFUNC2 must have a corresponding INITCOND2. defined, and any SFUNC2 must have a corresponding INITCOND2.
</para> </para>
</REFSECT2> </REFSECT2>
</refsect1>
<REFSECT1 ID="R1-SQL-CREATEAGGREGATE-2"> <REFSECT1 ID="R1-SQL-CREATEAGGREGATE-2">
<TITLE> <TITLE>
Usage Usage
</TITLE> </TITLE>
<PARA> <PARA>
Refer to the chapter on aggregate functions Refer to the chapter on aggregate functions
in the <citetitle>PostgreSQL Programmer's Guide</citetitle> in the <citetitle>PostgreSQL Programmer's Guide</citetitle>
on aggregate functions for on aggregate functions for
complete examples of usage. complete examples of usage.
</para>
</REFSECT1> </REFSECT1>
<REFSECT1 ID="R1-SQL-CREATEAGGREGATE-3"> <REFSECT1 ID="R1-SQL-CREATEAGGREGATE-3">
<TITLE> <TITLE>
Compatibility Compatibility
</TITLE> </TITLE>
<PARA>
<REFSECT2 ID="R2-SQL-CREATEAGGREGATE-4"> <REFSECT2 ID="R2-SQL-CREATEAGGREGATE-4">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-09-09</DATE> <DATE>1998-09-09</DATE>
</REFSECT2INFO> </REFSECT2INFO>
<TITLE> <TITLE>
SQL92 SQL92
</TITLE> </TITLE>
<PARA> <PARA>
<command>CREATE AGGREGATE</command> <command>CREATE AGGREGATE</command>
is a <productname>Postgres</productname> language extension. is a <productname>Postgres</productname> language extension.
There is no <command>CREATE AGGREGATE</command> in SQL92. There is no <command>CREATE AGGREGATE</command> in SQL92.
</PARA> </PARA>
</refsect2>
</refsect1>
</REFENTRY> </REFENTRY>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
......
doc/src/sgml/ref/create_database.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ ...@@ -12,6 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Creates a new database Creates a new database
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-04-15</DATE> <DATE>1998-04-15</DATE>
...@@ -51,12 +52,13 @@ CREATE DATABASE <REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE> [ WITH LOCATIO ...@@ -51,12 +52,13 @@ CREATE DATABASE <REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE> [ WITH LOCATIO
(e.g. '<filename>/usr/local/pgsql/data</filename>'). (e.g. '<filename>/usr/local/pgsql/data</filename>').
In either case, the location must be pre-configured In either case, the location must be pre-configured
by <command>initlocation</command>. by <command>initlocation</command>.
</PARA> </PARA>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
</VARIABLELIST> </VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
<REFSECT2 ID="R2-SQL-CREATEDATABASE-2"> <REFSECT2 ID="R2-SQL-CREATEDATABASE-2">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-04-15</DATE> <DATE>1998-04-15</DATE>
...@@ -90,14 +92,17 @@ CREATE DATABASE <REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE> [ WITH LOCATIO ...@@ -90,14 +92,17 @@ CREATE DATABASE <REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE> [ WITH LOCATIO
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<ReturnValue>ERROR: Unable to create database directory <replaceable class="parameter">directory</replaceable> <ReturnValue>ERROR: Unable to create database directory <replaceable class="parameter">directory</replaceable>
</ReturnValue> </ReturnValue>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
There was a problem with creating the required directory; this operation will There was a problem with creating the required directory; this operation will
need permissions for the <literal>postgres</literal> user on the specified location. need permissions for the <literal>postgres</literal> user on the specified location.
</para>
</VARIABLELIST> </listitem>
</varlistentry>
</VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
...@@ -128,7 +133,8 @@ need permissions for the <literal>postgres</literal> user on the specified locat ...@@ -128,7 +133,8 @@ need permissions for the <literal>postgres</literal> user on the specified locat
Use <command>DROP DATABASE</command> to remove a database. Use <command>DROP DATABASE</command> to remove a database.
</para> </para>
</REFSECT2> </REFSECT2>
</refsect1>
<REFSECT1 ID="R1-SQL-CREATEDATABASE-2"> <REFSECT1 ID="R1-SQL-CREATEDATABASE-2">
<TITLE> <TITLE>
Usage Usage
...@@ -137,27 +143,27 @@ need permissions for the <literal>postgres</literal> user on the specified locat ...@@ -137,27 +143,27 @@ need permissions for the <literal>postgres</literal> user on the specified locat
To create a new database: To create a new database:
</PARA> </PARA>
<ProgramListing> <ProgramListing>
<prompt>olly=></prompt> <userinput>create database lusiadas;</userinput> <prompt>olly=></prompt> <userinput>create database lusiadas;</userinput>
</ProgramListing> </ProgramListing>
<PARA> <PARA>
To create a new database in an alternate area <filename>~/private_db</filename>: To create a new database in an alternate area <filename>~/private_db</filename>:
</PARA> </PARA>
<ProgramListing> <ProgramListing>
<prompt>$</prompt> <userinput>mkdir private_db</userinput> <prompt>$</prompt> <userinput>mkdir private_db</userinput>
<prompt>$</prompt> <userinput>initlocation ~/private_db</userinput> <prompt>$</prompt> <userinput>initlocation ~/private_db</userinput>
<computeroutput>Creating Postgres database system directory /home/olly/private_db/base</computeroutput> <computeroutput>Creating Postgres database system directory /home/olly/private_db/base</computeroutput>
<prompt>$</prompt> <userinput>psql olly</userinput> <prompt>$</prompt> <userinput>psql olly</userinput>
<computeroutput>Welcome to the POSTGRESQL interactive sql monitor: <computeroutput>Welcome to the POSTGRESQL interactive sql monitor:
Please read the file COPYRIGHT for copyright terms of POSTGRESQL Please read the file COPYRIGHT for copyright terms of POSTGRESQL
type \? for help on slash commands type \? for help on slash commands
type \q to quit type \q to quit
type \g or terminate with semicolon to execute query type \g or terminate with semicolon to execute query
You are currently connected to the database: template1 You are currently connected to the database: template1
<prompt>olly=></prompt></computeroutput> <userinput>create database elsewhere with location = '/home/olly/private_db';</userinput> <prompt>olly=></prompt></computeroutput> <userinput>create database elsewhere with location = '/home/olly/private_db';</userinput>
<computeroutput>CREATEDB</computeroutput> <computeroutput>CREATEDB</computeroutput>
</ProgramListing> </ProgramListing>
</REFSECT1> </REFSECT1>
...@@ -190,7 +196,6 @@ Not sure if the dump/reload would guarantee that the alternate data area gets re ...@@ -190,7 +196,6 @@ Not sure if the dump/reload would guarantee that the alternate data area gets re
<TITLE> <TITLE>
Compatibility Compatibility
</TITLE> </TITLE>
<PARA>
<REFSECT2 ID="R2-SQL-CREATEDATABASE-4"> <REFSECT2 ID="R2-SQL-CREATEDATABASE-4">
<REFSECT2INFO> <REFSECT2INFO>
......
doc/src/sgml/ref/create_function.sgml
View file @ a75f2d21
...@@ -12,7 +12,7 @@ ...@@ -12,7 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Defines a new function Defines a new function
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-09</DATE> <DATE>1998-09-09</DATE>
...@@ -66,30 +66,31 @@ CREATE FUNCTION <replaceable class="parameter">name</replaceable> ( [ <replaceab ...@@ -66,30 +66,31 @@ CREATE FUNCTION <replaceable class="parameter">name</replaceable> ( [ <replaceab
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<replaceable class="parameter">path</replaceable> <replaceable class="parameter">path</replaceable>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
May be either an SQL-query or an absolute path to an May be either an SQL-query or an absolute path to an
object file. object file.
</PARA> </PARA>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<replaceable class="parameter">langname</replaceable> <replaceable class="parameter">langname</replaceable>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
may be '<literal>C</literal>', '<literal>sql</literal>', may be '<literal>C</literal>', '<literal>sql</literal>',
'<literal>internal</literal>' '<literal>internal</literal>'
or '<replaceable class="parameter">plname</replaceable>', or '<replaceable class="parameter">plname</replaceable>',
where '<replaceable class="parameter">plname</replaceable>' where '<replaceable class="parameter">plname</replaceable>'
is the name of a created procedural is the name of a created procedural
language. See <command>CREATE LANGUAGE</command> for details. language. See <command>CREATE LANGUAGE</command> for details.
</PARA> </PARA>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
</variablelist> </variablelist>
</para>
</REFSECT2> </REFSECT2>
<REFSECT2 ID="R2-SQL-CREATEFUNCTION-2"> <REFSECT2 ID="R2-SQL-CREATEFUNCTION-2">
...@@ -100,16 +101,20 @@ CREATE FUNCTION <replaceable class="parameter">name</replaceable> ( [ <replaceab ...@@ -100,16 +101,20 @@ CREATE FUNCTION <replaceable class="parameter">name</replaceable> ( [ <replaceab
Outputs Outputs
</TITLE> </TITLE>
<PARA> <PARA>
<VARIABLELIST> <VARIABLELIST>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<ReturnValue>CREATE</ReturnValue> <ReturnValue>CREATE</ReturnValue>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
This is returned if the command completes successfully. This is returned if the command completes successfully.
</VARIABLELIST> </para>
</listitem>
</varlistentry>
</VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
...@@ -122,8 +127,8 @@ CREATE FUNCTION <replaceable class="parameter">name</replaceable> ( [ <replaceab ...@@ -122,8 +127,8 @@ CREATE FUNCTION <replaceable class="parameter">name</replaceable> ( [ <replaceab
</TITLE> </TITLE>
<PARA> <PARA>
<command>CREATE FUNCTION</command> allows a <command>CREATE FUNCTION</command> allows a
<productname>Postgres</productname> user <productname>Postgres</productname> user
to register a function to register a function
with a database. Subsequently, this user is treated as the with a database. Subsequently, this user is treated as the
owner of the function. owner of the function.
</PARA> </PARA>
...@@ -138,13 +143,14 @@ to register a function ...@@ -138,13 +143,14 @@ to register a function
<PARA> <PARA>
Refer to the chapter on functions Refer to the chapter on functions
in the <citetitle>PostgreSQL Programmer's Guide</citetitle> in the <citetitle>PostgreSQL Programmer's Guide</citetitle>
for further information. for further information.
</PARA> </PARA>
<PARA> <PARA>
Use <command>DROP FUNCTION</command> Use <command>DROP FUNCTION</command>
to drop user-defined functions. to drop user-defined functions.
</PARA> </PARA>
</REFSECT2> </REFSECT2>
</refsect1>
<REFSECT1 ID="R1-SQL-CREATEFUNCTION-2"> <REFSECT1 ID="R1-SQL-CREATEFUNCTION-2">
<TITLE> <TITLE>
...@@ -154,17 +160,17 @@ in the <citetitle>PostgreSQL Programmer's Guide</citetitle> ...@@ -154,17 +160,17 @@ in the <citetitle>PostgreSQL Programmer's Guide</citetitle>
To create a simple SQL function: To create a simple SQL function:
</PARA> </PARA>
<ProgramListing> <ProgramListing>
CREATE FUNCTION one() RETURNS int4 CREATE FUNCTION one() RETURNS int4
AS 'SELECT 1 AS RESULT' AS 'SELECT 1 AS RESULT'
LANGUAGE 'sql'; LANGUAGE 'sql';
SELECT one() AS answer; SELECT one() AS answer;
<computeroutput> <computeroutput>
answer answer
------ ------
1 1
</computeroutput> </computeroutput>
</ProgramListing> </ProgramListing>
<para> <para>
To create a C function, calling a routine from a user-created To create a C function, calling a routine from a user-created
...@@ -173,18 +179,18 @@ answer ...@@ -173,18 +179,18 @@ answer
is correct. It is intended for use in a CHECK contraint. is correct. It is intended for use in a CHECK contraint.
</para> </para>
<programlisting> <programlisting>
<userinput> <userinput>
CREATE FUNCTION ean_checkdigit(bpchar, bpchar) RETURNS bool CREATE FUNCTION ean_checkdigit(bpchar, bpchar) RETURNS bool
AS '/usr1/proj/bray/sql/funcs.so' LANGUAGE 'c'; AS '/usr1/proj/bray/sql/funcs.so' LANGUAGE 'c';
CREATE TABLE product CREATE TABLE product
( (
id char(8) PRIMARY KEY, id char(8) PRIMARY KEY,
eanprefix char(8) CHECK (eanprefix ~ '[0-9]{2}-[0-9]{5}') eanprefix char(8) CHECK (eanprefix ~ '[0-9]{2}-[0-9]{5}')
REFERENCES brandname(ean_prefix), REFERENCES brandname(ean_prefix),
eancode char(6) CHECK (eancode ~ '[0-9]{6}'), eancode char(6) CHECK (eancode ~ '[0-9]{6}'),
CONSTRAINT ean CHECK (ean_checkdigit(eanprefix, eancode)) CONSTRAINT ean CHECK (ean_checkdigit(eanprefix, eancode))
);</userinput> );</userinput>
</programlisting> </programlisting>
</REFSECT1> </REFSECT1>
......
doc/src/sgml/ref/create_index.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ ...@@ -12,6 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Constructs a secondary index Constructs a secondary index
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-09</DATE> <DATE>1998-09-09</DATE>
...@@ -139,21 +140,21 @@ SELECT am.amname AS acc_name, ...@@ -139,21 +140,21 @@ SELECT am.amname AS acc_name,
</programlisting> </programlisting>
</PARA> </PARA>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<replaceable class="parameter">func_name</replaceable> <replaceable class="parameter">func_name</replaceable>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
A user-defined function, which returns a value that can A user-defined function, which returns a value that can
be indexed. be indexed.
</PARA> </PARA>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
</variablelist> </variablelist>
</para>
</REFSECT2> </REFSECT2>
<REFSECT2 ID="R2-SQL-CREATEINDEX-2"> <REFSECT2 ID="R2-SQL-CREATEINDEX-2">
...@@ -178,15 +179,17 @@ SELECT am.amname AS acc_name, ...@@ -178,15 +179,17 @@ SELECT am.amname AS acc_name,
</VARLISTENTRY> </VARLISTENTRY>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<ReturnValue>ERROR: Cannot create index: 'index_name' already exists.</ReturnValue> <ReturnValue>ERROR: Cannot create index: 'index_name' already exists.</ReturnValue>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
This error occurs if it is impossible to create the index. This error occurs if it is impossible to create the index.
</para>
</VARIABLELIST> </listitem>
</varlistentry>
</variablelist>
</para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
...@@ -198,17 +201,18 @@ SELECT am.amname AS acc_name, ...@@ -198,17 +201,18 @@ SELECT am.amname AS acc_name,
Description Description
</TITLE> </TITLE>
<PARA> <PARA>
<command>CREATE INDEX</command> constructs an index <command>CREATE INDEX</command> constructs an index
<replaceable class="parameter">index_name</replaceable>. <replaceable class="parameter">index_name</replaceable>.
on the specified on the specified
<replaceable class="parameter">table</replaceable>. <replaceable class="parameter">table</replaceable>.
<tip> <tip>
<para> <para>
Indexes are primarily used to enhance database performance. Indexes are primarily used to enhance database performance.
But inappropriate use will result in slower performance. But inappropriate use will result in slower performance.
</tip> </para>
</tip>
</para>
<para> <para>
In the first syntax shown above, the key fields for the In the first syntax shown above, the key fields for the
index are specified as column names; a column may also have index are specified as column names; a column may also have
...@@ -247,7 +251,8 @@ But inappropriate use will result in slower performance. ...@@ -247,7 +251,8 @@ But inappropriate use will result in slower performance.
to remove an index. to remove an index.
</para> </para>
</REFSECT2> </REFSECT2>
</refsect1>
<REFSECT1 ID="R1-SQL-CREATEINDEX-2"> <REFSECT1 ID="R1-SQL-CREATEINDEX-2">
<TITLE> <TITLE>
Usage Usage
......
doc/src/sgml/ref/create_language.sgml
View file @ a75f2d21
...@@ -12,7 +12,7 @@ ...@@ -12,7 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Defines a new language for functions Defines a new language for functions
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-09</DATE> <DATE>1998-09-09</DATE>
...@@ -75,25 +75,26 @@ superuser privilege can use ...@@ -75,25 +75,26 @@ superuser privilege can use
procedures. procedures.
</PARA> </PARA>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<replaceable class="parameter">comment</replaceable> <replaceable class="parameter">comment</replaceable>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
The <function>LANCOMPILER</function> argument is the The <function>LANCOMPILER</function> argument is the
string that will be string that will be
inserted in the <literal>LANCOMPILER</literal> attribute inserted in the <literal>LANCOMPILER</literal> attribute
of the new of the new
<filename>pg_language</filename> entry. At present, <filename>pg_language</filename> entry. At present,
<productname>Postgres</productname> does not use <productname>Postgres</productname> does not use
this attribute in any way. this attribute in any way.
</PARA> </PARA>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
</variablelist> </variablelist>
</para>
</REFSECT2> </REFSECT2>
<REFSECT2 ID="R2-SQL-CREATELANGUAGE-2"> <REFSECT2 ID="R2-SQL-CREATELANGUAGE-2">
...@@ -117,15 +118,19 @@ superuser privilege can use ...@@ -117,15 +118,19 @@ superuser privilege can use
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<ReturnValue>ERROR: PL handler function <replaceable class="parameter">funcname</replaceable>() doesn't exist</ReturnValue> <ReturnValue>ERROR: PL handler function <replaceable class="parameter">funcname</replaceable>() doesn't exist</ReturnValue>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
This error is returned if the function This error is returned if the function
<replaceable class="parameter">funcname</replaceable>() <replaceable class="parameter">funcname</replaceable>()
is not found. is not found.
</VARIABLELIST> </para>
</listitem>
</varlistentry>
</VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
...@@ -206,6 +211,7 @@ Subsequently, functions and ...@@ -206,6 +211,7 @@ Subsequently, functions and
file or anything else that tells the call handler what to file or anything else that tells the call handler what to
do in detail. do in detail.
</para> </para>
</refsect2>
<REFSECT2 ID="R2-SQL-CREATELANGUAGE-4"> <REFSECT2 ID="R2-SQL-CREATELANGUAGE-4">
<REFSECT2INFO> <REFSECT2INFO>
...@@ -320,19 +326,20 @@ sql |postgres ...@@ -320,19 +326,20 @@ sql |postgres
of the dots to complete the PL call handler. of the dots to complete the PL call handler.
See <command>CREATE FUNCTION</command> for information on how to compile See <command>CREATE FUNCTION</command> for information on how to compile
it into a loadable module it into a loadable module
.</para> .</para>
<para> <para>
The following commands then register the sample procedural The following commands then register the sample procedural
language: language:
<programlisting> <programlisting>
CREATE FUNCTION plsample_call_handler () RETURNS opaque CREATE FUNCTION plsample_call_handler () RETURNS opaque
AS '/usr/local/pgsql/lib/plsample.so' AS '/usr/local/pgsql/lib/plsample.so'
LANGUAGE 'C'; LANGUAGE 'C';
CREATE PROCEDURAL LANGUAGE 'plsample' CREATE PROCEDURAL LANGUAGE 'plsample'
HANDLER plsample_call_handler HANDLER plsample_call_handler
LANCOMPILER 'PL/Sample'; LANCOMPILER 'PL/Sample';
</programlisting> </programlisting>
</para>
</REFSECT1> </REFSECT1>
<REFSECT1 ID="R1-SQL-CREATELANGUAGE-7"> <REFSECT1 ID="R1-SQL-CREATELANGUAGE-7">
......
doc/src/sgml/ref/create_operator.sgml
View file @ a75f2d21
...@@ -12,7 +12,7 @@ ...@@ -12,7 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Defines a new user operator Defines a new user operator
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-09</DATE> <DATE>1998-09-09</DATE>
...@@ -155,16 +155,19 @@ Operator to use for sorting. ...@@ -155,16 +155,19 @@ Operator to use for sorting.
Outputs Outputs
</TITLE> </TITLE>
<PARA> <PARA>
<VARIABLELIST> <VARIABLELIST>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<ReturnValue>CREATE</ReturnValue> <ReturnValue>CREATE</ReturnValue>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
Message returned if the operator is successfully created. Message returned if the operator is successfully created.
</para>
</VARIABLELIST> </listitem>
</varlistentry>
</VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
...@@ -176,25 +179,25 @@ Operator to use for sorting. ...@@ -176,25 +179,25 @@ Operator to use for sorting.
Description Description
</TITLE> </TITLE>
<PARA> <PARA>
<command>CREATE OPERATOR</command> defines a new operator, <command>CREATE OPERATOR</command> defines a new operator,
<replaceable class="parameter">name</replaceable>. <replaceable class="parameter">name</replaceable>.
The user who defines an operator becomes its owner. The user who defines an operator becomes its owner.
</para> </para>
<para> <para>
The operator <replaceable class="parameter">name</replaceable> The operator <replaceable class="parameter">name</replaceable>
is a sequence of up to thirty two (32) characters in any combination is a sequence of up to thirty two (32) characters in any combination
from the following: from the following:
<literallayout> <literallayout>
+ - * / &lt; &gt; = ~ ! @ # % ^ & | ` ? $ : + - * / &lt; &gt; = ~ ! @ # % ^ & | ` ? $ :
</literallayout> </literallayout>
<note> <note>
<para> <para>
No alphabetic characters are allowed in an operator name. No alphabetic characters are allowed in an operator name.
This enables <productname>Postgres</productname> to parse SQL input This enables <productname>Postgres</productname> to parse SQL input
into tokens without requiring spaces between each token. into tokens without requiring spaces between each token.
</note> </para>
</note>
</para> </para>
<para> <para>
The operator "!=" is mapped to "&lt;&gt;" on input, so they are The operator "!=" is mapped to "&lt;&gt;" on input, so they are
therefore equivalent. therefore equivalent.
...@@ -206,26 +209,26 @@ into tokens without requiring spaces between each token. ...@@ -206,26 +209,26 @@ into tokens without requiring spaces between each token.
unary operators only RIGHTARG should be defined. unary operators only RIGHTARG should be defined.
</para> </para>
<para> <para>
Also, the Also, the
<replaceable class="parameter">func_name</replaceable> procedure must have <replaceable class="parameter">func_name</replaceable> procedure must have
been previously defined using <command>CREATE FUNCTION</command> and must been previously defined using <command>CREATE FUNCTION</command> and must
be defined to accept the correct number of arguments be defined to accept the correct number of arguments
(either one or two). (either one or two).
</para> </para>
<para> <para>
The commutator operator is present so that The commutator operator is present so that
<productname>Postgres</productname> can <productname>Postgres</productname> can
reverse the order of the operands if it wishes. reverse the order of the operands if it wishes.
For example, the operator area-less-than, &lt;&lt;&lt;, For example, the operator area-less-than, &lt;&lt;&lt;,
would have a commutator would have a commutator
operator, area-greater-than, &gt;&gt;&gt;. operator, area-greater-than, &gt;&gt;&gt;.
Hence, the query optimizer could freely convert: Hence, the query optimizer could freely convert:
<programlisting> <programlisting>
"0,0,1,1"::box &gt;&gt;&gt; MYBOXES.description "0,0,1,1"::box &gt;&gt;&gt; MYBOXES.description
</programlisting> </programlisting>
to to
<programlisting> <programlisting>
MYBOXES.description &lt;&lt;&lt; "0,0,1,1"::box</programlisting> MYBOXES.description &lt;&lt;&lt; "0,0,1,1"::box</programlisting>
</para> </para>
<para> <para>
This allows the execution code to always use the latter This allows the execution code to always use the latter
...@@ -233,21 +236,21 @@ MYBOXES.description &lt;&lt;&lt; "0,0,1,1"::box</programlisting> ...@@ -233,21 +236,21 @@ MYBOXES.description &lt;&lt;&lt; "0,0,1,1"::box</programlisting>
what. what.
</para> </para>
<para> <para>
Suppose that an Suppose that an
operator, area-equal, ===, exists, as well as an area not operator, area-equal, ===, exists, as well as an area not
equal, !==. equal, !==.
The negator operator allows the query optimizer to convert The negator operator allows the query optimizer to convert
<programlisting> <programlisting>
NOT MYBOXES.description === "0,0,1,1"::box NOT MYBOXES.description === "0,0,1,1"::box
</programlisting> </programlisting>
to to
<programlisting> <programlisting>
MYBOXES.description !== "0,0,1,1"::box MYBOXES.description !== "0,0,1,1"::box
</programlisting> </programlisting>
</para> </para>
<para> <para>
If a commutator operator name is supplied, If a commutator operator name is supplied,
<productname>Postgres</productname> <productname>Postgres</productname>
searches for it in the catalog. If it is found and it searches for it in the catalog. If it is found and it
does not yet have a commutator itself, then the commutator's does not yet have a commutator itself, then the commutator's
entry is updated to have the current (new) operator entry is updated to have the current (new) operator
...@@ -264,22 +267,22 @@ MYBOXES.description !== "0,0,1,1"::box ...@@ -264,22 +267,22 @@ MYBOXES.description !== "0,0,1,1"::box
<para> <para>
The next two specifications are present to support the The next two specifications are present to support the
query optimizer in performing joins. query optimizer in performing joins.
<productname>Postgres</productname> can always <productname>Postgres</productname> can always
evaluate a join (i.e., processing a clause with two tuple evaluate a join (i.e., processing a clause with two tuple
variables separated by an operator that returns a boolean) variables separated by an operator that returns a boolean)
by iterative substitution [WONG76]. by iterative substitution [WONG76].
In addition, <productname>Postgres</productname> In addition, <productname>Postgres</productname>
is planning on implementing a hash-join algorithm along is planning on implementing a hash-join algorithm along
the lines of [SHAP86]; however, it must know whether this the lines of [SHAP86]; however, it must know whether this
strategy is applicable. strategy is applicable.
For example, a hash-join For example, a hash-join
algorithm is usable for a clause of the form: algorithm is usable for a clause of the form:
<programlisting> <programlisting>
MYBOXES.description === MYBOXES2.description MYBOXES.description === MYBOXES2.description
</programlisting> </programlisting>
but not for a clause of the form: but not for a clause of the form:
<programlisting> <programlisting>
MYBOXES.description &lt;&lt;&lt; MYBOXES2.description. MYBOXES.description &lt;&lt;&lt; MYBOXES2.description.
</programlisting> </programlisting>
The HASHES flag gives the needed information to the query The HASHES flag gives the needed information to the query
optimizer concerning whether a hash join strategy is optimizer concerning whether a hash join strategy is
...@@ -292,13 +295,13 @@ MYBOXES.description &lt;&lt;&lt; MYBOXES2.description. ...@@ -292,13 +295,13 @@ MYBOXES.description &lt;&lt;&lt; MYBOXES2.description.
sort both relations using the operator, &lt;&lt;&lt;. On the other sort both relations using the operator, &lt;&lt;&lt;. On the other
hand, merge-sort is not usable with the clause: hand, merge-sort is not usable with the clause:
<programlisting> <programlisting>
MYBOXES.description &lt;&lt;&lt; MYBOXES2.description MYBOXES.description &lt;&lt;&lt; MYBOXES2.description
</programlisting> </programlisting>
</para> </para>
<para> <para>
If other join strategies are found to be practical, If other join strategies are found to be practical,
<productname>Postgres</productname> <productname>Postgres</productname>
will change the optimizer and run-time system to use will change the optimizer and run-time system to use
them and will require additional specification when an them and will require additional specification when an
operator is defined. Fortunately, the research community operator is defined. Fortunately, the research community
invents new join strategies infrequently, and the added invents new join strategies infrequently, and the added
...@@ -310,14 +313,14 @@ MYBOXES.description &lt;&lt;&lt; MYBOXES2.description ...@@ -310,14 +313,14 @@ MYBOXES.description &lt;&lt;&lt; MYBOXES2.description
the query optimizer can estimate result sizes. If a the query optimizer can estimate result sizes. If a
clause of the form: clause of the form:
<programlisting> <programlisting>
MYBOXES.description &lt;&lt;&lt; "0,0,1,1"::box MYBOXES.description &lt;&lt;&lt; "0,0,1,1"::box
</programlisting> </programlisting>
is present in the qualification, is present in the qualification,
then <productname>Postgres</productname> may have to then <productname>Postgres</productname> may have to
estimate the fraction of the instances in MYBOXES that estimate the fraction of the instances in MYBOXES that
satisfy the clause. The function satisfy the clause. The function
<replaceable class="parameter">res_proc</replaceable> <replaceable class="parameter">res_proc</replaceable>
must be a registered function (meaning it is already defined using must be a registered function (meaning it is already defined using
define function(l)) which accepts one argument of the correct define function(l)) which accepts one argument of the correct
data type and returns a floating point number. The data type and returns a floating point number. The
query optimizer simply calls this function, passing the query optimizer simply calls this function, passing the
...@@ -335,14 +338,14 @@ MYBOXES.description &lt;&lt;&lt; "0,0,1,1"::box ...@@ -335,14 +338,14 @@ MYBOXES.description &lt;&lt;&lt; "0,0,1,1"::box
<para> <para>
The difference between the function The difference between the function
<programlisting> <programlisting>
my_procedure_1 (MYBOXES.description, "0,0,1,1"::box) my_procedure_1 (MYBOXES.description, "0,0,1,1"::box)
</programlisting> </programlisting>
and the operator and the operator
<programlisting> <programlisting>
MYBOXES.description === "0,0,1,1"::box MYBOXES.description === "0,0,1,1"::box
</programlisting> </programlisting>
is that <productname>Postgres</productname> is that <productname>Postgres</productname>
attempts to optimize operators and can attempts to optimize operators and can
decide to use an index to restrict the search space when decide to use an index to restrict the search space when
operators are involved. However, there is no attempt to operators are involved. However, there is no attempt to
optimize functions, and they are performed by brute force. optimize functions, and they are performed by brute force.
...@@ -359,12 +362,13 @@ MYBOXES.description === "0,0,1,1"::box ...@@ -359,12 +362,13 @@ MYBOXES.description === "0,0,1,1"::box
</TITLE> </TITLE>
<PARA> <PARA>
Refer to the chapter on operators in the Refer to the chapter on operators in the
<citetitle>PostgreSQL User's Guide</citetitle> <citetitle>PostgreSQL User's Guide</citetitle>
for further information. for further information.
Refer to <command>DROP OPERATOR</command> to delete Refer to <command>DROP OPERATOR</command> to delete
user-defined operators from a database. user-defined operators from a database.
</para>
</REFSECT2> </REFSECT2>
</refsect1>
<REFSECT1 ID="R1-SQL-CREATEOPERATOR-2"> <REFSECT1 ID="R1-SQL-CREATEOPERATOR-2">
<TITLE> <TITLE>
...@@ -374,19 +378,17 @@ user-defined operators from a database. ...@@ -374,19 +378,17 @@ user-defined operators from a database.
area-equality, for the BOX data type. area-equality, for the BOX data type.
</PARA> </PARA>
<ProgramListing> <ProgramListing>
CREATE OPERATOR === ( CREATE OPERATOR === (
LEFTARG = box, LEFTARG = box,
RIGHTARG = box, RIGHTARG = box,
PROCEDURE = area_equal_procedure, PROCEDURE = area_equal_procedure,
COMMUTATOR = ===, COMMUTATOR = ===,
NEGATOR = !==, NEGATOR = !==,
RESTRICT = area_restriction_procedure, RESTRICT = area_restriction_procedure,
HASHES, HASHES,
JOIN = area-join-procedure, JOIN = area-join-procedure,
SORT = <<<, <<<) SORT = <<<, <<<)
</ProgramListing> </ProgramListing>
</REFSECT1> </REFSECT1>
<REFSECT1 ID="R1-SQL-CREATEOPERATOR-3"> <REFSECT1 ID="R1-SQL-CREATEOPERATOR-3">
......
doc/src/sgml/ref/create_rule.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ ...@@ -12,6 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Defines a new rule Defines a new rule
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-11</DATE> <DATE>1998-09-11</DATE>
...@@ -110,10 +111,11 @@ CREATE RULE <replaceable class="parameter">name</replaceable> ...@@ -110,10 +111,11 @@ CREATE RULE <replaceable class="parameter">name</replaceable>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
Message returned if the rule is successfully created. Message returned if the rule is successfully created.
</para>
</VARLISTENTRY> </listitem>
</VARIABLELIST> </VARLISTENTRY>
</VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
...@@ -216,8 +218,8 @@ select * from EMP ...@@ -216,8 +218,8 @@ select * from EMP
<para> <para>
You must have rule definition access to a class in order You must have rule definition access to a class in order
to define a rule on it. Use <command>GRANT</command> to define a rule on it. Use <command>GRANT</command>
and <command>REVOKE</command> to change permissions. and <command>REVOKE</command> to change permissions.
</PARA> </PARA>
</REFSECT2> </REFSECT2>
</refsect1> </refsect1>
...@@ -307,6 +309,7 @@ create rule example_5 is ...@@ -307,6 +309,7 @@ create rule example_5 is
fail if the rule plus its various internal representations fail if the rule plus its various internal representations
exceed some value that is on the order of one page (8KB). exceed some value that is on the order of one page (8KB).
</PARA> </PARA>
</refsect1>
<REFSECT1 ID="R1-SQL-CREATERULE-4"> <REFSECT1 ID="R1-SQL-CREATERULE-4">
<TITLE> <TITLE>
......
doc/src/sgml/ref/create_sequence.sgml
View file @ a75f2d21
...@@ -12,7 +12,7 @@ ...@@ -12,7 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Creates a new sequence number generator Creates a new sequence number generator
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-04-15</DATE> <DATE>1998-04-15</DATE>
...@@ -197,8 +197,11 @@ CREATE SEQUENCE <replaceable class="parameter">seqname</replaceable> ...@@ -197,8 +197,11 @@ CREATE SEQUENCE <replaceable class="parameter">seqname</replaceable>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
If the minimum and maximum values are inconsistant. If the minimum and maximum values are inconsistant.
</para>
</VARIABLELIST> </listitem>
</varlistentry>
</VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
...@@ -254,27 +257,28 @@ SELECT last_value FROM sequence_name; ...@@ -254,27 +257,28 @@ SELECT last_value FROM sequence_name;
</para> </para>
<caution> <caution>
<para> <para>
Unexpected results may be obtained if a cache setting greater than one Unexpected results may be obtained if a cache setting greater than one
is used for a sequence object that will be used concurrently by multiple is used for a sequence object that will be used concurrently by multiple
backends. Each backend will allocate "cache" successive sequence values backends. Each backend will allocate "cache" successive sequence values
during one access to the sequence object and increase the sequence during one access to the sequence object and increase the sequence
object's last_value accordingly. Then, the next cache-1 uses of nextval object's last_value accordingly. Then, the next cache-1 uses of nextval
within that backend simply return the preallocated values without touching within that backend simply return the preallocated values without touching
the shared object. So, numbers allocated but not used in the current session the shared object. So, numbers allocated but not used in the current session
will be lost. Furthermore, although multiple backends are guaranteed to will be lost. Furthermore, although multiple backends are guaranteed to
allocate distinct sequence values, the values may be generated out of allocate distinct sequence values, the values may be generated out of
sequence when all the backends are considered. (For example, with a cache sequence when all the backends are considered. (For example, with a cache
setting of 10, backend A might reserve values 1..10 and return nextval=1, setting of 10, backend A might reserve values 1..10 and return nextval=1,
then then
backend B might reserve values 11..20 and return nextval=11 before backend backend B might reserve values 11..20 and return nextval=11 before backend
A has generated nextval=2.) Thus, with a cache setting of one it is safe A has generated nextval=2.) Thus, with a cache setting of one it is safe
to assume that nextval values are generated sequentially; with a cache to assume that nextval values are generated sequentially; with a cache
setting greater than one you should only assume that the nextval values setting greater than one you should only assume that the nextval values
are all distinct, not that they are generated purely sequentially. are all distinct, not that they are generated purely sequentially.
Also, last_value will reflect the latest value reserved by any backend, Also, last_value will reflect the latest value reserved by any backend,
whether or not it has yet been returned by nextval. whether or not it has yet been returned by nextval.
</caution> </para>
</caution>
<REFSECT2 ID="R2-SQL-CREATESEQUENCE-3"> <REFSECT2 ID="R2-SQL-CREATESEQUENCE-3">
<REFSECT2INFO> <REFSECT2INFO>
...@@ -324,16 +328,16 @@ INSERT INTO distributors VALUES (NEXTVAL('serial'),'nothing'); ...@@ -324,16 +328,16 @@ INSERT INTO distributors VALUES (NEXTVAL('serial'),'nothing');
<para> <para>
Set the sequence value after a COPY FROM: Set the sequence value after a COPY FROM:
<programlisting> <programlisting>
CREATE FUNCTION distributors_id_max() RETURNS INT4 CREATE FUNCTION distributors_id_max() RETURNS INT4
AS 'SELECT max(id) FROM distributors' AS 'SELECT max(id) FROM distributors'
LANGUAGE 'sql'; LANGUAGE 'sql';
BEGIN; BEGIN;
COPY distributors FROM 'input_file'; COPY distributors FROM 'input_file';
SELECT setval('serial', distributors_id_max()); SELECT setval('serial', distributors_id_max());
END; END;
</programlisting> </programlisting>
</para> </para>
</REFSECT1> </REFSECT1>
<REFSECT1 ID="R1-SQL-CREATESEQUENCE-3"> <REFSECT1 ID="R1-SQL-CREATESEQUENCE-3">
...@@ -342,7 +346,7 @@ END; ...@@ -342,7 +346,7 @@ END;
</TITLE> </TITLE>
<PARA> <PARA>
<command>CREATE SEQUENCE</command> is a <productname>Postgres</productname> <command>CREATE SEQUENCE</command> is a <productname>Postgres</productname>
language extension. language extension.
</PARA> </PARA>
<REFSECT2 ID="R2-SQL-CREATESEQUENCE-4"> <REFSECT2 ID="R2-SQL-CREATESEQUENCE-4">
......
doc/src/sgml/ref/create_table.sgml
View file @ a75f2d21
...@@ -12,7 +12,7 @@ ...@@ -12,7 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Creates a new table Creates a new table
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-11</DATE> <DATE>1998-09-11</DATE>
...@@ -20,8 +20,7 @@ ...@@ -20,8 +20,7 @@
<SYNOPSIS> <SYNOPSIS>
CREATE TABLE <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE> ( CREATE TABLE <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE> (
<REPLACEABLE CLASS="PARAMETER">column</REPLACEABLE> <REPLACEABLE CLASS="PARAMETER">type</REPLACEABLE> <REPLACEABLE CLASS="PARAMETER">column</REPLACEABLE> <REPLACEABLE CLASS="PARAMETER">type</REPLACEABLE>
[ DEFAULT <REPLACEABLE CLASS="PARAMETER">value</REPLACEABLE>] [ NULL | NOT NULL ] [ UNIQUE ] [ DEFAULT <REPLACEABLE CLASS="PARAMETER">value</REPLACEABLE> ]
[, NOT NULL ] [ ,UNIQUE ]
[<REPLACEABLE>column_constraint_clause</REPLACEABLE> | PRIMARY KEY } [ ... ] ] [<REPLACEABLE>column_constraint_clause</REPLACEABLE> | PRIMARY KEY } [ ... ] ]
[, ... ] [, ... ]
[, PRIMARY KEY ( <REPLACEABLE CLASS="PARAMETER">column</REPLACEABLE> [, ...] ) ] [, PRIMARY KEY ( <REPLACEABLE CLASS="PARAMETER">column</REPLACEABLE> [, ...] ) ]
...@@ -126,33 +125,32 @@ requires the <REPLACEABLE CLASS="PARAMETER">column_constraint_clause</REPLACEABL ...@@ -126,33 +125,32 @@ requires the <REPLACEABLE CLASS="PARAMETER">column_constraint_clause</REPLACEABL
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
INHERITS <REPLACEABLE CLASS="PARAMETER">inherited_table</REPLACEABLE> INHERITS <REPLACEABLE CLASS="PARAMETER">inherited_table</REPLACEABLE>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
The optional INHERITS clause specifies a collection of table The optional INHERITS clause specifies a collection of table
names from which this table automatically inherits all fields. names from which this table automatically inherits all fields.
If any inherited field name appears more than once, If any inherited field name appears more than once,
<productname>Postgres</productname> <productname>Postgres</productname>
reports an error. reports an error.
<productname>Postgres</productname> automatically allows the created <productname>Postgres</productname> automatically allows the created
table to inherit functions on tables above it in the inheritance table to inherit functions on tables above it in the inheritance
hierarchy. hierarchy.
<note> <note>
<title>Aside</title> <title>Aside</title>
<para> <para>
Inheritance of functions is done according Inheritance of functions is done according
to the conventions of the Common Lisp Object System (CLOS). to the conventions of the Common Lisp Object System (CLOS).
</note> </para>
</PARA> </note>
</LISTITEM> </PARA>
</VARLISTENTRY> </LISTITEM>
</VARLISTENTRY>
</VARIABLELIST> </VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
<REFSECT2 ID="R2-SQL-CREATETABLE-2"> <REFSECT2 ID="R2-SQL-CREATETABLE-2">
...@@ -201,8 +199,11 @@ amcreate: "<replaceable class="parameter">table</replaceable>" relation already ...@@ -201,8 +199,11 @@ amcreate: "<replaceable class="parameter">table</replaceable>" relation already
<PARA> <PARA>
if data type of default value doesn't match the if data type of default value doesn't match the
column definition's data type. column definition's data type.
</para>
</VARIABLELIST> </listitem>
</varlistentry>
</VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
...@@ -217,7 +218,7 @@ amcreate: "<replaceable class="parameter">table</replaceable>" relation already ...@@ -217,7 +218,7 @@ amcreate: "<replaceable class="parameter">table</replaceable>" relation already
<command>CREATE TABLE</command> will enter a new table into the current data <command>CREATE TABLE</command> will enter a new table into the current data
base. The table will be "owned" by the user issuing the base. The table will be "owned" by the user issuing the
command. command.
</para>
<PARA> <PARA>
The new table is created as a heap with no initial data. The new table is created as a heap with no initial data.
A table can have no more than 1600 columns (realistically, A table can have no more than 1600 columns (realistically,
...@@ -226,9 +227,9 @@ amcreate: "<replaceable class="parameter">table</replaceable>" relation already ...@@ -226,9 +227,9 @@ amcreate: "<replaceable class="parameter">table</replaceable>" relation already
lower at some sites. A table cannot have the same name as lower at some sites. A table cannot have the same name as
a system catalog table. a system catalog table.
</PARA> </PARA>
</refsect1>
<REFSECT1 ID="R1-SQL-DEFAULTCLAUSE-1"> <REFSECT1 ID="R1-SQL-DEFAULTCLAUSE-1">
<REFSECT1INFO> <REFSECT1INFO>
<DATE>1998-09-11</DATE> <DATE>1998-09-11</DATE>
</REFSECT1INFO> </REFSECT1INFO>
...@@ -239,7 +240,7 @@ amcreate: "<replaceable class="parameter">table</replaceable>" relation already ...@@ -239,7 +240,7 @@ amcreate: "<replaceable class="parameter">table</replaceable>" relation already
<SYNOPSIS> <SYNOPSIS>
DEFAULT <REPLACEABLE CLASS="PARAMETER">value</REPLACEABLE> DEFAULT <REPLACEABLE CLASS="PARAMETER">value</REPLACEABLE>
</SYNOPSIS> </SYNOPSIS>
</para>
<REFSECT2 ID="R2-SQL-DEFAULTCLAUSE-1"> <REFSECT2 ID="R2-SQL-DEFAULTCLAUSE-1">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-09-11</DATE> <DATE>1998-09-11</DATE>
...@@ -270,23 +271,27 @@ DEFAULT <REPLACEABLE CLASS="PARAMETER">value</REPLACEABLE> ...@@ -270,23 +271,27 @@ DEFAULT <REPLACEABLE CLASS="PARAMETER">value</REPLACEABLE>
<listitem> <listitem>
<simpara> <simpara>
a niladic function a niladic function
</simpara> </simpara>
</listitem>
</itemizedlist>
</para>
</listitem> </listitem>
</VARLISTENTRY> </itemizedlist>
</para>
</variablelist> </listitem>
</VARLISTENTRY>
</variablelist>
</para>
</refsect2>
<REFSECT2 ID="R2-SQL-DEFAULTCLAUSE-2"> <REFSECT2 ID="R2-SQL-DEFAULTCLAUSE-2">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-09-11</DATE> <DATE>1998-09-11</DATE>
</REFSECT2INFO> </REFSECT2INFO>
<TITLE> <TITLE>
Outputs Outputs
</TITLE> </TITLE>
<PARA> <para>
</para>
</refsect2>
<REFSECT2 ID="R2-SQL-DEFAULTCLAUSE-3"> <REFSECT2 ID="R2-SQL-DEFAULTCLAUSE-3">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-09-11</DATE> <DATE>1998-09-11</DATE>
...@@ -365,6 +370,7 @@ DEFAULT <REPLACEABLE CLASS="PARAMETER">value</REPLACEABLE> ...@@ -365,6 +370,7 @@ DEFAULT <REPLACEABLE CLASS="PARAMETER">value</REPLACEABLE>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</para>
<para> <para>
In the current release (v6.4), <productname>Postgres</productname> In the current release (v6.4), <productname>Postgres</productname>
...@@ -386,7 +392,8 @@ DEFAULT CURRENT_TIMESTAMP ...@@ -386,7 +392,8 @@ DEFAULT CURRENT_TIMESTAMP
</quote>. </quote>.
This forces <productname>Postgres</productname> to consider the constant a string This forces <productname>Postgres</productname> to consider the constant a string
type and then to convert the value to <type>timestamp</type> at runtime. type and then to convert the value to <type>timestamp</type> at runtime.
</para>
</refsect2>
<REFSECT2 ID="R2-SQL-DEFAULTCLAUSE-4"> <REFSECT2 ID="R2-SQL-DEFAULTCLAUSE-4">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-09-11</DATE> <DATE>1998-09-11</DATE>
...@@ -406,7 +413,7 @@ CREATE TABLE video_sales ( ...@@ -406,7 +413,7 @@ CREATE TABLE video_sales (
total CASH DEFAULT '$0.0' total CASH DEFAULT '$0.0'
); );
</ProgramListing> </ProgramListing>
</para>
<PARA> <PARA>
To assign an existing sequence To assign an existing sequence
as the default for the column <literal>did</literal>, as the default for the column <literal>did</literal>,
...@@ -418,7 +425,8 @@ CREATE TABLE distributors ( ...@@ -418,7 +425,8 @@ CREATE TABLE distributors (
name VARCHAR(40) DEFAULT 'luso films' name VARCHAR(40) DEFAULT 'luso films'
); );
</ProgramListing> </ProgramListing>
</para>
</refsect2>
</REFSECT1> </REFSECT1>
<REFSECT1 ID="R1-SQL-COLUMNCONSTRAINT-1"> <REFSECT1 ID="R1-SQL-COLUMNCONSTRAINT-1">
...@@ -430,8 +438,9 @@ CREATE TABLE distributors ( ...@@ -430,8 +438,9 @@ CREATE TABLE distributors (
</TITLE> </TITLE>
<para> <para>
<SYNOPSIS> <SYNOPSIS>
[ CONSTRAINT <replaceable class="parameter">name</replaceable> ] { NOT NULL | UNIQUE | PRIMARY KEY | CHECK <replaceable class="parameter">constraint</replaceable> } [, ...] [ CONSTRAINT <replaceable class="parameter">name</replaceable> ] { [ NULL | NOT NULL ] | UNIQUE | PRIMARY KEY | CHECK <replaceable class="parameter">constraint</replaceable> } [, ...]
</SYNOPSIS> </SYNOPSIS>
</para>
<REFSECT2 ID="R2-SQL-COLUMNCONSTRAINT-1"> <REFSECT2 ID="R2-SQL-COLUMNCONSTRAINT-1">
<REFSECT2INFO> <REFSECT2INFO>
...@@ -457,6 +466,17 @@ which should ensure uniqueness for ...@@ -457,6 +466,17 @@ which should ensure uniqueness for
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
<VARLISTENTRY>
<TERM>
NULL
</TERM>
<LISTITEM>
<PARA>
The column is allowed to contain NULL values. This is the default.
</PARA>
</LISTITEM>
</VARLISTENTRY>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
NOT NULL NOT NULL
...@@ -507,6 +527,8 @@ as a unique identifier for rows. ...@@ -507,6 +527,8 @@ as a unique identifier for rows.
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
</VARIABLELIST> </VARIABLELIST>
</para>
</refsect2>
<REFSECT2 ID="R2-SQL-COLUMNCONSTRAINT-2"> <REFSECT2 ID="R2-SQL-COLUMNCONSTRAINT-2">
<REFSECT2INFO> <REFSECT2INFO>
...@@ -544,6 +566,7 @@ as a unique identifier for rows. ...@@ -544,6 +566,7 @@ as a unique identifier for rows.
accepts the REFERENCES syntax but ignores the clause. accepts the REFERENCES syntax but ignores the clause.
</para> </para>
</note> </note>
</refsect2>
<REFSECT2 ID="R2-SQL-NOTNULL-1"> <REFSECT2 ID="R2-SQL-NOTNULL-1">
<REFSECT2INFO> <REFSECT2INFO>
...@@ -564,69 +587,76 @@ accepts the REFERENCES syntax but ignores the clause. ...@@ -564,69 +587,76 @@ accepts the REFERENCES syntax but ignores the clause.
as a table constraint. as a table constraint.
</PARA> </PARA>
<REFSECT3 ID="R3-SQL-NOTNULL-1"> <REFSECT3 ID="R3-SQL-NOTNULL-1">
<REFSECT3INFO> <REFSECT3INFO>
<DATE>1998-09-11</DATE> <DATE>1998-09-11</DATE>
</REFSECT3INFO> </REFSECT3INFO>
<TITLE> <TITLE>
Outputs Outputs
</TITLE> </TITLE>
<PARA> <PARA>
</PARA> </PARA>
<VARIABLELIST> <VARIABLELIST>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<replaceable>status</replaceable> <replaceable>status</replaceable>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
<VARIABLELIST> <VARIABLELIST>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<ReturnValue>ERROR: ExecAppend: Fail to add null value in not <ReturnValue>ERROR: ExecAppend: Fail to add null value in not
null attribute "<replaceable class="parameter">column</replaceable>".</ReturnValue> null attribute "<replaceable class="parameter">column</replaceable>".</ReturnValue>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
This error occurs at runtime if one tries to insert a null value This error occurs at runtime if one tries to insert a null value
into a column which has a NOT NULL constraint. into a column which has a NOT NULL constraint.
</PARA> </PARA>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
</variablelist> </variablelist>
</LISTITEM> </para>
</VARLISTENTRY> </LISTITEM>
</VARIABLELIST> </VARLISTENTRY>
</VARIABLELIST>
<REFSECT3 ID="R3-SQL-NOTNULL-2"> </refsect3>
<REFSECT3INFO>
<DATE>1998-09-11</DATE>
</REFSECT3INFO>
<TITLE>
Description
</title>
<para>
<REFSECT3 ID="R3-SQL-NOTNULL-3">
<REFSECT3INFO>
<DATE>1998-09-11</DATE>
</REFSECT3INFO>
<TITLE>
Usage
</title>
<PARA>
Define two NOT NULL column constraints on the table
<classname>distributors</classname>,
one of which being a named constraint:
</PARA>
<ProgramListing>
CREATE TABLE distributors (
did DECIMAL(3) CONSTRAINT no_null NOT NULL,
name VARCHAR(40) NOT NULL
);
</ProgramListing>
<REFSECT3 ID="R3-SQL-NOTNULL-2">
<REFSECT3INFO>
<DATE>1998-09-11</DATE>
</REFSECT3INFO>
<TITLE>
Description
</title>
<para>
</para>
</refsect3>
<REFSECT3 ID="R3-SQL-NOTNULL-3">
<REFSECT3INFO>
<DATE>1998-09-11</DATE>
</REFSECT3INFO>
<TITLE>
Usage
</title>
<PARA>
Define two NOT NULL column constraints on the table
<classname>distributors</classname>,
one of which being a named constraint:
<ProgramListing>
CREATE TABLE distributors (
did DECIMAL(3) CONSTRAINT no_null NOT NULL,
name VARCHAR(40) NOT NULL
);
</ProgramListing>
</para>
</refsect3>
</refsect2>
<REFSECT2 ID="R2-SQL-UNIQUECLAUSE-1"> <REFSECT2 ID="R2-SQL-UNIQUECLAUSE-1">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-09-11</DATE> <DATE>1998-09-11</DATE>
...@@ -640,21 +670,22 @@ CREATE TABLE distributors ( ...@@ -640,21 +670,22 @@ CREATE TABLE distributors (
<refsect3> <refsect3>
<title>Inputs</title> <title>Inputs</title>
<para> <para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>
CONSTRAINT <replaceable class="parameter">name</replaceable> CONSTRAINT <replaceable class="parameter">name</replaceable>
</term> </term>
<listitem> <listitem>
<para> <para>
An arbitrary label given to a constraint. An arbitrary label given to a constraint.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</para>
</refsect3> </refsect3>
<refsect3> <refsect3>
<title>Outputs</title> <title>Outputs</title>
<PARA> <PARA>
...@@ -674,15 +705,17 @@ CREATE TABLE distributors ( ...@@ -674,15 +705,17 @@ CREATE TABLE distributors (
<para> <para>
This error occurs at runtime if one tries to insert a This error occurs at runtime if one tries to insert a
duplicate value into a column. duplicate value into a column.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist></para> </variablelist>
</listitem> </para>
</varlistentry> </listitem>
</variablelist> </varlistentry>
</variablelist>
</para>
</refsect3> </refsect3>
<refsect3> <refsect3>
<title> <title>
Description Description
...@@ -713,6 +746,7 @@ for more details.). ...@@ -713,6 +746,7 @@ for more details.).
data integrity. See CREATE INDEX for more information. data integrity. See CREATE INDEX for more information.
</Para> </Para>
</Note> </Note>
</refsect3>
<REFSECT3 ID="R3-SQL-UNIQUECLAUSE-3"> <REFSECT3 ID="R3-SQL-UNIQUECLAUSE-3">
<TITLE> <TITLE>
...@@ -737,6 +771,9 @@ CREATE TABLE distributors ( ...@@ -737,6 +771,9 @@ CREATE TABLE distributors (
UNIQUE(name) UNIQUE(name)
); );
</ProgramListing> </ProgramListing>
</para>
</refsect3>
</refsect2>
<REFSECT2 ID="R2-SQL-CHECK-1"> <REFSECT2 ID="R2-SQL-CHECK-1">
<REFSECT2INFO> <REFSECT2INFO>
...@@ -759,70 +796,73 @@ The CHECK Constraint ...@@ -759,70 +796,73 @@ The CHECK Constraint
<LISTITEM> <LISTITEM>
<PARA> <PARA>
An arbitrary name given to a constraint. An arbitrary name given to a constraint.
</PARA> </PARA>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
<VARLISTENTRY>
<TERM>
<replaceable>condition</replaceable>
</TERM>
<LISTITEM>
<PARA>
Any valid conditional expression evaluating to a boolean result.
</PARA>
</LISTITEM>
</VARLISTENTRY>
</variablelist>
</REFSECT3>
<REFSECT3 ID="R3-SQL-CHECK-2">
<REFSECT3INFO>
<DATE>1998-09-11</DATE>
</REFSECT3INFO>
<TITLE>
Outputs
</TITLE>
<PARA>
<VARIABLELIST>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<replaceable>status</replaceable> <replaceable>condition</replaceable>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
Any valid conditional expression evaluating to a boolean result.
</PARA>
</LISTITEM>
</VARLISTENTRY>
</variablelist>
</para>
</REFSECT3>
<REFSECT3 ID="R3-SQL-CHECK-2">
<REFSECT3INFO>
<DATE>1998-09-11</DATE>
</REFSECT3INFO>
<TITLE>
Outputs
</TITLE>
<PARA>
<VARIABLELIST> <VARIABLELIST>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<ReturnValue> <replaceable>status</replaceable>
ERROR: ExecAppend: rejected due to CHECK constraint
"<replaceable class="parameter">table_column</replaceable>".
</ReturnValue>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
This error occurs at runtime if one tries to insert an illegal
value into a column subject to a CHECK constraint. <VARIABLELIST>
</PARA> <VARLISTENTRY>
</LISTITEM> <TERM>
</VARLISTENTRY> <ReturnValue>
</variablelist> ERROR: ExecAppend: rejected due to CHECK constraint
"<replaceable class="parameter">table_column</replaceable>".
</ReturnValue>
</TERM>
<LISTITEM>
<PARA>
This error occurs at runtime if one tries to insert an illegal
value into a column subject to a CHECK constraint.
</PARA>
</LISTITEM>
</VARLISTENTRY>
</variablelist>
</para>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
</variablelist> </variablelist>
</para>
</REFSECT3> </REFSECT3>
<refsect3> <refsect3>
<title>Description</title> <title>Description</title>
<para> <para>
The CHECK constraint specifies a restriction on allowed values The CHECK constraint specifies a restriction on allowed values
within a column. within a column.
The CHECK constraint is also allowed as a table constraint. The CHECK constraint is also allowed as a table constraint.
</PARA> </PARA>
<PARA> <PARA>
The SQL92 CHECK column constraints can only be defined on, and The SQL92 CHECK column constraints can only be defined on, and
refer to, one column of the table. <productname>Postgres</productname> refer to, one column of the table. <productname>Postgres</productname>
does not have does not have
this restriction. this restriction.
</PARA> </PARA>
</refsect3> </refsect3>
...@@ -868,7 +908,7 @@ CONSTRAINT <REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE> ...@@ -868,7 +908,7 @@ CONSTRAINT <REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE>
<para> <para>
This occurs at run-time if one tries to insert a duplicate value into This occurs at run-time if one tries to insert a duplicate value into
a column subject to a PRIMARY KEY constraint. a column subject to a PRIMARY KEY constraint.
</PARA> </PARA>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
...@@ -909,83 +949,89 @@ However, <productname>Postgres</productname> does not specifically ...@@ -909,83 +949,89 @@ However, <productname>Postgres</productname> does not specifically
disallow this. disallow this.
</PARA> </PARA>
</refsect3> </refsect3>
</refsect2>
<REFSECT1 ID="R1-SQL-TABLECONSTRAINT-1"> </refsect1>
<REFSECT1INFO>
<DATE>1998-09-11</DATE> <REFSECT1 ID="R1-SQL-TABLECONSTRAINT-1">
</REFSECT1INFO> <REFSECT1INFO>
<TITLE> <DATE>1998-09-11</DATE>
</REFSECT1INFO>
<TITLE>
Table CONSTRAINT Clause Table CONSTRAINT Clause
</TITLE> </TITLE>
<para> <para>
<SYNOPSIS> <SYNOPSIS>
[ CONSTRAINT name ] { PRIMARY KEY | UNIQUE } ( <replaceable class="parameter">column</replaceable> [, ...] ) [ CONSTRAINT name ] { PRIMARY KEY | UNIQUE } ( <replaceable class="parameter">column</replaceable> [, ...] )
[ CONSTRAINT name ] CHECK ( <replaceable>constraint</replaceable> ) [ CONSTRAINT name ] CHECK ( <replaceable>constraint</replaceable> )
</SYNOPSIS> </SYNOPSIS>
<PARA> </para>
<REFSECT2 ID="R2-SQL-TABLECONSTRAINT-1"> <REFSECT2 ID="R2-SQL-TABLECONSTRAINT-1">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-09-11</DATE> <DATE>1998-09-11</DATE>
</REFSECT2INFO> </REFSECT2INFO>
<title> <title>
Inputs Inputs
</title> </title>
<para> <para>
<VARIABLELIST> <VARIABLELIST>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
CONSTRAINT <replaceable class="parameter">name</replaceable> CONSTRAINT <replaceable class="parameter">name</replaceable>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
An arbitrary name given to an integrity constraint. An arbitrary name given to an integrity constraint.
</PARA> </PARA>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<replaceable class="parameter">column</replaceable> [, ...] <replaceable class="parameter">column</replaceable> [, ...]
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
The column name(s) for which to define a unique index The column name(s) for which to define a unique index
and, for PRIMARY KEY, a NOT NULL constraint. and, for PRIMARY KEY, a NOT NULL constraint.
</PARA> </PARA>
</LISTITEM> </LISTITEM>
<VARLISTENTRY> </varlistentry>
<TERM> <VARLISTENTRY>
CHECK ( <replaceable class="parameter">constraint</replaceable> ) <TERM>
</TERM> CHECK ( <replaceable class="parameter">constraint</replaceable> )
<LISTITEM> </TERM>
<PARA> <LISTITEM>
A boolean expression to be evaluated as the constraint. <PARA>
</PARA> A boolean expression to be evaluated as the constraint.
</LISTITEM> </PARA>
</VARLISTENTRY> </LISTITEM>
</VARIABLELIST> </VARLISTENTRY>
</VARIABLELIST>
</para>
</refsect2>
<REFSECT2 ID="R2-SQL-TABLECONSTRAINT-2"> <REFSECT2 ID="R2-SQL-TABLECONSTRAINT-2">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-09-11</DATE> <DATE>1998-09-11</DATE>
</REFSECT2INFO> </REFSECT2INFO>
<title> <title>
Outputs Outputs
</title> </title>
<para> <para>
The possible outputs for the table constraint clause are the same The possible outputs for the table constraint clause are the same
as for the corresponding portions of the column constraint clause. as for the corresponding portions of the column constraint clause.
</para>
</refsect2>
<REFSECT2 ID="R2-SQL-TABLECONSTRAINT-3"> <REFSECT2 ID="R2-SQL-TABLECONSTRAINT-3">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-09-11</DATE> <DATE>1998-09-11</DATE>
</REFSECT2INFO> </REFSECT2INFO>
<title> <title>
Description Description
</title> </title>
<para> <para>
A table constraint is an integrity constraint defined on one or A table constraint is an integrity constraint defined on one or
more columns of a base table. The four variations of "Table more columns of a base table. The four variations of "Table
...@@ -1000,14 +1046,15 @@ Description ...@@ -1000,14 +1046,15 @@ Description
<note> <note>
<para> <para>
<productname>Postgres</productname> does not yet <productname>Postgres</productname> does not yet
(as of version 6.4) support FOREIGN KEY (as of version 6.4) support FOREIGN KEY
integrity constraints. The parser understands the FOREIGN KEY syntax, integrity constraints. The parser understands the FOREIGN KEY syntax,
but only prints a notice and otherwise ignores the clause. but only prints a notice and otherwise ignores the clause.
Foreign keys may be partially emulated by triggers (See the CREATE TRIGGER Foreign keys may be partially emulated by triggers (See the CREATE TRIGGER
statement). statement).
</para> </para>
</note> </note>
</refsect2>
<REFSECT2 ID="R2-SQL-UNIQUECLAUSE-4"> <REFSECT2 ID="R2-SQL-UNIQUECLAUSE-4">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-09-11</DATE> <DATE>1998-09-11</DATE>
...@@ -1016,15 +1063,16 @@ but only prints a notice and otherwise ignores the clause. ...@@ -1016,15 +1063,16 @@ but only prints a notice and otherwise ignores the clause.
UNIQUE Constraint UNIQUE Constraint
</TITLE> </TITLE>
<para> <para>
<synopsis> <synopsis>
[ CONSTRAINT <replaceable class="parameter">name</replaceable> ] UNIQUE ( <replaceable class="parameter">column</replaceable> [, ...] ) [ CONSTRAINT <replaceable class="parameter">name</replaceable> ] UNIQUE ( <replaceable class="parameter">column</replaceable> [, ...] )
</SYNOPSIS> </SYNOPSIS>
</para>
<refsect3> <refsect3>
<title>Inputs</title> <title>Inputs</title>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>
CONSTRAINT <replaceable class="parameter">name</replaceable> CONSTRAINT <replaceable class="parameter">name</replaceable>
</term> </term>
<listitem> <listitem>
<para> <para>
...@@ -1044,64 +1092,69 @@ but only prints a notice and otherwise ignores the clause. ...@@ -1044,64 +1092,69 @@ but only prints a notice and otherwise ignores the clause.
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</refsect3> </refsect3>
<refsect3> <refsect3>
<title>Outputs</title> <title>Outputs</title>
<PARA> <PARA>
<VARIABLELIST> <VARIABLELIST>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<replaceable>status</replaceable> <replaceable>status</replaceable>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
<VARIABLELIST> <VARIABLELIST>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
ERROR: Cannot insert a duplicate key into a unique index. ERROR: Cannot insert a duplicate key into a unique index.
</term> </term>
<listitem> <listitem>
<para> <para>
This error occurs at runtime if one tries to insert a This error occurs at runtime if one tries to insert a
duplicate value into a column. duplicate value into a column.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</listitem> </para>
</varlistentry> </listitem>
</variablelist> </varlistentry>
</variablelist>
</para>
</refsect3> </refsect3>
<refsect3> <refsect3>
<title> <title>
Description Description
</title> </title>
<PARA> <PARA>
The UNIQUE constraint specifies a rule that a group of one or The UNIQUE constraint specifies a rule that a group of one or
more distinct columns of a table may contain only unique values. more distinct columns of a table may contain only unique values.
The behavior of the UNIQUE table constraint is the same as that for column The behavior of the UNIQUE table constraint is the same as that for column
constraints, with the additional capability to span multiple columns. constraints, with the additional capability to span multiple columns.
</para> </para>
<para> <para>
See the section on the UNIQUE column constraint for more details. See the section on the UNIQUE column constraint for more details.
</para>
<REFSECT3 ID="R3-SQL-UNIQUECLAUSE-4"> </refsect3>
<TITLE>
Usage
</title>
<PARA>
Define a UNIQUE table constraint for the table distributors:
<ProgramListing>
CREATE TABLE distributors (
did DECIMAL(03),
name VARCHAR(40),
UNIQUE(name)
);
</ProgramListing>
<REFSECT3 ID="R3-SQL-UNIQUECLAUSE-4">
<TITLE>
Usage
</title>
<PARA>
Define a UNIQUE table constraint for the table distributors:
<ProgramListing>
CREATE TABLE distributors (
did DECIMAL(03),
name VARCHAR(40),
UNIQUE(name)
);
</ProgramListing>
</para>
</refsect3>
</REFSECT2> </REFSECT2>
<REFSECT2 ID="R2-SQL-PRIMARYKEY-4"> <REFSECT2 ID="R2-SQL-PRIMARYKEY-4">
...@@ -1111,18 +1164,18 @@ CREATE TABLE distributors ( ...@@ -1111,18 +1164,18 @@ CREATE TABLE distributors (
<TITLE> <TITLE>
PRIMARY KEY Constraint PRIMARY KEY Constraint
</TITLE> </TITLE>
<para> <para>
<SYNOPSIS> <SYNOPSIS>
[ CONSTRAINT <REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE> ] PRIMARY KEY ( <REPLACEABLE CLASS="PARAMETER">column</REPLACEABLE> [, ...] ) [ CONSTRAINT <REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE> ] PRIMARY KEY ( <REPLACEABLE CLASS="PARAMETER">column</REPLACEABLE> [, ...] )
</SYNOPSIS> </SYNOPSIS>
</para>
<refsect3> <refsect3>
<title>Inputs</title> <title>Inputs</title>
<PARA> <PARA>
<VARIABLELIST> <VARIABLELIST>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
CONSTRAINT <ReturnValue><REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE></ReturnValue> CONSTRAINT <ReturnValue><REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE></ReturnValue>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
...@@ -1132,7 +1185,7 @@ CONSTRAINT <ReturnValue><REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE></Retur ...@@ -1132,7 +1185,7 @@ CONSTRAINT <ReturnValue><REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE></Retur
</VARLISTENTRY> </VARLISTENTRY>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<REPLACEABLE CLASS="PARAMETER">column</REPLACEABLE> [, ...] <REPLACEABLE CLASS="PARAMETER">column</REPLACEABLE> [, ...]
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
...@@ -1143,32 +1196,33 @@ CONSTRAINT <ReturnValue><REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE></Retur ...@@ -1143,32 +1196,33 @@ CONSTRAINT <ReturnValue><REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE></Retur
</VARIABLELIST> </VARIABLELIST>
</para> </para>
</refsect3> </refsect3>
<refsect3> <refsect3>
<title>Outputs</title> <title>Outputs</title>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>
<replaceable>status</replaceable> <replaceable>status</replaceable>
</term> </term>
<listitem>
<para>
<variablelist>
<varlistentry>
<term>ERROR: Cannot insert a duplicate key into a unique index.</term>
<listitem> <listitem>
<para> <para>
This occurs at run-time if one tries to insert a duplicate value into <variablelist>
a column subject to a PRIMARY KEY constraint. <varlistentry>
</PARA> <term>ERROR: Cannot insert a duplicate key into a unique index.</term>
</listitem> <listitem>
</varlistentry> <para>
</variablelist> This occurs at run-time if one tries to insert a duplicate value into
a column subject to a PRIMARY KEY constraint.
</PARA>
</listitem>
</varlistentry>
</variablelist>
</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</refsect3> </refsect3>
<refsect3> <refsect3>
<title>Description</title> <title>Description</title>
<PARA> <PARA>
...@@ -1177,17 +1231,18 @@ CONSTRAINT <ReturnValue><REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE></Retur ...@@ -1177,17 +1231,18 @@ CONSTRAINT <ReturnValue><REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE></Retur
(non duplicate), non-null values. The column definitions of (non duplicate), non-null values. The column definitions of
the specified columns do not have to include a NOT NULL the specified columns do not have to include a NOT NULL
constraint to be included in a PRIMARY KEY constraint. constraint to be included in a PRIMARY KEY constraint.
The PRIMARY KEY table constraint is similar to that for column constraints, The PRIMARY KEY table constraint is similar to that for column constraints,
with the additional capability of encompassing multiple columns. with the additional capability of encompassing multiple columns.
</PARA> </PARA>
<PARA> <PARA>
Refer to the section on the PRIMARY KEY column constraint for more Refer to the section on the PRIMARY KEY column constraint for more
information. information.
</para>
</REFSECT3> </REFSECT3>
</REFSECT2> </REFSECT2>
</refsect1> </refsect1>
<REFSECT1 ID="R1-SQL-CREATETABLE-2"> <REFSECT1 ID="R1-SQL-CREATETABLE-2">
...@@ -1306,7 +1361,7 @@ information. ...@@ -1306,7 +1361,7 @@ information.
</TITLE> </TITLE>
<PARA> <PARA>
CREATE TABLE/INHERITS is a <productname>Postgres</productname> CREATE TABLE/INHERITS is a <productname>Postgres</productname>
language extension. language extension.
</PARA> </PARA>
</refsect2> </refsect2>
...@@ -1316,7 +1371,6 @@ information. ...@@ -1316,7 +1371,6 @@ information.
<TITLE> <TITLE>
Compatibility Compatibility
</TITLE> </TITLE>
<PARA>
<REFSECT2 ID="R2-SQL-CREATETABLE-4"> <REFSECT2 ID="R2-SQL-CREATETABLE-4">
<REFSECT2INFO> <REFSECT2INFO>
...@@ -1357,15 +1411,17 @@ information. ...@@ -1357,15 +1411,17 @@ information.
) ON COMMIT DELETE ROWS ) ON COMMIT DELETE ROWS
</programlisting> </programlisting>
<para> <para>
Temporary tables are not currently available Temporary tables are not currently available
in <productname>Postgres</productname>. in <productname>Postgres</productname>.
<tip> <tip>
<para> <para>
In the current release of <productname>Postgres</productname> In the current release of <productname>Postgres</productname>
(v6.4), to create a temporary (v6.4), to create a temporary
table you must create and drop the table by explicit commands. table you must create and drop the table by explicit commands.
</tip> </para>
</tip>
</para>
<REFSECT3 ID="R3-SQL-UNIQUECLAUSE-1"> <REFSECT3 ID="R3-SQL-UNIQUECLAUSE-1">
<REFSECT3INFO> <REFSECT3INFO>
<DATE>1998-09-11</DATE> <DATE>1998-09-11</DATE>
...@@ -1375,6 +1431,7 @@ Temporary tables are not currently available ...@@ -1375,6 +1431,7 @@ Temporary tables are not currently available
</TITLE> </TITLE>
<PARA> <PARA>
SQL92 specifies some additional capabilities for UNIQUE: SQL92 specifies some additional capabilities for UNIQUE:
</para>
<para> <para>
Table Constraint definition Table Constraint definition
</PARA> </PARA>
...@@ -1395,6 +1452,23 @@ Temporary tables are not currently available ...@@ -1395,6 +1452,23 @@ Temporary tables are not currently available
</synopsis> </synopsis>
</refsect3> </refsect3>
<REFSECT3 ID="R3-SQL-NULL-1">
<REFSECT3INFO>
<DATE>1998-12-24</DATE>
</REFSECT3INFO>
<TITLE>
NULL clause
</TITLE>
<PARA>
The NULL "constraint" (actually a non-constraint)
is a <productname>Postgres</productname> extension to SQL92
is included for symmetry with the NOT NULL clause. Since it is the default
for any column, its presence is simply noise.
<synopsis>
[ CONSTRAINT name ] NULL
</synopsis>
</REFSECT3>
<REFSECT3 ID="R3-SQL-NOTNULL-4"> <REFSECT3 ID="R3-SQL-NOTNULL-4">
<REFSECT3INFO> <REFSECT3INFO>
<DATE>1998-09-11</DATE> <DATE>1998-09-11</DATE>
...@@ -1407,9 +1481,9 @@ Temporary tables are not currently available ...@@ -1407,9 +1481,9 @@ Temporary tables are not currently available
SQL92 specifies some additional capabilities for NOT NULL: SQL92 specifies some additional capabilities for NOT NULL:
</PARA> </PARA>
<synopsis> <synopsis>
[ CONSTRAINT name ] NOT NULL [ CONSTRAINT name ] NOT NULL
[ {INITIALLY DEFERRED | INITIALLY IMMEDIATE} ] [ {INITIALLY DEFERRED | INITIALLY IMMEDIATE} ]
[ [ NOT ] DEFERRABLE ] [ [ NOT ] DEFERRABLE ]
</synopsis> </synopsis>
</REFSECT3> </REFSECT3>
...@@ -1450,13 +1524,13 @@ the column. Not our problem... ...@@ -1450,13 +1524,13 @@ the column. Not our problem...
<PARA> <PARA>
SQL92 specifies some additional capabilities for constraints, SQL92 specifies some additional capabilities for constraints,
and also defines assertions and domain constraints. and also defines assertions and domain constraints.
<note> <note>
<para> <para>
<productname>Postgres</productname> does not yet support <productname>Postgres</productname> does not yet support
either domains or assertions. either domains or assertions.
</para>
</note>
</para> </para>
</note>
<PARA> <PARA>
An assertion is a special type of integrity constraint and share An assertion is a special type of integrity constraint and share
the same namespace as other constraints. the same namespace as other constraints.
...@@ -1672,7 +1746,7 @@ affect a column or a table. ...@@ -1672,7 +1746,7 @@ affect a column or a table.
<REFPURPOSE> <REFPURPOSE>
Creates a new table Creates a new table
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-22</DATE> <DATE>1998-09-22</DATE>
...@@ -1722,10 +1796,12 @@ a comma-delimited list of column names. ...@@ -1722,10 +1796,12 @@ a comma-delimited list of column names.
<PARA> <PARA>
A valid query statement. Refer to SELECT for a description of the A valid query statement. Refer to SELECT for a description of the
allowed syntax. allowed syntax.
</PARA> </PARA>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
</VARIABLELIST> </VARIABLELIST>
</para>
</refsect2>
<REFSECT2 ID="R2-SQL-CREATETABLEAS-2"> <REFSECT2 ID="R2-SQL-CREATETABLEAS-2">
<REFSECT2INFO> <REFSECT2INFO>
...@@ -1735,22 +1811,25 @@ allowed syntax. ...@@ -1735,22 +1811,25 @@ allowed syntax.
Outputs Outputs
</TITLE> </TITLE>
<PARA> <PARA>
Refer to CREATE TABLE and SELECT for a summary of possible output Refer to CREATE TABLE and SELECT for a summary of possible output
messages. messages.
</para>
<REFSECT1 ID="R1-SQL-CREATETABLEAS-1"> </refsect2>
<REFSECT1INFO> </refsynopsisdiv>
<DATE>1998-09-22</DATE>
</REFSECT1INFO> <REFSECT1 ID="R1-SQL-CREATETABLEAS-1">
<TITLE> <REFSECT1INFO>
Description <DATE>1998-09-22</DATE>
</TITLE> </REFSECT1INFO>
<TITLE>
Description
</TITLE>
<PARA> <PARA>
CREATE TABLE AS enables a table to be created from the contents of CREATE TABLE AS enables a table to be created from the contents of
an existing table. It has functionality equivalent to SELECT TABLE INTO, an existing table. It has functionality equivalent to SELECT TABLE INTO,
but with perhaps a more obvious syntax. but with perhaps a more obvious syntax.
</para>
</refsect1> </refsect1>
</refentry> </refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
......
doc/src/sgml/ref/create_trigger.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ ...@@ -12,6 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Creates a new trigger Creates a new trigger
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-21</DATE> <DATE>1998-09-21</DATE>
...@@ -92,8 +93,11 @@ CREATE TRIGGER <REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE> { BEFORE | AFTE ...@@ -92,8 +93,11 @@ CREATE TRIGGER <REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE> { BEFORE | AFTE
<LISTITEM> <LISTITEM>
<PARA> <PARA>
This message is returned if the trigger is successfully created. This message is returned if the trigger is successfully created.
</para>
</VARIABLELIST> </listitem>
</varlistentry>
</VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
...@@ -147,31 +151,31 @@ CREATE TRIGGER <REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE> { BEFORE | AFTE ...@@ -147,31 +151,31 @@ CREATE TRIGGER <REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE> { BEFORE | AFTE
<PARA> <PARA>
Refer to <command>DROP TRIGGER</command> for information on how to Refer to <command>DROP TRIGGER</command> for information on how to
remove triggers. remove triggers.
</PARA> </PARA>
</REFSECT2> </REFSECT2>
</refsect1>
<REFSECT1 ID="R1-SQL-CREATETRIGGER-2"> <REFSECT1 ID="R1-SQL-CREATETRIGGER-2">
<TITLE> <TITLE>
Usage Usage
</TITLE> </TITLE>
<PARA> <PARA>
Check if the specified distributor code exists in the distributors Check if the specified distributor code exists in the distributors
table before appending or updating a row in the table films: table before appending or updating a row in the table films:
</PARA> </PARA>
<ProgramListing> <ProgramListing>
CREATE TRIGGER if_dist_exists CREATE TRIGGER if_dist_exists
BEFORE INSERT OR UPDATE ON films FOR EACH ROW BEFORE INSERT OR UPDATE ON films FOR EACH ROW
EXECUTE PROCEDURE check_primary_key ('did', 'distributors', 'did'); EXECUTE PROCEDURE check_primary_key ('did', 'distributors', 'did');
</ProgramListing> </ProgramListing>
<PARA> <PARA>
Before cancelling a distributor or updating its code, remove every Before cancelling a distributor or updating its code, remove every
reference to the table films: reference to the table films:
</PARA> </PARA>
<ProgramListing> <ProgramListing>
CREATE TRIGGER if_film_exists CREATE TRIGGER if_film_exists
BEFORE DELETE OR UPDATE ON distributors FOR EACH ROW BEFORE DELETE OR UPDATE ON distributors FOR EACH ROW
EXECUTE PROCEDURE check_foreign_key (1, 'CASCADE', 'did', 'films', 'did'); EXECUTE PROCEDURE check_foreign_key (1, 'CASCADE', 'did', 'films', 'did');
</ProgramListing> </ProgramListing>
</REFSECT1> </REFSECT1>
...@@ -190,25 +194,27 @@ CREATE TRIGGER if_film_exists ...@@ -190,25 +194,27 @@ CREATE TRIGGER if_film_exists
SQL92 SQL92
</TITLE> </TITLE>
<PARA> <PARA>
There is no <command>CREATE TRIGGER</command> in <acronym>SQL92</acronym>. There is no <command>CREATE TRIGGER</command> in <acronym>SQL92</acronym>.
</PARA> </PARA>
<PARA> <PARA>
The second example above may also be done by using a FOREIGN KEY The second example above may also be done by using a FOREIGN KEY
constraint as in: constraint as in:
</PARA> </PARA>
<ProgramListing> <ProgramListing>
CREATE TABLE distributors ( CREATE TABLE distributors (
did DECIMAL(3), did DECIMAL(3),
name VARCHAR(40), name VARCHAR(40),
CONSTRAINT if_film_exists CONSTRAINT if_film_exists
FOREIGN KEY(did) REFERENCES films FOREIGN KEY(did) REFERENCES films
ON UPDATE CASCADE ON DELETE CASCADE ON UPDATE CASCADE ON DELETE CASCADE
); );
</ProgramListing> </ProgramListing>
<PARA> <PARA>
However, foreign keys are not yet implemented (as of version 6.4) in However, foreign keys are not yet implemented (as of version 6.4) in
<productname>Postgres</productname>. <productname>Postgres</productname>.
</PARA> </PARA>
</refsect2>
</refsect1>
</REFENTRY> </REFENTRY>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
......
doc/src/sgml/ref/create_type.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ ...@@ -12,6 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Defines a new base data type Defines a new base data type
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-21</DATE> <DATE>1998-09-21</DATE>
...@@ -175,9 +176,11 @@ EXTERNALLENGTH <replaceable class="parameter">externallength</replaceable> ...@@ -175,9 +176,11 @@ EXTERNALLENGTH <replaceable class="parameter">externallength</replaceable>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
Message returned if the type is successfully created. Message returned if the type is successfully created.
</para>
</listitem>
</varlistentry>
</VARIABLELIST> </VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
...@@ -290,11 +293,13 @@ it with the fact that the data is not present></comment> ...@@ -290,11 +293,13 @@ it with the fact that the data is not present></comment>
length. If you need a larger type you must create a Large length. If you need a larger type you must create a Large
Object type. The interface for these types is discussed Object type. The interface for these types is discussed
at length in at length in
<comment>This section reference needs replacing</comment> <comment>This section reference needs replacing</comment>
Section 7, the large object interface. The Section 7, the large object interface. The
length of all large object types is always VARIABLE. length of all large object types is always VARIABLE.
</para>
</refsect2> </refsect2>
</refsect1> </refsect1>
<refsect1> <refsect1>
<title>Examples</title> <title>Examples</title>
<para> <para>
...@@ -302,10 +307,10 @@ it with the fact that the data is not present></comment> ...@@ -302,10 +307,10 @@ it with the fact that the data is not present></comment>
type in a class definition: type in a class definition:
</para> </para>
<programlisting> <programlisting>
CREATE TYPE box (INTERNALLENGTH = 8, CREATE TYPE box (INTERNALLENGTH = 8,
INPUT = my_procedure_1, OUTPUT = my_procedure_2) INPUT = my_procedure_1, OUTPUT = my_procedure_2)
CREATE TABLE myboxes (id INT4, description box) CREATE TABLE myboxes (id INT4, description box)
</programlisting> </programlisting>
<para> <para>
This command creates a variable length array type with This command creates a variable length array type with
...@@ -339,6 +344,7 @@ it with the fact that the data is not present></comment> ...@@ -339,6 +344,7 @@ it with the fact that the data is not present></comment>
with an underscore. with an underscore.
</para> </para>
</refsect2> </refsect2>
<REFSECT2 ID="R2-SQL-CREATETYPE-3"> <REFSECT2 ID="R2-SQL-CREATETYPE-3">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-09-21</DATE> <DATE>1998-09-21</DATE>
...@@ -351,9 +357,9 @@ it with the fact that the data is not present></comment> ...@@ -351,9 +357,9 @@ it with the fact that the data is not present></comment>
</PARA> </PARA>
<PARA> <PARA>
See also <command>CREATE FUNCTION</command>, See also <command>CREATE FUNCTION</command>,
<command>CREATE OPERATOR</command> and the chapter on Large Objects <command>CREATE OPERATOR</command> and the chapter on Large Objects
in the <citetitle>PostgreSQL Programmer's Guide</citetitle>. in the <citetitle>PostgreSQL Programmer's Guide</citetitle>.
</para> </para>
</REFSECT2> </REFSECT2>
</refsect1> </refsect1>
...@@ -362,7 +368,6 @@ in the <citetitle>PostgreSQL Programmer's Guide</citetitle>. ...@@ -362,7 +368,6 @@ in the <citetitle>PostgreSQL Programmer's Guide</citetitle>.
<TITLE> <TITLE>
Compatibility Compatibility
</TITLE> </TITLE>
<PARA>
<REFSECT2 ID="R2-SQL-CREATETYPE-4"> <REFSECT2 ID="R2-SQL-CREATETYPE-4">
<REFSECT2INFO> <REFSECT2INFO>
...@@ -375,7 +380,8 @@ in the <citetitle>PostgreSQL Programmer's Guide</citetitle>. ...@@ -375,7 +380,8 @@ in the <citetitle>PostgreSQL Programmer's Guide</citetitle>.
<command>CREATE TYPE</command> is an <acronym>SQL3</acronym> statement. <command>CREATE TYPE</command> is an <acronym>SQL3</acronym> statement.
</PARA> </PARA>
</REFSECT2> </REFSECT2>
</refsect1>
</REFENTRY> </REFENTRY>
......
doc/src/sgml/ref/create_user.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ ...@@ -12,6 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Creates account information for a new user Creates account information for a new user
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-21</DATE> <DATE>1998-09-21</DATE>
...@@ -126,10 +127,11 @@ CREATE USER<REPLACEABLE CLASS="PARAMETER"> username</REPLACEABLE> ...@@ -126,10 +127,11 @@ CREATE USER<REPLACEABLE CLASS="PARAMETER"> username</REPLACEABLE>
a NULL value is stored in "<filename>pg_shadow</filename>" a NULL value is stored in "<filename>pg_shadow</filename>"
for this attribute, for this attribute,
and the login will be valid for all time. and the login will be valid for all time.
</PARA> </PARA>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
</variablelist> </variablelist>
</para>
</REFSECT2> </REFSECT2>
<REFSECT2 ID="R2-SQL-CREATEUSER-2"> <REFSECT2 ID="R2-SQL-CREATEUSER-2">
...@@ -151,17 +153,19 @@ CREATE USER<REPLACEABLE CLASS="PARAMETER"> username</REPLACEABLE> ...@@ -151,17 +153,19 @@ CREATE USER<REPLACEABLE CLASS="PARAMETER"> username</REPLACEABLE>
Message returned if the command completes successfully. Message returned if the command completes successfully.
</PARA> </PARA>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<ReturnValue>ERROR: removeUser: user "<replaceable class="parameter">username</replaceable>" does not exist</ReturnValue> <ReturnValue>ERROR: removeUser: user "<replaceable class="parameter">username</replaceable>" does not exist</ReturnValue>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
if "<replaceable class="parameter">username</replaceable>" not found. if "<replaceable class="parameter">username</replaceable>" not found.
</PARA> </PARA>
<comment>I don't understand this and I don't know how to get <comment>I don't understand this and I don't know how to get
this error message.</comment> this error message.</comment>
</listitem>
</varlistentry>
</VARIABLELIST> </VARIABLELIST>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
...@@ -226,6 +230,7 @@ this error message.</comment> ...@@ -226,6 +230,7 @@ this error message.</comment>
+--------------------------+--------------------------+-------+ +--------------------------+--------------------------+-------+
</programlisting> </programlisting>
</REFSECT2> </REFSECT2>
</refsect1>
<REFSECT1 ID="R1-SQL-CREATEUSER-2"> <REFSECT1 ID="R1-SQL-CREATEUSER-2">
<TITLE> <TITLE>
...@@ -275,8 +280,10 @@ this error message.</comment> ...@@ -275,8 +280,10 @@ this error message.</comment>
SQL92 SQL92
</TITLE> </TITLE>
<PARA> <PARA>
There is no CREATE USER statement in SQL92. There is no CREATE USER statement in SQL92.
</PARA> </PARA>
</refsect2>
</refsect1>
</REFENTRY> </REFENTRY>
......
doc/src/sgml/ref/create_view.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ ...@@ -12,6 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Constructs a virtual table Constructs a virtual table
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-21</DATE> <DATE>1998-09-21</DATE>
...@@ -55,6 +56,7 @@ An SQL query which will provide the columns and rows of the view. ...@@ -55,6 +56,7 @@ An SQL query which will provide the columns and rows of the view.
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
</variablelist> </variablelist>
</para>
</REFSECT2> </REFSECT2>
<REFSECT2 ID="R2-SQL-CREATEVIEW-2"> <REFSECT2 ID="R2-SQL-CREATEVIEW-2">
...@@ -104,8 +106,11 @@ An SQL query which will provide the columns and rows of the view. ...@@ -104,8 +106,11 @@ An SQL query which will provide the columns and rows of the view.
<programlisting> <programlisting>
CREATE VIEW vista AS SELECT 'Hello World'::text CREATE VIEW vista AS SELECT 'Hello World'::text
</programlisting> </programlisting>
</para>
</VARIABLELIST> </listitem>
</varlistentry>
</VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
...@@ -146,7 +151,8 @@ An SQL query which will provide the columns and rows of the view. ...@@ -146,7 +151,8 @@ An SQL query which will provide the columns and rows of the view.
Currently, views are read only. Currently, views are read only.
</para> </para>
</REFSECT2> </REFSECT2>
</refsect1>
<REFSECT1 ID="R1-SQL-CREATEVIEW-2"> <REFSECT1 ID="R1-SQL-CREATEVIEW-2">
<TITLE> <TITLE>
Usage Usage
......
doc/src/sgml/ref/createdb.sgml
View file @ a75f2d21
<REFENTRY ID="APP-CREATEDB"> <REFENTRY ID="APP-CREATEDB">
<REFMETA> <REFMETA>
<REFENTRYTITLE> <REFENTRYTITLE>
<application>createdb</application> <application>createdb</application>
</REFENTRYTITLE> </REFENTRYTITLE>
<REFMISCINFO>Application</REFMISCINFO> <REFMISCINFO>Application</REFMISCINFO>
</REFMETA> </REFMETA>
<REFNAMEDIV> <REFNAMEDIV>
<REFNAME> <REFNAME>
<application>createdb</application> <application>createdb</application>
</REFNAME> </REFNAME>
<REFPURPOSE> <REFPURPOSE>
Create a new <productname>Postgres</productname> database Create a new <productname>Postgres</productname> database
</REFPURPOSE> </REFPURPOSE>
<REFSYNOPSISDIV> </refnamediv>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIV>
<DATE>1998-10-02</DATE> <REFSYNOPSISDIVINFO>
</REFSYNOPSISDIVINFO> <DATE>1998-10-02</DATE>
<SYNOPSIS> </REFSYNOPSISDIVINFO>
createdb [ <replaceable class="parameter">dbname</replaceable> ] <SYNOPSIS>
createdb [ -h <replaceable class="parameter">host</replaceable> ] [ -p <replaceable class="parameter">port</replaceable> ] createdb [ <replaceable class="parameter">dbname</replaceable> ]
[ -D <replaceable class="parameter">datadir</replaceable> ] createdb [ -h <replaceable class="parameter">host</replaceable> ] [ -p <replaceable class="parameter">port</replaceable> ]
[ -u ] [ <replaceable class="parameter">dbname</replaceable> ] [ -D <replaceable class="parameter">datadir</replaceable> ]
</SYNOPSIS> [ -u ] [ <replaceable class="parameter">dbname</replaceable> ]
</SYNOPSIS>
<REFSECT2 ID="R2-APP-CREATEDB-1">
<REFSECT2INFO> <REFSECT2 ID="R2-APP-CREATEDB-1">
<DATE>1998-10-02</DATE> <REFSECT2INFO>
</REFSECT2INFO> <DATE>1998-10-02</DATE>
<TITLE> </REFSECT2INFO>
Inputs <TITLE>
</TITLE> Inputs
<PARA> </TITLE>
<PARA>
<variablelist>
<varlistentry> <variablelist>
<term> <varlistentry>
-h <replaceable class="parameter">host</replaceable> <term>
</term> -h <replaceable class="parameter">host</replaceable>
<listitem> </term>
<para> <listitem>
Specifies the hostname of the machine on which the <para>
<application>postmaster</application> Specifies the hostname of the machine on which the
is running. Defaults to using a local Unix domain socket <application>postmaster</application>
rather than an IP connection.. is running. Defaults to using a local Unix domain socket
rather than an IP connection..
<varlistentry> </para>
<term> </listitem>
-p <replaceable class="parameter">port</replaceable> </varlistentry>
</term> <varlistentry>
<listitem> <term>
<para> -p <replaceable class="parameter">port</replaceable>
Specifies the Internet TCP/IP port or local Unix domain socket file </term>
extension on which the <application>postmaster</application> <listitem>
is listening for connections. The port number defaults to 5432, <para>
or the value of the <envar>PGPORT</envar> Specifies the Internet TCP/IP port or local Unix domain socket file
environment variable (if set). extension on which the <application>postmaster</application>
is listening for connections. The port number defaults to 5432,
<varlistentry> or the value of the <envar>PGPORT</envar>
<term> environment variable (if set).
-u </para>
</term> </listitem>
<listitem> </varlistentry>
<para>
Use password authentication. <varlistentry>
Prompts for <term>
<replaceable class="parameter">username</replaceable> -u
and <replaceable class="parameter">password</replaceable>. </term>
<listitem>
<varlistentry> <para>
<term> Use password authentication.
-D <replaceable class="parameter">datadir</replaceable> Prompts for
</term> <replaceable class="parameter">username</replaceable>
<listitem> and <replaceable class="parameter">password</replaceable>.
<para> </para>
Specifies the alternate database location for this database installation. </listitem>
This is the location of the installation system tables, not the location </varlistentry>
of this specific database, which may be different.
<varlistentry>
<varlistentry> <term>
<term> -D <replaceable class="parameter">datadir</replaceable>
<replaceable class="parameter">dbname</replaceable> </term>
</term> <listitem>
<listitem> <para>
<para> Specifies the alternate database location for this database installation.
Specifies the name of the database to be created. The name must be This is the location of the installation system tables, not the location
unique among all <productname>Postgres</productname> databases in this installation. of this specific database, which may be different.
<replaceable class="parameter">dbname</replaceable> </para>
defaults to the value of the </listitem>
<envar>USER</envar> </varlistentry>
environment variable.
<varlistentry>
</variablelist> <term>
<replaceable class="parameter">dbname</replaceable>
<REFSECT2 ID="R2-APP-CREATEDB-2"> </term>
<REFSECT2INFO> <listitem>
<DATE>1998-10-02</DATE> <para>
</REFSECT2INFO> Specifies the name of the database to be created. The name must be
<TITLE> unique among all <productname>Postgres</productname> databases in this installation.
Outputs <replaceable class="parameter">dbname</replaceable>
</TITLE> defaults to the value of the
<PARA> <envar>USER</envar>
<application>createdb</application> will create files in the environment variable.
<filename><envar>PGDATA</envar>/<replaceable class="parameter">dbname</replaceable>/</filename> </para>
data area for the new database. </listitem>
</varlistentry>
<variablelist>
<varlistentry> </variablelist>
<term> </para>
Connection to database 'template1' failed. </refsect2>
connectDB() failed: Is the postmaster running and accepting connections
at 'UNIX Socket' on port '<replaceable class="parameter">port</replaceable>'?
createdb: database creation failed on <replaceable class="parameter">dbname</replaceable>.
<listitem>
<para>
<application>createdb</application> could not attach to the
<application>postmaster</application>
process on the specified host and port. If you see this message,
ensure that the <application>postmaster</application>
is running on the proper host and that you have specified the proper
port. If your site uses an authentication system, ensure that you
have obtained the required authentication credentials.
<varlistentry>
<term>
Connection to database 'template1' failed.
FATAL 1: SetUserId: user '<replaceable class="parameter">username</replaceable>' is not in 'pg_shadow'
createdb: database creation failed on <replaceable class="parameter">dbname</replaceable>.
<listitem>
<para>
You do not have a valid entry in the relation <literal>pg_shadow</literal>
and and will not be allowed to access <productname>Postgres</productname>.
Contact your <productname>Postgres</productname> administrator.
<varlistentry>
<term>
ERROR: user '<replaceable class="parameter">username</replaceable>' is not allowed to create/destroy databases
createdb: database creation failed on <replaceable class="parameter">dbname</replaceable>.
<listitem>
<para>
You do not have permission to create new databases.
Contact your <productname>Postgres</productname> site administrator.
<varlistentry>
<term>
ERROR: createdb: database '<replaceable class="parameter">dbname</replaceable>' already exists.
createdb: database creation failed on <replaceable class="parameter">dbname</replaceable>.
<listitem>
<para>
The database already exists.
<varlistentry>
<term>
createdb: database creation failed on <replaceable class="parameter">dbname</replaceable>.
<listitem>
<para>
An internal error occurred in <application>psql</application>
or in the backend server. Ensure that your site administrator has
properly installed <productname>Postgres</productname>and initialized the site with
<application>initdb</application>.
</variablelist>
<note>
<para>
<application>createdb</application> internally runs
CREATE DATABASE from <application>psql</application>
while connected to the <literal>template1</literal> database.
</note>
<REFSECT1 ID="R1-APP-CREATEDB-1">
<REFSECT1INFO>
<DATE>1998-10-02</DATE>
</REFSECT1INFO>
<TITLE>
Description
</TITLE>
<PARA>
<application>createdb</application> creates a new
<productname>Postgres</productname> database.
The person who executes this command becomes
the database administrator, or <acronym>DBA</acronym>,
for this database and is the only
person, other than the <productname>Postgres</productname> super-user,
who can destroy it.
<para>
<application>createdb</application> is a shell script that invokes
<application>psql</application>.
Hence, a <application>postmaster</application>
process must be running on the database server host before
<application>createdb</application>
is executed. The
<envar>PGOPTION</envar>
and
<envar>PGREALM</envar>
environment variables will be passed on to
<application>psql</application>
and processed as described in <xref linkend="app-psql" endterm="psql-ref">.
<REFSECT1 ID="R1-APP-CREATEDB-2">
<REFSECT1INFO>
<DATE>1998-10-02</DATE>
</REFSECT1INFO>
<TITLE>
Usage
</TITLE>
<PARA>
To create the database <literal>demo</literal>
using the postmaster on the local host, port 5432:
<programlisting>
createdb demo
</programlisting>
To create the database <literal>demo</literal>
using the postmaster on host eden, port 5000:
<programlisting>
createdb -p 5000 -h eden demo
</programlisting>
<REFSECT2 ID="R2-APP-CREATEDB-2">
<REFSECT2INFO>
<DATE>1998-10-02</DATE>
</REFSECT2INFO>
<TITLE>
Outputs
</TITLE>
<PARA>
<application>createdb</application> will create files in the
<filename><envar>PGDATA</envar>/<replaceable class="parameter">dbname</replaceable>/</filename>
data area for the new database.
<variablelist>
<varlistentry>
<term>
Connection to database 'template1' failed.
connectDB() failed: Is the postmaster running and accepting connections
at 'UNIX Socket' on port '<replaceable class="parameter">port</replaceable>'?
createdb: database creation failed on <replaceable class="parameter">dbname</replaceable>.
</term>
<listitem>
<para>
<application>createdb</application> could not attach to the
<application>postmaster</application>
process on the specified host and port. If you see this message,
ensure that the <application>postmaster</application>
is running on the proper host and that you have specified the proper
port. If your site uses an authentication system, ensure that you
have obtained the required authentication credentials.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
Connection to database 'template1' failed.
FATAL 1: SetUserId: user '<replaceable class="parameter">username</replaceable>' is not in 'pg_shadow'
createdb: database creation failed on <replaceable class="parameter">dbname</replaceable>.
</term>
<listitem>
<para>
You do not have a valid entry in the relation <literal>pg_shadow</literal>
and and will not be allowed to access <productname>Postgres</productname>.
Contact your <productname>Postgres</productname> administrator.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
ERROR: user '<replaceable class="parameter">username</replaceable>' is not allowed to create/destroy databases
createdb: database creation failed on <replaceable class="parameter">dbname</replaceable>.
</term>
<listitem>
<para>
You do not have permission to create new databases.
Contact your <productname>Postgres</productname> site administrator.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
ERROR: createdb: database '<replaceable class="parameter">dbname</replaceable>' already exists.
createdb: database creation failed on <replaceable class="parameter">dbname</replaceable>.
</term>
<listitem>
<para>
The database already exists.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
createdb: database creation failed on <replaceable class="parameter">dbname</replaceable>.
</term>
<listitem>
<para>
An internal error occurred in <application>psql</application>
or in the backend server. Ensure that your site administrator has
properly installed <productname>Postgres</productname>and initialized the site with
<application>initdb</application>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<note>
<para>
<application>createdb</application> internally runs
CREATE DATABASE from <application>psql</application>
while connected to the <literal>template1</literal> database.
</para>
</note>
</refsect2>
</refsynopsisdiv>
<REFSECT1 ID="R1-APP-CREATEDB-1">
<REFSECT1INFO>
<DATE>1998-10-02</DATE>
</REFSECT1INFO>
<TITLE>
Description
</TITLE>
<PARA>
<application>createdb</application> creates a new
<productname>Postgres</productname> database.
The person who executes this command becomes
the database administrator, or <acronym>DBA</acronym>,
for this database and is the only
person, other than the <productname>Postgres</productname> super-user,
who can destroy it.
</para>
<para>
<application>createdb</application> is a shell script that invokes
<application>psql</application>.
Hence, a <application>postmaster</application>
process must be running on the database server host before
<application>createdb</application>
is executed. The
<envar>PGOPTION</envar>
and
<envar>PGREALM</envar>
environment variables will be passed on to
<application>psql</application>
and processed as described in <xref linkend="app-psql" endterm="psql-ref">.
</para>
</refsect1>
<REFSECT1 ID="R1-APP-CREATEDB-2">
<REFSECT1INFO>
<DATE>1998-10-02</DATE>
</REFSECT1INFO>
<TITLE>
Usage
</TITLE>
<PARA>
To create the database <literal>demo</literal>
using the postmaster on the local host, port 5432:
<programlisting>
createdb demo
</programlisting>
To create the database <literal>demo</literal>
using the postmaster on host eden, port 5000:
<programlisting>
createdb -p 5000 -h eden demo
</programlisting>
</para>
</refsect1>
</REFENTRY> </REFENTRY>
doc/src/sgml/ref/createuser.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ ...@@ -12,6 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Create a new <productname>Postgres</productname> user Create a new <productname>Postgres</productname> user
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-10-02</DATE> <DATE>1998-10-02</DATE>
...@@ -23,215 +24,267 @@ createuser [ -h <replaceable class="parameter">host</replaceable> ] [ -p <replac ...@@ -23,215 +24,267 @@ createuser [ -h <replaceable class="parameter">host</replaceable> ] [ -p <replac
[ -d | -D ] [ -u | -U ] [ <replaceable class="parameter">username</replaceable> ] [ -d | -D ] [ -u | -U ] [ <replaceable class="parameter">username</replaceable> ]
</SYNOPSIS> </SYNOPSIS>
<REFSECT2 ID="R2-APP-CREATEUSER-1"> <REFSECT2 ID="R2-APP-CREATEUSER-1">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-10-02</DATE> <DATE>1998-10-02</DATE>
</REFSECT2INFO> </REFSECT2INFO>
<TITLE> <TITLE>
Inputs Inputs
</TITLE> </TITLE>
<PARA> <PARA>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>
-h <replaceable class="parameter">host</replaceable> -h <replaceable class="parameter">host</replaceable>
</term> </term>
<listitem> <listitem>
<para> <para>
Specifies the hostname of the machine on which the Specifies the hostname of the machine on which the
<application>postmaster</application> <application>postmaster</application>
is running. Defaults to using a local Unix domain socket is running. Defaults to using a local Unix domain socket
rather than an IP connection.. rather than an IP connection..
</para>
<varlistentry> </listitem>
<term> </varlistentry>
-p <replaceable class="parameter">port</replaceable>
</term> <varlistentry>
<listitem> <term>
<para> -p <replaceable class="parameter">port</replaceable>
Specifies the Internet TCP/IP port or local Unix domain socket file </term>
extension on which the <application>postmaster</application> <listitem>
is listening for connections. The port number defaults to 5432, <para>
or the value of the <envar>PGPORT</envar> Specifies the Internet TCP/IP port or local Unix domain socket file
environment variable (if set). extension on which the <application>postmaster</application>
is listening for connections. The port number defaults to 5432,
<varlistentry> or the value of the <envar>PGPORT</envar>
<term> environment variable (if set).
-d </para>
</term> </listitem>
<listitem> </varlistentry>
<para>
Allows the user to create databases. <varlistentry>
<term>
<varlistentry> -d
<term> </term>
-D <listitem>
</term> <para>
<listitem> Allows the user to create databases.
<para> </para>
Forbids the user to create databases. </listitem>
</varlistentry>
<varlistentry>
<term> <varlistentry>
-i <replaceable class="parameter">userid</replaceable> <term>
</term> -D
<listitem> </term>
<para> <listitem>
Specifies the numeric identifier to be associated with this user. <para>
This identifier must be unique among all <productname>Postgres</productname> users, and is not required Forbids the user to create databases.
to match the operating system UID. </para>
You will be prompted for an identifier if none is specified on the command line, </listitem>
and it will suggest an identifier matching the UID. </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
-u -i <replaceable class="parameter">userid</replaceable>
</term> </term>
<listitem> <listitem>
<para> <para>
Allows the user to create other users. Specifies the numeric identifier to be associated with this user.
This identifier must be unique among all <productname>Postgres</productname> users, and is not required
<varlistentry> to match the operating system UID.
<term> You will be prompted for an identifier if none is specified on the command line,
-U and it will suggest an identifier matching the UID.
</term> </para>
<listitem> </listitem>
<para> </varlistentry>
Forbids the user to create other users.
<varlistentry>
<varlistentry> <term>
<term> -u
<replaceable class="parameter">username</replaceable> </term>
</term> <listitem>
<listitem> <para>
<para> Allows the user to create other users.
Specifies the name of the <productname>Postgres</productname> user to be created. </para>
This name must be unique among all <productname>Postgres</productname> users. </listitem>
You will be prompted for a name if none is specified on the command line. </varlistentry>
</variablelist> <varlistentry>
<term>
<REFSECT2 ID="R2-APP-CREATEUSER-2"> -U
<REFSECT2INFO> </term>
<DATE>1998-10-02</DATE> <listitem>
</REFSECT2INFO> <para>
<TITLE> Forbids the user to create other users.
Outputs </para>
</TITLE> </listitem>
<PARA> </varlistentry>
<application>createuser</application> will add an entry in the
<literal>pg_user</literal> or <literal>pg_shadow</literal> system table. <varlistentry>
<term>
<variablelist> <replaceable class="parameter">username</replaceable>
<varlistentry> </term>
<term> <listitem>
Connection to database 'template1' failed. <para>
connectDB() failed: Is the postmaster running and accepting connections Specifies the name of the <productname>Postgres</productname> user to be created.
at 'UNIX Socket' on port '<replaceable class="parameter">port</replaceable>'? This name must be unique among all <productname>Postgres</productname> users.
createuser: database access failed. You will be prompted for a name if none is specified on the command line.
<listitem> </para>
<para> </listitem>
<application>createuser</application> could not attach to the </varlistentry>
<application>postmaster</application>
process on the specified host and port. If you see this message, </variablelist>
ensure that the <application>postmaster</application> </para>
is running on the proper host and that you have specified the proper </refsect2>
port. If your site uses an authentication system, ensure that you
have obtained the required authentication credentials.
<varlistentry>
<term>
Connection to database 'template1' failed.
FATAL 1: SetUserId: user '<replaceable class="parameter">username</replaceable>' is not in 'pg_shadow'
createuser: database access failed.
<listitem>
<para>
You do not have a valid entry in the relation <literal>pg_shadow</literal>
and and will not be allowed to access <productname>Postgres</productname>. Contact your
<productname>Postgres</productname> administrator.
<varlistentry>
<term>
createuser: <replaceable class="parameter">username</replaceable> cannot create users.
<listitem>
<para>
You do not have permission to create new users; contact your
<productname>Postgres</productname> site administrator.
<varlistentry>
<term>
createuser: user "<replaceable class="parameter">username</replaceable>" already exists
<listitem>
<para>
The user to be added already has an entry in the <literal>pg_shadow</literal>
class.
<varlistentry>
<term>
database access failed
<listitem>
<para>
An internal error occurred in <application>psql</application>
or in the backend server. Ensure that your site administrator has
properly installed <productname>Postgres</productname>and initialized the site with
<application>initdb</application>.
</variablelist>
<note>
<para>
<application>createuser</application> internally runs
CREATE USER from <application>psql</application>
while connected to the <literal>template1</literal> database.
</note>
<REFSECT1 ID="R1-APP-CREATEUSER-1">
<REFSECT1INFO>
<DATE>1998-10-02</DATE>
</REFSECT1INFO>
<TITLE>
Description
</TITLE>
<PARA>
<application>createuser</application> creates a
new <productname>Postgres</productname> user.
Only users with <literal>usesuper</literal> set in
the <literal>pg_shadow</literal> class can create
new <productname>Postgres</productname> users. As shipped,
the user <literal>postgres</literal> can create users.
<para>
<application>createuser</application> is a shell script that invokes
<application>psql</application>.
Hence, a <application>postmaster</application>
process must be running on the database server host before
<application>createuser</application> is executed.
The
<envar>PGOPTION</envar>
and
<envar>PGREALM</envar>
environment variables will be passed on to
<application>psql</application>
and processed as described in <xref linkend="app-psql" endterm="psql-ref">.
Once invoked, <application>createuser</application>
will ask a series of questions to obtain parameters not specified on
the command line. The new user's database login name and a numeric
user identifier must be specified.
<note>
<para>
The <productname>Postgres</productname> user identifier
does not need to be the same as the user's Unix UID. However, typically
they are assigned to be the same.
</note>
<para>
You must also describe the privileges of the new user for security purposes.
Specifically, you will be asked whether the new user should be able to
act as <productname>Postgres</productname> super-user,
whether the new user may create new databases and whether the new user
is allowed to create other new users.
<REFSECT2 ID="R2-APP-CREATEUSER-2">
<REFSECT2INFO>
<DATE>1998-10-02</DATE>
</REFSECT2INFO>
<TITLE>
Outputs
</TITLE>
<PARA>
<application>createuser</application> will add an entry in the
<literal>pg_user</literal> or <literal>pg_shadow</literal> system table.
<variablelist>
<varlistentry>
<term>
Connection to database 'template1' failed.
connectDB() failed: Is the postmaster running and accepting connections
at 'UNIX Socket' on port '<replaceable class="parameter">port</replaceable>'?
createuser: database access failed.
</term>
<listitem>
<para>
<application>createuser</application> could not attach to the
<application>postmaster</application>
process on the specified host and port. If you see this message,
ensure that the <application>postmaster</application>
is running on the proper host and that you have specified the proper
port. If your site uses an authentication system, ensure that you
have obtained the required authentication credentials.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
Connection to database 'template1' failed.
FATAL 1: SetUserId: user '<replaceable class="parameter">username</replaceable>' is not in 'pg_shadow'
createuser: database access failed.
</term>
<listitem>
<para>
You do not have a valid entry in the relation <literal>pg_shadow</literal>
and and will not be allowed to access <productname>Postgres</productname>. Contact your
<productname>Postgres</productname> administrator.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
createuser: <replaceable class="parameter">username</replaceable> cannot create users.
</term>
<listitem>
<para>
You do not have permission to create new users; contact your
<productname>Postgres</productname> site administrator.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
createuser: user "<replaceable class="parameter">username</replaceable>" already exists
</term>
<listitem>
<para>
The user to be added already has an entry in the <literal>pg_shadow</literal>
class.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
database access failed
</term>
<listitem>
<para>
An internal error occurred in <application>psql</application>
or in the backend server. Ensure that your site administrator has
properly installed <productname>Postgres</productname>and initialized the site with
<application>initdb</application>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<note>
<para>
<application>createuser</application> internally runs
CREATE USER from <application>psql</application>
while connected to the <literal>template1</literal> database.
</para>
</note>
</refsect2>
</refsynopsisdiv>
<REFSECT1 ID="R1-APP-CREATEUSER-1">
<REFSECT1INFO>
<DATE>1998-10-02</DATE>
</REFSECT1INFO>
<TITLE>
Description
</TITLE>
<PARA>
<application>createuser</application> creates a
new <productname>Postgres</productname> user.
Only users with <literal>usesuper</literal> set in
the <literal>pg_shadow</literal> class can create
new <productname>Postgres</productname> users. As shipped,
the user <literal>postgres</literal> can create users.
</para>
<para>
<application>createuser</application> is a shell script that invokes
<application>psql</application>.
Hence, a <application>postmaster</application>
process must be running on the database server host before
<application>createuser</application> is executed.
The
<envar>PGOPTION</envar>
and
<envar>PGREALM</envar>
environment variables will be passed on to
<application>psql</application>
and processed as described in <xref linkend="app-psql" endterm="psql-ref">.
Once invoked, <application>createuser</application>
will ask a series of questions to obtain parameters not specified on
the command line. The new user's database login name and a numeric
user identifier must be specified.
</para>
<note>
<para>
The <productname>Postgres</productname> user identifier
does not need to be the same as the user's Unix UID. However, typically
they are assigned to be the same.
</para>
</note>
<para>
You must also describe the privileges of the new user for security purposes.
Specifically, you will be asked whether the new user should be able to
act as <productname>Postgres</productname> super-user,
whether the new user may create new databases and whether the new user
is allowed to create other new users.
</para>
</refsect1>
</REFENTRY> </REFENTRY>
doc/src/sgml/ref/declare.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ ...@@ -12,6 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Defines a cursor for table access Defines a cursor for table access
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-04</DATE> <DATE>1998-09-04</DATE>
...@@ -180,11 +181,11 @@ ERROR: Named portals may only be used in begin/end transaction blocks ...@@ -180,11 +181,11 @@ ERROR: Named portals may only be used in begin/end transaction blocks
<LISTITEM> <LISTITEM>
<PARA> <PARA>
This error occurs if the cursor is not declared within a transaction block. This error occurs if the cursor is not declared within a transaction block.
</PARA> </PARA>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
</VARIABLELIST>
</VARIABLELIST> </para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
...@@ -215,19 +216,20 @@ backend was built. Since ...@@ -215,19 +216,20 @@ backend was built. Since
BINARY cursors give you back the data in the native binary BINARY cursors give you back the data in the native binary
representation. So binary cursors will tend to be a representation. So binary cursors will tend to be a
little faster since they suffer less conversion overhead. little faster since they suffer less conversion overhead.
<para> </para>
<para>
As an example, if a query returns a value of one from an integer column, As an example, if a query returns a value of one from an integer column,
you would get a string of '1' with a default cursor you would get a string of '1' with a default cursor
whereas with a binary cursor you would get whereas with a binary cursor you would get
a 4-byte value equal to control-A ('^A'). a 4-byte value equal to control-A ('^A').
<caution>
<caution> <para>
<para> BINARY cursors should be used carefully. User applications such
BINARY cursors should be used carefully. User applications such as <application>psql</application> are not aware of binary cursors
as <application>psql</application> are not aware of binary cursors and expect data to come back in a text format.
and expect data to come back in a text format. </para>
</caution> </caution>
</para>
<PARA> <PARA>
However, string representation is architecture-neutral whereas binary However, string representation is architecture-neutral whereas binary
representation can differ between different machine architectures. representation can differ between different machine architectures.
...@@ -235,13 +237,14 @@ and expect data to come back in a text format. ...@@ -235,13 +237,14 @@ and expect data to come back in a text format.
representations (e.g. "big-endian" versus "little-endian"), representations (e.g. "big-endian" versus "little-endian"),
you will probably not want your data returned in you will probably not want your data returned in
binary format. binary format.
<tip> <tip>
<para> <para>
If you intend to display the data in If you intend to display the data in
ASCII, getting it back in ASCII will save you some ASCII, getting it back in ASCII will save you some
effort on the client side. effort on the client side.
</tip> </para>
</tip>
</PARA> </PARA>
<REFSECT2 ID="R2-SQL-DECLARE-3"> <REFSECT2 ID="R2-SQL-DECLARE-3">
...@@ -256,18 +259,19 @@ and expect data to come back in a text format. ...@@ -256,18 +259,19 @@ and expect data to come back in a text format.
</PARA> </PARA>
<PARA> <PARA>
<productname>Postgres</productname> <productname>Postgres</productname>
does not have an explicit <command>OPEN cursor</command> does not have an explicit <command>OPEN cursor</command>
statement; a cursor is considered to be open when it is declared. statement; a cursor is considered to be open when it is declared.
<note> <note>
<para> <para>
In <acronym>SQL92</acronym> cursors are only available in In <acronym>SQL92</acronym> cursors are only available in
embedded applications. <application>ecpg</application>, the embedded applications. <application>ecpg</application>, the
embedded SQL preprocessor for <productname>Postgres</productname>, embedded SQL preprocessor for <productname>Postgres</productname>,
supports the <acronym>SQL92</acronym> conventions, including those supports the <acronym>SQL92</acronym> conventions, including those
involving DECLARE and OPEN statements. involving DECLARE and OPEN statements.
</note> </para>
</note>
</PARA> </PARA>
</REFSECT2> </REFSECT2>
</refsect1> </refsect1>
...@@ -300,14 +304,16 @@ DECLARE liahona CURSOR ...@@ -300,14 +304,16 @@ DECLARE liahona CURSOR
SQL92 SQL92
</TITLE> </TITLE>
<PARA> <PARA>
<acronym>SQL92</acronym> allows cursors only in embedded <acronym>SQL</acronym> <acronym>SQL92</acronym> allows cursors only in embedded <acronym>SQL</acronym>
and in modules. <productname>Postgres</productname> permits cursors to be used and in modules. <productname>Postgres</productname> permits cursors to be used
interactively. interactively.
<acronym>SQL92</acronym> allows embedded or modular cursors to <acronym>SQL92</acronym> allows embedded or modular cursors to
update database information. update database information.
All <productname>Postgres</productname> cursors are readonly. All <productname>Postgres</productname> cursors are readonly.
The BINARY keyword is a <productname>Postgres</productname> extension. The BINARY keyword is a <productname>Postgres</productname> extension.
</para>
</refsect2>
</refsect1>
</REFENTRY> </REFENTRY>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
......
doc/src/sgml/ref/delete.sgml
View file @ a75f2d21
...@@ -13,7 +13,7 @@ ...@@ -13,7 +13,7 @@
Deletes rows from a table Deletes rows from a table
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-04-15</DATE> <DATE>1998-04-15</DATE>
...@@ -82,10 +82,13 @@ ...@@ -82,10 +82,13 @@
<PARA> <PARA>
If <replaceable class="parameter">count</replaceable> is 0, If <replaceable class="parameter">count</replaceable> is 0,
no rows were deleted. no rows were deleted.
</para>
</VARIABLELIST> </listitem>
</varlistentry>
</VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
<REFSECT1 ID="R1-SQL-DELETE-1"> <REFSECT1 ID="R1-SQL-DELETE-1">
<REFSECT1INFO> <REFSECT1INFO>
...@@ -118,7 +121,7 @@ ...@@ -118,7 +121,7 @@
Remove all films but musicals: Remove all films but musicals:
</PARA> </PARA>
<ProgramListing> <ProgramListing>
DELETE FROM films WHERE kind &lt;&gt; 'Musical'; DETETE FROM films WHERE kind &lt;&gt; 'Musical';
SELECT * FROM films; SELECT * FROM films;
...@@ -165,7 +168,7 @@ DELETE FROM <replaceable class="parameter">table</replaceable> WHERE CURRENT OF ...@@ -165,7 +168,7 @@ DELETE FROM <replaceable class="parameter">table</replaceable> WHERE CURRENT OF
</synopsis> </synopsis>
<para> <para>
where <replaceable class="parameter">cursor</replaceable> identifies an open cursor. Interactive cursors in <productname>Postgres</productname> are read-only. where <replaceable class="parameter">cursor</replaceable> identifies an open cursor. Interactive cursors in <productname>Postgres</productname> are read-only.
</para> </para>
</refsect2> </refsect2>
</refsect1> </refsect1>
</REFENTRY> </REFENTRY>
......
doc/src/sgml/ref/destroydb.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ ...@@ -12,6 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Create a new <productname>Postgres</productname> database Create a new <productname>Postgres</productname> database
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-10-02</DATE> <DATE>1998-10-02</DATE>
...@@ -22,203 +23,247 @@ destroydb [ -h <replaceable class="parameter">host</replaceable> ] [ -p <replace ...@@ -22,203 +23,247 @@ destroydb [ -h <replaceable class="parameter">host</replaceable> ] [ -p <replace
[ -i ] [ <replaceable class="parameter">dbname</replaceable> ] [ -i ] [ <replaceable class="parameter">dbname</replaceable> ]
</SYNOPSIS> </SYNOPSIS>
<REFSECT2 ID="R2-APP-DESTROYDB-1"> <REFSECT2 ID="R2-APP-DESTROYDB-1">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-10-02</DATE> <DATE>1998-10-02</DATE>
</REFSECT2INFO> </REFSECT2INFO>
<TITLE> <TITLE>
Inputs Inputs
</TITLE> </TITLE>
<PARA> <PARA>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>
-h <replaceable class="parameter">host</replaceable> -h <replaceable class="parameter">host</replaceable>
</term> </term>
<listitem> <listitem>
<para> <para>
Specifies the hostname of the machine on which the Specifies the hostname of the machine on which the
<application>postmaster</application> <application>postmaster</application>
is running. Defaults to using a local Unix domain socket is running. Defaults to using a local Unix domain socket
rather than an IP connection.. rather than an IP connection..
</para>
<varlistentry> </listitem>
<term> </varlistentry>
-p <replaceable class="parameter">port</replaceable>
</term> <varlistentry>
<listitem> <term>
<para> -p <replaceable class="parameter">port</replaceable>
Specifies the Internet TCP/IP port or local Unix domain socket file </term>
extension on which the <application>postmaster</application> <listitem>
is listening for connections. The port number defaults to 5432, <para>
or the value of the <envar>PGPORT</envar> Specifies the Internet TCP/IP port or local Unix domain socket file
environment variable (if set). extension on which the <application>postmaster</application>
is listening for connections. The port number defaults to 5432,
<varlistentry> or the value of the <envar>PGPORT</envar>
<term> environment variable (if set).
-i </para>
</term> </listitem>
<listitem> </varlistentry>
<para>
Run in interactive mode. <varlistentry>
Prompts for confirmation before destroying a database. <term>
-i
<varlistentry> </term>
<term> <listitem>
<replaceable class="parameter">dbname</replaceable> <para>
</term> Run in interactive mode.
<listitem> Prompts for confirmation before destroying a database.
<para> </para>
Specifies the name of the database to be destroyed. The database </listitem>
must be one of the existing <productname>Postgres</productname> databases </varlistentry>
in this installation.
<replaceable class="parameter">dbname</replaceable> <varlistentry>
defaults to the value of the <term>
<envar>USER</envar> <replaceable class="parameter">dbname</replaceable>
environment variable. </term>
<listitem>
</variablelist> <para>
Specifies the name of the database to be destroyed. The database
<REFSECT2 ID="R2-APP-DESTROYDB-2"> must be one of the existing <productname>Postgres</productname> databases
<REFSECT2INFO> in this installation.
<DATE>1998-10-02</DATE> <replaceable class="parameter">dbname</replaceable>
</REFSECT2INFO> defaults to the value of the
<TITLE> <envar>USER</envar>
Outputs environment variable.
</TITLE> </para>
<PARA> </listitem>
<application>destroydb</application> will remove files from the </varlistentry>
<filename><envar>PGDATA</envar>/<replaceable class="parameter">dbname</replaceable>/</filename>
data area for the existing database. </variablelist>
</para>
<variablelist> </refsect2>
<varlistentry>
<term>
Connection to database 'template1' failed.
connectDB() failed: Is the postmaster running and accepting connections
at 'UNIX Socket' on port '<replaceable class="parameter">port</replaceable>'?
destroydb: database destroy failed on <replaceable class="parameter">dbname</replaceable>.
<listitem>
<para>
<application>destroydb</application> could not attach to the
<application>postmaster</application>
process on the specified host and port. If you see this message,
ensure that the <application>postmaster</application>
is running on the proper host and that you have specified the proper
port. If your site uses an authentication system, ensure that you
have obtained the required authentication credentials.
<varlistentry>
<term>
Connection to database 'template1' failed.
FATAL 1: SetUserId: user '<replaceable class="parameter">username</replaceable>' is not in 'pg_shadow'
destroydb: database destroy failed on <replaceable class="parameter">dbname</replaceable>.
<listitem>
<para>
You do not have a valid entry in the relation <literal>pg_shadow</literal>
and and will not be allowed to access <productname>Postgres</productname>.
Contact your <productname>Postgres</productname> administrator.
<varlistentry> <REFSECT2 ID="R2-APP-DESTROYDB-2">
<term> <REFSECT2INFO>
ERROR: user '<replaceable class="parameter">username</replaceable>' is not allowed to create/destroy databases <DATE>1998-10-02</DATE>
destroydb: database destroy failed on <replaceable class="parameter">dbname</replaceable>. </REFSECT2INFO>
<listitem> <TITLE>
<para> Outputs
You do not have permission to destroy (or create) databases. </TITLE>
Contact your <productname>Postgres</productname> site administrator. <PARA>
<application>destroydb</application> will remove files from the
<filename><envar>PGDATA</envar>/<replaceable class="parameter">dbname</replaceable>/</filename>
data area for the existing database.
<variablelist>
<varlistentry>
<term>
Connection to database 'template1' failed.
connectDB() failed: Is the postmaster running and accepting connections
at 'UNIX Socket' on port '<replaceable class="parameter">port</replaceable>'?
destroydb: database destroy failed on <replaceable class="parameter">dbname</replaceable>.
</term>
<listitem>
<para>
<application>destroydb</application> could not attach to the
<application>postmaster</application>
process on the specified host and port. If you see this message,
ensure that the <application>postmaster</application>
is running on the proper host and that you have specified the proper
port. If your site uses an authentication system, ensure that you
have obtained the required authentication credentials.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
ERROR: destroydb: database '<replaceable class="parameter">dbname</replaceable>' does not exist. Connection to database 'template1' failed.
destroydb: database destroy failed on <replaceable class="parameter">dbname</replaceable>. FATAL 1: SetUserId: user '<replaceable class="parameter">username</replaceable>' is not in 'pg_shadow'
<listitem> destroydb: database destroy failed on <replaceable class="parameter">dbname</replaceable>.
<para> </term>
The database to be removed does not have an entry in the <listitem>
<literal>pg_database</literal> class. <para>
You do not have a valid entry in the relation <literal>pg_shadow</literal>
and and will not be allowed to access <productname>Postgres</productname>.
Contact your <productname>Postgres</productname> administrator.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
ERROR: destroydb: database '<replaceable class="parameter">dbname</replaceable>' is not owned by you. ERROR: user '<replaceable class="parameter">username</replaceable>' is not allowed to create/destroy databases
destroydb: database destroy failed on <replaceable class="parameter">dbname</replaceable>. destroydb: database destroy failed on <replaceable class="parameter">dbname</replaceable>.
<listitem> </term>
<para> <listitem>
You are not the Database Administrator (DBA) for the specified database. <para>
You do not have permission to destroy (or create) databases.
<varlistentry> Contact your <productname>Postgres</productname> site administrator.
<term> </para>
destroydb: database destroy failed on <replaceable class="parameter">dbname</replaceable>. </listitem>
<listitem> </varlistentry>
<para>
An internal error occurred in <application>psql</application> <varlistentry>
or in the backend server. Ensure that your site administrator has <term>
properly installed <productname>Postgres</productname>and initialized the site with ERROR: destroydb: database '<replaceable class="parameter">dbname</replaceable>' does not exist.
<application>initdb</application>. destroydb: database destroy failed on <replaceable class="parameter">dbname</replaceable>.
</term>
</variablelist> <listitem>
<para>
<note> The database to be removed does not have an entry in the
<para> <literal>pg_database</literal> class.
<application>destroydb</application> internally runs </para>
<command>DESTROY DATABASE</command> from <application>psql</application> </listitem>
while connected to the <literal>template1</literal> database. </varlistentry>
</note>
<varlistentry>
<REFSECT1 ID="R1-APP-DESTROYDB-1"> <term>
<REFSECT1INFO> ERROR: destroydb: database '<replaceable class="parameter">dbname</replaceable>' is not owned by you.
<DATE>1998-10-02</DATE> destroydb: database destroy failed on <replaceable class="parameter">dbname</replaceable>.
</REFSECT1INFO> </term>
<TITLE> <listitem>
Description <para>
</TITLE> You are not the Database Administrator (DBA) for the specified database.
<PARA> </para>
<application>destroydb</application> destroys an existing </listitem>
<productname>Postgres</productname> database. </varlistentry>
The person who executes this command must be
the database administrator, or <acronym>DBA</acronym>, <varlistentry>
or must be the <productname>Postgres</productname> super-user. <term>
The program runs silently; no confirmation message will be displayed. destroydb: database destroy failed on <replaceable class="parameter">dbname</replaceable>.
After the database is destroyed, a Unix shell prompt will reappear. </term>
<listitem>
<para> <para>
All references to An internal error occurred in <application>psql</application>
the database are removed, including the directory containing this or in the backend server. Ensure that your site administrator has
database and its associated files. properly installed <productname>Postgres</productname>and initialized the site with
<application>initdb</application>.
<para> </para>
<application>destroydb</application> is a shell script that invokes </listitem>
<application>psql</application>. </varlistentry>
Hence, a <application>postmaster</application>
process must be running on the database server host before </variablelist>
<application>destroydb</application> </para>
is executed. The <note>
<envar>PGOPTION</envar> <para>
and <application>destroydb</application> internally runs
<envar>PGREALM</envar> <command>DESTROY DATABASE</command> from <application>psql</application>
environment variables will be passed on to while connected to the <literal>template1</literal> database.
<application>psql</application> </para>
and processed as described in <xref linkend="app-psql" endterm="psql-ref">. </note>
</refsect2>
<REFSECT1 ID="R1-APP-DESTROYDB-2"> </refsynopsisdiv>
<REFSECT1INFO>
<DATE>1998-10-02</DATE>
</REFSECT1INFO>
<TITLE>
Usage
</TITLE>
<PARA>
To destroy the database <literal>demo</literal>
using the postmaster on the local host, port 5432:
<programlisting>
destroydb demo
</programlisting>
<para> <REFSECT1 ID="R1-APP-DESTROYDB-1">
To destroy the database <literal>demo</literal> <REFSECT1INFO>
using the postmaster on host eden, port 5000: <DATE>1998-10-02</DATE>
<programlisting> </REFSECT1INFO>
destroydb -p 5000 -h eden demo <TITLE>
</programlisting> Description
</TITLE>
<PARA>
<application>destroydb</application> destroys an existing
<productname>Postgres</productname> database.
The person who executes this command must be
the database administrator, or <acronym>DBA</acronym>,
or must be the <productname>Postgres</productname> super-user.
The program runs silently; no confirmation message will be displayed.
After the database is destroyed, a Unix shell prompt will reappear.
</para>
<para>
All references to
the database are removed, including the directory containing this
database and its associated files.
</para>
<para>
<application>destroydb</application> is a shell script that invokes
<application>psql</application>.
Hence, a <application>postmaster</application>
process must be running on the database server host before
<application>destroydb</application>
is executed. The
<envar>PGOPTION</envar>
and
<envar>PGREALM</envar>
environment variables will be passed on to
<application>psql</application>
and processed as described in <xref linkend="app-psql" endterm="psql-ref">.
</para>
</refsect1>
<REFSECT1 ID="R1-APP-DESTROYDB-2">
<REFSECT1INFO>
<DATE>1998-10-02</DATE>
</REFSECT1INFO>
<TITLE>
Usage
</TITLE>
<PARA>
To destroy the database <literal>demo</literal>
using the postmaster on the local host, port 5432:
<programlisting>
destroydb demo
</programlisting>
</para>
<para>
To destroy the database <literal>demo</literal>
using the postmaster on host eden, port 5000:
<programlisting>
destroydb -p 5000 -h eden demo
</programlisting>
</para>
</refsect1>
</REFENTRY> </REFENTRY>
doc/src/sgml/ref/destroyuser.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ ...@@ -12,6 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Destroy a <productname>Postgres</productname> user and associated databases Destroy a <productname>Postgres</productname> user and associated databases
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-10-02</DATE> <DATE>1998-10-02</DATE>
...@@ -22,179 +23,222 @@ destroyuser [ -h <replaceable class="parameter">host</replaceable> ] [ -p <repla ...@@ -22,179 +23,222 @@ destroyuser [ -h <replaceable class="parameter">host</replaceable> ] [ -p <repla
[ <replaceable class="parameter">username</replaceable> ] [ <replaceable class="parameter">username</replaceable> ]
</SYNOPSIS> </SYNOPSIS>
<REFSECT2 ID="R2-APP-DESTROYUSER-1"> <REFSECT2 ID="R2-APP-DESTROYUSER-1">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-10-02</DATE> <DATE>1998-10-02</DATE>
</REFSECT2INFO> </REFSECT2INFO>
<TITLE> <TITLE>
Inputs Inputs
</TITLE> </TITLE>
<PARA> <PARA>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>
-h <replaceable class="parameter">host</replaceable> -h <replaceable class="parameter">host</replaceable>
</term> </term>
<listitem> <listitem>
<para> <para>
Specifies the hostname of the machine on which the Specifies the hostname of the machine on which the
<application>postmaster</application> <application>postmaster</application>
is running. Defaults to using a local Unix domain socket is running. Defaults to using a local Unix domain socket
rather than an IP connection.. rather than an IP connection..
</para>
<varlistentry> </listitem>
<term> </varlistentry>
-p <replaceable class="parameter">port</replaceable>
</term> <varlistentry>
<listitem> <term>
<para> -p <replaceable class="parameter">port</replaceable>
Specifies the Internet TCP/IP port or local Unix domain socket file </term>
extension on which the <application>postmaster</application> <listitem>
is listening for connections. The port number defaults to 5432, <para>
or the value of the <envar>PGPORT</envar> Specifies the Internet TCP/IP port or local Unix domain socket file
environment variable (if set). extension on which the <application>postmaster</application>
is listening for connections. The port number defaults to 5432,
<varlistentry> or the value of the <envar>PGPORT</envar>
<term> environment variable (if set).
<replaceable class="parameter">username</replaceable> </para>
</term> </listitem>
<listitem> </varlistentry>
<para>
Specifies the name of the <productname>Postgres</productname> user to be removed. <varlistentry>
This name must exist in the <productname>Postgres</productname> installation. <term>
You will be prompted for a name if none is specified on the command line. <replaceable class="parameter">username</replaceable>
</term>
</variablelist> <listitem>
<para>
<REFSECT2 ID="R2-APP-DESTROYUSER-2"> Specifies the name of the <productname>Postgres</productname> user to be removed.
<REFSECT2INFO> This name must exist in the <productname>Postgres</productname> installation.
<DATE>1998-10-02</DATE> You will be prompted for a name if none is specified on the command line.
</REFSECT2INFO> </para>
<TITLE> </listitem>
Outputs </varlistentry>
</TITLE>
<PARA> </variablelist>
<application>destroyuser</application> will remove an entry in the </para>
<literal>pg_user</literal> or <literal>pg_shadow</literal> system table, </refsect2>
and will remove all databases for which that user is the administrator
(<acronym>DBA</acronym>). <REFSECT2 ID="R2-APP-DESTROYUSER-2">
<REFSECT2INFO>
<variablelist> <DATE>1998-10-02</DATE>
<varlistentry> </REFSECT2INFO>
<term> <TITLE>
Connection to database 'template1' failed. Outputs
connectDB() failed: Is the postmaster running and accepting connections </TITLE>
at 'UNIX Socket' on port '<replaceable class="parameter">port</replaceable>'? <PARA>
destroyuser: database access failed. <application>destroyuser</application> will remove an entry in the
<listitem> <literal>pg_user</literal> or <literal>pg_shadow</literal> system table,
<para> and will remove all databases for which that user is the administrator
<application>destroyuser</application> could not attach to the (<acronym>DBA</acronym>).
<application>postmaster</application>
process on the specified host and port. If you see this message, <variablelist>
ensure that the <application>postmaster</application> <varlistentry>
is running on the proper host and that you have specified the proper <term>
port. If your site uses an authentication system, ensure that you Connection to database 'template1' failed.
have obtained the required authentication credentials. connectDB() failed: Is the postmaster running and accepting connections
at 'UNIX Socket' on port '<replaceable class="parameter">port</replaceable>'?
<varlistentry> destroyuser: database access failed.
<term> </term>
Connection to database 'template1' failed. <listitem>
FATAL 1: SetUserId: user '<replaceable class="parameter">username</replaceable>' is not in 'pg_shadow' <para>
destroyuser: database access failed. <application>destroyuser</application> could not attach to the
<listitem> <application>postmaster</application>
<para> process on the specified host and port. If you see this message,
You do not have a valid entry in the relation <literal>pg_shadow</literal> ensure that the <application>postmaster</application>
and and will not be allowed to access <productname>Postgres</productname>. Contact your is running on the proper host and that you have specified the proper
<productname>Postgres</productname> administrator. port. If your site uses an authentication system, ensure that you
have obtained the required authentication credentials.
<varlistentry> </para>
<term> </listitem>
destroyuser: <replaceable class="parameter">username</replaceable> cannot delete users. </varlistentry>
<listitem>
<para> <varlistentry>
You do not have permission to delete users; contact your <term>
<productname>Postgres</productname> site administrator. Connection to database 'template1' failed.
FATAL 1: SetUserId: user '<replaceable class="parameter">username</replaceable>' is not in 'pg_shadow'
<varlistentry> destroyuser: database access failed.
<term> </term>
destroyuser: user "<replaceable class="parameter">username</replaceable>" already exists <listitem>
<listitem> <para>
<para> You do not have a valid entry in the relation <literal>pg_shadow</literal>
The user to be added already has an entry in the <literal>pg_shadow</literal> and and will not be allowed to access <productname>Postgres</productname>. Contact your
class. <productname>Postgres</productname> administrator.
</para>
<varlistentry> </listitem>
<term> </varlistentry>
database access failed
<listitem> <varlistentry>
<para> <term>
An internal error occurred in <application>psql</application> destroyuser: <replaceable class="parameter">username</replaceable> cannot delete users.
or in the backend server. Ensure that your site administrator has </term>
properly installed <productname>Postgres</productname>and initialized the site with <listitem>
<application>initdb</application>. <para>
You do not have permission to delete users; contact your
<varlistentry> <productname>Postgres</productname> site administrator.
<term> </para>
destroydb on <replaceable class="parameter">dbname</replaceable> failed - exiting </listitem>
<listitem> </varlistentry>
<para>
An internal error occurred in <application>psql</application> <varlistentry>
or in the backend server. There was possibly a Unix permissions problem with the <term>
specified database. destroyuser: user "<replaceable class="parameter">username</replaceable>" already exists
</term>
<listitem>
<varlistentry> <para>
<term> The user to be added already has an entry in the <literal>pg_shadow</literal>
delete of user <replaceable class="parameter">username</replaceable> was UNSUCCESSFUL class.
<listitem> </para>
<para> </listitem>
An internal error occurred in <application>psql</application> </varlistentry>
or in the backend server.
<varlistentry>
</variablelist> <term>
database access failed
<note> </term>
<para> <listitem>
<application>destroyuser</application> internally runs <para>
DROP USER from <application>psql</application> An internal error occurred in <application>psql</application>
while connected to the <literal>template1</literal> database. or in the backend server. Ensure that your site administrator has
</note> properly installed <productname>Postgres</productname>and initialized the site with
<application>initdb</application>.
<REFSECT1 ID="R1-APP-DESTROYUSER-1"> </para>
<REFSECT1INFO> </listitem>
<DATE>1998-10-02</DATE> </varlistentry>
</REFSECT1INFO>
<TITLE> <varlistentry>
Description <term>
</TITLE> destroydb on <replaceable class="parameter">dbname</replaceable> failed - exiting
<PARA> </term>
<application>destroyuser</application> removes an existing <listitem>
<productname>Postgres</productname> user <para>
and the databases for which that user An internal error occurred in <application>psql</application>
is database administrator. or in the backend server. There was possibly a Unix permissions problem with the
Only users with <literal>usesuper</literal> set in specified database.
the <literal>pg_shadow</literal> class can destroy </para>
<productname>Postgres</productname> users. As shipped, </listitem>
the user <literal>postgres</literal> can remove users. </varlistentry>
<para> <varlistentry>
<application>destroyuser</application> is a shell script that invokes <term>
<application>psql</application>. delete of user <replaceable class="parameter">username</replaceable> was UNSUCCESSFUL
Hence, a <application>postmaster</application> </term>
process must be running on the database server host before <listitem>
<application>destroyuser</application> is executed. <para>
The An internal error occurred in <application>psql</application>
<envar>PGOPTION</envar> or in the backend server.
and </para>
<envar>PGREALM</envar> </listitem>
environment variables will be passed on to </varlistentry>
<application>psql</application>
and processed as described in <xref linkend="app-psql" endterm="psql-ref">. </variablelist>
</para>
<para>
Once invoked, <application>destroyuser</application> <note>
will warn you about the databases that will be destroyed in the <para>
process and permit you to abort the removal of the user if desired. <application>destroyuser</application> internally runs
DROP USER from <application>psql</application>
while connected to the <literal>template1</literal> database.
</para>
</note>
</refsect2>
</refsynopsisdiv>
<REFSECT1 ID="R1-APP-DESTROYUSER-1">
<REFSECT1INFO>
<DATE>1998-10-02</DATE>
</REFSECT1INFO>
<TITLE>
Description
</TITLE>
<PARA>
<application>destroyuser</application> removes an existing
<productname>Postgres</productname> user
and the databases for which that user
is database administrator.
Only users with <literal>usesuper</literal> set in
the <literal>pg_shadow</literal> class can destroy
<productname>Postgres</productname> users. As shipped,
the user <literal>postgres</literal> can remove users.
</para>
<para>
<application>destroyuser</application> is a shell script that invokes
<application>psql</application>.
Hence, a <application>postmaster</application>
process must be running on the database server host before
<application>destroyuser</application> is executed.
The
<envar>PGOPTION</envar>
and
<envar>PGREALM</envar>
environment variables will be passed on to
<application>psql</application>
and processed as described in <xref linkend="app-psql" endterm="psql-ref">.
</para>
<para>
Once invoked, <application>destroyuser</application>
will warn you about the databases that will be destroyed in the
process and permit you to abort the removal of the user if desired.
</para>
</refsect1>
</REFENTRY> </REFENTRY>
doc/src/sgml/ref/drop_aggregate.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ ...@@ -12,6 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Removes the definition of an aggregate function Removes the definition of an aggregate function
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-04-15</DATE> <DATE>1998-04-15</DATE>
...@@ -84,8 +85,11 @@ DROP AGGREGATE <REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE> <REPLACEABLE CL ...@@ -84,8 +85,11 @@ DROP AGGREGATE <REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE> <REPLACEABLE CL
<PARA> <PARA>
This message occurs if the aggregate function specified does not This message occurs if the aggregate function specified does not
exist in the database. exist in the database.
</para>
</VARIABLELIST> </listitem>
</varlistentry>
</VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
......
doc/src/sgml/ref/drop_database.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ ...@@ -12,6 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Destroys an existing database Destroys an existing database
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-04-15</DATE> <DATE>1998-04-15</DATE>
...@@ -80,8 +81,11 @@ DROP DATABASE <REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE> ...@@ -80,8 +81,11 @@ DROP DATABASE <REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
This message occurs if the specified database does not exist. This message occurs if the specified database does not exist.
</para>
</VARIABLELIST> </listitem>
</varlistentry>
</VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
......
doc/src/sgml/ref/drop_function.sgml
View file @ a75f2d21
...@@ -12,7 +12,7 @@ ...@@ -12,7 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Removes a user-defined C function Removes a user-defined C function
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-04-15</DATE> <DATE>1998-04-15</DATE>
...@@ -82,8 +82,11 @@ DROP FUNCTION <replaceable class="parameter">name</replaceable> ( [ <replaceable ...@@ -82,8 +82,11 @@ DROP FUNCTION <replaceable class="parameter">name</replaceable> ( [ <replaceable
<PARA> <PARA>
This message is given if the function specified does not This message is given if the function specified does not
exist in the current database. exist in the current database.
</para>
</VARIABLELIST> </listitem>
</varlistentry>
</VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
...@@ -118,6 +121,7 @@ CREATE FUNCTION ...@@ -118,6 +121,7 @@ CREATE FUNCTION
to create aggregate functions. to create aggregate functions.
</PARA> </PARA>
</REFSECT2> </REFSECT2>
</refsect1>
<REFSECT1 ID="R1-SQL-DROPFUNCTION-2"> <REFSECT1 ID="R1-SQL-DROPFUNCTION-2">
<TITLE> <TITLE>
...@@ -130,6 +134,7 @@ CREATE FUNCTION ...@@ -130,6 +134,7 @@ CREATE FUNCTION
DROP FUNCTION sqrt(int4); DROP FUNCTION sqrt(int4);
</ProgramListing> </ProgramListing>
</REFSECT1> </REFSECT1>
<REFSECT1 ID="R1-SQL-DROPFUNCTION-3"> <REFSECT1 ID="R1-SQL-DROPFUNCTION-3">
<TITLE> <TITLE>
Bugs Bugs
......
doc/src/sgml/ref/drop_index.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ ...@@ -12,6 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Removes an index from a database Removes an index from a database
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-04-15</DATE> <DATE>1998-04-15</DATE>
...@@ -70,8 +71,11 @@ DROP INDEX <REPLACEABLE CLASS="PARAMETER">index_name</REPLACEABLE> ...@@ -70,8 +71,11 @@ DROP INDEX <REPLACEABLE CLASS="PARAMETER">index_name</REPLACEABLE>
<PARA> <PARA>
This message occurs if <REPLACEABLE CLASS="PARAMETER">index_name</REPLACEABLE> This message occurs if <REPLACEABLE CLASS="PARAMETER">index_name</REPLACEABLE>
is not an index in the database. is not an index in the database.
</para>
</VARIABLELIST> </listitem>
</varlistentry>
</VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
...@@ -104,6 +108,7 @@ DROP INDEX <REPLACEABLE CLASS="PARAMETER">index_name</REPLACEABLE> ...@@ -104,6 +108,7 @@ DROP INDEX <REPLACEABLE CLASS="PARAMETER">index_name</REPLACEABLE>
information on how to create indexes. information on how to create indexes.
</PARA> </PARA>
</REFSECT2> </REFSECT2>
</refsect1>
<REFSECT1 ID="R1-SQL-DROPINDEX-2"> <REFSECT1 ID="R1-SQL-DROPINDEX-2">
<TITLE> <TITLE>
......
doc/src/sgml/ref/drop_language.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ ...@@ -12,6 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Removes a user-defined procedural language Removes a user-defined procedural language
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-04-15</DATE> <DATE>1998-04-15</DATE>
...@@ -72,8 +73,11 @@ DROP PROCEDURAL LANGUAGE '<REPLACEABLE CLASS="PARAMETER">langname</REPLACEABLE>' ...@@ -72,8 +73,11 @@ DROP PROCEDURAL LANGUAGE '<REPLACEABLE CLASS="PARAMETER">langname</REPLACEABLE>'
This message occurs if the language This message occurs if the language
"<replaceable class="parameter">langname</replaceable>" is "<replaceable class="parameter">langname</replaceable>" is
not found. not found.
</para>
</VARIABLELIST> </listitem>
</varlistentry>
</VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
......
doc/src/sgml/ref/drop_operator.sgml
View file @ a75f2d21
...@@ -12,7 +12,7 @@ ...@@ -12,7 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Removes an operator from the database Removes an operator from the database
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
...@@ -104,8 +104,11 @@ DROP OPERATOR <REPLACEABLE CLASS="PARAMETER">id</REPLACEABLE> ( <REPLACEABLE CLA ...@@ -104,8 +104,11 @@ DROP OPERATOR <REPLACEABLE CLASS="PARAMETER">id</REPLACEABLE> ( <REPLACEABLE CLA
<PARA> <PARA>
This message occurs if the specified right unary operator This message occurs if the specified right unary operator
specified does not exist. specified does not exist.
</para>
</VARIABLELIST> </listitem>
</varlistentry>
</VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
...@@ -147,6 +150,7 @@ DROP OPERATOR <REPLACEABLE CLASS="PARAMETER">id</REPLACEABLE> ( <REPLACEABLE CLA ...@@ -147,6 +150,7 @@ DROP OPERATOR <REPLACEABLE CLASS="PARAMETER">id</REPLACEABLE> ( <REPLACEABLE CLA
operator classes that rely on the deleted operator. operator classes that rely on the deleted operator.
</PARA> </PARA>
</REFSECT2> </REFSECT2>
</refsect1>
<REFSECT1 ID="R1-SQL-DROPOPERATOR-2"> <REFSECT1 ID="R1-SQL-DROPOPERATOR-2">
<TITLE> <TITLE>
......
doc/src/sgml/ref/drop_rule.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ ...@@ -12,6 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Removes an existing rule from the database Removes an existing rule from the database
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-22</DATE> <DATE>1998-09-22</DATE>
...@@ -69,7 +70,11 @@ DROP RULE <REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE> ...@@ -69,7 +70,11 @@ DROP RULE <REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
This message occurs if the specified rule does not exist. This message occurs if the specified rule does not exist.
</VARIABLELIST> </para>
</listitem>
</varlistentry>
</VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
......
doc/src/sgml/ref/drop_sequence.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ ...@@ -12,6 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Removes an existing sequence Removes an existing sequence
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-22</DATE> <DATE>1998-09-22</DATE>
...@@ -70,7 +71,11 @@ DROP SEQUENCE <REPLACEABLE CLASS="PARAMETER">seqname</REPLACEABLE> [, ...] ...@@ -70,7 +71,11 @@ DROP SEQUENCE <REPLACEABLE CLASS="PARAMETER">seqname</REPLACEABLE> [, ...]
<LISTITEM> <LISTITEM>
<PARA> <PARA>
This message occurs if the specified sequence does not exist. This message occurs if the specified sequence does not exist.
</VARIABLELIST> </para>
</listitem>
</varlistentry>
</VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
...@@ -105,6 +110,7 @@ DROP SEQUENCE <REPLACEABLE CLASS="PARAMETER">seqname</REPLACEABLE> [, ...] ...@@ -105,6 +110,7 @@ DROP SEQUENCE <REPLACEABLE CLASS="PARAMETER">seqname</REPLACEABLE> [, ...]
information on how to create a sequence. information on how to create a sequence.
</PARA> </PARA>
</REFSECT2> </REFSECT2>
</refsect1>
<REFSECT1 ID="R1-SQL-DROPSEQUENCE-2"> <REFSECT1 ID="R1-SQL-DROPSEQUENCE-2">
<TITLE> <TITLE>
......
doc/src/sgml/ref/drop_table.sgml
View file @ a75f2d21
...@@ -12,7 +12,7 @@ ...@@ -12,7 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Removes existing tables from a database Removes existing tables from a database
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-22</DATE> <DATE>1998-09-22</DATE>
...@@ -70,7 +70,11 @@ DROP TABLE <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE> [, ...] ...@@ -70,7 +70,11 @@ DROP TABLE <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE> [, ...]
<LISTITEM> <LISTITEM>
<PARA> <PARA>
If the specified table or view does not exist in the database. If the specified table or view does not exist in the database.
</VARIABLELIST> </para>
</listitem>
</varlistentry>
</VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
......
doc/src/sgml/ref/drop_trigger.sgml
View file @ a75f2d21
...@@ -11,7 +11,8 @@ ...@@ -11,7 +11,8 @@
</REFNAME> </REFNAME>
<REFPURPOSE> <REFPURPOSE>
Removes the definition of a trigger Removes the definition of a trigger
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-22</DATE> <DATE>1998-09-22</DATE>
...@@ -80,9 +81,11 @@ DROP TRIGGER <REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE> ON <REPLACEABLE C ...@@ -80,9 +81,11 @@ DROP TRIGGER <REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE> ON <REPLACEABLE C
<LISTITEM> <LISTITEM>
<PARA> <PARA>
This message occurs if the trigger specified does not exist. This message occurs if the trigger specified does not exist.
</para>
</VARIABLELIST> </listitem>
</varlistentry>
</VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
...@@ -115,6 +118,7 @@ DROP TRIGGER <REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE> ON <REPLACEABLE C ...@@ -115,6 +118,7 @@ DROP TRIGGER <REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE> ON <REPLACEABLE C
information on how to create triggers. information on how to create triggers.
</PARA> </PARA>
</REFSECT2> </REFSECT2>
</refsect1>
<REFSECT1 ID="R1-SQL-DROPTRIGGER-2"> <REFSECT1 ID="R1-SQL-DROPTRIGGER-2">
<TITLE> <TITLE>
......
doc/src/sgml/ref/drop_type.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ ...@@ -12,6 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Removes a user-defined type from the system catalogs Removes a user-defined type from the system catalogs
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-22</DATE> <DATE>1998-09-22</DATE>
...@@ -69,8 +70,11 @@ DROP TYPE <REPLACEABLE CLASS="PARAMETER">typename</REPLACEABLE> ...@@ -69,8 +70,11 @@ DROP TYPE <REPLACEABLE CLASS="PARAMETER">typename</REPLACEABLE>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
This message occurs if the specified type is not found. This message occurs if the specified type is not found.
</para>
</VARIABLELIST> </listitem>
</varlistentry>
</VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
...@@ -123,6 +127,7 @@ DROP TYPE <REPLACEABLE CLASS="PARAMETER">typename</REPLACEABLE> ...@@ -123,6 +127,7 @@ DROP TYPE <REPLACEABLE CLASS="PARAMETER">typename</REPLACEABLE>
is unpredictable. is unpredictable.
</PARA> </PARA>
</refsect2> </refsect2>
</refsect1>
<REFSECT1 ID="R1-SQL-DROPTYPE-2"> <REFSECT1 ID="R1-SQL-DROPTYPE-2">
<TITLE> <TITLE>
......
doc/src/sgml/ref/drop_user.sgml
View file @ a75f2d21
...@@ -12,7 +12,7 @@ ...@@ -12,7 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Removes an user account information Removes an user account information
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-22</DATE> <DATE>1998-09-22</DATE>
...@@ -70,10 +70,11 @@ DROP USER <REPLACEABLE CLASS="PARAMETER">username</REPLACEABLE> ...@@ -70,10 +70,11 @@ DROP USER <REPLACEABLE CLASS="PARAMETER">username</REPLACEABLE>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
This message occurs if the username is not found. This message occurs if the username is not found.
</PARA> </PARA>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
</VARIABLELIST> </VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
...@@ -111,6 +112,7 @@ DROP USER <REPLACEABLE CLASS="PARAMETER">username</REPLACEABLE> ...@@ -111,6 +112,7 @@ DROP USER <REPLACEABLE CLASS="PARAMETER">username</REPLACEABLE>
how to create or modify user accounts. how to create or modify user accounts.
</PARA> </PARA>
</REFSECT2> </REFSECT2>
</refsect1>
<REFSECT1 ID="R1-SQL-DROPUSER-2"> <REFSECT1 ID="R1-SQL-DROPUSER-2">
<TITLE> <TITLE>
......
doc/src/sgml/ref/drop_view.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ ...@@ -12,6 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Removes an existing view from a database Removes an existing view from a database
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-22</DATE> <DATE>1998-09-22</DATE>
...@@ -60,19 +61,24 @@ DROP VIEW <REPLACEABLE CLASS="PARAMETER">view</REPLACEABLE> ...@@ -60,19 +61,24 @@ DROP VIEW <REPLACEABLE CLASS="PARAMETER">view</REPLACEABLE>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
The message returned if the command is successful. The message returned if the command is successful.
</para>
<VARLISTENTRY> </listitem>
<TERM> </varlistentry>
<ReturnValue> <VARLISTENTRY>
ERROR: RewriteGetRuleEventRel: rule "_RET<REPLACEABLE CLASS="PARAMETER">view</REPLACEABLE>" not found</ReturnValue> <TERM>
</TERM> <ReturnValue>
<LISTITEM> ERROR: RewriteGetRuleEventRel: rule "_RET<REPLACEABLE CLASS="PARAMETER">view</REPLACEABLE>" not found</ReturnValue>
<PARA> </TERM>
This message occurs if the specified view does not exist in <LISTITEM>
the database. <PARA>
</variablelist> This message occurs if the specified view does not exist in
the database.
</REFSECT2> </para>
</listitem>
</varlistentry>
</variablelist>
</para>
</REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
<REFSECT1 ID="R1-SQL-DROPVIEW-1"> <REFSECT1 ID="R1-SQL-DROPVIEW-1">
...@@ -104,6 +110,7 @@ the database. ...@@ -104,6 +110,7 @@ the database.
for information on how to create views. for information on how to create views.
</PARA> </PARA>
</REFSECT2> </REFSECT2>
</refsect1>
<REFSECT1 ID="R1-SQL-DROPVIEW-2"> <REFSECT1 ID="R1-SQL-DROPVIEW-2">
<TITLE> <TITLE>
...@@ -164,11 +171,12 @@ DROP VIEW <replaceable class="parameter">view</replaceable> { RESTRICT | CASCADE ...@@ -164,11 +171,12 @@ DROP VIEW <replaceable class="parameter">view</replaceable> { RESTRICT | CASCADE
<para> <para>
Any referencing views and integrity constraints Any referencing views and integrity constraints
will be dropped as well. will be dropped as well.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</refsect3> </para>
</refsect3>
<REFSECT3 ID="R3-SQL-DROPVIEW-2"> <REFSECT3 ID="R3-SQL-DROPVIEW-2">
<REFSECT3INFO> <REFSECT3INFO>
...@@ -176,15 +184,17 @@ DROP VIEW <replaceable class="parameter">view</replaceable> { RESTRICT | CASCADE ...@@ -176,15 +184,17 @@ DROP VIEW <replaceable class="parameter">view</replaceable> { RESTRICT | CASCADE
</REFSECT3INFO> </REFSECT3INFO>
<TITLE> <TITLE>
Notes Notes
</TITLE> </TITLE>
<para>
<tip>
<para> <para>
At present, to remove a referenced view from a <tip>
<productname>Postgres</productname> database, <para>
you must drop it explicitly. At present, to remove a referenced view from a
<productname>Postgres</productname> database,
you must drop it explicitly.
</para>
</tip>
</para> </para>
</tip> </refsect3>
</refsect2> </refsect2>
</refsect1> </refsect1>
</REFENTRY> </REFENTRY>
......
doc/src/sgml/ref/explain.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ EXPLAIN ...@@ -12,6 +12,7 @@ EXPLAIN
<REFPURPOSE> <REFPURPOSE>
Shows statement execution details Shows statement execution details
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
...@@ -38,7 +39,9 @@ VERBOSE ...@@ -38,7 +39,9 @@ VERBOSE
<LISTITEM> <LISTITEM>
<PARA> <PARA>
Flag to show detailed query plan. Flag to show detailed query plan.
</para>
</listitem>
</varlistentry>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<REPLACEABLE CLASS="PARAMETER">query</REPLACEABLE> <REPLACEABLE CLASS="PARAMETER">query</REPLACEABLE>
...@@ -46,9 +49,11 @@ Flag to show detailed query plan. ...@@ -46,9 +49,11 @@ Flag to show detailed query plan.
<LISTITEM> <LISTITEM>
<PARA> <PARA>
Any <REPLACEABLE CLASS="PARAMETER">query</REPLACEABLE>. Any <REPLACEABLE CLASS="PARAMETER">query</REPLACEABLE>.
</para>
</listitem>
</varlistentry>
</VARIABLELIST> </VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
<REFSECT2 ID="R2-SQL-EXPLAIN-2"> <REFSECT2 ID="R2-SQL-EXPLAIN-2">
...@@ -69,7 +74,9 @@ NOTICE: QUERY PLAN: ...@@ -69,7 +74,9 @@ NOTICE: QUERY PLAN:
<LISTITEM> <LISTITEM>
<PARA> <PARA>
Explicit query plan from the <productname>Postgres</productname> backend. Explicit query plan from the <productname>Postgres</productname> backend.
</para>
</listitem>
</varlistentry>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
EXPLAIN EXPLAIN
...@@ -77,9 +84,11 @@ EXPLAIN ...@@ -77,9 +84,11 @@ EXPLAIN
<LISTITEM> <LISTITEM>
<PARA> <PARA>
Flag sent after query plan is shown. Flag sent after query plan is shown.
</para>
</listitem>
</varlistentry>
</VARIABLELIST> </VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
...@@ -95,7 +104,7 @@ Description ...@@ -95,7 +104,7 @@ Description
The default output is the computed query cost. The default output is the computed query cost.
VERBOSE displays the full query plan and cost to your screen, VERBOSE displays the full query plan and cost to your screen,
and pretty-prints the plan to the postmaster log file. and pretty-prints the plan to the postmaster log file.
</para>
<REFSECT2 ID="R2-SQL-EXPLAIN-3"> <REFSECT2 ID="R2-SQL-EXPLAIN-3">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-04-15</DATE> <DATE>1998-04-15</DATE>
...@@ -111,8 +120,9 @@ can be found in database textbooks. ...@@ -111,8 +120,9 @@ can be found in database textbooks.
Refer to the <citetitle>Programmer's Guide</citetitle> Refer to the <citetitle>Programmer's Guide</citetitle>
in the chapters on indexes and the genetic query optimizer for in the chapters on indexes and the genetic query optimizer for
more information. more information.
</para>
</REFSECT2> </REFSECT2>
</refsect1>
<REFSECT1 ID="R1-SQL-EXPLAIN-2"> <REFSECT1 ID="R1-SQL-EXPLAIN-2">
<TITLE> <TITLE>
...@@ -129,7 +139,7 @@ Seq Scan on foo (cost=0.00 size=0 width=4) ...@@ -129,7 +139,7 @@ Seq Scan on foo (cost=0.00 size=0 width=4)
EXPLAIN EXPLAIN
</ProgramListing> </ProgramListing>
</para>
</REFSECT1> </REFSECT1>
<REFSECT1 ID="R1-SQL-EXPLAIN-3"> <REFSECT1 ID="R1-SQL-EXPLAIN-3">
...@@ -148,6 +158,9 @@ SQL92 ...@@ -148,6 +158,9 @@ SQL92
</TITLE> </TITLE>
<PARA> <PARA>
There is no EXPLAIN statement defined in SQL92. There is no EXPLAIN statement defined in SQL92.
</para>
</refsect2>
</refsect1>
</REFENTRY> </REFENTRY>
<!-- <!--
......
doc/src/sgml/ref/fetch.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ FETCH ...@@ -12,6 +12,7 @@ FETCH
<REFPURPOSE> <REFPURPOSE>
Gets rows using a cursor Gets rows using a cursor
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-01</DATE> <DATE>1998-09-01</DATE>
...@@ -42,7 +43,10 @@ Inputs ...@@ -42,7 +43,10 @@ Inputs
<REPLACEABLE CLASS="PARAMETER">selector</REPLACEABLE> <REPLACEABLE CLASS="PARAMETER">selector</REPLACEABLE>
defines the fetch direction. It can be one defines the fetch direction. It can be one
the following: the following:
</para>
</listitem>
</varlistentry>
</variablelist>
<VARIABLELIST> <VARIABLELIST>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
...@@ -52,7 +56,9 @@ FORWARD ...@@ -52,7 +56,9 @@ FORWARD
<PARA> <PARA>
fetch next row(s). This is the default fetch next row(s). This is the default
if <REPLACEABLE CLASS="PARAMETER">selector</REPLACEABLE> is omitted. if <REPLACEABLE CLASS="PARAMETER">selector</REPLACEABLE> is omitted.
</para>
</listitem>
</varlistentry>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
BACKWARD BACKWARD
...@@ -60,7 +66,9 @@ BACKWARD ...@@ -60,7 +66,9 @@ BACKWARD
<LISTITEM> <LISTITEM>
<PARA> <PARA>
fetch previous row(s). fetch previous row(s).
</para>
</listitem>
</varlistentry>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
RELATIVE RELATIVE
...@@ -68,8 +76,10 @@ RELATIVE ...@@ -68,8 +76,10 @@ RELATIVE
<LISTITEM> <LISTITEM>
<PARA> <PARA>
Noise word for SQL92 compatibility. Noise word for SQL92 compatibility.
</para>
</listitem>
</varlistentry>
</VARIABLELIST>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
...@@ -79,8 +89,11 @@ Noise word for SQL92 compatibility. ...@@ -79,8 +89,11 @@ Noise word for SQL92 compatibility.
<PARA> <PARA>
<REPLACEABLE CLASS="PARAMETER">count</REPLACEABLE> <REPLACEABLE CLASS="PARAMETER">count</REPLACEABLE>
determines how many rows to fetch. It can be one of the following: determines how many rows to fetch. It can be one of the following:
</para>
</listitem>
</varlistentry>
<VARIABLELIST>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<REPLACEABLE CLASS="PARAMETER">#</REPLACEABLE> <REPLACEABLE CLASS="PARAMETER">#</REPLACEABLE>
...@@ -90,6 +103,9 @@ determines how many rows to fetch. It can be one of the following: ...@@ -90,6 +103,9 @@ determines how many rows to fetch. It can be one of the following:
A signed integer that specify how many rows to fetch. A signed integer that specify how many rows to fetch.
Note that a negative integer is equivalent to changing the sense of Note that a negative integer is equivalent to changing the sense of
FORWARD and BACKWARD. FORWARD and BACKWARD.
</para>
</listitem>
</varlistentry>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
...@@ -98,6 +114,9 @@ ALL ...@@ -98,6 +114,9 @@ ALL
<LISTITEM> <LISTITEM>
<PARA> <PARA>
Retrieve all remaining rows. Retrieve all remaining rows.
</para>
</listitem>
</varlistentry>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
...@@ -106,6 +125,9 @@ NEXT ...@@ -106,6 +125,9 @@ NEXT
<LISTITEM> <LISTITEM>
<PARA> <PARA>
Equivalent to specifying a count of <command>1</command>. Equivalent to specifying a count of <command>1</command>.
</para>
</listitem>
</varlistentry>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
...@@ -114,8 +136,9 @@ PRIOR ...@@ -114,8 +136,9 @@ PRIOR
<LISTITEM> <LISTITEM>
<PARA> <PARA>
Equivalent to specifying a count of <command>-1</command>. Equivalent to specifying a count of <command>-1</command>.
</para>
</VARIABLELIST> </listitem>
</varlistentry>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
...@@ -124,9 +147,11 @@ Equivalent to specifying a count of <command>-1</command>. ...@@ -124,9 +147,11 @@ Equivalent to specifying a count of <command>-1</command>.
<LISTITEM> <LISTITEM>
<PARA> <PARA>
An open cursor's name. An open cursor's name.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</para>
</REFSECT2> </REFSECT2>
<REFSECT2 ID="R2-SQL-FETCH-2"> <REFSECT2 ID="R2-SQL-FETCH-2">
...@@ -139,6 +164,7 @@ Outputs ...@@ -139,6 +164,7 @@ Outputs
<PARA> <PARA>
FETCH returns the results of the query defined by the specified cursor. FETCH returns the results of the query defined by the specified cursor.
The following messages will be returned if the query fails: The following messages will be returned if the query fails:
</para>
<VARIABLELIST> <VARIABLELIST>
<VARLISTENTRY> <VARLISTENTRY>
...@@ -150,6 +176,9 @@ NOTICE: PerformPortalFetch: portal "<REPLACEABLE CLASS="PARAMETER">cursor</REPL ...@@ -150,6 +176,9 @@ NOTICE: PerformPortalFetch: portal "<REPLACEABLE CLASS="PARAMETER">cursor</REPL
If <REPLACEABLE CLASS="PARAMETER">cursor</REPLACEABLE> If <REPLACEABLE CLASS="PARAMETER">cursor</REPLACEABLE>
is not previously declared. is not previously declared.
The cursor must be declared within a transaction block. The cursor must be declared within a transaction block.
</para>
</listitem>
</varlistentry>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
...@@ -159,6 +188,9 @@ NOTICE: FETCH/ABSOLUTE not supported, using RELATIVE ...@@ -159,6 +188,9 @@ NOTICE: FETCH/ABSOLUTE not supported, using RELATIVE
<PARA> <PARA>
<productname>Postgres</productname> does not support absolute <productname>Postgres</productname> does not support absolute
positioning of cursors. positioning of cursors.
</para>
</listitem>
</varlistentry>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
...@@ -178,6 +210,9 @@ all rows should be retrieved and is equivalent to specifying the ALL keyword. ...@@ -178,6 +210,9 @@ all rows should be retrieved and is equivalent to specifying the ALL keyword.
If the RELATIVE keyword has been used, the <productname>Postgres</productname> If the RELATIVE keyword has been used, the <productname>Postgres</productname>
assumes that the user intended <acronym>SQL92</acronym> behavior assumes that the user intended <acronym>SQL92</acronym> behavior
and returns this error message. and returns this error message.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
...@@ -209,18 +244,20 @@ Negative numbers are now allowed to be specified for the ...@@ -209,18 +244,20 @@ Negative numbers are now allowed to be specified for the
row count. A negative number is equivalent to reversing row count. A negative number is equivalent to reversing
the sense of the FORWARD and BACKWARD keywords. For example, the sense of the FORWARD and BACKWARD keywords. For example,
<command>FORWARD -1</command> is the same as <command>BACKWARD 1</command>. <command>FORWARD -1</command> is the same as <command>BACKWARD 1</command>.
</para>
</tip> </tip>
</para>
<para> <para>
Note that the FORWARD and BACKWARD keywords are Note that the FORWARD and BACKWARD keywords are
<productname>Postgres</productname> extensions. <productname>Postgres</productname> extensions.
The <acronym>SQL92</acronym> syntax is also supported, specified The <acronym>SQL92</acronym> syntax is also supported, specified
in the second form of the command. See below for details in the second form of the command. See below for details
on compatibility issues. on compatibility issues.
</para>
<para> <para>
Once all rows are fetched, every other fetch access returns Once all rows are fetched, every other fetch access returns
no rows. no rows.
</para>
<para> <para>
Updating data in a cursor is not supported by Updating data in a cursor is not supported by
...@@ -229,10 +266,12 @@ on compatibility issues. ...@@ -229,10 +266,12 @@ on compatibility issues.
not generally possible, as is also the case with VIEW updates. not generally possible, as is also the case with VIEW updates.
Consequently, Consequently,
users must issue explicit UPDATE commands to replace data. users must issue explicit UPDATE commands to replace data.
</para>
<para> <para>
Cursors may only be used inside of transactions because Cursors may only be used inside of transactions because
the data that they store spans multiple user queries. the data that they store spans multiple user queries.
</para>
<REFSECT2 ID="R2-SQL-FETCH-3"> <REFSECT2 ID="R2-SQL-FETCH-3">
<REFSECT2INFO> <REFSECT2INFO>
...@@ -246,8 +285,9 @@ Notes ...@@ -246,8 +285,9 @@ Notes
Refer to DECLARE statements to declare a cursor. Refer to DECLARE statements to declare a cursor.
Refer to BEGIN WORK, COMMIT WORK, ROLLBACK WORK statements Refer to BEGIN WORK, COMMIT WORK, ROLLBACK WORK statements
for further information about transactions. for further information about transactions.
</para>
</REFSECT2> </REFSECT2>
</refsect1>
<REFSECT1 ID="R1-SQL-FETCH-2"> <REFSECT1 ID="R1-SQL-FETCH-2">
<TITLE> <TITLE>
...@@ -287,7 +327,7 @@ Usage ...@@ -287,7 +327,7 @@ Usage
CLOSE liahona; CLOSE liahona;
COMMIT WORK; COMMIT WORK;
</ProgramListing> </ProgramListing>
</para>
</REFSECT1> </REFSECT1>
<REFSECT1 ID="R1-SQL-FETCH-3"> <REFSECT1 ID="R1-SQL-FETCH-3">
...@@ -327,7 +367,9 @@ ABSOLUTE ...@@ -327,7 +367,9 @@ ABSOLUTE
The cursor should be positioned to the specified absolute The cursor should be positioned to the specified absolute
row number. All row numbers in <productname>Postgres</productname> row number. All row numbers in <productname>Postgres</productname>
are relative numbers so this capability is not supported. are relative numbers so this capability is not supported.
</para>
</listitem>
</varlistentry>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
:<REPLACEABLE CLASS="PARAMETER">variable</REPLACEABLE> :<REPLACEABLE CLASS="PARAMETER">variable</REPLACEABLE>
...@@ -335,9 +377,13 @@ are relative numbers so this capability is not supported. ...@@ -335,9 +377,13 @@ are relative numbers so this capability is not supported.
<LISTITEM> <LISTITEM>
<PARA> <PARA>
Target host variable(s). Target host variable(s).
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</para>
</refsect2>
</refsect1>
</REFENTRY> </REFENTRY>
<!-- <!--
......
doc/src/sgml/ref/grant.sgml
View file @ a75f2d21
<REFENTRY ID="SQL-GRANT"> <REFENTRY ID="SQL-GRANT">
<REFMETA> <REFMETA>
<REFENTRYTITLE> <REFENTRYTITLE>
GRANT GRANT
</REFENTRYTITLE> </REFENTRYTITLE>
<REFMISCINFO>SQL - Language Statements</REFMISCINFO> <REFMISCINFO>SQL - Language Statements</REFMISCINFO>
</REFMETA> </REFMETA>
<REFNAMEDIV> <REFNAMEDIV>
<REFNAME> <REFNAME>
GRANT GRANT
</REFNAME> </REFNAME>
<REFPURPOSE> <REFPURPOSE>
Grants access privilege to a user, a group or all users Grants access privilege to a user, a group or all users
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-23</DATE> <DATE>1998-09-23</DATE>
</REFSYNOPSISDIVINFO> </REFSYNOPSISDIVINFO>
<SYNOPSIS> <SYNOPSIS>
GRANT <REPLACEABLE CLASS="PARAMETER">privilege</REPLACEABLE> [, ...] GRANT <REPLACEABLE CLASS="PARAMETER">privilege</REPLACEABLE> [, ...]
ON <REPLACEABLE CLASS="PARAMETER">object</REPLACEABLE> [, ...] ON <REPLACEABLE CLASS="PARAMETER">object</REPLACEABLE> [, ...]
TO { PUBLIC | GROUP <REPLACEABLE CLASS="PARAMETER">group</REPLACEABLE> | <REPLACEABLE CLASS="PARAMETER">username</REPLACEABLE> } TO { PUBLIC | GROUP <REPLACEABLE CLASS="PARAMETER">group</REPLACEABLE> | <REPLACEABLE CLASS="PARAMETER">username</REPLACEABLE> }
</SYNOPSIS> </SYNOPSIS>
<REFSECT2 ID="R2-SQL-GRANT-1"> <REFSECT2 ID="R2-SQL-GRANT-1">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-09-23</DATE> <DATE>1998-09-23</DATE>
</REFSECT2INFO> </REFSECT2INFO>
<TITLE> <TITLE>
Inputs Inputs
</TITLE> </TITLE>
<PARA> <PARA>
<VARIABLELIST> <VARIABLELIST>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<REPLACEABLE CLASS="PARAMETER">privilege</REPLACEABLE> <REPLACEABLE CLASS="PARAMETER">privilege</REPLACEABLE>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
The possible privileges are: The possible privileges are:
</para>
<VARIABLELIST> </listitem>
<VARLISTENTRY> </varlistentry>
<TERM> <VARLISTENTRY>
SELECT <TERM>
</TERM> SELECT
<LISTITEM> </TERM>
<PARA> <LISTITEM>
Access all of the columns of a specific <PARA>
table/view. Access all of the columns of a specific
table/view.
<VARLISTENTRY> </para>
<TERM> </listitem>
INSERT </varlistentry>
</TERM>
<LISTITEM> <VARLISTENTRY>
<PARA> <TERM>
Insert data into all columns of a INSERT
specific table. </TERM>
<LISTITEM>
<VARLISTENTRY> <PARA>
<TERM> Insert data into all columns of a
UPDATE specific table.
</TERM> </para>
<LISTITEM> </listitem>
<PARA> </varlistentry>
Update all columns of a specific
table. <VARLISTENTRY>
<TERM>
<VARLISTENTRY> UPDATE
<TERM> </TERM>
DELETE <LISTITEM>
</TERM> <PARA>
<LISTITEM> Update all columns of a specific
<PARA> table.
Delete rows from a specific table. </para>
</listitem>
<VARLISTENTRY> </varlistentry>
<TERM>
RULE <VARLISTENTRY>
</TERM> <TERM>
<LISTITEM> DELETE
<PARA> </TERM>
Define rules on the table/view <LISTITEM>
(See CREATE RULE statement). <PARA>
Delete rows from a specific table.
<VARLISTENTRY> </para>
<TERM> </listitem>
ALL </varlistentry>
</TERM>
<LISTITEM> <VARLISTENTRY>
<PARA> <TERM>
Grant all privileges. RULE
</TERM>
</VARIABLELIST> <LISTITEM>
<PARA>
<VARLISTENTRY> Define rules on the table/view
<TERM> (See CREATE RULE statement).
<REPLACEABLE CLASS="PARAMETER">object</REPLACEABLE> </para>
</TERM> </listitem>
<LISTITEM> </varlistentry>
<PARA>
The name of an object to which to grant access. <VARLISTENTRY>
The possible objects are: <TERM>
ALL
<itemizedlist mark="bullet" spacing="compact"> </TERM>
<listitem> <LISTITEM>
<para> <PARA>
table Grant all privileges.
</para>
<listitem> </listitem>
<para> </varlistentry>
view
<VARLISTENTRY>
<listitem> <TERM>
<para> <REPLACEABLE CLASS="PARAMETER">object</REPLACEABLE>
sequence </TERM>
<LISTITEM>
<listitem> <PARA>
<para> The name of an object to which to grant access.
index The possible objects are:
</itemizedlist> </para>
<VARLISTENTRY> <para>
<TERM> <itemizedlist mark="bullet" spacing="compact">
PUBLIC <listitem>
</TERM> <para>
<LISTITEM> table
<PARA> </para>
A short form representing all users. </listitem>
<VARLISTENTRY> <listitem>
<TERM> <para>
GROUP <REPLACEABLE CLASS="PARAMETER">group</REPLACEABLE> view
</TERM> </para>
<LISTITEM> </listitem>
<PARA>
A <REPLACEABLE CLASS="PARAMETER">group</REPLACEABLE> to whom to grant privileges. <listitem>
In the current release, the group must be created explicitly as described below. <para>
sequence
<VARLISTENTRY> </para>
<TERM> </listitem>
<REPLACEABLE CLASS="PARAMETER">username</REPLACEABLE>
</TERM> <listitem>
<LISTITEM> <para>
<PARA> index
The name of a user to whom grant privileges. PUBLIC is a short form </para>
representing all users. </listitem>
</itemizedlist>
</VARIABLELIST> </para>
</listitem>
</REFSECT2> </varlistentry>
<REFSECT2 ID="R2-SQL-GRANT-2"> <VARLISTENTRY>
<REFSECT2INFO> <TERM>
<DATE>1998-09-23</DATE> PUBLIC
</REFSECT2INFO> </TERM>
<TITLE> <LISTITEM>
Outputs <PARA>
</TITLE> A short form representing all users.
<PARA> </para>
</listitem>
<VARIABLELIST> </varlistentry>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
CHANGE GROUP <REPLACEABLE CLASS="PARAMETER">group</REPLACEABLE>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
Message returned if successful. A <REPLACEABLE CLASS="PARAMETER">group</REPLACEABLE> to whom to grant privileges.
In the current release, the group must be created explicitly as described below.
<VARLISTENTRY> </para>
<TERM> </listitem>
ERROR: ChangeAcl: class "<REPLACEABLE CLASS="PARAMETER">object</REPLACEABLE>" </varlistentry>
not found
</TERM> <VARLISTENTRY>
<LISTITEM> <TERM>
<PARA> <REPLACEABLE CLASS="PARAMETER">username</REPLACEABLE>
Message returned if the specified object is not available or </TERM>
if it is impossible <LISTITEM>
to give privileges to the specified group or users. <PARA>
The name of a user to whom grant privileges. PUBLIC is a short form
</VARIABLELIST> representing all users.
</para>
</REFSECT2> </listitem>
</REFSYNOPSISDIV> </varlistentry>
</VARIABLELIST>
<REFSECT1 ID="R1-SQL-GRANT-1"> </para>
<REFSECT1INFO> </REFSECT2>
<DATE>1998-09-23</DATE>
</REFSECT1INFO> <REFSECT2 ID="R2-SQL-GRANT-2">
<TITLE> <REFSECT2INFO>
Description <DATE>1998-09-23</DATE>
</TITLE> </REFSECT2INFO>
<PARA> <TITLE>
GRANT allows the creator of an object to give specific permissions to Outputs
all users (PUBLIC) or to a certain user or group. </TITLE>
Users other than the creator don't have any access permission <PARA>
unless the creator GRANTs permissions, after the object
is created. <VARIABLELIST>
<VARLISTENTRY>
<para> <TERM>
Once a user has a privilege on an object, he is enabled to exercise CHANGE
that privilege. </TERM>
There is no need to GRANT privileges to the creator of <LISTITEM>
an object, the creator automatically holds ALL privileges, and can <PARA>
also drop the object. Message returned if successful.
</para>
<REFSECT2 ID="R2-SQL-GRANT-3"> </listitem>
<REFSECT2INFO> </varlistentry>
<DATE>1998-09-23</DATE>
</REFSECT2INFO> <VARLISTENTRY>
<TITLE> <TERM>
Notes ERROR: ChangeAcl: class "<REPLACEABLE CLASS="PARAMETER">object</REPLACEABLE>"
</TITLE> not found
<PARA> </TERM>
Use the <command>psql \z</command> command <LISTITEM>
for further information about permissions <PARA>
on existing objects: Message returned if the specified object is not available or
<programlisting> if it is impossible
Database = lusitania to give privileges to the specified group or users.
</para>
</listitem>
</varlistentry>
</VARIABLELIST>
</para>
</REFSECT2>
</REFSYNOPSISDIV>
<REFSECT1 ID="R1-SQL-GRANT-1">
<REFSECT1INFO>
<DATE>1998-09-23</DATE>
</REFSECT1INFO>
<TITLE>
Description
</TITLE>
<PARA>
GRANT allows the creator of an object to give specific permissions to
all users (PUBLIC) or to a certain user or group.
Users other than the creator don't have any access permission
unless the creator GRANTs permissions, after the object
is created.
</para>
<para>
Once a user has a privilege on an object, he is enabled to exercise
that privilege.
There is no need to GRANT privileges to the creator of
an object, the creator automatically holds ALL privileges, and can
also drop the object.
</para>
<REFSECT2 ID="R2-SQL-GRANT-3">
<REFSECT2INFO>
<DATE>1998-09-23</DATE>
</REFSECT2INFO>
<TITLE>
Notes
</TITLE>
<PARA>
Use the <command>psql \z</command> command
for further information about permissions
on existing objects:
<programlisting>
Database = lusitania
+------------------+---------------------------------------------+ +------------------+---------------------------------------------+
| Relation | Grant/Revoke Permissions | | Relation | Grant/Revoke Permissions |
+------------------+---------------------------------------------+ +------------------+---------------------------------------------+
...@@ -236,177 +280,211 @@ Use the <command>psql \z</command> command ...@@ -236,177 +280,211 @@ Use the <command>psql \z</command> command
a -- INSERT a -- INSERT
R -- RULE R -- RULE
arwR -- ALL arwR -- ALL
</programlisting> </programlisting>
<tip> <tip>
<para> <para>
Currently, to create a GROUP you have to insert Currently, to create a GROUP you have to insert
data manually into table pg_group as: data manually into table pg_group as:
<programlisting> <programlisting>
INSERT INTO pg_group VALUES ('todos'); INSERT INTO pg_group VALUES ('todos');
CREATE USER miriam IN GROUP todos; CREATE USER miriam IN GROUP todos;
</programlisting> </programlisting>
Refer to REVOKE statements to revoke access privileges. Refer to REVOKE statements to revoke access privileges.
</tip> </para>
</tip>
</REFSECT2> </para>
</REFSECT2>
<REFSECT1 ID="R1-SQL-GRANT-2"> </refsect1>
<TITLE>
Usage <REFSECT1 ID="R1-SQL-GRANT-2">
</TITLE> <TITLE>
<PARA> Usage
<ProgramListing> </TITLE>
-- grant insert privilege to all users on table films: <PARA>
-- <ProgramListing>
GRANT INSERT ON films TO PUBLIC; -- grant insert privilege to all users on table films:
</programlisting> --
GRANT INSERT ON films TO PUBLIC;
<programlisting> </programlisting>
-- grant all privileges to user manuel on view kinds:
-- <programlisting>
GRANT ALL ON kinds TO manuel; -- grant all privileges to user manuel on view kinds:
</ProgramListing> --
GRANT ALL ON kinds TO manuel;
</REFSECT1> </ProgramListing>
</para>
<REFSECT1 ID="R1-SQL-GRANT-3"> </REFSECT1>
<TITLE>
Compatibility <REFSECT1 ID="R1-SQL-GRANT-3">
</TITLE> <TITLE>
<PARA> Compatibility
</PARA> </TITLE>
<PARA>
<REFSECT2 ID="R2-SQL-GRANT-4"> </PARA>
<REFSECT2INFO>
<DATE>1998-09-23</DATE> <REFSECT2 ID="R2-SQL-GRANT-4">
</REFSECT2INFO> <REFSECT2INFO>
<TITLE> <DATE>1998-09-23</DATE>
SQL92 </REFSECT2INFO>
</TITLE> <TITLE>
<PARA> SQL92
The <acronym>SQL92</acronym> syntax for GRANT allows setting privileges </TITLE>
for individual columns <PARA>
within a table, and allows setting a privilege to grant The <acronym>SQL92</acronym> syntax for GRANT allows setting privileges
the same privileges to others. for individual columns
within a table, and allows setting a privilege to grant
<SYNOPSIS> the same privileges to others.
GRANT <REPLACEABLE CLASS="PARAMETER">privilege</REPLACEABLE> [, ...]
ON <REPLACEABLE CLASS="PARAMETER">object</REPLACEABLE> [ ( <REPLACEABLE CLASS="PARAMETER">column</REPLACEABLE> [, ...] ) ] [, ...] <SYNOPSIS>
TO { PUBLIC | <REPLACEABLE CLASS="PARAMETER">username</REPLACEABLE> [, ...] } GRANT <REPLACEABLE CLASS="PARAMETER">privilege</REPLACEABLE> [, ...]
[ WITH GRANT OPTION ] ON <REPLACEABLE CLASS="PARAMETER">object</REPLACEABLE> [ ( <REPLACEABLE CLASS="PARAMETER">column</REPLACEABLE> [, ...] ) ] [, ...]
</SYNOPSIS> TO { PUBLIC | <REPLACEABLE CLASS="PARAMETER">username</REPLACEABLE> [, ...] }
[ WITH GRANT OPTION ]
Fields are compatible with the those in the <acronym>Postgres</acronym> </SYNOPSIS>
implementation, with the following additions:
Fields are compatible with the those in the <acronym>Postgres</acronym>
<VARIABLELIST> implementation, with the following additions:
<VARLISTENTRY>
<TERM> <VARIABLELIST>
<REPLACEABLE CLASS="PARAMETER">privilege</REPLACEABLE> <VARLISTENTRY>
SELECT <TERM>
</TERM> <REPLACEABLE CLASS="PARAMETER">privilege</REPLACEABLE>
<LISTITEM> SELECT
<PARA> </TERM>
<acronym>SQL92</acronym> permits additional privileges to be specified: <LISTITEM>
<PARA>
<VARIABLELIST> <acronym>SQL92</acronym> permits additional privileges to be specified:
<VARLISTENTRY> </para>
<TERM> </listitem>
REFERENCES </varlistentry>
</TERM>
<LISTITEM> <VARLISTENTRY>
<PARA> <TERM>
Allowed to reference some or all of the columns of a specific REFERENCES
table/view in integrity constraints. </TERM>
<LISTITEM>
<VARLISTENTRY> <PARA>
<TERM> Allowed to reference some or all of the columns of a specific
USAGE table/view in integrity constraints.
</TERM> </para>
<LISTITEM> </listitem>
<PARA> </varlistentry>
Allowed to use a domain, character set, collation
or translation. <VARLISTENTRY>
If an object specifies anything other than a table/view, <TERM>
<REPLACEABLE CLASS="PARAMETER">privilege</REPLACEABLE> USAGE
must specify only USAGE. </TERM>
<LISTITEM>
</variablelist> <PARA>
Allowed to use a domain, character set, collation
<tip> or translation.
<para> If an object specifies anything other than a table/view,
Currently, to grant privileges in <productname>Postgres</productname> <REPLACEABLE CLASS="PARAMETER">privilege</REPLACEABLE>
to only few columns, you must must specify only USAGE.
create a view having desired columns and then grant privileges </para>
to that view. </listitem>
</tip> </varlistentry>
<VARLISTENTRY> </variablelist>
<TERM>
<REPLACEABLE CLASS="PARAMETER">object</REPLACEABLE> <tip>
</TERM> <para>
<LISTITEM> Currently, to grant privileges in <productname>Postgres</productname>
<PARA> to only few columns, you must
create a view having desired columns and then grant privileges
<variablelist> to that view.
<VARLISTENTRY> </para>
<TERM> </tip>
<REPLACEABLE CLASS="PARAMETER">object</REPLACEABLE>
</TERM> <variablelist>
<LISTITEM> <VARLISTENTRY>
<PARA> <TERM>
<acronym>SQL92</acronym> allows an additional non-functional keyword: <REPLACEABLE CLASS="PARAMETER">object</REPLACEABLE>
</TERM>
<simplelist> <LISTITEM>
<member> <PARA>
[ TABLE ] table
</simplelist> <variablelist>
<VARLISTENTRY>
<VARLISTENTRY> <TERM>
<TERM> <REPLACEABLE CLASS="PARAMETER">object</REPLACEABLE>
CHARACTER SET </TERM>
</TERM> <LISTITEM>
<LISTITEM> <PARA>
<PARA> <acronym>SQL92</acronym> allows an additional non-functional keyword:
Allowed to use the specified character set.
<simplelist>
<VARLISTENTRY> <member>
<TERM> [ TABLE ] table
COLLATION </member>
</TERM> </simplelist>
<LISTITEM> </para>
<PARA> </listitem>
Allowed to use the specified collation sequence. </varlistentry>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
TRANSLATION CHARACTER SET
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
Allowed to use the specified character set translation. Allowed to use the specified character set.
</para>
<VARLISTENTRY> </listitem>
<TERM> </varlistentry>
DOMAIN
</TERM> <VARLISTENTRY>
<LISTITEM> <TERM>
<PARA> COLLATION
Allowed to use the specified domain. </TERM>
<LISTITEM>
</variablelist> <PARA>
Allowed to use the specified collation sequence.
</para>
<VARLISTENTRY> </listitem>
<TERM> </varlistentry>
WITH GRANT OPTION
</TERM> <VARLISTENTRY>
<LISTITEM> <TERM>
<PARA> TRANSLATION
Allowed to grant the same privilege to others. </TERM>
<LISTITEM>
</variablelist> <PARA>
Allowed to use the specified character set translation.
</para>
</listitem>
</varlistentry>
<VARLISTENTRY>
<TERM>
DOMAIN
</TERM>
<LISTITEM>
<PARA>
Allowed to use the specified domain.
</para>
</listitem>
</varlistentry>
<VARLISTENTRY>
<TERM>
WITH GRANT OPTION
</TERM>
<LISTITEM>
<PARA>
Allowed to grant the same privilege to others.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect2>
</refsect1>
</REFENTRY> </REFENTRY>
<!-- <!--
......
doc/src/sgml/ref/initdb.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ ...@@ -12,6 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Create a new <productname>Postgres</productname> database installation Create a new <productname>Postgres</productname> database installation
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-10-02</DATE> <DATE>1998-10-02</DATE>
...@@ -24,256 +25,289 @@ initdb [ --pgdata=<replaceable class="parameter">dbdir</replaceable> | -r <repla ...@@ -24,256 +25,289 @@ initdb [ --pgdata=<replaceable class="parameter">dbdir</replaceable> | -r <repla
[ --noclean | -n ] [ --debug | -d ] [ --noclean | -n ] [ --debug | -d ]
</SYNOPSIS> </SYNOPSIS>
<REFSECT2 ID="R2-APP-INITDB-1"> <REFSECT2 ID="R2-APP-INITDB-1">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-10-02</DATE> <DATE>1998-10-02</DATE>
</REFSECT2INFO> </REFSECT2INFO>
<TITLE> <TITLE>
Inputs Inputs
</TITLE> </TITLE>
<PARA> <PARA>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>
--pglib=<replaceable class="parameter">libdir</replaceable> --pglib=<replaceable class="parameter">libdir</replaceable>
</term> </term>
<term> <term>
-l <replaceable class="parameter">libdir</replaceable> -l <replaceable class="parameter">libdir</replaceable>
</term> </term>
<term> <term>
<envar>PGLIB</envar> <envar>PGLIB</envar>
<listitem> </term>
<para> <listitem>
Where are the files that make up <productname>Postgres</productname>? <para>
Apart from files that Where are the files that make up <productname>Postgres</productname>?
have to go in particular directories because of their function, the Apart from files that
files that make up the <productname>Postgres</productname> software have to go in particular directories because of their function, the
were installed in a directory files that make up the <productname>Postgres</productname> software
called the <replaceable class="parameter">libdir</replaceable> directory. were installed in a directory
An example of a file that will be found called the <replaceable class="parameter">libdir</replaceable> directory.
there that <application>initdb</application> An example of a file that will be found
needs is <filename>global1.bki.source</filename>, there that <application>initdb</application>
which contains all the information that goes needs is <filename>global1.bki.source</filename>,
into the shared catalog tables. which contains all the information that goes
into the shared catalog tables.
<varlistentry> </para>
<term> </listitem>
--pgdata=<replaceable class="parameter">dbdir</replaceable> </varlistentry>
</term>
<term> <varlistentry>
-r <replaceable class="parameter">dbdir</replaceable> <term>
</term> --pgdata=<replaceable class="parameter">dbdir</replaceable>
<term> </term>
<envar>PGDATA</envar> <term>
</term> -r <replaceable class="parameter">dbdir</replaceable>
<listitem> </term>
<para> <term>
Where in your Unix filesystem do you want the database data to go? <envar>PGDATA</envar>
The top level directory is called the <envar>PGDATA</envar> directory. </term>
<listitem>
<varlistentry> <para>
<term> Where in your Unix filesystem do you want the database data to go?
--username=<replaceable class="parameter">name</replaceable> The top level directory is called the <envar>PGDATA</envar> directory.
</term> </para>
<term> </listitem>
-u <replaceable class="parameter">name</replaceable> </varlistentry>
</term>
<term> <varlistentry>
<envar>PGUSER</envar> <term>
</term> --username=<replaceable class="parameter">name</replaceable>
<listitem> </term>
<para> <term>
Who will be the <productname>Postgres</productname> superuser -u <replaceable class="parameter">name</replaceable>
for this database system? The </term>
<productname>Postgres</productname> superuser is a Unix user <term>
who owns all files that store the database <envar>PGUSER</envar>
system and also owns the postmaster and backend processes that access them. </term>
Or just let it default to you (the Unix user who runs <listitem>
<application>initdb</application>). <para>
Who will be the <productname>Postgres</productname> superuser
<note> for this database system? The
<para> <productname>Postgres</productname> superuser is a Unix user
Only the Unix superuser (<literal>root</literal>) who owns all files that store the database
can create a database system with an owner system and also owns the postmaster and backend processes that access them.
different from the <productname>Postgres</productname> superuser. Or just let it default to you (the Unix user who runs
</note> <application>initdb</application>).
</para>
</variablelist> <note>
<para>
<para> Only the Unix superuser (<literal>root</literal>)
Other, less commonly used, parameters are also available: can create a database system with an owner
different from the <productname>Postgres</productname> superuser.
<variablelist> </para>
<varlistentry> </note>
<term> </listitem>
--template=<replaceable class="parameter">template</replaceable> </varlistentry>
</term> </variablelist>
<term> </para>
-t <replaceable class="parameter">template</replaceable> <para>
</term> Other, less commonly used, parameters are also available:
<listitem>
<para> <variablelist>
Replace the <literal>template1</literal> <varlistentry>
database in an existing database system, and don't touch anything else. <term>
This is useful when you need to upgrade your <literal>template1</literal> --template=<replaceable class="parameter">template</replaceable>
database using <application>initdb</application> </term>
from a newer release of <productname>Postgres</productname>, <term>
or when your <literal>template1</literal> -t <replaceable class="parameter">template</replaceable>
database has become corrupted by some system problem. Normally the </term>
contents of <literal>template1</literal> <listitem>
remain constant throughout the life of the database system. You can't <para>
destroy anything by running <application>initdb</application> Replace the <literal>template1</literal>
with the database in an existing database system, and don't touch anything else.
<option>--template</option> This is useful when you need to upgrade your <literal>template1</literal>
option. database using <application>initdb</application>
from a newer release of <productname>Postgres</productname>,
<varlistentry> or when your <literal>template1</literal>
<term> database has become corrupted by some system problem. Normally the
--noclean contents of <literal>template1</literal>
</term> remain constant throughout the life of the database system. You can't
<term> destroy anything by running <application>initdb</application>
-n with the
</term> <option>--template</option>
<listitem> option.
<para> </para>
By default, when <application>initdb</application> </listitem>
determines that error prevent it from completely creating the database </varlistentry>
system, it removes any files it may have created before determining
that it can't finish the job. That includes any core files left by <varlistentry>
the programs it invokes. This option inhibits any tidying-up and is <term>
thus useful for debugging. --noclean
</term>
<varlistentry> <term>
<term> -n
--debug </term>
</term> <listitem>
<term> <para>
-d By default, when <application>initdb</application>
</term> determines that error prevent it from completely creating the database
<listitem> system, it removes any files it may have created before determining
<para> that it can't finish the job. That includes any core files left by
Print debugging output from the bootstrap backend. the programs it invokes. This option inhibits any tidying-up and is
The bootstrap backend is the program <application>initdb</application> thus useful for debugging.
uses to create the catalog tables. This option generates a tremendous </para>
amount of output. It also turns off the final vacuuming step. </listitem>
</varlistentry>
</variablelist>
<varlistentry>
<para> <term>
Files are also input to <application>initdb</application>: --debug
</term>
<variablelist> <term>
<varlistentry> -d
<term> </term>
<application>postconfig</application> <listitem>
</term> <para>
<listitem> Print debugging output from the bootstrap backend.
<para> The bootstrap backend is the program <application>initdb</application>
If appearing somewhere in the Unix command search path uses to create the catalog tables. This option generates a tremendous
(defined by the PATH environment variable). amount of output. It also turns off the final vacuuming step.
This is a program that specifies defaults for some of the </para>
command options. See below. </listitem>
</varlistentry>
<varlistentry>
<term> </variablelist>
<filename><envar>PGLIB</envar>/global1.bki.source</filename> </para>
</term> <para>
<listitem> Files are also input to <application>initdb</application>:
<para>
Contents for the shared catalog tables in the new database system. This <variablelist>
file is part of the <productname>Postgres</productname> software. <varlistentry>
<term>
<varlistentry> <application>postconfig</application>
<term> </term>
<filename><envar>PGLIB</envar>/local1_template1.bki.source</filename> <listitem>
</term> <para>
<listitem> If appearing somewhere in the Unix command search path
<para> (defined by the PATH environment variable).
Contents for the template1 tables in the new database system. This This is a program that specifies defaults for some of the
file is part of the <productname>Postgres</productname> software. command options. See below.
</para>
</variablelist> </listitem>
</varlistentry>
<REFSECT2 ID="R2-APP-INITDB-2">
<REFSECT2INFO> <varlistentry>
<DATE>1998-09-26</DATE> <term>
</REFSECT2INFO> <filename><envar>PGLIB</envar>/global1.bki.source</filename>
<TITLE> </term>
Outputs <listitem>
</TITLE> <para>
<PARA> Contents for the shared catalog tables in the new database system. This
<application>initdb</application> will create files in the <envar>PGDATA</envar> file is part of the <productname>Postgres</productname> software.
data area which are the system tables and framework for a complete </para>
installation. </listitem>
</varlistentry>
<REFSECT1 ID="R1-APP-INITDB-1">
<REFSECT1INFO> <varlistentry>
<DATE>1998-09-26</DATE> <term>
</REFSECT1INFO> <filename><envar>PGLIB</envar>/local1_template1.bki.source</filename>
<TITLE> </term>
Description <listitem>
</TITLE> <para>
<PARA> Contents for the template1 tables in the new database system. This
<application>initdb</application> creates a new file is part of the <productname>Postgres</productname> software.
<productname>Postgres</productname> database system. </para>
A database system is a </listitem>
collection of databases that are all administered by the same Unix user </varlistentry>
and managed by a single postmaster.
</variablelist>
<para> </para>
Creating a database system consists of creating the directories in which </refsect2>
the database data will live, generating the shared catalog tables
(tables that don't belong to any particular database), and
creating the <literal>template1</literal>
database. What is the <literal>template1</literal>
database? When you create a database, <productname>Postgres</productname>
does it by copying
everything from the <literal>template1</literal>
database. It contains catalog tables filled in for things like the
builtin types.
<para>
After <application>initdb</application>
creates the database, it completes the initialization by running
<application>vacuum</application>, which resets some optimization parameters.
<para>
There are three ways to give parameters to <application>initdb</application>.
First, you can use <application>initdb</application> command options.
Second, you can set environment
variables before invoking <application>initdb</application>.
Third, you can have a program called <application>postconfig</application>
in your Unix command search path.
<application>initdb</application> invokes that program and that program then writes
<application>initdb</application> parameters to its standard output stream.
This third option is not a common thing to do, however.
<para>
Command options always override parameters specified any other way.
The values returned by <application>postconfig</application>
override any environment variables, but your
<application>postconfig</application>
program may base its output on the environment variables if you want
their values to be used.
<para>
The value that <application>postconfig</application>
outputs must have the format
<programlisting>
<replaceable>var1</replaceable>=<replaceable class="parameter">value1</replaceable> <replaceable>var2</replaceable>=<replaceable class="parameter">value2</replaceable> ...
</programlisting>
It can output nothing if it doesn't want to supply any parameters. <REFSECT2 ID="R2-APP-INITDB-2">
The <replaceable>var</replaceable> values are equal to <REFSECT2INFO>
the corresponding environment variable <DATE>1998-09-26</DATE>
names. For example, </REFSECT2INFO>
<programlisting> <TITLE>
PGDATA=/tmp/postgres_test Outputs
</programlisting> </TITLE>
has the <PARA>
same effect as invoking <application>initdb</application> <application>initdb</application> will create files in the <envar>PGDATA</envar>
with an environment variable called <envar>PGDATA</envar> whose value is data area which are the system tables and framework for a complete
<filename>/tmp/postgres_test</filename>. installation.
</para>
</refsect2>
</refsynopsisdiv>
<REFSECT1 ID="R1-APP-INITDB-1">
<REFSECT1INFO>
<DATE>1998-09-26</DATE>
</REFSECT1INFO>
<TITLE>
Description
</TITLE>
<PARA>
<application>initdb</application> creates a new
<productname>Postgres</productname> database system.
A database system is a
collection of databases that are all administered by the same Unix user
and managed by a single postmaster.
</para>
<para>
Creating a database system consists of creating the directories in which
the database data will live, generating the shared catalog tables
(tables that don't belong to any particular database), and
creating the <literal>template1</literal>
database. What is the <literal>template1</literal>
database? When you create a database, <productname>Postgres</productname>
does it by copying
everything from the <literal>template1</literal>
database. It contains catalog tables filled in for things like the
builtin types.
</para>
<para>
After <application>initdb</application>
creates the database, it completes the initialization by running
<application>vacuum</application>, which resets some optimization parameters.
</para>
<para>
There are three ways to give parameters to <application>initdb</application>.
First, you can use <application>initdb</application> command options.
Second, you can set environment
variables before invoking <application>initdb</application>.
Third, you can have a program called <application>postconfig</application>
in your Unix command search path.
<application>initdb</application> invokes that program and that program then writes
<application>initdb</application> parameters to its standard output stream.
This third option is not a common thing to do, however.
</para>
<para>
Command options always override parameters specified any other way.
The values returned by <application>postconfig</application>
override any environment variables, but your
<application>postconfig</application>
program may base its output on the environment variables if you want
their values to be used.
</para>
<para>
The value that <application>postconfig</application>
outputs must have the format
<programlisting>
<replaceable>var1</replaceable>=<replaceable class="parameter">value1</replaceable> <replaceable>var2</replaceable>=<replaceable class="parameter">value2</replaceable> ...
</programlisting>
It can output nothing if it doesn't want to supply any parameters.
The <replaceable>var</replaceable> values are equal to
the corresponding environment variable
names. For example,
<programlisting>
PGDATA=/tmp/postgres_test
</programlisting>
has the
same effect as invoking <application>initdb</application>
with an environment variable called <envar>PGDATA</envar> whose value is
<filename>/tmp/postgres_test</filename>.
</para>
</refsect1>
</REFENTRY> </REFENTRY>
doc/src/sgml/ref/initlocation.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ ...@@ -12,6 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Create a secondary <productname>Postgres</productname> database storage area Create a secondary <productname>Postgres</productname> database storage area
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-10-02</DATE> <DATE>1998-10-02</DATE>
...@@ -22,180 +23,206 @@ initlocation [ --location=<replaceable class="parameter">altdir</replaceable> | ...@@ -22,180 +23,206 @@ initlocation [ --location=<replaceable class="parameter">altdir</replaceable> |
[ <replaceable class="parameter">altdir</replaceable> ] [ <replaceable class="parameter">altdir</replaceable> ]
</SYNOPSIS> </SYNOPSIS>
<REFSECT2 ID="R2-APP-INITLOCATION-1"> <REFSECT2 ID="R2-APP-INITLOCATION-1">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-10-02</DATE> <DATE>1998-10-02</DATE>
</REFSECT2INFO> </REFSECT2INFO>
<TITLE> <TITLE>
Inputs Inputs
</TITLE> </TITLE>
<PARA> <PARA>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>
--location=<replaceable class="parameter">altdir</replaceable> --location=<replaceable class="parameter">altdir</replaceable>
</term> </term>
<term> <term>
-D <replaceable class="parameter">altdir</replaceable> -D <replaceable class="parameter">altdir</replaceable>
</term> </term>
<term> <term>
<replaceable class="parameter">altdir</replaceable> <replaceable class="parameter">altdir</replaceable>
</term> </term>
<listitem> <listitem>
<para> <para>
Where in your Unix filesystem do you want alternate databases to go? Where in your Unix filesystem do you want alternate databases to go?
The top level directory is called the <envar>PGDATA</envar> directory, so you The top level directory is called the <envar>PGDATA</envar> directory, so you
might want to point your first alternate location at <envar>PGDATA2</envar>. might want to point your first alternate location at <envar>PGDATA2</envar>.
</para>
<varlistentry> </listitem>
<term> </varlistentry>
--username=<replaceable class="parameter">name</replaceable>
</term> <varlistentry>
<term> <term>
-u <replaceable class="parameter">name</replaceable> --username=<replaceable class="parameter">name</replaceable>
</term> </term>
<term> <term>
<envar>PGUSER</envar> -u <replaceable class="parameter">name</replaceable>
</term> </term>
<listitem> <term>
<para> <envar>PGUSER</envar>
Who will be the Unix filesystem owner of this database storage area? </term>
The <listitem>
<productname>Postgres</productname> superuser is a Unix user <para>
who owns all files that store the database Who will be the Unix filesystem owner of this database storage area?
system and also owns the postmaster and backend processes that access them. The
Usually, this is the user who should run <application>initlocation</application> <productname>Postgres</productname> superuser is a Unix user
and who will thus have ownership of the directories and files. who owns all files that store the database
system and also owns the postmaster and backend processes that access them.
<note> Usually, this is the user who should run <application>initlocation</application>
<para> and who will thus have ownership of the directories and files.
Only the Unix superuser can create a database system with a </para>
different user as the <productname>Postgres</productname> superuser. <note>
Specifying a user other than the <productname>Postgres</productname> superuser <para>
may lead to database security and data integrity problems. Refer to the Only the Unix superuser can create a database system with a
<citetitle><productname>PostgreSQL</productname> Administrator's Guide</citetitle> different user as the <productname>Postgres</productname> superuser.
for more information. Specifying a user other than the <productname>Postgres</productname> superuser
</note> may lead to database security and data integrity problems. Refer to the
<citetitle><productname>PostgreSQL</productname> Administrator's Guide</citetitle>
</variablelist> for more information.
</para>
<REFSECT2 ID="R2-APP-INITLOCATION-2"> </note>
<REFSECT2INFO> </listitem>
<DATE>1998-09-26</DATE> </varlistentry>
</REFSECT2INFO>
<TITLE> </variablelist>
Outputs </para>
</TITLE> </refsect2>
<PARA>
<application>initlocation</application> will create directories in <REFSECT2 ID="R2-APP-INITLOCATION-2">
the specified place. <REFSECT2INFO>
<DATE>1998-09-26</DATE>
<variablelist> </REFSECT2INFO>
<varlistentry> <TITLE>
<term> Outputs
We are initializing the database area with username postgres (uid=500). </TITLE>
This user will own all the files and must also own the server process. <PARA>
Creating Postgres database system directory <replaceable class="parameter">altdir</replaceable> <application>initlocation</application> will create directories in
Creating Postgres database system directory <replaceable class="parameter">altdir</replaceable> the specified place.
</term>
<listitem> <variablelist>
<para> <varlistentry>
Successful completion. <term>
We are initializing the database area with username postgres (uid=500).
<varlistentry> This user will own all the files and must also own the server process.
<term> Creating Postgres database system directory <replaceable class="parameter">altdir</replaceable>
We are initializing the database area with username postgres (uid=500). Creating Postgres database system directory <replaceable class="parameter">altdir</replaceable>
This user will own all the files and must also own the server process. </term>
Creating Postgres database system directory /usr/local/src/testlocation <listitem>
mkdir: cannot make directory `<replaceable class="parameter">altdir</replaceable>': Permission denied <para>
</term> Successful completion.
<listitem> </para>
<para> </listitem>
You do not have filesystem permission to write to the specified directory area. </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
Valid username not given. You must specify the username for We are initializing the database area with username postgres (uid=500).
the Postgres superuser for the database system you are This user will own all the files and must also own the server process.
initializing, either with the --username option or by default Creating Postgres database system directory /usr/local/src/testlocation
to the USER environment variable. mkdir: cannot make directory `<replaceable class="parameter">altdir</replaceable>': Permission denied
</term> </term>
<listitem> <listitem>
<para> <para>
The username which you have specified is not the You do not have filesystem permission to write to the specified directory area.
<productname>Postgres</productname> superuser. </para>
</listitem>
<varlistentry> </varlistentry>
<term>
Can't tell what username to use. You don't have the USER <varlistentry>
environment variable set to your username and didn't specify the <term>
--username option Valid username not given. You must specify the username for
</term> the Postgres superuser for the database system you are
<listitem> initializing, either with the --username option or by default
<para> to the USER environment variable.
Specify the <option>--username</option> command line option. </term>
<listitem>
</variablelist> <para>
The username which you have specified is not the
<REFSECT1 ID="R1-APP-INITLOCATION-1"> <productname>Postgres</productname> superuser.
<REFSECT1INFO> </para>
<DATE>1998-09-26</DATE> </listitem>
</REFSECT1INFO> </varlistentry>
<TITLE>
Description <varlistentry>
</TITLE> <term>
<PARA> Can't tell what username to use. You don't have the USER
<application>initlocation</application> environment variable set to your username and didn't specify the
creates a new <productname>Postgres</productname> secondary database storage area. --username option
A secondary storage area contains a required tree of directories with </term>
the correct file permissions on those directories. <listitem>
<para>
<para> Specify the <option>--username</option> command line option.
Creating a database storage area consists of creating the directories in which </para>
database data might live. </listitem>
</varlistentry>
<para>
There are two kinds of arguments for <application>initlocation</application>. </variablelist>
First, you can specify an environment variable (e.g. <envar>PGDATA2</envar>). </para>
This environment variable should be known to the backend for later use in </refsect2>
<command>CREATE DATABASE/WITH LOCATION</command> </refsynopsisdiv>
or
<command>createdb -D <replaceable class="parameter">altdir</replaceable></command>. <REFSECT1 ID="R1-APP-INITLOCATION-1">
However, <emphasis>the backend daemon must have this variable in it's <REFSECT1INFO>
environment</emphasis> for this to succeed. <DATE>1998-09-26</DATE>
</REFSECT1INFO>
Second, you may be able to specify an explicit <TITLE>
absolute path to the top directory of the storage area. However,this second Description
option is possible only if explicitly enabled during the </TITLE>
<productname>Postgres</productname> installation. It is usually disabled <PARA>
to alleviate security and data integrity concerns. <application>initlocation</application>
creates a new <productname>Postgres</productname> secondary database storage area.
<note> A secondary storage area contains a required tree of directories with
<para> the correct file permissions on those directories.
<productname>Postgres</productname> will add <filename>/base/</filename> </para>
to the specified path to create the storage area. <para>
Creating a database storage area consists of creating the directories in which
<para> database data might live.
The backend requires that any argument to <option>WITH LOCATION</option> which is </para>
in all uppercase and which has no path delimiters is an environment variable. <para>
</note> There are two kinds of arguments for <application>initlocation</application>.
First, you can specify an environment variable (e.g. <envar>PGDATA2</envar>).
<REFSECT1 ID="R1-APP-INITLOCATION-2"> This environment variable should be known to the backend for later use in
<REFSECT1INFO> <command>CREATE DATABASE/WITH LOCATION</command>
<DATE>1998-09-26</DATE> or
</REFSECT1INFO> <command>createdb -D <replaceable class="parameter">altdir</replaceable></command>.
<TITLE> However, <emphasis>the backend daemon must have this variable in it's
Usage environment</emphasis> for this to succeed.
</TITLE>
<PARA> Second, you may be able to specify an explicit
To create a database in an alternate location, using an environment variable: absolute path to the top directory of the storage area. However,this second
option is possible only if explicitly enabled during the
<programlisting> <productname>Postgres</productname> installation. It is usually disabled
% setenv PGDATA2 /opt/postgres/data to alleviate security and data integrity concerns.
</para>
% initlocation PGDATA2 <note>
% createdb -D PGDATA2 <para>
</programlisting> <productname>Postgres</productname> will add <filename>/base/</filename>
to the specified path to create the storage area.
</para>
<para>
The backend requires that any argument to <option>WITH LOCATION</option> which is
in all uppercase and which has no path delimiters is an environment variable.
</para>
</note>
</refsect1>
<REFSECT1 ID="R1-APP-INITLOCATION-2">
<REFSECT1INFO>
<DATE>1998-09-26</DATE>
</REFSECT1INFO>
<TITLE>
Usage
</TITLE>
<PARA>
To create a database in an alternate location, using an environment variable:
<programlisting>
% setenv PGDATA2 /opt/postgres/data
% initlocation PGDATA2
% createdb -D PGDATA2
</programlisting>
</para>
</refsect1>
</REFENTRY> </REFENTRY>
doc/src/sgml/ref/insert.sgml
View file @ a75f2d21
...@@ -12,188 +12,208 @@ INSERT ...@@ -12,188 +12,208 @@ INSERT
<REFPURPOSE> <REFPURPOSE>
Inserts new rows into a table Inserts new rows into a table
</REFPURPOSE> </REFPURPOSE>
<REFSYNOPSISDIV> </refnamediv>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIV>
<DATE>1998-09-23</DATE> <REFSYNOPSISDIVINFO>
</REFSYNOPSISDIVINFO> <DATE>1998-09-23</DATE>
<SYNOPSIS> </REFSYNOPSISDIVINFO>
INSERT INTO <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE> [ ( <REPLACEABLE CLASS="PARAMETER">column</REPLACEABLE> [, ...] ) ] <SYNOPSIS>
{ VALUES ( <REPLACEABLE CLASS="PARAMETER">expression</REPLACEABLE> [, ...] ) | SELECT <REPLACEABLE CLASS="PARAMETER">query</REPLACEABLE> } INSERT INTO <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE> [ ( <REPLACEABLE CLASS="PARAMETER">column</REPLACEABLE> [, ...] ) ]
</SYNOPSIS> { VALUES ( <REPLACEABLE CLASS="PARAMETER">expression</REPLACEABLE> [, ...] ) | SELECT <REPLACEABLE CLASS="PARAMETER">query</REPLACEABLE> }
</SYNOPSIS>
<REFSECT2 ID="R2-SQL-INSERT-1">
<REFSECT2INFO> <REFSECT2 ID="R2-SQL-INSERT-1">
<DATE>1998-09-23</DATE> <REFSECT2INFO>
</REFSECT2INFO> <DATE>1998-09-23</DATE>
<TITLE> </REFSECT2INFO>
Inputs <TITLE>
</TITLE> Inputs
<PARA> </TITLE>
</PARA> <PARA>
<VARIABLELIST> </PARA>
<VARLISTENTRY> <VARIABLELIST>
<TERM> <VARLISTENTRY>
<REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE> <TERM>
</TERM> <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE>
<LISTITEM> </TERM>
<PARA> <LISTITEM>
The name of an existing table. <PARA>
The name of an existing table.
<VARLISTENTRY> </para>
<TERM> </listitem>
<REPLACEABLE CLASS="PARAMETER">column</REPLACEABLE> </varlistentry>
</TERM> <VARLISTENTRY>
<LISTITEM> <TERM>
<PARA> <REPLACEABLE CLASS="PARAMETER">column</REPLACEABLE>
The name of a column in <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE>. </TERM>
<LISTITEM>
<VARLISTENTRY> <PARA>
<TERM> The name of a column in <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE>.
<REPLACEABLE CLASS="PARAMETER">expression</REPLACEABLE> </para>
</TERM> </listitem>
<LISTITEM> </varlistentry>
<PARA>
A valid expression or value to assign to <REPLACEABLE CLASS="PARAMETER">column</REPLACEABLE>. <VARLISTENTRY>
<TERM>
<VARLISTENTRY> <REPLACEABLE CLASS="PARAMETER">expression</REPLACEABLE>
<TERM> </TERM>
<REPLACEABLE CLASS="PARAMETER">query</REPLACEABLE> <LISTITEM>
</TERM> <PARA>
<LISTITEM> A valid expression or value to assign to <REPLACEABLE CLASS="PARAMETER">column</REPLACEABLE>.
<PARA> </para>
A valid query. Refer to the SELECT statement for a further description </listitem>
of valid arguments. </varlistentry>
</VARIABLELIST> <VARLISTENTRY>
<TERM>
</REFSECT2> <REPLACEABLE CLASS="PARAMETER">query</REPLACEABLE>
</TERM>
<REFSECT2 ID="R2-SQL-INSERT-2"> <LISTITEM>
<REFSECT2INFO> <PARA>
<DATE>1998-09-23</DATE> A valid query. Refer to the SELECT statement for a further description
</REFSECT2INFO> of valid arguments.
<TITLE> </para>
Outputs </listitem>
</TITLE> </varlistentry>
<PARA>
</VARIABLELIST>
<VARIABLELIST>
<VARLISTENTRY> </REFSECT2>
<TERM>
<ReturnValue>INSERT <replaceable>oid</replaceable></ReturnValue> 1 <REFSECT2 ID="R2-SQL-INSERT-2">
</TERM> <REFSECT2INFO>
<LISTITEM> <DATE>1998-09-23</DATE>
<PARA> </REFSECT2INFO>
Message returned if only one row was inserted. <TITLE>
<ReturnValue><replaceable>oid</replaceable></ReturnValue> Outputs
is the row identifier. </TITLE>
<PARA>
<VARLISTENTRY>
<TERM> <VARIABLELIST>
<ReturnValue>INSERT 0 <replaceable>#</replaceable></ReturnValue> <VARLISTENTRY>
</TERM> <TERM>
<LISTITEM> <ReturnValue>INSERT <replaceable>oid</replaceable></ReturnValue> 1
<PARA> </TERM>
Message returned if more than one rows were inserted. <LISTITEM>
<ReturnValue><replaceable>#</replaceable></ReturnValue> <PARA>
is the number of rows inserted. Message returned if only one row was inserted.
<ReturnValue><replaceable>oid</replaceable></ReturnValue>
</VARIABLELIST> is the numeric <acronym>OID</acronym> of the inserted row.
</para>
</REFSECT2> </listitem>
</REFSYNOPSISDIV> </varlistentry>
<VARLISTENTRY>
<REFSECT1 ID="R1-SQL-INSERT-1"> <TERM>
<REFSECT1INFO> <ReturnValue>INSERT 0 <replaceable>#</replaceable></ReturnValue>
<DATE>1998-09-02</DATE> </TERM>
</REFSECT1INFO> <LISTITEM>
<TITLE> <PARA>
Description Message returned if more than one rows were inserted.
</TITLE> <ReturnValue><replaceable>#</replaceable></ReturnValue>
<PARA> is the number of rows inserted.
INSERT allows one to insert new rows into a table. One can insert </para>
a single row at time or several rows as a result of a query. </listitem>
The columns in the target list may be listed in any order. </varlistentry>
In every column not present in the target list will be inserted </VARIABLELIST>
the default value, if column has not a declared default value </para>
it will be assumed as NULL. If the expression for each column </REFSECT2>
is not of the correct data type, automatic type coercion will be </REFSYNOPSISDIV>
attempted.
<REFSECT1 ID="R1-SQL-INSERT-1">
<para> <REFSECT1INFO>
You must have insert privilege to a table in order to append <DATE>1998-09-02</DATE>
to it, as well as select privilege on any table specified </REFSECT1INFO>
in a WHERE clause. <TITLE>
Description
<REFSECT1 ID="R1-SQL-INSERT-2"> </TITLE>
<TITLE> <PARA>
Usage INSERT allows one to insert new rows into a table. One can insert
</TITLE> a single row at time or several rows as a result of a query.
<PARA> The columns in the target list may be listed in any order.
<ProgramListing> In every column not present in the target list will be inserted
--Insert a single row into table films; the default value, if column has not a declared default value
--(in the second example the column date_prod is omitted it will be assumed as NULL. If the expression for each column
--therefore will be stored in it a default value of NULL): is not of the correct data type, automatic type coercion will be
-- attempted.
INSERT INTO films VALUES </para>
('UA502','Bananas',105,'1971-07-13','Comedy',INTERVAL '82 minute'); <para>
You must have insert privilege to a table in order to append
INSERT INTO films (code, title, did, date_prod, kind) to it, as well as select privilege on any table specified
VALUES ('T_601', 'Yojimbo', 106, DATE '1961-06-16', 'Drama'); in a WHERE clause.
</ProgramListing> </para>
</refsect1>
<ProgramListing>
--Insert a single row into table distributors, note that <REFSECT1 ID="R1-SQL-INSERT-2">
--only column "name" is specified, to the non specified <TITLE>
--column "did" will be assigned its default value: Usage
-- </TITLE>
INSERT INTO distributors (name) VALUES ('British Lion'); <PARA>
</ProgramListing> <ProgramListing>
--Insert a single row into table films;
<ProgramListing> --(in the second example the column date_prod is omitted
--Insert several rows into table films from table tmp: --therefore will be stored in it a default value of NULL):
-- --
INSERT INTO films INSERT INTO films VALUES
SELECT * FROM tmp; ('UA502','Bananas',105,'1971-07-13','Comedy',INTERVAL '82 minute');
</ProgramListing>
INSERT INTO films (code, title, did, date_prod, kind)
<ProgramListing> VALUES ('T_601', 'Yojimbo', 106, DATE '1961-06-16', 'Drama');
--Insert into arrays: </ProgramListing>
--Create an empty 3x3 gameboard for noughts-and-crosses
--(all of these queries create the same board attribute) <ProgramListing>
--(Refer to the <citetitle>PostgreSQL User's Guide</citetitle> for further --Insert a single row into table distributors, note that
--information about arrays). --only column "name" is specified, to the non specified
--column "did" will be assigned its default value:
INSERT INTO tictactoe (game, board[1:3][1:3]) --
VALUES (1,'{{"","",""},{},{"",""}}'); INSERT INTO distributors (name) VALUES ('British Lion');
INSERT INTO tictactoe (game, board[3][3]) </ProgramListing>
VALUES (2,'{}');
INSERT INTO tictactoe (game, board) <ProgramListing>
VALUES (3,'{{,,},{,,},{,,}}'); --Insert several rows into table films from table tmp:
</ProgramListing> --
INSERT INTO films
</REFSECT1> SELECT * FROM tmp;
</ProgramListing>
<REFSECT1 ID="R1-SQL-INSERT-3">
<TITLE> <ProgramListing>
Compatibility --Insert into arrays:
</TITLE> --Create an empty 3x3 gameboard for noughts-and-crosses
<PARA> --(all of these queries create the same board attribute)
</PARA> --(Refer to the <citetitle>PostgreSQL User's Guide</citetitle> for further
--information about arrays).
<REFSECT2 ID="R2-SQL-INSERT-4">
<REFSECT2INFO> INSERT INTO tictactoe (game, board[1:3][1:3])
<DATE>1998-09-23</DATE> VALUES (1,'{{"","",""},{},{"",""}}');
</REFSECT2INFO> INSERT INTO tictactoe (game, board[3][3])
<TITLE> VALUES (2,'{}');
SQL92 INSERT INTO tictactoe (game, board)
</TITLE> VALUES (3,'{{,,},{,,},{,,}}');
<PARA> </ProgramListing>
The INSERT statement is fully compatible with <acronym>SQL92</acronym>. </para>
Possible limitations in features of the </REFSECT1>
<REPLACEABLE CLASS="PARAMETER">query</REPLACEABLE>
clause are documented for the SELECT statement. <REFSECT1 ID="R1-SQL-INSERT-3">
<TITLE>
Compatibility
</TITLE>
<PARA>
</PARA>
<REFSECT2 ID="R2-SQL-INSERT-4">
<REFSECT2INFO>
<DATE>1998-09-23</DATE>
</REFSECT2INFO>
<TITLE>
SQL92
</TITLE>
<PARA>
The INSERT statement is fully compatible with <acronym>SQL92</acronym>.
Possible limitations in features of the
<REPLACEABLE CLASS="PARAMETER">query</REPLACEABLE>
clause are documented for the SELECT statement.
</para>
</refsect2>
</refsect1>
</REFENTRY> </REFENTRY>
<!-- <!--
......
doc/src/sgml/ref/listen.sgml
View file @ a75f2d21
...@@ -12,7 +12,7 @@ LISTEN ...@@ -12,7 +12,7 @@ LISTEN
<REFPURPOSE> <REFPURPOSE>
Listen for notification on a notify condition Listen for notification on a notify condition
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-10-07</DATE> <DATE>1998-10-07</DATE>
...@@ -21,156 +21,165 @@ Listen for notification on a notify condition ...@@ -21,156 +21,165 @@ Listen for notification on a notify condition
LISTEN <REPLACEABLE CLASS="PARAMETER">notifyname</REPLACEABLE> LISTEN <REPLACEABLE CLASS="PARAMETER">notifyname</REPLACEABLE>
</SYNOPSIS> </SYNOPSIS>
<REFSECT2 ID="R2-SQL-LISTEN-1"> <REFSECT2 ID="R2-SQL-LISTEN-1">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-10-07</DATE> <DATE>1998-10-07</DATE>
</REFSECT2INFO> </REFSECT2INFO>
<TITLE> <TITLE>
Inputs Inputs
</TITLE> </TITLE>
<PARA> <PARA>
</PARA> </PARA>
<VARIABLELIST> <VARIABLELIST>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<REPLACEABLE CLASS="PARAMETER">notifyname</REPLACEABLE> <REPLACEABLE CLASS="PARAMETER">notifyname</REPLACEABLE>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
Name of notify condition. Name of notify condition.
</para>
</VARIABLELIST> </listitem>
</varlistentry>
</REFSECT2> </VARIABLELIST>
<REFSECT2 ID="R2-SQL-LISTEN-2"> </REFSECT2>
<REFSECT2INFO>
<DATE>1998-09-24</DATE> <REFSECT2 ID="R2-SQL-LISTEN-2">
</REFSECT2INFO> <REFSECT2INFO>
<TITLE> <DATE>1998-09-24</DATE>
Outputs </REFSECT2INFO>
</TITLE> <TITLE>
<PARA> Outputs
</TITLE>
<VARIABLELIST> <PARA>
<VARLISTENTRY>
<TERM> <VARIABLELIST>
<returnvalue>LISTEN</returnvalue> <VARLISTENTRY>
</TERM> <TERM>
<LISTITEM> <returnvalue>LISTEN</returnvalue>
<PARA> </TERM>
Message returned upon successful completion of registration. <LISTITEM>
</PARA> <PARA>
</LISTITEM> Message returned upon successful completion of registration.
</VARLISTENTRY> </PARA>
<VARLISTENTRY> </LISTITEM>
<TERM> </VARLISTENTRY>
<returnvalue>NOTICE Async_Listen: We are already listening on notifyname</returnvalue> <VARLISTENTRY>
</TERM> <TERM>
<LISTITEM> <returnvalue>NOTICE Async_Listen: We are already listening on notifyname</returnvalue>
<PARA> </TERM>
If this backend is already registered for that notify condition. <LISTITEM>
</PARA> <PARA>
</VARIABLELIST> If this backend is already registered for that notify condition.
</REFSECT2> </PARA>
</REFSYNOPSISDIV> </listitem>
</varlistentry>
<REFSECT1 ID="R1-SQL-LISTEN-1"> </VARIABLELIST>
<REFSECT1INFO> </para>
<DATE>1998-10-07</DATE> </REFSECT2>
</REFSECT1INFO> </REFSYNOPSISDIV>
<TITLE>
Description <REFSECT1 ID="R1-SQL-LISTEN-1">
</TITLE> <REFSECT1INFO>
<PARA> <DATE>1998-10-07</DATE>
LISTEN registers the current <productname>Postgres</productname> backend as a </REFSECT1INFO>
listener on the notify condition <TITLE>
<REPLACEABLE CLASS="PARAMETER">notifyname</REPLACEABLE>. Description
</TITLE>
<para> <PARA>
Whenever the command LISTEN registers the current <productname>Postgres</productname> backend as a
<command>NOTIFY <REPLACEABLE CLASS="PARAMETER">notifyname</REPLACEABLE></command> listener on the notify condition
is invoked, either by this backend or another one connected to <REPLACEABLE CLASS="PARAMETER">notifyname</REPLACEABLE>.
the same database, all the backends currently listening on that notify </para>
condition are notified, and each will in turn notify its connected <para>
frontend application. See the discussion of <command>NOTIFY</command> Whenever the command
for more information. <command>NOTIFY <REPLACEABLE CLASS="PARAMETER">notifyname</REPLACEABLE></command>
is invoked, either by this backend or another one connected to
<para> the same database, all the backends currently listening on that notify
A backend can be deregistered for a given notify condition with the condition are notified, and each will in turn notify its connected
<command>UNLISTEN</command> command. Also, a backend's listen registrations frontend application. See the discussion of <command>NOTIFY</command>
are automatically cleared when the backend process exits. for more information.
</para>
<para> <para>
The method a frontend application must use to detect notify events depends on A backend can be deregistered for a given notify condition with the
which <productname>Postgres</productname> application programming interface it <command>UNLISTEN</command> command. Also, a backend's listen registrations
uses. With the basic libpq library, the application issues are automatically cleared when the backend process exits.
<command>LISTEN</command> as an ordinary SQL command, and then must </para>
periodically call the routine <function>PQnotifies</function> to find out <para>
whether any notify events have been received. Other interfaces such as The method a frontend application must use to detect notify events depends on
libpgtcl provide higher-level methods for handling notify events; indeed, which <productname>Postgres</productname> application programming interface it
with libpgtcl the application programmer should not even issue uses. With the basic libpq library, the application issues
<command>LISTEN</command> or <command>UNLISTEN</command> directly. See the <command>LISTEN</command> as an ordinary SQL command, and then must
documentation for the library you are using for more details. periodically call the routine <function>PQnotifies</function> to find out
whether any notify events have been received. Other interfaces such as
<para> libpgtcl provide higher-level methods for handling notify events; indeed,
The reference page for <command>NOTIFY</command> contains a more extensive with libpgtcl the application programmer should not even issue
discussion of the use of <command>LISTEN</command> and <command>LISTEN</command> or <command>UNLISTEN</command> directly. See the
<command>NOTIFY</command>. documentation for the library you are using for more details.
</para>
<REFSECT2 ID="R2-SQL-LISTEN-3"> <para>
<REFSECT2INFO> The reference page for <command>NOTIFY</command> contains a more extensive
<DATE>1998-10-07</DATE> discussion of the use of <command>LISTEN</command> and
</REFSECT2INFO> <command>NOTIFY</command>.
<TITLE> </para>
Notes
</TITLE> <REFSECT2 ID="R2-SQL-LISTEN-3">
<para> <REFSECT2INFO>
<REPLACEABLE CLASS="PARAMETER">notifyname</REPLACEABLE> <DATE>1998-10-07</DATE>
can be any string valid as a name; </REFSECT2INFO>
it need not correspond to the name of any actual table. If <TITLE>
<REPLACEABLE CLASS="PARAMETER">notifyname</REPLACEABLE> Notes
is enclosed in double-quotes, it need not even be a syntactically </TITLE>
valid name, but can be any string up to 31 characters long. <para>
<REPLACEABLE CLASS="PARAMETER">notifyname</REPLACEABLE>
<para> can be any string valid as a name;
In some previous releases of it need not correspond to the name of any actual table. If
<productname>Postgres</productname>, <REPLACEABLE CLASS="PARAMETER">notifyname</REPLACEABLE>
<REPLACEABLE CLASS="PARAMETER">notifyname</REPLACEABLE> is enclosed in double-quotes, it need not even be a syntactically
had to be enclosed in double-quotes when it did not correspond to any existing valid name, but can be any string up to 31 characters long.
table name, even if syntactically valid as a name. That is no longer required. </para>
<para>
</REFSECT2> In some previous releases of
<productname>Postgres</productname>,
<REFSECT1 ID="R1-SQL-LISTEN-2"> <REPLACEABLE CLASS="PARAMETER">notifyname</REPLACEABLE>
<TITLE> had to be enclosed in double-quotes when it did not correspond to any existing
Usage table name, even if syntactically valid as a name. That is no longer required.
</TITLE> </para>
<PARA> </REFSECT2>
<ProgramListing> </refsect1>
-- Configure and execute a listen/notify sequence from psql
postgres=> listen virtual; <REFSECT1 ID="R1-SQL-LISTEN-2">
LISTEN <TITLE>
postgres=> notify virtual; Usage
NOTIFY </TITLE>
ASYNC NOTIFY of 'virtual' from backend pid '11239' received <PARA>
</ProgramListing> <ProgramListing>
-- Configure and execute a listen/notify sequence from psql
</REFSECT1> postgres=> listen virtual;
LISTEN
<REFSECT1 ID="R1-SQL-LISTEN-3"> postgres=> notify virtual;
<TITLE> NOTIFY
Compatibility ASYNC NOTIFY of 'virtual' from backend pid '11239' received
</TITLE> </ProgramListing>
<PARA> </para>
</REFSECT1>
<REFSECT2 ID="R2-SQL-LISTEN-4">
<REFSECT2INFO> <REFSECT1 ID="R1-SQL-LISTEN-3">
<DATE>1998-09-01</DATE> <TITLE>
</REFSECT2INFO> Compatibility
<TITLE> </TITLE>
SQL92
</TITLE> <REFSECT2 ID="R2-SQL-LISTEN-4">
<PARA> <REFSECT2INFO>
There is no <command>LISTEN</command> in <acronym>SQL92</acronym>. <DATE>1998-09-01</DATE>
</REFSECT2INFO>
<TITLE>
SQL92
</TITLE>
<PARA>
There is no <command>LISTEN</command> in <acronym>SQL92</acronym>.
</para>
</refsect2>
</refsect1>
</REFENTRY> </REFENTRY>
doc/src/sgml/ref/load.sgml
View file @ a75f2d21
<REFENTRY ID="SQL-LOAD"> <REFENTRY ID="SQL-LOAD">
<REFMETA> <REFMETA>
<REFENTRYTITLE> <REFENTRYTITLE>
LOAD LOAD
</REFENTRYTITLE> </REFENTRYTITLE>
<REFMISCINFO>SQL - Language Statements</REFMISCINFO> <REFMISCINFO>SQL - Language Statements</REFMISCINFO>
</REFMETA> </REFMETA>
<REFNAMEDIV> <REFNAMEDIV>
<REFNAME> <REFNAME>
LOAD LOAD
</REFNAME> </REFNAME>
<REFPURPOSE> <REFPURPOSE>
Dynamically loads an object file Dynamically loads an object file
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-24</DATE> <DATE>1998-09-24</DATE>
</REFSYNOPSISDIVINFO> </REFSYNOPSISDIVINFO>
<SYNOPSIS> <SYNOPSIS>
<REPLACEABLE CLASS="PARAMETER"> <REPLACEABLE CLASS="PARAMETER">
</REPLACEABLE> </REPLACEABLE>
LOAD '<REPLACEABLE CLASS="PARAMETER">filename</REPLACEABLE>' LOAD '<REPLACEABLE CLASS="PARAMETER">filename</REPLACEABLE>'
</SYNOPSIS> </SYNOPSIS>
<REFSECT2 ID="R2-SQL-LOAD-1"> <REFSECT2 ID="R2-SQL-LOAD-1">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-09-01</DATE> <DATE>1998-09-01</DATE>
</REFSECT2INFO> </REFSECT2INFO>
<TITLE> <TITLE>
Inputs Inputs
</TITLE> </TITLE>
<PARA> <PARA>
</PARA> </PARA>
<VARIABLELIST> <VARIABLELIST>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<REPLACEABLE CLASS="PARAMETER">filename</REPLACEABLE> <REPLACEABLE CLASS="PARAMETER">filename</REPLACEABLE>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
Object file for dynamic loading. Object file for dynamic loading.
</para>
</VARIABLELIST> </listitem>
</varlistentry>
</REFSECT2> </VARIABLELIST>
<REFSECT2 ID="R2-SQL-LOAD-2"> </REFSECT2>
<REFSECT2INFO>
<DATE>1998-09-24</DATE> <REFSECT2 ID="R2-SQL-LOAD-2">
</REFSECT2INFO> <REFSECT2INFO>
<TITLE> <DATE>1998-09-24</DATE>
Outputs </REFSECT2INFO>
</TITLE> <TITLE>
<PARA> Outputs
</TITLE>
<VARIABLELIST> <PARA>
<VARLISTENTRY>
<TERM> <VARIABLELIST>
<returnvalue>LOAD</returnvalue> <VARLISTENTRY>
</TERM> <TERM>
<LISTITEM> <returnvalue>LOAD</returnvalue>
<PARA> </TERM>
Message returned on successful completion. <LISTITEM>
<PARA>
<VARLISTENTRY> Message returned on successful completion.
<TERM> </para>
<returnvalue>ERROR: LOAD: could not open file '<REPLACEABLE CLASS="PARAMETER">filename</REPLACEABLE>'</returnvalue> </listitem>
</TERM> </varlistentry>
<LISTITEM> <VARLISTENTRY>
<PARA> <TERM>
Message returned if the specified file is not found. The file must be visible <returnvalue>ERROR: LOAD: could not open file '<REPLACEABLE CLASS="PARAMETER">filename</REPLACEABLE>'</returnvalue>
<emphasis>to the <productname>Postgres</productname> backend</emphasis>, </TERM>
with the appropriate full path name specified, to avoid this message. <LISTITEM>
<PARA>
</VARIABLELIST> Message returned if the specified file is not found. The file must be visible
<emphasis>to the <productname>Postgres</productname> backend</emphasis>,
</REFSECT2> with the appropriate full path name specified, to avoid this message.
</REFSYNOPSISDIV> </para>
</listitem>
<REFSECT1 ID="R1-SQL-LOAD-1"> </varlistentry>
<REFSECT1INFO> </VARIABLELIST>
<DATE>1998-09-24</DATE> </para>
</REFSECT1INFO> </REFSECT2>
<TITLE> </REFSYNOPSISDIV>
Description
</TITLE> <REFSECT1 ID="R1-SQL-LOAD-1">
<PARA> <REFSECT1INFO>
Loads an object (or ".o") file into the <DATE>1998-09-24</DATE>
<productname>Postgres</productname> backend address space. Once a </REFSECT1INFO>
file is loaded, all functions in that file can be accessed. This <TITLE>
function is used in support of user-defined types and functions. Description
</TITLE>
<para> <PARA>
If a file is not loaded using Loads an object (or ".o") file into the
<command>LOAD</command>, <productname>Postgres</productname> backend address space. Once a
the file will be loaded automatically the first time the file is loaded, all functions in that file can be accessed. This
function is called by <productname>Postgres</productname>. function is used in support of user-defined types and functions.
<command>LOAD</command> </para>
can also be used to reload an object file if it has been edited and <para>
recompiled. Only objects created from C language files are supported If a file is not loaded using
at this time. <command>LOAD</command>,
the file will be loaded automatically the first time the
<REFSECT2 ID="R2-SQL-LOAD-3"> function is called by <productname>Postgres</productname>.
<REFSECT2INFO> <command>LOAD</command>
<DATE>1998-09-24</DATE> can also be used to reload an object file if it has been edited and
</REFSECT2INFO> recompiled. Only objects created from C language files are supported
<TITLE> at this time.
Notes </para>
</TITLE> <REFSECT2 ID="R2-SQL-LOAD-3">
<PARA> <REFSECT2INFO>
Functions in loaded object files should not call functions in other <DATE>1998-09-24</DATE>
object files loaded through the </REFSECT2INFO>
<command>LOAD</command> <TITLE>
command. For example, all functions in file <literal>A</literal> should Notes
call each other, functions in the standard or math libraries, or in </TITLE>
Postgres itself. They should not call functions defined in a different <PARA>
loaded file <literal>B</literal>. Functions in loaded object files should not call functions in other
This is because if <literal>B</literal> is reloaded, the Postgres loader is object files loaded through the
not able to relocate the calls from the functions in <literal>A</literal> into <command>LOAD</command>
the new address space of <literal>B</literal>. command. For example, all functions in file <literal>A</literal> should
If <literal>B</literal> is not reloaded, however, there will call each other, functions in the standard or math libraries, or in
not be a problem. Postgres itself. They should not call functions defined in a different
loaded file <literal>B</literal>.
<para> This is because if <literal>B</literal> is reloaded, the Postgres loader is
Object files must be compiled to contain position independent code. not able to relocate the calls from the functions in <literal>A</literal> into
For example, the new address space of <literal>B</literal>.
on DECstations you must use If <literal>B</literal> is not reloaded, however, there will
<application>/bin/cc</application> not be a problem.
with the <literal>-G 0</literal> option when compiling object files to be </para>
loaded. <para>
Object files must be compiled to contain position independent code.
<para> For example,
Note that if you are porting <productname>Postgres</productname> on DECstations you must use
to a new platform, <command>LOAD</command> <application>/bin/cc</application>
will have to work in order to support ADTs. with the <literal>-G 0</literal> option when compiling object files to be
loaded.
</REFSECT2> </para>
<para>
<REFSECT1 ID="R1-SQL-LOAD-2"> Note that if you are porting <productname>Postgres</productname>
<TITLE> to a new platform, <command>LOAD</command>
Usage will have to work in order to support ADTs.
</TITLE> </para>
<PARA> </REFSECT2>
<ProgramListing> </refsect1>
--Load the file /usr/postgres/demo/circle.o
-- <REFSECT1 ID="R1-SQL-LOAD-2">
LOAD '/usr/postgres/demo/circle.o' <TITLE>
</ProgramListing> Usage
</TITLE>
</REFSECT1> <PARA>
<ProgramListing>
<REFSECT1 ID="R1-SQL-LOAD-3"> --Load the file /usr/postgres/demo/circle.o
<TITLE> --
Compatibility LOAD '/usr/postgres/demo/circle.o'
</TITLE> </ProgramListing>
<PARA> </para>
</PARA> </REFSECT1>
<REFSECT2 ID="R2-SQL-LOAD-4"> <REFSECT1 ID="R1-SQL-LOAD-3">
<REFSECT2INFO> <TITLE>
<DATE>1998-09-24</DATE> Compatibility
</REFSECT2INFO> </TITLE>
<TITLE> <PARA>
SQL92 </PARA>
</TITLE>
<PARA> <REFSECT2 ID="R2-SQL-LOAD-4">
There is no <command>LOAD</command> in <acronym>SQL92</acronym>. <REFSECT2INFO>
<DATE>1998-09-24</DATE>
</REFSECT2INFO>
<TITLE>
SQL92
</TITLE>
<PARA>
There is no <command>LOAD</command> in <acronym>SQL92</acronym>.
</para>
</refsect2>
</refsect1>
</REFENTRY> </REFENTRY>
doc/src/sgml/ref/lock.sgml
View file @ a75f2d21
...@@ -12,7 +12,7 @@ LOCK ...@@ -12,7 +12,7 @@ LOCK
<REFPURPOSE> <REFPURPOSE>
Explicit lock of a table inside a transaction Explicit lock of a table inside a transaction
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-24</DATE> <DATE>1998-09-24</DATE>
...@@ -21,158 +21,170 @@ Explicit lock of a table inside a transaction ...@@ -21,158 +21,170 @@ Explicit lock of a table inside a transaction
LOCK [ TABLE ] <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE> LOCK [ TABLE ] <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE>
</SYNOPSIS> </SYNOPSIS>
<REFSECT2 ID="R2-SQL-LOCK-1"> <REFSECT2 ID="R2-SQL-LOCK-1">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-09-01</DATE> <DATE>1998-09-01</DATE>
</REFSECT2INFO> </REFSECT2INFO>
<TITLE> <TITLE>
Inputs Inputs
</TITLE> </TITLE>
<PARA> <PARA>
</PARA> </PARA>
<VARIABLELIST> <VARIABLELIST>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE> <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
The name of an existing table to lock. The name of an existing table to lock.
</VARIABLELIST> </para>
</listitem>
</REFSECT2> </varlistentry>
</VARIABLELIST>
<REFSECT2 ID="R2-SQL-LOCK-2">
<REFSECT2INFO> </REFSECT2>
<DATE>1998-09-24</DATE>
</REFSECT2INFO> <REFSECT2 ID="R2-SQL-LOCK-2">
<TITLE> <REFSECT2INFO>
Outputs <DATE>1998-09-24</DATE>
</TITLE> </REFSECT2INFO>
<PARA> <TITLE>
Outputs
<VARIABLELIST> </TITLE>
<VARLISTENTRY> <PARA>
<TERM>
DELETE 0 <VARIABLELIST>
</TERM> <VARLISTENTRY>
<LISTITEM> <TERM>
<PARA> DELETE 0
Message returned on a successful lock. </TERM>
<command>LOCK</command> is implemented as a <LISTITEM>
<command>DELETE FROM <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE></command> <PARA>
which is guaranteed to not delete any rows. Message returned on a successful lock.
<command>LOCK</command> is implemented as a
<VARLISTENTRY> <command>DELETE FROM <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE></command>
<TERM> which is guaranteed to not delete any rows.
ERROR <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE>: Table does not exist. </para>
</TERM> </listitem>
<LISTITEM> </varlistentry>
<PARA> <VARLISTENTRY>
Message returned if <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE> <TERM>
does not exist. ERROR <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE>: Table does not exist.
</TERM>
</VARIABLELIST> <LISTITEM>
<PARA>
</REFSECT2> Message returned if <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE>
</REFSYNOPSISDIV> does not exist.
</para>
<REFSECT1 ID="R1-SQL-LOCK-1"> </listitem>
<REFSECT1INFO> </varlistentry>
<DATE>1998-09-24</DATE> </VARIABLELIST>
</REFSECT1INFO> </para>
<TITLE> </REFSECT2>
Description </REFSYNOPSISDIV>
</TITLE>
<PARA> <REFSECT1 ID="R1-SQL-LOCK-1">
<command>LOCK</command> locks in exclusive mode a table inside <REFSECT1INFO>
a transaction. The classic use for this is <DATE>1998-09-24</DATE>
the case where you want to select some data, then </REFSECT1INFO>
update it inside a transaction. <TITLE>
If you don't explicit lock a table using LOCK statement, it will be Description
implicit locked only at the first </TITLE>
<command>UPDATE</command>, <command>INSERT</command>, <PARA>
or <command>DELETE</command> operation. <command>LOCK</command> locks in exclusive mode a table inside
If you don't exclusive lock the table before the select, some a transaction. The classic use for this is
other user may also read the selected data, and try and do the case where you want to select some data, then
their own update, causing a deadlock while you both wait update it inside a transaction.
for the other to release the select-induced shared lock so If you don't explicit lock a table using LOCK statement, it will be
you can get an exclusive lock to do the update. implicit locked only at the first
<command>UPDATE</command>, <command>INSERT</command>,
<para> or <command>DELETE</command> operation.
Another example of deadlock is where one user locks one If you don't exclusive lock the table before the select, some
table, and another user locks a second table. While both other user may also read the selected data, and try and do
keep their existing locks, the first user tries to lock their own update, causing a deadlock while you both wait
the second user's table, and the second user tries to lock for the other to release the select-induced shared lock so
the first user's table. Both users deadlock waiting for you can get an exclusive lock to do the update.
the tables to become available. The only solution to this </para>
is for both users to lock tables in the same order, so <para>
user's lock acquisitions and requests to not form a deadlock. Another example of deadlock is where one user locks one
table, and another user locks a second table. While both
<note> keep their existing locks, the first user tries to lock
<para> the second user's table, and the second user tries to lock
<productname>Postgres</productname> does detect deadlocks and will the first user's table. Both users deadlock waiting for
rollback transactions to resolve the deadlock. Usually, at least one the tables to become available. The only solution to this
of the deadlocked transactions will complete successfully. is for both users to lock tables in the same order, so
</note> user's lock acquisitions and requests to not form a deadlock.
</para>
<REFSECT2 ID="R2-SQL-LOCK-3"> <note>
<REFSECT2INFO> <para>
<DATE>1998-09-24</DATE> <productname>Postgres</productname> does detect deadlocks and will
</REFSECT2INFO> rollback transactions to resolve the deadlock. Usually, at least one
<TITLE> of the deadlocked transactions will complete successfully.
Notes </para>
</TITLE> </note>
<PARA>
<command>LOCK</command> is a <productname>Postgres</productname> <REFSECT2 ID="R2-SQL-LOCK-3">
language extension. <REFSECT2INFO>
<para> <DATE>1998-09-24</DATE>
<command>LOCK</command> works only inside transactions. </REFSECT2INFO>
<TITLE>
<note> Notes
<title>Bug</title> </TITLE>
<para> <para>
If the locked table is dropped then it will be automatically <command>LOCK</command> is a <productname>Postgres</productname>
unlocked even if a transaction is still in progress. language extension.
</note> </para>
<para>
</REFSECT2> <command>LOCK</command> works only inside transactions.
<REFSECT1 ID="R1-SQL-LOCK-2"> <note>
<TITLE> <title>Bug</title>
Usage <para>
</TITLE> If the locked table is dropped then it will be automatically
<PARA> unlocked even if a transaction is still in progress.
</PARA> </para>
<ProgramListing> </note>
--Explicit locking to prevent deadlock: </para>
-- </REFSECT2>
BEGIN WORK; </refsect1>
LOCK films;
SELECT * FROM films; <REFSECT1 ID="R1-SQL-LOCK-2">
UPDATE films SET len = INTERVAL '100 minute' <TITLE>
WHERE len = INTERVAL '117 minute'; Usage
COMMIT WORK; </TITLE>
</ProgramListing> <PARA>
</PARA>
</REFSECT1> <ProgramListing>
--Explicit locking to prevent deadlock:
<REFSECT1 ID="R1-SQL-LOCK-3"> --
<TITLE> BEGIN WORK;
Compatibility LOCK films;
</TITLE> SELECT * FROM films;
<PARA> UPDATE films SET len = INTERVAL '100 minute'
WHERE len = INTERVAL '117 minute';
<REFSECT2 ID="R2-SQL-LOCK-4"> COMMIT WORK;
<REFSECT2INFO> </ProgramListing>
<DATE>1998-09-24</DATE>
</REFSECT2INFO> </REFSECT1>
<TITLE>
SQL92 <REFSECT1 ID="R1-SQL-LOCK-3">
</TITLE> <TITLE>
<PARA> Compatibility
There is no <command>LOCK TABLE</command> in <acronym>SQL92</acronym>, </TITLE>
which instead uses <command>SET TRANSACTION</command> to specify
concurrency level on transactions. <REFSECT2 ID="R2-SQL-LOCK-4">
<REFSECT2INFO>
<DATE>1998-09-24</DATE>
</REFSECT2INFO>
<TITLE>
SQL92
</TITLE>
<PARA>
There is no <command>LOCK TABLE</command> in <acronym>SQL92</acronym>,
which instead uses <command>SET TRANSACTION</command> to specify
concurrency level on transactions.
</para>
</refsect2>
</refsect1>
</REFENTRY> </REFENTRY>
doc/src/sgml/ref/move.sgml
View file @ a75f2d21
...@@ -12,7 +12,7 @@ MOVE ...@@ -12,7 +12,7 @@ MOVE
<REFPURPOSE> <REFPURPOSE>
Moves cursor position Moves cursor position
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-24</DATE> <DATE>1998-09-24</DATE>
...@@ -21,99 +21,104 @@ Moves cursor position ...@@ -21,99 +21,104 @@ Moves cursor position
MOVE [ <REPLACEABLE CLASS="PARAMETER">selector</REPLACEABLE> ] [ <REPLACEABLE CLASS="PARAMETER">count</REPLACEABLE> ] MOVE [ <REPLACEABLE CLASS="PARAMETER">selector</REPLACEABLE> ] [ <REPLACEABLE CLASS="PARAMETER">count</REPLACEABLE> ]
{ IN | FROM } <REPLACEABLE CLASS="PARAMETER">cursor</REPLACEABLE> { IN | FROM } <REPLACEABLE CLASS="PARAMETER">cursor</REPLACEABLE>
FETCH [ RELATIVE ] [ { [ <REPLACEABLE CLASS="PARAMETER">#</REPLACEABLE> | ALL | NEXT | PRIOR ] } ] FROM ] <REPLACEABLE CLASS="PARAMETER">cursor</REPLACEABLE> FETCH [ RELATIVE ] [ { [ <REPLACEABLE CLASS="PARAMETER">#</REPLACEABLE> | ALL | NEXT | PRIOR ] } ] FROM ] <REPLACEABLE CLASS="PARAMETER">cursor</REPLACEABLE>
</SYNOPSIS> </SYNOPSIS>
</refsynopsisdiv>
<REFSECT1 ID="R1-SQL-MOVE-1"> <REFSECT1 ID="R1-SQL-MOVE-1">
<REFSECT1INFO> <REFSECT1INFO>
<DATE>1998-09-24</DATE> <DATE>1998-09-24</DATE>
</REFSECT1INFO> </REFSECT1INFO>
<TITLE> <TITLE>
Description Description
</TITLE> </TITLE>
<PARA> <PARA>
<command>MOVE</command> allows a user to move cursor position a specified <command>MOVE</command> allows a user to move cursor position a specified
number of rows. number of rows.
<command>MOVE</command> works like the <command>FETCH</command> command, <command>MOVE</command> works like the <command>FETCH</command> command,
but only positions the cursor and does but only positions the cursor and does
not return rows. not return rows.
</para>
<para> <para>
Refer to the <command>FETCH</command> command for details on syntax and usage. Refer to the <command>FETCH</command> command for details on syntax and usage.
</para>
<REFSECT2 ID="R2-SQL-MOVE-3">
<REFSECT2INFO>
<DATE>1998-09-24</DATE>
</REFSECT2INFO>
<TITLE>
Notes
</TITLE>
<PARA>
<command>MOVE</command> is a <productname>Postgres</productname>
language extension.
<para>
Refer to <command>FETCH</command> for a description
of valid arguments.
Refer to <command>DECLARE</command> to declare a cursor.
Refer to <command>BEGIN WORK</command>, <command>COMMIT WORK</command>,
<command>ROLLBACK WORK</command> statements
for further information about transactions.
</REFSECT2>
<REFSECT1 ID="R1-SQL-MOVE-2">
<TITLE>
Usage
</TITLE>
<PARA>
<ProgramListing>
--set up and use a cursor:
--
BEGIN WORK;
DECLARE liahona CURSOR FOR SELECT * FROM films;
--Skip first 5 rows:
--
MOVE FORWARD 5 IN liahona;
<computeroutput>
MOVE
</computeroutput>
--Fetch 6th row in the cursor liahona:
--
FETCH 1 IN liahona;
<computeroutput>
FETCH
code |title |did| date_prod|kind |len
-----+------+---+----------+----------+------
P_303|48 Hrs|103|1982-10-22|Action | 01:37
(1 row)
</computeroutput>
-- close the cursor liahona and commit work:
--
CLOSE liahona;
COMMIT WORK;
</ProgramListing>
</REFSECT1>
<REFSECT1 ID="R1-SQL-MOVE-3"> <REFSECT2 ID="R2-SQL-MOVE-3">
<TITLE> <REFSECT2INFO>
Compatibility <DATE>1998-09-24</DATE>
</TITLE> </REFSECT2INFO>
<PARA> <TITLE>
</PARA> Notes
</TITLE>
<PARA>
<command>MOVE</command> is a <productname>Postgres</productname>
language extension.
</para>
<para>
Refer to <command>FETCH</command> for a description
of valid arguments.
Refer to <command>DECLARE</command> to declare a cursor.
Refer to <command>BEGIN WORK</command>, <command>COMMIT WORK</command>,
<command>ROLLBACK WORK</command> statements
for further information about transactions.
</para>
</REFSECT2>
</refsect1>
<REFSECT2 ID="R2-SQL-MOVE-4"> <REFSECT1 ID="R1-SQL-MOVE-2">
<REFSECT2INFO> <TITLE>
<DATE>1998-09-01</DATE> Usage
</REFSECT2INFO> </TITLE>
<TITLE> <PARA>
SQL92 <ProgramListing>
</TITLE> --set up and use a cursor:
<PARA> --
There is no SQL92 <command>MOVE</command> statement. BEGIN WORK;
Instead, <acronym>SQL92</acronym> allows DECLARE liahona CURSOR FOR SELECT * FROM films;
one to <command>FETCH</command> rows from an absolute cursor position,
implicitly moving the cursor to the correct place. --Skip first 5 rows:
--
MOVE FORWARD 5 IN liahona;
<computeroutput>
MOVE
</computeroutput>
--Fetch 6th row in the cursor liahona:
--
FETCH 1 IN liahona;
<computeroutput>
FETCH
code |title |did| date_prod|kind |len
-----+------+---+----------+----------+------
P_303|48 Hrs|103|1982-10-22|Action | 01:37
(1 row)
</computeroutput>
-- close the cursor liahona and commit work:
--
CLOSE liahona;
COMMIT WORK;
</ProgramListing>
</para>
</REFSECT1>
<REFSECT1 ID="R1-SQL-MOVE-3">
<TITLE>
Compatibility
</TITLE>
<PARA>
</PARA>
<REFSECT2 ID="R2-SQL-MOVE-4">
<REFSECT2INFO>
<DATE>1998-09-01</DATE>
</REFSECT2INFO>
<TITLE>
SQL92
</TITLE>
<PARA>
There is no SQL92 <command>MOVE</command> statement.
Instead, <acronym>SQL92</acronym> allows
one to <command>FETCH</command> rows from an absolute cursor position,
implicitly moving the cursor to the correct place.
</para>
</refsect2>
</refsect1>
</REFENTRY> </REFENTRY>
doc/src/sgml/ref/notify.sgml
View file @ a75f2d21
...@@ -12,7 +12,7 @@ NOTIFY ...@@ -12,7 +12,7 @@ NOTIFY
<REFPURPOSE> <REFPURPOSE>
Signals all frontends and backends listening on a notify condition Signals all frontends and backends listening on a notify condition
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-10-07</DATE> <DATE>1998-10-07</DATE>
...@@ -23,208 +23,215 @@ Signals all frontends and backends listening on a notify condition ...@@ -23,208 +23,215 @@ Signals all frontends and backends listening on a notify condition
NOTIFY <REPLACEABLE CLASS="PARAMETER">notifyname</REPLACEABLE> NOTIFY <REPLACEABLE CLASS="PARAMETER">notifyname</REPLACEABLE>
</SYNOPSIS> </SYNOPSIS>
<REFSECT2 ID="R2-SQL-NOTIFY-1"> <REFSECT2 ID="R2-SQL-NOTIFY-1">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-10-07</DATE> <DATE>1998-10-07</DATE>
</REFSECT2INFO> </REFSECT2INFO>
<TITLE> <TITLE>
Inputs Inputs
</TITLE> </TITLE>
<PARA> <PARA>
<VARIABLELIST> <VARIABLELIST>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<REPLACEABLE CLASS="PARAMETER">notifyname</REPLACEABLE> <REPLACEABLE CLASS="PARAMETER">notifyname</REPLACEABLE>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
Notify condition to be signaled. Notify condition to be signaled.
</para>
</VARIABLELIST> </listitem>
</varlistentry>
</REFSECT2> </VARIABLELIST>
</para>
<REFSECT2 ID="R2-SQL-NOTIFY-2"> </REFSECT2>
<REFSECT2INFO>
<DATE>1998-10-07</DATE> <REFSECT2 ID="R2-SQL-NOTIFY-2">
</REFSECT2INFO> <REFSECT2INFO>
<TITLE> <DATE>1998-10-07</DATE>
Outputs </REFSECT2INFO>
</TITLE> <TITLE>
<PARA> Outputs
</TITLE>
<VARIABLELIST> <PARA>
<VARLISTENTRY>
<TERM> <VARIABLELIST>
NOTIFY <VARLISTENTRY>
</TERM> <TERM>
<LISTITEM> NOTIFY
<PARA> </TERM>
Acknowledgement that notify command has executed. <LISTITEM>
<PARA>
<VARLISTENTRY> Acknowledgement that notify command has executed.
<TERM> </para>
Notify events </listitem>
</TERM> </varlistentry>
<LISTITEM> <VARLISTENTRY>
<PARA> <TERM>
Events are delivered to listening frontends; whether and how each frontend Notify events
application reacts depends on its programming. </TERM>
</PARA> <LISTITEM>
</LISTITEM> <PARA>
</VARLISTENTRY> Events are delivered to listening frontends; whether and how each frontend
</VARIABLELIST> application reacts depends on its programming.
</REFSECT2> </PARA>
</REFSYNOPSISDIV> </LISTITEM>
</VARLISTENTRY>
<REFSECT1 ID="R1-SQL-NOTIFY-1"> </VARIABLELIST>
<REFSECT1INFO> </para>
<DATE>1998-10-07</DATE> </REFSECT2>
</REFSECT1INFO> </REFSYNOPSISDIV>
<TITLE>
Description <REFSECT1 ID="R1-SQL-NOTIFY-1">
</TITLE> <REFSECT1INFO>
<PARA> <DATE>1998-10-07</DATE>
The <command>NOTIFY</command> command sends a notify event to each </REFSECT1INFO>
frontend application that has previously executed <TITLE>
<command>LISTEN <replaceable class="parameter">notifyname</replaceable></command> Description
for the specified notify condition in the current database. </TITLE>
<PARA>
<para> The <command>NOTIFY</command> command sends a notify event to each
The information passed to the frontend for a notify event includes the notify frontend application that has previously executed
condition name and the notifying backend process's PID. It is up to the <command>LISTEN <replaceable class="parameter">notifyname</replaceable></command>
database designer to define the condition names that will be used in a given for the specified notify condition in the current database.
database and what each one means. </para>
<para>
<para> The information passed to the frontend for a notify event includes the notify
Commonly, the notify condition name is the same as the name of some table in condition name and the notifying backend process's PID. It is up to the
the database, and the notify event essentially means "I changed this table, database designer to define the condition names that will be used in a given
take a look at it to see what's new". But no such association is enforced by database and what each one means.
the <command>NOTIFY</command> and <command>LISTEN</command> commands. For </para>
example, a database designer could use several different condition names <para>
to signal different sorts of changes to a single table. Commonly, the notify condition name is the same as the name of some table in
the database, and the notify event essentially means "I changed this table,
<para> take a look at it to see what's new". But no such association is enforced by
<command>NOTIFY</command> provides a simple form of signal or the <command>NOTIFY</command> and <command>LISTEN</command> commands. For
IPC (interprocess communication) mechanism for a collection of processes example, a database designer could use several different condition names
accessing the same <productname>Postgres</productname> database. to signal different sorts of changes to a single table.
Higher-level mechanisms can be built by using tables in the database to </para>
pass additional data (beyond a mere condition name) from notifier to <para>
listener(s). <command>NOTIFY</command> provides a simple form of signal or
IPC (interprocess communication) mechanism for a collection of processes
<para> accessing the same <productname>Postgres</productname> database.
When <command>NOTIFY</command> is used to signal the occurrence of changes Higher-level mechanisms can be built by using tables in the database to
to a particular table, a useful programming technique is to put the pass additional data (beyond a mere condition name) from notifier to
<command>NOTIFY</command> in a rule that is triggered by table updates. listener(s).
In this way, notification happens automatically when the table is changed, </para>
and the application programmer can't accidentally forget to do it. <para>
When <command>NOTIFY</command> is used to signal the occurrence of changes
<para> to a particular table, a useful programming technique is to put the
<command>NOTIFY</command> interacts with SQL transactions in some important <command>NOTIFY</command> in a rule that is triggered by table updates.
ways. Firstly, if a <command>NOTIFY</command> is executed inside a In this way, notification happens automatically when the table is changed,
transaction, the notify events are not delivered until and unless the and the application programmer can't accidentally forget to do it.
transaction is committed. This is appropriate, since if the transaction </para>
is aborted we would like all the commands within it to have had no effect <para>
--- including <command>NOTIFY</command>. But it can be disconcerting if one <command>NOTIFY</command> interacts with SQL transactions in some important
is expecting the notify events to be delivered immediately. Secondly, if ways. Firstly, if a <command>NOTIFY</command> is executed inside a
a listening backend receives a notify signal while it is within a transaction, transaction, the notify events are not delivered until and unless the
the notify event will not be delivered to its connected frontend until just transaction is committed. This is appropriate, since if the transaction
after the transaction is completed (either committed or aborted). Again, the is aborted we would like all the commands within it to have had no effect
reasoning is that if a notify were delivered within a transaction that was --- including <command>NOTIFY</command>. But it can be disconcerting if one
later aborted, one would want the notification to be undone somehow --- but is expecting the notify events to be delivered immediately. Secondly, if
the backend cannot "take back" a notify once it has sent it to the frontend. a listening backend receives a notify signal while it is within a transaction,
So notify events are only delivered between transactions. The upshot of this the notify event will not be delivered to its connected frontend until just
is that applications using <command>NOTIFY</command> for real-time signaling after the transaction is completed (either committed or aborted). Again, the
should try to keep their transactions short. reasoning is that if a notify were delivered within a transaction that was
later aborted, one would want the notification to be undone somehow --- but
<para> the backend cannot "take back" a notify once it has sent it to the frontend.
<command>NOTIFY</command> behaves like Unix signals in one important So notify events are only delivered between transactions. The upshot of this
respect: if the same condition name is signaled multiple times in quick is that applications using <command>NOTIFY</command> for real-time signaling
succession, recipients may get only one notify event for several executions should try to keep their transactions short.
of <command>NOTIFY</command>. So it is a bad idea to depend on the number </para>
of notifies received. Instead, use <command>NOTIFY</command> to wake up <para>
applications that need to pay attention to something, and use a database <command>NOTIFY</command> behaves like Unix signals in one important
object (such as a sequence) to keep track of what happened or how many times respect: if the same condition name is signaled multiple times in quick
it happened. succession, recipients may get only one notify event for several executions
of <command>NOTIFY</command>. So it is a bad idea to depend on the number
<para> of notifies received. Instead, use <command>NOTIFY</command> to wake up
It is common for a frontend that sends <command>NOTIFY</command> to be applications that need to pay attention to something, and use a database
listening on the same notify name itself. In that case it will get back a object (such as a sequence) to keep track of what happened or how many times
notify event, just like all the other listening frontends. Depending on the it happened.
application logic, this could result in useless work --- for example, </para>
re-reading a database table to find the same updates that that frontend just <para>
wrote out. In <productname>Postgres</productname> 6.4 and later, it is It is common for a frontend that sends <command>NOTIFY</command> to be
possible to avoid such extra work by noticing whether the notifying backend listening on the same notify name itself. In that case it will get back a
process's PID (supplied in the notify event message) is the same as one's own notify event, just like all the other listening frontends. Depending on the
backend's PID (available from libpq). When they are the same, the notify application logic, this could result in useless work --- for example,
event is one's own work bouncing back, and can be ignored. (Despite what was re-reading a database table to find the same updates that that frontend just
said in the preceding paragraph, this is a safe technique. wrote out. In <productname>Postgres</productname> 6.4 and later, it is
<productname>Postgres</productname> keeps self-notifies separate from notifies possible to avoid such extra work by noticing whether the notifying backend
arriving from other backends, so you cannot miss an outside notify by ignoring process's PID (supplied in the notify event message) is the same as one's own
your own notifies.) backend's PID (available from libpq). When they are the same, the notify
event is one's own work bouncing back, and can be ignored. (Despite what was
<REFSECT2 ID="R2-SQL-NOTIFY-3"> said in the preceding paragraph, this is a safe technique.
<REFSECT2INFO> <productname>Postgres</productname> keeps self-notifies separate from notifies
<DATE>1998-10-07</DATE> arriving from other backends, so you cannot miss an outside notify by ignoring
</REFSECT2INFO> your own notifies.)
<TITLE> </para>
Notes
</TITLE> <REFSECT2 ID="R2-SQL-NOTIFY-3">
<para> <REFSECT2INFO>
<REPLACEABLE CLASS="PARAMETER">notifyname</REPLACEABLE> <DATE>1998-10-07</DATE>
can be any string valid as a name; </REFSECT2INFO>
it need not correspond to the name of any actual table. If <TITLE>
<REPLACEABLE CLASS="PARAMETER">notifyname</REPLACEABLE> Notes
is enclosed in double-quotes, it need not even be a syntactically </TITLE>
valid name, but can be any string up to 31 characters long. <para>
<REPLACEABLE CLASS="PARAMETER">notifyname</REPLACEABLE>
<para> can be any string valid as a name;
In some previous releases of it need not correspond to the name of any actual table. If
<productname>Postgres</productname>, <REPLACEABLE CLASS="PARAMETER">notifyname</REPLACEABLE>
<REPLACEABLE CLASS="PARAMETER">notifyname</REPLACEABLE> is enclosed in double-quotes, it need not even be a syntactically
had to be enclosed in double-quotes when it did not correspond to any existing valid name, but can be any string up to 31 characters long.
table name, even if syntactically valid as a name. That is no longer required. </para>
<para>
<para> In some previous releases of
In <productname>Postgres</productname> releases prior to 6.4, the backend <productname>Postgres</productname>,
PID delivered in a notify message was always the PID of the frontend's own <REPLACEABLE CLASS="PARAMETER">notifyname</REPLACEABLE>
backend. So it was not possible to distinguish one's own notifies from other had to be enclosed in double-quotes when it did not correspond to any existing
clients' notifies in those earlier releases. table name, even if syntactically valid as a name. That is no longer required.
</para>
</REFSECT2> <para>
In <productname>Postgres</productname> releases prior to 6.4, the backend
<REFSECT1 ID="R1-SQL-NOTIFY-2"> PID delivered in a notify message was always the PID of the frontend's own
<TITLE> backend. So it was not possible to distinguish one's own notifies from other
Usage clients' notifies in those earlier releases.
</TITLE> </para>
<PARA> </REFSECT2>
<ProgramListing> </refsect1>
-- Configure and execute a listen/notify sequence from psql
postgres=> listen virtual; <REFSECT1 ID="R1-SQL-NOTIFY-2">
LISTEN <TITLE>
postgres=> notify virtual; Usage
NOTIFY </TITLE>
ASYNC NOTIFY of 'virtual' from backend pid '11239' received <PARA>
</ProgramListing> <ProgramListing>
-- Configure and execute a listen/notify sequence from psql
</REFSECT1> postgres=> listen virtual;
LISTEN
<REFSECT1 ID="R1-SQL-NOTIFY-3"> postgres=> notify virtual;
<TITLE> NOTIFY
Compatibility ASYNC NOTIFY of 'virtual' from backend pid '11239' received
</TITLE> </ProgramListing>
<PARA> </para>
</REFSECT1>
<REFSECT2 ID="R2-SQL-NOTIFY-4"> <REFSECT1 ID="R1-SQL-NOTIFY-3">
<REFSECT2INFO> <TITLE>
<DATE>1998-09-24</DATE> Compatibility
</REFSECT2INFO> </TITLE>
<TITLE>
SQL92 <REFSECT2 ID="R2-SQL-NOTIFY-4">
</TITLE> <REFSECT2INFO>
<PARA> <DATE>1998-09-24</DATE>
There is no <command>NOTIFY</command> statement in <acronym>SQL92</acronym>. </REFSECT2INFO>
<TITLE>
SQL92
</TITLE>
<PARA>
There is no <command>NOTIFY</command> statement in <acronym>SQL92</acronym>.
</para>
</refsect2>
</refsect1>
</REFENTRY> </REFENTRY>
doc/src/sgml/ref/pg_dump.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ ...@@ -12,6 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Extract a <productname>Postgres</productname> database into a script file Extract a <productname>Postgres</productname> database into a script file
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-11-05</DATE> <DATE>1998-11-05</DATE>
...@@ -25,308 +26,386 @@ pg_dump [ -h <replaceable class="parameter">host</replaceable> ] [ -p <replaceab ...@@ -25,308 +26,386 @@ pg_dump [ -h <replaceable class="parameter">host</replaceable> ] [ -p <replaceab
[ <replaceable class="parameter">dbname</replaceable> ] [ <replaceable class="parameter">dbname</replaceable> ]
</SYNOPSIS> </SYNOPSIS>
<REFSECT2 ID="R2-APP-PG-DUMP-1"> <REFSECT2 ID="R2-APP-PG-DUMP-1">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-11-05</DATE> <DATE>1998-11-05</DATE>
</REFSECT2INFO> </REFSECT2INFO>
<TITLE> <TITLE>
Inputs Inputs
</TITLE> </TITLE>
<PARA> <PARA>
<application>pg_dump</application> accepts the following command line arguments: <application>pg_dump</application> accepts the following command line arguments:
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>
<replaceable class="parameter">dbname</replaceable> <replaceable class="parameter">dbname</replaceable>
</term> </term>
<listitem> <listitem>
<para> <para>
Specifies the name of the database to be extracted. Specifies the name of the database to be extracted.
<replaceable class="parameter">dbname</replaceable> <replaceable class="parameter">dbname</replaceable>
defaults to the value of the defaults to the value of the
<envar>USER</envar> <envar>USER</envar>
environment variable. environment variable.
</para>
<varlistentry> </listitem>
<term> </varlistentry>
-a
</term> <varlistentry>
<listitem> <term>
<para> -a
Dump out only the data, no schema (definitions). </term>
<listitem>
<varlistentry> <para>
<term> Dump out only the data, no schema (definitions).
-d </para>
</term> </listitem>
<listitem> </varlistentry>
<para>
Dump data as proper insert strings. <varlistentry>
<term>
<varlistentry> -d
<term> </term>
-D <listitem>
</term> <para>
<listitem> Dump data as proper insert strings.
<para> </para>
Dump data as inserts with attribute names </listitem>
</varlistentry>
<varlistentry>
<term> <varlistentry>
-f <replaceable class="parameter">filename</replaceable> <term>
</term> -D
<listitem> </term>
<para> <listitem>
Specifies the output file. Defaults to <filename>stdout</filename>. <para>
Dump data as inserts with attribute names
<varlistentry> </para>
<term> </listitem>
-n </varlistentry>
</term>
<listitem> <varlistentry>
<para> <term>
Suppress double quotes around identifiers unless absolutely necessary. -f <replaceable class="parameter">filename</replaceable>
This may cause trouble loading this dumped data if there are reserved words </term>
used for identifiers. <listitem>
This was the default behavior in pre-v6.4 <application>pg_dump</application>. <para>
Specifies the output file. Defaults to <filename>stdout</filename>.
<varlistentry> </para>
<term> </listitem>
-N </varlistentry>
</term>
<listitem> <varlistentry>
<para> <term>
Include double quotes around identifiers. -n
This is the default. </term>
<listitem>
<varlistentry> <para>
<term> Suppress double quotes around identifiers unless absolutely necessary.
-o This may cause trouble loading this dumped data if there are reserved words
</term> used for identifiers.
<listitem> This was the default behavior in pre-v6.4 <application>pg_dump</application>.
<para> </para>
Dump object identifiers (<acronym>OID</acronym>s) for every table. </listitem>
</varlistentry>
<varlistentry>
<term> <varlistentry>
-s <term>
</term> -N
<listitem> </term>
<para> <listitem>
Dump out only the schema (definitions), no data. <para>
Include double quotes around identifiers.
<varlistentry> This is the default.
<term> </para>
-t <replaceable class="parameter">table</replaceable> </listitem>
</term> </varlistentry>
<listitem>
<para> <varlistentry>
Dump data for <replaceable class="parameter">table</replaceable> only. <term>
-o
<varlistentry> </term>
<term> <listitem>
-u <para>
</term> Dump object identifiers (<acronym>OID</acronym>s) for every table.
<listitem> </para>
<para> </listitem>
Use password authentication. Prompts for username and password. </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
-v -s
</term> </term>
<listitem> <listitem>
<para> <para>
Specifies verbose mode Dump out only the schema (definitions), no data.
</para>
<varlistentry> </listitem>
<term> </varlistentry>
-z
</term> <varlistentry>
<listitem> <term>
<para> -t <replaceable class="parameter">table</replaceable>
Include ACLs (grant/revoke commands) and table ownership information. </term>
<listitem>
</variablelist> <para>
Dump data for <replaceable class="parameter">table</replaceable> only.
<para> </para>
<application>pg_dump</application> also accepts </listitem>
the following command line arguments for connection parameters: </varlistentry>
<variablelist> <varlistentry>
<varlistentry> <term>
<term> -u
-h <replaceable class="parameter">host</replaceable> </term>
</term> <listitem>
<listitem> <para>
<para> Use password authentication. Prompts for username and password.
Specifies the hostname of the machine on which the </para>
<application>postmaster</application> </listitem>
is running. Defaults to using a local Unix domain socket </varlistentry>
rather than an IP connection..
<varlistentry>
<varlistentry> <term>
<term> -v
-p <replaceable class="parameter">port</replaceable> </term>
</term> <listitem>
<listitem> <para>
<para> Specifies verbose mode
Specifies the Internet TCP/IP port or local Unix domain socket file </para>
extension on which the <application>postmaster</application> </listitem>
is listening for connections. The port number defaults to 5432, </varlistentry>
or the value of the <envar>PGPORT</envar>
environment variable (if set). <varlistentry>
<term>
<varlistentry> -z
<term> </term>
-u <listitem>
</term> <para>
<listitem> Include ACLs (grant/revoke commands) and table ownership information.
<para> </para>
Use password authentication. </listitem>
Prompts for </varlistentry>
<replaceable class="parameter">username</replaceable>
and <replaceable class="parameter">password</replaceable>. </variablelist>
</para>
</variablelist> <para>
<application>pg_dump</application> also accepts
<REFSECT2 ID="R2-APP-PG-DUMP-2"> the following command line arguments for connection parameters:
<REFSECT2INFO>
<DATE>1998-11-05</DATE> <variablelist>
</REFSECT2INFO> <varlistentry>
<TITLE> <term>
Outputs -h <replaceable class="parameter">host</replaceable>
</TITLE> </term>
<PARA> <listitem>
<application>pg_dump</application> will create a file or <para>
write to <filename>stdout</filename>. Specifies the hostname of the machine on which the
<application>postmaster</application>
<variablelist> is running. Defaults to using a local Unix domain socket
<varlistentry> rather than an IP connection..
<term> </para>
Connection to database 'template1' failed. </listitem>
connectDB() failed: Is the postmaster running and accepting connections </varlistentry>
at 'UNIX Socket' on port '<replaceable class="parameter">port</replaceable>'?
<listitem> <varlistentry>
<para> <term>
<application>pg_dump</application> could not attach to the -p <replaceable class="parameter">port</replaceable>
<application>postmaster</application> </term>
process on the specified host and port. If you see this message, <listitem>
ensure that the <application>postmaster</application> <para>
is running on the proper host and that you have specified the proper Specifies the Internet TCP/IP port or local Unix domain socket file
port. If your site uses an authentication system, ensure that you extension on which the <application>postmaster</application>
have obtained the required authentication credentials. is listening for connections. The port number defaults to 5432,
or the value of the <envar>PGPORT</envar>
<varlistentry> environment variable (if set).
<term> </para>
Connection to database '<replaceable class="parameter">dbname</replaceable>' failed. </listitem>
FATAL 1: SetUserId: user '<replaceable class="parameter">username</replaceable>' is not in 'pg_shadow' </varlistentry>
<listitem>
<para> <varlistentry>
You do not have a valid entry in the relation <literal>pg_shadow</literal> <term>
and and will not be allowed to access <productname>Postgres</productname>. -u
Contact your <productname>Postgres</productname> administrator. </term>
<listitem>
<varlistentry> <para>
<term> Use password authentication.
dumpSequence(<replaceable class="parameter">table</replaceable>): SELECT failed Prompts for
<listitem> <replaceable class="parameter">username</replaceable>
<para> and <replaceable class="parameter">password</replaceable>.
You do not have permission to read the database. </para>
Contact your <productname>Postgres</productname> site administrator. </listitem>
</varlistentry>
</variablelist>
</variablelist>
<note> </para>
<para> </refsect2>
<application>pg_dump</application> internally executes
<command>SELECT</command> statements. If you have problems running <REFSECT2 ID="R2-APP-PG-DUMP-2">
<application>pg_dump</application>, <REFSECT2INFO>
make sure you are able to select information from the database using, for <DATE>1998-11-05</DATE>
example, <application>psql</application>. </REFSECT2INFO>
</note> <TITLE>
Outputs
<REFSECT1 ID="R1-APP-PG-DUMP-1"> </TITLE>
<REFSECT1INFO> <PARA>
<DATE>1998-11-05</DATE> <application>pg_dump</application> will create a file or
</REFSECT1INFO> write to <filename>stdout</filename>.
<TITLE>
Description <variablelist>
</TITLE> <varlistentry>
<PARA> <term>
<application>pg_dump</application> is a utility for dumping out a Connection to database 'template1' failed.
<productname>Postgres</productname> database into a script file connectDB() failed: Is the postmaster running and accepting connections
containing query commands. The script at 'UNIX Socket' on port '<replaceable class="parameter">port</replaceable>'?
files are in text format and can be used to reconstruct the database, </term>
even on other machines and other architectures. <listitem>
<application>pg_dump</application> <para>
will produce the queries necessary to re-generate all <application>pg_dump</application> could not attach to the
user-defined types, functions, tables, indices, aggregates, and <application>postmaster</application>
operators. In addition, all the data is copied out in text format so process on the specified host and port. If you see this message,
that it can be readily copied in again, as well as imported into tools ensure that the <application>postmaster</application>
for editing. is running on the proper host and that you have specified the proper
port. If your site uses an authentication system, ensure that you
<para> have obtained the required authentication credentials.
<application>pg_dump</application> </para>
is useful for dumping out the contents of a database to move from one </listitem>
<productname>Postgres</productname> installation to another. After running </varlistentry>
<application>pg_dump</application>,
one should examine the output script file for any warnings, especially <varlistentry>
in light of the limitations listed below. <term>
Connection to database '<replaceable class="parameter">dbname</replaceable>' failed.
<REFSECT1 ID="R1-APP-PG-DUMP-2"> FATAL 1: SetUserId: user '<replaceable class="parameter">username</replaceable>' is not in 'pg_shadow'
<REFSECT1INFO> </term>
<DATE>1998-11-05</DATE> <listitem>
</REFSECT1INFO> <para>
<TITLE> You do not have a valid entry in the relation <literal>pg_shadow</literal>
Notes and and will not be allowed to access <productname>Postgres</productname>.
</TITLE> Contact your <productname>Postgres</productname> administrator.
<PARA> </para>
<application>pg_dump</application> has a few limitations. </listitem>
The limitations mostly stem from </varlistentry>
difficulty in extracting certain meta-information from the system
catalogs. <varlistentry>
<term>
<variablelist> dumpSequence(<replaceable class="parameter">table</replaceable>): SELECT failed
<varlistentry> </term>
<term> <listitem>
partial indices <para>
<listitem> You do not have permission to read the database.
<para> Contact your <productname>Postgres</productname> site administrator.
<application>pg_dump</application> </para>
does not understand partial indices. The reason is </listitem>
the same as above; partial index predicates are stored as plans. </varlistentry>
<varlistentry> </variablelist>
<term> </para>
large objects <note>
<listitem> <para>
<para> <application>pg_dump</application> internally executes
<application>pg_dump</application> does not handle large objects. <command>SELECT</command> statements. If you have problems running
Large objects are ignored and must be dealt with manually. <application>pg_dump</application>,
make sure you are able to select information from the database using, for
</variablelist> example, <application>psql</application>.
</para>
<REFSECT1 ID="R1-APP-PG-DUMP-3"> </note>
<REFSECT1INFO> </refsect2>
<DATE>1998-11-05</DATE> </refsynopsisdiv>
</REFSECT1INFO>
<TITLE> <REFSECT1 ID="R1-APP-PG-DUMP-1">
Usage <REFSECT1INFO>
</TITLE> <DATE>1998-11-05</DATE>
<PARA> </REFSECT1INFO>
To dump a database of the same name as the user: <TITLE>
Description
<programlisting> </TITLE>
% pg_dump > db.out <PARA>
</programlisting> <application>pg_dump</application> is a utility for dumping out a
<productname>Postgres</productname> database into a script file
<para> containing query commands. The script
To reload this database: files are in text format and can be used to reconstruct the database,
even on other machines and other architectures.
<programlisting> <application>pg_dump</application>
psql -e database < db.out will produce the queries necessary to re-generate all
</programlisting> user-defined types, functions, tables, indices, aggregates, and
operators. In addition, all the data is copied out in text format so
that it can be readily copied in again, as well as imported into tools
for editing.
</para>
<para>
<application>pg_dump</application>
is useful for dumping out the contents of a database to move from one
<productname>Postgres</productname> installation to another. After running
<application>pg_dump</application>,
one should examine the output script file for any warnings, especially
in light of the limitations listed below.
</para>
</refsect1>
<REFSECT1 ID="R1-APP-PG-DUMP-2">
<REFSECT1INFO>
<DATE>1998-11-05</DATE>
</REFSECT1INFO>
<TITLE>
Notes
</TITLE>
<PARA>
<application>pg_dump</application> has a few limitations.
The limitations mostly stem from
difficulty in extracting certain meta-information from the system
catalogs.
<variablelist>
<varlistentry>
<term>
partial indices
</term>
<listitem>
<para>
<application>pg_dump</application>
does not understand partial indices. The reason is
the same as above; partial index predicates are stored as plans.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
large objects
</term>
<listitem>
<para>
<application>pg_dump</application> does not handle large objects.
Large objects are ignored and must be dealt with manually.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<REFSECT1 ID="R1-APP-PG-DUMP-3">
<REFSECT1INFO>
<DATE>1998-11-05</DATE>
</REFSECT1INFO>
<TITLE>
Usage
</TITLE>
<PARA>
To dump a database of the same name as the user:
<programlisting>
% pg_dump > db.out
</programlisting>
</para>
<para>
To reload this database:
<programlisting>
psql -e database < db.out
</programlisting>
</para>
</refsect1>
</REFENTRY> </REFENTRY>
doc/src/sgml/ref/pg_dumpall.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ ...@@ -12,6 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Extract all <productname>Postgres</productname> databases into a script file Extract all <productname>Postgres</productname> databases into a script file
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-10-04</DATE> <DATE>1998-10-04</DATE>
...@@ -22,246 +23,301 @@ pg_dumpall [ -h <replaceable class="parameter">host</replaceable> ] [ -p <replac ...@@ -22,246 +23,301 @@ pg_dumpall [ -h <replaceable class="parameter">host</replaceable> ] [ -p <replac
[ -a ] [ -d ] [ -D ] [ -o ] [ -s ] [ -u ] [ -v ] [ -z ] [ -a ] [ -d ] [ -D ] [ -o ] [ -s ] [ -u ] [ -v ] [ -z ]
</SYNOPSIS> </SYNOPSIS>
<REFSECT2 ID="R2-APP-PG-DUMPALL-1"> <REFSECT2 ID="R2-APP-PG-DUMPALL-1">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-10-04</DATE> <DATE>1998-10-04</DATE>
</REFSECT2INFO> </REFSECT2INFO>
<TITLE> <TITLE>
Inputs Inputs
</TITLE> </TITLE>
<PARA> <PARA>
<application>pg_dumpall</application> accepts the following command line arguments: <application>pg_dumpall</application> accepts the following command line arguments:
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>
-a -a
</term> </term>
<listitem> <listitem>
<para> <para>
Dump out only the data, no schema (definitions). Dump out only the data, no schema (definitions).
</para>
<varlistentry> </listitem>
<term> </varlistentry>
-d <varlistentry>
</term> <term>
<listitem> -d
<para> </term>
Dump data as proper insert strings. <listitem>
<para>
<varlistentry> Dump data as proper insert strings.
<term> </para>
-D </listitem>
</term> </varlistentry>
<listitem>
<para> <varlistentry>
Dump data as inserts with attribute names <term>
-D
<varlistentry> </term>
<term> <listitem>
-n <para>
</term> Dump data as inserts with attribute names
<listitem> </para>
<para> </listitem>
Suppress double quotes around identifiers unless absolutely necessary. </varlistentry>
This may cause trouble loading this dumped data if there are reserved words
used for identifiers. <varlistentry>
<term>
<varlistentry> -n
<term> </term>
-o <listitem>
</term> <para>
<listitem> Suppress double quotes around identifiers unless absolutely necessary.
<para> This may cause trouble loading this dumped data if there are reserved words
Dump object identifiers (<acronym>OID</acronym>s) for every table. used for identifiers.
</para>
<varlistentry> </listitem>
<term> </varlistentry>
-s
</term> <varlistentry>
<listitem> <term>
<para> -o
Dump out only the schema (definitions), no data. </term>
<listitem>
<varlistentry> <para>
<term> Dump object identifiers (<acronym>OID</acronym>s) for every table.
-u </para>
</term> </listitem>
<listitem> </varlistentry>
<para>
Use password authentication. Prompts for username and password. <varlistentry>
<term>
<varlistentry> -s
<term> </term>
-v <listitem>
</term> <para>
<listitem> Dump out only the schema (definitions), no data.
<para> </para>
Specifies verbose mode </listitem>
</varlistentry>
<varlistentry>
<term> <varlistentry>
-z <term>
</term> -u
<listitem> </term>
<para> <listitem>
Include ACLs (grant/revoke commands) and table ownership information. <para>
Use password authentication. Prompts for username and password.
</variablelist> </para>
</listitem>
<para> </varlistentry>
<application>pg_dumpall</application> also accepts
the following command line arguments for connection parameters: <varlistentry>
<term>
<variablelist> -v
<varlistentry> </term>
<term> <listitem>
-h <replaceable class="parameter">host</replaceable> <para>
</term> Specifies verbose mode
<listitem> </para>
<para> </listitem>
Specifies the hostname of the machine on which the </varlistentry>
<application>postmaster</application>
is running. Defaults to using a local Unix domain socket <varlistentry>
rather than an IP connection.. <term>
-z
<varlistentry> </term>
<term> <listitem>
-p <replaceable class="parameter">port</replaceable> <para>
</term> Include ACLs (grant/revoke commands) and table ownership information.
<listitem> </para>
<para> </listitem>
Specifies the Internet TCP/IP port or local Unix domain socket file </varlistentry>
extension on which the <application>postmaster</application>
is listening for connections. The port number defaults to 5432, </variablelist>
or the value of the <envar>PGPORT</envar> </para>
environment variable (if set). <para>
<application>pg_dumpall</application> also accepts
<varlistentry> the following command line arguments for connection parameters:
<term>
-u <variablelist>
</term> <varlistentry>
<listitem> <term>
<para> -h <replaceable class="parameter">host</replaceable>
Use password authentication. </term>
Prompts for <listitem>
<replaceable class="parameter">username</replaceable> <para>
and <replaceable class="parameter">password</replaceable>. Specifies the hostname of the machine on which the
<application>postmaster</application>
</variablelist> is running. Defaults to using a local Unix domain socket
rather than an IP connection..
<REFSECT2 ID="R2-APP-PG-DUMPALL-2"> </para>
<REFSECT2INFO> </listitem>
<DATE>1998-10-04</DATE> </varlistentry>
</REFSECT2INFO>
<TITLE> <varlistentry>
Outputs <term>
</TITLE> -p <replaceable class="parameter">port</replaceable>
<PARA> </term>
<application>pg_dumpall</application> will create a file or <listitem>
write to <filename>stdout</filename>. <para>
Specifies the Internet TCP/IP port or local Unix domain socket file
<variablelist> extension on which the <application>postmaster</application>
<varlistentry> is listening for connections. The port number defaults to 5432,
<term> or the value of the <envar>PGPORT</envar>
Connection to database 'template1' failed. environment variable (if set).
connectDB() failed: Is the postmaster running and accepting connections </para>
at 'UNIX Socket' on port '<replaceable class="parameter">port</replaceable>'? </listitem>
<listitem> </varlistentry>
<para>
<application>pg_dumpall</application> could not attach to the <varlistentry>
<application>postmaster</application> <term>
process on the specified host and port. If you see this message, -u
ensure that the <application>postmaster</application> </term>
is running on the proper host and that you have specified the proper <listitem>
port. If your site uses an authentication system, ensure that you <para>
have obtained the required authentication credentials. Use password authentication.
Prompts for
<varlistentry> <replaceable class="parameter">username</replaceable>
<term> and <replaceable class="parameter">password</replaceable>.
Connection to database '<replaceable class="parameter">dbname</replaceable>' failed. </para>
FATAL 1: SetUserId: user '<replaceable class="parameter">username</replaceable>' is not in 'pg_shadow' </listitem>
<listitem> </varlistentry>
<para> </variablelist>
You do not have a valid entry in the relation <literal>pg_shadow</literal> </para>
and and will not be allowed to access <productname>Postgres</productname>. </refsect2>
Contact your <productname>Postgres</productname> administrator.
<REFSECT2 ID="R2-APP-PG-DUMPALL-2">
<varlistentry> <REFSECT2INFO>
<term> <DATE>1998-10-04</DATE>
dumpSequence(<replaceable class="parameter">table</replaceable>): SELECT failed </REFSECT2INFO>
<listitem> <TITLE>
<para> Outputs
You do not have permission to read the database. </TITLE>
Contact your <productname>Postgres</productname> site administrator. <PARA>
<application>pg_dumpall</application> will create a file or
</variablelist> write to <filename>stdout</filename>.
<note> <variablelist>
<para> <varlistentry>
<application>pg_dumpall</application> internally executes <term>
<command>SELECT</command> statements. If you have problems running Connection to database 'template1' failed.
<application>pg_dumpall</application>, connectDB() failed: Is the postmaster running and accepting connections
make sure you are able to select information from the database using, for at 'UNIX Socket' on port '<replaceable class="parameter">port</replaceable>'?
example, <application>psql</application>. </term>
</note> <listitem>
<para>
<REFSECT1 ID="R1-APP-PG-DUMPALL-1"> <application>pg_dumpall</application> could not attach to the
<REFSECT1INFO> <application>postmaster</application>
<DATE>1998-10-04</DATE> process on the specified host and port. If you see this message,
</REFSECT1INFO> ensure that the <application>postmaster</application>
<TITLE> is running on the proper host and that you have specified the proper
Description port. If your site uses an authentication system, ensure that you
</TITLE> have obtained the required authentication credentials.
<PARA> </para>
<application>pg_dumpall</application> </listitem>
is a utility for dumping out all Postgres databases into one file. </varlistentry>
It also dumps the pg_shadow table, which is global to all databases.
<application>pg_dumpall</application> includes in this file the proper commands <varlistentry>
to automatically create each dumped database before loading. <term>
Connection to database '<replaceable class="parameter">dbname</replaceable>' failed.
<para> FATAL 1: SetUserId: user '<replaceable class="parameter">username</replaceable>' is not in 'pg_shadow'
<application>pg_dumpall</application> takes all <application>pg_dump</application> </term>
options, but <option>-f</option>, <option>-t</option> and <listitem>
<replaceable class="parameter">dbname</replaceable> <para>
should be omitted. You do not have a valid entry in the relation <literal>pg_shadow</literal>
and and will not be allowed to access <productname>Postgres</productname>.
<para> Contact your <productname>Postgres</productname> administrator.
Refer to </para>
<xref linkend="app-pg-dump" endterm="pg-dump"> </listitem>
for more information on this capability. </varlistentry>
<REFSECT1 ID="R1-APP-PG-DUMPALL-2"> <varlistentry>
<REFSECT1INFO> <term>
<DATE>1998-10-04</DATE> dumpSequence(<replaceable class="parameter">table</replaceable>): SELECT failed
</REFSECT1INFO> </term>
<TITLE> <listitem>
Usage <para>
</TITLE> You do not have permission to read the database.
<PARA> Contact your <productname>Postgres</productname> site administrator.
To dump all databases: </para>
</listitem>
<programlisting> </varlistentry>
% pg_dumpall -o > db.out </variablelist>
</programlisting> </para>
<tip> <note>
<para> <para>
You can use most <application>pg_dump</application> options <application>pg_dumpall</application> internally executes
for <application>pg_dumpall</application>. <command>SELECT</command> statements. If you have problems running
</tip> <application>pg_dumpall</application>,
make sure you are able to select information from the database using, for
<para> example, <application>psql</application>.
To reload this database: </para>
</note>
<programlisting> </refsect2>
psql -e template1 < db.out </refsynopsisdiv>
</programlisting>
<REFSECT1 ID="R1-APP-PG-DUMPALL-1">
<tip> <REFSECT1INFO>
<para> <DATE>1998-10-04</DATE>
You can use most <application>psql</application> options </REFSECT1INFO>
when reloading. <TITLE>
</tip> Description
</TITLE>
<PARA>
<application>pg_dumpall</application>
is a utility for dumping out all Postgres databases into one file.
It also dumps the pg_shadow table, which is global to all databases.
<application>pg_dumpall</application> includes in this file the proper commands
to automatically create each dumped database before loading.
</para>
<para>
<application>pg_dumpall</application> takes all <application>pg_dump</application>
options, but <option>-f</option>, <option>-t</option> and
<replaceable class="parameter">dbname</replaceable>
should be omitted.
</para>
<para>
Refer to
<xref linkend="app-pg-dump" endterm="pg-dump">
for more information on this capability.
</para
</refsect1>
<REFSECT1 ID="R1-APP-PG-DUMPALL-2">
<REFSECT1INFO>
<DATE>1998-10-04</DATE>
</REFSECT1INFO>
<TITLE>
Usage
</TITLE>
<PARA>
To dump all databases:
<programlisting>
% pg_dumpall -o > db.out
</programlisting>
<tip>
<para>
You can use most <application>pg_dump</application> options
for <application>pg_dumpall</application>.
</para>
</tip>
</para>
<para>
To reload this database:
<programlisting>
psql -e template1 < db.out
</programlisting>
</para>
<tip>
<para>
You can use most <application>psql</application> options
when reloading.
</para>
</tip>
</refsect1>
</REFENTRY> </REFENTRY>
doc/src/sgml/ref/psql-ref.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ ...@@ -12,6 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
<productname>Postgres</productname> interactive client <productname>Postgres</productname> interactive client
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-26</DATE> <DATE>1998-09-26</DATE>
...@@ -23,851 +24,1029 @@ psql -A [ -c <replaceable class="parameter">query</replaceable> ] [ -d <replacea ...@@ -23,851 +24,1029 @@ psql -A [ -c <replaceable class="parameter">query</replaceable> ] [ -d <replacea
[ -o <replaceable class="parameter">filename</replaceable> ] [ -p <replaceable class="parameter">port</replaceable> ] -qsSt ] [ -T <replaceable class="parameter">table_options</replaceable> ] -ux [ <replaceable class="parameter">dbname</replaceable> ] [ -o <replaceable class="parameter">filename</replaceable> ] [ -p <replaceable class="parameter">port</replaceable> ] -qsSt ] [ -T <replaceable class="parameter">table_options</replaceable> ] -ux [ <replaceable class="parameter">dbname</replaceable> ]
</SYNOPSIS> </SYNOPSIS>
<REFSECT2 ID="R2-APP-PSQL-1"> <REFSECT2 ID="R2-APP-PSQL-1">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-09-26</DATE> <DATE>1998-09-26</DATE>
</REFSECT2INFO> </REFSECT2INFO>
<TITLE> <TITLE>
Inputs Inputs
</TITLE> </TITLE>
<PARA> <PARA>
<application>psql</application> accepts many command-line arguments, <application>psql</application> accepts many command-line arguments,
a rich set of meta-commands, and the full <acronym>SQL</acronym> language a rich set of meta-commands, and the full <acronym>SQL</acronym> language
supported by <productname>Postgres</productname>. The most common supported by <productname>Postgres</productname>. The most common
command-line arguments are: command-line arguments are:
<VARIABLELIST> <VARIABLELIST>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<REPLACEABLE CLASS="PARAMETER">dbname</REPLACEABLE> <REPLACEABLE CLASS="PARAMETER">dbname</REPLACEABLE>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
The name of an existing database to access. The name of an existing database to access.
<replaceable class="parameter">dbname</replaceable> <replaceable class="parameter">dbname</replaceable>
defaults to the value of the defaults to the value of the
<envar>USER</envar> <envar>USER</envar>
environment variable or, if that's not set, to the Unix account name of the environment variable or, if that's not set, to the Unix account name of the
current user. current user.
</PARA> </PARA>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
-c <replaceable class="parameter">query</replaceable> -c <replaceable class="parameter">query</replaceable>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
A single query to run. <application>psql</application> will exit on completion. A single query to run. <application>psql</application> will exit on completion.
</PARA> </PARA>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
</variablelist> </variablelist>
</para>
<para> <para>
The full set of command-line arguments and meta-commands are described in a subsequent The full set of command-line arguments and meta-commands are described in a subsequent
section. section.
</para>
<para> <para>
There are some environment variables which can be used in liu of There are some environment variables which can be used in liu of
command line arguments. command line arguments.
Additionally, the <productname>Postgres</productname> frontend library used by Additionally, the <productname>Postgres</productname> frontend library used by
the <application>psql</application> application the <application>psql</application> application
looks for other optional environment variables to configure, for example, looks for other optional environment variables to configure, for example,
the style of date/time representation and the local time zone. Refer the style of date/time representation and the local time zone. Refer
to the chapter on <filename>libpq</filename> in the to the chapter on <filename>libpq</filename> in the
<citetitle>Programmer's Guide</citetitle> for more details. <citetitle>Programmer's Guide</citetitle> for more details.
</para>
<para> <para>
You may set any of the following environment variables to avoid You may set any of the following environment variables to avoid
specifying command-line options: specifying command-line options:
<VARIABLELIST> <VARIABLELIST>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<envar>PGHOST</envar> <envar>PGHOST</envar>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
The <acronym>DNS</acronym> host name of the database server. The <acronym>DNS</acronym> host name of the database server.
Setting <envar>PGHOST</envar> to a non-zero-length string causes Setting <envar>PGHOST</envar> to a non-zero-length string causes
<acronym>TCP/IP</acronym> communication <acronym>TCP/IP</acronym> communication
to be used, rather than the default local Unix domain sockets. to be used, rather than the default local Unix domain sockets.
</PARA> </PARA>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<envar>PGPORT</envar> <envar>PGPORT</envar>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
The port number on which a <productname>Postgres</productname> server is listening. The port number on which a <productname>Postgres</productname> server is listening.
Defaults to <literal>5432</literal>. Defaults to <literal>5432</literal>.
</PARA> </PARA>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<envar>PGTTY</envar> <envar>PGTTY</envar>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
The target for display of messages from the client support library. The target for display of messages from the client support library.
Not required. Not required.
</PARA> </PARA>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<envar>PGOPTION</envar> <envar>PGOPTION</envar>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
If <envar>PGOPTION</envar> If <envar>PGOPTION</envar>
is specified, then the options it contains are parsed is specified, then the options it contains are parsed
<emphasis>before</emphasis> <emphasis>before</emphasis>
any command-line options. any command-line options.
</PARA> </PARA>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<envar>PGREALM</envar> <envar>PGREALM</envar>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
<envar>PGREALM</envar> <envar>PGREALM</envar>
only applies if only applies if
<productname>Kerberos</productname> <productname>Kerberos</productname>
authentication is in use. authentication is in use.
If this environment variable is set, <productname>Postgres</productname> If this environment variable is set, <productname>Postgres</productname>
will attempt authentication with servers for this realm and will use will attempt authentication with servers for this realm and will use
separate ticket files to avoid conflicts with local ticket files. separate ticket files to avoid conflicts with local ticket files.
See the <citetitle>PostgreSQL Administrator's Guide</citetitle> See the <citetitle>PostgreSQL Administrator's Guide</citetitle>
for additional information on for additional information on
<productname>Kerberos</productname>. <productname>Kerberos</productname>.
</para>
</variablelist> </listitem>
</varlistentry>
<REFSECT2 ID="R2-APP-PSQL-2"> </variablelist>
<REFSECT2INFO> </para>
<DATE>1998-09-26</DATE> </refsect2>
</REFSECT2INFO>
<TITLE> <REFSECT2 ID="R2-APP-PSQL-2">
Outputs <REFSECT2INFO>
</TITLE> <DATE>1998-09-26</DATE>
<PARA> </REFSECT2INFO>
<TITLE>
<application>psql</application> Outputs
returns 0 to the shell on successful completion of all queries, </TITLE>
1 for errors, 2 for abrupt disconnection from the backend. <PARA>
The default TAB delimiter is used.
<application>psql</application> <application>psql</application>
will also return 1 if the connection to a database could not be made for returns 0 to the shell on successful completion of all queries,
any reason. 1 for errors, 2 for abrupt disconnection from the backend.
The default TAB delimiter is used.
<REFSECT1 ID="R1-APP-PSQL-1"> <application>psql</application>
<REFSECT1INFO> will also return 1 if the connection to a database could not be made for
<DATE>1998-09-26</DATE> any reason.
</REFSECT1INFO> </para>
<TITLE> </refsect2>
Description </refsynopsisdiv>
</TITLE>
<PARA> <REFSECT1 ID="R1-APP-PSQL-1">
<application>psql</application> is a character-based front-end to <REFSECT1INFO>
<productname>Postgres</productname>. <DATE>1998-09-26</DATE>
It enables you to </REFSECT1INFO>
type in queries interactively, issue them to <productname>Postgres</productname>, <TITLE>
and see the query Description
results. </TITLE>
<PARA>
<para> <application>psql</application> is a character-based front-end to
<application>psql</application> <productname>Postgres</productname>.
is a <productname>Postgres</productname> client application. Hence, a It enables you to
<application>postmaster</application> process type in queries interactively, issue them to <productname>Postgres</productname>,
must be running on the database server host before and see the query
<application>psql</application> results.
is executed. In addition, the correct parameters to identify </para>
the database server, such as the <para>
<application>postmaster</application> host name, <application>psql</application>
may need to be specified is a <productname>Postgres</productname> client application. Hence, a
as described below. <application>postmaster</application> process
must be running on the database server host before
<para> <application>psql</application>
When is executed. In addition, the correct parameters to identify
<application>psql</application> the database server, such as the
starts, it reads SQL commands from <application>postmaster</application> host name,
<filename>/etc/psqlrc</filename> may need to be specified
and then from as described below.
<filename>$(<envar>HOME</envar>)/.psqlrc</filename> </para>
This allows SQL commands like <para>
<command>SET</command> When
which can be used to set the date style to be run at the start of <application>psql</application>
every session. starts, it reads SQL commands from
<filename>/etc/psqlrc</filename>
<REFSECT2 ID="R2-APP-PSQL-3"> and then from
<REFSECT2INFO> <filename>$(<envar>HOME</envar>)/.psqlrc</filename>
<DATE>1998-09-26</DATE> This allows SQL commands like
</REFSECT2INFO> <command>SET</command>
<TITLE> which can be used to set the date style to be run at the start of
Connecting To A Database every session.
</TITLE> </para>
<para>
<application>psql</application> <REFSECT2 ID="R2-APP-PSQL-3">
attempts to make a connection to the database at the hostname and <REFSECT2INFO>
port number specified on the command line. If the connection could not <DATE>1998-09-26</DATE>
be made for any reason (e.g. insufficient privileges, postmaster is not </REFSECT2INFO>
running on the server, etc) <TITLE>
.IR <application>psql</application> Connecting To A Database
will return an error that says </TITLE>
<programlisting> <para>
Connection to database failed. <application>psql</application>
</programlisting> attempts to make a connection to the database at the hostname and
The reason for the connection failure is not provided. port number specified on the command line. If the connection could not
be made for any reason (e.g. insufficient privileges, postmaster is not
<REFSECT2 ID="R2-APP-PSQL-4"> running on the server, etc)
<REFSECT2INFO> .IR <application>psql</application>
<DATE>1998-09-26</DATE> will return an error that says
</REFSECT2INFO> <programlisting>
<TITLE> Connection to database failed.
Entering Queries </programlisting>
</TITLE> The reason for the connection failure is not provided.
<para> </para>
In normal operation, </refsect2>
<application>psql</application> provides a prompt with the name of the
database that <application>psql</application> is current connected to <REFSECT2 ID="R2-APP-PSQL-4">
followed by the string "=>". <REFSECT2INFO>
For example, <DATE>1998-09-26</DATE>
<programlisting> </REFSECT2INFO>
$ <userinput>psql testdb</userinput> <TITLE>
Welcome to the POSTGRESQL interactive sql monitor: Entering Queries
Please read the file COPYRIGHT for copyright terms of POSTGRESQL </TITLE>
<para>
type \e? for help on slash commands In normal operation,
type \eq to quit <application>psql</application> provides a prompt with the name of the
type \eg or terminate with semicolon to execute query database that <application>psql</application> is current connected to
You are currently connected to the database: testdb followed by the string "=>".
For example,
testdb=> <programlisting>
</programlisting> $ <userinput>psql testdb</userinput>
Welcome to the POSTGRESQL interactive sql monitor:
<para> Please read the file COPYRIGHT for copyright terms of POSTGRESQL
At the prompt, the user may type in <acronym>SQL</acronym> queries.
Unless the -S option type \e? for help on slash commands
is set, input lines are sent to the backend when a query-terminating type \eq to quit
semicolon is reached. type \eg or terminate with semicolon to execute query
You are currently connected to the database: testdb
<para>
Whenever a query is executed, testdb=>
<application>psql</application> also polls for asynchronous notification </programlisting>
events generated by <command>LISTEN</command> and <command>NOTIFY</command>. </para>
<para>
<para> At the prompt, the user may type in <acronym>SQL</acronym> queries.
<application>psql</application> Unless the -S option
can be used in a pipe sequence, and automatically detects when it is set, input lines are sent to the backend when a query-terminating
is not listening or talking to a real tty. semicolon is reached.
</para>
<REFSECT1 ID="R1-APP-PSQL-2"> <para>
<REFSECT1INFO> Whenever a query is executed,
<DATE>1998-09-26</DATE> <application>psql</application> also polls for asynchronous notification
</REFSECT1INFO> events generated by <command>LISTEN</command> and <command>NOTIFY</command>.
<TITLE> </para>
Command-line Options <para>
</TITLE> <application>psql</application>
<para> can be used in a pipe sequence, and automatically detects when it
<application>psql</application> is not listening or talking to a real tty.
understands the following command-line options: </para>
</refsect2>
<VARIABLELIST> </refsect1>
<VARLISTENTRY>
<TERM> <REFSECT1 ID="R1-APP-PSQL-2">
-A <REFSECT1INFO>
</TERM> <DATE>1998-09-26</DATE>
<LISTITEM> </REFSECT1INFO>
<PARA> <TITLE>
Turn off fill justification when printing out table elements. Command-line Options
</TITLE>
<VARLISTENTRY> <para>
<TERM> <application>psql</application>
-c <replaceable class="parameter">query</replaceable> understands the following command-line options:
</TERM>
<LISTITEM> <VARIABLELIST>
<PARA> <VARLISTENTRY>
Specifies that <TERM>
<application>psql</application> -A
is to execute one query string, </TERM>
<replaceable class="parameter">query</replaceable>, <LISTITEM>
and then exit. This is useful for shell scripts, typically in <PARA>
conjunction with the <option>-q</option> option in shell scripts. Turn off fill justification when printing out table elements.
</para>
<VARLISTENTRY> </listitem>
<TERM> </varlistentry>
-d <replaceable class="parameter">dbname</replaceable>
</TERM> <VARLISTENTRY>
<LISTITEM> <TERM>
<PARA> -c <replaceable class="parameter">query</replaceable>
Specifies the name of the database to connect to. This is equivalent to specifying </TERM>
<replaceable class="parameter">dbname</replaceable> as the last field in the <LISTITEM>
command line. <PARA>
Specifies that
<VARLISTENTRY> <application>psql</application>
<TERM> is to execute one query string,
-e <replaceable class="parameter">query</replaceable>,
</TERM> and then exit. This is useful for shell scripts, typically in
<LISTITEM> conjunction with the <option>-q</option> option in shell scripts.
<PARA> </para>
Echo the query sent to the backend </listitem>
</varlistentry>
<VARLISTENTRY>
<TERM> <VARLISTENTRY>
-f <replaceable class="parameter">filename</replaceable> <TERM>
</TERM> -d <replaceable class="parameter">dbname</replaceable>
<LISTITEM> </TERM>
<PARA> <LISTITEM>
Use the file <replaceable class="parameter">filename</replaceable> <PARA>
as the source of queries instead of reading queries interactively. Specifies the name of the database to connect to. This is equivalent to specifying
This file must be specified for and visible to the client frontend. <replaceable class="parameter">dbname</replaceable> as the last field in the
command line.
<VARLISTENTRY> </para>
<TERM> </listitem>
-F <replaceable class="parameter">separator</replaceable> </varlistentry>
</TERM>
<LISTITEM> <VARLISTENTRY>
<PARA> <TERM>
Use <replaceable class="parameter">separator</replaceable> -e
as the field separator. </TERM>
The default is an ASCII vertical bar ("|"). <LISTITEM>
<PARA>
<VARLISTENTRY> Echo the query sent to the backend
<TERM> </para>
-h <replaceable class="parameter">hostname</replaceable> </listitem>
</TERM> </varlistentry>
<LISTITEM>
<PARA> <VARLISTENTRY>
Specifies the host name of the machine on which the <TERM>
<application>postmaster</application> -f <replaceable class="parameter">filename</replaceable>
is running. </TERM>
Without this option, communication is performed using <LISTITEM>
local Unix domain sockets. <PARA>
Use the file <replaceable class="parameter">filename</replaceable>
<VARLISTENTRY> as the source of queries instead of reading queries interactively.
<TERM> This file must be specified for and visible to the client frontend.
-H </para>
</TERM> </listitem>
<LISTITEM> </varlistentry>
<PARA>
Turns on <VARLISTENTRY>
<acronym>HTML 3.0</acronym> <TERM>
tabular output. -F <replaceable class="parameter">separator</replaceable>
</TERM>
<VARLISTENTRY> <LISTITEM>
<TERM> <PARA>
-l Use <replaceable class="parameter">separator</replaceable>
</TERM> as the field separator.
<LISTITEM> The default is an ASCII vertical bar ("|").
<PARA> </para>
Lists all available databases, then exit. Other non-connection options are ignored. </listitem>
</varlistentry>
<VARLISTENTRY>
<TERM> <VARLISTENTRY>
-n <TERM>
</TERM> -h <replaceable class="parameter">hostname</replaceable>
<LISTITEM> </TERM>
<PARA> <LISTITEM>
Do not use the readline library for input line editing and command history. <PARA>
Specifies the host name of the machine on which the
<VARLISTENTRY> <application>postmaster</application>
<TERM> is running.
-o <replaceable class="parameter">filename</replaceable> Without this option, communication is performed using
</TERM> local Unix domain sockets.
<LISTITEM> </para>
<PARA> </listitem>
Put all output into file <replaceable class="parameter">filename</replaceable>. </varlistentry>
The path must be writable by the client.
<VARLISTENTRY>
<VARLISTENTRY> <TERM>
<TERM> -H
-p <replaceable class="parameter">port</replaceable> </TERM>
</TERM> <LISTITEM>
<LISTITEM> <PARA>
<PARA> Turns on
Specifies the TCP/IP port or, by omission, the local Unix domain socket file <acronym>HTML 3.0</acronym>
extension on which the tabular output.
<application>postmaster</application> </para>
is listening for connections. Defaults to the value of the </listitem>
<envar>PGPORT</envar> </varlistentry>
environment variable, if set, or to 5432.
<VARLISTENTRY>
<VARLISTENTRY> <TERM>
<TERM> -l
-q </TERM>
</TERM> <LISTITEM>
<LISTITEM> <PARA>
<PARA> Lists all available databases, then exit. Other non-connection options are ignored.
Specifies that </para>
<application>psql</application> </listitem>
should do its work quietly. By default, it </varlistentry>
prints welcome and exit messages and prompts for each query, and prints
out the number of rows returned from a query. <VARLISTENTRY>
If this option is used, none of this happens. This is useful with the <TERM>
<option>-c</option> option. -n
</TERM>
<VARLISTENTRY> <LISTITEM>
<TERM> <PARA>
-s Do not use the readline library for input line editing and command history.
</TERM> </para>
<LISTITEM> </listitem>
<PARA> </varlistentry>
Run in single-step mode where the user is prompted for each query before
it is sent to the backend. <VARLISTENTRY>
<TERM>
<VARLISTENTRY> -o <replaceable class="parameter">filename</replaceable>
<TERM> </TERM>
-S <LISTITEM>
</TERM> <PARA>
<LISTITEM> Put all output into file <replaceable class="parameter">filename</replaceable>.
<PARA> The path must be writable by the client.
Runs in single-line mode where each query is terminated by a newline, </para>
instead of a semicolon. </listitem>
</varlistentry>
<VARLISTENTRY>
<TERM> <VARLISTENTRY>
-t <TERM>
</TERM> -p <replaceable class="parameter">port</replaceable>
<LISTITEM> </TERM>
<PARA> <LISTITEM>
Turn off printing of column names. <PARA>
This is useful with the Specifies the TCP/IP port or, by omission, the local Unix domain socket file
<option>-c</option> extension on which the
option in shell scripts. <application>postmaster</application>
is listening for connections. Defaults to the value of the
<VARLISTENTRY> <envar>PGPORT</envar>
<TERM> environment variable, if set, or to 5432.
-T <replaceable class="parameter">table_options</replaceable> </para>
</TERM> </listitem>
<LISTITEM> </varlistentry>
<PARA>
Allows you to specify options to be placed within the <VARLISTENTRY>
<sgmltag>table ...</sgmltag> tag for <acronym>HTML 3.0</acronym> <TERM>
tabular output.For example, <literal>border</literal> -q
will give you tables with borders. </TERM>
This must be used in conjunction with the <option>-H</option> option. <LISTITEM>
<PARA>
<VARLISTENTRY> Specifies that
<TERM> <application>psql</application>
-u should do its work quietly. By default, it
</TERM> prints welcome and exit messages and prompts for each query, and prints
<LISTITEM> out the number of rows returned from a query.
<PARA> If this option is used, none of this happens. This is useful with the
Asks the user for the user name and password before connecting to the database. <option>-c</option> option.
If the database does not require password authentication then these are </para>
ignored. If the option is not used (and the PGPASSWORD environment variable </listitem>
is not set) and the database requires password authentication, then the </varlistentry>
connection will fail. The user name is ignored anyway.
<VARLISTENTRY>
<VARLISTENTRY> <TERM>
<TERM> -s
-x </TERM>
</TERM> <LISTITEM>
<LISTITEM> <PARA>
<PARA> Run in single-step mode where the user is prompted for each query before
Turns on extended row format mode. When enabled each row will have its column it is sent to the backend.
names printed on the left with the column values printed on the right. </para>
This is useful for rows which are otherwise too long to fit into </listitem>
one screen line. HTML row output supports this mode also. </varlistentry>
</variablelist>
<VARLISTENTRY>
<para> <TERM>
You may set environment variables to avoid typing some of the above -S
options. See the section on environment variables below. </TERM>
<LISTITEM>
<PARA>
<REFSECT1 ID="R1-APP-PSQL-3"> Runs in single-line mode where each query is terminated by a newline,
<REFSECT1INFO> instead of a semicolon.
<DATE>1998-09-26</DATE> </para>
</REFSECT1INFO> </listitem>
<TITLE> </varlistentry>
<application>psql</application> Meta-Commands
</TITLE> <VARLISTENTRY>
<para> <TERM>
Anything you enter in <application>psql</application> -t
that begins with an unquoted backslash is a <application>psql</application> </TERM>
meta-command. Anything else is <acronym>SQL</acronym> <LISTITEM>
and simply goes into the current query buffer <PARA>
(and once you have at least one complete query, it gets automatically Turn off printing of column names.
submitted to the backend). This is useful with the
<Application>psql</Application> meta-commands are also called slash commands. <option>-c</option>
option in shell scripts.
<para> </para>
The format of a <application>psql</application> command is the backslash, </listitem>
followed immediately by </varlistentry>
a command verb, then any arguments. The arguments are separated from the
command verb and each other by any number of white space characters. <VARLISTENTRY>
<TERM>
<para> -T <replaceable class="parameter">table_options</replaceable>
With single character command verbs, you don't actually need to separate the </TERM>
command verb from the argument with white space, for historical reasons. <LISTITEM>
You should anyway. <PARA>
Allows you to specify options to be placed within the
<para> <sgmltag>table ...</sgmltag> tag for <acronym>HTML 3.0</acronym>
The following meta-commands are defined: tabular output.For example, <literal>border</literal>
will give you tables with borders.
<VARIABLELIST> This must be used in conjunction with the <option>-H</option> option.
<VARLISTENTRY> </para>
<TERM> </listitem>
<literal>\a</literal> </varlistentry>
</TERM>
<LISTITEM> <VARLISTENTRY>
<PARA> <TERM>
Toggle field alignment when printing out table elements. -u
</TERM>
<VARLISTENTRY> <LISTITEM>
<TERM> <PARA>
<literal>\C</literal> <replaceable class="parameter">caption</replaceable> Asks the user for the user name and password before connecting to the database.
</TERM> If the database does not require password authentication then these are
<LISTITEM> ignored. If the option is not used (and the PGPASSWORD environment variable
<PARA> is not set) and the database requires password authentication, then the
Set the HTML3.0 table caption to connection will fail. The user name is ignored anyway.
<quote><replaceable class="parameter">caption</replaceable></quote>. </para>
</listitem>
<VARLISTENTRY> </varlistentry>
<TERM>
<literal>\connect</literal> <replaceable class="parameter">dbname</replaceable> [ <replaceable class="parameter">username</replaceable> ] <VARLISTENTRY>
</TERM> <TERM>
<LISTITEM> -x
<PARA> </TERM>
Establish a connection to a new database, using the default <LISTITEM>
<replaceable class="parameter">username</replaceable> if none is specified. <PARA>
The previous connection is closed. Turns on extended row format mode. When enabled each row will have its column
names printed on the left with the column values printed on the right.
<VARLISTENTRY> This is useful for rows which are otherwise too long to fit into
<TERM> one screen line. HTML row output supports this mode also.
<literal>\copy</literal> <replaceable class="parameter">dbname</replaceable> { FROM | TO } <replaceable class="parameter">filename</replaceable> </para>
</TERM> </listitem>
<LISTITEM> </varlistentry>
<PARA> </variablelist>
Perform a frontend (client) copy. This is an operation that runs a SQL COPY command, </para>
but instead of the backend reading or writing the specified file, and <para>
consequently requiring backend access and special user privilege, You may set environment variables to avoid typing some of the above
<application>psql</application> reads or writes the options. See the section on environment variables below.
file and routes the data to or from the backend. The default <literal>tab</literal> </para>
delimiter is used. </refsect1>
<tip>
<para> <REFSECT1 ID="R1-APP-PSQL-3">
This operation is not as efficient as the <acronym>SQL</acronym> <REFSECT1INFO>
<command>COPY</command> command because all data must pass through the <DATE>1998-09-26</DATE>
client/server IP or socket connection. For large amounts of data this other </REFSECT1INFO>
technique may be preferable. <TITLE>
</tip> <application>psql</application> Meta-Commands
</TITLE>
<VARLISTENTRY> <para>
<TERM> Anything you enter in <application>psql</application>
<literal>\d</literal> [ <replaceable class="parameter">table</replaceable> ] that begins with an unquoted backslash is a <application>psql</application>
</TERM> meta-command. Anything else is <acronym>SQL</acronym>
<LISTITEM> and simply goes into the current query buffer
<PARA> (and once you have at least one complete query, it gets automatically
List tables in the database, or if <replaceable class="parameter">table</replaceable> submitted to the backend).
is specified, list the columns in that table. <Application>psql</Application> meta-commands are also called slash commands.
If table name is specified as an asterisk (<quote>*</quote>), </para>
list all tables and column information for each tables. <para>
The format of a <application>psql</application> command is the backslash,
<VARLISTENTRY> followed immediately by
<TERM> a command verb, then any arguments. The arguments are separated from the
<literal>\da</literal> command verb and each other by any number of white space characters.
</TERM> </para>
<LISTITEM> <para>
<PARA> With single character command verbs, you don't actually need to separate the
List all available aggregates. command verb from the argument with white space, for historical reasons.
You should anyway.
<VARLISTENTRY> </para>
<TERM> <para>
<literal>\dd</literal> <replaceable class="parameter">object</replaceable> The following meta-commands are defined:
</TERM>
<LISTITEM> <VARIABLELIST>
<PARA> <VARLISTENTRY>
List the description from <literal>pg_description</literal> <TERM>
of the specified object, which can be a <literal>\a</literal>
table, table.column, type, operator, or aggregate. </TERM>
<tip> <LISTITEM>
<para> <PARA>
Not all objects have a description in <literal>pg_description</literal>. Toggle field alignment when printing out table elements.
This meta-command can be useful to get a quick description of a native </para>
<productname>Postgres</productname> feature. </listitem>
</tip> </varlistentry>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<literal>\df</literal> <literal>\C</literal> <replaceable class="parameter">caption</replaceable>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
List functions. Set the HTML3.0 table caption to
<quote><replaceable class="parameter">caption</replaceable></quote>.
<VARLISTENTRY> </para>
<TERM> </listitem>
<literal>\di</literal> </varlistentry>
</TERM>
<LISTITEM> <VARLISTENTRY>
<PARA> <TERM>
List only indexes. <literal>\connect</literal> <replaceable class="parameter">dbname</replaceable> [ <replaceable class="parameter">username</replaceable> ]
</TERM>
<VARLISTENTRY> <LISTITEM>
<TERM> <PARA>
<literal>\do</literal> Establish a connection to a new database, using the default
</TERM> <replaceable class="parameter">username</replaceable> if none is specified.
<LISTITEM> The previous connection is closed.
<PARA> </para>
List only operators. </listitem>
</varlistentry>
<VARLISTENTRY>
<TERM> <VARLISTENTRY>
<literal>\ds</literal> <TERM>
</TERM> <literal>\copy</literal> <replaceable class="parameter">dbname</replaceable> { FROM | TO } <replaceable class="parameter">filename</replaceable>
<LISTITEM> </TERM>
<PARA> <LISTITEM>
List only sequences. <PARA>
Perform a frontend (client) copy. This is an operation that runs a SQL COPY command,
<VARLISTENTRY> but instead of the backend reading or writing the specified file, and
<TERM> consequently requiring backend access and special user privilege,
<literal>\dS</literal> <application>psql</application> reads or writes the
</TERM> file and routes the data to or from the backend. The default <literal>tab</literal>
<LISTITEM> delimiter is used.
<PARA> </para>
List system tables and indexes. <tip>
<para>
<VARLISTENTRY> This operation is not as efficient as the <acronym>SQL</acronym>
<TERM> <command>COPY</command> command because all data must pass through the
<literal>\dt</literal> client/server IP or socket connection. For large amounts of data this other
</TERM> technique may be preferable.
<LISTITEM> </para>
<PARA> </tip>
List only non-system tables. </listitem>
</varlistentry>
<VARLISTENTRY>
<TERM> <VARLISTENTRY>
<literal>\dT</literal> <TERM>
</TERM> <literal>\d</literal> [ <replaceable class="parameter">table</replaceable> ]
<LISTITEM> </TERM>
<PARA> <LISTITEM>
List types. <PARA>
List tables in the database, or if <replaceable class="parameter">table</replaceable>
<VARLISTENTRY> is specified, list the columns in that table.
<TERM> If table name is specified as an asterisk (<quote>*</quote>),
<literal>\e</literal> [ <replaceable class="parameter">filename</replaceable> ] list all tables and column information for each tables.
</TERM> </para>
<LISTITEM> </listitem>
<PARA> </varlistentry>
Edit the current query buffer or the contents of the file
<replaceable class="parameter">filename</replaceable>. <VARLISTENTRY>
<TERM>
<VARLISTENTRY> <literal>\da</literal>
<TERM> </TERM>
<literal>\E</literal> [ <replaceable class="parameter">filename</replaceable> ] <LISTITEM>
</TERM> <PARA>
<LISTITEM> List all available aggregates.
<PARA> </para>
Edit the current query buffer or the contents of the file </listitem>
<replaceable class="parameter">filename</replaceable> </varlistentry>
and execute it upon editor exit.
<VARLISTENTRY>
<VARLISTENTRY> <TERM>
<TERM> <literal>\dd</literal> <replaceable class="parameter">object</replaceable>
<literal>\f</literal> [ <replaceable class="parameter">separator</replaceable> ] </TERM>
</TERM> <LISTITEM>
<LISTITEM> <PARA>
<PARA> List the description from <literal>pg_description</literal>
Set the field separator. Default is a single blank space. of the specified object, which can be a
table, table.column, type, operator, or aggregate.
<VARLISTENTRY> </para>
<TERM> <tip>
<literal>\g</literal> [ { <replaceable class="parameter">filename</replaceable> | <literal>|</literal><replaceable class="parameter">command</replaceable> } ] <para>
</TERM> Not all objects have a description in <literal>pg_description</literal>.
<LISTITEM> This meta-command can be useful to get a quick description of a native
<PARA> <productname>Postgres</productname> feature.
Send the current query input buffer to the backend and optionally </para>
save the output in <replaceable class="parameter">filename</replaceable> </tip>
or pipe the output into a separate Unix shell to execute </listitem>
<replaceable class="parameter">command</replaceable>. </varlistentry>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<literal>\h</literal> [ <replaceable class="parameter">command</replaceable> ] <literal>\df</literal>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
Give syntax help on the specified SQL command. List functions.
If <replaceable class="parameter">command</replaceable> is not a defined SQL command </para>
(or is not documented in <application>psql</application>), or if </listitem>
<replaceable class="parameter">command</replaceable> is not specified, </varlistentry>
then <application>psql</application> will
list all the commands for which syntax help is <VARLISTENTRY>
available. If <replaceable class="parameter">command</replaceable> <TERM>
is an asterisk (<quote>*</quote>), then <literal>\di</literal>
give syntax help on all SQL commands. </TERM>
<LISTITEM>
<VARLISTENTRY> <PARA>
<TERM> List only indexes.
<literal>\H</literal> </para>
</TERM> </listitem>
<LISTITEM> </varlistentry>
<PARA>
Toggle <acronym>HTML3</acronym> output. This is equivalent to the <option>-H</option> <VARLISTENTRY>
command-line option. <TERM>
<literal>\do</literal>
<VARLISTENTRY> </TERM>
<TERM> <LISTITEM>
<literal>\i</literal> <replaceable class="parameter">filename</replaceable> <PARA>
</TERM> List only operators.
<LISTITEM> </para>
<PARA> </listitem>
Read queries from the file <replaceable class="parameter">filename</replaceable> </varlistentry>
into the query input buffer.
<VARLISTENTRY>
<VARLISTENTRY> <TERM>
<TERM> <literal>\ds</literal>
<literal>\l</literal> </TERM>
</TERM> <LISTITEM>
<LISTITEM> <PARA>
<PARA> List only sequences.
List all the databases in the server. </para>
</listitem>
<VARLISTENTRY> </varlistentry>
<TERM>
<literal>\m</literal> <VARLISTENTRY>
</TERM> <TERM>
<LISTITEM> <literal>\dS</literal>
<PARA> </TERM>
Toggle the old monitor-like table display, which includes border characters <LISTITEM>
surrounding the table. <PARA>
This is standard SQL output. List system tables and indexes.
By default, <application>psql</application> includes only field separators </para>
between columns. </listitem>
</varlistentry>
<VARLISTENTRY>
<TERM> <VARLISTENTRY>
<literal>\o</literal> [ { <replaceable class="parameter">filename</replaceable> | <literal>|</literal><replaceable class="parameter">command</replaceable> } ] <TERM>
</TERM> <literal>\dt</literal>
<LISTITEM> </TERM>
<PARA> <LISTITEM>
Save future query results to the file <PARA>
<replaceable class="parameter">filename</replaceable> or pipe future List only non-system tables.
results into a separate Unix shell to execute </para>
<replaceable class="parameter">command</replaceable>. </listitem>
If no arguments are specified, send query results to </varlistentry>
<filename>stdout</filename>.
<VARLISTENTRY>
<VARLISTENTRY> <TERM>
<TERM> <literal>\dT</literal>
<literal>\p</literal> </TERM>
</TERM> <LISTITEM>
<LISTITEM> <PARA>
<PARA> List types.
Print the current query buffer. </para>
</listitem>
<VARLISTENTRY> </varlistentry>
<TERM>
<literal>\q</literal> <VARLISTENTRY>
</TERM> <TERM>
<LISTITEM> <literal>\e</literal> [ <replaceable class="parameter">filename</replaceable> ]
<PARA> </TERM>
Quit the <application>psql</application> program. <LISTITEM>
<PARA>
<VARLISTENTRY> Edit the current query buffer or the contents of the file
<TERM> <replaceable class="parameter">filename</replaceable>.
<literal>\r</literal> </para>
</TERM> </listitem>
<LISTITEM> </varlistentry>
<PARA>
Reset(clear) the query buffer. <VARLISTENTRY>
<TERM>
<VARLISTENTRY> <literal>\E</literal> [ <replaceable class="parameter">filename</replaceable> ]
<TERM> </TERM>
<literal>\s</literal> [ <replaceable class="parameter">filename</replaceable> ] <LISTITEM>
</TERM> <PARA>
<LISTITEM> Edit the current query buffer or the contents of the file
<PARA> <replaceable class="parameter">filename</replaceable>
Print or save the command line history to and execute it upon editor exit.
<replaceable class="parameter">filename</replaceable>. </para>
If <replaceable class="parameter">filename</replaceable> is omitted, </listitem>
do not save subsequent commands to a history file. </varlistentry>
This option is only available if <application>psql</application> is
configured to use readline. <VARLISTENTRY>
<TERM>
<VARLISTENTRY> <literal>\f</literal> [ <replaceable class="parameter">separator</replaceable> ]
<TERM> </TERM>
<literal>\t</literal> <LISTITEM>
</TERM> <PARA>
<LISTITEM> Set the field separator. Default is a single blank space.
<PARA> </para>
Toggle display of output column name headings and row count footer (defaults to on). </listitem>
</varlistentry>
<VARLISTENTRY>
<TERM> <VARLISTENTRY>
<literal>\T</literal> <replaceable class="parameter">table_options</replaceable> <TERM>
</TERM> <literal>\g</literal> [ { <replaceable class="parameter">filename</replaceable> | <literal>|</literal><replaceable class="parameter">command</replaceable> } ]
<LISTITEM> </TERM>
<PARA> <LISTITEM>
Allows you to specify options to be placed within the <PARA>
<sgmltag>table ...</sgmltag> tag Send the current query input buffer to the backend and optionally
for <acronym>HTML 3.0</acronym> save the output in <replaceable class="parameter">filename</replaceable>
tabular output.For example, <literal>border</literal> or pipe the output into a separate Unix shell to execute
will give you tables with borders. <replaceable class="parameter">command</replaceable>.
This must be used in conjunction with the <command>\H</command> meta-command. </para>
</listitem>
<VARLISTENTRY> </varlistentry>
<TERM>
<literal>\x</literal> <VARLISTENTRY>
</TERM> <TERM>
<LISTITEM> <literal>\h</literal> [ <replaceable class="parameter">command</replaceable> ]
<PARA> </TERM>
Toggles extended row format mode. When enabled each row will have its column <LISTITEM>
names printed on the left with the column values printed on the right. <PARA>
This is useful for rows which are otherwise too long to fit into Give syntax help on the specified SQL command.
one screen line. <acronym>HTML</acronym> row output mode supports this flag too. If <replaceable class="parameter">command</replaceable> is not a defined SQL command
(or is not documented in <application>psql</application>), or if
<VARLISTENTRY> <replaceable class="parameter">command</replaceable> is not specified,
<TERM> then <application>psql</application> will
<literal>\w</literal> <replaceable class="parameter">filename</replaceable> list all the commands for which syntax help is
</TERM> available. If <replaceable class="parameter">command</replaceable>
<LISTITEM> is an asterisk (<quote>*</quote>), then
<PARA> give syntax help on all SQL commands.
Outputs the current query buffer to the file </para>
<replaceable class="parameter">filename</replaceable>. </listitem>
</varlistentry>
<VARLISTENTRY>
<TERM> <VARLISTENTRY>
<literal>\z</literal> <TERM>
</TERM> <literal>\H</literal>
<LISTITEM> </TERM>
<PARA> <LISTITEM>
Produces a list of all tables in the database with their appropriate ACLs <PARA>
(grant/revoke permissions) listed. Toggle <acronym>HTML3</acronym> output. This is equivalent to the <option>-H</option>
command-line option.
<VARLISTENTRY> </para>
<TERM> </listitem>
<literal>\!</literal> [ <replaceable class="parameter">command</replaceable> ] </varlistentry>
</TERM>
<LISTITEM> <VARLISTENTRY>
<PARA> <TERM>
Escape to a separate Unix shell or execute the Unix command <literal>\i</literal> <replaceable class="parameter">filename</replaceable>
<replaceable class="parameter">command</replaceable>. </TERM>
<LISTITEM>
<VARLISTENTRY> <PARA>
<TERM> Read queries from the file <replaceable class="parameter">filename</replaceable>
<literal>\?</literal> into the query input buffer.
</TERM> </para>
<LISTITEM> </listitem>
<PARA> </varlistentry>
Get help information about the slash (<quote>\</quote>) commands.
<VARLISTENTRY>
</variablelist> <TERM>
<literal>\l</literal>
</TERM>
<LISTITEM>
<PARA>
List all the databases in the server.
</para>
</listitem>
</varlistentry>
<VARLISTENTRY>
<TERM>
<literal>\m</literal>
</TERM>
<LISTITEM>
<PARA>
Toggle the old monitor-like table display, which includes border characters
surrounding the table.
This is standard SQL output.
By default, <application>psql</application> includes only field separators
between columns.
</para>
</listitem>
</varlistentry>
<VARLISTENTRY>
<TERM>
<literal>\o</literal> [ { <replaceable class="parameter">filename</replaceable> | <literal>|</literal><replaceable class="parameter">command</replaceable> } ]
</TERM>
<LISTITEM>
<PARA>
Save future query results to the file
<replaceable class="parameter">filename</replaceable> or pipe future
results into a separate Unix shell to execute
<replaceable class="parameter">command</replaceable>.
If no arguments are specified, send query results to
<filename>stdout</filename>.
</para>
</listitem>
</varlistentry>
<VARLISTENTRY>
<TERM>
<literal>\p</literal>
</TERM>
<LISTITEM>
<PARA>
Print the current query buffer.
</para>
</listitem>
</varlistentry>
<VARLISTENTRY>
<TERM>
<literal>\q</literal>
</TERM>
<LISTITEM>
<PARA>
Quit the <application>psql</application> program.
</para>
</listitem>
</varlistentry>
<VARLISTENTRY>
<TERM>
<literal>\r</literal>
</TERM>
<LISTITEM>
<PARA>
Reset(clear) the query buffer.
</para>
</listitem>
</varlistentry>
<VARLISTENTRY>
<TERM>
<literal>\s</literal> [ <replaceable class="parameter">filename</replaceable> ]
</TERM>
<LISTITEM>
<PARA>
Print or save the command line history to
<replaceable class="parameter">filename</replaceable>.
If <replaceable class="parameter">filename</replaceable> is omitted,
do not save subsequent commands to a history file.
This option is only available if <application>psql</application> is
configured to use readline.
</para>
</listitem>
</varlistentry>
<VARLISTENTRY>
<TERM>
<literal>\t</literal>
</TERM>
<LISTITEM>
<PARA>
Toggle display of output column name headings and row count footer (defaults to on).
</para>
</listitem>
</varlistentry>
<VARLISTENTRY>
<TERM>
<literal>\T</literal> <replaceable class="parameter">table_options</replaceable>
</TERM>
<LISTITEM>
<PARA>
Allows you to specify options to be placed within the
<sgmltag>table ...</sgmltag> tag
for <acronym>HTML 3.0</acronym>
tabular output.For example, <literal>border</literal>
will give you tables with borders.
This must be used in conjunction with the <command>\H</command> meta-command.
</para>
</listitem>
</varlistentry>
<VARLISTENTRY>
<TERM>
<literal>\x</literal>
</TERM>
<LISTITEM>
<PARA>
Toggles extended row format mode. When enabled each row will have its column
names printed on the left with the column values printed on the right.
This is useful for rows which are otherwise too long to fit into
one screen line. <acronym>HTML</acronym> row output mode supports this flag too.
</para>
</listitem>
</varlistentry>
<VARLISTENTRY>
<TERM>
<literal>\w</literal> <replaceable class="parameter">filename</replaceable>
</TERM>
<LISTITEM>
<PARA>
Outputs the current query buffer to the file
<replaceable class="parameter">filename</replaceable>.
</para>
</listitem>
</varlistentry>
<VARLISTENTRY>
<TERM>
<literal>\z</literal>
</TERM>
<LISTITEM>
<PARA>
Produces a list of all tables in the database with their appropriate ACLs
(grant/revoke permissions) listed.
</para>
</listitem>
</varlistentry>
<VARLISTENTRY>
<TERM>
<literal>\!</literal> [ <replaceable class="parameter">command</replaceable> ]
</TERM>
<LISTITEM>
<PARA>
Escape to a separate Unix shell or execute the Unix command
<replaceable class="parameter">command</replaceable>.
</para>
</listitem>
</varlistentry>
<VARLISTENTRY>
<TERM>
<literal>\?</literal>
</TERM>
<LISTITEM>
<PARA>
Get help information about the slash (<quote>\</quote>) commands.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
</refentry> </refentry>
doc/src/sgml/ref/reset.sgml
View file @ a75f2d21
...@@ -12,7 +12,7 @@ RESET ...@@ -12,7 +12,7 @@ RESET
<REFPURPOSE> <REFPURPOSE>
Restores run-time parameters for session to default values Restores run-time parameters for session to default values
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-24</DATE> <DATE>1998-09-24</DATE>
...@@ -21,115 +21,122 @@ Restores run-time parameters for session to default values ...@@ -21,115 +21,122 @@ Restores run-time parameters for session to default values
RESET <REPLACEABLE CLASS="PARAMETER">variable</REPLACEABLE> RESET <REPLACEABLE CLASS="PARAMETER">variable</REPLACEABLE>
</SYNOPSIS> </SYNOPSIS>
<REFSECT2 ID="R2-SQL-RESET-1"> <REFSECT2 ID="R2-SQL-RESET-1">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-09-24</DATE> <DATE>1998-09-24</DATE>
</REFSECT2INFO> </REFSECT2INFO>
<TITLE> <TITLE>
Inputs Inputs
</TITLE> </TITLE>
<PARA> <PARA>
<VARIABLELIST>
<VARIABLELIST> <VARLISTENTRY>
<VARLISTENTRY> <TERM>
<TERM> <REPLACEABLE CLASS="PARAMETER">variable</REPLACEABLE>
<REPLACEABLE CLASS="PARAMETER">variable</REPLACEABLE> </TERM>
</TERM> <LISTITEM>
<LISTITEM> <PARA>
<PARA> Refer to the SET statement for more information on available
Refer to the SET statement for more information on available variables.
variables. </para>
</variablelist> </listitem>
</varlistentry>
</REFSECT2> </variablelist>
</para>
<REFSECT2 ID="R2-SQL-RESET-2"> </REFSECT2>
<REFSECT2INFO>
<DATE>1998-09-24</DATE> <REFSECT2 ID="R2-SQL-RESET-2">
</REFSECT2INFO> <REFSECT2INFO>
<TITLE> <DATE>1998-09-24</DATE>
Outputs </REFSECT2INFO>
</TITLE> <TITLE>
<PARA> Outputs
</TITLE>
<VARIABLELIST> <PARA>
<VARLISTENTRY>
<TERM> <VARIABLELIST>
RESET VARIABLE <VARLISTENTRY>
</TERM> <TERM>
<LISTITEM> RESET VARIABLE
<PARA> </TERM>
Message returned if <LISTITEM>
<REPLACEABLE CLASS="PARAMETER">variable</REPLACEABLE> is successfully reset <PARA>
to its default value.. Message returned if
<REPLACEABLE CLASS="PARAMETER">variable</REPLACEABLE> is successfully reset
</VARIABLELIST> to its default value..
</para>
</REFSECT2> </listitem>
</REFSYNOPSISDIV> </varlistentry>
</VARIABLELIST>
<REFSECT1 ID="R1-SQL-RESET-1"> </para>
<REFSECT1INFO> </REFSECT2>
<DATE>1998-09-24</DATE> </REFSYNOPSISDIV>
</REFSECT1INFO>
<TITLE> <REFSECT1 ID="R1-SQL-RESET-1">
Description <REFSECT1INFO>
</TITLE> <DATE>1998-09-24</DATE>
<PARA> </REFSECT1INFO>
<command>RESET</command> restores variables to the <TITLE>
default values. Description
Refer to the <command>SET</command> command for details on </TITLE>
allowed values and defaults. <PARA>
<command>RESET</command> is an alternate form for <command>RESET</command> restores variables to the
<synopsis> default values.
<command>SET <replaceable class="parameter">variable</replaceable> = DEFAULT</command> Refer to the <command>SET</command> command for details on
</synopsis> allowed values and defaults.
<command>RESET</command> is an alternate form for
<REFSECT2 ID="R2-SQL-RESET-3"> <synopsis>
<REFSECT2INFO> <command>SET <replaceable class="parameter">variable</replaceable> = DEFAULT</command>
<DATE>1998-09-24</DATE> </synopsis>
</REFSECT2INFO> </para>
<TITLE>
Notes <REFSECT2 ID="R2-SQL-RESET-3">
</TITLE> <REFSECT2INFO>
<PARA> <DATE>1998-09-24</DATE>
The RESET statement is a <productname>Postgres</productname> language extension. </REFSECT2INFO>
<para> <TITLE>
Refer to SET/SHOW statements to set/show variable values. Notes
</TITLE>
</REFSECT2> <PARA>
</refsect1> The RESET statement is a <productname>Postgres</productname> language extension.
</para>
<REFSECT1 ID="R1-SQL-RESET-2"> <para>
<TITLE> Refer to SET/SHOW statements to set/show variable values.
Usage </para>
</TITLE> </REFSECT2>
<PARA> </refsect1>
<ProgramListing>
-- reset DateStyle to its default; <REFSECT1 ID="R1-SQL-RESET-2">
RESET DateStyle; <TITLE>
</programlisting> Usage
<programlisting> </TITLE>
-- reset Geqo to its default; <PARA>
RESET GEQO; <ProgramListing>
</ProgramListing> -- reset DateStyle to its default;
RESET DateStyle;
</REFSECT1> </programlisting>
<programlisting>
<REFSECT1 ID="R1-SQL-RESET-3"> -- reset Geqo to its default;
<TITLE> RESET GEQO;
Compatibility </ProgramListing>
</TITLE> </para>
<PARA> </REFSECT1>
<REFSECT2 ID="R2-SQL-RESET-4"> <REFSECT1 ID="R1-SQL-RESET-3">
<REFSECT2INFO> <TITLE>
<DATE>1998-09-24</DATE> Compatibility
</REFSECT2INFO> </TITLE>
<TITLE>
SQL92 <REFSECT2 ID="R2-SQL-RESET-4">
</TITLE> <REFSECT2INFO>
<PARA> <DATE>1998-09-24</DATE>
There is no <command>RESET</command> in <acronym>SQL92</acronym>. </REFSECT2INFO>
<TITLE>
SQL92
</TITLE>
<PARA>
There is no <command>RESET</command> in <acronym>SQL92</acronym>.
</para>
</refsect2>
</refsect1>
</REFENTRY> </REFENTRY>
doc/src/sgml/ref/revoke.sgml
View file @ a75f2d21
...@@ -12,7 +12,7 @@ REVOKE ...@@ -12,7 +12,7 @@ REVOKE
<REFPURPOSE> <REFPURPOSE>
Revokes access privilege from a user, a group or all users. Revokes access privilege from a user, a group or all users.
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-24</DATE> <DATE>1998-09-24</DATE>
...@@ -25,312 +25,360 @@ REVOKE <REPLACEABLE CLASS="PARAMETER">privilege</REPLACEABLE> [, ...] ...@@ -25,312 +25,360 @@ REVOKE <REPLACEABLE CLASS="PARAMETER">privilege</REPLACEABLE> [, ...]
FROM { PUBLIC | GROUP <REPLACEABLE CLASS="PARAMETER">group</REPLACEABLE> | <REPLACEABLE CLASS="PARAMETER">username</REPLACEABLE> } FROM { PUBLIC | GROUP <REPLACEABLE CLASS="PARAMETER">group</REPLACEABLE> | <REPLACEABLE CLASS="PARAMETER">username</REPLACEABLE> }
</SYNOPSIS> </SYNOPSIS>
<REFSECT2 ID="R2-SQL-REVOKE-1"> <REFSECT2 ID="R2-SQL-REVOKE-1">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-09-24</DATE> <DATE>1998-09-24</DATE>
</REFSECT2INFO> </REFSECT2INFO>
<TITLE> <TITLE>
Inputs Inputs
</TITLE> </TITLE>
<PARA> <PARA>
<VARIABLELIST> <VARIABLELIST>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<REPLACEABLE CLASS="PARAMETER">privilege</REPLACEABLE> <REPLACEABLE CLASS="PARAMETER">privilege</REPLACEABLE>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
The possible privileges are: The possible privileges are:
</para>
<VARIABLELIST> </listitem>
<VARLISTENTRY> </varlistentry>
<TERM>
SELECT <VARLISTENTRY>
</TERM> <TERM>
<LISTITEM> SELECT
<PARA> </TERM>
Privilege to access all of the columns of a specific <LISTITEM>
table/view. <PARA>
</PARA> Privilege to access all of the columns of a specific
</LISTITEM> table/view.
</VARLISTENTRY> </PARA>
</LISTITEM>
<VARLISTENTRY> </VARLISTENTRY>
<TERM>
INSERT <VARLISTENTRY>
</TERM> <TERM>
<LISTITEM> INSERT
<PARA> </TERM>
Privilege to insert data into all columns of a <LISTITEM>
specific table. <PARA>
Privilege to insert data into all columns of a
<VARLISTENTRY> specific table.
<TERM> </para>
UPDATE </listitem>
</TERM> </varlistentry>
<LISTITEM>
<PARA> <VARLISTENTRY>
Privilege to update all columns of a specific <TERM>
table. UPDATE
</TERM>
<VARLISTENTRY> <LISTITEM>
<TERM> <PARA>
DELETE Privilege to update all columns of a specific
</TERM> table.
<LISTITEM> </para>
<PARA> </listitem>
Privilege to delete rows from a specific table. </varlistentry>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
RULE DELETE
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
Privilege to define rules on table/view. Privilege to delete rows from a specific table.
(See <command>CREATE RULE</command>). </para>
</listitem>
<VARLISTENTRY> </varlistentry>
<TERM>
ALL <VARLISTENTRY>
</TERM> <TERM>
<LISTITEM> RULE
<PARA> </TERM>
Rescind all privileges. <LISTITEM>
<PARA>
</VARIABLELIST> Privilege to define rules on table/view.
(See <command>CREATE RULE</command>).
<VARLISTENTRY> </para>
<TERM> </listitem>
<REPLACEABLE CLASS="PARAMETER">object</REPLACEABLE> </varlistentry>
</TERM>
<LISTITEM> <VARLISTENTRY>
<PARA> <TERM>
The name of an object from which to revoke access. ALL
The possible objects are: </TERM>
<itemizedlist mark="bullet" spacing="compact"> <LISTITEM>
<listitem> <PARA>
<para> Rescind all privileges.
table </para>
</listitem>
<listitem> </varlistentry>
<para>
view <VARLISTENTRY>
<TERM>
<listitem> <REPLACEABLE CLASS="PARAMETER">object</REPLACEABLE>
<para> </TERM>
sequence <LISTITEM>
<PARA>
<listitem> The name of an object from which to revoke access.
<para> The possible objects are:
index <itemizedlist mark="bullet" spacing="compact">
</itemizedlist> <listitem>
<para>
<VARLISTENTRY> table
<TERM> </para>
<REPLACEABLE CLASS="PARAMETER">group</REPLACEABLE> </listitem>
</TERM>
<LISTITEM> <listitem>
<PARA> <para>
The name of a group from whom to revoke privileges. view
</PARA> </para>
</LISTITEM> </listitem>
</VARLISTENTRY>
<listitem>
<VARLISTENTRY> <para>
<TERM> sequence
<REPLACEABLE CLASS="PARAMETER">username</REPLACEABLE> </para>
</TERM> </listitem>
<LISTITEM>
<PARA> <listitem>
The name of a user from whom revoke privileges. Use the PUBLIC keyword <para>
to specify all users. index
</PARA> </para>
</LISTITEM> </listitem>
</VARLISTENTRY> </itemizedlist>
</para>
<VARLISTENTRY> </listitem>
<TERM> </varlistentry>
PUBLIC
</TERM> <VARLISTENTRY>
<LISTITEM> <TERM>
<PARA> <REPLACEABLE CLASS="PARAMETER">group</REPLACEABLE>
Rescind the specified privilege(s) for all users. </TERM>
<LISTITEM>
</LISTITEM> <PARA>
</VARLISTENTRY> The name of a group from whom to revoke privileges.
</VARIABLELIST> </PARA>
</LISTITEM>
</REFSECT2> </VARLISTENTRY>
<REFSECT2 ID="R2-SQL-REVOKE-2"> <VARLISTENTRY>
<REFSECT2INFO> <TERM>
<DATE>1998-09-24</DATE> <REPLACEABLE CLASS="PARAMETER">username</REPLACEABLE>
</REFSECT2INFO> </TERM>
<TITLE> <LISTITEM>
Outputs <PARA>
</TITLE> The name of a user from whom revoke privileges. Use the PUBLIC keyword
<PARA> to specify all users.
</PARA>
<VARIABLELIST> </LISTITEM>
<VARLISTENTRY> </VARLISTENTRY>
<TERM>
CHANGE <VARLISTENTRY>
</TERM> <TERM>
<LISTITEM> PUBLIC
<PARA> </TERM>
Message returned if successfully. <LISTITEM>
<PARA>
<VARLISTENTRY> Rescind the specified privilege(s) for all users.
<TERM> </para>
ERROR </LISTITEM>
</TERM> </VARLISTENTRY>
<LISTITEM> </VARIABLELIST>
<PARA> </para>
Message returned if object is not available or impossible </REFSECT2>
to revoke privileges from a group or users.
<REFSECT2 ID="R2-SQL-REVOKE-2">
</VARIABLELIST> <REFSECT2INFO>
<DATE>1998-09-24</DATE>
</REFSECT2> </REFSECT2INFO>
</REFSYNOPSISDIV> <TITLE>
Outputs
<REFSECT1 ID="R1-SQL-REVOKE-1"> </TITLE>
<REFSECT1INFO> <PARA>
<DATE>1998-09-24</DATE>
</REFSECT1INFO> <VARIABLELIST>
<TITLE> <VARLISTENTRY>
Description <TERM>
</TITLE> CHANGE
<PARA> </TERM>
REVOKE allows creator of an object to revoke permissions granted <LISTITEM>
before, from all users (via PUBLIC) or a certain user or group. <PARA>
Message returned if successfully.
<REFSECT2 ID="R2-SQL-REVOKE-3"> </para>
<REFSECT2INFO> </listitem>
<DATE>1998-09-24</DATE> </varlistentry>
</REFSECT2INFO>
<TITLE> <VARLISTENTRY>
Notes <TERM>
</TITLE> ERROR
<PARA> </TERM>
Refer to psql \z command for further information about permissions <LISTITEM>
on existing objects: <PARA>
Message returned if object is not available or impossible
<programlisting> to revoke privileges from a group or users.
Database = lusitania </para>
+------------------+---------------------------------------------+ </listitem>
| Relation | Grant/Revoke Permissions | </varlistentry>
+------------------+---------------------------------------------+ </VARIABLELIST>
| mytable | {"=rw","miriam=arwR","group todos=rw"} | </para>
+------------------+---------------------------------------------+ </REFSECT2>
Legend: </REFSYNOPSISDIV>
uname=arwR -- privileges granted to a user
group gname=arwR -- privileges granted to a GROUP <REFSECT1 ID="R1-SQL-REVOKE-1">
=arwR -- privileges granted to PUBLIC <REFSECT1INFO>
<DATE>1998-09-24</DATE>
r -- SELECT </REFSECT1INFO>
w -- UPDATE/DELETE <TITLE>
a -- INSERT Description
R -- RULE </TITLE>
arwR -- ALL <PARA>
</programlisting> REVOKE allows creator of an object to revoke permissions granted
before, from all users (via PUBLIC) or a certain user or group.
<tip> </para>
<para>
Currently, to create a GROUP you have to insert <REFSECT2 ID="R2-SQL-REVOKE-3">
<REFSECT2INFO>
<DATE>1998-09-24</DATE>
</REFSECT2INFO>
<TITLE>
Notes
</TITLE>
<PARA>
Refer to psql \z command for further information about permissions
on existing objects:
<programlisting>
Database = lusitania
+------------------+---------------------------------------------+
| Relation | Grant/Revoke Permissions |
+------------------+---------------------------------------------+
| mytable | {"=rw","miriam=arwR","group todos=rw"} |
+------------------+---------------------------------------------+
Legend:
uname=arwR -- privileges granted to a user
group gname=arwR -- privileges granted to a GROUP
=arwR -- privileges granted to PUBLIC
r -- SELECT
w -- UPDATE/DELETE
a -- INSERT
R -- RULE
arwR -- ALL
</programlisting>
</para>
<tip>
<para>
Currently, to create a GROUP you have to insert
data manually into table pg_group as: data manually into table pg_group as:
<programlisting> <programlisting>
INSERT INTO pg_group VALUES ('todos'); INSERT INTO pg_group VALUES ('todos');
CREATE USER miriam IN GROUP todos; CREATE USER miriam IN GROUP todos;
</programlisting> </programlisting>
</tip> </para>
</tip>
</REFSECT2>
</REFSECT2>
<REFSECT1 ID="R1-SQL-REVOKE-2"> </refsect1>
<TITLE>
Usage <REFSECT1 ID="R1-SQL-REVOKE-2">
</TITLE> <TITLE>
<PARA> Usage
<ProgramListing> </TITLE>
-- revoke insert privilege from all users on table films: <PARA>
-- <ProgramListing>
REVOKE INSERT ON films FROM PUBLIC; -- revoke insert privilege from all users on table films:
--
-- revoke all privileges from user manuel on view kinds: REVOKE INSERT ON films FROM PUBLIC;
--
REVOKE ALL ON kinds FROM manuel; -- revoke all privileges from user manuel on view kinds:
</ProgramListing> --
REVOKE ALL ON kinds FROM manuel;
</REFSECT1> </ProgramListing>
</para>
<REFSECT1 ID="R1-SQL-REVOKE-3"> </REFSECT1>
<TITLE>
Compatibility <REFSECT1 ID="R1-SQL-REVOKE-3">
</TITLE> <TITLE>
<PARA> Compatibility
</TITLE>
<REFSECT2 ID="R2-SQL-REVOKE-4">
<REFSECT2INFO> <REFSECT2 ID="R2-SQL-REVOKE-4">
<DATE>1998-09-01</DATE> <REFSECT2INFO>
</REFSECT2INFO> <DATE>1998-09-01</DATE>
<TITLE> </REFSECT2INFO>
SQL92 <TITLE>
</TITLE> SQL92
<PARA> </TITLE>
The SQL92 syntax for <command>REVOKE</command> <PARA>
has additional capabilities for rescinding The SQL92 syntax for <command>REVOKE</command>
privileges, including those on individual columns in tables: has additional capabilities for rescinding
privileges, including those on individual columns in tables:
<variablelist>
<varlistentry> <variablelist>
<term> <varlistentry>
<synopsis> <term>
REVOKE { SELECT | DELETE | USAGE | ALL PRIVILEGES } [, ...] <synopsis>
ON <replaceable class="parameter">object</replaceable> REVOKE { SELECT | DELETE | USAGE | ALL PRIVILEGES } [, ...]
FROM { PUBLIC | <replaceable class="parameter">username</replaceable> [, ...] } { RESTRICT | CASCADE } ON <replaceable class="parameter">object</replaceable>
REVOKE { INSERT | UPDATE | REFERENCES } [, ...] [ ( <replaceable class="parameter">column</replaceable> [, ...] ) ] FROM { PUBLIC | <replaceable class="parameter">username</replaceable> [, ...] } { RESTRICT | CASCADE }
ON <replaceable class="parameter">object</replaceable> REVOKE { INSERT | UPDATE | REFERENCES } [, ...] [ ( <replaceable class="parameter">column</replaceable> [, ...] ) ]
FROM { PUBLIC | <replaceable class="parameter">username</replaceable> [, ...] } { RESTRICT | CASCADE } ON <replaceable class="parameter">object</replaceable>
</synopsis> FROM { PUBLIC | <replaceable class="parameter">username</replaceable> [, ...] } { RESTRICT | CASCADE }
<listitem> </synopsis>
<para> </term>
Refer to the <command>GRANT</command> command for details on individual fields. <listitem>
<para>
<varlistentry> Refer to the <command>GRANT</command> command for details on individual fields.
<term> </para>
<synopsis> </listitem>
REVOKE GRANT OPTION FOR <replaceable class="parameter">privilege</replaceable> [, ...] </varlistentry>
ON <replaceable class="parameter">object</replaceable>
FROM { PUBLIC | <replaceable class="parameter">username</replaceable> [, ...] } { RESTRICT | CASCADE } <varlistentry>
</synopsis> <term>
<listitem> <synopsis>
<para> REVOKE GRANT OPTION FOR <replaceable class="parameter">privilege</replaceable> [, ...]
Rescinds authority for a user to grant the specified privilege to others. ON <replaceable class="parameter">object</replaceable>
Refer to the <command>GRANT</command> command for details on individual fields. FROM { PUBLIC | <replaceable class="parameter">username</replaceable> [, ...] } { RESTRICT | CASCADE }
</synopsis>
</variablelist> </term>
<listitem>
<para> <para>
The possible objects are: Rescinds authority for a user to grant the specified privilege to others.
<simplelist> Refer to the <command>GRANT</command> command for details on individual fields.
<member> [ TABLE ] table/view </para>
<member> CHARACTER SET character-set </listitem>
<member> COLLATION collation </varlistentry>
<member> TRANSLATION translation </variablelist>
<member> DOMAIN domain </para>
</simplelist> <para>
The possible objects are:
<para> <simplelist>
If user1 gives a privilege WITH GRANT OPTION to user2, <member> [ TABLE ] table/view
and user2 gives it to user3 then user1 can revoke </member>
this privilege in cascade using the CASCADE keyword. <member> CHARACTER SET character-set
</member>
<para> <member> COLLATION collation
If user1 gives a privilege WITH GRANT OPTION to user2, </member>
and user2 gives it to user3 then if user1 try revoke <member> TRANSLATION translation
this privilege it fails if he/she specify the RESTRICT </member>
keyword. <member> DOMAIN domain
</member>
</simplelist>
</para>
<para>
If user1 gives a privilege WITH GRANT OPTION to user2,
and user2 gives it to user3 then user1 can revoke
this privilege in cascade using the CASCADE keyword.
</para>
<para>
If user1 gives a privilege WITH GRANT OPTION to user2,
and user2 gives it to user3 then if user1 try revoke
this privilege it fails if he/she specify the RESTRICT
keyword.
</para>
</refsect2>
</refsect1>
</REFENTRY> </REFENTRY>
doc/src/sgml/ref/rollback.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ ROLLBACK ...@@ -12,6 +12,7 @@ ROLLBACK
<REFPURPOSE> <REFPURPOSE>
Aborts the current transaction Aborts the current transaction
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-24</DATE> <DATE>1998-09-24</DATE>
...@@ -20,105 +21,113 @@ Aborts the current transaction ...@@ -20,105 +21,113 @@ Aborts the current transaction
ROLLBACK [ WORK ] ROLLBACK [ WORK ]
</SYNOPSIS> </SYNOPSIS>
<REFSECT2 ID="R2-SQL-ROLLBACK-1"> <REFSECT2 ID="R2-SQL-ROLLBACK-1">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-09-24</DATE> <DATE>1998-09-24</DATE>
</REFSECT2INFO> </REFSECT2INFO>
<TITLE> <TITLE>
Inputs Inputs
</TITLE> </TITLE>
<PARA> <PARA>
None. None.
</para>
</REFSECT2> </REFSECT2>
<REFSECT2 ID="R2-SQL-ROLLBACK-2">
<REFSECT2INFO>
<DATE>1998-09-24</DATE>
</REFSECT2INFO>
<TITLE>
Outputs
</TITLE>
<PARA>
<VARIABLELIST>
<VARLISTENTRY>
<TERM>
ABORT
</TERM>
<LISTITEM>
<PARA>
Message returned if successful.
<VARLISTENTRY>
<TERM>
NOTICE: UserAbortTransactionBlock and not in in-progress state
ABORT
</TERM>
<LISTITEM>
<PARA>
If there is not any transaction currently in progress.
</VARLISTENTRY>
</VARIABLELIST>
</REFSECT2>
</REFSYNOPSISDIV>
<REFSECT1 ID="R1-SQL-ROLLBACK-1"> <REFSECT2 ID="R2-SQL-ROLLBACK-2">
<REFSECT1INFO> <REFSECT2INFO>
<DATE>1998-09-24</DATE> <DATE>1998-09-24</DATE>
</REFSECT1INFO> </REFSECT2INFO>
<TITLE> <TITLE>
Description Outputs
</TITLE> </TITLE>
<PARA> <PARA>
<command>ROLLBACK</command> rolls back the current transaction and causes
all the updates made by the transaction to be discarded. <VARIABLELIST>
<VARLISTENTRY>
<REFSECT2 ID="R2-SQL-ROLLBACK-3"> <TERM>
<REFSECT2INFO> ABORT
<DATE>1998-09-24</DATE> </TERM>
</REFSECT2INFO> <LISTITEM>
<TITLE> <PARA>
Notes Message returned if successful.
</TITLE> </para>
<PARA> </listitem>
The keyword WORK is noise and can be omitted. </VARLISTENTRY>
<para> <VARLISTENTRY>
Use the <command>COMMIT</command> statement to successfully <TERM>
terminate a transaction. NOTICE: UserAbortTransactionBlock and not in in-progress state
ABORT
</TERM>
<LISTITEM>
<PARA>
If there is not any transaction currently in progress.
</para>
</listitem>
</VARLISTENTRY>
</VARIABLELIST>
</para>
</REFSECT2>
</REFSYNOPSISDIV>
</REFSECT1> <REFSECT1 ID="R1-SQL-ROLLBACK-1">
<REFSECT1INFO>
<DATE>1998-09-24</DATE>
</REFSECT1INFO>
<TITLE>
Description
</TITLE>
<PARA>
<command>ROLLBACK</command> rolls back the current transaction and causes
all the updates made by the transaction to be discarded.
</para>
<REFSECT2 ID="R2-SQL-ROLLBACK-3">
<REFSECT2INFO>
<DATE>1998-09-24</DATE>
</REFSECT2INFO>
<TITLE>
Notes
</TITLE>
<PARA>
The keyword WORK is noise and can be omitted.
</para>
<para>
Use the <command>COMMIT</command> statement to successfully
terminate a transaction.
</para>
</refsect2>
</REFSECT1>
<REFSECT1 ID="R1-SQL-ROLLBACK-2"> <REFSECT1 ID="R1-SQL-ROLLBACK-2">
<TITLE> <TITLE>
Usage Usage
</TITLE> </TITLE>
<PARA> <PARA>
<ProgramListing> <ProgramListing>
--To abort all changes: --To abort all changes:
-- --
ROLLBACK WORK; ROLLBACK WORK;
</ProgramListing> </ProgramListing>
</para>
</REFSECT1> </REFSECT1>
<REFSECT1 ID="R1-SQL-ROLLBACK-3"> <REFSECT1 ID="R1-SQL-ROLLBACK-3">
<TITLE> <TITLE>
Compatibility Compatibility
</TITLE> </TITLE>
<PARA> <PARA>
</PARA> </PARA>
<REFSECT2 ID="R2-SQL-ROLLBACK-4"> <REFSECT2 ID="R2-SQL-ROLLBACK-4">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-09-24</DATE> <DATE>1998-09-24</DATE>
</REFSECT2INFO> </REFSECT2INFO>
<TITLE> <TITLE>
SQL92 SQL92
</TITLE> </TITLE>
<PARA> <PARA>
Full compatibility. Full compatibility.
</para>
</refsect2>
</refsect1>
</REFENTRY> </REFENTRY>
doc/src/sgml/ref/select.sgml
View file @ a75f2d21
...@@ -156,29 +156,32 @@ SELECT [ALL|DISTINCT [ON <replaceable class="PARAMETER">column</replaceable>] ] ...@@ -156,29 +156,32 @@ SELECT [ALL|DISTINCT [ON <replaceable class="PARAMETER">column</replaceable>] ]
<title> <title>
Outputs Outputs
</title> </title>
<para> <para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>
Rows Rows
</term> </term>
<listitem> <listitem>
<para> <para>
The complete set of rows resulting from the query specification. The complete set of rows resulting from the query specification.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<returnvalue><replaceable>count</replaceable></returnvalue> <returnvalue><replaceable>count</replaceable></returnvalue>
</term> </term>
<listitem> <listitem>
<para> <para>
The count of rows returned by the query. The count of rows returned by the query.
</variablelist> </para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect2> </refsect2>
</refsynopsisdiv> </refsynopsisdiv>
...@@ -513,6 +516,7 @@ SELECT distributors.* WHERE name = 'Westwood'; ...@@ -513,6 +516,7 @@ SELECT distributors.* WHERE name = 'Westwood';
108|Westward 108|Westward
</programlisting> </programlisting>
</para> </para>
</refsect2>
<refsect2 id="R2-SQL-SELECT-5"> <refsect2 id="R2-SQL-SELECT-5">
<refsect2info> <refsect2info>
...@@ -613,6 +617,8 @@ SELECT [ ALL | DISTINCT ] <replaceable class="PARAMETER">expression</replaceable ...@@ -613,6 +617,8 @@ SELECT [ ALL | DISTINCT ] <replaceable class="PARAMETER">expression</replaceable
</title> </title>
<para> <para>
All input fields are described in detail for SELECT. All input fields are described in detail for SELECT.
</para>
</refsect2>
<refsect2 id="R2-SQL-SELECTINTO-2"> <refsect2 id="R2-SQL-SELECTINTO-2">
<refsect2info> <refsect2info>
...@@ -623,22 +629,26 @@ All input fields are described in detail for SELECT. ...@@ -623,22 +629,26 @@ All input fields are described in detail for SELECT.
</title> </title>
<para> <para>
All output fields are described in detail for SELECT. All output fields are described in detail for SELECT.
</para>
</refsect2>
</refsynopsisdiv>
<refsect1 id="R1-SQL-SELECTINTO-1"> <refsect1 id="R1-SQL-SELECTINTO-1">
<refsect1info> <refsect1info>
<date>1998-09-22</date> <date>1998-09-22</date>
</refsect1info> </refsect1info>
<title> <title>
Description Description
</title> </title>
<para> <para>
SELECT INTO creates a new table from the results of a query. Typically, this SELECT INTO creates a new table from the results of a query. Typically, this
query draws data from an existing table, but any SQL query is allowed. query draws data from an existing table, but any SQL query is allowed.
<note> <note>
<para> <para>
CREATE TABLE AS is functionally equivalent to the SELECT INTO command. CREATE TABLE AS is functionally equivalent to the SELECT INTO command.
</note> </para>
</note>
</para>
</refsect1> </refsect1>
</refentry> </refentry>
......
doc/src/sgml/ref/set.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ SET ...@@ -12,6 +12,7 @@ SET
<REFPURPOSE> <REFPURPOSE>
Set run-time parameters for session Set run-time parameters for session
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-24</DATE> <DATE>1998-09-24</DATE>
...@@ -23,587 +24,718 @@ SET <REPLACEABLE CLASS="PARAMETER">variable</REPLACEABLE> { TO | = } { '<REPLACE ...@@ -23,587 +24,718 @@ SET <REPLACEABLE CLASS="PARAMETER">variable</REPLACEABLE> { TO | = } { '<REPLACE
SET TIME ZONE { '<REPLACEABLE CLASS="PARAMETER">timezone</REPLACEABLE>' | LOCAL }; SET TIME ZONE { '<REPLACEABLE CLASS="PARAMETER">timezone</REPLACEABLE>' | LOCAL };
</SYNOPSIS> </SYNOPSIS>
<REFSECT2 ID="R2-SQL-SET-1"> <REFSECT2 ID="R2-SQL-SET-1">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-09-24</DATE> <DATE>1998-09-24</DATE>
</REFSECT2INFO> </REFSECT2INFO>
<TITLE> <TITLE>
Inputs Inputs
</TITLE> </TITLE>
<PARA> <PARA>
<VARIABLELIST> <VARIABLELIST>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<REPLACEABLE CLASS="PARAMETER">variable</REPLACEABLE> <REPLACEABLE CLASS="PARAMETER">variable</REPLACEABLE>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<para> <para>
Settable global parameter. Settable global parameter.
</para>
<varlistentry> </listitem>
<term> </varlistentry>
<REPLACEABLE CLASS="PARAMETER">value</REPLACEABLE> <varlistentry>
</term> <term>
<listitem> <REPLACEABLE CLASS="PARAMETER">value</REPLACEABLE>
<PARA> </term>
New value of parameter. <listitem>
</variablelist> <PARA>
New value of parameter.
<para> </para>
The possible variables and allowed values are: </listitem>
</varlistentry>
<VARIABLELIST> </variablelist>
<VARLISTENTRY> </para>
<TERM> <para>
DateStyle The possible variables and allowed values are:
</TERM>
<LISTITEM> <VARIABLELIST>
<PARA> <VARLISTENTRY>
<TERM>
<VARIABLELIST> DateStyle
<VARLISTENTRY> </TERM>
<TERM> <LISTITEM>
ISO <PARA>
</TERM>
<LISTITEM> <VARIABLELIST>
<PARA> <VARLISTENTRY>
use ISO 8601-style dates and times <TERM>
<VARLISTENTRY> ISO
<TERM> </TERM>
SQL <LISTITEM>
</TERM> <PARA>
<LISTITEM> use ISO 8601-style dates and times
<PARA> </para>
use Oracle/Ingres-style dates and times </listitem>
<VARLISTENTRY> </varlistentry>
<TERM> <VARLISTENTRY>
Postgres <TERM>
</TERM> SQL
<LISTITEM> </TERM>
<PARA> <LISTITEM>
use traditional <productname>Postgres</productname> format <PARA>
<VARLISTENTRY> use Oracle/Ingres-style dates and times
<TERM> </para>
European </listitem>
</TERM> </varlistentry>
<LISTITEM> <VARLISTENTRY>
<PARA> <TERM>
use dd/mm/yyyy for numeric date representations. Postgres
<VARLISTENTRY> </TERM>
<TERM> <LISTITEM>
NonEuropean <PARA>
</TERM> use traditional <productname>Postgres</productname> format
<LISTITEM> </para>
<PARA> </listitem>
use mm/dd/yyyy for numeric date representations. </varlistentry>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
German European
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
use dd.mm.yyyy for numeric date representations. use dd/mm/yyyy for numeric date representations.
<VARLISTENTRY> </para>
<TERM> </listitem>
US </varlistentry>
</TERM> <VARLISTENTRY>
<LISTITEM> <TERM>
<PARA> NonEuropean
same as 'NonEuropean' </TERM>
<VARLISTENTRY> <LISTITEM>
<TERM> <PARA>
default use mm/dd/yyyy for numeric date representations.
</TERM> </para>
<LISTITEM> </listitem>
<PARA> </varlistentry>
restores the default values ('US,Postgres') <VARLISTENTRY>
</varlistentry> <TERM>
</variablelist> German
</TERM>
<para> <LISTITEM>
Date format initialization my be done by: <PARA>
<simplelist> use dd.mm.yyyy for numeric date representations.
<member> </para>
Setting PGDATESTYLE environment variable. </listitem>
</varlistentry>
<member> <VARLISTENTRY>
Running postmaster using -oe parameter to set <TERM>
dates to the 'European' convention. US
Note that this affects only the some combinations of date styles; for example </TERM>
the ISO style is not affected by this parameter. <LISTITEM>
<member> <PARA>
Changing variables in same as 'NonEuropean'
<filename>src/backend/utils/init/globals.c</filename>. </para>
</simplelist> </listitem>
</varlistentry>
<para> <VARLISTENTRY>
The variables in <filename>globals.c</filename> which can be changed are: <TERM>
<programlisting> default
bool EuroDates = false </TERM>
true <LISTITEM>
int DateStyle = USE_ISO_DATES <PARA>
USE_POSTGRES_DATES restores the default values ('US,Postgres')
USE_ISO_DATES </para>
USE_SQL_DATES </listitem>
USE_GERMAN_DATES </varlistentry>
</programlisting> </variablelist>
</para>
</varlistentry> </listitem>
</varlistentry>
<varlistentry> </variablelist>
<term> </para>
TIMEZONE <para>
</term> Date format initialization my be done by:
<listitem> <simplelist>
<para> <member>
The possible values for timezone depends on your operating Setting PGDATESTYLE environment variable.
system. For example on Linux /usr/lib/zoneinfo contains the </member>
database of timezones. <member>
<para> Running postmaster using -oe parameter to set
Here are some valid values for timezone: dates to the 'European' convention.
Note that this affects only the some combinations of date styles; for example
<variablelist> the ISO style is not affected by this parameter.
<varlistentry> </member>
<term> <member>
'PST8PDT' Changing variables in
</term> <filename>src/backend/utils/init/globals.c</filename>.
<listitem> </member>
<para> </simplelist>
set the timezone for California </para>
<varlistentry> <para>
<term> The variables in <filename>globals.c</filename> which can be changed are:
'Portugal' <programlisting>
</term> bool EuroDates = false
<listitem> true
<para> int DateStyle = USE_ISO_DATES
set time zone for Portugal. USE_POSTGRES_DATES
<varlistentry> USE_ISO_DATES
<term> USE_SQL_DATES
'Europe/Rome' USE_GERMAN_DATES
</term> </programlisting>
<listitem> </para>
<para> <para>
set time zone for Italy. <variablelist>
<varlistentry> <varlistentry>
<term> <term>
DEFAULT TIMEZONE
</term> </term>
<listitem> <listitem>
<para> <para>
set time zone to your local timezone The possible values for timezone depends on your operating
(value of the TZ environment variable). system. For example on Linux /usr/lib/zoneinfo contains the
</variablelist> database of timezones.
</para>
<para> <para>
If an invalid time zone is specified, the time zone Here are some valid values for timezone:
becomes GMT (on most systems anyway).
<variablelist>
<para> <varlistentry>
A frontend which uses libpq may be initialized by setting the PGTZ <term>
environment variable. 'PST8PDT'
</term>
<para> <listitem>
The second syntax shown above, allows one to set the timezone <para>
with a syntax similar to SQL92 <command>SET TIME ZONE</command>. set the timezone for California
The LOCAL keyword is just an alternate form </para>
of DEFAULT for SQL92 compatibility. </listitem>
</varlistentry>
</varlistentry> <varlistentry>
</variablelist> <term>
'Portugal'
There are also several internal or optimization </term>
parameters which can be specified <listitem>
by the <command>SET</command> command: <para>
set time zone for Portugal.
<variablelist> </para>
<varlistentry> </listitem>
<term> </varlistentry>
COST_HEAP <varlistentry>
</term> <term>
<listitem> 'Europe/Rome'
<para> </term>
Sets the default cost of a heap scan for use by the optimizer. <listitem>
<para>
<variablelist> set time zone for Italy.
<varlistentry> </para>
<term> </listitem>
<replaceable class="parameter">float4</replaceable> </varlistentry>
</term> <varlistentry>
<listitem> <term>
<para> DEFAULT
Set the cost of a heap scan to the specified floating point value. </term>
<listitem>
<varlistentry> <para>
<term> set time zone to your local timezone
DEFAULT (value of the TZ environment variable).
</term> </para>
<listitem> </listitem>
<para> </varlistentry>
Sets the cost of a heap scan to the default value. </variablelist>
</variablelist> </para>
<para>
<para> If an invalid time zone is specified, the time zone
The frontend may be initialized by setting the PGCOSTHEAP becomes GMT (on most systems anyway).
environment variable. </para>
<para>
<varlistentry> A frontend which uses libpq may be initialized by setting the PGTZ
<term> environment variable.
COST_INDEX </para>
</term> <para>
<listitem> The second syntax shown above, allows one to set the timezone
<para> with a syntax similar to SQL92 <command>SET TIME ZONE</command>.
Sets the default cost of an index scan for use by the optimizer. The LOCAL keyword is just an alternate form
of DEFAULT for SQL92 compatibility.
<variablelist> </para>
<varlistentry> </listitem>
<term> </varlistentry>
<replaceable class="parameter">float4</replaceable> </variablelist>
</term> </para>
<listitem> <para>
<para> There are also several internal or optimization
Set the cost of an index scan to the specified floating point value. parameters which can be specified
by the <command>SET</command> command:
<varlistentry>
<term> <variablelist>
DEFAULT <varlistentry>
</term> <term>
<listitem> COST_HEAP
<para> </term>
Sets the cost of an index scan to the default value. <listitem>
</variablelist> <para>
Sets the default cost of a heap scan for use by the optimizer.
<para>
The frontend may be initialized by setting the PGCOSTINDEX <variablelist>
environment variable. <varlistentry>
<term>
<varlistentry> <replaceable class="parameter">float4</replaceable>
<term> </term>
GEQO <listitem>
</term> <para>
<listitem> Set the cost of a heap scan to the specified floating point value.
<para> </para>
Sets the threshold for using the genetic optimizer algorithm. </listitem>
</varlistentry>
<variablelist>
<varlistentry> <varlistentry>
<term> <term>
On DEFAULT
</term> </term>
<listitem> <listitem>
<para> <para>
enables the genetic optimizer algorithm Sets the cost of a heap scan to the default value.
for statements with 8 or more tables. </para>
<varlistentry> </listitem>
<term> </varlistentry>
On=<replaceable class="parameter">#</replaceable> </variablelist>
</term> </para>
<listitem> <para>
<para> The frontend may be initialized by setting the PGCOSTHEAP
Takes an integer argument to enable the genetic optimizer algorithm environment variable.
for statements with <replaceable class="parameter">#</replaceable> </para>
or more tables in the query. <variablelist>
<varlistentry> <varlistentry>
<term> <term>
Off COST_INDEX
</term> </term>
<listitem> <listitem>
<para> <para>
disables the genetic optimizer algorithm. Sets the default cost of an index scan for use by the optimizer.
<varlistentry> </para>
<term> </listitem>
DEFAULT </varlistentry>
</term>
<listitem> <varlistentry>
<para> <term>
Equivalent to specifying <command>SET GEQO='on'</command> <replaceable class="parameter">float4</replaceable>
</varlistentry> </term>
</variablelist> <listitem>
<para>
<para> Set the cost of an index scan to the specified floating point value.
This algorithm is on by default, which used GEQO for </para>
statements of eight or more tables. </listitem>
(See the chapter on GEQO in the Programmer's Guide </varlistentry>
for more information).
<varlistentry>
<para> <term>
The frontend may be initialized by setting PGGEQO DEFAULT
environment variable. </term>
</varlistentry> <listitem>
<para>
<varlistentry> Sets the cost of an index scan to the default value.
<term> </para>
R_PLANS </listitem>
</term> </varlistentry>
<listitem> </variablelist>
<para> </listitem>
Determines whether right-hand plan evaluation is allowed: </varlistentry>
</variablelist>
<variablelist> </para>
<varlistentry> <para>
<term> The frontend may be initialized by setting the PGCOSTINDEX
On environment variable.
</term>
<listitem> <variablelist>
<para> <varlistentry>
enables right-hand evaluation of plans. <term>
GEQO
<varlistentry> </term>
<term> <listitem>
Off <para>
</term> Sets the threshold for using the genetic optimizer algorithm.
<listitem> </para>
<para>
disables right-hand evaluation of plans. <variablelist>
<varlistentry>
<varlistentry> <term>
<term> On
DEFAULT </term>
</term> <listitem>
<listitem> <para>
<para> enables the genetic optimizer algorithm
Equivalent to specifying <command>SET R_PLANS='off'</command>. for statements with 8 or more tables.
</variablelist> </para>
</listitem>
<para> </varlistentry>
It may be useful when joining big relations with <varlistentry>
small ones. This algorithm is off by default. <term>
It's not used by GEQO anyway. On=<replaceable class="parameter">#</replaceable>
<para> </term>
The frontend may be initialized by setting the PGRPLANS <listitem>
environment variable. <para>
</varlistentry> Takes an integer argument to enable the genetic optimizer algorithm
for statements with <replaceable class="parameter">#</replaceable>
<varlistentry> or more tables in the query.
<term> </para>
KSQO </listitem>
</term> </varlistentry>
<listitem> <varlistentry>
<para> <term>
<firstterm>Key Set Query Optimizer</firstterm> forces the query optimizer Off
to optimize repetative OR clauses such as generated by </term>
<productname>MicroSoft Access</productname>: <listitem>
<para>
<variablelist> disables the genetic optimizer algorithm.
<varlistentry> </para>
<term> </listitem>
On </varlistentry>
</term> <varlistentry>
<listitem> <term>
<para> DEFAULT
enables this optimization. </term>
<listitem>
<varlistentry> <para>
<term> Equivalent to specifying <command>SET GEQO='on'</command>
Off </para>
</term> </listitem>
<listitem> </varlistentry>
<para> </variablelist>
disables this optimization. </listitem>
</varlistentry>
<varlistentry> </variablelist>
<term> </para>
DEFAULT <para>
</term> This algorithm is on by default, which used GEQO for
<listitem> statements of eight or more tables.
<para> (See the chapter on GEQO in the Programmer's Guide
Equivalent to specifying <command>SET KSQO='off'</command>. for more information).
</variablelist> </para>
<para>
<para> The frontend may be initialized by setting PGGEQO
It may be useful when joining big relations with environment variable.
small ones. This algorithm is off by default.
It's not used by GEQO anyway. <variablelist>
<para>
The frontend may be initialized by setting the PGRPLANS <varlistentry>
environment variable. <term>
R_PLANS
<varlistentry> </term>
<term> <listitem>
QUERY_LIMIT <para>
</term> Determines whether right-hand plan evaluation is allowed:
<listitem> </para>
<para>
Sets the number of rows returned by a query. <variablelist>
<varlistentry>
<variablelist> <term>
<varlistentry> On
<term> </term>
Value <listitem>
</term> <para>
<listitem> enables right-hand evaluation of plans.
<para> </para>
Maximum number of rows to return for a query. The default is to allow </listitem>
an unlimited number of rows. </varlistentry>
<varlistentry>
<term> <varlistentry>
<replaceable class="parameter">#</replaceable> <term>
</term> Off
<listitem> </term>
<para> <listitem>
Sets the maximum number of rows returned by a <para>
query to <replaceable class="parameter">#</replaceable>. disables right-hand evaluation of plans.
<varlistentry> </para>
<term> </listitem>
DEFAULT </varlistentry>
</term>
<listitem> <varlistentry>
<para> <term>
Sets the maximum number of rows returned by a query to be unlimited. DEFAULT
<para> </term>
By default, there is no limit to the number of rows <listitem>
returned by a query. <para>
</varlistentry> Equivalent to specifying <command>SET R_PLANS='off'</command>.
</para>
</variablelist> </listitem>
</varlistentry>
</VARLISTENTRY> </variablelist>
</VARIABLELIST> </listitem>
</REFSECT2> </varlistentry>
</variablelist>
<REFSECT2 ID="R2-SQL-SET-2"> </para>
<REFSECT2INFO> <para>
<DATE>1998-09-24</DATE> It may be useful when joining big relations with
</REFSECT2INFO> small ones. This algorithm is off by default.
<TITLE> It's not used by GEQO anyway.
Outputs </para>
</TITLE> <para>
<PARA> The frontend may be initialized by setting the PGRPLANS
environment variable.
<VARIABLELIST> <variablelist>
<VARLISTENTRY> <varlistentry>
<TERM> <term>
<returnvalue>SET VARIABLE</returnvalue> KSQO
</TERM> </term>
<LISTITEM> <listitem>
<PARA> <para>
Message returned if successfully. <firstterm>Key Set Query Optimizer</firstterm> forces the query optimizer
to optimize repetative OR clauses such as generated by
<VARLISTENTRY> <productname>MicroSoft Access</productname>:
<TERM> </para>
<returnvalue>WARN: Bad value for <replaceable class="parameter">variable</replaceable> (<replaceable class="parameter">value</replaceable>)</returnvalue>
</TERM> <variablelist>
<LISTITEM> <varlistentry>
<PARA> <term>
If the command fails to set variable. On
</term>
</VARIABLELIST> <listitem>
<para>
</REFSECT2> enables this optimization.
</REFSYNOPSISDIV> </para>
</listitem>
<REFSECT1 ID="R1-SQL-SET-1"> </varlistentry>
<REFSECT1INFO>
<DATE>1998-09-24</DATE> <varlistentry>
</REFSECT1INFO> <term>
<TITLE> Off
Description </term>
</TITLE> <listitem>
<PARA> <para>
<command>SET</command> will modify configuration parameters for variable during disables this optimization.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
DEFAULT
</term>
<listitem>
<para>
Equivalent to specifying <command>SET KSQO='off'</command>.
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
It may be useful when joining big relations with
small ones. This algorithm is off by default.
It's not used by GEQO anyway.
</para>
<para>
The frontend may be initialized by setting the PGRPLANS
environment variable.
<variablelist>
<varlistentry>
<term>
QUERY_LIMIT
</term>
<listitem>
<para>
Sets the number of rows returned by a query.
</para>
<variablelist>
<varlistentry>
<term>
Value
</term>
<listitem>
<para>
Maximum number of rows to return for a query. The default is to allow
an unlimited number of rows.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<replaceable class="parameter">#</replaceable>
</term>
<listitem>
<para>
Sets the maximum number of rows returned by a
query to <replaceable class="parameter">#</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
DEFAULT
</term>
<listitem>
<para>
Sets the maximum number of rows returned by a query to be unlimited.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
By default, there is no limit to the number of rows
returned by a query.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</REFSECT2>
<REFSECT2 ID="R2-SQL-SET-2">
<REFSECT2INFO>
<DATE>1998-09-24</DATE>
</REFSECT2INFO>
<TITLE>
Outputs
</TITLE>
<PARA>
<VARIABLELIST>
<VARLISTENTRY>
<TERM>
<returnvalue>SET VARIABLE</returnvalue>
</TERM>
<LISTITEM>
<PARA>
Message returned if successfully.
</para>
</listitem>
</varlistentry>
<VARLISTENTRY>
<TERM>
<returnvalue>WARN: Bad value for <replaceable class="parameter">variable</replaceable> (<replaceable class="parameter">value</replaceable>)</returnvalue>
</TERM>
<LISTITEM>
<PARA>
If the command fails to set variable.
</para>
</listitem>
</varlistentry>
</VARIABLELIST>
</para>
</REFSECT2>
</REFSYNOPSISDIV>
<REFSECT1 ID="R1-SQL-SET-1">
<REFSECT1INFO>
<DATE>1998-09-24</DATE>
</REFSECT1INFO>
<TITLE>
Description
</TITLE>
<PARA>
<command>SET</command> will modify configuration parameters for variable during
a session. a session.
</para>
<para> <para>
Current values can be obtained using <command>SHOW</command>, and values Current values can be obtained using <command>SHOW</command>, and values
can be restored to the defaults using <command>RESET</command>. can be restored to the defaults using <command>RESET</command>.
Parameters and values are case-insensitive. Note that the value Parameters and values are case-insensitive. Note that the value
field is always specified as a string, so is enclosed in field is always specified as a string, so is enclosed in
single-quotes. single-quotes.
<para> </para>
<command>SET TIME ZONE</command> changes the session's <para>
default time zone offset. <command>SET TIME ZONE</command> changes the session's
A SQL-session always begins with an initial default time zone default time zone offset.
offset. A SQL-session always begins with an initial default time zone
The <command>SET TIME ZONE</command> statement is used to change the default offset.
time zone offset for the current SQL session. The <command>SET TIME ZONE</command> statement is used to change the default
time zone offset for the current SQL session.
<REFSECT2 ID="R2-SQL-SET-3"> </para>
<REFSECT2INFO>
<DATE>1998-09-24</DATE> <REFSECT2 ID="R2-SQL-SET-3">
</REFSECT2INFO> <REFSECT2INFO>
<TITLE> <DATE>1998-09-24</DATE>
Notes </REFSECT2INFO>
</TITLE> <TITLE>
<PARA> Notes
The <command>SET <replaceable class="parameter">variable</replaceable></command> </TITLE>
statement is a <productname>Postgres</productname> language extension. <PARA>
The <command>SET <replaceable class="parameter">variable</replaceable></command>
<para> statement is a <productname>Postgres</productname> language extension.
Refer to <command>SHOW</command> and <command>RESET</command> to </para>
display or reset the current values. <para>
Refer to <command>SHOW</command> and <command>RESET</command> to
</REFSECT2> display or reset the current values.
</REFSECT1> </para>
</REFSECT2>
<REFSECT1 ID="R1-SQL-SET-2"> </REFSECT1>
<TITLE>
Usage <REFSECT1 ID="R1-SQL-SET-2">
</TITLE> <TITLE>
<PARA> Usage
</PARA> </TITLE>
<ProgramListing> <PARA>
--Set the style of date to ISO: </PARA>
-- <ProgramListing>
SET DATESTYLE TO 'ISO'; --Set the style of date to ISO:
</programlisting> --
<programlisting> SET DATESTYLE TO 'ISO';
--Set GEQO to default: </programlisting>
-- <programlisting>
SET GEQO = DEFAULT; --Set GEQO to default:
</programlisting> --
<programlisting> SET GEQO = DEFAULT;
--Turn on right-hand evaluation of plans: </programlisting>
-- <programlisting>
SET R_PLANS TO 'on'; --Turn on right-hand evaluation of plans:
</programlisting> --
<programlisting> SET R_PLANS TO 'on';
--set the timezone for Berkeley, California: </programlisting>
SET TIME ZONE 'PST8PDT'; <programlisting>
--set the timezone for Berkeley, California:
SELECT CURRENT_TIMESTAMP AS today; SET TIME ZONE 'PST8PDT';
today SELECT CURRENT_TIMESTAMP AS today;
----------------------
1998-03-31 07:41:21-08 today
</programlisting> ----------------------
<programlisting> 1998-03-31 07:41:21-08
--set the timezone for Italy: </programlisting>
SET TIME ZONE 'Europe/Rome'; <programlisting>
--set the timezone for Italy:
SELECT CURRENT_TIMESTAMP AS today; SET TIME ZONE 'Europe/Rome';
today SELECT CURRENT_TIMESTAMP AS today;
----------------------
1998-03-31 17:41:31+02 today
</ProgramListing> ----------------------
1998-03-31 17:41:31+02
</REFSECT1> </ProgramListing>
<REFSECT1 ID="R1-SQL-SET-3"> </REFSECT1>
<TITLE>
Compatibility <REFSECT1 ID="R1-SQL-SET-3">
</TITLE> <TITLE>
<PARA> Compatibility
</PARA> </TITLE>
<PARA>
<REFSECT2 ID="R2-SQL-SET-4"> </PARA>
<REFSECT2INFO>
<DATE>1998-09-24</DATE> <REFSECT2 ID="R2-SQL-SET-4">
</REFSECT2INFO> <REFSECT2INFO>
<TITLE> <DATE>1998-09-24</DATE>
SQL92 </REFSECT2INFO>
</TITLE> <TITLE>
<PARA> SQL92
There is no </TITLE>
<command>SET <replaceable class="parameter">variable</replaceable></command> <PARA>
in <acronym>SQL92</acronym>. There is no
<command>SET <replaceable class="parameter">variable</replaceable></command>
The <acronym>SQL92</acronym> syntax for <command>SET TIME ZONE</command> in <acronym>SQL92</acronym>.
is slightly different,
allowing only a single integer value for time zone specification: The <acronym>SQL92</acronym> syntax for <command>SET TIME ZONE</command>
is slightly different,
<programlisting> allowing only a single integer value for time zone specification:
SET TIME ZONE { interval_value_expression | LOCAL }
</programlisting> <programlisting>
SET TIME ZONE { interval_value_expression | LOCAL }
</programlisting>
</para>
</refsect2>
</refsect1>
</REFENTRY> </REFENTRY>
doc/src/sgml/ref/show.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ SHOW ...@@ -12,6 +12,7 @@ SHOW
<REFPURPOSE> <REFPURPOSE>
Shows run-time parameters for session Shows run-time parameters for session
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-24</DATE> <DATE>1998-09-24</DATE>
...@@ -20,144 +21,151 @@ Shows run-time parameters for session ...@@ -20,144 +21,151 @@ Shows run-time parameters for session
SHOW <REPLACEABLE CLASS="PARAMETER">variable</REPLACEABLE> SHOW <REPLACEABLE CLASS="PARAMETER">variable</REPLACEABLE>
</SYNOPSIS> </SYNOPSIS>
<REFSECT2 ID="R2-SQL-SHOW-1"> <REFSECT2 ID="R2-SQL-SHOW-1">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-09-24</DATE> <DATE>1998-09-24</DATE>
</REFSECT2INFO> </REFSECT2INFO>
<TITLE> <TITLE>
Inputs Inputs
</TITLE> </TITLE>
<PARA> <PARA>
<VARIABLELIST> <VARIABLELIST>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<REPLACEABLE CLASS="PARAMETER">variable</REPLACEABLE> <REPLACEABLE CLASS="PARAMETER">variable</REPLACEABLE>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
Refer to <command>SET</command> for more information on available Refer to <command>SET</command> for more information on available
variables. variables.
</VARLISTENTRY> </para>
</VARIABLELIST> </listitem>
</VARLISTENTRY>
</REFSECT2> </VARIABLELIST>
</para>
<REFSECT2 ID="R2-SQL-SHOW-2"> </REFSECT2>
<REFSECT2INFO>
<DATE>1998-09-24</DATE> <REFSECT2 ID="R2-SQL-SHOW-2">
</REFSECT2INFO> <REFSECT2INFO>
<TITLE> <DATE>1998-09-24</DATE>
Outputs </REFSECT2INFO>
</TITLE> <TITLE>
<PARA> Outputs
</TITLE>
<VARIABLELIST> <PARA>
<VARLISTENTRY>
<TERM> <VARIABLELIST>
<returnvalue>NOTICE: <REPLACEABLE CLASS="PARAMETER">variable</REPLACEABLE> is <replaceable>value</replaceable></ReturnValue> <VARLISTENTRY>
SHOW VARIABLE <TERM>
</TERM> <returnvalue>NOTICE: <REPLACEABLE CLASS="PARAMETER">variable</REPLACEABLE> is <replaceable>value</replaceable></ReturnValue>
<LISTITEM> SHOW VARIABLE
<PARA> </TERM>
Message returned if successfully. <LISTITEM>
</listitem> <PARA>
Message returned if successfully.
<VARLISTENTRY> </para>
<TERM> </listitem>
<returnvalue>NOTICE: Unrecognized variable <replaceable>value</replaceable></ReturnValue> </varlistentry>
</TERM> <VARLISTENTRY>
<LISTITEM> <TERM>
<PARA> <returnvalue>NOTICE: Unrecognized variable <replaceable>value</replaceable></ReturnValue>
Message returned if <ReturnValue>value</ReturnValue> does not exist. </TERM>
</PARA> <LISTITEM>
</LISTITEM> <PARA>
</VARLISTENTRY> Message returned if <ReturnValue>value</ReturnValue> does not exist.
</PARA>
<VARLISTENTRY> </LISTITEM>
<TERM> </VARLISTENTRY>
NOTICE: Time zone is unknown
SHOW VARIABLE <VARLISTENTRY>
</TERM> <TERM>
<LISTITEM> NOTICE: Time zone is unknown
<PARA> SHOW VARIABLE
If the TZ environment variable is not set. </TERM>
<LISTITEM>
</VARIABLELIST> <PARA>
If the TZ environment variable is not set.
</REFSECT2> </para>
</REFSYNOPSISDIV> </listitem>
</varlistentry>
<REFSECT1 ID="R1-SQL-SHOW-1"> </VARIABLELIST>
<REFSECT1INFO> </para>
<DATE>1998-09-24</DATE> </REFSECT2>
</REFSECT1INFO> </REFSYNOPSISDIV>
<TITLE>
Description <REFSECT1 ID="R1-SQL-SHOW-1">
</TITLE> <REFSECT1INFO>
<PARA> <DATE>1998-09-24</DATE>
<command>SHOW</command> will display the current </REFSECT1INFO>
configuration parameters for <TITLE>
variable during a session. Description
</TITLE>
<para> <PARA>
The session can be configured using <command>SET</command> statement, <command>SHOW</command> will display the current
and values configuration parameters for
can be restored to the defaults using <command>RESET</command> statement. variable during a session.
Parameters and values are case-insensitive. </para>
<para>
<REFSECT2 ID="R2-SQL-SHOW-3"> The session can be configured using <command>SET</command> statement,
<REFSECT2INFO> and values
<DATE>1998-09-24</DATE> can be restored to the defaults using <command>RESET</command> statement.
</REFSECT2INFO> Parameters and values are case-insensitive.
<TITLE> </para>
Notes
</TITLE> <REFSECT2 ID="R2-SQL-SHOW-3">
<PARA> <REFSECT2INFO>
The <command>SHOW</command> is a <productname>Postgres</productname> <DATE>1998-09-24</DATE>
language extension. </REFSECT2INFO>
<TITLE>
<para> Notes
Refer to <command>SET</command>/<command>RESET</command> </TITLE>
to set/reset variable values. <PARA>
See also <command>SET TIME ZONE</command>. The <command>SHOW</command> is a <productname>Postgres</productname>
language extension.
</REFSECT2> </para>
</REFSECT1> <para>
Refer to <command>SET</command>/<command>RESET</command>
<REFSECT1 ID="R1-SQL-SHOW-2"> to set/reset variable values.
<TITLE> See also <command>SET TIME ZONE</command>.
Usage </para>
</TITLE> </REFSECT2>
<PARA> </REFSECT1>
<ProgramListing>
-- show DateStyle; <REFSECT1 ID="R1-SQL-SHOW-2">
SHOW DateStyle; <TITLE>
NOTICE:DateStyle is Postgres with US (NonEuropean) conventions Usage
</TITLE>
-- show Geqo; <PARA>
SHOW GEQO; <ProgramListing>
NOTICE:GEQO is ON -- show DateStyle;
</ProgramListing> SHOW DateStyle;
NOTICE:DateStyle is Postgres with US (NonEuropean) conventions
</REFSECT1>
-- show Geqo;
<REFSECT1 ID="R1-SQL-SHOW-3"> SHOW GEQO;
<TITLE> NOTICE:GEQO is ON
Compatibility </ProgramListing>
</TITLE> </para>
<PARA> </REFSECT1>
</PARA>
<REFSECT1 ID="R1-SQL-SHOW-3">
<REFSECT2 ID="R2-SQL-SHOW-4"> <TITLE>
<REFSECT2INFO> Compatibility
<DATE>1998-09-24</DATE> </TITLE>
</REFSECT2INFO> <PARA>
<TITLE> </PARA>
SQL92
</TITLE> <REFSECT2 ID="R2-SQL-SHOW-4">
<PARA> <REFSECT2INFO>
There is no <command>SET</command> defined in <acronym>SQL92</acronym>. <DATE>1998-09-24</DATE>
</refsect2> </REFSECT2INFO>
</refsect1> <TITLE>
SQL92
</TITLE>
<PARA>
There is no <command>SET</command> defined in <acronym>SQL92</acronym>.
</para>
</refsect2>
</refsect1>
</REFENTRY> </REFENTRY>
doc/src/sgml/ref/unlisten.sgml
View file @ a75f2d21
...@@ -12,7 +12,7 @@ UNLISTEN ...@@ -12,7 +12,7 @@ UNLISTEN
<REFPURPOSE> <REFPURPOSE>
Stop listening for notification Stop listening for notification
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-10-19</DATE> <DATE>1998-10-19</DATE>
...@@ -38,7 +38,9 @@ Inputs ...@@ -38,7 +38,9 @@ Inputs
<LISTITEM> <LISTITEM>
<PARA> <PARA>
Name of previously registered notify condition. Name of previously registered notify condition.
</para>
</listitem>
</varlistentry>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<literal>*</literal> <literal>*</literal>
...@@ -46,6 +48,9 @@ Name of previously registered notify condition. ...@@ -46,6 +48,9 @@ Name of previously registered notify condition.
<LISTITEM> <LISTITEM>
<PARA> <PARA>
All current listen registrations for this backend are cleared. All current listen registrations for this backend are cleared.
</para>
</listitem>
</varlistentry>
</VARIABLELIST> </VARIABLELIST>
...@@ -68,8 +73,12 @@ Outputs ...@@ -68,8 +73,12 @@ Outputs
<LISTITEM> <LISTITEM>
<PARA> <PARA>
Acknowledgement that statement has executed. Acknowledgement that statement has executed.
</para>
</listitem>
</varlistentry>
</VARIABLELIST> </VARIABLELIST>
</para>
</REFSECT2> </REFSECT2>
</REFSYNOPSISDIV> </REFSYNOPSISDIV>
...@@ -88,12 +97,13 @@ UNLISTEN cancels any existing registration of the current ...@@ -88,12 +97,13 @@ UNLISTEN cancels any existing registration of the current
condition <REPLACEABLE CLASS="PARAMETER">notifyname</REPLACEABLE>. condition <REPLACEABLE CLASS="PARAMETER">notifyname</REPLACEABLE>.
The special condition wildcard "*" cancels all listener registrations The special condition wildcard "*" cancels all listener registrations
for the current session. for the current session.
</para>
<para> <para>
<xref linkend="sql-notify" endterm="sql-notify-ref"> <xref linkend="sql-notify" endterm="sql-notify-ref">
contains a more extensive contains a more extensive
discussion of the use of <command>LISTEN</command> and discussion of the use of <command>LISTEN</command> and
<command>NOTIFY</command>. <command>NOTIFY</command>.
</para>
<REFSECT2 ID="R2-SQL-UNLISTEN-3"> <REFSECT2 ID="R2-SQL-UNLISTEN-3">
<REFSECT2INFO> <REFSECT2INFO>
...@@ -106,21 +116,22 @@ Notes ...@@ -106,21 +116,22 @@ Notes
<REPLACEABLE CLASS="PARAMETER">classname</REPLACEABLE> <REPLACEABLE CLASS="PARAMETER">classname</REPLACEABLE>
needs not to be a valid class name but can be any string valid needs not to be a valid class name but can be any string valid
as a name up to 32 characters long. as a name up to 32 characters long.
</para>
<para> <para>
The backend does not complain if you UNLISTEN something you were not The backend does not complain if you UNLISTEN something you were not
listening for. listening for.
Each backend will automatically execute <command>UNLISTEN *</command> when Each backend will automatically execute <command>UNLISTEN *</command> when
exiting. exiting.
</para>
<para> <para>
A restriction in some previous releases of A restriction in some previous releases of
<productname>Postgres</productname> that a <productname>Postgres</productname> that a
<REPLACEABLE CLASS="PARAMETER">classname</REPLACEABLE> <REPLACEABLE CLASS="PARAMETER">classname</REPLACEABLE>
which does not correspond to an actual table must be enclosed in double-quotes which does not correspond to an actual table must be enclosed in double-quotes
is no longer present. is no longer present.
</para>
</REFSECT2> </REFSECT2>
</refsect1>
<REFSECT1 ID="R1-SQL-UNLISTEN-2"> <REFSECT1 ID="R1-SQL-UNLISTEN-2">
<TITLE> <TITLE>
...@@ -144,14 +155,13 @@ NOTIFY ...@@ -144,14 +155,13 @@ NOTIFY
-- notice no NOTIFY event is received -- notice no NOTIFY event is received
postgres=> postgres=>
</programlisting> </programlisting>
</para>
</REFSECT1> </REFSECT1>
<REFSECT1 ID="R1-SQL-UNLISTEN-3"> <REFSECT1 ID="R1-SQL-UNLISTEN-3">
<TITLE> <TITLE>
Compatibility Compatibility
</TITLE> </TITLE>
<PARA>
<REFSECT2 ID="R2-SQL-UNLISTEN-4"> <REFSECT2 ID="R2-SQL-UNLISTEN-4">
<REFSECT2INFO> <REFSECT2INFO>
...@@ -162,5 +172,7 @@ SQL92 ...@@ -162,5 +172,7 @@ SQL92
</TITLE> </TITLE>
<PARA> <PARA>
There is no <command>UNLISTEN</command> in <acronym>SQL92</acronym>. There is no <command>UNLISTEN</command> in <acronym>SQL92</acronym>.
</para>
</refsect2>
</refsect1>
</REFENTRY> </REFENTRY>
doc/src/sgml/ref/update.sgml
View file @ a75f2d21
...@@ -12,7 +12,7 @@ UPDATE ...@@ -12,7 +12,7 @@ UPDATE
<REFPURPOSE> <REFPURPOSE>
Replaces values of columns in a table Replaces values of columns in a table
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-24</DATE> <DATE>1998-09-24</DATE>
...@@ -23,127 +23,134 @@ UPDATE <REPLACEABLE CLASS="PARAMETER">table</replaceable> SET <REPLACEABLE CLASS ...@@ -23,127 +23,134 @@ UPDATE <REPLACEABLE CLASS="PARAMETER">table</replaceable> SET <REPLACEABLE CLASS
[ WHERE <REPLACEABLE CLASS="PARAMETER">condition</REPLACEABLE> ] [ WHERE <REPLACEABLE CLASS="PARAMETER">condition</REPLACEABLE> ]
</SYNOPSIS> </SYNOPSIS>
<REFSECT2 ID="R2-SQL-UPDATE-1"> <REFSECT2 ID="R2-SQL-UPDATE-1">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-09-24</DATE> <DATE>1998-09-24</DATE>
</REFSECT2INFO> </REFSECT2INFO>
<TITLE> <TITLE>
Inputs Inputs
</TITLE> </TITLE>
<PARA> <PARA>
<VARIABLELIST> <VARIABLELIST>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
<REPLACEABLE CLASS="PARAMETER">table</replaceable> <REPLACEABLE CLASS="PARAMETER">table</replaceable>
</TERM> </TERM>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
The name of an existing table. The name of an existing table.
</LISTITEM> </para>
</VARLISTENTRY> </LISTITEM>
<VARLISTENTRY> </VARLISTENTRY>
<TERM> <VARLISTENTRY>
<REPLACEABLE CLASS="PARAMETER">column</replaceable> <TERM>
</TERM> <REPLACEABLE CLASS="PARAMETER">column</replaceable>
<LISTITEM> </TERM>
<PARA> <LISTITEM>
The name of a column in <REPLACEABLE CLASS="PARAMETER">table</replaceable>. <PARA>
</LISTITEM> The name of a column in <REPLACEABLE CLASS="PARAMETER">table</replaceable>.
</VARLISTENTRY> </para>
<VARLISTENTRY> </LISTITEM>
<TERM> </VARLISTENTRY>
<REPLACEABLE CLASS="PARAMETER">expression</replaceable> <VARLISTENTRY>
</TERM> <TERM>
<LISTITEM> <REPLACEABLE CLASS="PARAMETER">expression</replaceable>
<PARA> </TERM>
A valid expression or value to assign to column. <LISTITEM>
</LISTITEM> <PARA>
</VARLISTENTRY> A valid expression or value to assign to column.
<VARLISTENTRY> </para>
<TERM> </LISTITEM>
<REPLACEABLE CLASS="PARAMETER">fromlist</REPLACEABLE> </VARLISTENTRY>
</TERM> <VARLISTENTRY>
<LISTITEM> <TERM>
<PARA> <REPLACEABLE CLASS="PARAMETER">fromlist</REPLACEABLE>
A <productname>Postgres</productname> </TERM>
non-standard extension to allow columns <LISTITEM>
from other tables to appear in the WHERE condition. <PARA>
</LISTITEM> A <productname>Postgres</productname>
</VARLISTENTRY> non-standard extension to allow columns
<VARLISTENTRY> from other tables to appear in the WHERE condition.
<TERM> </para>
<REPLACEABLE CLASS="PARAMETER">condition</REPLACEABLE> </LISTITEM>
</TERM> </VARLISTENTRY>
<LISTITEM> <VARLISTENTRY>
<PARA> <TERM>
Refer to the SELECT statement for a further description <REPLACEABLE CLASS="PARAMETER">condition</REPLACEABLE>
of the WHERE clause. </TERM>
</LISTITEM> <LISTITEM>
</VARLISTENTRY> <PARA>
</VARIABLELIST> Refer to the SELECT statement for a further description
</REFSECT2> of the WHERE clause.
</para>
<REFSECT2 ID="R2-SQL-UPDATE-2"> </LISTITEM>
<REFSECT2INFO> </VARLISTENTRY>
<DATE>1998-09-24</DATE> </VARIABLELIST>
</REFSECT2INFO> </para>
<TITLE> </REFSECT2>
Outputs
</TITLE> <REFSECT2 ID="R2-SQL-UPDATE-2">
<PARA> <REFSECT2INFO>
<DATE>1998-09-24</DATE>
<VARIABLELIST> </REFSECT2INFO>
<VARLISTENTRY> <TITLE>
<TERM> Outputs
UPDATE <replaceable class="parameter">#</replaceable> </TITLE>
</TERM> <PARA>
<LISTITEM>
<PARA> <VARIABLELIST>
Message returned if successful. <VARLISTENTRY>
The <replaceable class="parameter">#</replaceable> <TERM>
means the number of rows updated. UPDATE <replaceable class="parameter">#</replaceable>
If <replaceable class="parameter">#</replaceable> </TERM>
is equal 0 no rows are updated. <LISTITEM>
</LISTITEM> <PARA>
</VARLISTENTRY> Message returned if successful.
</VARIABLELIST> The <replaceable class="parameter">#</replaceable>
means the number of rows updated.
</REFSECT2> If <replaceable class="parameter">#</replaceable>
</REFSYNOPSISDIV> is equal 0 no rows are updated.
</para>
<REFSECT1 ID="R1-SQL-UPDATE-1"> </LISTITEM>
<REFSECT1INFO> </VARLISTENTRY>
<DATE>1998-09-24</DATE> </VARIABLELIST>
</REFSECT1INFO> </para>
<TITLE> </REFSECT2>
Description </REFSYNOPSISDIV>
</TITLE>
<PARA> <REFSECT1 ID="R1-SQL-UPDATE-1">
UPDATE changes the values of the columns specified for <REFSECT1INFO>
all rows which satisfy condition. Only the columns <DATE>1998-09-24</DATE>
to be modified need appear as column. </REFSECT1INFO>
<TITLE>
<PARA> Description
Array references use the same syntax found in SELECT. </TITLE>
That is, either single array elements, a range of array <PARA>
elements or the entire array may be replaced with a single UPDATE changes the values of the columns specified for
query. all rows which satisfy condition. Only the columns
to be modified need appear as column.
<PARA> </para>
You must have write access to the table in order to modify <PARA>
it, as well as read access to any table whose values are Array references use the same syntax found in SELECT.
mentioned in the WHERE condition. That is, either single array elements, a range of array
elements or the entire array may be replaced with a single
</REFSECT1> query.
</para>
<REFSECT1 ID="R1-SQL-UPDATE-2"> <PARA>
<TITLE> You must have write access to the table in order to modify
Usage it, as well as read access to any table whose values are
</TITLE> mentioned in the WHERE condition.
<PARA> </para>
</PARA> </REFSECT1>
<ProgramListing>
<REFSECT1 ID="R1-SQL-UPDATE-2">
<TITLE>
Usage
</TITLE>
<PARA>
</PARA>
<ProgramListing>
--Change word "Drama" with "Dramatic" on column kind: --Change word "Drama" with "Dramatic" on column kind:
-- --
UPDATE films UPDATE films
...@@ -159,32 +166,35 @@ Usage ...@@ -159,32 +166,35 @@ Usage
M_401|War and Peace|104|1967-02-12|Dramatic | 05:57 M_401|War and Peace|104|1967-02-12|Dramatic | 05:57
T_601|Yojimbo |106|1961-06-16|Dramatic | 01:50 T_601|Yojimbo |106|1961-06-16|Dramatic | 01:50
DA101|Das Boot |110|1981-11-11|Dramatic | 02:29 DA101|Das Boot |110|1981-11-11|Dramatic | 02:29
</ProgramListing> </ProgramListing>
</REFSECT1> </REFSECT1>
<REFSECT1 ID="R1-SQL-UPDATE-3"> <REFSECT1 ID="R1-SQL-UPDATE-3">
<TITLE> <TITLE>
Compatibility Compatibility
</TITLE> </TITLE>
<PARA> <PARA>
</PARA> </PARA>
<REFSECT2 ID="R2-SQL-UPDATE-4"> <REFSECT2 ID="R2-SQL-UPDATE-4">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-09-24</DATE> <DATE>1998-09-24</DATE>
</REFSECT2INFO> </REFSECT2INFO>
<TITLE> <TITLE>
SQL92 SQL92
</TITLE> </TITLE>
<PARA> <PARA>
SQL92 defines a different syntax for positioned UPDATE statement: SQL92 defines a different syntax for positioned UPDATE statement:
<programlisting> <programlisting>
UPDATE table SET column = expression [, ...] UPDATE table SET column = expression [, ...]
WHERE CURRENT OF <replaceable class="parameter">cursor</replaceable> WHERE CURRENT OF <replaceable class="parameter">cursor</replaceable>
</programlisting> </programlisting>
where <replaceable class="parameter">cursor</replaceable> where <replaceable class="parameter">cursor</replaceable>
identifies an open cursor. identifies an open cursor.
</para>
</refsect2>
</refsect1>
</REFENTRY> </REFENTRY>
doc/src/sgml/ref/vacuum.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ VACUUM ...@@ -12,6 +12,7 @@ VACUUM
<REFPURPOSE> <REFPURPOSE>
Clean and analyze a <productname>Postgres</productname> database Clean and analyze a <productname>Postgres</productname> database
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-10-04</DATE> <DATE>1998-10-04</DATE>
...@@ -21,163 +22,191 @@ VACUUM [ VERBOSE ] [ ANALYZE ] [ <REPLACEABLE CLASS="PARAMETER">table</REPLACEAB ...@@ -21,163 +22,191 @@ VACUUM [ VERBOSE ] [ ANALYZE ] [ <REPLACEABLE CLASS="PARAMETER">table</REPLACEAB
VACUUM [ VERBOSE ] ANALYZE [ <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE> [ (<REPLACEABLE CLASS="PARAMETER">column</REPLACEABLE> [, ...] ) ] ] VACUUM [ VERBOSE ] ANALYZE [ <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE> [ (<REPLACEABLE CLASS="PARAMETER">column</REPLACEABLE> [, ...] ) ] ]
</SYNOPSIS> </SYNOPSIS>
<REFSECT2 ID="R2-SQL-VACUUM-1"> <REFSECT2 ID="R2-SQL-VACUUM-1">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-10-04</DATE> <DATE>1998-10-04</DATE>
</REFSECT2INFO> </REFSECT2INFO>
<TITLE> <TITLE>
Inputs Inputs
</TITLE> </TITLE>
<PARA> <PARA>
<VARIABLELIST> <VARIABLELIST>
<VARLISTENTRY> <VARLISTENTRY>
<TERM> <TERM>
VERBOSE VERBOSE
<LISTITEM> </term>
<PARA> <LISTITEM>
Prints a detailed vacuum activity report for each table. <PARA>
Prints a detailed vacuum activity report for each table.
<VARLISTENTRY> </para>
<TERM> </listitem>
ANALYZE </varlistentry>
<LISTITEM> <VARLISTENTRY>
<PARA> <TERM>
Updates column statistics used by the optimizer to ANALYZE
determine the most efficient way to execute a query. </term>
The statistics represent the disbursion of the data in each column. <LISTITEM>
This information is valuable when several execution paths are possible. <PARA>
Updates column statistics used by the optimizer to
<VARLISTENTRY> determine the most efficient way to execute a query.
<TERM> The statistics represent the disbursion of the data in each column.
<REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE> This information is valuable when several execution paths are possible.
<LISTITEM> </para>
<PARA> </listitem>
The name of a specific table to vacuum. Defaults to all tables. </varlistentry>
<VARLISTENTRY>
<VARLISTENTRY> <TERM>
<TERM> <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE>
<REPLACEABLE CLASS="PARAMETER">column</REPLACEABLE> </term>
<LISTITEM> <LISTITEM>
<PARA> <PARA>
The name of a specific column to analyze. Defaults to all columns. The name of a specific table to vacuum. Defaults to all tables.
</para>
</VARIABLELIST> </listitem>
</varlistentry>
</REFSECT2> <VARLISTENTRY>
<TERM>
<REFSECT2 ID="R2-SQL-VACUUM-2"> <REPLACEABLE CLASS="PARAMETER">column</REPLACEABLE>
<REFSECT2INFO> </term>
<DATE>1998-10-04</DATE> <LISTITEM>
</REFSECT2INFO> <PARA>
<TITLE> The name of a specific column to analyze. Defaults to all columns.
Outputs </para>
</TITLE> </listitem>
<PARA> </varlistentry>
</VARIABLELIST>
<VARIABLELIST> </para>
<VARLISTENTRY> </REFSECT2>
<TERM>
<ReturnValue>VACUUM</ReturnValue> <REFSECT2 ID="R2-SQL-VACUUM-2">
</TERM> <REFSECT2INFO>
<LISTITEM> <DATE>1998-10-04</DATE>
<PARA> </REFSECT2INFO>
The command has been accepted and the database is being cleaned. <TITLE>
Outputs
<VARLISTENTRY> </TITLE>
<TERM> <PARA>
NOTICE: --Relation <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE>--
<LISTITEM> <VARIABLELIST>
<PARA> <VARLISTENTRY>
The report header for <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE>. <TERM>
<ReturnValue>VACUUM</ReturnValue>
<VARLISTENTRY> </TERM>
<TERM> <LISTITEM>
NOTICE: Pages 98: Changed 25, Reapped 74, Empty 0, New 0; <PARA>
Tup 1000: Vac 3000, Crash 0, UnUsed 0, MinLen 188, MaxLen 188; The command has been accepted and the database is being cleaned.
Re-using: Free/Avail. Space 586952/586952; EndEmpty/Avail. Pages 0/74. </para>
Elapsed 0/0 sec. </listitem>
<LISTITEM> </varlistentry>
<PARA>
The analysis for <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE> itself. <VARLISTENTRY>
<TERM>
<VARLISTENTRY> NOTICE: --Relation <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE>--
<TERM> </term>
NOTICE: Index <REPLACEABLE CLASS="PARAMETER">index</REPLACEABLE>: Pages 28; <LISTITEM>
Tuples 1000: Deleted 3000. Elapsed 0/0 sec. <PARA>
<LISTITEM> The report header for <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE>.
<PARA> </para>
The analysis for an index on the target table. </listitem>
</varlistentry>
</VARIABLELIST>
<VARLISTENTRY>
</REFSECT2> <TERM>
</REFSYNOPSISDIV> NOTICE: Pages 98: Changed 25, Reapped 74, Empty 0, New 0;
Tup 1000: Vac 3000, Crash 0, UnUsed 0, MinLen 188, MaxLen 188;
<REFSECT1 ID="R1-SQL-VACUUM-1"> Re-using: Free/Avail. Space 586952/586952; EndEmpty/Avail. Pages 0/74.
<REFSECT1INFO> Elapsed 0/0 sec.
<DATE>1998-10-04</DATE> </term>
</REFSECT1INFO> <LISTITEM>
<TITLE> <PARA>
Description The analysis for <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE> itself.
</TITLE> </para>
<PARA> </listitem>
<command>VACUUM</command> serves two purposes in </varlistentry>
<productname>Postgres</productname> as both a means to reclaim storage and
also a means to collect information for the optimizer. <VARLISTENTRY>
<TERM>
<para> NOTICE: Index <REPLACEABLE CLASS="PARAMETER">index</REPLACEABLE>: Pages 28;
<command>VACUUM</command> opens every class in the database, Tuples 1000: Deleted 3000. Elapsed 0/0 sec.
cleans out records from rolled back transactions, and updates statistics in the </term>
system catalogs. The statistics maintained include the number of <LISTITEM>
tuples and number of pages stored in all classes. <PARA>
The analysis for an index on the target table.
Running <command>VACUUM</command> </para>
periodically will increase the speed of the database in processing user queries. </listitem>
</varlistentry>
<REFSECT2 ID="R2-SQL-VACUUM-3"> </VARIABLELIST>
<REFSECT2INFO> </para>
<DATE>1998-10-04</DATE> </REFSECT2>
</REFSECT2INFO> </REFSYNOPSISDIV>
<TITLE>
Notes <REFSECT1 ID="R1-SQL-VACUUM-1">
</TITLE> <REFSECT1INFO>
<PARA> <DATE>1998-10-04</DATE>
The open database is target for <command>VACUUM</command>. </REFSECT1INFO>
<TITLE>
<para> Description
We recommend that active production databases be cleaned nightly, in order </TITLE>
to keep statistics relatively current. The <command>VACUUM</command> <PARA>
query may be executed at any time, however. In particular, after <command>VACUUM</command> serves two purposes in
copying a large class into <productname>Postgres</productname> <productname>Postgres</productname> as both a means to reclaim storage and
or after deleting a large number of also a means to collect information for the optimizer.
records, it may be a good idea to issue a <command>VACUUM</command> </para>
query. This will update the system catalogs with the results of all <para>
recent changes, and allow the <productname>Postgres</productname> <command>VACUUM</command> opens every class in the database,
query optimizer to make better choices in planning user queries. cleans out records from rolled back transactions, and updates statistics in the
system catalogs. The statistics maintained include the number of
<para> tuples and number of pages stored in all classes.
If the server crashes during a <command>VACUUM</command> command,
chances are it will leave a lock file hanging around. Running <command>VACUUM</command>
Attempts to re-run the <command>VACUUM</command> command periodically will increase the speed of the database in processing user queries.
result in an error message about the creation of a lock file. If you </para>
are sure <command>VACUUM</command> is not running,
remove the <filename>pg_vlock</filename> file in your <REFSECT2 ID="R2-SQL-VACUUM-3">
database directory <REFSECT2INFO>
(i.e. <filename><envar>PGDATA</envar>/base/dbname/pg_vlock</filename>). <DATE>1998-10-04</DATE>
</PARA> </REFSECT2INFO>
<TITLE>
</REFSECT2> Notes
</TITLE>
<REFSECT1 ID="R1-SQL-VACUUM-2"> <PARA>
<TITLE> The open database is target for <command>VACUUM</command>.
Usage </para>
</TITLE> <para>
<PARA> We recommend that active production databases be cleaned nightly, in order
The following is an example from running <command>VACUUM</command> on a table to keep statistics relatively current. The <command>VACUUM</command>
in the regression database: query may be executed at any time, however. In particular, after
copying a large class into <productname>Postgres</productname>
<ProgramListing> or after deleting a large number of
records, it may be a good idea to issue a <command>VACUUM</command>
query. This will update the system catalogs with the results of all
recent changes, and allow the <productname>Postgres</productname>
query optimizer to make better choices in planning user queries.
</para>
<para>
If the server crashes during a <command>VACUUM</command> command,
chances are it will leave a lock file hanging around.
Attempts to re-run the <command>VACUUM</command> command
result in an error message about the creation of a lock file. If you
are sure <command>VACUUM</command> is not running,
remove the <filename>pg_vlock</filename> file in your
database directory
(i.e. <filename><envar>PGDATA</envar>/base/dbname/pg_vlock</filename>).
</PARA>
</REFSECT2>
</refsect1>
<REFSECT1 ID="R1-SQL-VACUUM-2">
<TITLE>
Usage
</TITLE>
<PARA>
The following is an example from running <command>VACUUM</command> on a table
in the regression database:
<ProgramListing>
regression=> vacuum verbose analyze onek; regression=> vacuum verbose analyze onek;
NOTICE: --Relation onek-- NOTICE: --Relation onek--
NOTICE: Pages 98: Changed 25, Reapped 74, Empty 0, New 0; NOTICE: Pages 98: Changed 25, Reapped 74, Empty 0, New 0;
...@@ -194,24 +223,24 @@ NOTICE: Index onek_hundred: Pages 12; Tuples 1000: Deleted 1000. Elapsed 0/0 se ...@@ -194,24 +223,24 @@ NOTICE: Index onek_hundred: Pages 12; Tuples 1000: Deleted 1000. Elapsed 0/0 se
NOTICE: Index onek_unique2: Pages 19; Tuples 1000: Deleted 1000. Elapsed 0/0 sec. NOTICE: Index onek_unique2: Pages 19; Tuples 1000: Deleted 1000. Elapsed 0/0 sec.
NOTICE: Index onek_unique1: Pages 17; Tuples 1000: Deleted 1000. Elapsed 0/0 sec. NOTICE: Index onek_unique1: Pages 17; Tuples 1000: Deleted 1000. Elapsed 0/0 sec.
VACUUM VACUUM
</ProgramListing> </ProgramListing>
</para>
</REFSECT1> </REFSECT1>
<REFSECT1 ID="R1-SQL-VACUUM-3"> <REFSECT1 ID="R1-SQL-VACUUM-3">
<TITLE> <TITLE>
Compatibility Compatibility
</TITLE> </TITLE>
<PARA> <REFSECT2 ID="R2-SQL-VACUUM-4">
<REFSECT2INFO>
<REFSECT2 ID="R2-SQL-VACUUM-4"> <DATE>1998-10-04</DATE>
<REFSECT2INFO> </REFSECT2INFO>
<DATE>1998-10-04</DATE> <TITLE>
</REFSECT2INFO> SQL92
<TITLE> </TITLE>
SQL92 <PARA>
</TITLE> There is no <COMMAND>VACUUM</COMMAND> statement in SQL92.
<PARA> </para>
There is no <COMMAND>VACUUM</COMMAND> statement in SQL92. </refsect2>
</refsect1>
</REFENTRY> </REFENTRY>
doc/src/sgml/ref/vacuumdb.sgml
View file @ a75f2d21
...@@ -12,6 +12,7 @@ ...@@ -12,6 +12,7 @@
<REFPURPOSE> <REFPURPOSE>
Clean and analyze a <productname>Postgres</productname> database Clean and analyze a <productname>Postgres</productname> database
</REFPURPOSE> </REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-10-04</DATE> <DATE>1998-10-04</DATE>
...@@ -23,218 +24,262 @@ vacuumdb [ -h <replaceable class="parameter">host</replaceable> ] [ -p <replacea ...@@ -23,218 +24,262 @@ vacuumdb [ -h <replaceable class="parameter">host</replaceable> ] [ -p <replacea
[ <replaceable class="parameter">dbname</replaceable> ] [ <replaceable class="parameter">dbname</replaceable> ]
</SYNOPSIS> </SYNOPSIS>
<REFSECT2 ID="R2-APP-VACUUMDB-1"> <REFSECT2 ID="R2-APP-VACUUMDB-1">
<REFSECT2INFO> <REFSECT2INFO>
<DATE>1998-10-04</DATE> <DATE>1998-10-04</DATE>
</REFSECT2INFO> </REFSECT2INFO>
<TITLE> <TITLE>
Inputs Inputs
</TITLE> </TITLE>
<PARA> <PARA>
<application>vacuumdb</application> accepts the following command line arguments: <application>vacuumdb</application> accepts the following command line arguments:
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>
<replaceable class="parameter">dbname</replaceable> <replaceable class="parameter">dbname</replaceable>
</term> </term>
<listitem> <listitem>
<para> <para>
Specifies the name of the database to be cleaned or analyzed. Specifies the name of the database to be cleaned or analyzed.
<replaceable class="parameter">dbname</replaceable> <replaceable class="parameter">dbname</replaceable>
defaults to the value of the defaults to the value of the
<envar>USER</envar> <envar>USER</envar>
environment variable. environment variable.
</para>
<varlistentry> </listitem>
<term> </varlistentry>
--analyze
</term> <varlistentry>
<term> <term>
-z --analyze
</term> </term>
<listitem> <term>
<para> -z
Calculate statistics on the database for use by the optimizer. </term>
<listitem>
<varlistentry> <para>
<term> Calculate statistics on the database for use by the optimizer.
--verbose </para>
</term> </listitem>
<term> </varlistentry>
-v
</term> <varlistentry>
<listitem> <term>
<para> --verbose
Print detailed information during processing. </term>
<term>
<varlistentry> -v
<term> </term>
--table <replaceable class="parameter">table</replaceable> [ (<replaceable class="parameter">column</replaceable> [,...]) ] <listitem>
</term> <para>
<term> Print detailed information during processing.
-t <replaceable class="parameter">table</replaceable> [ (<replaceable class="parameter">column</replaceable> [,...]) ] </para>
</term> </listitem>
<listitem> </varlistentry>
<para>
Clean or analyze <replaceable class="parameter">table</replaceable> only. <varlistentry>
Column names may be specified only in conjunction with <term>
the <option>--analyze</option> option. --table <replaceable class="parameter">table</replaceable> [ (<replaceable class="parameter">column</replaceable> [,...]) ]
</term>
</variablelist> <term>
-t <replaceable class="parameter">table</replaceable> [ (<replaceable class="parameter">column</replaceable> [,...]) ]
<para> </term>
<application>vacuumdb</application> also accepts <listitem>
the following command line arguments for connection parameters: <para>
Clean or analyze <replaceable class="parameter">table</replaceable> only.
<variablelist> Column names may be specified only in conjunction with
<varlistentry> the <option>--analyze</option> option.
<term> </para>
-h <replaceable class="parameter">host</replaceable> </listitem>
</term> </varlistentry>
<listitem>
<para> </variablelist>
Specifies the hostname of the machine on which the </para>
<application>postmaster</application> <para>
is running. Defaults to using a local Unix domain socket <application>vacuumdb</application> also accepts
rather than an IP connection.. the following command line arguments for connection parameters:
<varlistentry> <variablelist>
<term> <varlistentry>
-p <replaceable class="parameter">port</replaceable> <term>
</term> -h <replaceable class="parameter">host</replaceable>
<listitem> </term>
<para> <listitem>
Specifies the Internet TCP/IP port or local Unix domain socket file <para>
extension on which the <application>postmaster</application> Specifies the hostname of the machine on which the
is listening for connections. The port number defaults to 5432, <application>postmaster</application>
or the value of the <envar>PGPORT</envar> is running. Defaults to using a local Unix domain socket
environment variable (if set). rather than an IP connection..
</para>
<varlistentry> </listitem>
<term> </varlistentry>
-u
</term> <varlistentry>
<listitem> <term>
<para> -p <replaceable class="parameter">port</replaceable>
Use password authentication. </term>
Prompts for <listitem>
<replaceable class="parameter">username</replaceable> <para>
and <replaceable class="parameter">password</replaceable>. Specifies the Internet TCP/IP port or local Unix domain socket file
extension on which the <application>postmaster</application>
</variablelist> is listening for connections. The port number defaults to 5432,
or the value of the <envar>PGPORT</envar>
<REFSECT2 ID="R2-APP-VACUUMDB-2"> environment variable (if set).
<REFSECT2INFO> </para>
<DATE>1998-10-04</DATE> </listitem>
</REFSECT2INFO> </varlistentry>
<TITLE>
Outputs <varlistentry>
</TITLE> <term>
<PARA> -u
<application>vacuumdb</application> executes a <command>VACUUM</command> command </term>
on the specified database, so has not explicit external output. <listitem>
<para>
<variablelist> Use password authentication.
<varlistentry> Prompts for
<term> <replaceable class="parameter">username</replaceable>
ERROR: Can't vacuum columns, only tables. You can 'vacuum analyze' columns. and <replaceable class="parameter">password</replaceable>.
vacuumdb: database vacuum failed on <replaceable class="parameter">dbname</replaceable>. </para>
<listitem> </listitem>
<para> </varlistentry>
The non-analyze mode requires cleaning full tables or databases.
Individual columns may be specified only when analyzing a specific table.
<varlistentry>
<term>
Connection to database 'template1' failed.
connectDB() failed: Is the postmaster running and accepting connections
at 'UNIX Socket' on port '<replaceable class="parameter">port</replaceable>'?
<listitem>
<para>
<application>vacuumdb</application> could not attach to the
<application>postmaster</application>
process on the specified host and port. If you see this message,
ensure that the <application>postmaster</application>
is running on the proper host and that you have specified the proper
port. If your site uses an authentication system, ensure that you
have obtained the required authentication credentials.
<varlistentry>
<term>
Connection to database '<replaceable class="parameter">dbname</replaceable>' failed.
FATAL 1: SetUserId: user '<replaceable class="parameter">username</replaceable>' is not in 'pg_shadow'
<listitem>
<para>
You do not have a valid entry in the relation <literal>pg_shadow</literal>
and and will not be allowed to access <productname>Postgres</productname>.
Contact your <productname>Postgres</productname> administrator.
</variablelist>
<note>
<para>
<application>vacuumdb</application> internally executes a
<command>VACUUM</command> <acronym>SQL</acronym> statement.
If you have problems running <application>vacuumdb</application>,
make sure you are able to run <command>VACUUM</command> on the database using, for
example, <application>psql</application>.
</note>
<REFSECT1 ID="R1-APP-VACUUMDB-1"> </variablelist>
<REFSECT1INFO> </para>
<DATE>1998-10-04</DATE> </refsect2>
</REFSECT1INFO>
<TITLE>
Description
</TITLE>
<PARA>
<application>vacuumdb</application> is a utility for cleaning a
<productname>Postgres</productname> database.
<application>vacuumdb</application> will also generate internal statistics
used by the <productname>Postgres</productname> query optimizer.
<REFSECT1 ID="R1-APP-VACUUMDB-2">
<REFSECT1INFO>
<DATE>1998-10-04</DATE>
</REFSECT1INFO>
<TITLE>
Notes
</TITLE>
<para>
See <xref linkend="vacuum" endterm="vacuum"> for more details.
<REFSECT1 ID="R1-APP-VACUUMDB-3"> <REFSECT2 ID="R2-APP-VACUUMDB-2">
<REFSECT1INFO> <REFSECT2INFO>
<DATE>1998-10-04</DATE> <DATE>1998-10-04</DATE>
</REFSECT1INFO> </REFSECT2INFO>
<TITLE> <TITLE>
Usage Outputs
</TITLE> </TITLE>
<PARA> <PARA>
To clean a database of the same name as the user: <application>vacuumdb</application> executes a <command>VACUUM</command> command
on the specified database, so has not explicit external output.
<programlisting> <variablelist>
% vacuumdb <varlistentry>
</programlisting> <term>
ERROR: Can't vacuum columns, only tables. You can 'vacuum analyze' columns.
vacuumdb: database vacuum failed on <replaceable class="parameter">dbname</replaceable>.
</term>
<listitem>
<para>
The non-analyze mode requires cleaning full tables or databases.
Individual columns may be specified only when analyzing a specific table.
</para>
</listitem>
</varlistentry>
<para> <varlistentry>
To analyze a database named <literal>bigdb</literal> for the optimizer: <term>
Connection to database 'template1' failed.
connectDB() failed: Is the postmaster running and accepting connections
at 'UNIX Socket' on port '<replaceable class="parameter">port</replaceable>'?
</term>
<listitem>
<para>
<application>vacuumdb</application> could not attach to the
<application>postmaster</application>
process on the specified host and port. If you see this message,
ensure that the <application>postmaster</application>
is running on the proper host and that you have specified the proper
port. If your site uses an authentication system, ensure that you
have obtained the required authentication credentials.
</para>
</listitem>
</varlistentry>
<programlisting> <varlistentry>
% vacuumdb --analyze bigdb <term>
</programlisting> Connection to database '<replaceable class="parameter">dbname</replaceable>' failed.
FATAL 1: SetUserId: user '<replaceable class="parameter">username</replaceable>' is not in 'pg_shadow'
</term>
<listitem>
<para>
You do not have a valid entry in the relation <literal>pg_shadow</literal>
and and will not be allowed to access <productname>Postgres</productname>.
Contact your <productname>Postgres</productname> administrator.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para> <note>
To analyze a single column <literal>bar</literal> in table <literal>foo</literal> <para>
in a database named <literal>xyzzy</literal> for the optimizer: <application>vacuumdb</application> internally executes a
<command>VACUUM</command> <acronym>SQL</acronym> statement.
If you have problems running <application>vacuumdb</application>,
make sure you are able to run <command>VACUUM</command> on the database using, for
example, <application>psql</application>.
</para>
</note>
</refsect2>
</refsynopsisdiv>
<REFSECT1 ID="R1-APP-VACUUMDB-1">
<REFSECT1INFO>
<DATE>1998-10-04</DATE>
</REFSECT1INFO>
<TITLE>
Description
</TITLE>
<PARA>
<application>vacuumdb</application> is a utility for cleaning a
<productname>Postgres</productname> database.
<application>vacuumdb</application> will also generate internal statistics
used by the <productname>Postgres</productname> query optimizer.
</para>
</refsect1>
<programlisting> <REFSECT1 ID="R1-APP-VACUUMDB-2">
% vacuumdb --analyze --verbose --table 'foo(bar)' xyzzy <REFSECT1INFO>
</programlisting> <DATE>1998-10-04</DATE>
</REFSECT1INFO>
<TITLE>
Notes
</TITLE>
<para>
See <xref linkend="vacuum" endterm="vacuum"> for more details.
</para>
</refsect1>
<REFSECT1 ID="R1-APP-VACUUMDB-3">
<REFSECT1INFO>
<DATE>1998-10-04</DATE>
</REFSECT1INFO>
<TITLE>
Usage
</TITLE>
<PARA>
To clean a database of the same name as the user:
<programlisting>
% vacuumdb
</programlisting>
</para>
<para>
To analyze a database named <literal>bigdb</literal> for the optimizer:
<programlisting>
% vacuumdb --analyze bigdb
</programlisting>
</para>
<para>
To analyze a single column <literal>bar</literal> in table <literal>foo</literal>
in a database named <literal>xyzzy</literal> for the optimizer:
<programlisting>
% vacuumdb --analyze --verbose --table 'foo(bar)' xyzzy
</programlisting>
</para>
</refsect1>
</REFENTRY> </REFENTRY>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
......
doc/src/sgml/regress.sgml
View file @ a75f2d21
...@@ -104,22 +104,23 @@ the following: ...@@ -104,22 +104,23 @@ the following:
is not available, you can set the time zone rules explicitly: is not available, you can set the time zone rules explicitly:
<ProgramListing> <ProgramListing>
setenv PGTZ PST8PDT7,M04.01.0,M10.05.03 setenv PGTZ PST8PDT7,M04.01.0,M10.05.03
</ProgramListing> </ProgramListing>
</Para> </Para>
</sect1>
<Sect1>
<Title>Directory Layout</Title> <Sect1>
<Title>Directory Layout</Title>
<Para>
<Note> <Para>
<Para> <Note>
This should become a table in the previous section. <Para>
</Para> This should become a table in the previous section.
</Note> </Para>
</Para> </Note>
</Para>
<Para>
<ProgramListing> <Para>
<ProgramListing>
input/ .... .source files that are converted using 'make all' into input/ .... .source files that are converted using 'make all' into
some of the .sql files in the 'sql' subdirectory some of the .sql files in the 'sql' subdirectory
...@@ -133,316 +134,313 @@ This should become a table in the previous section. ...@@ -133,316 +134,313 @@ This should become a table in the previous section.
results/ .. .out files that represent what the results *actually* look results/ .. .out files that represent what the results *actually* look
like. Also used as temporary storage for table copy testing. like. Also used as temporary storage for table copy testing.
</ProgramListing> </ProgramListing>
</Para> </Para>
</Sect1>
</Sect1>
<Sect1>
<Sect1> <Title>Regression Test Procedure</Title>
<Title>Regression Test Procedure</Title>
<Para>
<Para> Commands were tested on RedHat Linux version 4.2 using the bash shell.
Commands were tested on RedHat Linux version 4.2 using the bash shell. Except where noted, they will probably work on most systems. Commands
Except where noted, they will probably work on most systems. Commands like <FileName>ps</FileName> and <FileName>tar</FileName> vary wildly on what options you should use on each
like <FileName>ps</FileName> and <FileName>tar</FileName> vary wildly on what options you should use on each platform. <Emphasis>Use common sense</Emphasis> before typing in these commands.
platform. <Emphasis>Use common sense</Emphasis> before typing in these commands. </Para>
</Para>
<Procedure>
<Para> <Title><ProductName>Postgres</ProductName> Regression Configuration</Title>
<Procedure>
<Title><ProductName>Postgres</ProductName> Regression Configuration</Title> <Para>
For a fresh install or upgrading from previous releases of
<Para> <ProductName>Postgres</ProductName>:
For a fresh install or upgrading from previous releases of </Para>
<ProductName>Postgres</ProductName>:
</Para> <Step Performance="required">
<Para>
<Step Performance="required"> Build the regression test. Type
<Para> <ProgramListing>
Build the regression test. Type cd /usr/src/pgsql/src/test/regress
<ProgramListing> gmake all
cd /usr/src/pgsql/src/test/regress </ProgramListing>
gmake all </Para>
</ProgramListing> </Step>
</Para>
</Step> <Step Performance="optional">
<Para>
<Step Performance="optional"> If you have prevously invoked the regression test, clean up the
<Para> working directory with:
If you have prevously invoked the regression test, clean up the
working directory with: <ProgramListing>
cd /usr/src/pgsql/src/test/regress
<ProgramListing> make clean
cd /usr/src/pgsql/src/test/regress </ProgramListing>
make clean </para>
</ProgramListing> </step>
<Step Performance="required">
<Step Performance="required"> <Para>
<Para> The file /usr/src/pgsql/src/test/regress/README has detailed
The file /usr/src/pgsql/src/test/regress/README has detailed instructions for running and interpreting the regression tests.
instructions for running and interpreting the regression tests. A short version follows here:
A short version follows here: </Para>
</Para>
<Para>
<Para> If the postmaster is not already running, start the postmaster on an
If the postmaster is not already running, start the postmaster on an available window by typing
available window by typing <ProgramListing>
<ProgramListing> postmaster
postmaster </ProgramListing>
</ProgramListing>
or start the postmaster daemon running in the background by typing
or start the postmaster daemon running in the background by typing <ProgramListing>
<ProgramListing> cd
cd nohup postmaster > regress.log 2>&1 &
nohup postmaster > regress.log 2>&1 & </ProgramListing>
</ProgramListing> </Para>
</Para>
<Para>
<Para> Run postmaster from your <ProductName>Postgres</ProductName> super user account (typically
Run postmaster from your <ProductName>Postgres</ProductName> super user account (typically account postgres).
account postgres).
<Note>
<Note> <Para>
<Para> Do not run <FileName>postmaster</FileName> from the root account.
Do not run <FileName>postmaster</FileName> from the root account. </Para>
</Para> </Note>
</Note> </Para>
</Para> </Step>
</Step>
<Step Performance="required">
<Step Performance="required"> <Para>
<Para> Run the regression tests. Type
Run the regression tests. Type
<ProgramListing>
<ProgramListing> cd /usr/src/pgsql/src/test/regress
cd /usr/src/pgsql/src/test/regress gmake runtest
gmake runtest </ProgramListing>
</ProgramListing> </Para>
</Para>
<Para>
<Para>
You do not need to type "gmake clean" if this is the first time you
You do not need to type "gmake clean" if this is the first time you are running the tests.
are running the tests. </Para>
</Para> </Step>
</Step>
<Step Performance="required">
<Step Performance="required"> <Para>
<Para>
You should get on the screen (and also written to file ./regress.out)
You should get on the screen (and also written to file ./regress.out) a series of statements stating which tests passed and which tests
a series of statements stating which tests passed and which tests failed. Please note that it can be normal for some of the tests to
failed. Please note that it can be normal for some of the tests to "fail". For the failed tests, use diff to compare the files in
"fail". For the failed tests, use diff to compare the files in directories ./results and ./expected. If float8 failed, type
directories ./results and ./expected. If float8 failed, type something like:
something like: <ProgramListing>
<ProgramListing> cd /usr/src/pgsql/src/test/regress
cd /usr/src/pgsql/src/test/regress diff -w expected/float8.out results
diff -w expected/float8.out results </ProgramListing>
</ProgramListing> </Para>
</Para> </Step>
</Step>
<Step Performance="required">
<Step Performance="required"> <Para>
<Para> After running the tests, type
After running the tests, type <ProgramListing>
<ProgramListing> destroydb regression
destroydb regression cd /usr/src/pgsql/src/test/regress
cd /usr/src/pgsql/src/test/regress gmake clean
gmake clean </ProgramListing>
</ProgramListing> </Para>
</Para> </Step>
</Step> </procedure>
</Sect1>
</Procedure>
<Sect1>
</Sect1> <Title>Regression Analysis</Title>
<Sect1> <Para>
<Title>Regression Analysis</Title> <Quote>Failed</Quote> tests may have failed due to slightly different error messages,
math libraries, or output formatting.
<Para> "Failures" of this type do not indicate a problem with
<Quote>Failed</Quote> tests may have failed due to slightly different error messages, <ProductName>Postgres</ProductName>.
math libraries, or output formatting. </Para>
"Failures" of this type do not indicate a problem with
<ProductName>Postgres</ProductName>. <Para>
</Para> For a i686/Linux-ELF platform, no tests failed since this is the
v6.2.1 regression testing reference platform.
<Para> </Para>
For a i686/Linux-ELF platform, no tests failed since this is the
v6.2.1 regression testing reference platform. <Para>
</Para> For the SPARC/Linux-ELF platform, using the 970525 beta version of
<ProductName>Postgres</ProductName> v6.2 the following tests "failed":
<Para> float8 and geometry "failed" due to minor precision differences in
For the SPARC/Linux-ELF platform, using the 970525 beta version of floating point numbers. select_views produces massively different output,
<ProductName>Postgres</ProductName> v6.2 the following tests "failed": but the differences are due to minor floating point differences.
float8 and geometry "failed" due to minor precision differences in </Para>
floating point numbers. select_views produces massively different output,
but the differences are due to minor floating point differences. <Para>
</Para> Conclusion? If you do see failures, try to understand the nature of
the differences and then decide if those differences will affect your
<Para> intended use of <ProductName>Postgres</ProductName>. However, keep in mind that this is likely
Conclusion? If you do see failures, try to understand the nature of to be the most solid release of <ProductName>Postgres</ProductName> to date, incorporating many
the differences and then decide if those differences will affect your bug fixes from v6.1, and that previous versions of <ProductName>Postgres</ProductName> have been
intended use of <ProductName>Postgres</ProductName>. However, keep in mind that this is likely in use successfully for some time now.
to be the most solid release of <ProductName>Postgres</ProductName> to date, incorporating many </Para>
bug fixes from v6.1, and that previous versions of <ProductName>Postgres</ProductName> have been
in use successfully for some time now. <Sect2>
</Para> <Title>Comparing expected/actual output</Title>
<Sect2> <Para>
<Title>Comparing expected/actual output</Title> The results are in files in the ./results directory. These results
can be compared with results in the ./expected directory using 'diff'.
<Para> The files might not compare exactly. The following paragraphs attempt
The results are in files in the ./results directory. These results to explain the differences.
can be compared with results in the ./expected directory using 'diff'. </Para>
The files might not compare exactly. The following paragraphs attempt
to explain the differences. </Sect2>
</Para>
<Sect2>
</Sect2> <Title>Error message differences</Title>
<Sect2> <Para>
<Title>Error message differences</Title> Some of the regression tests involve intentional invalid input values.
Error messages can come from either the Postgres code or from the host
<Para> platform system routines. In the latter case, the messages may vary
Some of the regression tests involve intentional invalid input values. between platforms, but should reflect similar information. These
Error messages can come from either the Postgres code or from the host differences in messages will result in a "failed" regression test which
platform system routines. In the latter case, the messages may vary can be validated by inspection.
between platforms, but should reflect similar information. These </Para>
differences in messages will result in a "failed" regression test which
can be validated by inspection. </Sect2>
</Para>
<Sect2>
</Sect2> <Title>OID differences</Title>
<Sect2> <Para>
<Title>OID differences</Title> There are several places where PostgreSQL OID (object identifiers) appear
in 'regress.out'. OID's are unique 32-bit integers which are generated
<Para> by the PostgreSQL backend whenever a table row is inserted or updated.
There are several places where PostgreSQL OID (object identifiers) appear If you run the regression test on a non-virgin database or run it multiple
in 'regress.out'. OID's are unique 32-bit integers which are generated times, the OID's reported will have different values.
by the PostgreSQL backend whenever a table row is inserted or updated.
If you run the regression test on a non-virgin database or run it multiple The following SQL statements in 'misc.out' have shown this behavior:
times, the OID's reported will have different values.
QUERY: SELECT user_relns() AS user_relns ORDER BY user_relns;
The following SQL statements in 'misc.out' have shown this behavior:
The 'a,523676' row is composed from an OID.
QUERY: SELECT user_relns() AS user_relns ORDER BY user_relns; </Para>
The 'a,523676' row is composed from an OID. </Sect2>
</Para>
<Sect2>
</Sect2> <Title>Date and time differences</Title>
<Sect2> <Para>
<Title>Date and time differences</Title> On many supported platforms, you can force PostgreSQL to believe that it
is running in the same time zone as Berkeley, California. See details in
<Para> the section on how to run the regression tests.
On many supported platforms, you can force PostgreSQL to believe that it
is running in the same time zone as Berkeley, California. See details in If you do not explicitly set your time zone environment to PST8PDT, then
the section on how to run the regression tests. most of the date and time results will reflect your local time zone and
will fail the regression testing.
If you do not explicitly set your time zone environment to PST8PDT, then
most of the date and time results will reflect your local time zone and There appears to be some systems which do not accept the recommended syntax
will fail the regression testing. for explicitly setting the local time zone rules. Some systems using the
public domain time zone package exhibit minor problems with pre-1970 PDT
There appears to be some systems which do not accept the recommended syntax times, representing them in PST instead.
for explicitly setting the local time zone rules. Some systems using the </Para>
public domain time zone package exhibit minor problems with pre-1970 PDT
times, representing them in PST instead. </Sect2>
</Para>
<Sect2>
</Sect2> <Title>Floating point differences</Title>
<Sect2> <Para>
<Title>Floating point differences</Title> Some of the tests involve computing 64-bit (<Type>float8</Type>) number from table
columns. Differences in results involving mathematical functions of
<Para> <Type>float8</Type> columns have been observed. These differences occur where
Some of the tests involve computing 64-bit (<Type>float8</Type>) number from table different operating systems are used on the same platform ie:
columns. Differences in results involving mathematical functions of BSDI and SOLARIS on Intel/86, and where the same operating system is
<Type>float8</Type> columns have been observed. These differences occur where used used on different platforms, ie: SOLARIS on SPARC and Intel/86.
different operating systems are used on the same platform ie:
BSDI and SOLARIS on Intel/86, and where the same operating system is Human eyeball comparison is needed to determine the real significance
used used on different platforms, ie: SOLARIS on SPARC and Intel/86. of these differences which are usually 10 places to the right of
the decimal point.
Human eyeball comparison is needed to determine the real significance
of these differences which are usually 10 places to the right of Some systems signal errors from pow() and exp() differently from
the decimal point. the mechanism expected by the current Postgres code.
</Para>
Some systems signal errors from pow() and exp() differently from
the mechanism expected by the current Postgres code. </Sect2>
</Para>
<Sect2>
</Sect2> <Title>Polygon differences</Title>
<Sect2> <Para>
<Title>Polygon differences</Title> Several of the tests involve operations on geographic date about the
Oakland/Berkley CA street map. The map data is expressed as polygons
<Para> whose vertices are represented as pairs of <Type>float8</Type> numbers (decimal
Several of the tests involve operations on geographic date about the latitude and longitude). Initially, some tables are created and
Oakland/Berkley CA street map. The map data is expressed as polygons loaded with geographic data, then some views are created which join
whose vertices are represented as pairs of <Type>float8</Type> numbers (decimal two tables using the polygon intersection operator (##), then a select
latitude and longitude). Initially, some tables are created and is done on the view.
loaded with geographic data, then some views are created which join
two tables using the polygon intersection operator (##), then a select When comparing the results from different platforms, differences occur
is done on the view. in the 2nd or 3rd place to the right of the decimal point. The SQL
statements where these problems occur are the folowing:
When comparing the results from different platforms, differences occur
in the 2nd or 3rd place to the right of the decimal point. The SQL <ProgramListing>
statements where these problems occur are the folowing: QUERY: SELECT * from street;
QUERY: SELECT * from iexit;
<ProgramListing> </ProgramListing>
QUERY: SELECT * from street; </Para>
QUERY: SELECT * from iexit;
</ProgramListing> </Sect2>
</Para>
<Sect2>
</Sect2> <Title>Random differences</Title>
<Sect2> <Para>
<Title>Random differences</Title> There is at least one test case in random.out which is intended to produce
random results. This causes random to fail the regression testing.
<Para> Typing
There is at least one test case in random.out which is intended to produce <ProgramListing>
random results. This causes random to fail the regression testing. diff results/random.out expected/random.out
Typing </ProgramListing>
<ProgramListing>
diff results/random.out expected/random.out should produce only
</ProgramListing> one or a few lines of differences for this reason, but other floating
point differences on dissimilar architectures might cause many more
should produce only differences. See the release notes below.
one or a few lines of differences for this reason, but other floating </Para>
point differences on dissimilar architectures might cause many more
differences. See the release notes below. </Sect2>
</Para>
<Sect2>
</Sect2> <Title>The <Quote>expected</Quote> files</Title>
<Sect2> <Para>
<Title>The <Quote>expected</Quote> files</Title> The <FileName>./expected/*.out</FileName> files were adapted from the original monolithic
<FileName>expected.input</FileName> file provided by Jolly Chen et al. Newer versions of these
<Para> files generated on various development machines have been substituted after
The <FileName>./expected/*.out</FileName> files were adapted from the original monolithic careful (?) inspection. Many of the development machines are running a
<FileName>expected.input</FileName> file provided by Jolly Chen et al. Newer versions of these Unix OS variant (FreeBSD, Linux, etc) on Ix86 hardware.
files generated on various development machines have been substituted after
careful (?) inspection. Many of the development machines are running a The original <FileName>expected.input</FileName> file was created on a SPARC Solaris 2.4
Unix OS variant (FreeBSD, Linux, etc) on Ix86 hardware. system using the <FileName>postgres5-1.02a5.tar.gz</FileName> source tree. It was compared
with a file created on an I386 Solaris 2.4 system and the differences
The original <FileName>expected.input</FileName> file was created on a SPARC Solaris 2.4 were only in the floating point polygons in the 3rd digit to the right
system using the <FileName>postgres5-1.02a5.tar.gz</FileName> source tree. It was compared of the decimal point. (see below)
with a file created on an I386 Solaris 2.4 system and the differences
were only in the floating point polygons in the 3rd digit to the right The original <FileName>sample.regress.out</FileName> file was from the postgres-1.01 release
of the decimal point. (see below) constructed by Jolly Chen and is included here for reference. It may
have been created on a DEC ALPHA machine as the <FileName>Makefile.global</FileName>
The original <FileName>sample.regress.out</FileName> file was from the postgres-1.01 release in the postgres-1.01 release has PORTNAME=alpha.
constructed by Jolly Chen and is included here for reference. It may </Para>
have been created on a DEC ALPHA machine as the <FileName>Makefile.global</FileName>
in the postgres-1.01 release has PORTNAME=alpha. </Sect2>
</Para>
</Sect1>
</Sect2>
</Sect1>
</Chapter> </Chapter>
doc/src/sgml/release.sgml
View file @ a75f2d21
...@@ -20,7 +20,7 @@ ...@@ -20,7 +20,7 @@
<para> <para>
This is a bugfix release for 6.3.x. This is a bugfix release for 6.3.x.
Refer to the release notes for v6.3 for a more complete summary of new features. Refer to the release notes for v6.3 for a more complete summary of new features.
</para>
<para> <para>
Summary: Summary:
...@@ -29,22 +29,27 @@ Summary: ...@@ -29,22 +29,27 @@ Summary:
<para> <para>
Repairs automatic configuration support for some platforms, including Linux, Repairs automatic configuration support for some platforms, including Linux,
from breakage inadvertently introduced in v6.3.1. from breakage inadvertently introduced in v6.3.1.
</para>
</listitem>
<listitem> <listitem>
<para> <para>
Correctly handles function calls on the left side of BETWEEN and LIKE clauses. Correctly handles function calls on the left side of BETWEEN and LIKE clauses.
</para>
</listitem>
</itemizedlist> </itemizedlist>
</para>
<Para> <Para>
A dump/restore is NOT required for those running 6.3 or 6.3.1. A A dump/restore is NOT required for those running 6.3 or 6.3.1. A
'make distclean', 'make', and 'make install' is all that is required. 'make distclean', 'make', and 'make install' is all that is required.
This last step should be performed while the postmaster is not running. This last step should be performed while the postmaster is not running.
You should re-link any custom applications that use <productname>Postgres</productname> libraries. You should re-link any custom applications that use <productname>Postgres</productname> libraries.
</para>
<para> <para>
For upgrades from pre-v6.3 installations, For upgrades from pre-v6.3 installations,
refer to the installation and migration instructions for v6.3. refer to the installation and migration instructions for v6.3.
</para>
<sect2> <sect2>
<title>Detailed Change List</title> <title>Detailed Change List</title>
...@@ -72,8 +77,9 @@ Remove DISTDIR(Bruce) ...@@ -72,8 +77,9 @@ Remove DISTDIR(Bruce)
Makefile dependency cleanup(Jeroen van Vianen) Makefile dependency cleanup(Jeroen van Vianen)
ASSERT fixes(Bruce) ASSERT fixes(Bruce)
</programlisting> </programlisting>
</para>
</sect2>
</sect1>
<Sect1> <Sect1>
<Title>Release 6.3.1</Title> <Title>Release 6.3.1</Title>
<!-- <!--
...@@ -97,33 +103,39 @@ Summary: ...@@ -97,33 +103,39 @@ Summary:
<listitem> <listitem>
<para> <para>
Additional support for multi-byte character sets. Additional support for multi-byte character sets.
</para>
</listitem>
<listitem> <listitem>
<para> <para>
Repair byte ordering for mixed-endian clients and servers. Repair byte ordering for mixed-endian clients and servers.
</para>
</listitem>
<listitem> <listitem>
<para> <para>
Minor updates to allowed SQL syntax. Minor updates to allowed SQL syntax.
</para>
</listitem>
<listitem> <listitem>
<para> <para>
Improvements to the configuration autodetection for installation. Improvements to the configuration autodetection for installation.
</para>
<listitem> </listitem>
<para>
</itemizedlist> </itemizedlist>
</para>
<Para> <Para>
A dump/restore is NOT required for those running 6.3. A A dump/restore is NOT required for those running 6.3. A
'make distclean', 'make', and 'make install' is all that is required. 'make distclean', 'make', and 'make install' is all that is required.
This last step should be performed while the postmaster is not running. This last step should be performed while the postmaster is not running.
You should re-link any custom applications that use <productname>Postgres</productname> libraries. You should re-link any custom applications that use <productname>Postgres</productname> libraries.
</para>
<para> <para>
For upgrades from pre-v6.3 installations, For upgrades from pre-v6.3 installations,
refer to the installation and migration instructions for v6.3. refer to the installation and migration instructions for v6.3.
</para>
<sect2> <sect2>
<title>Detailed Change List</title> <title>Detailed Change List</title>
...@@ -160,8 +172,9 @@ Fix for text arrays containing quotes(Doug Gibson) ...@@ -160,8 +172,9 @@ Fix for text arrays containing quotes(Doug Gibson)
Solaris compile fix(Albert Chin-A-Young) Solaris compile fix(Albert Chin-A-Young)
Better identify tcl and tk libs and includes(Bruce) Better identify tcl and tk libs and includes(Bruce)
</programlisting> </programlisting>
</para>
</sect2>
</sect1>
<Sect1> <Sect1>
<Title>Release 6.3</Title> <Title>Release 6.3</Title>
<!-- <!--
...@@ -188,37 +201,49 @@ Here is a brief, incomplete summary: ...@@ -188,37 +201,49 @@ Here is a brief, incomplete summary:
Many new SQL features, including Many new SQL features, including
full <acronym>SQL92</acronym> subselect capability full <acronym>SQL92</acronym> subselect capability
(everything is here but target-list subselects). (everything is here but target-list subselects).
</para>
</listitem>
<listitem> <listitem>
<para> <para>
Support for client-side environment variables to specify time zone and date style. Support for client-side environment variables to specify time zone and date style.
</para>
</listitem>
<listitem> <listitem>
<para> <para>
Socket interface for client/server connection. This is the default now Socket interface for client/server connection. This is the default now
so you may need to start <application>postmaster</application> with the so you may need to start <application>postmaster</application> with the
<quote>-i</quote> flag. <quote>-i</quote> flag.
</para>
</listitem>
<listitem> <listitem>
<para> <para>
Better password authorization mechanisms. Default table permissions have changed. Better password authorization mechanisms. Default table permissions have changed.
</para>
</listitem>
<listitem> <listitem>
<para> <para>
Old-style <quote>time travel</quote> has been removed. Performance has been improved. Old-style <quote>time travel</quote> has been removed. Performance has been improved.
</para>
</listitem>
</itemizedlist> </itemizedlist>
</para>
<note> <note>
<para> <para>
Bruce Momjian wrote the following notes to introduce the new release. Bruce Momjian wrote the following notes to introduce the new release.
</para>
</note> </note>
<para> <para>
There are some general 6.3 issues that I want to mention. These are There are some general 6.3 issues that I want to mention. These are
only the big items that can not be described in one sentence. A review only the big items that can not be described in one sentence. A review
of the detailed changes list is still needed. of the detailed changes list is still needed.
</para>
<para> <para>
First, we now have subselects. Now that we have them, I would like to First, we now have subselects. Now that we have them, I would like to
mention that without subselects, SQL is a very limited language. mention that without subselects, SQL is a very limited language.
...@@ -228,13 +253,13 @@ think you will find that there are more uses for subselects than you may ...@@ -228,13 +253,13 @@ think you will find that there are more uses for subselects than you may
think. Vadim has put us on the big SQL map with subselects, and fully think. Vadim has put us on the big SQL map with subselects, and fully
functional ones too. The only thing you can't do with subselects is to functional ones too. The only thing you can't do with subselects is to
use them in the target list. use them in the target list.
</para>
<para> <para>
Second, 6.3 uses unix domain sockets rather than TCP/IP by default. To Second, 6.3 uses unix domain sockets rather than TCP/IP by default. To
enable connections from other machines, you have to use the new enable connections from other machines, you have to use the new
postmaster -i option, and of course edit pg_hba.conf. Also, for this postmaster -i option, and of course edit pg_hba.conf. Also, for this
reason, the format of pg_hba.conf has changed. reason, the format of pg_hba.conf has changed.
</para>
<para> <para>
Third, char() fields will now allow faster access than varchar() or Third, char() fields will now allow faster access than varchar() or
text. Specifically, the text and varchar() have a penalty for access to text. Specifically, the text and varchar() have a penalty for access to
...@@ -243,7 +268,7 @@ have this access penalty, but it no longer does. This may suggest that ...@@ -243,7 +268,7 @@ have this access penalty, but it no longer does. This may suggest that
you redesign some of your tables, especially if you have short character you redesign some of your tables, especially if you have short character
columns that you have defined as varchar() or text. This and other columns that you have defined as varchar() or text. This and other
changes make 6.3 even faster than earlier releases. changes make 6.3 even faster than earlier releases.
</para>
<para> <para>
We now have passwords definable independent of any Unix file. There are We now have passwords definable independent of any Unix file. There are
new SQL USER commands. See the pg_hba.conf manual page for more new SQL USER commands. See the pg_hba.conf manual page for more
...@@ -252,23 +277,23 @@ user information and user passwords, and it by default only SELECT-able ...@@ -252,23 +277,23 @@ user information and user passwords, and it by default only SELECT-able
by the postgres super-user. pg_user is now a view of pg_shadow, and is by the postgres super-user. pg_user is now a view of pg_shadow, and is
SELECT-able by PUBLIC. You should keep using pg_user in your SELECT-able by PUBLIC. You should keep using pg_user in your
application without changes. application without changes.
</para>
<para> <para>
User-created tables now no longer have SELECT permission to PUBLIC by User-created tables now no longer have SELECT permission to PUBLIC by
default. This was done because the ANSI standard requires it. You can default. This was done because the ANSI standard requires it. You can
of course GRANT any permissions you want after the table is created. of course GRANT any permissions you want after the table is created.
System tables continue to be SELECT-able by PUBLIC. System tables continue to be SELECT-able by PUBLIC.
</para>
<para> <para>
We also have real deadlock detection code. No more sixty-second We also have real deadlock detection code. No more sixty-second
timeouts. And the new locking code implements a FIFO better, so there timeouts. And the new locking code implements a FIFO better, so there
should be less resource starvation during heavy use. should be less resource starvation during heavy use.
</para>
<para> <para>
Many complaints have been made about inadequate documenation in previous Many complaints have been made about inadequate documenation in previous
releases. Thomas has put much effort into many new manuals for this releases. Thomas has put much effort into many new manuals for this
release. Check out the doc/ directory. release. Check out the doc/ directory.
</para>
<para> <para>
For performance reasons, time travel is gone, but can be implemented For performance reasons, time travel is gone, but can be implemented
using triggers (see pgsql/contrib/spi/README). Please check out the new using triggers (see pgsql/contrib/spi/README). Please check out the new
...@@ -276,13 +301,13 @@ using triggers (see pgsql/contrib/spi/README). Please check out the new ...@@ -276,13 +301,13 @@ using triggers (see pgsql/contrib/spi/README). Please check out the new
permissions now, not based on the underlying tables, so permissions on permissions now, not based on the underlying tables, so permissions on
them have to be set separately. Check /pgsql/interfaces for some new them have to be set separately. Check /pgsql/interfaces for some new
ways to talk to <productname>Postgres</productname>. ways to talk to <productname>Postgres</productname>.
</para>
<para> <para>
This is the first release that really required an explanation for This is the first release that really required an explanation for
existing users. In many ways, this was necessary because the new existing users. In many ways, this was necessary because the new
release removes many limitations, and the work-arounds people were using release removes many limitations, and the work-arounds people were using
are no longer needed. are no longer needed.
</para>
<sect2> <sect2>
<title>Migration to v6.3</title> <title>Migration to v6.3</title>
...@@ -292,7 +317,8 @@ A dump/restore using <application>pg_dump</application> ...@@ -292,7 +317,8 @@ A dump/restore using <application>pg_dump</application>
or <application>pg_dumpall</application> or <application>pg_dumpall</application>
is required for those wishing to migrate data from any is required for those wishing to migrate data from any
previous release of <productname>Postgres</productname>. previous release of <productname>Postgres</productname>.
</para>
</sect2>
<sect2> <sect2>
<title>Detailed Change List</title> <title>Detailed Change List</title>
...@@ -465,7 +491,7 @@ Expand a few function names formerly truncated to 16 characters(Thomas) ...@@ -465,7 +491,7 @@ Expand a few function names formerly truncated to 16 characters(Thomas)
Remove un-needed malloc() calls and replace with palloc()(Bruce) Remove un-needed malloc() calls and replace with palloc()(Bruce)
</programlisting> </programlisting>
</Para> </Para>
</sect2>
</Sect1> </Sect1>
<Sect1> <Sect1>
...@@ -486,7 +512,7 @@ Fri Oct 17 00:01:27 EDT 1997 ...@@ -486,7 +512,7 @@ Fri Oct 17 00:01:27 EDT 1997
<para> <para>
v6.2.1 is a bug-fix and usability release on v6.2. v6.2.1 is a bug-fix and usability release on v6.2.
</para>
<para> <para>
Summary: Summary:
...@@ -494,17 +520,22 @@ Summary: ...@@ -494,17 +520,22 @@ Summary:
<listitem> <listitem>
<para> <para>
Allow strings to span lines, per <acronym>SQL92</acronym>. Allow strings to span lines, per <acronym>SQL92</acronym>.
</para>
</listitem>
<listitem> <listitem>
<para> <para>
Include example trigger function for inserting user names on table updates. Include example trigger function for inserting user names on table updates.
</para>
</listitem>
</itemizedlist> </itemizedlist>
</para>
<para> <para>
This is a minor bug-fix release on v6.2. This is a minor bug-fix release on v6.2.
For upgrades from pre-v6.2 systems, a full dump/reload is required. For upgrades from pre-v6.2 systems, a full dump/reload is required.
Refer to the v6.2 release notes for instructions. Refer to the v6.2 release notes for instructions.
</para>
<sect2> <sect2>
<title>Migration from v6.2 to v6.2.1</title> <title>Migration from v6.2 to v6.2.1</title>
...@@ -512,12 +543,12 @@ Refer to the v6.2 release notes for instructions. ...@@ -512,12 +543,12 @@ Refer to the v6.2 release notes for instructions.
<para> <para>
This is a minor bug-fix release. A dump/reload is not required from v6.2, This is a minor bug-fix release. A dump/reload is not required from v6.2,
but is required from any release prior to v6.2. but is required from any release prior to v6.2.
</para>
<para> <para>
In upgrading from v6.2, if you choose to dump/reload you will find that In upgrading from v6.2, if you choose to dump/reload you will find that
avg(money) is now calculated correctly. All other bug fixes take effect avg(money) is now calculated correctly. All other bug fixes take effect
upon updating the executables. upon updating the executables.
</para>
<para> <para>
Another way to avoid dump/reload is to use the following SQL command Another way to avoid dump/reload is to use the following SQL command
from psql to update the existing system table: from psql to update the existing system table:
...@@ -526,10 +557,11 @@ from psql to update the existing system table: ...@@ -526,10 +557,11 @@ from psql to update the existing system table:
update pg_aggregate set aggfinalfn = 'cash_div_flt8' update pg_aggregate set aggfinalfn = 'cash_div_flt8'
where aggname = 'avg' and aggbasetype = 790; where aggname = 'avg' and aggbasetype = 790;
</programlisting> </programlisting>
</para>
<para> <para>
This will need to be done to every existing database, including template1. This will need to be done to every existing database, including template1.
</para>
</sect2>
<sect2> <sect2>
<title>Detailed Change List</title> <title>Detailed Change List</title>
...@@ -549,6 +581,8 @@ Fix for specifying a column twice in ORDER/GROUP BY(Vadim) ...@@ -549,6 +581,8 @@ Fix for specifying a column twice in ORDER/GROUP BY(Vadim)
Documented new libpq function to return affected rows, PQcmdTuples(Bruce) Documented new libpq function to return affected rows, PQcmdTuples(Bruce)
Trigger function for inserting user names for INSERT/UPDATE(Brook Milligan) Trigger function for inserting user names for INSERT/UPDATE(Brook Milligan)
</programlisting> </programlisting>
</para>
</sect2>
</Sect1> </Sect1>
<Sect1> <Sect1>
...@@ -570,6 +604,7 @@ Thu Oct 02 12:53:46 EDT 1997 ...@@ -570,6 +604,7 @@ Thu Oct 02 12:53:46 EDT 1997
<para> <para>
A dump/restore is required for those wishing to migrate data from A dump/restore is required for those wishing to migrate data from
previous releases of <productname>Postgres</productname>. previous releases of <productname>Postgres</productname>.
</para>
<sect2> <sect2>
<title>Migration from v6.1 to v6.2</title> <title>Migration from v6.1 to v6.2</title>
...@@ -577,10 +612,12 @@ previous releases of <productname>Postgres</productname>. ...@@ -577,10 +612,12 @@ previous releases of <productname>Postgres</productname>.
<para> <para>
This migration requires a complete dump of the 6.1 database and a This migration requires a complete dump of the 6.1 database and a
restore of the database in 6.2. restore of the database in 6.2.
</para>
<para> <para>
Note that the pg_dump and pg_dumpall utility from 6.2 should be used Note that the pg_dump and pg_dumpall utility from 6.2 should be used
to dump the 6.1 database. to dump the 6.1 database.
</para>
</sect2>
<sect2> <sect2>
<title>Migration from v1.x to v6.2</title> <title>Migration from v1.x to v6.2</title>
...@@ -588,6 +625,8 @@ to dump the 6.1 database. ...@@ -588,6 +625,8 @@ to dump the 6.1 database.
<para> <para>
Those migrating from earlier 1.* releases should first upgrade to 1.09 Those migrating from earlier 1.* releases should first upgrade to 1.09
because the COPY output format was improved from the 1.02 release. because the COPY output format was improved from the 1.02 release.
</para>
</sect2>
<sect2> <sect2>
<title>Detailed Change List</title> <title>Detailed Change List</title>
...@@ -703,7 +742,9 @@ Massive commit to run PGINDENT on all *.c and *.h files(Bruce) ...@@ -703,7 +742,9 @@ Massive commit to run PGINDENT on all *.c and *.h files(Bruce)
Files moved to /src/tools directory(Bruce) Files moved to /src/tools directory(Bruce)
SPI and Trigger programming guides (Vadim & D'Arcy) SPI and Trigger programming guides (Vadim & D'Arcy)
</programlisting> </programlisting>
</para>
</sect2>
</sect1>
<Sect1> <Sect1>
<Title>Release 6.1.1</Title> <Title>Release 6.1.1</Title>
...@@ -729,6 +770,8 @@ Mon Jul 22 18:04:49 EDT 1997 ...@@ -729,6 +770,8 @@ Mon Jul 22 18:04:49 EDT 1997
This is a minor bug-fix release. A dump/reload is not required from v6.1, This is a minor bug-fix release. A dump/reload is not required from v6.1,
but is required from any release prior to v6.1. but is required from any release prior to v6.1.
Refer to the release notes for v6.1 for more details. Refer to the release notes for v6.1 for more details.
</para>
</sect2>
<sect2> <sect2>
<title>Detailed Change List</title> <title>Detailed Change List</title>
...@@ -755,8 +798,9 @@ Fix for Solaris assembler and include files(Yoshihiko Ichikawa) ...@@ -755,8 +798,9 @@ Fix for Solaris assembler and include files(Yoshihiko Ichikawa)
allow underscores in usernames(Bruce) allow underscores in usernames(Bruce)
pg_dumpall now returns proper status, portability fix(Bruce) pg_dumpall now returns proper status, portability fix(Bruce)
</programlisting> </programlisting>
</para>
</sect2>
</sect1>
<Sect1> <Sect1>
<Title>Release 6.1</Title> <Title>Release 6.1</Title>
...@@ -825,10 +869,12 @@ Sun Jun 8 14:41:13 EDT 1997 ...@@ -825,10 +869,12 @@ Sun Jun 8 14:41:13 EDT 1997
<para> <para>
This migration requires a complete dump of the 6.0 database and a This migration requires a complete dump of the 6.0 database and a
restore of the database in 6.1. restore of the database in 6.1.
</para>
<para> <para>
Those migrating from earlier 1.* releases should first upgrade to 1.09 Those migrating from earlier 1.* releases should first upgrade to 1.09
because the COPY output format was improved from the 1.02 release. because the COPY output format was improved from the 1.02 release.
</para>
</sect2>
<sect2> <sect2>
<title>Detailed Change List</title> <title>Detailed Change List</title>
...@@ -930,7 +976,9 @@ c++ include file cleanup(Bruce) ...@@ -930,7 +976,9 @@ c++ include file cleanup(Bruce)
warn about buggy flex(Bruce) warn about buggy flex(Bruce)
DG-UX, Ultrix, Irix, AIX portability fixes DG-UX, Ultrix, Irix, AIX portability fixes
</programlisting> </programlisting>
</para>
</sect2>
</sect1>
<sect1> <sect1>
<title>Release v6.0</title> <title>Release v6.0</title>
...@@ -951,6 +999,7 @@ Wed Jan 29 00:19:54 EST 1997 ...@@ -951,6 +999,7 @@ Wed Jan 29 00:19:54 EST 1997
<para> <para>
A dump/restore is required for those wishing to migrate data from A dump/restore is required for those wishing to migrate data from
previous releases of <productname>Postgres</productname>. previous releases of <productname>Postgres</productname>.
</para>
<sect2> <sect2>
<title>Migration from v1.09 to v6.0</title> <title>Migration from v1.09 to v6.0</title>
...@@ -958,6 +1007,8 @@ previous releases of <productname>Postgres</productname>. ...@@ -958,6 +1007,8 @@ previous releases of <productname>Postgres</productname>.
<para> <para>
This migration requires a complete dump of the 1.09 database and a This migration requires a complete dump of the 1.09 database and a
restore of the database in 6.0. restore of the database in 6.0.
</para>
</sect2>
<sect2> <sect2>
<title>Migration from pre-v1.09 to v6.0</title> <title>Migration from pre-v1.09 to v6.0</title>
...@@ -965,6 +1016,8 @@ restore of the database in 6.0. ...@@ -965,6 +1016,8 @@ restore of the database in 6.0.
<para> <para>
Those migrating from earlier 1.* releases should first upgrade to 1.09 Those migrating from earlier 1.* releases should first upgrade to 1.09
because the COPY output format was improved from the 1.02 release. because the COPY output format was improved from the 1.02 release.
</para>
</sect2>
<sect2> <sect2>
<title>Detailed Change List</title> <title>Detailed Change List</title>
...@@ -1075,7 +1128,9 @@ Restructured object file generation/location(Bryan, Marc) ...@@ -1075,7 +1128,9 @@ Restructured object file generation/location(Bryan, Marc)
Restructured port-specific file locations(Bryan, Marc) Restructured port-specific file locations(Bryan, Marc)
Unused/uninialized variables corrected Unused/uninialized variables corrected
</programlisting> </programlisting>
</para>
</sect2>
</sect1>
<sect1> <sect1>
<title>Release v1.09</title> <title>Release v1.09</title>
...@@ -1097,7 +1152,8 @@ Unknown ...@@ -1097,7 +1152,8 @@ Unknown
Sorry, we stopped keeping track of changes from 1.02 to 1.09. Some of Sorry, we stopped keeping track of changes from 1.02 to 1.09. Some of
the changes listed in 6.0 were actually included in the 1.02.1 to 1.09 the changes listed in 6.0 were actually included in the 1.02.1 to 1.09
releases. releases.
</para>
</sect1>
<sect1> <sect1>
<title>Release v1.02</title> <title>Release v1.02</title>
...@@ -1121,26 +1177,28 @@ Thu Aug 1 18:00:00 EDT 1996 ...@@ -1121,26 +1177,28 @@ Thu Aug 1 18:00:00 EDT 1996
<para> <para>
Here is a new migration file for 1.02.1. It includes the 'copy' change Here is a new migration file for 1.02.1. It includes the 'copy' change
and a script to convert old ascii files. and a script to convert old ascii files.
</para>
<note> <note>
<para> <para>
The following notes are for the benefit of users who want to migrate The following notes are for the benefit of users who want to migrate
databases from postgres95 1.01 and 1.02 to postgres95 1.02.1. databases from postgres95 1.01 and 1.02 to postgres95 1.02.1.
</para>
<para> <para>
If you are starting afresh with postgres95 1.02.1 and do not need If you are starting afresh with postgres95 1.02.1 and do not need
to migrate old databases, you do not need to read any further. to migrate old databases, you do not need to read any further.
</para>
</note> </note>
<para> <para>
In order to upgrade older postgres95 version 1.01 or 1.02 databases to In order to upgrade older postgres95 version 1.01 or 1.02 databases to
version 1.02.1, the following steps are required: version 1.02.1, the following steps are required:
</para>
<procedure> <procedure>
<step> <step>
<para> <para>
Start up a new 1.02.1 postmaster Start up a new 1.02.1 postmaster
</para>
</step>
<step> <step>
<para> <para>
Add the new built-in functions and operators of 1.02.1 to 1.01 or 1.02 Add the new built-in functions and operators of 1.02.1 to 1.01 or 1.02
...@@ -1156,7 +1214,10 @@ Add the new built-in functions and operators of 1.02.1 to 1.01 or 1.02 ...@@ -1156,7 +1214,10 @@ Add the new built-in functions and operators of 1.02.1 to 1.01 or 1.02
Those upgrading 1.02 databases will get a warning when executing the Those upgrading 1.02 databases will get a warning when executing the
last two statements in the file because they are already present in 1.02. This is last two statements in the file because they are already present in 1.02. This is
not a cause for concern. not a cause for concern.
</para>
</step>
</procedure> </procedure>
</sect2>
<sect2> <sect2>
<title>Dump/Reload Procedure</title> <title>Dump/Reload Procedure</title>
...@@ -1172,7 +1233,7 @@ than NULL. See the copy manual page for full details. ...@@ -1172,7 +1233,7 @@ than NULL. See the copy manual page for full details.
<programlisting> <programlisting>
sed 's/^\.$/\\./g' &lt;in_file &gt;out_file sed 's/^\.$/\\./g' &lt;in_file &gt;out_file
</programlisting> </programlisting>
</para>
<para> <para>
If you are loading an older binary copy or non-stdout copy, there is no If you are loading an older binary copy or non-stdout copy, there is no
end-of-data character, and hence no conversion necessary. end-of-data character, and hence no conversion necessary.
...@@ -1185,7 +1246,8 @@ create operator !~* (leftarg = bpchar, rightarg = text, procedure = texticregexn ...@@ -1185,7 +1246,8 @@ create operator !~* (leftarg = bpchar, rightarg = text, procedure = texticregexn
create operator ~* (leftarg = varchar, rightarg = text, procedure = texticregexeq); create operator ~* (leftarg = varchar, rightarg = text, procedure = texticregexeq);
create operator !~* (leftarg = varchar, rightarg = text, procedure = texticregexne); create operator !~* (leftarg = varchar, rightarg = text, procedure = texticregexne);
</programlisting> </programlisting>
</para>
</sect2>
<sect2> <sect2>
<title>Detailed Change List</title> <title>Detailed Change List</title>
...@@ -1218,7 +1280,7 @@ New Ports ...@@ -1218,7 +1280,7 @@ New Ports
* added BSDI 2.1 port * added BSDI 2.1 port
* added DGUX port * added DGUX port
</programlisting> </programlisting>
</para>
<!-- <!--
Contributors (appologies to any missed) Contributors (appologies to any missed)
* Kurt J. Lidl <lidl@va.pubnix.com> * Kurt J. Lidl <lidl@va.pubnix.com>
...@@ -1247,6 +1309,8 @@ Contributors (appologies to any missed) ...@@ -1247,6 +1309,8 @@ Contributors (appologies to any missed)
* Paul "Shag" Walmsley <ccshag@cclabs.missouri.edu> * Paul "Shag" Walmsley <ccshag@cclabs.missouri.edu>
* "Alistair G. Crooks" <azcb0@sde.uts.amdahl.com> * "Alistair G. Crooks" <azcb0@sde.uts.amdahl.com>
--> -->
</sect2>
</sect1>
<sect1> <sect1>
<title>Release v1.01</title> <title>Release v1.01</title>
...@@ -1270,32 +1334,34 @@ Fri Feb 23 18:20:36 PST 1996 ...@@ -1270,32 +1334,34 @@ Fri Feb 23 18:20:36 PST 1996
<para> <para>
The following notes are for the benefit of users who want to migrate The following notes are for the benefit of users who want to migrate
databases from postgres95 1.0 to postgres95 1.01. databases from postgres95 1.0 to postgres95 1.01.
</para>
<para> <para>
If you are starting afresh with postgres95 1.01 and do not need If you are starting afresh with postgres95 1.01 and do not need
to migrate old databases, you do not need to read any further. to migrate old databases, you do not need to read any further.
</para>
<para> <para>
In order to postgres95 version 1.01 with databases created with In order to postgres95 version 1.01 with databases created with
postgres95 version 1.0, the following steps are required: postgres95 version 1.0, the following steps are required:
</para>
<procedure> <procedure>
<step> <step>
<para> <para>
Set the definition of NAMEDATALEN in src/Makefile.global to 16 Set the definition of NAMEDATALEN in src/Makefile.global to 16
and OIDNAMELEN to 20. and OIDNAMELEN to 20.
</para>
</step>
<step> <step>
<para> <para>
Decide whether you want to use Host based authentication. Decide whether you want to use Host based authentication.
</para>
<substeps> <substeps>
<step> <step>
<para> <para>
If you do, you must create a file name "pg_hba" in your top-level data If you do, you must create a file name "pg_hba" in your top-level data
directory (typically the value of your $PGDATA). src/libpq/pg_hba directory (typically the value of your $PGDATA). src/libpq/pg_hba
shows an example syntax. shows an example syntax.
</para>
</step>
<step> <step>
<para> <para>
If you do not want host-based authentication, you can comment out If you do not want host-based authentication, you can comment out
...@@ -1304,35 +1370,43 @@ If you do not want host-based authentication, you can comment out ...@@ -1304,35 +1370,43 @@ If you do not want host-based authentication, you can comment out
HBA = 1 HBA = 1
</programlisting> </programlisting>
in src/Makefile.global in src/Makefile.global
</para>
<para> <para>
Note that host-based authentication is turned on by default, and if Note that host-based authentication is turned on by default, and if
you do not take steps A or B above, the out-of-the-box 1.01 will you do not take steps A or B above, the out-of-the-box 1.01 will
not allow you to connect to 1.0 databases. not allow you to connect to 1.0 databases.
</para>
</step>
</substeps> </substeps>
</step>
<step> <step>
<para> <para>
Compile and install 1.01, but DO NOT do the initdb step. Compile and install 1.01, but DO NOT do the initdb step.
</para>
</step>
<step> <step>
<para> <para>
Before doing anything else, terminate your 1.0 postmaster, and Before doing anything else, terminate your 1.0 postmaster, and
backup your existing $PGDATA directory. backup your existing $PGDATA directory.
</para>
</step>
<step> <step>
<para> <para>
Set your PGDATA environment variable to your 1.0 databases, but set up Set your PGDATA environment variable to your 1.0 databases, but set up
path up so that 1.01 binaries are being used. path up so that 1.01 binaries are being used.
</para>
</step>
<step> <step>
<para> <para>
Modify the file $PGDATA/PG_VERSION from 5.0 to 5.1 Modify the file $PGDATA/PG_VERSION from 5.0 to 5.1
</para>
</step>
<step> <step>
<para> <para>
Start up a new 1.01 postmaster Start up a new 1.01 postmaster
</para>
</step>
<step> <step>
<para> <para>
Add the new built-in functions and operators of 1.01 to 1.0 Add the new built-in functions and operators of 1.01 to 1.0
...@@ -1390,8 +1464,10 @@ create operator !~* (leftarg = char16, rightarg = text, procedure = char16icrege ...@@ -1390,8 +1464,10 @@ create operator !~* (leftarg = char16, rightarg = text, procedure = char16icrege
create operator ~* (leftarg = text, rightarg = text, procedure = texticregexeq); create operator ~* (leftarg = text, rightarg = text, procedure = texticregexeq);
create operator !~* (leftarg = text, rightarg = text, procedure = texticregexne); create operator !~* (leftarg = text, rightarg = text, procedure = texticregexne);
</programlisting> </programlisting>
</para>
</step>
</procedure> </procedure>
</sect2>
<sect2> <sect2>
<title>Detailed Change List</title> <title>Detailed Change List</title>
...@@ -1431,6 +1507,9 @@ Bug fixes: ...@@ -1431,6 +1507,9 @@ Bug fixes:
* psql now returns non-zero status on errors when using -c * psql now returns non-zero status on errors when using -c
* applied public patches 1-14 * applied public patches 1-14
</programlisting> </programlisting>
</para>
</sect2>
</sect1>
<sect1> <sect1>
<title>Release v1.0</title> <title>Release v1.0</title>
...@@ -1493,6 +1572,9 @@ Bug fixes: ...@@ -1493,6 +1572,9 @@ Bug fixes:
* btrees with multiple index never worked, now we tell you they don't * btrees with multiple index never worked, now we tell you they don't
work when you try to use them work when you try to use them
</programlisting> </programlisting>
</para>
</sect2>
</sect1>
<sect1> <sect1>
<title><productname>Postgres95</productname> Beta 0.03</title> <title><productname>Postgres95</productname> Beta 0.03</title>
...@@ -1621,7 +1703,9 @@ New utilities: ...@@ -1621,7 +1703,9 @@ New utilities:
New documentation: New documentation:
* the user manual has been revised and libpq documentation added. * the user manual has been revised and libpq documentation added.
</programlisting> </programlisting>
</para>
</sect2>
</sect1>
<sect1> <sect1>
<title><productname>Postgres95</productname> Beta 0.02</title> <title><productname>Postgres95</productname> Beta 0.02</title>
...@@ -1678,7 +1762,9 @@ The following bugs have been fixed in postgres95-beta-0.02: ...@@ -1678,7 +1762,9 @@ The following bugs have been fixed in postgres95-beta-0.02:
* CREATE TYPE doesn't accept 'variable' as the internallength * CREATE TYPE doesn't accept 'variable' as the internallength
* wrong result using more than 1 aggregate in a SELECT * wrong result using more than 1 aggregate in a SELECT
</programlisting> </programlisting>
</para>
</sect2>
</sect1>
<sect1> <sect1>
<title><productname>Postgres95</productname> Beta 0.01</title> <title><productname>Postgres95</productname> Beta 0.01</title>
...@@ -1698,7 +1784,8 @@ Mon May 1 19:03:10 PDT 1995 ...@@ -1698,7 +1784,8 @@ Mon May 1 19:03:10 PDT 1995
<para> <para>
Initial release. Initial release.
</para>
</sect1>
<Sect1> <Sect1>
<Title>Timing Results</Title> <Title>Timing Results</Title>
...@@ -1711,11 +1798,11 @@ These timing results are from running the regression test with the commands ...@@ -1711,11 +1798,11 @@ These timing results are from running the regression test with the commands
% make all % make all
% time make runtest % time make runtest
</ProgramListing> </ProgramListing>
</para>
<Para> <Para>
Timing under Linux 2.0.27 seems to have a roughly 5% variation from run Timing under Linux 2.0.27 seems to have a roughly 5% variation from run
to run, presumably due to the scheduling vagaries of multitasking systems. to run, presumably due to the scheduling vagaries of multitasking systems.
</para>
<Sect2> <Sect2>
<Title>v6.4beta</Title> <Title>v6.4beta</Title>
...@@ -1723,12 +1810,14 @@ These timing results are from running the regression test with the commands ...@@ -1723,12 +1810,14 @@ These timing results are from running the regression test with the commands
The times for this release are not directly comparable to those for previous releases The times for this release are not directly comparable to those for previous releases
since some additional regression tests have been included. since some additional regression tests have been included.
In general, however, v6.4 should be slightly faster than the previous release (thanks, Bruce!). In general, however, v6.4 should be slightly faster than the previous release (thanks, Bruce!).
</para>
<Para> <Para>
<ProgramListing> <ProgramListing>
Time System Time System
02:26 Dual Pentium Pro 180, 96MB, UW-SCSI, Linux 2.0.30, gcc 2.7.2.1 -O2 -m486 02:26 Dual Pentium Pro 180, 96MB, UW-SCSI, Linux 2.0.30, gcc 2.7.2.1 -O2 -m486
</ProgramListing> </ProgramListing>
</para>
</sect2>
<Sect2> <Sect2>
<Title>v6.3</Title> <Title>v6.3</Title>
...@@ -1738,13 +1827,15 @@ The times for this release are not directly comparable to those for previous rel ...@@ -1738,13 +1827,15 @@ The times for this release are not directly comparable to those for previous rel
since some additional regression tests have been included and some obsolete tests involving since some additional regression tests have been included and some obsolete tests involving
time travel have been removed. time travel have been removed.
In general, however, v6.3 is substantially faster than previous releases (thanks, Bruce!). In general, however, v6.3 is substantially faster than previous releases (thanks, Bruce!).
</para>
<Para> <Para>
<ProgramListing> <ProgramListing>
Time System Time System
02:30 Dual Pentium Pro 180, 96MB, UW-SCSI, Linux 2.0.30, gcc 2.7.2.1 -O2 -m486 02:30 Dual Pentium Pro 180, 96MB, UW-SCSI, Linux 2.0.30, gcc 2.7.2.1 -O2 -m486
04:12 Dual Pentium Pro 180, 96MB, EIDE, Linux 2.0.30, gcc 2.7.2.1 -O2 -m486 04:12 Dual Pentium Pro 180, 96MB, EIDE, Linux 2.0.30, gcc 2.7.2.1 -O2 -m486
</ProgramListing> </ProgramListing>
</para>
</sect2>
<Sect2> <Sect2>
<Title>v6.1</Title> <Title>v6.1</Title>
...@@ -1756,5 +1847,7 @@ In general, however, v6.3 is substantially faster than previous releases (thanks ...@@ -1756,5 +1847,7 @@ In general, however, v6.3 is substantially faster than previous releases (thanks
12:06 P-100, 48MB, Linux 2.0.29, gcc 12:06 P-100, 48MB, Linux 2.0.29, gcc
39:58 Sparc IPC 32MB, Solaris 2.5, gcc 2.7.2.1 -O -g 39:58 Sparc IPC 32MB, Solaris 2.5, gcc 2.7.2.1 -O -g
</ProgramListing> </ProgramListing>
</para>
</sect2>
</sect1>
</Chapter> </Chapter>
doc/src/sgml/rules.sgml
View file @ a75f2d21
...@@ -28,7 +28,7 @@ ...@@ -28,7 +28,7 @@
[<XRef LinkEnd="ONG90" EndTerm="ONG90">] [<XRef LinkEnd="ONG90" EndTerm="ONG90">]
as well as as well as
[<XRef LinkEnd="STON90b" EndTerm="STON90b">]. [<XRef LinkEnd="STON90b" EndTerm="STON90b">].
</para>
<Sect1> <Sect1>
<Title>What is a Querytree?</Title> <Title>What is a Querytree?</Title>
...@@ -224,6 +224,7 @@ ...@@ -224,6 +224,7 @@
</VarListEntry> </VarListEntry>
</VariableList> </VariableList>
</para>
</Sect2> </Sect2>
</Sect1> </Sect1>
...@@ -1020,7 +1021,7 @@ ...@@ -1020,7 +1021,7 @@
create zero or many new parsetrees and can throw away the create zero or many new parsetrees and can throw away the
original one. original one.
</Para> </Para>
</sect2>
<Sect2> <Sect2>
<Title>How These Rules Work</Title> <Title>How These Rules Work</Title>
...@@ -1128,7 +1129,7 @@ ...@@ -1128,7 +1129,7 @@
</Para> </Para>
</ListItem> </ListItem>
</ItemizedList> </ItemizedList>
</para>
<Para> <Para>
Finally, if the rule is not INSTEAD, the unchanged original parsetree is Finally, if the rule is not INSTEAD, the unchanged original parsetree is
added to the list. Since only qualified INSTEAD rules already add the added to the list. Since only qualified INSTEAD rules already add the
......
doc/src/sgml/runtime.sgml
View file @ a75f2d21
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
<Para> <Para>
This chapter outlines the interaction between <Productname>Postgres</Productname> and This chapter outlines the interaction between <Productname>Postgres</Productname> and
the operating system. the operating system.
</para>
<sect1> <sect1>
<title>Using <Productname>Postgres</Productname> from Unix</title> <title>Using <Productname>Postgres</Productname> from Unix</title>
...@@ -13,7 +13,7 @@ All <Productname>Postgres</Productname> commands that are executed ...@@ -13,7 +13,7 @@ All <Productname>Postgres</Productname> commands that are executed
directly from a Unix shell are directly from a Unix shell are
found in the directory <quote>.../bin</quote>. Including this directory in found in the directory <quote>.../bin</quote>. Including this directory in
your search path will make executing the commands easier. your search path will make executing the commands easier.
</para>
<para> <para>
A collection of system catalogs exist at each site. These include a A collection of system catalogs exist at each site. These include a
class (<literal>pg_user</literal>) that contains an instance for each valid class (<literal>pg_user</literal>) that contains an instance for each valid
...@@ -26,6 +26,9 @@ user cannot do anything with <Productname>Postgres</Productname> ...@@ -26,6 +26,9 @@ user cannot do anything with <Productname>Postgres</Productname>
until an appropriate instance is until an appropriate instance is
installed in this class. Further information on the system catalogs installed in this class. Further information on the system catalogs
is available by running queries on the appropriate classes. is available by running queries on the appropriate classes.
</para>
</sect1>
</chapter>
<chapter id="layout"> <chapter id="layout">
<Title>System Layout</Title> <Title>System Layout</Title>
......
doc/src/sgml/signals.sgml
View file @ a75f2d21
...@@ -17,10 +17,12 @@ ...@@ -17,10 +17,12 @@
Contributed by <ULink url="mailto:dz@cs.unitn.it">Massimo Dal Zotto</ULink> Contributed by <ULink url="mailto:dz@cs.unitn.it">Massimo Dal Zotto</ULink>
</Para> </Para>
</Note> </Note>
</para>
<para> <para>
<productname>Postgres</productname> uses the following signals for <productname>Postgres</productname> uses the following signals for
communication between the postmaster and backends: communication between the postmaster and backends:
</para>
<para> <para>
<table tocentry="1"> <table tocentry="1">
...@@ -32,103 +34,156 @@ Contributed by <ULink url="mailto:dz@cs.unitn.it">Massimo Dal Zotto</ULink> ...@@ -32,103 +34,156 @@ Contributed by <ULink url="mailto:dz@cs.unitn.it">Massimo Dal Zotto</ULink>
<row> <row>
<entry> <entry>
Signal Signal
</entry>
<entry> <entry>
<application>postmaster</application> Action <application>postmaster</application> Action
</entry>
<entry> <entry>
Server Action Server Action
</entry>
</row>
</thead>
<tbody> <tbody>
<row> <row>
<entry> <entry>
SIGHUP SIGHUP
</entry>
<entry> <entry>
kill(*,sighup) kill(*,sighup)
</entry>
<entry> <entry>
read_pg_options read_pg_options
</entry>
</row>
<row> <row>
<entry> <entry>
SIGINT SIGINT
</entry>
<entry> <entry>
die die
</entry>
<entry> <entry>
cancel query cancel query
</entry>
</row>
<row> <row>
<entry> <entry>
SIGQUIT SIGQUIT
</entry>
<entry> <entry>
kill(*,sigterm) kill(*,sigterm)
</entry>
<entry> <entry>
handle_warn handle_warn
</entry>
</row>
<row> <row>
<entry> <entry>
SIGTERM SIGTERM
</entry>
<entry> <entry>
kill(*,sigterm), kill(*,9), die kill(*,sigterm), kill(*,9), die
</entry>
<entry> <entry>
die die
</entry>
</row>
<row> <row>
<entry> <entry>
SIGPIPE SIGPIPE
</entry>
<entry> <entry>
ignored ignored
</entry>
<entry> <entry>
die die
</entry>
</row>
<row> <row>
<entry> <entry>
SIGUSR1 SIGUSR1
</entry>
<entry> <entry>
kill(*,sigusr1), die kill(*,sigusr1), die
</entry>
<entry> <entry>
quickdie quickdie
</entry>
</row>
<row> <row>
<entry> <entry>
SIGUSR2 SIGUSR2
</entry>
<entry> <entry>
kill(*,sigusr2) kill(*,sigusr2)
</entry>
<entry> <entry>
async notify (SI flush) async notify (SI flush)
</entry>
</row>
<row> <row>
<entry> <entry>
SIGCHLD SIGCHLD
</entry>
<entry> <entry>
reaper reaper
</entry>
<entry> <entry>
ignored (alive test) ignored (alive test)
</entry>
</row>
<row> <row>
<entry> <entry>
SIGTTIN SIGTTIN
</entry>
<entry> <entry>
ignored ignored
</entry>
<entry> <entry>
</entry>
</row>
<row> <row>
<entry> <entry>
SIGTTOU SIGTTOU
</entry>
<entry> <entry>
ignored ignored
</entry>
<entry> <entry>
</entry>
</row>
<row> <row>
<entry> <entry>
SIGCONT SIGCONT
</entry>
<entry> <entry>
dumpstatus dumpstatus
</entry>
<entry> <entry>
</entry>
</row>
<row> <row>
<entry> <entry>
SIGFPE SIGFPE
</entry>
<entry> <entry>
</entry>
<entry> <entry>
FloatExceptionHandler FloatExceptionHandler
</entry>
</row>
</tbody> </tbody>
</tgroup> </tgroup>
...@@ -137,7 +192,9 @@ FloatExceptionHandler ...@@ -137,7 +192,9 @@ FloatExceptionHandler
<note> <note>
<para> <para>
<quote>kill(*,signal)</quote> means sending a signal to all backends. <quote>kill(*,signal)</quote> means sending a signal to all backends.
</para>
</note> </note>
</para>
<para> <para>
The main changes to the old signal handling are the use of SIGQUIT instead The main changes to the old signal handling are the use of SIGQUIT instead
...@@ -148,6 +205,7 @@ In this way these signals sent to the postmaster can be sent ...@@ -148,6 +205,7 @@ In this way these signals sent to the postmaster can be sent
automatically to all the backends without need to know their pids. automatically to all the backends without need to know their pids.
To shut down postgres one needs only to send a SIGTERM to postmaster To shut down postgres one needs only to send a SIGTERM to postmaster
and it will stop automatically all the backends. and it will stop automatically all the backends.
</para>
<para> <para>
The SIGUSR2 signal is also used to prevent SI cache table overflow The SIGUSR2 signal is also used to prevent SI cache table overflow
...@@ -155,6 +213,7 @@ which happens when some backend doesn't process SI cache for a long period. ...@@ -155,6 +213,7 @@ which happens when some backend doesn't process SI cache for a long period.
When a backend detects the SI table full at 70% it simply sends a signal When a backend detects the SI table full at 70% it simply sends a signal
to the postmaster which will wake up all idle backends and make them flush to the postmaster which will wake up all idle backends and make them flush
the cache. the cache.
</para>
<para> <para>
The typical use of signals by programmers could be the following: The typical use of signals by programmers could be the following:
...@@ -186,5 +245,5 @@ cat new_pg_options > $DATA_DIR/pg_options ...@@ -186,5 +245,5 @@ cat new_pg_options > $DATA_DIR/pg_options
kill -HUP $backend_pid kill -HUP $backend_pid
cat old_pg_options > $DATA_DIR/pg_options cat old_pg_options > $DATA_DIR/pg_options
</programlisting> </programlisting>
</para>
</chapter> </chapter>
doc/src/sgml/spi.sgml
View file @ a75f2d21
...@@ -127,6 +127,7 @@ Return status ...@@ -127,6 +127,7 @@ Return status
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
</VARIABLELIST> </VARIABLELIST>
</para>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
</VARIABLELIST> </VARIABLELIST>
...@@ -263,7 +264,7 @@ SPI_finish(void) ...@@ -263,7 +264,7 @@ SPI_finish(void)
<PARA> <PARA>
<FUNCTION>SPI_finish</FUNCTION> closes an existing connection to the <ProductName>Postgres</ProductName> backend. <FUNCTION>SPI_finish</FUNCTION> closes an existing connection to the <ProductName>Postgres</ProductName> backend.
You should call this function after completing operations through the SPI manager. You should call this function after completing operations through the SPI manager.
</para>
<PARA> <PARA>
You may get the error return <ReturnValue>SPI_ERROR_UNCONNECTED</ReturnValue> if <Function>SPI_finish</Function> is You may get the error return <ReturnValue>SPI_ERROR_UNCONNECTED</ReturnValue> if <Function>SPI_finish</Function> is
called without having a current valid connection. called without having a current valid connection.
...@@ -408,7 +409,7 @@ Maximum number of tuples to return ...@@ -408,7 +409,7 @@ Maximum number of tuples to return
<ReturnValue>SPI_ERROR_OPUNKNOWN</ReturnValue> if type of query is unknown (this shouldn't occur). <ReturnValue>SPI_ERROR_OPUNKNOWN</ReturnValue> if type of query is unknown (this shouldn't occur).
</Member> </Member>
</SimpleList> </SimpleList>
</para>
<Para> <Para>
If execution of your query was successful then one of the following If execution of your query was successful then one of the following
(non-negative) values will be returned: (non-negative) values will be returned:
...@@ -475,7 +476,7 @@ You may pass many queries in one string or query string may be ...@@ -475,7 +476,7 @@ You may pass many queries in one string or query string may be
executed. executed.
</Para> </Para>
</Note> </Note>
</para>
<Para> <Para>
The actual number of tuples for which the (last) query was executed is The actual number of tuples for which the (last) query was executed is
returned in the global variable SPI_processed (if not <ReturnValue>SPI_OK_UTILITY</ReturnValue>). returned in the global variable SPI_processed (if not <ReturnValue>SPI_OK_UTILITY</ReturnValue>).
...@@ -676,16 +677,16 @@ Pointer to an execution plan (parser+planner+optimizer) ...@@ -676,16 +677,16 @@ Pointer to an execution plan (parser+planner+optimizer)
<PARA> <PARA>
nargs is number of parameters ($1 ... $nargs - as in SQL-functions), nargs is number of parameters ($1 ... $nargs - as in SQL-functions),
and nargs may be 0 only if there is not any $1 in query. and nargs may be 0 only if there is not any $1 in query.
</para>
<Para> <Para>
Execution of prepared execution plans is sometimes much faster so this Execution of prepared execution plans is sometimes much faster so this
feature may be useful if the same query will be executed many times. feature may be useful if the same query will be executed many times.
</para>
<Para> <Para>
The plan returned by <Function>SPI_prepare</Function> may be used only in current The plan returned by <Function>SPI_prepare</Function> may be used only in current
invocation of the procedure since <Function>SPI_finish</Function> frees memory allocated for a plan. invocation of the procedure since <Function>SPI_finish</Function> frees memory allocated for a plan.
See <Function>SPI_saveplan</Function>. See <Function>SPI_saveplan</Function>.
</para>
<Para> <Para>
If successful, a non-null pointer will be returned. Otherwise, you'll get If successful, a non-null pointer will be returned. Otherwise, you'll get
a NULL plan. In both cases SPI_result will be set like the value returned a NULL plan. In both cases SPI_result will be set like the value returned
...@@ -818,7 +819,7 @@ Execution plan location. NULL if unsuccessful. ...@@ -818,7 +819,7 @@ Execution plan location. NULL if unsuccessful.
<FUNCTION>SPI_saveplan</FUNCTION> <FUNCTION>SPI_saveplan</FUNCTION>
stores a plan prepared by <Function>SPI_prepare</Function> in safe memory stores a plan prepared by <Function>SPI_prepare</Function> in safe memory
protected from freeing by <Function>SPI_finish</Function> or the transaction manager. protected from freeing by <Function>SPI_finish</Function> or the transaction manager.
</para>
<Para> <Para>
In the current version of <ProductName>Postgres</ProductName> there is no ability to In the current version of <ProductName>Postgres</ProductName> there is no ability to
store prepared plans in the system store prepared plans in the system
...@@ -991,6 +992,7 @@ Number of tuples for which plan is to be executed ...@@ -991,6 +992,7 @@ Number of tuples for which plan is to be executed
was prepared with some parameters. was prepared with some parameters.
</Member> </Member>
</SimpleList> </SimpleList>
</para>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
<VARLISTENTRY> <VARLISTENTRY>
...@@ -1010,6 +1012,8 @@ initialized as in ...@@ -1010,6 +1012,8 @@ initialized as in
<PARA> <PARA>
initialized as in initialized as in
<Function>SPI_exec</Function> if successful <Function>SPI_exec</Function> if successful
</para>
</listitem>
</VARLISTENTRY> </VARLISTENTRY>
</VARIABLELIST> </VARIABLELIST>
</REFSECT2> </REFSECT2>
...@@ -1025,7 +1029,7 @@ initialized as in ...@@ -1025,7 +1029,7 @@ initialized as in
<FUNCTION>SPI_execp</FUNCTION> <FUNCTION>SPI_execp</FUNCTION>
stores a plan prepared by <Function>SPI_prepare</Function> in safe memory stores a plan prepared by <Function>SPI_prepare</Function> in safe memory
protected from freeing by <Function>SPI_finish</Function> or the transaction manager. protected from freeing by <Function>SPI_finish</Function> or the transaction manager.
</para>
<Para> <Para>
In the current version of <ProductName>Postgres</ProductName> there is no ability to In the current version of <ProductName>Postgres</ProductName> there is no ability to
store prepared plans in the system store prepared plans in the system
...@@ -1169,6 +1173,7 @@ Copied tuple ...@@ -1169,6 +1173,7 @@ Copied tuple
is NULL is NULL
</Member> </Member>
</SimpleList> </SimpleList>
</para>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
</VARIABLELIST> </VARIABLELIST>
...@@ -1333,6 +1338,7 @@ New tuple with modifications ...@@ -1333,6 +1338,7 @@ New tuple with modifications
is NULL is NULL
</Member> </Member>
</SimpleList> </SimpleList>
</para>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
<VARLISTENTRY> <VARLISTENTRY>
...@@ -1352,6 +1358,7 @@ SPI_result ...@@ -1352,6 +1358,7 @@ SPI_result
attributes in tuple) attributes in tuple)
</Member> </Member>
</SimpleList> </SimpleList>
</para>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
</VARIABLELIST> </VARIABLELIST>
...@@ -1474,6 +1481,7 @@ Valid one-based index number of attribute ...@@ -1474,6 +1481,7 @@ Valid one-based index number of attribute
<ReturnValue>SPI_ERROR_NOATTRIBUTE</ReturnValue> if the named attribute is not found <ReturnValue>SPI_ERROR_NOATTRIBUTE</ReturnValue> if the named attribute is not found
</Member> </Member>
</SimpleList> </SimpleList>
</para>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
</VARIABLELIST> </VARIABLELIST>
...@@ -1595,6 +1603,7 @@ SPI_result set to ...@@ -1595,6 +1603,7 @@ SPI_result set to
<ReturnValue>SPI_ERROR_NOATTRIBUTE</ReturnValue> on error <ReturnValue>SPI_ERROR_NOATTRIBUTE</ReturnValue> on error
</Member> </Member>
</SimpleList> </SimpleList>
</para>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
</VARIABLELIST> </VARIABLELIST>
...@@ -1731,6 +1740,7 @@ no output function available ...@@ -1731,6 +1740,7 @@ no output function available
<ReturnValue>SPI_ERROR_NOOUTFUNC</ReturnValue>) <ReturnValue>SPI_ERROR_NOOUTFUNC</ReturnValue>)
</Member> </Member>
</SimpleList> </SimpleList>
</para>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
</VARIABLELIST> </VARIABLELIST>
......
doc/src/sgml/start-ag.sgml
View file @ a75f2d21
...@@ -73,7 +73,7 @@ It is possible to create a database in a location other than the default ...@@ -73,7 +73,7 @@ It is possible to create a database in a location other than the default
location for the installation. Remember that all database access actually location for the installation. Remember that all database access actually
occurs through the database backend, so that any location specified must occurs through the database backend, so that any location specified must
be accessible by the backend. be accessible by the backend.
</para>
<Para> <Para>
Alternate database locations are created and referenced by an environment variable Alternate database locations are created and referenced by an environment variable
which gives the absolute path to the intended storage location. which gives the absolute path to the intended storage location.
...@@ -82,7 +82,7 @@ and must be writable by the postgres administrator account. ...@@ -82,7 +82,7 @@ and must be writable by the postgres administrator account.
Any valid environment variable name may be used to reference an alternate Any valid environment variable name may be used to reference an alternate
location, although using variable name with a prefix of PGDATA is recommended location, although using variable name with a prefix of PGDATA is recommended
to avoid confusion and conflict with other variables. to avoid confusion and conflict with other variables.
</para>
<Note> <Note>
<Para> <Para>
In previous versions of <ProductName>Postgres</ProductName>, In previous versions of <ProductName>Postgres</ProductName>,
...@@ -123,7 +123,7 @@ Any environment variable can be used to reference alternate location, ...@@ -123,7 +123,7 @@ Any environment variable can be used to reference alternate location,
although it is preferred that the variables be prefixed with "PGDATA" although it is preferred that the variables be prefixed with "PGDATA"
to eliminate confusion and the possibility of conflicting with or to eliminate confusion and the possibility of conflicting with or
overwriting other variables. overwriting other variables.
</para>
<Para> <Para>
To create a data storage area in PGDATA2, ensure To create a data storage area in PGDATA2, ensure
that <filename>/home/postgres</filename> already exists and is writable that <filename>/home/postgres</filename> already exists and is writable
...@@ -137,13 +137,14 @@ Creating Postgres database system directory /home/postgres/data ...@@ -137,13 +137,14 @@ Creating Postgres database system directory /home/postgres/data
Creating Postgres database system directory /home/postgres/data/base Creating Postgres database system directory /home/postgres/data/base
</ProgramListing> </ProgramListing>
</para>
<Para> <Para>
To test the new location, create a database <Database>test</Database> by typing To test the new location, create a database <Database>test</Database> by typing
<ProgramListing> <ProgramListing>
% createdb -D PGDATA2 test % createdb -D PGDATA2 test
% destroydb test % destroydb test
</ProgramListing> </ProgramListing>
</para>
</Sect1> </Sect1>
</Chapter> </Chapter>
...@@ -158,7 +159,7 @@ and authorized you to use the database, you (as a user) may begin to start up ...@@ -158,7 +159,7 @@ and authorized you to use the database, you (as a user) may begin to start up
<filename>/usr/local/pgsql/bin</filename> to your shell search path. <filename>/usr/local/pgsql/bin</filename> to your shell search path.
In most cases, this is all you should have to do in In most cases, this is all you should have to do in
terms of preparation. terms of preparation.
</para>
<Para> <Para>
If you get the following error message from a If you get the following error message from a
<ProductName>Postgres</ProductName> <ProductName>Postgres</ProductName>
......
doc/src/sgml/typeconv.sgml
View file @ a75f2d21
...@@ -6,6 +6,7 @@ ...@@ -6,6 +6,7 @@
mixing of different data types in the same expression. mixing of different data types in the same expression.
<productname>Postgres</productname> has extensive facilities for <productname>Postgres</productname> has extensive facilities for
evaluating mixed-type expressions. evaluating mixed-type expressions.
</para>
<para> <para>
In many cases a user will not need In many cases a user will not need
...@@ -14,16 +15,19 @@ However, the implicit conversions done by <productname>Postgres</productname> ...@@ -14,16 +15,19 @@ However, the implicit conversions done by <productname>Postgres</productname>
can affect the apparent results of a query, and these results can affect the apparent results of a query, and these results
can be tailored by a user or programmer can be tailored by a user or programmer
using <emphasis>explicit</emphasis> type coersion. using <emphasis>explicit</emphasis> type coersion.
</para>
<para> <para>
This chapter introduces the <productname>Postgres</productname> This chapter introduces the <productname>Postgres</productname>
type conversion mechanisms and conventions. type conversion mechanisms and conventions.
Refer to the relevant sections in the User's Guide and Programmer's Guide Refer to the relevant sections in the User's Guide and Programmer's Guide
for more information on specific data types and allowed functions and operators. for more information on specific data types and allowed functions and operators.
</para>
<para> <para>
The Programmer's Guide has more details on the exact algorithms used for The Programmer's Guide has more details on the exact algorithms used for
implicit type conversion and coersion. implicit type conversion and coersion.
</para>
<sect1> <sect1>
<title>Overview</title> <title>Overview</title>
...@@ -36,6 +40,7 @@ much more general and flexible than other <acronym>RDBMS</acronym> implementatio ...@@ -36,6 +40,7 @@ much more general and flexible than other <acronym>RDBMS</acronym> implementatio
Hence, most type conversion behavior in <productname>Postgres</productname> Hence, most type conversion behavior in <productname>Postgres</productname>
should be governed by general rules rather than by ad-hoc heuristics to allow should be governed by general rules rather than by ad-hoc heuristics to allow
mixed-type expressions to be meaningful, even with user-defined types. mixed-type expressions to be meaningful, even with user-defined types.
</para>
<para> <para>
The <productname>Postgres</productname> scanner/parser decodes lexical elements The <productname>Postgres</productname> scanner/parser decodes lexical elements
...@@ -56,11 +61,13 @@ Origin|(0,0) ...@@ -56,11 +61,13 @@ Origin|(0,0)
has two strings, of type <type>text</type> and <type>point</type>. has two strings, of type <type>text</type> and <type>point</type>.
If a type is not specified, then the placeholder type <type>unknown</type> If a type is not specified, then the placeholder type <type>unknown</type>
is assigned initially, to be resolved in later stages as described below. is assigned initially, to be resolved in later stages as described below.
</para>
<para> <para>
There are four fundamental <acronym>SQL</acronym> constructs requiring There are four fundamental <acronym>SQL</acronym> constructs requiring
distinct type conversion rules in the <productname>Postgres</productname> distinct type conversion rules in the <productname>Postgres</productname>
parser: parser:
</para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
...@@ -72,6 +79,7 @@ Operators ...@@ -72,6 +79,7 @@ Operators
<productname>Postgres</productname> allows expressions with <productname>Postgres</productname> allows expressions with
left- and right-unary (one argument) operators, left- and right-unary (one argument) operators,
as well as binary (two argument) operators. as well as binary (two argument) operators.
</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
...@@ -83,6 +91,7 @@ Function calls ...@@ -83,6 +91,7 @@ Function calls
Much of the <productname>Postgres</productname> type system is built around a rich set of Much of the <productname>Postgres</productname> type system is built around a rich set of
functions. Function calls have one or more arguments which, for any specific query, functions. Function calls have one or more arguments which, for any specific query,
must be matched to the functions available in the system catalog. must be matched to the functions available in the system catalog.
</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
...@@ -93,6 +102,7 @@ Query targets ...@@ -93,6 +102,7 @@ Query targets
<para> <para>
<acronym>SQL</acronym> INSERT statements place the results of query into a table. The expressions <acronym>SQL</acronym> INSERT statements place the results of query into a table. The expressions
in the query must be matched up with, and perhaps converted to, the target columns of the insert. in the query must be matched up with, and perhaps converted to, the target columns of the insert.
</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
...@@ -103,6 +113,7 @@ UNION queries ...@@ -103,6 +113,7 @@ UNION queries
<para> <para>
Since all select results from a UNION SELECT statement must appear in a single set of columns, the types Since all select results from a UNION SELECT statement must appear in a single set of columns, the types
of each SELECT clause must be matched up and converted to a uniform set. of each SELECT clause must be matched up and converted to a uniform set.
</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
...@@ -113,6 +124,7 @@ the <productname>Postgres</productname> function and operator system tables. ...@@ -113,6 +124,7 @@ the <productname>Postgres</productname> function and operator system tables.
There are some heuristics included in the conversion rules to better support There are some heuristics included in the conversion rules to better support
conventions for the <acronym>SQL92</acronym> standard native types such as conventions for the <acronym>SQL92</acronym> standard native types such as
<type>smallint</type>, <type>integer</type>, and <type>float</type>. <type>smallint</type>, <type>integer</type>, and <type>float</type>.
</para>
<para> <para>
The <productname>Postgres</productname> parser uses the convention that all The <productname>Postgres</productname> parser uses the convention that all
...@@ -122,6 +134,7 @@ criteria is considered to be a valid conversion function, and may be used ...@@ -122,6 +134,7 @@ criteria is considered to be a valid conversion function, and may be used
by the parser as such. This simple assumption gives the parser the power by the parser as such. This simple assumption gives the parser the power
to explore type conversion possibilities without hardcoding, allowing to explore type conversion possibilities without hardcoding, allowing
extended user-defined types to use these same features transparently. extended user-defined types to use these same features transparently.
</para>
<para> <para>
An additional heuristic is provided in the parser to allow better guesses An additional heuristic is provided in the parser to allow better guesses
...@@ -133,11 +146,13 @@ Each "user-defined" type is its own "preferred type", so ambiguous ...@@ -133,11 +146,13 @@ Each "user-defined" type is its own "preferred type", so ambiguous
expressions (those with multiple candidate parsing solutions) expressions (those with multiple candidate parsing solutions)
with only one user-defined type can resolve to a single best choice, while those with with only one user-defined type can resolve to a single best choice, while those with
multiple user-defined types will remain ambiguous and throw an error. multiple user-defined types will remain ambiguous and throw an error.
</para>
<para> <para>
Ambiguous expressions which have candidate solutions within only one type category are Ambiguous expressions which have candidate solutions within only one type category are
likely to resolve, while ambiguous expressions with candidates spanning multiple likely to resolve, while ambiguous expressions with candidates spanning multiple
categories are likely to throw an error and ask for clarification from the user. categories are likely to throw an error and ask for clarification from the user.
</para>
<sect2> <sect2>
<title>Guidelines</title> <title>Guidelines</title>
...@@ -149,12 +164,16 @@ All type conversion rules are designed with several principles in mind: ...@@ -149,12 +164,16 @@ All type conversion rules are designed with several principles in mind:
<listitem> <listitem>
<para> <para>
Implicit conversions should never have suprising or unpredictable outcomes. Implicit conversions should never have suprising or unpredictable outcomes.
</para>
</listitem>
<listitem> <listitem>
<para> <para>
User-defined types, of which the parser has no apriori knowledge, should be User-defined types, of which the parser has no apriori knowledge, should be
"higher" in the type heirarchy. In mixed-type expressions, native types shall always "higher" in the type heirarchy. In mixed-type expressions, native types shall always
be converted to a user-defined type (of course, only if conversion is necessary). be converted to a user-defined type (of course, only if conversion is necessary).
</para>
</listitem>
<listitem> <listitem>
<para> <para>
...@@ -162,6 +181,8 @@ User-defined types are not related. Currently, <productname>Postgres</productnam ...@@ -162,6 +181,8 @@ User-defined types are not related. Currently, <productname>Postgres</productnam
does not have information available to it on relationships between types, other than does not have information available to it on relationships between types, other than
hardcoded heuristics for built-in types and implicit relationships based on available functions hardcoded heuristics for built-in types and implicit relationships based on available functions
in the catalog. in the catalog.
</para>
</listitem>
<listitem> <listitem>
<para> <para>
...@@ -170,12 +191,18 @@ if a query does not need implicit type conversion. ...@@ -170,12 +191,18 @@ if a query does not need implicit type conversion.
That is, if a query is well formulated and the types already match up, then the query should proceed That is, if a query is well formulated and the types already match up, then the query should proceed
without spending extra time in the parser and without introducing unnecessary implicit conversion without spending extra time in the parser and without introducing unnecessary implicit conversion
functions into the query. functions into the query.
</para>
<para> <para>
Additionally, if a query usually requires an implicit conversion for a function, and Additionally, if a query usually requires an implicit conversion for a function, and
if then the user defines an explicit function with the correct argument types, the parser if then the user defines an explicit function with the correct argument types, the parser
should use this new function and will no longer do the implicit conversion using the old function. should use this new function and will no longer do the implicit conversion using the old function.
</para>
</listitem>
</itemizedlist> </itemizedlist>
</para>
</sect2>
</sect1>
<sect1> <sect1>
<title>Operators</title> <title>Operators</title>
...@@ -183,50 +210,55 @@ should use this new function and will no longer do the implicit conversion using ...@@ -183,50 +210,55 @@ should use this new function and will no longer do the implicit conversion using
<sect2> <sect2>
<title>Conversion Procedure</title> <title>Conversion Procedure</title>
<para>
<procedure> <procedure>
<title>Operator Evaluation</title> <title>Operator Evaluation</title>
<para>
<step performance="required"> <step performance="required">
<para> <para>
Check for an exact match in the pg_operator system catalog. Check for an exact match in the pg_operator system catalog.
</para>
<substeps> <substeps>
<step performance="optional"> <step performance="optional">
<para> <para>
If one argument of a binary operator is <type>unknown</type>, If one argument of a binary operator is <type>unknown</type>,
then assume it is the same type as the other argument. then assume it is the same type as the other argument.
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Reverse the arguments, and look for an exact match with an operator which Reverse the arguments, and look for an exact match with an operator which
points to itself as being commutative. points to itself as being commutative.
If found, then reverse the arguments in the parse tree and use this operator. If found, then reverse the arguments in the parse tree and use this operator.
</para>
</step>
</substeps> </substeps>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Look for the best match. Look for the best match.
</para>
<substeps> <substeps>
<step performance="optional"> <step performance="optional">
<para> <para>
Make a list of all operators of the same name. Make a list of all operators of the same name.
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
If only one operator is in the list, use it if the input type can be coerced, If only one operator is in the list, use it if the input type can be coerced,
and throw an error if the type cannot be coerced. and throw an error if the type cannot be coerced.
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Keep all operators with the most explicit matches for types. Keep all if there Keep all operators with the most explicit matches for types. Keep all if there
are no explicit matches and move to the next step. are no explicit matches and move to the next step.
If only one candidate remains, use it if the type can be coerced. If only one candidate remains, use it if the type can be coerced.
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
If any input arguments are "unknown", categorize the input candidates as If any input arguments are "unknown", categorize the input candidates as
...@@ -235,16 +267,20 @@ categories, or more than one user-defined type, throw an error because ...@@ -235,16 +267,20 @@ categories, or more than one user-defined type, throw an error because
the correct choice cannot be deduced without more clues. the correct choice cannot be deduced without more clues.
If only one category is present, then assign the "preferred type" If only one category is present, then assign the "preferred type"
to the input column which had been previously "unknown". to the input column which had been previously "unknown".
</para>
</step>
<step performance="required"> <step performance="required">
<para> <para>
Choose the candidate with the most exact type matches, and which matches Choose the candidate with the most exact type matches, and which matches
the "preferred type" for each column category from the previous step. the "preferred type" for each column category from the previous step.
If there is still more than one candidate, or if there are none, If there is still more than one candidate, or if there are none,
then throw an error. then throw an error.
</para>
</step>
</substeps> </substeps>
</step>
</procedure> </procedure>
</sect2>
<sect2> <sect2>
<title>Examples</title> <title>Examples</title>
...@@ -291,7 +327,10 @@ Exp ...@@ -291,7 +327,10 @@ Exp
This last form has the least overhead, since no functions are called to do This last form has the least overhead, since no functions are called to do
implicit type conversion. This is not an issue for small queries, but may implicit type conversion. This is not an issue for small queries, but may
have an impact on the performance of queries involving large tables. have an impact on the performance of queries involving large tables.
</para>
</note> </note>
</para>
</sect3>
<sect3> <sect3>
<title>String Concatenation</title> <title>String Concatenation</title>
...@@ -300,6 +339,7 @@ have an impact on the performance of queries involving large tables. ...@@ -300,6 +339,7 @@ have an impact on the performance of queries involving large tables.
A string-like syntax is used for working with string types as well as for A string-like syntax is used for working with string types as well as for
working with complex extended types. working with complex extended types.
Strings with unspecified type are matched with likely operator candidates. Strings with unspecified type are matched with likely operator candidates.
</para>
<para> <para>
One unspecified argument: One unspecified argument:
...@@ -310,11 +350,13 @@ Text and Unknown ...@@ -310,11 +350,13 @@ Text and Unknown
abcdef abcdef
(1 row) (1 row)
</programlisting> </programlisting>
</para>
<para> <para>
In this case the parser looks to see if there is an operator taking <type>text</type> In this case the parser looks to see if there is an operator taking <type>text</type>
for both arguments. Since there is, it assumes that the second argument should for both arguments. Since there is, it assumes that the second argument should
be interpreted as of type <type>text</type>. be interpreted as of type <type>text</type>.
</para>
<para> <para>
Concatenation on unspecified types: Concatenation on unspecified types:
...@@ -325,19 +367,23 @@ Unspecified ...@@ -325,19 +367,23 @@ Unspecified
abcdef abcdef
(1 row) (1 row)
</programlisting> </programlisting>
</para>
<para> <para>
In this case there is no initial hint for which type to use, since no types In this case there is no initial hint for which type to use, since no types
are specified in the query. So, the parser looks for all candidate operators are specified in the query. So, the parser looks for all candidate operators
and finds that all arguments for all the candidates are string types. It chooses and finds that all arguments for all the candidates are string types. It chooses
the "preferred type" for strings, <type>text</type>, for this query. the "preferred type" for strings, <type>text</type>, for this query.
</para>
<note> <note>
<para> <para>
If a user defines a new type and defines an operator <quote>||</quote> to work If a user defines a new type and defines an operator <quote>||</quote> to work
with it, then this query would no longer succeed as written. The parser would with it, then this query would no longer succeed as written. The parser would
now have candidate types from two categories, and could not decide which to use. now have candidate types from two categories, and could not decide which to use.
</para>
</note> </note>
</sect3>
<sect3> <sect3>
<title>Factorial</title> <title>Factorial</title>
...@@ -366,40 +412,43 @@ However, the role of a database is not to teach mathematics, but ...@@ -366,40 +412,43 @@ However, the role of a database is not to teach mathematics, but
to be a tool for data manipulation. If a user chooses to take the to be a tool for data manipulation. If a user chooses to take the
factorial of a floating point number, <productname>Postgres</productname> factorial of a floating point number, <productname>Postgres</productname>
will try to oblige. will try to oblige.
</para>
</note> </note>
</para>
</sect3>
</sect2>
</sect1>
<sect1> <sect1>
<title>Functions</title> <title>Functions</title>
<para>
<procedure> <procedure>
<title>Function Evaluation</title> <title>Function Evaluation</title>
<step performance="required"> <step performance="required">
<para> <para>
Check for an exact match in the pg_proc system catalog. Check for an exact match in the pg_proc system catalog.
</para></step>
<step performance="required"> <step performance="required">
<para> <para>
Look for the best match. Look for the best match.
</para>
<substeps> <substeps>
<step performance="required"> <step performance="required">
<para> <para>
Make a list of all functions of the same name with the same number of arguments. Make a list of all functions of the same name with the same number of arguments.
</para></step>
<step performance="required"> <step performance="required">
<para> <para>
If only one function is in the list, use it if the input types can be coerced, If only one function is in the list, use it if the input types can be coerced,
and throw an error if the types cannot be coerced. and throw an error if the types cannot be coerced.
</para></step>
<step performance="required"> <step performance="required">
<para> <para>
Keep all functions with the most explicit matches for types. Keep all if there Keep all functions with the most explicit matches for types. Keep all if there
are no explicit matches and move to the next step. are no explicit matches and move to the next step.
If only one candidate remains, use it if the type can be coerced. If only one candidate remains, use it if the type can be coerced.
</para></step>
<step performance="required"> <step performance="required">
<para> <para>
If any input arguments are "unknown", categorize the input candidate arguments as If any input arguments are "unknown", categorize the input candidate arguments as
...@@ -408,17 +457,17 @@ categories, or more than one user-defined type, throw an error because ...@@ -408,17 +457,17 @@ categories, or more than one user-defined type, throw an error because
the correct choice cannot be deduced without more clues. the correct choice cannot be deduced without more clues.
If only one category is present, then assign the "preferred type" If only one category is present, then assign the "preferred type"
to the input column which had been previously "unknown". to the input column which had been previously "unknown".
</para></step>
<step performance="required"> <step performance="required">
<para> <para>
Choose the candidate with the most exact type matches, and which matches Choose the candidate with the most exact type matches, and which matches
the "preferred type" for each column category from the previous step. the "preferred type" for each column category from the previous step.
If there is still more than one candidate, or if there are none, If there is still more than one candidate, or if there are none,
then throw an error. then throw an error.
</para></step>
</substeps> </substeps>
</step>
</procedure> </procedure>
<sect2> <sect2>
<title>Examples</title> <title>Examples</title>
...@@ -446,6 +495,8 @@ int4fac ...@@ -446,6 +495,8 @@ int4fac
24 24
(1 row) (1 row)
</programlisting> </programlisting>
</para>
</sect3>
<sect3> <sect3>
<title>Substring Function</title> <title>Substring Function</title>
...@@ -453,6 +504,7 @@ int4fac ...@@ -453,6 +504,7 @@ int4fac
<para> <para>
There are two <function>substr</function> functions declared in pg_proc. However, There are two <function>substr</function> functions declared in pg_proc. However,
only one takes two arguments, of types <type>text</type> and <type>int4</type>. only one takes two arguments, of types <type>text</type> and <type>int4</type>.
</para>
<para> <para>
If called with a string constant of unspecified type, the type is matched up If called with a string constant of unspecified type, the type is matched up
...@@ -464,6 +516,7 @@ substr ...@@ -464,6 +516,7 @@ substr
34 34
(1 row) (1 row)
</programlisting> </programlisting>
</para>
<para> <para>
If the string is declared to be of type <type>varchar</type>, as might be the case If the string is declared to be of type <type>varchar</type>, as might be the case
...@@ -483,12 +536,14 @@ substr ...@@ -483,12 +536,14 @@ substr
34 34
(1 row) (1 row)
</programlisting> </programlisting>
</para>
<note> <note>
<para> <para>
There are some heuristics in the parser to optimize the relationship between the There are some heuristics in the parser to optimize the relationship between the
<type>char</type>, <type>varchar</type>, and <type>text</type> types. <type>char</type>, <type>varchar</type>, and <type>text</type> types.
For this case, <function>substr</function> is called directly with the <type>varchar</type> string For this case, <function>substr</function> is called directly with the <type>varchar</type> string
rather than inserting an explicit conversion call. rather than inserting an explicit conversion call.
</para>
</note> </note>
<para> <para>
...@@ -509,22 +564,25 @@ substr ...@@ -509,22 +564,25 @@ substr
34 34
(1 row) (1 row)
</programlisting> </programlisting>
</para>
</sect3>
</sect2>
</sect1>
<sect1> <sect1>
<title>Query Targets</title> <title>Query Targets</title>
<para>
<procedure> <procedure>
<title>Target Evaluation</title> <title>Target Evaluation</title>
<step performance="required"> <step performance="required">
<para> <para>
Check for an exact match with the target. Check for an exact match with the target.
</para></step>
<step performance="required"> <step performance="required">
<para> <para>
Try to coerce the expression directly to the target type if necessary. Try to coerce the expression directly to the target type if necessary.
</para></step>
<step performance="required"> <step performance="required">
<para> <para>
...@@ -532,6 +590,7 @@ If the target is a fixed-length type (e.g. <type>char</type> or <type>varchar</t ...@@ -532,6 +590,7 @@ If the target is a fixed-length type (e.g. <type>char</type> or <type>varchar</t
declared with a length) then try to find a sizing function of the same name declared with a length) then try to find a sizing function of the same name
as the type taking two arguments, the first the type name and the second an as the type taking two arguments, the first the type name and the second an
integer length. integer length.
</para></step>
</procedure> </procedure>
...@@ -556,7 +615,10 @@ v ...@@ -556,7 +615,10 @@ v
abcd abcd
(1 row) (1 row)
</programlisting> </programlisting>
</para>
</sect3>
</sect2>
</sect1>
<sect1> <sect1>
<title>UNION Queries</title> <title>UNION Queries</title>
...@@ -564,19 +626,20 @@ abcd ...@@ -564,19 +626,20 @@ abcd
<para> <para>
The UNION construct is somewhat different in that it must match up The UNION construct is somewhat different in that it must match up
possibly dissimilar types to become a single result set. possibly dissimilar types to become a single result set.
</para>
<procedure> <procedure>
<title>UNION Evaluation</title> <title>UNION Evaluation</title>
<step performance="required"> <step performance="required">
<para> <para>
Check for identical types for all results. Check for identical types for all results.
</para></step>
<step performance="required"> <step performance="required">
<para> <para>
Coerce each result from the UNION clauses to match the type of the Coerce each result from the UNION clauses to match the type of the
first SELECT clause or the target column. first SELECT clause or the target column.
</para></step>
</procedure> </procedure>
<sect2> <sect2>
...@@ -594,6 +657,8 @@ a ...@@ -594,6 +657,8 @@ a
b b
(2 rows) (2 rows)
</programlisting> </programlisting>
</para>
</sect3>
<sect3> <sect3>
<title>Simple UNION</title> <title>Simple UNION</title>
...@@ -607,6 +672,8 @@ Float8 ...@@ -607,6 +672,8 @@ Float8
1.2 1.2
(2 rows) (2 rows)
</programlisting> </programlisting>
</para>
</sect3>
<sect3> <sect3>
<title>Transposed UNION</title> <title>Transposed UNION</title>
...@@ -626,7 +693,7 @@ All integers ...@@ -626,7 +693,7 @@ All integers
3 3
(3 rows) (3 rows)
</programlisting> </programlisting>
</para>
<para> <para>
An alternate parser strategy could be to choose the "best" type of the bunch, but An alternate parser strategy could be to choose the "best" type of the bunch, but
this is more difficult because of the nice recursion technique used in the this is more difficult because of the nice recursion technique used in the
...@@ -649,5 +716,8 @@ tgl=> SELECT f AS "Floating point" from ff; ...@@ -649,5 +716,8 @@ tgl=> SELECT f AS "Floating point" from ff;
3.3 3.3
(3 rows) (3 rows)
</programlisting> </programlisting>
</para>
</sect3>
</sect2>
</sect1>
</chapter> </chapter>
doc/src/sgml/xfunc.sgml
View file @ a75f2d21
...@@ -72,6 +72,7 @@ ...@@ -72,6 +72,7 @@
+-------+ +-------+
</ProgramListing> </ProgramListing>
</Para> </Para>
</sect2>
<Sect2> <Sect2>
<Title><Acronym>SQL</Acronym> Functions on Composite Types</Title> <Title><Acronym>SQL</Acronym> Functions on Composite Types</Title>
...@@ -98,7 +99,7 @@ ...@@ -98,7 +99,7 @@
|Sam | 2400 | |Sam | 2400 |
+-----+-------+ +-----+-------+
</ProgramListing> </ProgramListing>
</para>
<Para> <Para>
Notice the use of the syntax $1.salary. Notice the use of the syntax $1.salary.
Before launching into the subject of functions that Before launching into the subject of functions that
...@@ -122,7 +123,7 @@ ...@@ -122,7 +123,7 @@
|Sam | |Sam |
+----------+ +----------+
</ProgramListing> </ProgramListing>
</para>
<Para> <Para>
As we shall see, however, this is not always the case. As we shall see, however, this is not always the case.
This function notation is important when we want to use This function notation is important when we want to use
...@@ -156,6 +157,7 @@ The target list order must be exactly the same as ...@@ -156,6 +157,7 @@ The target list order must be exactly the same as
that in which the attributes appear in the CREATE that in which the attributes appear in the CREATE
TABLE statement (or when you execute a .* query). TABLE statement (or when you execute a .* query).
</Para> </Para>
</ListItem>
<ListItem> <ListItem>
<Para> <Para>
You must typecast the expressions You must typecast the expressions
...@@ -165,6 +167,7 @@ You must typecast the expressions ...@@ -165,6 +167,7 @@ You must typecast the expressions
WARN::function declared to return type EMP does not retrieve (EMP.*) WARN::function declared to return type EMP does not retrieve (EMP.*)
</ProgramListing> </ProgramListing>
</Para> </Para>
</ListItem>
<ListItem> <ListItem>
<Para> <Para>
When calling a function that returns an instance, we When calling a function that returns an instance, we
...@@ -181,6 +184,7 @@ When calling a function that returns an instance, we ...@@ -181,6 +184,7 @@ When calling a function that returns an instance, we
+-------+ +-------+
</ProgramListing> </ProgramListing>
</Para> </Para>
</ListItem>
<ListItem> <ListItem>
<Para> <Para>
The reason why, in general, we must use the function The reason why, in general, we must use the function
...@@ -194,8 +198,9 @@ The reason why, in general, we must use the function ...@@ -194,8 +198,9 @@ The reason why, in general, we must use the function
WARN:parser: syntax error at or near "." WARN:parser: syntax error at or near "."
</ProgramListing> </ProgramListing>
</Para> </Para>
</ListItem>
</ItemizedList> </ItemizedList>
</para>
<Para> <Para>
Any collection of commands in the <Acronym>SQL</Acronym> query language Any collection of commands in the <Acronym>SQL</Acronym> query language
can be packaged together and defined as a function. can be packaged together and defined as a function.
...@@ -219,6 +224,8 @@ The reason why, in general, we must use the function ...@@ -219,6 +224,8 @@ The reason why, in general, we must use the function
+--+ +--+
</ProgramListing> </ProgramListing>
</Para> </Para>
</sect2>
</sect1>
<Sect1> <Sect1>
<Title>Programming Language Functions</Title> <Title>Programming Language Functions</Title>
...@@ -236,8 +243,11 @@ The reason why, in general, we must use the function ...@@ -236,8 +243,11 @@ The reason why, in general, we must use the function
Base types can have one of three internal formats: Base types can have one of three internal formats:
<ItemizedList> <ItemizedList>
<ListItem><Para>pass by value, fixed-length</Para> <ListItem><Para>pass by value, fixed-length</Para>
</ListItem>
<ListItem><Para>pass by reference, fixed-length</Para> <ListItem><Para>pass by reference, fixed-length</Para>
</ListItem>
<ListItem><Para>pass by reference, variable-length</Para> <ListItem><Para>pass by reference, variable-length</Para>
</ListItem>
</ItemizedList> </ItemizedList>
</Para> </Para>
...@@ -498,6 +508,7 @@ Most of the header (include) files for <ProductName>Postgres</ProductName> ...@@ -498,6 +508,7 @@ Most of the header (include) files for <ProductName>Postgres</ProductName>
</ProgramListing> </ProgramListing>
(where &lt;PORTNAME&gt; is the name of the port, e.g., (where &lt;PORTNAME&gt; is the name of the port, e.g.,
alpha or sparc). alpha or sparc).
</para>
</ListItem> </ListItem>
<ListItem> <ListItem>
<Para> When allocating memory, use the <ProductName>Postgres</ProductName> <Para> When allocating memory, use the <ProductName>Postgres</ProductName>
...@@ -507,6 +518,7 @@ Most of the header (include) files for <ProductName>Postgres</ProductName> ...@@ -507,6 +518,7 @@ Most of the header (include) files for <ProductName>Postgres</ProductName>
automatically at the end of each transaction, automatically at the end of each transaction,
preventing memory leaks. preventing memory leaks.
</Para> </Para>
</ListItem>
<ListItem> <ListItem>
<Para> Always zero the bytes of your structures using <Para> Always zero the bytes of your structures using
memset or bzero. Several routines (such as the memset or bzero. Several routines (such as the
...@@ -517,12 +529,14 @@ Most of the header (include) files for <ProductName>Postgres</ProductName> ...@@ -517,12 +529,14 @@ Most of the header (include) files for <ProductName>Postgres</ProductName>
several bytes of alignment padding (holes in the several bytes of alignment padding (holes in the
structure) that may contain garbage values. structure) that may contain garbage values.
</Para> </Para>
</ListItem>
<ListItem> <ListItem>
<Para> Most of the internal <ProductName>Postgres</ProductName> types are declared <Para> Most of the internal <ProductName>Postgres</ProductName> types are declared
in postgres.h, so it's a good idea to always in postgres.h, so it's a good idea to always
include that file as well. Including postgres.h include that file as well. Including postgres.h
will also include elog.h and palloc.h for you. will also include elog.h and palloc.h for you.
</Para> </Para>
</ListItem>
<ListItem> <ListItem>
<Para> Compiling and loading your object code so that <Para> Compiling and loading your object code so that
it can be dynamically loaded into <ProductName>Postgres</ProductName> it can be dynamically loaded into <ProductName>Postgres</ProductName>
...@@ -534,3 +548,6 @@ Most of the header (include) files for <ProductName>Postgres</ProductName> ...@@ -534,3 +548,6 @@ Most of the header (include) files for <ProductName>Postgres</ProductName>
</ItemizedList> </ItemizedList>
</Para> </Para>
</Sect2> </Sect2>
</sect1>
</chapter>
doc/src/sgml/xindex.sgml
View file @ a75f2d21
...@@ -196,7 +196,7 @@ Strictly speaking, this routine can return a negative ...@@ -196,7 +196,7 @@ Strictly speaking, this routine can return a negative
number (< 0), 0, or a non-zero positive number (> 0). number (< 0), 0, or a non-zero positive number (> 0).
</Para> </Para>
</Note> </Note>
</para>
<Para> <Para>
The <FileName>amstrategies</FileName> entry in pg_am is just the number of The <FileName>amstrategies</FileName> entry in pg_am is just the number of
strategies defined for the access method in question. strategies defined for the access method in question.
......
doc/src/sgml/xplang.sgml
View file @ a75f2d21
...@@ -28,15 +28,14 @@ ...@@ -28,15 +28,14 @@
<Sect1> <Sect1>
<Title>Installing Procedural Languages</Title> <Title>Installing Procedural Languages</Title>
<Para> <Procedure>
<Procedure>
<Title> <Title>
Procedural Language Installation Procedural Language Installation
</Title> </Title>
<para> <para>
A procedural language is installed in the database in three steps. A procedural language is installed in the database in three steps.
</para>
<Step Performance="Required"> <Step Performance="Required">
<Para> <Para>
The shared object for the language handler The shared object for the language handler
...@@ -82,9 +81,9 @@ ...@@ -82,9 +81,9 @@
PL/Tcl are known to be trusted. PL/Tcl are known to be trusted.
</Para> </Para>
</Step> </Step>
</Procedure> </Procedure>
<Para>
<Procedure> <Procedure>
<Title>Example</Title> <Title>Example</Title>
<Step Performance="Required"> <Step Performance="Required">
<Para> <Para>
...@@ -132,7 +131,7 @@ ...@@ -132,7 +131,7 @@
languages are available by default. languages are available by default.
</Para> </Para>
</Step> </Step>
</Procedure> </Procedure>
</Sect1> <!-- **** End of PL installation **** --> </Sect1> <!-- **** End of PL installation **** -->
<!-- ********** <!-- **********
...@@ -367,7 +366,6 @@ ...@@ -367,7 +366,6 @@
<Replaceable>name</Replaceable> ALIAS FOR $n; <Replaceable>name</Replaceable> ALIAS FOR $n;
</Term> </Term>
<ListItem> <ListItem>
<Para>
<Para> <Para>
For better readability of the code it is possible to define an alias For better readability of the code it is possible to define an alias
for a positional parameter to a function. for a positional parameter to a function.
...@@ -385,7 +383,6 @@ ...@@ -385,7 +383,6 @@
RENAME <Replaceable>oldname</Replaceable> TO <Replaceable>newname</Replaceable>; RENAME <Replaceable>oldname</Replaceable> TO <Replaceable>newname</Replaceable>;
</Term> </Term>
<ListItem> <ListItem>
<Para>
<Para> <Para>
Change the name of a variable, record or row. This is useful Change the name of a variable, record or row. This is useful
if NEW or OLD should be referenced by another name inside a if NEW or OLD should be referenced by another name inside a
......
doc/src/sgml/xtypes.sgml
View file @ a75f2d21
...@@ -89,7 +89,7 @@ ...@@ -89,7 +89,7 @@
</Para> </Para>
</ListItem> </ListItem>
</ItemizedList> </ItemizedList>
</para>
<Para> <Para>
To define the <Acronym>complex</Acronym> type, we need to create the two To define the <Acronym>complex</Acronym> type, we need to create the two
user-defined functions complex_in and complex_out user-defined functions complex_in and complex_out
...@@ -125,7 +125,7 @@ ...@@ -125,7 +125,7 @@
them, since the system already understands what they them, since the system already understands what they
look like inside. look like inside.
</Para> </Para>
</sect2>
<Sect2> <Sect2>
<Title>Large Objects</Title> <Title>Large Objects</Title>
...@@ -143,7 +143,7 @@ The actual value that fits depends on the machine architecture. ...@@ -143,7 +143,7 @@ The actual value that fits depends on the machine architecture.
If you require a larger type for something like a document If you require a larger type for something like a document
retrieval system or for storing bitmaps, you will retrieval system or for storing bitmaps, you will
need to use the <ProductName>Postgres</ProductName> large object interface. need to use the <ProductName>Postgres</ProductName> large object interface.
</para>
</Sect2> </Sect2>
</Sect1> </Sect1>
</Chapter> </Chapter>
doc/src/sgml/y2k.sgml
View file @ a75f2d21
<sect1> <sect1>
<title>Y2K Statement</title> <title>Y2K Statement</title>
<para>
<note> <note>
<title>Author</title> <title>Author</title>
...@@ -9,6 +8,7 @@ ...@@ -9,6 +8,7 @@
Written by Written by
<ulink url="mailto:lockhart@alumni.caltech.edu">Thomas Lockhart</ulink> <ulink url="mailto:lockhart@alumni.caltech.edu">Thomas Lockhart</ulink>
on 1998-10-22. on 1998-10-22.
</para>
</note> </note>
<para> <para>
...@@ -16,6 +16,7 @@ The <productname>PostgreSQL</productname> Global Development Team provides ...@@ -16,6 +16,7 @@ The <productname>PostgreSQL</productname> Global Development Team provides
the <productname>Postgres</productname> software code tree as a public service, the <productname>Postgres</productname> software code tree as a public service,
without warranty and without liability for it's behavior or performance. without warranty and without liability for it's behavior or performance.
However, at the time of writing: However, at the time of writing:
</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
...@@ -24,6 +25,8 @@ The author of this statement, a volunteer on the <productname>Postgres</productn ...@@ -24,6 +25,8 @@ The author of this statement, a volunteer on the <productname>Postgres</productn
support team since November, 1996, is not aware of support team since November, 1996, is not aware of
any problems in the <productname>Postgres</productname> code base related any problems in the <productname>Postgres</productname> code base related
to time transitions around Jan 1, 2000 (Y2K). to time transitions around Jan 1, 2000 (Y2K).
</para>
</listitem>
<listitem> <listitem>
<para> <para>
...@@ -33,6 +36,8 @@ or in other field use of recent or current versions ...@@ -33,6 +36,8 @@ or in other field use of recent or current versions
of <productname>Postgres</productname>. We might have expected of <productname>Postgres</productname>. We might have expected
to hear about problems if they existed, given the installed base and to hear about problems if they existed, given the installed base and
the active participation of users on the support mailing lists. the active participation of users on the support mailing lists.
</para>
</listitem>
<listitem> <listitem>
<para> <para>
...@@ -44,12 +49,16 @@ are documented in the current ...@@ -44,12 +49,16 @@ are documented in the current
For two-digit years, the significant transition year is 1970, not 2000; For two-digit years, the significant transition year is 1970, not 2000;
e.g. <quote>70-01-01</quote> is interpreted as <quote>1970-01-01</quote>, e.g. <quote>70-01-01</quote> is interpreted as <quote>1970-01-01</quote>,
whereas <quote>69-01-01</quote> is interpreted as <quote>2069-01-01</quote>. whereas <quote>69-01-01</quote> is interpreted as <quote>2069-01-01</quote>.
</para>
</listitem>
<listitem> <listitem>
<para> <para>
Any Y2K problems in the underlying OS related to obtaining "the Any Y2K problems in the underlying OS related to obtaining "the
current time" may propagate into apparent Y2K problems in current time" may propagate into apparent Y2K problems in
<productname>Postgres</productname>. <productname>Postgres</productname>.
</para>
</listitem>
</itemizedlist> </itemizedlist>
...@@ -60,5 +69,6 @@ and ...@@ -60,5 +69,6 @@ and
<ulink url="http://language.perl.com/news/y2k.html">The Perl Institute</ulink> <ulink url="http://language.perl.com/news/y2k.html">The Perl Institute</ulink>
for further discussion of Y2K issues, particularly for further discussion of Y2K issues, particularly
as it relates to open source, no fee software. as it relates to open source, no fee software.
</para>
</sect1> </sect1>
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment