<!--

$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

-->

<title>Description</title>

<para>

<application>clusterdb</application> is a utility forre-clustering tables

in a <productname>PostgreSQL</productname> database. It findstable(s)

<application>clusterdb</application> is a utility forreclustering tables

in a <productname>PostgreSQL</productname> database. It findstables

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

touched.

<title>Options</title>

<para>

<application>clusterdb</application> accepts the following commandline arguments:

<application>clusterdb</application> accepts the following command-line arguments:

<variablelist>

<varlistentry>

<term><option>-d <replaceable class="parameter">dbname</replaceable></></term>

<term><option>--dbname <replaceable class="parameter">dbname</replaceable></></term>

<term><option>-a</></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>

<para>

Specifies the name of the database to be clustered.

</varlistentry>

<varlistentry>

<term><option>-a</></term>

<term><option>--all</></term>

<term><option>-e</></term>

<term><option>--echo</></term>

<listitem>

<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>

</listitem>

</varlistentry>

<para>

<application>clusterdb</application> also accepts

the following commandline arguments for connection parameters:

the following command-line arguments for connection parameters:

<variablelist>

<varlistentry>

<term><option>-h <replaceable class="parameter">host</replaceable></></term>

</para>

</listitem>

</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>

</para>

</refsect1>

<literal>foo</literal> in a database named

<literal>xyzzy</literal>:

<screen>

<prompt>$ </prompt><userinput>clusterdb --verbose --table foo xyzzy</userinput>

<prompt>$ </prompt><userinput>clusterdb --table foo xyzzy</userinput>

</screen>

</para>

<!--

$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

-->

<refsect1>

<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>

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>

</listitem>

</varlistentry>

<para>

<application>createdb</application> accepts the following command-line arguments:

<variablelist>

<varlistentry>

<term><option>-p <replaceable class="parameter">port</replaceable></></term>

<term><option>--port <replaceable class="parameter">port</replaceable></></term>

<term><replaceable class="parameter">dbname</replaceable></term>

<listitem>

<para>

Specifies the Internet TCP/IP port or the local Unix domain socket file

extension on which the server is listening for connections.

Specifies the name of the database to be created. The name must be

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>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-U <replaceable class="parameter">username</replaceable></></term>

<term><option>--username <replaceable class="parameter">username</replaceable></></term>

<term><replaceable class="parameter">description</replaceable></term>

<listitem>

<para>

User name to connect as

This optionally specifies a comment to be associated with the newly created

database.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-W</></term>

<term><option>--password</></term>

<term><option>-D <replaceable class="parameter">location</replaceable></></term>

<term><option>--location <replaceable class="parameter">location</replaceable></></term>

<listitem>

<para>

Force password prompt.

Specifies the alternative location for the database. See also <xref

linkend="app-initlocation">.

</para>

</listitem>

</varlistentry>

</varlistentry>

<varlistentry>

<term><option>-q</></term>

<term><option>--quiet</></term>

<term><option>-E <replaceable class="parameter">encoding</replaceable></></term>

<term><option>--encoding <replaceable class="parameter">encoding</replaceable></></term>

<listitem>

<para>

Do not display a response.

Specifies the character encoding scheme to be used in this database.

</para>

</listitem>

</varlistentry>

</varlistentry>

<varlistentry>

<term><option>-D <replaceable class="parameter">datadir</replaceable></></term>

<term><option>--location <replaceable class="parameter">datadir</replaceable></></term>

<term><option>-q</></term>

<term><option>--quiet</></term>

<listitem>

<para>

Specifies the alternative location for the database. See also <xref

linkend="app-initlocation">.

Do not display a response.

</para>

</listitem>

</varlistentry>

</para>

</listitem>

</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>

<term><option>-E <replaceable class="parameter">encoding</replaceable></></term>

<term><option>--encoding <replaceable class="parameter">encoding</replaceable></></term>

<term><option>-h <replaceable class="parameter">host</replaceable></></term>

<term><option>--host <replaceable class="parameter">host</replaceable></></term>

<listitem>

<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>

</listitem>

</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>

<para>

Specifies the name of the database to be created. The name must be

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.

Specifies the Internet TCP/IP port or the local Unix domain socket file

extension on which the server is listening for connections.

</para>

</listitem>

</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>

<para>

This optionally specifies a comment to be associated with the newly created

database.

User name to connect as

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-W</></term>

<term><option>--password</></term>

<listitem>

<para>

Force password prompt.

</para>

</listitem>

</varlistentry>

</variablelist>

<para>

The options <option>-h</option>, <option>-p</option>, <option>-U</option>,

<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>

</refsect1>

<!--

$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

-->

<application>createlang</application> because it performs a number

of checks and is much easier to use. See

<xref linkend="sql-createlanguage" endterm="sql-createlanguage-title">

formore.

foradditional information.

</para>

</refsect1>

<title>Options</title>

<para>

<application>createlang</application> accepts the following commandline arguments:

<application>createlang</application> accepts the following command-line arguments:

<variablelist>

<varlistentry>

</varlistentry>

<varlistentry>

<term><option>-d <replaceable class="parameter">dbname</replaceable></></term>

<term><option>--dbname <replaceable class="parameter">dbname</replaceable></></term>

<term><option><optional>-d</> <replaceable class="parameter">dbname</replaceable></></term>

<term><option><optional>--dbname</> <replaceable class="parameter">dbname</replaceable></></term>

<listitem>

<para>

Specifies to which database the language should be added.

<para>

<application>createlang</application> also accepts

the following commandline arguments for connection parameters:

the following command-line arguments for connection parameters:

<variablelist>

<varlistentry>