Skip to content

P
Postgres FD Implementation
Commit c0865903 authored by Peter Eisentraut's avatar Peter Eisentraut
Browse files
Options

Assorted reference page updates

parent 3379f7b9
Show whitespace changes
Inline Side-by-side
Showing with 570 additions and 563 deletions
doc/src/sgml/ref/clusterdb.sgml
View file @ c0865903
<!-- <!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/clusterdb.sgml,v 1.4 2002/09/21 18:32:54 petere Exp $ $Header: /cvsroot/pgsql/doc/src/sgml/ref/clusterdb.sgml,v 1.5 2002/10/11 23:03:48 petere Exp $
PostgreSQL documentation PostgreSQL documentation
--> -->
...@@ -33,8 +33,8 @@ PostgreSQL documentation ...@@ -33,8 +33,8 @@ PostgreSQL documentation
<title>Description</title> <title>Description</title>
<para> <para>
<application>clusterdb</application> is a utility for re-clustering tables <application>clusterdb</application> is a utility for reclustering tables
in a <productname>PostgreSQL</productname> database. It finds table(s) in a <productname>PostgreSQL</productname> database. It finds tables
that have previously been clustered, and clusters them again on the same that have previously been clustered, and clusters them again on the same
index that was last used. Tables that have never been clustered are not index that was last used. Tables that have never been clustered are not
touched. touched.
...@@ -67,12 +67,22 @@ PostgreSQL documentation ...@@ -67,12 +67,22 @@ PostgreSQL documentation
<title>Options</title> <title>Options</title>
<para> <para>
<application>clusterdb</application> accepts the following command line arguments: <application>clusterdb</application> accepts the following command-line arguments:
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><option>-d <replaceable class="parameter">dbname</replaceable></></term> <term><option>-a</></term>
<term><option>--dbname <replaceable class="parameter">dbname</replaceable></></term> <term><option>--all</></term>
<listitem>
<para>
Cluster all databases.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option><optional>-d</> <replaceable class="parameter">dbname</replaceable></></term>
<term><option><optional>--dbname</> <replaceable class="parameter">dbname</replaceable></></term>
<listitem> <listitem>
<para> <para>
Specifies the name of the database to be clustered. Specifies the name of the database to be clustered.
...@@ -86,11 +96,22 @@ PostgreSQL documentation ...@@ -86,11 +96,22 @@ PostgreSQL documentation
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-a</></term> <term><option>-e</></term>
<term><option>--all</></term> <term><option>--echo</></term>
<listitem> <listitem>
<para> <para>
Cluster all databases. Echo the commands that <application>clusterdb</application> generates
and sends to the server.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-q</></term>
<term><option>--quiet</></term>
<listitem>
<para>
Do not display a response.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
...@@ -110,7 +131,7 @@ PostgreSQL documentation ...@@ -110,7 +131,7 @@ PostgreSQL documentation
<para> <para>
<application>clusterdb</application> also accepts <application>clusterdb</application> also accepts
the following command line arguments for connection parameters: the following command-line arguments for connection parameters:
<variablelist> <variablelist>
<varlistentry> <varlistentry>
...@@ -157,27 +178,6 @@ PostgreSQL documentation ...@@ -157,27 +178,6 @@ PostgreSQL documentation
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><option>-e</></term>
<term><option>--echo</></term>
<listitem>
<para>
Echo the commands that <application>clusterdb</application> generates
and sends to the server.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-q</></term>
<term><option>--quiet</></term>
<listitem>
<para>
Do not display a response.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</para> </para>
</refsect1> </refsect1>
...@@ -250,7 +250,7 @@ PostgreSQL documentation ...@@ -250,7 +250,7 @@ PostgreSQL documentation
<literal>foo</literal> in a database named <literal>foo</literal> in a database named
<literal>xyzzy</literal>: <literal>xyzzy</literal>:
<screen> <screen>
<prompt>$ </prompt><userinput>clusterdb --verbose --table foo xyzzy</userinput> <prompt>$ </prompt><userinput>clusterdb --table foo xyzzy</userinput>
</screen> </screen>
</para> </para>
......
doc/src/sgml/ref/createdb.sgml
View file @ c0865903
<!-- <!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/createdb.sgml,v 1.29 2002/09/21 18:32:54 petere Exp $ $Header: /cvsroot/pgsql/doc/src/sgml/ref/createdb.sgml,v 1.30 2002/10/11 23:03:48 petere Exp $
PostgreSQL documentation PostgreSQL documentation
--> -->
...@@ -59,46 +59,39 @@ PostgreSQL documentation ...@@ -59,46 +59,39 @@ PostgreSQL documentation
<refsect1> <refsect1>
<title>Options</title> <title>Options</title>
<variablelist>
<varlistentry>
<term><option>-h <replaceable class="parameter">host</replaceable></></term>
<term><option>--host <replaceable class="parameter">host</replaceable></></term>
<listitem>
<para> <para>
Specifies the host name of the machine on which the <application>createdb</application> accepts the following command-line arguments:
server is running. If host begins with a slash, it is used
as the directory for the Unix domain socket.
</para>
</listitem>
</varlistentry>
<variablelist>
<varlistentry> <varlistentry>
<term><option>-p <replaceable class="parameter">port</replaceable></></term> <term><replaceable class="parameter">dbname</replaceable></term>
<term><option>--port <replaceable class="parameter">port</replaceable></></term>
<listitem> <listitem>
<para> <para>
Specifies the Internet TCP/IP port or the local Unix domain socket file Specifies the name of the database to be created. The name must be
extension on which the server is listening for connections. unique among all <productname>PostgreSQL</productname> databases in this installation.
The default is to create a database with the same name as the
current system user.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-U <replaceable class="parameter">username</replaceable></></term> <term><replaceable class="parameter">description</replaceable></term>
<term><option>--username <replaceable class="parameter">username</replaceable></></term>
<listitem> <listitem>
<para> <para>
User name to connect as This optionally specifies a comment to be associated with the newly created
database.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-W</></term> <term><option>-D <replaceable class="parameter">location</replaceable></></term>
<term><option>--password</></term> <term><option>--location <replaceable class="parameter">location</replaceable></></term>
<listitem> <listitem>
<para> <para>
Force password prompt. Specifies the alternative location for the database. See also <xref
linkend="app-initlocation">.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
...@@ -115,11 +108,11 @@ PostgreSQL documentation ...@@ -115,11 +108,11 @@ PostgreSQL documentation
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-q</></term> <term><option>-E <replaceable class="parameter">encoding</replaceable></></term>
<term><option>--quiet</></term> <term><option>--encoding <replaceable class="parameter">encoding</replaceable></></term>
<listitem> <listitem>
<para> <para>
Do not display a response. Specifies the character encoding scheme to be used in this database.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
...@@ -135,12 +128,11 @@ PostgreSQL documentation ...@@ -135,12 +128,11 @@ PostgreSQL documentation
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-D <replaceable class="parameter">datadir</replaceable></></term> <term><option>-q</></term>
<term><option>--location <replaceable class="parameter">datadir</replaceable></></term> <term><option>--quiet</></term>
<listitem> <listitem>
<para> <para>
Specifies the alternative location for the database. See also <xref Do not display a response.
linkend="app-initlocation">.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
...@@ -154,53 +146,68 @@ PostgreSQL documentation ...@@ -154,53 +146,68 @@ PostgreSQL documentation
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist>
</para>
<para>
The options <option>-D</option>, <option>-E</option>,
<option>-O</option>, and
<option>-T</option> correspond to options of the underlying
SQL command <xref linkend="SQL-CREATEDATABASE"
endterm="SQL-CREATEDATABASE-title">; see there for more information
about them.
</para>
<para>
<application>createdb</application> also accepts the following
command-line arguments for connection parameters:
<variablelist>
<varlistentry> <varlistentry>
<term><option>-E <replaceable class="parameter">encoding</replaceable></></term> <term><option>-h <replaceable class="parameter">host</replaceable></></term>
<term><option>--encoding <replaceable class="parameter">encoding</replaceable></></term> <term><option>--host <replaceable class="parameter">host</replaceable></></term>
<listitem> <listitem>
<para> <para>
Specifies the character encoding scheme to be used in this database. Specifies the host name of the machine on which the
server is running. If host begins with a slash, it is used
as the directory for the Unix domain socket.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><replaceable class="parameter">dbname</replaceable></term> <term><option>-p <replaceable class="parameter">port</replaceable></></term>
<term><option>--port <replaceable class="parameter">port</replaceable></></term>
<listitem> <listitem>
<para> <para>
Specifies the name of the database to be created. The name must be Specifies the Internet TCP/IP port or the local Unix domain socket file
unique among all <productname>PostgreSQL</productname> databases in this installation. extension on which the server is listening for connections.
The default is to create a database with the same name as the
current system user.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><replaceable class="parameter">description</replaceable></term> <term><option>-U <replaceable class="parameter">username</replaceable></></term>
<term><option>--username <replaceable class="parameter">username</replaceable></></term>
<listitem> <listitem>
<para> <para>
This optionally specifies a comment to be associated with the newly created User name to connect as
database.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> <varlistentry>
<term><option>-W</></term>
<term><option>--password</></term>
<listitem>
<para> <para>
The options <option>-h</option>, <option>-p</option>, <option>-U</option>, Force password prompt.
<option>-W</option>, and <option>-e</option> are passed on literally to
<xref linkend="app-psql">.
The options <option>-O</option>, <option>-D</option>,
<option>-T</option>, and
<option>-E</option> are converted into options for the underlying
SQL command <xref linkend="SQL-CREATEDATABASE"
endterm="SQL-CREATEDATABASE-title">; see there for more information
about them.
</para> </para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1> </refsect1>
......
doc/src/sgml/ref/createlang.sgml
View file @ c0865903
<!-- <!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/createlang.sgml,v 1.27 2002/09/21 18:32:54 petere Exp $ $Header: /cvsroot/pgsql/doc/src/sgml/ref/createlang.sgml,v 1.28 2002/10/11 23:03:48 petere Exp $
PostgreSQL documentation PostgreSQL documentation
--> -->
...@@ -46,7 +46,7 @@ PostgreSQL documentation ...@@ -46,7 +46,7 @@ PostgreSQL documentation
<application>createlang</application> because it performs a number <application>createlang</application> because it performs a number
of checks and is much easier to use. See of checks and is much easier to use. See
<xref linkend="sql-createlanguage" endterm="sql-createlanguage-title"> <xref linkend="sql-createlanguage" endterm="sql-createlanguage-title">
for more. for additional information.
</para> </para>
</refsect1> </refsect1>
...@@ -55,7 +55,7 @@ PostgreSQL documentation ...@@ -55,7 +55,7 @@ PostgreSQL documentation
<title>Options</title> <title>Options</title>
<para> <para>
<application>createlang</application> accepts the following command line arguments: <application>createlang</application> accepts the following command-line arguments:
<variablelist> <variablelist>
<varlistentry> <varlistentry>
...@@ -69,8 +69,8 @@ PostgreSQL documentation ...@@ -69,8 +69,8 @@ PostgreSQL documentation
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-d <replaceable class="parameter">dbname</replaceable></></term> <term><option><optional>-d</> <replaceable class="parameter">dbname</replaceable></></term>
<term><option>--dbname <replaceable class="parameter">dbname</replaceable></></term> <term><option><optional>--dbname</> <replaceable class="parameter">dbname</replaceable></></term>
<listitem> <listitem>
<para> <para>
Specifies to which database the language should be added. Specifies to which database the language should be added.
...@@ -117,7 +117,7 @@ PostgreSQL documentation ...@@ -117,7 +117,7 @@ PostgreSQL documentation
<para> <para>
<application>createlang</application> also accepts <application>createlang</application> also accepts
the following command line arguments for connection parameters: the following command-line arguments for connection parameters:
<variablelist> <variablelist>
<varlistentry> <varlistentry>
......
doc/src/sgml/ref/createuser.sgml
View file @ c0865903
<!-- <!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/createuser.sgml,v 1.28 2002/09/21 18:32:54 petere Exp $ $Header: /cvsroot/pgsql/doc/src/sgml/ref/createuser.sgml,v 1.29 2002/10/11 23:03:48 petere Exp $
PostgreSQL documentation PostgreSQL documentation
--> -->
...@@ -33,7 +33,7 @@ PostgreSQL documentation ...@@ -33,7 +33,7 @@ PostgreSQL documentation
the <literal>pg_shadow</literal> table) can create the <literal>pg_shadow</literal> table) can create
new <productname>PostgreSQL</productname> users, new <productname>PostgreSQL</productname> users,
so <application>createuser</application> must be so <application>createuser</application> must be
invoked by someone who is a <productname>PostgreSQL</productname> invoked by someone who can connect as a <productname>PostgreSQL</productname>
superuser. superuser.
</para> </para>
...@@ -62,49 +62,39 @@ PostgreSQL documentation ...@@ -62,49 +62,39 @@ PostgreSQL documentation
<refsect1> <refsect1>
<title>Options</title> <title>Options</title>
<variablelist>
<varlistentry>
<term><option>-h <replaceable class="parameter">host</replaceable></></term>
<term><option>--host <replaceable class="parameter">host</replaceable></></term>
<listitem>
<para> <para>
Specifies the host name of the machine on which the <application>createuser</> accepts the following command-line arguments:
server
is running. If host begins with a slash, it is used
as the directory for the Unix domain socket.
</para>
</listitem>
</varlistentry>
<variablelist>
<varlistentry> <varlistentry>
<term><option>-p <replaceable class="parameter">port</replaceable></></term> <term><replaceable class="parameter">username</replaceable></term>
<term><option>--port <replaceable class="parameter">port</replaceable></></term>
<listitem> <listitem>
<para> <para>
Specifies the Internet TCP/IP port or local Unix domain socket file Specifies the name of the <productname>PostgreSQL</productname> user to be created.
extension on which the server This name must be unique among all <productname>PostgreSQL</productname> users.
is listening for connections.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-e</></term> <term><option>-a</></term>
<term><option>--echo</></term> <term><option>--adduser</></term>
<listitem> <listitem>
<para> <para>
Echo the queries that <application>createuser</application> generates The new user is allowed to create other users.
and sends to the server. (Note: Actually, this makes the new user a <firstterm>superuser</>.
The option is poorly named.)
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-q</></term> <term><option>-A</></term>
<term><option>--quiet</></term> <term><option>--no-adduser</></term>
<listitem> <listitem>
<para> <para>
Do not display a response. The new user is not allowed to create other users (i.e.,
the new user is a regular user, not a superuser).
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
...@@ -130,24 +120,45 @@ PostgreSQL documentation ...@@ -130,24 +120,45 @@ PostgreSQL documentation
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-a</></term> <term><option>-e</></term>
<term><option>--adduser</></term> <term><option>--echo</></term>
<listitem> <listitem>
<para> <para>
The new user is allowed to create other users. Echo the queries that <application>createuser</application> generates
(Note: Actually, this makes the new user a <firstterm>superuser</>. and sends to the server.
The option is poorly named.)
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-A</></term> <term><option>-E</></term>
<term><option>--no-adduser</></term> <term><option>--encrypted</></term>
<listitem> <listitem>
<para> <para>
The new user is not allowed to create other users (i.e., Encrypts the user's password stored in the database. If not
the new user is a regular user not a superuser). specified, the default is used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-i <replaceable class="parameter">uid</replaceable></></term>
<term><option>--sysid <replaceable class="parameter">uid</replaceable></></term>
<listitem>
<para>
Allows you to pick a non-default user ID for the new user. This is not
necessary, but some people like it.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-N</></term>
<term><option>--unencrypted</></term>
<listitem>
<para>
Does not encrypt the user's password stored in the database. If
not specified, the default is used.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
...@@ -165,59 +176,73 @@ PostgreSQL documentation ...@@ -165,59 +176,73 @@ PostgreSQL documentation
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-i <replaceable class="parameter">uid</replaceable></></term> <term><option>-q</></term>
<term><option>--sysid <replaceable class="parameter">uid</replaceable></></term> <term><option>--quiet</></term>
<listitem> <listitem>
<para> <para>
Allows you to pick a non-default user id for the new user. This is not Do not display a response.
necessary, but some people like it.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist>
</para>
<para>
You will be prompted for a name and other missing information if it
is not specified on the command line.
</para>
<para>
<application>createuser</application> also accepts the following
command-line arguments for connection parameters:
<variablelist>
<varlistentry> <varlistentry>
<term><option>-E</></term> <term><option>-h <replaceable class="parameter">host</replaceable></></term>
<term><option>--encrypted</></term> <term><option>--host <replaceable class="parameter">host</replaceable></></term>
<listitem> <listitem>
<para> <para>
Encrypts the user's password stored in the database. If not Specifies the host name of the machine on which the
specified, the default is used. server
is running. If host begins with a slash, it is used
as the directory for the Unix domain socket.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-N</></term> <term><option>-p <replaceable class="parameter">port</replaceable></></term>
<term><option>--unencrypted</></term> <term><option>--port <replaceable class="parameter">port</replaceable></></term>
<listitem> <listitem>
<para> <para>
Does not encrypt the user's password stored in the database. If Specifies the Internet TCP/IP port or local Unix domain socket file
not specified, the default is used. extension on which the server
is listening for connections.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><replaceable class="parameter">username</replaceable></term> <term><option>-U <replaceable class="parameter">username</replaceable></></term>
<term><option>--username <replaceable class="parameter">username</replaceable></></term>
<listitem> <listitem>
<para> <para>
Specifies the name of the <productname>PostgreSQL</productname> user to be created. User name to connect as (not the user name to create)
This name must be unique among all <productname>PostgreSQL</productname> users.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist>
<varlistentry>
<term><option>-W</></term>
<term><option>--password</></term>
<listitem>
<para> <para>
You will be prompted for a name and other missing information if it is not Force password prompt (to connect to the server, not for the
specified on the command line. password of the new user).
</para> </para>
</listitem>
<para> </varlistentry>
The options <literal>-h</literal>, <literal>-p</literal>, and <literal>-e</literal>, </variablelist>
are passed on literally to <xref linkend="APP-PSQL">. The
<application>psql</application> options <literal>-U</literal> and <literal>-W</literal>
are available as well, but their use can be confusing in this context.
</para> </para>
</refsect1> </refsect1>
......
doc/src/sgml/ref/dropdb.sgml
View file @ c0865903
<!-- <!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropdb.sgml,v 1.18 2002/09/21 18:32:54 petere Exp $ $Header: /cvsroot/pgsql/doc/src/sgml/ref/dropdb.sgml,v 1.19 2002/10/11 23:03:48 petere Exp $
PostgreSQL documentation PostgreSQL documentation
--> -->
...@@ -52,99 +52,104 @@ PostgreSQL documentation ...@@ -52,99 +52,104 @@ PostgreSQL documentation
<refsect1> <refsect1>
<title>Options</title> <title>Options</title>
<para>
<application>dropdb</> accepts the following command-line arguments:
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><option>-h <replaceable class="parameter">host</replaceable></></term> <term><replaceable class="parameter">dbname</replaceable></term>
<term><option>--host <replaceable class="parameter">host</replaceable></></term>
<listitem> <listitem>
<para> <para>
Specifies the host name of the machine on which the Specifies the name of the database to be removed. The database
server must be one of the existing <productname>PostgreSQL</productname> databases
is running. If host begins with a slash, it is used in this installation.
as the directory for the Unix domain socket.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-p <replaceable class="parameter">port</replaceable></></term> <term><option>-e</></term>
<term><option>--port <replaceable class="parameter">port</replaceable></></term> <term><option>--echo</></term>
<listitem> <listitem>
<para> <para>
Specifies the Internet TCP/IP port or local Unix domain socket file Echo the queries that <application>dropdb</application> generates
extension on which the server and sends to the server.
is listening for connections.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-U <replaceable class="parameter">username</replaceable></></term> <term><option>-i</></term>
<term><option>--username <replaceable class="parameter">username</replaceable></></term> <term><option>--interactive</></term>
<listitem> <listitem>
<para> <para>
User name to connect as Issues a verification prompt before doing anything destructive.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-W</></term> <term><option>-q</></term>
<term><option>--password</></term> <term><option>--quiet</></term>
<listitem> <listitem>
<para> <para>
Force password prompt. Do not display a response.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist>
</para>
<para>
<application>createdb</application> also accepts the following
command-line arguments for connection parameters:
<variablelist>
<varlistentry> <varlistentry>
<term><option>-e</></term> <term><option>-h <replaceable class="parameter">host</replaceable></></term>
<term><option>--echo</></term> <term><option>--host <replaceable class="parameter">host</replaceable></></term>
<listitem> <listitem>
<para> <para>
Echo the queries that <application>dropdb</application> generates Specifies the host name of the machine on which the
and sends to the server. server
is running. If host begins with a slash, it is used
as the directory for the Unix domain socket.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-q</></term> <term><option>-p <replaceable class="parameter">port</replaceable></></term>
<term><option>--quiet</></term> <term><option>--port <replaceable class="parameter">port</replaceable></></term>
<listitem> <listitem>
<para> <para>
Do not display a response. Specifies the Internet TCP/IP port or local Unix domain socket file
extension on which the server
is listening for connections.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-i</></term> <term><option>-U <replaceable class="parameter">username</replaceable></></term>
<term><option>--interactive</></term> <term><option>--username <replaceable class="parameter">username</replaceable></></term>
<listitem> <listitem>
<para> <para>
Issues a verification prompt before doing anything destructive. User name to connect as
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><replaceable class="parameter">dbname</replaceable></term> <term><option>-W</></term>
<term><option>--password</></term>
<listitem> <listitem>
<para> <para>
Specifies the name of the database to be removed. The database Force password prompt.
must be one of the existing <productname>PostgreSQL</productname> databases
in this installation.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
<para>
The options <literal>-h</literal>, <literal>-p</literal>, <literal>-U</literal>,
<literal>-W</literal>, and <literal>-e</literal> are passed on literally to
<xref linkend="APP-PSQL">.
</para> </para>
</refsect1> </refsect1>
......
doc/src/sgml/ref/dropuser.sgml
View file @ c0865903
<!-- <!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropuser.sgml,v 1.21 2002/09/21 18:32:54 petere Exp $ $Header: /cvsroot/pgsql/doc/src/sgml/ref/dropuser.sgml,v 1.22 2002/10/11 23:03:48 petere Exp $
PostgreSQL documentation PostgreSQL documentation
--> -->
...@@ -54,39 +54,38 @@ PostgreSQL documentation ...@@ -54,39 +54,38 @@ PostgreSQL documentation
<refsect1> <refsect1>
<title>Options</title> <title>Options</title>
<para>
<application>dropuser</application> accepts the following command-line arguments:
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><option>-h <replaceable class="parameter">host</replaceable></></term> <term><replaceable class="parameter">username</replaceable></term>
<term><option>--host <replaceable class="parameter">host</replaceable></></term>
<listitem> <listitem>
<para> <para>
Specifies the host name of the machine on which the Specifies the name of the <productname>PostgreSQL</productname> user to be removed.
server This name must exist in the <productname>PostgreSQL</productname> installation.
is running. If host begins with a slash, it is used You will be prompted for a name if none is specified on the command line.
as the directory for the Unix domain socket.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-p <replaceable class="parameter">port</replaceable></></term> <term><option>-e</></term>
<term><option>--port <replaceable class="parameter">port</replaceable></></term> <term><option>--echo</></term>
<listitem> <listitem>
<para> <para>
Specifies the Internet TCP/IP port or local Unix domain socket file Echo the queries that <application>dropuser</application> generates
extension on which the server and sends to the server.
is listening for connections.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-e</></term> <term><option>-i</></term>
<term><option>--echo</></term> <term><option>--interactive</></term>
<listitem> <listitem>
<para> <para>
Echo the queries that <application>dropuser</application> generates Prompt for confirmation before actually removing the user.
and sends to the server.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
...@@ -100,34 +99,60 @@ PostgreSQL documentation ...@@ -100,34 +99,60 @@ PostgreSQL documentation
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist>
</para>
<para>
<application>createuser</application> also accepts the following
command-line arguments for connection parameters:
<variablelist>
<varlistentry> <varlistentry>
<term><option>-i</></term> <term><option>-h <replaceable class="parameter">host</replaceable></></term>
<term><option>--interactive</></term> <term><option>--host <replaceable class="parameter">host</replaceable></></term>
<listitem> <listitem>
<para> <para>
Prompt for confirmation before actually removing the user. Specifies the host name of the machine on which the
server
is running. If host begins with a slash, it is used
as the directory for the Unix domain socket.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><replaceable class="parameter">username</replaceable></term> <term><option>-p <replaceable class="parameter">port</replaceable></></term>
<term><option>--port <replaceable class="parameter">port</replaceable></></term>
<listitem> <listitem>
<para> <para>
Specifies the name of the <productname>PostgreSQL</productname> user to be removed. Specifies the Internet TCP/IP port or local Unix domain socket file
This name must exist in the <productname>PostgreSQL</productname> installation. extension on which the server
You will be prompted for a name if none is specified on the command line. is listening for connections.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-U <replaceable class="parameter">username</replaceable></></term>
<term><option>--username <replaceable class="parameter">username</replaceable></></term>
<listitem>
<para>
User name to connect as (not the user name to drop)
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist>
<varlistentry>
<term><option>-W</></term>
<term><option>--password</></term>
<listitem>
<para> <para>
The options <literal>-h</literal>, <literal>-p</literal>, and <literal>-e</literal>, Force password prompt (to connect to the server, not for the
are passed on literally to <xref linkend="APP-PSQL">. The password of the user to be dropped).
<application>psql</application> options <literal>-U</literal> and <literal>-W</literal> </para>
are available as well, but they can be confusing in this context. </listitem>
</varlistentry>
</variablelist>
</para> </para>
</refsect1> </refsect1>
......
doc/src/sgml/ref/initdb.sgml
View file @ c0865903
<!-- <!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/initdb.sgml,v 1.22 2002/09/21 18:32:54 petere Exp $ $Header: /cvsroot/pgsql/doc/src/sgml/ref/initdb.sgml,v 1.23 2002/10/11 23:03:48 petere Exp $
PostgreSQL documentation PostgreSQL documentation
--> -->
...@@ -18,32 +18,12 @@ PostgreSQL documentation ...@@ -18,32 +18,12 @@ PostgreSQL documentation
<refsynopsisdiv> <refsynopsisdiv>
<cmdsynopsis> <cmdsynopsis>
<command>initdb</command> <command>initdb</command>
<arg rep="repeat">options</arg>
<group choice="plain"> <group choice="plain">
<arg>--pgdata </arg> <arg>--pgdata </arg>
<arg>-D </arg> <arg>-D </arg>
<replaceable>directory</replaceable> <replaceable>directory</replaceable>
</group> </group>
<group>
<arg>--username </arg>
<arg>-U </arg>
<replaceable>username</replaceable>
</group>
<group><arg>--pwprompt</arg><arg>-W</arg></group>
<group>
<arg>--encoding </arg>
<arg>-E </arg>
<replaceable>encoding</replaceable>
</group>
<arg>--locale <replaceable>locale</replaceable></arg>
<arg>--lc-collate <replaceable>locale</replaceable></arg>
<arg>--lc-ctype <replaceable>locale</replaceable></arg>
<arg>--lc-messages <replaceable>locale</replaceable></arg>
<arg>--lc-monetary <replaceable>locale</replaceable></arg>
<arg>--lc-numeric <replaceable>locale</replaceable></arg>
<arg>--lc-time <replaceable>locale</replaceable></arg>
<arg>-L <replaceable>directory</replaceable></arg>
<group><arg>--noclean</arg><arg>-n</arg></group>
<group><arg>--debug</arg><arg>-d</arg></group>
</cmdsynopsis> </cmdsynopsis>
</refsynopsisdiv> </refsynopsisdiv>
...@@ -107,15 +87,16 @@ PostgreSQL documentation ...@@ -107,15 +87,16 @@ PostgreSQL documentation
<command>su</command> to become the database user, and <command>su</command> to become the database user, and
finally run <command>initdb</command> as the database user. finally run <command>initdb</command> as the database user.
</para> </para>
</refsect1>
<refsect2> <refsect1>
<title>Options</title> <title>Options</title>
<para> <para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><option>--pgdata=<replaceable class="parameter">directory</replaceable></option></term>
<term><option>-D <replaceable class="parameter">directory</replaceable></option></term> <term><option>-D <replaceable class="parameter">directory</replaceable></option></term>
<term><option>--pgdata=<replaceable class="parameter">directory</replaceable></option></term>
<listitem> <listitem>
<para> <para>
This option specifies the directory where the database system This option specifies the directory where the database system
...@@ -130,37 +111,8 @@ PostgreSQL documentation ...@@ -130,37 +111,8 @@ PostgreSQL documentation
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--username=<replaceable class="parameter">username</replaceable></option></term>
<term><option>-U <replaceable class="parameter">username</replaceable></option></term>
<listitem>
<para>
Selects the user name of the database superuser. This defaults
to the name of the effective user running
<command>initdb</command>. It is really not important what the
superuser's name is, but one might choose to keep the
customary name <systemitem>postgres</systemitem>, even if the operating
system user's name is different.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--pwprompt</option></term>
<term><option>-W</option></term>
<listitem>
<para>
Makes <command>initdb</command> prompt for a password
to give the database superuser. If you don't plan on using password
authentication, this is not important. Otherwise you won't be
able to use password authentication until you have a password
set up.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--encoding=<replaceable class="parameter">encoding</replaceable></option></term>
<term><option>-E <replaceable class="parameter">encoding</replaceable></option></term> <term><option>-E <replaceable class="parameter">encoding</replaceable></option></term>
<term><option>--encoding=<replaceable class="parameter">encoding</replaceable></option></term>
<listitem> <listitem>
<para> <para>
Selects the encoding of the template database. This will also Selects the encoding of the template database. This will also
...@@ -198,6 +150,35 @@ PostgreSQL documentation ...@@ -198,6 +150,35 @@ PostgreSQL documentation
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><option>-U <replaceable class="parameter">username</replaceable></option></term>
<term><option>--username=<replaceable class="parameter">username</replaceable></option></term>
<listitem>
<para>
Selects the user name of the database superuser. This defaults
to the name of the effective user running
<command>initdb</command>. It is really not important what the
superuser's name is, but one might choose to keep the
customary name <systemitem>postgres</systemitem>, even if the operating
system user's name is different.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-W</option></term>
<term><option>--pwprompt</option></term>
<listitem>
<para>
Makes <command>initdb</command> prompt for a password
to give the database superuser. If you don't plan on using password
authentication, this is not important. Otherwise you won't be
able to use password authentication until you have a password
set up.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</para> </para>
...@@ -205,6 +186,20 @@ PostgreSQL documentation ...@@ -205,6 +186,20 @@ PostgreSQL documentation
Other, less commonly used, parameters are also available: Other, less commonly used, parameters are also available:
<variablelist> <variablelist>
<varlistentry>
<term><option>-d</option></term>
<term><option>--debug</option></term>
<listitem>
<para>
Print debugging output from the bootstrap backend and a few other
messages of lesser interest for the general public.
The bootstrap backend is the program <command>initdb</command>
uses to create the catalog tables. This option generates a tremendous
amount of extremely boring output.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><option>-L <replaceable class="parameter">directory</replaceable></option></term> <term><option>-L <replaceable class="parameter">directory</replaceable></option></term>
<listitem> <listitem>
...@@ -230,25 +225,9 @@ PostgreSQL documentation ...@@ -230,25 +225,9 @@ PostgreSQL documentation
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><option>-d</option></term>
<term><option>--debug</option></term>
<listitem>
<para>
Print debugging output from the bootstrap backend and a few other
messages of lesser interest for the general public.
The bootstrap backend is the program <command>initdb</command>
uses to create the catalog tables. This option generates a tremendous
amount of extremely boring output.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</para> </para>
</refsect2>
</refsect1> </refsect1>
<refsect1> <refsect1>
......
doc/src/sgml/ref/initlocation.sgml
View file @ c0865903
<!-- <!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/initlocation.sgml,v 1.16 2002/07/28 15:22:20 petere Exp $ $Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/initlocation.sgml,v 1.17 2002/10/11 23:03:48 petere Exp $
PostgreSQL documentation PostgreSQL documentation
--> -->
...@@ -41,7 +41,6 @@ PostgreSQL documentation ...@@ -41,7 +41,6 @@ PostgreSQL documentation
<refsect1 id="R1-APP-INITLOCATION-2"> <refsect1 id="R1-APP-INITLOCATION-2">
<title>Examples</title> <title>Examples</title>
<informalexample>
<para> <para>
To create a database in an alternate location, using an To create a database in an alternate location, using an
environment variable: environment variable:
...@@ -56,9 +55,7 @@ PostgreSQL documentation ...@@ -56,9 +55,7 @@ PostgreSQL documentation
<prompt>$</prompt> <userinput>createdb -D PGDATA2 testdb</userinput> <prompt>$</prompt> <userinput>createdb -D PGDATA2 testdb</userinput>
</screen> </screen>
</para> </para>
</informalexample>
<informalexample>
<para> <para>
Alternatively, if you allow absolute paths you could write: Alternatively, if you allow absolute paths you could write:
<screen> <screen>
...@@ -66,7 +63,6 @@ PostgreSQL documentation ...@@ -66,7 +63,6 @@ PostgreSQL documentation
<prompt>$</prompt> <userinput>createdb -D /opt/postgres/data/testdb testdb</userinput> <prompt>$</prompt> <userinput>createdb -D /opt/postgres/data/testdb testdb</userinput>
</screen> </screen>
</para> </para>
</informalexample>
</refsect1> </refsect1>
<refsect1> <refsect1>
......
doc/src/sgml/ref/pg_config-ref.sgml
View file @ c0865903
<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_config-ref.sgml,v 1.10 2002/04/21 19:02:39 thomas Exp $ --> <!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_config-ref.sgml,v 1.11 2002/10/11 23:03:48 petere Exp $ -->
<refentry id="app-pgconfig"> <refentry id="app-pgconfig">
<refmeta> <refmeta>
...@@ -60,7 +60,7 @@ ...@@ -60,7 +60,7 @@
<term><option>--includedir</option></> <term><option>--includedir</option></>
<listitem> <listitem>
<para> <para>
Print the location of C and C++ header files of the client interfaces. Print the location of C header files of the client interfaces.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
...@@ -69,7 +69,7 @@ ...@@ -69,7 +69,7 @@
<term><option>--includedir-server</option></> <term><option>--includedir-server</option></>
<listitem> <listitem>
<para> <para>
Print the location of C and C++ header files for server Print the location of C header files for server
programming. programming.
</para> </para>
</listitem> </listitem>
......
doc/src/sgml/ref/pg_ctl-ref.sgml
View file @ c0865903
<!-- <!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_ctl-ref.sgml,v 1.16 2002/09/21 18:32:54 petere Exp $ $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_ctl-ref.sgml,v 1.17 2002/10/11 23:03:48 petere Exp $
PostgreSQL documentation PostgreSQL documentation
--> -->
...@@ -125,9 +125,11 @@ PostgreSQL documentation ...@@ -125,9 +125,11 @@ PostgreSQL documentation
and if so displays the <acronym>PID</acronym> and the command line and if so displays the <acronym>PID</acronym> and the command line
options that were used to invoke it. options that were used to invoke it.
</para> </para>
</refsect1>
<refsect2 id="app-pg-ctl-options"> <refsect1 id="app-pg-ctl-options">
<title>Options</title> <title>Options</title>
<para> <para>
<variablelist> <variablelist>
...@@ -224,7 +226,6 @@ PostgreSQL documentation ...@@ -224,7 +226,6 @@ PostgreSQL documentation
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</para> </para>
</refsect2>
</refsect1> </refsect1>
......
doc/src/sgml/ref/pg_dump.sgml
View file @ c0865903
<!-- <!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.51 2002/09/07 16:14:33 petere Exp $ $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.52 2002/10/11 23:03:48 petere Exp $
PostgreSQL documentation PostgreSQL documentation
--> -->
...@@ -21,27 +21,7 @@ PostgreSQL documentation ...@@ -21,27 +21,7 @@ PostgreSQL documentation
<refsynopsisdiv> <refsynopsisdiv>
<cmdsynopsis> <cmdsynopsis>
<command>pg_dump</command> <command>pg_dump</command>
<group> <arg>-a</arg> <arg>-s</arg> </group> <arg rep="repeat"><replaceable>options</replaceable></arg>
<arg>-b</arg>
<arg>-c</arg>
<arg>-C</arg>
<group> <arg>-d</arg> <arg>-D</arg> </group>
<arg>-f <replaceable>file</replaceable></arg>
<arg>-F <replaceable>format</replaceable></arg>
<arg>-i</arg>
<arg>-o</arg>
<arg>-O</arg>
<arg>-R</arg>
<arg>-S</arg>
<arg>-t <replaceable>table</replaceable></arg>
<arg>-v</arg>
<arg>-x</arg>
<arg>-X <replaceable>keyword</replaceable></arg>
<arg>-Z <replaceable>0...9</replaceable></arg>
<arg>-h <replaceable>host</replaceable></arg>
<arg>-p <replaceable>port</replaceable></arg>
<arg>-U <replaceable>username</replaceable></arg>
<arg>-W</arg>
<arg><replaceable>dbname</replaceable></arg> <arg><replaceable>dbname</replaceable></arg>
</cmdsynopsis> </cmdsynopsis>
</refsynopsisdiv> </refsynopsisdiv>
...@@ -53,42 +33,41 @@ PostgreSQL documentation ...@@ -53,42 +33,41 @@ PostgreSQL documentation
</title> </title>
<para> <para>
<command>pg_dump</command> is a utility for saving a <application>pg_dump</application> is a utility for saving a
<productname>PostgreSQL</productname> database into a script or an <productname>PostgreSQL</productname> database into a script or an
archive file. The script files are in plain-text format and archive file. The script files are in plain-text format and
contain the SQL commands required to reconstruct the database to contain the SQL commands required to reconstruct the database to
the state it was in at the time it was saved. They can be used to the state it was in at the time it was saved. To restore these
scripts, use <xref linkend="app-psql">. They can be used to
reconstruct the database even on other machines and other reconstruct the database even on other machines and other
architectures, with some modifications even on other RDBMS architectures, with some modifications even on other SQL database
products. Furthermore, there are alternative archive file formats that products.
are meant to be </para>
used with <xref linkend="app-pgrestore"> to rebuild the database,
and they also allow <command>pg_restore</command> to be selective <para>
about what is restored, or even to reorder the items prior to being Furthermore, there are alternative archive file formats
restored. The archive files are also designed to be portable across that are meant to be used with <xref linkend="app-pgrestore"> to
rebuild the database, and they also allow
<application>pg_restore</application> to be selective about what is
restored, or even to reorder the items prior to being restored. The
archive files are also designed to be portable across
architectures. architectures.
</para> </para>
<para> <para>
<command>pg_dump</command> will save the information necessary to <application>pg_dump</application> will save the information necessary to
re-generate all user-defined types, functions, tables, indexes, re-generate all user-defined types, functions, tables, indexes,
aggregates, and operators. In addition, all the data is copied out 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 in text format so that it can be readily copied in again, as well
as imported into tools for editing. as imported into tools for editing.
</para> </para>
<para>
<command>pg_dump</command>
is useful for dumping out the contents of a database to move from one
<productname>PostgreSQL</productname> installation to another.
</para>
<para> <para>
When used with one of the archive file formats and combined with When used with one of the archive file formats and combined with
<xref linkend="app-pgrestore">, <command>pg_dump</command> provides a <application>pg_restore</application>, <application>pg_dump</application> provides a
flexible archival and flexible archival and
transfer mechanism. <command>pg_dump</command> can be used to transfer mechanism. <application>pg_dump</application> can be used to
backup an entire database, then <command>pg_restore</command> can backup an entire database, then <application>pg_restore</application> can
be used to examine the archive and/or select which parts of the be used to examine the archive and/or select which parts of the
database are to be restored. database are to be restored.
The most flexible output file format is the <quote>custom</quote> The most flexible output file format is the <quote>custom</quote>
...@@ -107,8 +86,8 @@ PostgreSQL documentation ...@@ -107,8 +86,8 @@ PostgreSQL documentation
</para> </para>
<para> <para>
<command>pg_dump</command> makes consistent backups even if the <application>pg_dump</application> makes consistent backups even if the
database is being used concurrently. <command>pg_dump</command> database is being used concurrently. <application>pg_dump</application>
does not block other users accessing the database (readers or does not block other users accessing the database (readers or
writers). writers).
</para> </para>
...@@ -202,7 +181,7 @@ PostgreSQL documentation ...@@ -202,7 +181,7 @@ PostgreSQL documentation
<para> <para>
Dump data as <command>INSERT</command> commands (rather Dump data as <command>INSERT</command> commands (rather
than <command>COPY</command>). This will make restoration very than <command>COPY</command>). This will make restoration very
slow, but it makes the archives more portable to other RDBMS slow, but it makes the archives more portable to other SQL database
packages. packages.
</para> </para>
</listitem> </listitem>
...@@ -258,7 +237,7 @@ PostgreSQL documentation ...@@ -258,7 +237,7 @@ PostgreSQL documentation
<listitem> <listitem>
<para> <para>
Output a <filename>tar</filename> archive suitable for input into Output a <filename>tar</filename> archive suitable for input into
<command>pg_restore</command>. Using this archive format <application>pg_restore</application>. Using this archive format
allows reordering and/or exclusion of schema elements allows reordering and/or exclusion of schema elements
at the time the database is restored. It is also possible to limit at the time the database is restored. It is also possible to limit
which data is reloaded at restore time. which data is reloaded at restore time.
...@@ -271,7 +250,7 @@ PostgreSQL documentation ...@@ -271,7 +250,7 @@ PostgreSQL documentation
<listitem> <listitem>
<para> <para>
Output a custom archive suitable for input into Output a custom archive suitable for input into
<command>pg_restore</command>. This is the most flexible <application>pg_restore</application>. This is the most flexible
format in that it allows reordering of data load as well format in that it allows reordering of data load as well
as schema elements. This format is also compressed by default. as schema elements. This format is also compressed by default.
</para> </para>
...@@ -324,8 +303,8 @@ PostgreSQL documentation ...@@ -324,8 +303,8 @@ PostgreSQL documentation
<para> <para>
Do not output commands to set the Do not output commands to set the
object ownership to match the original database. Typically, object ownership to match the original database. Typically,
<command>pg_dump</command> issues <application>pg_dump</application> issues
(<command>psql</command>-specific) <command>\connect</command> (<application>psql</application>-specific) <command>\connect</command>
statements to set ownership of schema elements. See also statements to set ownership of schema elements. See also
under <option>-R</option> and <option>-X under <option>-R</option> and <option>-X
use-set-session-authorization</option>. Note that use-set-session-authorization</option>. Note that
...@@ -347,13 +326,13 @@ PostgreSQL documentation ...@@ -347,13 +326,13 @@ PostgreSQL documentation
<term><option>--no-reconnect</option></term> <term><option>--no-reconnect</option></term>
<listitem> <listitem>
<para> <para>
Prohibit <command>pg_dump</command> Prohibit <application>pg_dump</application>
from outputting a script that would require reconnections to from outputting a script that would require reconnections to
the database while being restored. An average restoration the database while being restored. An average restoration
script usually has to reconnect several times as different script usually has to reconnect several times as different
users to set the original ownerships of the objects. This users to set the original ownerships of the objects. This
option is a rather blunt instrument because it makes option is a rather blunt instrument because it makes
<command>pg_dump</command> lose this ownership information, <application>pg_dump</application> lose this ownership information,
<emphasis>unless</emphasis> you use the <option>-X <emphasis>unless</emphasis> you use the <option>-X
use-set-session-authorization</option> option. use-set-session-authorization</option> option.
</para> </para>
...@@ -435,13 +414,13 @@ PostgreSQL documentation ...@@ -435,13 +414,13 @@ PostgreSQL documentation
<listitem> <listitem>
<para> <para>
Normally, if a (plain-text mode) script generated by Normally, if a (plain-text mode) script generated by
<command>pg_dump</command> must alter the current database <application>pg_dump</application> must alter the current database
user (e.g., to set correct object ownerships), it uses the user (e.g., to set correct object ownerships), it uses the
<xref linkend="app-psql"> <command>\connect</command> command. <application>psql</application> <command>\connect</command> command.
This command actually opens a new connection, which might This command actually opens a new connection, which might
require manual interaction (e.g., passwords). If you use the require manual interaction (e.g., passwords). If you use the
<option>-X use-set-session-authorization</option> option, then <option>-X use-set-session-authorization</option> option, then
<command>pg_dump</command> will instead output <xref <application>pg_dump</application> will instead output <xref
linkend="sql-set-session-authorization" endterm="sql-set-session-authorization-title"> commands. This has linkend="sql-set-session-authorization" endterm="sql-set-session-authorization-title"> commands. This has
the same effect, but it requires that the user restoring the the same effect, but it requires that the user restoring the
database from the generated script be a database superuser. database from the generated script be a database superuser.
...@@ -452,7 +431,7 @@ PostgreSQL documentation ...@@ -452,7 +431,7 @@ PostgreSQL documentation
<para> <para>
Since <xref linkend="sql-set-session-authorization" endterm="sql-set-session-authorization-title"> is a Since <xref linkend="sql-set-session-authorization" endterm="sql-set-session-authorization-title"> is a
standard SQL command, whereas <command>\connect</command> only standard SQL command, whereas <command>\connect</command> only
works in <xref linkend="app-psql">, this option also enhances works in <application>psql</application>, this option also enhances
the theoretical portability of the output script. the theoretical portability of the output script.
</para> </para>
...@@ -470,7 +449,7 @@ PostgreSQL documentation ...@@ -470,7 +449,7 @@ PostgreSQL documentation
<listitem> <listitem>
<para> <para>
This option is only relevant when creating a data-only dump. This option is only relevant when creating a data-only dump.
It instructs <command>pg_dump</command> to include commands It instructs <application>pg_dump</application> to include commands
to temporarily disable triggers on the target tables while to temporarily disable triggers on the target tables while
the data is reloaded. Use this if you have referential the data is reloaded. Use this if you have referential
integrity checks or other triggers on the tables that you integrity checks or other triggers on the tables that you
...@@ -591,22 +570,21 @@ PostgreSQL documentation ...@@ -591,22 +570,21 @@ PostgreSQL documentation
<msg> <msg>
<msgmain> <msgmain>
<msgtext> <msgtext>
<screen><computeroutput> <screen>
Connection to database 'template1' failed. Connection to database 'template1' failed.
connectDBStart() -- connect() failed: No such file or directory connectDBStart() -- connect() failed: No such file or directory
Is the postmaster running locally Is the postmaster running locally
and accepting connections on Unix socket '/tmp/.s.PGSQL.5432'? and accepting connections on Unix socket '/tmp/.s.PGSQL.5432'?
</computeroutput></screen> </screen>
</msgtext> </msgtext>
</msgmain> </msgmain>
</msg> </msg>
<msgexplan> <msgexplan>
<para> <para>
<command>pg_dump</command> could not attach to the <application>pg_dump</application> could not attach to the
<command>postmaster</command> PostgreSQL server on the specified host and port. If you see this message,
process on the specified host and port. If you see this message, ensure that the server
ensure that the <command>postmaster</command>
is running on the proper host and that you have specified the proper is running on the proper host and that you have specified the proper
port. port.
</para> </para>
...@@ -617,9 +595,9 @@ connectDBStart() -- connect() failed: No such file or directory ...@@ -617,9 +595,9 @@ connectDBStart() -- connect() failed: No such file or directory
<note> <note>
<para> <para>
<command>pg_dump</command> internally executes <application>pg_dump</application> internally executes
<command>SELECT</command> statements. If you have problems running <command>SELECT</command> statements. If you have problems running
<command>pg_dump</command>, <application>pg_dump</application>,
make sure you are able to select information from the database using, for make sure you are able to select information from the database using, for
example, <xref linkend="app-psql">. example, <xref linkend="app-psql">.
</para> </para>
...@@ -632,23 +610,23 @@ connectDBStart() -- connect() failed: No such file or directory ...@@ -632,23 +610,23 @@ connectDBStart() -- connect() failed: No such file or directory
<para> <para>
If your installation has any local additions to the template1 database, If your installation has any local additions to the template1 database,
be careful to restore the output of <command>pg_dump</command> into a be careful to restore the output of <application>pg_dump</application> into a
truly empty database; otherwise you are likely to get errors due to truly empty database; otherwise you are likely to get errors due to
duplicate definitions of the added objects. To make an empty database duplicate definitions of the added objects. To make an empty database
without any local additions, copy from template0 not template1, without any local additions, copy from template0 not template1,
for example: for example:
<programlisting> <programlisting>
CREATE DATABASE foo WITH TEMPLATE = template0; CREATE DATABASE foo WITH TEMPLATE template0;
</programlisting> </programlisting>
</para> </para>
<para> <para>
<command>pg_dump</command> has a few limitations: <application>pg_dump</application> has a few limitations:
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
When dumping a single table or as plain text, <command>pg_dump</command> When dumping a single table or as plain text, <application>pg_dump</application>
does not handle large objects. Large objects must be dumped in their does not handle large objects. Large objects must be dumped in their
entirety using one of the binary archive formats. entirety using one of the binary archive formats.
</para> </para>
...@@ -656,7 +634,7 @@ CREATE DATABASE foo WITH TEMPLATE = template0; ...@@ -656,7 +634,7 @@ CREATE DATABASE foo WITH TEMPLATE = template0;
<listitem> <listitem>
<para> <para>
When doing a data only dump, <command>pg_dump</command> emits queries When doing a data only dump, <application>pg_dump</application> emits queries
to disable triggers on user tables before inserting the data and queries to to disable triggers on user tables before inserting the data and queries to
re-enable them after the data has been inserted. If the restore is stopped re-enable them after the data has been inserted. If the restore is stopped
in the middle, the system catalogs may be left in the wrong state. in the middle, the system catalogs may be left in the wrong state.
...@@ -717,7 +695,7 @@ CREATE DATABASE foo WITH TEMPLATE = template0; ...@@ -717,7 +695,7 @@ CREATE DATABASE foo WITH TEMPLATE = template0;
<title>History</title> <title>History</title>
<para> <para>
The <command>pg_dump</command> utility first appeared in The <application>pg_dump</application> utility first appeared in
<application>Postgres95</application> release <literal>0.02</literal>. The <application>Postgres95</application> release <literal>0.02</literal>. The
non-plain-text output formats were introduced in non-plain-text output formats were introduced in
<application>PostgreSQL</application> release <literal>7.1</literal>. <application>PostgreSQL</application> release <literal>7.1</literal>.
......
doc/src/sgml/ref/pg_restore.sgml
View file @ c0865903
<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.30 2002/08/10 16:57:31 petere Exp $ --> <!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.31 2002/10/11 23:03:48 petere Exp $ -->
<refentry id="APP-PGRESTORE"> <refentry id="APP-PGRESTORE">
<docinfo> <docinfo>
...@@ -22,43 +22,16 @@ ...@@ -22,43 +22,16 @@
<refsynopsisdiv> <refsynopsisdiv>
<cmdsynopsis> <cmdsynopsis>
<command>pg_restore</command> <command>pg_restore</command>
<arg> -a </arg> <arg rep="repeat"><replaceable>options</replaceable></arg>
<arg> -c </arg>
<arg> -C </arg>
<arg> -d <replaceable class="parameter">dbname</replaceable> </arg>
<arg> -f <replaceable class="parameter">output-file</replaceable> </arg>
<arg> -F <replaceable class="parameter">format</replaceable> </arg>
<arg> -i </arg>
<arg> -I <replaceable class="parameter">index</replaceable> </arg>
<arg> -l </arg>
<arg> -L <replaceable class="parameter">contents-file</replaceable> </arg>
<group> <arg> -N </arg> <arg> -o </arg> <arg> -r </arg> </group>
<arg> -O </arg>
<arg> -P <replaceable class="parameter">function-name(argtype [, ...])</replaceable> </arg>
<arg> -R </arg>
<arg> -s </arg>
<arg> -S </arg>
<arg> -t <replaceable class="parameter">table</replaceable> </arg>
<arg> -T <replaceable class="parameter">trigger</replaceable> </arg>
<arg> -v </arg>
<arg> -x </arg>
<arg> -X <replaceable>keyword</replaceable></arg>
<arg> -h <replaceable class="parameter">host</replaceable> </arg>
<arg> -p <replaceable class="parameter">port</replaceable> </arg>
<arg> -U <replaceable>username</replaceable> </arg>
<arg> -W </arg>
<arg> <replaceable class="parameter">archive-file</replaceable> </arg>
</cmdsynopsis> </cmdsynopsis>
</refsynopsisdiv> </refsynopsisdiv>
<refsect1 id="app-pgrestore-description"> <refsect1 id="app-pgrestore-description">
<title> <title>Description</title>
Description
</title>
<para> <para>
<command>pg_restore</command> is a utility for restoring a <application>pg_restore</application> is a utility for restoring a
<productname>PostgreSQL</productname> database from an archive <productname>PostgreSQL</productname> database from an archive
created by <xref linkend="app-pgdump"> in one of the non-plain-text created by <xref linkend="app-pgdump"> in one of the non-plain-text
formats. It formats. It
...@@ -69,36 +42,35 @@ ...@@ -69,36 +42,35 @@
<para> <para>
The archive files contain information for The archive files contain information for
<command>pg_restore</command> to rebuild the database, but also <application>pg_restore</application> to rebuild the database, but also
allow <command>pg_restore</command> to be selective about what is allow <application>pg_restore</application> to be selective about what is
restored, or even to reorder the items prior to being restored. The restored, or even to reorder the items prior to being restored. The
archive files are designed to be portable across architectures. archive files are designed to be portable across architectures.
</para> </para>
<para> <para>
<command>pg_restore</command> can operate in two modes: If a <application>pg_restore</application> can operate in two modes: If a
database name is specified, the archive is restored directly into database name is specified, the archive is restored directly into
the database. Otherwise, a script containing the SQL commands the database. Otherwise, a script containing the SQL commands
necessary to rebuild the database is created (and written to a file necessary to rebuild the database is created (and written to a file
or standard output), similar to the ones created by the or standard output), similar to the ones created by the
<command>pg_dump</command> plain text format. Some of the options <application>pg_dump</application> plain text format. Some of the options
controlling the script output are therefore analogous to controlling the script output are therefore analogous to
<command>pg_dump</command> options. <application>pg_dump</application> options.
</para> </para>
<para> <para>
Obviously, <command>pg_restore</command> cannot restore information Obviously, <application>pg_restore</application> cannot restore information
that is not present in the archive file; for instance, if the that is not present in the archive file; for instance, if the
archive was made using the <quote>dump data as archive was made using the <quote>dump data as
<command>INSERT</command>s</quote> option, <command>INSERT</command>s</quote> option,
<command>pg_restore</command> will not be able to load the data <application>pg_restore</application> will not be able to load the data
using <command>COPY</command> statements. using <command>COPY</command> statements.
</para> </para>
</refsect1>
<refsect2 id="app-pgrestore-options"> <refsect1 id="app-pgrestore-options">
<title> <title>Options</title>
Options
</title>
<para> <para>
<command>pg_restore</command> accepts the following command <command>pg_restore</command> accepts the following command
...@@ -140,11 +112,11 @@ ...@@ -140,11 +112,11 @@
<term><option>--create</option></term> <term><option>--create</option></term>
<listitem> <listitem>
<para> <para>
Create the database before restoring into it. Create the database before restoring into it. (When this
(When this switch appears, the database named with <option>-d</option> switch appears, the database named with <option>-d</option> is
is used only used only to issue the initial <literal>CREATE DATABASE</>
to issue the initial CREATE DATABASE command. All data is restored command. All data is restored into the database name that
into the database name that appears in the archive.) appears in the archive.)
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
...@@ -154,8 +126,10 @@ ...@@ -154,8 +126,10 @@
<term><option>--dbname=<replaceable class="parameter">dbname</replaceable></option></term> <term><option>--dbname=<replaceable class="parameter">dbname</replaceable></option></term>
<listitem> <listitem>
<para> <para>
Connect to database <replaceable class="parameter">dbname</replaceable> and restore Connect to database <replaceable
directly into the database. Large objects can only be restored by using a direct database connection. class="parameter">dbname</replaceable> and restore directly
into the database. Large objects can only be restored by using
a direct database connection.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
...@@ -166,7 +140,8 @@ ...@@ -166,7 +140,8 @@
<listitem> <listitem>
<para> <para>
Specify output file for generated script, or for the listing Specify output file for generated script, or for the listing
when used with <option>-l</option>. Default is the standard output. when used with <option>-l</option>. Default is the standard
output.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
...@@ -176,20 +151,21 @@ ...@@ -176,20 +151,21 @@
<term><option>--format=<replaceable class="parameter">format</replaceable></option></term> <term><option>--format=<replaceable class="parameter">format</replaceable></option></term>
<listitem> <listitem>
<para> <para>
Specify format of the archive. Specify format of the archive. It is not necessary to specify
It is not necessary to specify the format, since <COMMAND>pg_restore</COMMAND> will the format, since <application>pg_restore</application> will
determine the format automatically. If specified, it can be one of the following: determine the format automatically. If specified, it can be
one of the following:
</para> </para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term>t</term> <term>t</term>
<listitem> <listitem>
<para> <para>
Archive is a <filename>tar</filename> archive. Using this archive format allows reordering and/or Archive is a <filename>tar</filename> archive. Using this
exclusion of schema elements at the time the database is restored. It is also possible to limit which archive format allows reordering and/or exclusion of schema
data is reloaded at restore time. elements at the time the database is restored. It is also
possible to limit which data is reloaded at restore time.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
...@@ -198,15 +174,15 @@ ...@@ -198,15 +174,15 @@
<term>c</term> <term>c</term>
<listitem> <listitem>
<para> <para>
Archive is in the custom format of <command>pg_dump</command>. This is the most flexible format Archive is in the custom format of
in that it allows reordering of data load as well as schema elements. <application>pg_dump</application>. This is the most
This format is also compressed by default. flexible format in that it allows reordering of data load
as well as schema elements. This format is also compressed
by default.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</listitem> </listitem>
</varlistentry> </varlistentry>
...@@ -225,7 +201,8 @@ ...@@ -225,7 +201,8 @@
<term><option>--index=<replaceable class="parameter">index</replaceable></option></term> <term><option>--index=<replaceable class="parameter">index</replaceable></option></term>
<listitem> <listitem>
<para> <para>
Restore definition for named <replaceable class="parameter">index</replaceable> only. Restore definition for named <replaceable
class="parameter">index</replaceable> only.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
...@@ -235,8 +212,9 @@ ...@@ -235,8 +212,9 @@
<term><option>--list</option></term> <term><option>--list</option></term>
<listitem> <listitem>
<para> <para>
List the contents of the archive. The output of this command can be used with the <option>-L</option> option List the contents of the archive. The output of this command
to restrict and reorder the items that are restored. can be used with the <option>-L</option> option to restrict
and reorder the items that are restored.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
...@@ -246,8 +224,10 @@ ...@@ -246,8 +224,10 @@
<term><option>--use-list=<replaceable class="parameter">list-file</replaceable></option></term> <term><option>--use-list=<replaceable class="parameter">list-file</replaceable></option></term>
<listitem> <listitem>
<para> <para>
Restore elements in <REPLACEABLE CLASS="PARAMETER">list-file</REPLACEABLE> only, and in the Restore elements in <REPLACEABLE
order they appear in the file. Lines can be moved and may also be commented out by placing a <literal>;</literal> at the CLASS="PARAMETER">list-file</REPLACEABLE> only, and in the
order they appear in the file. Lines can be moved and may also
be commented out by placing a <literal>;</literal> at the
start of the line. start of the line.
</para> </para>
</listitem> </listitem>
...@@ -258,8 +238,11 @@ ...@@ -258,8 +238,11 @@
<term><option>--orig-order</option></term> <term><option>--orig-order</option></term>
<listitem> <listitem>
<para> <para>
Restore items in the original dump order. By default <command>pg_dump</command> will dump items in an order convenient Restore items in the original dump order. By default
to <command>pg_dump</command>, then save the archive in a modified OID order. This option overrides the OID ordering. <application>pg_dump</application> will dump items in an order
convenient to <application>pg_dump</application>, then save the
archive in a modified OID order. This option overrides the OID
ordering.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
...@@ -269,8 +252,11 @@ ...@@ -269,8 +252,11 @@
<term><option>--oid-order</option></term> <term><option>--oid-order</option></term>
<listitem> <listitem>
<para> <para>
Restore items in the OID order. By default <command>pg_dump</command> will dump items in an order convenient Restore items in the OID order. By default
to <command>pg_dump</command>, then save the archive in a modified OID order. This option enforces strict OID ordering. <application>pg_dump</application> will dump items in an order
convenient to <application>pg_dump</application>, then save the
archive in a modified OID order. This option enforces strict
OID ordering.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
...@@ -280,8 +266,9 @@ ...@@ -280,8 +266,9 @@
<term><option>--no-owner</option></term> <term><option>--no-owner</option></term>
<listitem> <listitem>
<para> <para>
Prevent any attempt to restore original object ownership. Objects will be owned by the user name used Prevent any attempt to restore original object
to attach to the database. ownership. Objects will be owned by the user name used to
attach to the database.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
...@@ -301,10 +288,13 @@ ...@@ -301,10 +288,13 @@
<term><option>--rearrange</option></term> <term><option>--rearrange</option></term>
<listitem> <listitem>
<para> <para>
Restore items in modified OID order. By default <command>pg_dump</command> will dump items in an order convenient Restore items in modified OID order. By default
to <command>pg_dump</command>, then save the archive in a modified OID order. Most objects <application>pg_dump</application> will dump items in an order
will be restored in OID order, but some things (e.g., rules and indexes) will be restored at the end of convenient to <application>pg_dump</application>, then save the
the process irrespective of their OIDs. This option is the default. archive in a modified OID order. Most objects will be restored
in OID order, but some things (e.g., rules and indexes) will
be restored at the end of the process irrespective of their
OIDs. This option is the default.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
...@@ -314,18 +304,18 @@ ...@@ -314,18 +304,18 @@
<term><option>--no-reconnect</option></term> <term><option>--no-reconnect</option></term>
<listitem> <listitem>
<para> <para>
While restoring an archive, <command>pg_restore</command> While restoring an archive, <application>pg_restore</application>
typically has to reconnect to the database several times with typically has to reconnect to the database several times with
different user names to set the correct ownership of the different user names to set the correct ownership of the
created objects. If this is undesirable (e.g., because manual created objects. If this is undesirable (e.g., because manual
interaction (passwords) would be necessary for each interaction (passwords) would be necessary for each
reconnection), this option prevents reconnection), this option prevents
<command>pg_restore</command> from issuing any reconnection <application>pg_restore</application> from issuing any reconnection
requests. (A connection request while in plain text mode, not requests. (A connection request while in plain text mode, not
connected to a database, is made by putting out a <xref connected to a database, is made by putting out a <xref
linkend="app-psql"> <command>\connect</command> command.) linkend="app-psql"> <command>\connect</command> command.)
However, this option is a rather blunt instrument because it However, this option is a rather blunt instrument because it
makes <command>pg_restore</command> lose all object ownership makes <application>pg_restore</application> lose all object ownership
information, <emphasis>unless</emphasis> you use the information, <emphasis>unless</emphasis> you use the
<option>-X use-set-session-authorization</option> option. <option>-X use-set-session-authorization</option> option.
</para> </para>
...@@ -404,7 +394,7 @@ ...@@ -404,7 +394,7 @@
ownerships), a new connection to the database must be opened, ownerships), a new connection to the database must be opened,
which might require manual interaction (e.g., passwords). If which might require manual interaction (e.g., passwords). If
you use the <option>-X use-set-session-authorization</option> option, you use the <option>-X use-set-session-authorization</option> option,
then <command>pg_restore</command> will instead use the <xref then <application>pg_restore</application> will instead use the <xref
linkend="sql-set-session-authorization"> command. This has linkend="sql-set-session-authorization"> command. This has
the same effect, but it requires that the user restoring the the same effect, but it requires that the user restoring the
archive is a database superuser. This option effectively archive is a database superuser. This option effectively
...@@ -419,7 +409,7 @@ ...@@ -419,7 +409,7 @@
<listitem> <listitem>
<para> <para>
This option is only relevant when performing a data-only restore. This option is only relevant when performing a data-only restore.
It instructs <command>pg_restore</command> to execute commands It instructs <application>pg_restore</application> to execute commands
to temporarily disable triggers on the target tables while to temporarily disable triggers on the target tables while
the data is reloaded. Use this if you have referential the data is reloaded. Use this if you have referential
integrity checks or other triggers on the tables that you integrity checks or other triggers on the tables that you
...@@ -431,7 +421,7 @@ ...@@ -431,7 +421,7 @@
must be done as superuser. So, you should also specify must be done as superuser. So, you should also specify
a superuser name with <option>-S</>, or preferably specify a superuser name with <option>-S</>, or preferably specify
<option>--use-set-session-authorization</> and run <option>--use-set-session-authorization</> and run
<command>pg_restore</command> as a superuser. <application>pg_restore</application> as a PostgreSQL superuser.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
...@@ -449,10 +439,9 @@ ...@@ -449,10 +439,9 @@
<term><option>--host=<replaceable class="parameter">host</replaceable></option></term> <term><option>--host=<replaceable class="parameter">host</replaceable></option></term>
<listitem> <listitem>
<para> <para>
Specifies the host name of the machine on which the Specifies the host name of the machine on which the server is
server running. If host begins with a slash, it is used as the
is running. If host begins with a slash, it is used directory for the Unix domain socket.
as the directory for the Unix domain socket.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
...@@ -462,11 +451,10 @@ ...@@ -462,11 +451,10 @@
<term><option>--port=<replaceable class="parameter">port</replaceable></option></term> <term><option>--port=<replaceable class="parameter">port</replaceable></option></term>
<listitem> <listitem>
<para> <para>
Specifies the Internet TCP/IP port or local Unix domain socket file Specifies the Internet TCP/IP port or local Unix domain socket
extension on which the server file extension on which the server is listening for
is listening for connections. The port number defaults to 5432, connections. The port number defaults to 5432, or the value
or the value of the <envar>PGPORT</envar> of the <envar>PGPORT</envar> environment variable (if set).
environment variable (if set).
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
...@@ -491,8 +479,6 @@ ...@@ -491,8 +479,6 @@
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</para> </para>
</refsect2>
</refsect1> </refsect1>
...@@ -523,20 +509,20 @@ ...@@ -523,20 +509,20 @@
<msg> <msg>
<msgmain> <msgmain>
<msgtext> <msgtext>
<screen><computeroutput> <screen>
Connection to database 'template1' failed. Connection to database 'template1' failed.
connectDBStart() -- connect() failed: No such file or directory connectDBStart() -- connect() failed: No such file or directory
Is the postmaster running locally Is the postmaster running locally
and accepting connections on Unix socket '/tmp/.s.PGSQL.5432'? and accepting connections on Unix socket '/tmp/.s.PGSQL.5432'?
</computeroutput></screen> </screen>
</msgtext> </msgtext>
</msgmain> </msgmain>
</msg> </msg>
<msgexplan> <msgexplan>
<para> <para>
<command>pg_restore</command> could not attach to the <application>pg_restore</application> could not attach to the
<command>postmaster</command> PostgreSQL server
process on the specified host and port. If you see this message, process on the specified host and port. If you see this message,
ensure that the server ensure that the server
is running on the proper host and that you have specified the proper is running on the proper host and that you have specified the proper
...@@ -549,40 +535,39 @@ connectDBStart() -- connect() failed: No such file or directory ...@@ -549,40 +535,39 @@ connectDBStart() -- connect() failed: No such file or directory
<note> <note>
<para> <para>
When a direct database connection is specified using the -d option, <command>pg_restore</command> When a direct database connection is specified using the -d
internally executes <command>SQL</command> statements. If you have problems running option, <application>pg_restore</application> internally executes
<command>pg_restore</command>, SQL statements. If you have problems running
make sure you are able to select information from the database using, for <application>pg_restore</application>, make sure you are able to select
example, <command>psql</command>. information from the database using, for example,
<application>psql</application>.
</para> </para>
</note> </note>
</refsect1> </refsect1>
<refsect1 id="app-pgrestore-notes"> <refsect1 id="app-pgrestore-notes">
<title> <title>Notes</title>
Notes
</title>
<para> <para>
If your installation has any local additions to the template1 database, If your installation has any local additions to the
be careful to load the output of <command>pg_restore</command> into a <literal>template1</> database, be careful to load the output of
truly empty database; otherwise you are likely to get errors due to <application>pg_restore</application> into a truly empty database;
duplicate definitions of the added objects. To make an empty database otherwise you are likely to get errors due to duplicate definitions
without any local additions, copy from template0 not template1, of the added objects. To make an empty database without any local
for example: additions, copy from template0 not template1, for example:
<programlisting> <programlisting>
CREATE DATABASE foo WITH TEMPLATE = template0; CREATE DATABASE foo WITH TEMPLATE = template0;
</programlisting> </programlisting>
</para> </para>
<para> <para>
The limitations of <command>pg_restore</command> are detailed below. The limitations of <application>pg_restore</application> are detailed below.
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
When restoring data to a pre-existing table, <command>pg_restore</command> emits queries When restoring data to a pre-existing table, <application>pg_restore</application> emits queries
to disable triggers on user tables before inserting the data then emits queries to to disable triggers on user tables before inserting the data then emits queries to
re-enable them after the data has been inserted. If the restore is stopped in the re-enable them after the data has been inserted. If the restore is stopped in the
middle, the system catalogs may be left in the wrong state. middle, the system catalogs may be left in the wrong state.
...@@ -591,7 +576,7 @@ CREATE DATABASE foo WITH TEMPLATE = template0; ...@@ -591,7 +576,7 @@ CREATE DATABASE foo WITH TEMPLATE = template0;
<listitem> <listitem>
<para> <para>
<command>pg_restore</command> will not restore large objects for a single table. If <application>pg_restore</application> will not restore large objects for a single table. If
an archive contains large objects, then all large objects will be restored. an archive contains large objects, then all large objects will be restored.
</para> </para>
</listitem> </listitem>
...@@ -600,16 +585,14 @@ CREATE DATABASE foo WITH TEMPLATE = template0; ...@@ -600,16 +585,14 @@ CREATE DATABASE foo WITH TEMPLATE = template0;
</para> </para>
<para> <para>
See the <xref linkend="app-pgdump"> documentation for details on See also the <xref linkend="app-pgdump"> documentation for details on
limitations of <command>pg_dump</command>. limitations of <application>pg_dump</application>.
</para> </para>
</refsect1> </refsect1>
<refsect1 id="app-pgrestore-examples"> <refsect1 id="app-pgrestore-examples">
<title> <title>Examples</title>
Examples
</title>
<para> <para>
To dump a database: To dump a database:
...@@ -701,7 +684,7 @@ CREATE DATABASE foo WITH TEMPLATE = template0; ...@@ -701,7 +684,7 @@ CREATE DATABASE foo WITH TEMPLATE = template0;
<title>History</title> <title>History</title>
<para> <para>
The <command>pg_restore</command> utility first appeared in The <application>pg_restore</application> utility first appeared in
PostgreSQL 7.1. PostgreSQL 7.1.
</para> </para>
</refsect1> </refsect1>
......
doc/src/sgml/ref/postgres-ref.sgml
View file @ c0865903
<!-- <!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/postgres-ref.sgml,v 1.27 2002/07/28 15:22:21 petere Exp $ $Header: /cvsroot/pgsql/doc/src/sgml/ref/postgres-ref.sgml,v 1.28 2002/10/11 23:03:48 petere Exp $
PostgreSQL documentation PostgreSQL documentation
--> -->
...@@ -101,14 +101,15 @@ PostgreSQL documentation ...@@ -101,14 +101,15 @@ PostgreSQL documentation
<para> <para>
When running a stand-alone backend, the session user will be set to When running a stand-alone backend, the session user will be set to
the user with id 1. This user does not actually have to exist, so the user with ID 1. This user does not actually have to exist, so
a stand-alone backend can be used to manually recover from certain a stand-alone backend can be used to manually recover from certain
kinds of accidental damage to the system catalogs. Implicit kinds of accidental damage to the system catalogs. Implicit
superuser powers are granted to the user with id 1 in stand-alone superuser powers are granted to the user with ID 1 in stand-alone
mode. mode.
</para> </para>
</refsect1>
<refsect2> <refsect1>
<title>Options</title> <title>Options</title>
<para> <para>
...@@ -131,7 +132,7 @@ PostgreSQL documentation ...@@ -131,7 +132,7 @@ PostgreSQL documentation
<application>postgres</application> command-line options. <application>postgres</application> command-line options.
</para> </para>
<refsect3> <refsect2>
<title>General Purpose</title> <title>General Purpose</title>
<para> <para>
...@@ -210,9 +211,9 @@ PostgreSQL documentation ...@@ -210,9 +211,9 @@ PostgreSQL documentation
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</refsect3> </refsect2>
<refsect3> <refsect2>
<title>Options for stand-alone mode</title> <title>Options for stand-alone mode</title>
<variablelist> <variablelist>
...@@ -244,9 +245,9 @@ PostgreSQL documentation ...@@ -244,9 +245,9 @@ PostgreSQL documentation
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</refsect3> </refsect2>
<refsect3> <refsect2>
<title>Semi-internal Options</title> <title>Semi-internal Options</title>
<para> <para>
...@@ -345,7 +346,6 @@ PostgreSQL documentation ...@@ -345,7 +346,6 @@ PostgreSQL documentation
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</refsect3>
</refsect2> </refsect2>
</refsect1> </refsect1>
......
doc/src/sgml/ref/postmaster.sgml
View file @ c0865903
<!-- <!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/postmaster.sgml,v 1.32 2002/09/21 18:32:54 petere Exp $ $Header: /cvsroot/pgsql/doc/src/sgml/ref/postmaster.sgml,v 1.33 2002/10/11 23:03:48 petere Exp $
PostgreSQL documentation PostgreSQL documentation
--> -->
...@@ -72,9 +72,11 @@ PostgreSQL documentation ...@@ -72,9 +72,11 @@ PostgreSQL documentation
communication ports (see below). A data area is created with <xref communication ports (see below). A data area is created with <xref
linkend="app-initdb">. linkend="app-initdb">.
</para> </para>
</refsect1>
<refsect2 id="app-postmaster-options"> <refsect1 id="app-postmaster-options">
<title>Options</title> <title>Options</title>
<para> <para>
<application>postmaster</application> accepts the following <application>postmaster</application> accepts the following
command line arguments. For a detailed discussion of the options command line arguments. For a detailed discussion of the options
...@@ -336,7 +338,6 @@ PostgreSQL documentation ...@@ -336,7 +338,6 @@ PostgreSQL documentation
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</para> </para>
</refsect2>
</refsect1> </refsect1>
...@@ -580,6 +581,15 @@ StreamServerPort: cannot bind to port ...@@ -580,6 +581,15 @@ StreamServerPort: cannot bind to port
</para> </para>
</tip> </tip>
</refsect1> </refsect1>
<refsect1>
<title>See Also</title>
<para>
<xref linkend="app-initdb">,
<xref linkend="app-pg-ctl">
</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/ref/psql-ref.sgml
View file @ c0865903
<!-- <!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/psql-ref.sgml,v 1.77 2002/09/22 20:44:22 tgl Exp $ $Header: /cvsroot/pgsql/doc/src/sgml/ref/psql-ref.sgml,v 1.78 2002/10/11 23:03:48 petere Exp $
PostgreSQL documentation PostgreSQL documentation
--> -->
...@@ -43,12 +43,6 @@ PostgreSQL documentation ...@@ -43,12 +43,6 @@ PostgreSQL documentation
<refsect1 id="R1-APP-PSQL-3"> <refsect1 id="R1-APP-PSQL-3">
<title>Options</title> <title>Options</title>
<para>
If so configured, <application>psql</application> understands both
standard Unix short options, and <acronym>GNU</acronym>-style long
options. The latter are not available on all systems.
</para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><option>-a</></term> <term><option>-a</></term>
...@@ -452,6 +446,10 @@ PostgreSQL documentation ...@@ -452,6 +446,10 @@ PostgreSQL documentation
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
<para>
Long options are not available on all platforms.
</para>
</refsect1> </refsect1>
......
doc/src/sgml/ref/vacuumdb.sgml
View file @ c0865903
<!-- <!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/vacuumdb.sgml,v 1.26 2002/09/21 18:32:54 petere Exp $ $Header: /cvsroot/pgsql/doc/src/sgml/ref/vacuumdb.sgml,v 1.27 2002/10/11 23:03:48 petere Exp $
PostgreSQL documentation PostgreSQL documentation
--> -->
...@@ -75,12 +75,12 @@ PostgreSQL documentation ...@@ -75,12 +75,12 @@ PostgreSQL documentation
<title>Options</title> <title>Options</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><option>-d <replaceable class="parameter">dbname</replaceable></option></term> <term><option><optional>-d</> <replaceable class="parameter">dbname</replaceable></option></term>
<term><option>--dbname <replaceable class="parameter">dbname</replaceable></option></term> <term><option><optional>--dbname</> <replaceable class="parameter">dbname</replaceable></option></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.
...@@ -103,32 +103,34 @@ PostgreSQL documentation ...@@ -103,32 +103,34 @@ PostgreSQL documentation
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-f</option></term> <term><option>-e</></term>
<term><option>--full</option></term> <term><option>--echo</></term>
<listitem> <listitem>
<para> <para>
Perform <quote>full</quote> vacuuming. Echo the commands that <application>vacuumdb</application> generates
and sends to the server.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-v</option></term> <term><option>-f</option></term>
<term><option>--verbose</option></term> <term><option>--full</option></term>
<listitem> <listitem>
<para> <para>
Print detailed information during processing. Perform <quote>full</quote> vacuuming.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-z</option></term> <term><option>-q</></term>
<term><option>--analyze</option></term> <term><option>--quiet</></term>
<listitem> <listitem>
<para> <para>
Calculate statistics for use by the optimizer. Do not display a response.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
...@@ -151,12 +153,31 @@ PostgreSQL documentation ...@@ -151,12 +153,31 @@ PostgreSQL documentation
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><option>-v</option></term>
<term><option>--verbose</option></term>
<listitem>
<para>
Print detailed information during processing.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-z</option></term>
<term><option>--analyze</option></term>
<listitem>
<para>
Calculate statistics for use by the optimizer.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</para> </para>
<para> <para>
<application>vacuumdb</application> also accepts <application>vacuumdb</application> also accepts
the following command line arguments for connection parameters: the following command-line arguments for connection parameters:
<variablelist> <variablelist>
<varlistentry> <varlistentry>
...@@ -203,27 +224,6 @@ PostgreSQL documentation ...@@ -203,27 +224,6 @@ PostgreSQL documentation
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><option>-e</></term>
<term><option>--echo</></term>
<listitem>
<para>
Echo the commands that <application>vacuumdb</application> generates
and sends to the server.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-q</></term>
<term><option>--quiet</></term>
<listitem>
<para>
Do not display a response.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</para> </para>
</refsect1> </refsect1>
......
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