477 lines
14 KiB
Plaintext
477 lines
14 KiB
Plaintext
<!--
|
|
doc/src/sgml/ref/reindexdb.sgml
|
|
PostgreSQL documentation
|
|
-->
|
|
|
|
<refentry id="app-reindexdb">
|
|
<indexterm zone="app-reindexdb">
|
|
<primary>reindexdb</primary>
|
|
</indexterm>
|
|
|
|
<refmeta>
|
|
<refentrytitle><application>reindexdb</application></refentrytitle>
|
|
<manvolnum>1</manvolnum>
|
|
<refmiscinfo>Application</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>reindexdb</refname>
|
|
<refpurpose>reindex a <productname>PostgreSQL</productname> database</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv>
|
|
<cmdsynopsis>
|
|
<command>reindexdb</command>
|
|
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
|
|
<arg rep="repeat"><replaceable>option</replaceable></arg>
|
|
|
|
<arg choice="plain" rep="repeat">
|
|
<arg choice="opt">
|
|
<group choice="plain">
|
|
<arg choice="plain"><option>-S</option></arg>
|
|
<arg choice="plain"><option>--schema</option></arg>
|
|
</group>
|
|
<replaceable>schema</replaceable>
|
|
</arg>
|
|
</arg>
|
|
|
|
<arg choice="plain" rep="repeat">
|
|
<arg choice="opt">
|
|
<group choice="plain">
|
|
<arg choice="plain"><option>-t</option></arg>
|
|
<arg choice="plain"><option>--table</option></arg>
|
|
</group>
|
|
<replaceable>table</replaceable>
|
|
</arg>
|
|
</arg>
|
|
|
|
<arg choice="plain" rep="repeat">
|
|
<arg choice="opt">
|
|
<group choice="plain">
|
|
<arg choice="plain"><option>-i</option></arg>
|
|
<arg choice="plain"><option>--index</option></arg>
|
|
</group>
|
|
<replaceable>index</replaceable>
|
|
</arg>
|
|
</arg>
|
|
|
|
<arg choice="opt"><replaceable>dbname</replaceable></arg>
|
|
</cmdsynopsis>
|
|
|
|
<cmdsynopsis>
|
|
<command>reindexdb</command>
|
|
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
|
|
<arg rep="repeat"><replaceable>option</replaceable></arg>
|
|
|
|
<group choice="plain">
|
|
<arg choice="plain"><option>-a</option></arg>
|
|
<arg choice="plain"><option>--all</option></arg>
|
|
</group>
|
|
</cmdsynopsis>
|
|
|
|
<cmdsynopsis>
|
|
<command>reindexdb</command>
|
|
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
|
|
<arg rep="repeat"><replaceable>option</replaceable></arg>
|
|
|
|
<group choice="plain">
|
|
<arg choice="plain"><option>-s</option></arg>
|
|
<arg choice="plain"><option>--system</option></arg>
|
|
</group>
|
|
<arg choice="opt"><replaceable>dbname</replaceable></arg>
|
|
</cmdsynopsis>
|
|
</refsynopsisdiv>
|
|
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
|
|
<para>
|
|
<application>reindexdb</application> is a utility for rebuilding indexes
|
|
in a <productname>PostgreSQL</productname> database.
|
|
</para>
|
|
|
|
<para>
|
|
<application>reindexdb</application> is a wrapper around the SQL
|
|
command <link linkend="sql-reindex"><command>REINDEX</command></link>.
|
|
There is no effective difference between reindexing databases via
|
|
this utility and via other methods for accessing the server.
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
|
|
<refsect1>
|
|
<title>Options</title>
|
|
|
|
<para>
|
|
<application>reindexdb</application> accepts the following command-line arguments:
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><option>-a</option></term>
|
|
<term><option>--all</option></term>
|
|
<listitem>
|
|
<para>
|
|
Reindex all databases.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>--concurrently</option></term>
|
|
<listitem>
|
|
<para>
|
|
Use the <literal>CONCURRENTLY</literal> option. See
|
|
<xref linkend="sql-reindex"/>, where all the caveats of this option
|
|
are explained in detail.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option><optional>-d</optional> <replaceable class="parameter">dbname</replaceable></option></term>
|
|
<term><option><optional>--dbname=</optional><replaceable class="parameter">dbname</replaceable></option></term>
|
|
<listitem>
|
|
<para>
|
|
Specifies the name of the database to be reindexed,
|
|
when <option>-a</option>/<option>--all</option> is not used.
|
|
If this is not specified, the database name is read
|
|
from the environment variable <envar>PGDATABASE</envar>. If
|
|
that is not set, the user name specified for the connection is
|
|
used. The <replaceable>dbname</replaceable> can be a <link
|
|
linkend="libpq-connstring">connection string</link>. If so,
|
|
connection string parameters will override any conflicting command
|
|
line options.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>-e</option></term>
|
|
<term><option>--echo</option></term>
|
|
<listitem>
|
|
<para>
|
|
Echo the commands that <application>reindexdb</application> generates
|
|
and sends to the server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>-i <replaceable class="parameter">index</replaceable></option></term>
|
|
<term><option>--index=<replaceable class="parameter">index</replaceable></option></term>
|
|
<listitem>
|
|
<para>
|
|
Recreate <replaceable class="parameter">index</replaceable> only.
|
|
Multiple indexes can be recreated by writing multiple
|
|
<option>-i</option> switches.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>-j <replaceable class="parameter">njobs</replaceable></option></term>
|
|
<term><option>--jobs=<replaceable class="parameter">njobs</replaceable></option></term>
|
|
<listitem>
|
|
<para>
|
|
Execute the reindex commands in parallel by running
|
|
<replaceable class="parameter">njobs</replaceable>
|
|
commands simultaneously. This option may reduce the processing time
|
|
but it also increases the load on the database server.
|
|
</para>
|
|
<para>
|
|
<application>reindexdb</application> will open
|
|
<replaceable class="parameter">njobs</replaceable> connections to the
|
|
database, so make sure your <xref linkend="guc-max-connections"/>
|
|
setting is high enough to accommodate all connections.
|
|
</para>
|
|
<para>
|
|
Note that this option is incompatible with the <option>--index</option>
|
|
and <option>--system</option> options.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>-q</option></term>
|
|
<term><option>--quiet</option></term>
|
|
<listitem>
|
|
<para>
|
|
Do not display progress messages.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>-s</option></term>
|
|
<term><option>--system</option></term>
|
|
<listitem>
|
|
<para>
|
|
Reindex database's system catalogs only.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>-S <replaceable class="parameter">schema</replaceable></option></term>
|
|
<term><option>--schema=<replaceable class="parameter">schema</replaceable></option></term>
|
|
<listitem>
|
|
<para>
|
|
Reindex <replaceable class="parameter">schema</replaceable> only.
|
|
Multiple schemas can be reindexed by writing multiple
|
|
<option>-S</option> switches.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>-t <replaceable class="parameter">table</replaceable></option></term>
|
|
<term><option>--table=<replaceable class="parameter">table</replaceable></option></term>
|
|
<listitem>
|
|
<para>
|
|
Reindex <replaceable class="parameter">table</replaceable> only.
|
|
Multiple tables can be reindexed by writing multiple
|
|
<option>-t</option> switches.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>--tablespace=<replaceable class="parameter">tablespace</replaceable></option></term>
|
|
<listitem>
|
|
<para>
|
|
Specifies the tablespace where indexes are rebuilt. (This name is
|
|
processed as a double-quoted identifier.)
|
|
</para>
|
|
</listitem>
|
|
</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>-V</option></term>
|
|
<term><option>--version</option></term>
|
|
<listitem>
|
|
<para>
|
|
Print the <application>reindexdb</application> version and exit.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>-?</option></term>
|
|
<term><option>--help</option></term>
|
|
<listitem>
|
|
<para>
|
|
Show help about <application>reindexdb</application> command line
|
|
arguments, and exit.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</para>
|
|
|
|
<para>
|
|
<application>reindexdb</application> also accepts
|
|
the following command-line arguments for connection parameters:
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><option>-h <replaceable class="parameter">host</replaceable></option></term>
|
|
<term><option>--host=<replaceable class="parameter">host</replaceable></option></term>
|
|
<listitem>
|
|
<para>
|
|
Specifies the host name of the machine on which the server is
|
|
running. If the value begins with a slash, it is used as the
|
|
directory for the Unix domain socket.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>-p <replaceable class="parameter">port</replaceable></option></term>
|
|
<term><option>--port=<replaceable class="parameter">port</replaceable></option></term>
|
|
<listitem>
|
|
<para>
|
|
Specifies the TCP port or local Unix domain socket file
|
|
extension on which the server
|
|
is listening for connections.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>-U <replaceable class="parameter">username</replaceable></option></term>
|
|
<term><option>--username=<replaceable class="parameter">username</replaceable></option></term>
|
|
<listitem>
|
|
<para>
|
|
User name to connect as.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>-w</option></term>
|
|
<term><option>--no-password</option></term>
|
|
<listitem>
|
|
<para>
|
|
Never issue a password prompt. If the server requires
|
|
password authentication and a password is not available by
|
|
other means such as a <filename>.pgpass</filename> file, the
|
|
connection attempt will fail. This option can be useful in
|
|
batch jobs and scripts where no user is present to enter a
|
|
password.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>-W</option></term>
|
|
<term><option>--password</option></term>
|
|
<listitem>
|
|
<para>
|
|
Force <application>reindexdb</application> to prompt for a
|
|
password before connecting to a database.
|
|
</para>
|
|
|
|
<para>
|
|
This option is never essential, since
|
|
<application>reindexdb</application> will automatically prompt
|
|
for a password if the server demands password authentication.
|
|
However, <application>reindexdb</application> will waste a
|
|
connection attempt finding out that the server wants a password.
|
|
In some cases it is worth typing <option>-W</option> to avoid the extra
|
|
connection attempt.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>--maintenance-db=<replaceable class="parameter">dbname</replaceable></option></term>
|
|
<listitem>
|
|
<para>
|
|
Specifies the name of the database to connect to to discover which
|
|
databases should be reindexed,
|
|
when <option>-a</option>/<option>--all</option> is used.
|
|
If not specified, the <literal>postgres</literal> database will be used,
|
|
or if that does not exist, <literal>template1</literal> will be used.
|
|
This can be a <link linkend="libpq-connstring">connection
|
|
string</link>. If so, connection string parameters will override any
|
|
conflicting command line options. Also, connection string parameters
|
|
other than the database name itself will be re-used when connecting
|
|
to other databases.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
|
|
<refsect1>
|
|
<title>Environment</title>
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><envar>PGDATABASE</envar></term>
|
|
<term><envar>PGHOST</envar></term>
|
|
<term><envar>PGPORT</envar></term>
|
|
<term><envar>PGUSER</envar></term>
|
|
|
|
<listitem>
|
|
<para>
|
|
Default connection parameters
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><envar>PG_COLOR</envar></term>
|
|
<listitem>
|
|
<para>
|
|
Specifies whether to use color in diagnostic messages. Possible values
|
|
are <literal>always</literal>, <literal>auto</literal> and
|
|
<literal>never</literal>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
|
|
<para>
|
|
This utility, like most other <productname>PostgreSQL</productname> utilities,
|
|
also uses the environment variables supported by <application>libpq</application>
|
|
(see <xref linkend="libpq-envars"/>).
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
|
|
<refsect1>
|
|
<title>Diagnostics</title>
|
|
|
|
<para>
|
|
In case of difficulty, see <xref linkend="sql-reindex"/>
|
|
and <xref linkend="app-psql"/> for
|
|
discussions of potential problems and error messages.
|
|
The database server must be running at the
|
|
targeted host. Also, any default connection settings and environment
|
|
variables used by the <application>libpq</application> front-end
|
|
library will apply.
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
|
|
<refsect1>
|
|
<title>Notes</title>
|
|
|
|
<para>
|
|
<application>reindexdb</application> might need to connect several
|
|
times to the <productname>PostgreSQL</productname> server, asking
|
|
for a password each time. It is convenient to have a
|
|
<filename>~/.pgpass</filename> file in such cases. See <xref
|
|
linkend="libpq-pgpass"/> for more information.
|
|
</para>
|
|
</refsect1>
|
|
|
|
|
|
<refsect1>
|
|
<title>Examples</title>
|
|
|
|
<para>
|
|
To reindex the database <literal>test</literal>:
|
|
<screen>
|
|
<prompt>$ </prompt><userinput>reindexdb test</userinput>
|
|
</screen>
|
|
</para>
|
|
|
|
<para>
|
|
To reindex the table <literal>foo</literal> and the index
|
|
<literal>bar</literal> in a database named <literal>abcd</literal>:
|
|
<screen>
|
|
<prompt>$ </prompt><userinput>reindexdb --table=foo --index=bar abcd</userinput>
|
|
</screen></para>
|
|
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>See Also</title>
|
|
|
|
<simplelist type="inline">
|
|
<member><xref linkend="sql-reindex"/></member>
|
|
</simplelist>
|
|
</refsect1>
|
|
|
|
</refentry>
|