2005-07-29 17:13:11 +02:00
|
|
|
<!--
|
2010-09-20 22:08:53 +02:00
|
|
|
doc/src/sgml/ref/reindexdb.sgml
|
2005-07-29 17:13:11 +02:00
|
|
|
PostgreSQL documentation
|
|
|
|
|
-->
|
|
|
|
|
|
2017-10-20 03:16:39 +02:00
|
|
|
<refentry id="app-reindexdb">
|
2014-02-24 03:25:35 +01:00
|
|
|
<indexterm zone="app-reindexdb">
|
|
|
|
|
<primary>reindexdb</primary>
|
|
|
|
|
</indexterm>
|
|
|
|
|
|
2005-07-29 17:13:11 +02:00
|
|
|
<refmeta>
|
2010-04-03 09:23:02 +02:00
|
|
|
<refentrytitle><application>reindexdb</application></refentrytitle>
|
2005-07-29 17:13:11 +02:00
|
|
|
<manvolnum>1</manvolnum>
|
|
|
|
|
<refmiscinfo>Application</refmiscinfo>
|
|
|
|
|
</refmeta>
|
|
|
|
|
|
|
|
|
|
<refnamediv>
|
2020-03-07 14:04:09 +01:00
|
|
|
<refname>reindexdb</refname>
|
2005-07-29 17:13:11 +02:00
|
|
|
<refpurpose>reindex a <productname>PostgreSQL</productname> database</refpurpose>
|
|
|
|
|
</refnamediv>
|
|
|
|
|
|
|
|
|
|
<refsynopsisdiv>
|
|
|
|
|
<cmdsynopsis>
|
|
|
|
|
<command>reindexdb</command>
|
|
|
|
|
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
|
2015-05-15 14:45:55 +02:00
|
|
|
<arg rep="repeat"><replaceable>option</replaceable></arg>
|
2016-12-17 18:00:00 +01:00
|
|
|
|
2014-12-08 16:28:00 +01:00
|
|
|
<arg choice="plain" rep="repeat">
|
|
|
|
|
<arg choice="opt">
|
|
|
|
|
<group choice="plain">
|
|
|
|
|
<arg choice="plain"><option>-S</option></arg>
|
2020-12-03 16:28:58 +01:00
|
|
|
<arg choice="plain"><option>--schema</option></arg>
|
2014-12-08 16:28:00 +01:00
|
|
|
</group>
|
2015-05-09 20:45:54 +02:00
|
|
|
<replaceable>schema</replaceable>
|
2014-12-08 16:28:00 +01:00
|
|
|
</arg>
|
|
|
|
|
</arg>
|
|
|
|
|
|
2013-01-17 11:24:47 +01:00
|
|
|
<arg choice="plain" rep="repeat">
|
|
|
|
|
<arg choice="opt">
|
|
|
|
|
<group choice="plain">
|
|
|
|
|
<arg choice="plain"><option>-t</option></arg>
|
2020-12-03 16:28:58 +01:00
|
|
|
<arg choice="plain"><option>--table</option></arg>
|
2013-01-17 11:24:47 +01:00
|
|
|
</group>
|
|
|
|
|
<replaceable>table</replaceable>
|
|
|
|
|
</arg>
|
|
|
|
|
</arg>
|
|
|
|
|
|
|
|
|
|
<arg choice="plain" rep="repeat">
|
|
|
|
|
<arg choice="opt">
|
|
|
|
|
<group choice="plain">
|
|
|
|
|
<arg choice="plain"><option>-i</option></arg>
|
2020-12-03 16:28:58 +01:00
|
|
|
<arg choice="plain"><option>--index</option></arg>
|
2013-01-17 11:24:47 +01:00
|
|
|
</group>
|
|
|
|
|
<replaceable>index</replaceable>
|
|
|
|
|
</arg>
|
|
|
|
|
</arg>
|
|
|
|
|
|
reindexdb: Allow specifying objects to process in all databases.
Presently, reindexdb's --table, --schema, --index, and --system
options cannot be used together with --all, i.e., you cannot
specify objects to process in all databases. This commit removes
this unnecessary restriction. Furthermore, it removes the
restriction that --system cannot be used with --table, --schema,
and --index. There is no such restriction for the latter options,
and there is no technical reason to disallow these combinations.
Reviewed-by: Kyotaro Horiguchi, Dean Rasheed
Discussion: https://postgr.es/m/20230628232402.GA1954626%40nathanxps13
2024-03-11 21:42:27 +01:00
|
|
|
<arg choice="plain">
|
|
|
|
|
<arg choice="opt">
|
|
|
|
|
<group choice="plain">
|
|
|
|
|
<arg choice="plain"><option>-s</option></arg>
|
|
|
|
|
<arg choice="plain"><option>--system</option></arg>
|
|
|
|
|
</group>
|
|
|
|
|
</arg>
|
|
|
|
|
</arg>
|
2015-05-15 14:45:55 +02:00
|
|
|
|
reindexdb: Allow specifying objects to process in all databases.
Presently, reindexdb's --table, --schema, --index, and --system
options cannot be used together with --all, i.e., you cannot
specify objects to process in all databases. This commit removes
this unnecessary restriction. Furthermore, it removes the
restriction that --system cannot be used with --table, --schema,
and --index. There is no such restriction for the latter options,
and there is no technical reason to disallow these combinations.
Reviewed-by: Kyotaro Horiguchi, Dean Rasheed
Discussion: https://postgr.es/m/20230628232402.GA1954626%40nathanxps13
2024-03-11 21:42:27 +01:00
|
|
|
<arg choice="opt">
|
|
|
|
|
<group choice="plain">
|
|
|
|
|
<arg choice="plain"><replaceable>dbname</replaceable></arg>
|
|
|
|
|
<arg choice="plain"><option>-a</option></arg>
|
|
|
|
|
<arg choice="plain"><option>--all</option></arg>
|
|
|
|
|
</group>
|
|
|
|
|
</arg>
|
2005-07-29 17:13:11 +02:00
|
|
|
</cmdsynopsis>
|
|
|
|
|
</refsynopsisdiv>
|
2010-11-23 21:27:50 +01:00
|
|
|
|
2005-07-29 17:13:11 +02:00
|
|
|
|
|
|
|
|
<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
|
Improve <xref> vs. <command> formatting in the documentation
SQL commands are generally marked up as <command>, except when a link
to a reference page is used using <xref>. But the latter doesn't
create monospace markup, so this looks strange especially when a
paragraph contains a mix of links and non-links.
We considered putting <command> in the <refentrytitle> on the target
side, but that creates some formatting side effects elsewhere.
Generally, it seems safer to solve this on the link source side.
We can't put the <xref> inside the <command>; the DTD doesn't allow
this. DocBook 5 would allow the <command> to have the linkend
attribute itself, but we are not there yet.
So to solve this for now, convert the <xref>s to <link> plus
<command>. This gives the correct look and also gives some more
flexibility what we can put into the link text (e.g., subcommands or
other clauses). In the future, these could then be converted to
DocBook 5 style.
I haven't converted absolutely all xrefs to SQL command reference
pages, only those where we care about the appearance of the link text
or where it was otherwise appropriate to make the appearance match a
bit better. Also in some cases, the links where repetitive, so in
those cases the links where just removed and replaced by a plain
<command>. In cases where we just want the link and don't
specifically care about the generated link text (typically phrased
"for further information see <xref ...>") the xref is kept.
Reported-by: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
Discussion: https://www.postgresql.org/message-id/flat/87o8pco34z.fsf@wibble.ilmari.org
2020-10-03 16:16:51 +02:00
|
|
|
command <link linkend="sql-reindex"><command>REINDEX</command></link>.
|
2005-07-29 17:13:11 +02:00
|
|
|
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:
|
2010-11-23 21:27:50 +01:00
|
|
|
|
2005-07-29 17:13:11 +02:00
|
|
|
<variablelist>
|
|
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>-a</option></term>
|
|
|
|
|
<term><option>--all</option></term>
|
2005-07-29 17:13:11 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2007-02-22 00:21:12 +01:00
|
|
|
Reindex all databases.
|
2005-07-29 17:13:11 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2019-03-29 08:25:20 +01:00
|
|
|
<varlistentry>
|
|
|
|
|
<term><option>--concurrently</option></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2020-05-31 03:48:21 +02:00
|
|
|
Use the <literal>CONCURRENTLY</literal> option. See
|
|
|
|
|
<xref linkend="sql-reindex"/>, where all the caveats of this option
|
|
|
|
|
are explained in detail.
|
2019-03-29 08:25:20 +01:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2005-07-29 17:13:11 +02:00
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option><optional>-d</optional> <replaceable class="parameter">dbname</replaceable></option></term>
|
|
|
|
|
<term><option><optional>--dbname=</optional><replaceable class="parameter">dbname</replaceable></option></term>
|
2005-07-29 17:13:11 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
Fix connection string handling in src/bin/scripts/ programs.
When told to process all databases, clusterdb, reindexdb, and vacuumdb
would reconnect by replacing their --maintenance-db parameter with the
name of the target database. If that parameter is a connstring (which
has been allowed for a long time, though we failed to document that
before this patch), we'd lose any other options it might specify, for
example SSL or GSS parameters, possibly resulting in failure to connect.
Thus, this is the same bug as commit a45bc8a4f fixed in pg_dump and
pg_restore. We can fix it in the same way, by using libpq's rules for
handling multiple "dbname" parameters to add the target database name
separately. I chose to apply the same refactoring approach as in that
patch, with a struct to handle the command line parameters that need to
be passed through to connectDatabase. (Maybe someday we can unify the
very similar functions here and in pg_dump/pg_restore.)
Per Peter Eisentraut's comments on bug #16604. Back-patch to all
supported branches.
Discussion: https://postgr.es/m/16604-933f4b8791227b15@postgresql.org
2020-10-20 01:03:46 +02:00
|
|
|
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
|
2007-06-04 12:02:40 +02:00
|
|
|
from the environment variable <envar>PGDATABASE</envar>. If
|
|
|
|
|
that is not set, the user name specified for the connection is
|
2020-10-03 04:19:31 +02:00
|
|
|
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.
|
2005-07-29 17:13:11 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>-e</option></term>
|
|
|
|
|
<term><option>--echo</option></term>
|
2005-07-29 17:13:11 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2007-06-04 12:02:40 +02:00
|
|
|
Echo the commands that <application>reindexdb</application> generates
|
|
|
|
|
and sends to the server.
|
2005-07-29 17:13:11 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>-i <replaceable class="parameter">index</replaceable></option></term>
|
|
|
|
|
<term><option>--index=<replaceable class="parameter">index</replaceable></option></term>
|
2005-07-29 17:13:11 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2007-02-22 00:21:12 +01:00
|
|
|
Recreate <replaceable class="parameter">index</replaceable> only.
|
2013-01-17 11:24:47 +01:00
|
|
|
Multiple indexes can be recreated by writing multiple
|
2017-10-09 03:44:17 +02:00
|
|
|
<option>-i</option> switches.
|
2005-07-29 17:13:11 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2019-07-27 15:21:18 +02:00
|
|
|
<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>
|
2020-09-21 18:43:42 +02:00
|
|
|
commands simultaneously. This option may reduce the processing time
|
|
|
|
|
but it also increases the load on the database server.
|
2019-07-27 15:21:18 +02:00
|
|
|
</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>
|
2024-03-25 01:07:14 +01:00
|
|
|
Note that this option is incompatible with the <option>--system</option> option.
|
2019-07-27 15:21:18 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2005-07-29 17:13:11 +02:00
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>-q</option></term>
|
|
|
|
|
<term><option>--quiet</option></term>
|
2005-07-29 17:13:11 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2007-06-04 12:02:40 +02:00
|
|
|
Do not display progress messages.
|
2005-07-29 17:13:11 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>-s</option></term>
|
|
|
|
|
<term><option>--system</option></term>
|
2005-07-29 17:13:11 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2021-10-27 16:20:02 +02:00
|
|
|
Reindex database's system catalogs only.
|
2005-07-29 17:13:11 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2014-12-08 16:28:00 +01:00
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>-S <replaceable class="parameter">schema</replaceable></option></term>
|
|
|
|
|
<term><option>--schema=<replaceable class="parameter">schema</replaceable></option></term>
|
2014-12-08 16:28:00 +01:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
|
|
|
|
Reindex <replaceable class="parameter">schema</replaceable> only.
|
|
|
|
|
Multiple schemas can be reindexed by writing multiple
|
2017-10-09 03:44:17 +02:00
|
|
|
<option>-S</option> switches.
|
2014-12-08 16:28:00 +01:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2005-07-29 17:13:11 +02:00
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>-t <replaceable class="parameter">table</replaceable></option></term>
|
|
|
|
|
<term><option>--table=<replaceable class="parameter">table</replaceable></option></term>
|
2005-07-29 17:13:11 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2007-06-04 12:02:40 +02:00
|
|
|
Reindex <replaceable class="parameter">table</replaceable> only.
|
2013-01-17 11:24:47 +01:00
|
|
|
Multiple tables can be reindexed by writing multiple
|
2017-10-09 03:44:17 +02:00
|
|
|
<option>-t</option> switches.
|
2005-07-29 17:13:11 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
2010-02-19 15:36:45 +01:00
|
|
|
|
2021-03-03 02:14:21 +01:00
|
|
|
<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>
|
|
|
|
|
|
2015-05-15 14:45:55 +02:00
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>-v</option></term>
|
|
|
|
|
<term><option>--verbose</option></term>
|
2015-05-15 14:45:55 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
|
|
|
|
Print detailed information during processing.
|
|
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2010-02-19 15:36:45 +01:00
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>-V</option></term>
|
|
|
|
|
<term><option>--version</option></term>
|
2010-02-19 15:36:45 +01:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
|
|
|
|
Print the <application>reindexdb</application> version and exit.
|
|
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>-?</option></term>
|
|
|
|
|
<term><option>--help</option></term>
|
2010-02-19 15:36:45 +01:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
|
|
|
|
Show help about <application>reindexdb</application> command line
|
|
|
|
|
arguments, and exit.
|
|
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
</variablelist>
|
|
|
|
|
|
2005-07-29 17:13:11 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
<para>
|
2010-11-23 21:27:50 +01:00
|
|
|
<application>reindexdb</application> also accepts
|
2005-07-29 17:13:11 +02:00
|
|
|
the following command-line arguments for connection parameters:
|
|
|
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>-h <replaceable class="parameter">host</replaceable></option></term>
|
|
|
|
|
<term><option>--host=<replaceable class="parameter">host</replaceable></option></term>
|
2005-07-29 17:13:11 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2007-02-22 00:21:12 +01:00
|
|
|
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.
|
2005-07-29 17:13:11 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>-p <replaceable class="parameter">port</replaceable></option></term>
|
|
|
|
|
<term><option>--port=<replaceable class="parameter">port</replaceable></option></term>
|
2005-07-29 17:13:11 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2010-11-23 21:27:50 +01:00
|
|
|
Specifies the TCP port or local Unix domain socket file
|
2007-02-22 00:21:12 +01:00
|
|
|
extension on which the server
|
|
|
|
|
is listening for connections.
|
2005-07-29 17:13:11 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>-U <replaceable class="parameter">username</replaceable></option></term>
|
|
|
|
|
<term><option>--username=<replaceable class="parameter">username</replaceable></option></term>
|
2005-07-29 17:13:11 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
|
|
|
|
User name to connect as.
|
|
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2009-02-26 17:02:39 +01:00
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>-w</option></term>
|
|
|
|
|
<term><option>--no-password</option></term>
|
2009-02-26 17:02:39 +01:00
|
|
|
<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>
|
|
|
|
|
|
2005-07-29 17:13:11 +02:00
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>-W</option></term>
|
|
|
|
|
<term><option>--password</option></term>
|
2005-07-29 17:13:11 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2007-12-11 20:57:32 +01:00
|
|
|
Force <application>reindexdb</application> to prompt for a
|
2010-11-23 21:27:50 +01:00
|
|
|
password before connecting to a database.
|
2007-12-11 20:57:32 +01:00
|
|
|
</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.
|
2017-10-09 03:44:17 +02:00
|
|
|
In some cases it is worth typing <option>-W</option> to avoid the extra
|
2007-12-11 20:57:32 +01:00
|
|
|
connection attempt.
|
2005-07-29 17:13:11 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
2011-12-06 14:48:15 +01:00
|
|
|
|
|
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>--maintenance-db=<replaceable class="parameter">dbname</replaceable></option></term>
|
2011-12-06 14:48:15 +01:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
Fix connection string handling in src/bin/scripts/ programs.
When told to process all databases, clusterdb, reindexdb, and vacuumdb
would reconnect by replacing their --maintenance-db parameter with the
name of the target database. If that parameter is a connstring (which
has been allowed for a long time, though we failed to document that
before this patch), we'd lose any other options it might specify, for
example SSL or GSS parameters, possibly resulting in failure to connect.
Thus, this is the same bug as commit a45bc8a4f fixed in pg_dump and
pg_restore. We can fix it in the same way, by using libpq's rules for
handling multiple "dbname" parameters to add the target database name
separately. I chose to apply the same refactoring approach as in that
patch, with a struct to handle the command line parameters that need to
be passed through to connectDatabase. (Maybe someday we can unify the
very similar functions here and in pg_dump/pg_restore.)
Per Peter Eisentraut's comments on bug #16604. Back-patch to all
supported branches.
Discussion: https://postgr.es/m/16604-933f4b8791227b15@postgresql.org
2020-10-20 01:03:46 +02:00
|
|
|
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.
|
2011-12-06 14:48:15 +01:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
2005-07-29 17:13:11 +02:00
|
|
|
</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>
|
Unified logging system for command-line programs
This unifies the various ad hoc logging (message printing, error
printing) systems used throughout the command-line programs.
Features:
- Program name is automatically prefixed.
- Message string does not end with newline. This removes a common
source of inconsistencies and omissions.
- Additionally, a final newline is automatically stripped, simplifying
use of PQerrorMessage() etc., another common source of mistakes.
- I converted error message strings to use %m where possible.
- As a result of the above several points, more translatable message
strings can be shared between different components and between
frontends and backend, without gratuitous punctuation or whitespace
differences.
- There is support for setting a "log level". This is not meant to be
user-facing, but can be used internally to implement debug or
verbose modes.
- Lazy argument evaluation, so no significant overhead if logging at
some level is disabled.
- Some color in the messages, similar to gcc and clang. Set
PG_COLOR=auto to try it out. Some colors are predefined, but can be
customized by setting PG_COLORS.
- Common files (common/, fe_utils/, etc.) can handle logging much more
simply by just using one API without worrying too much about the
context of the calling program, requiring callbacks, or having to
pass "progname" around everywhere.
- Some programs called setvbuf() to make sure that stderr is
unbuffered, even on Windows. But not all programs did that. This
is now done centrally.
Soft goals:
- Reduces vertical space use and visual complexity of error reporting
in the source code.
- Encourages more deliberate classification of messages. For example,
in some cases it wasn't clear without analyzing the surrounding code
whether a message was meant as an error or just an info.
- Concepts and terms are vaguely aligned with popular logging
frameworks such as log4j and Python logging.
This is all just about printing stuff out. Nothing affects program
flow (e.g., fatal exits). The uses are just too varied to do that.
Some existing code had wrappers that do some kind of print-and-exit,
and I adapted those.
I tried to keep the output mostly the same, but there is a lot of
historical baggage to unwind and special cases to consider, and I
might not always have succeeded. One significant change is that
pg_rewind used to write all error messages to stdout. That is now
changed to stderr.
Reviewed-by: Donald Dong <xdong@csumb.edu>
Reviewed-by: Arthur Zakirov <a.zakirov@postgrespro.ru>
Discussion: https://www.postgresql.org/message-id/flat/6a609b43-4f57-7348-6480-bd022f924310@2ndquadrant.com
2019-04-01 14:24:37 +02:00
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
|
<term><envar>PG_COLOR</envar></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2020-03-09 02:53:22 +01:00
|
|
|
Specifies whether to use color in diagnostic messages. Possible values
|
|
|
|
|
are <literal>always</literal>, <literal>auto</literal> and
|
Unified logging system for command-line programs
This unifies the various ad hoc logging (message printing, error
printing) systems used throughout the command-line programs.
Features:
- Program name is automatically prefixed.
- Message string does not end with newline. This removes a common
source of inconsistencies and omissions.
- Additionally, a final newline is automatically stripped, simplifying
use of PQerrorMessage() etc., another common source of mistakes.
- I converted error message strings to use %m where possible.
- As a result of the above several points, more translatable message
strings can be shared between different components and between
frontends and backend, without gratuitous punctuation or whitespace
differences.
- There is support for setting a "log level". This is not meant to be
user-facing, but can be used internally to implement debug or
verbose modes.
- Lazy argument evaluation, so no significant overhead if logging at
some level is disabled.
- Some color in the messages, similar to gcc and clang. Set
PG_COLOR=auto to try it out. Some colors are predefined, but can be
customized by setting PG_COLORS.
- Common files (common/, fe_utils/, etc.) can handle logging much more
simply by just using one API without worrying too much about the
context of the calling program, requiring callbacks, or having to
pass "progname" around everywhere.
- Some programs called setvbuf() to make sure that stderr is
unbuffered, even on Windows. But not all programs did that. This
is now done centrally.
Soft goals:
- Reduces vertical space use and visual complexity of error reporting
in the source code.
- Encourages more deliberate classification of messages. For example,
in some cases it wasn't clear without analyzing the surrounding code
whether a message was meant as an error or just an info.
- Concepts and terms are vaguely aligned with popular logging
frameworks such as log4j and Python logging.
This is all just about printing stuff out. Nothing affects program
flow (e.g., fatal exits). The uses are just too varied to do that.
Some existing code had wrappers that do some kind of print-and-exit,
and I adapted those.
I tried to keep the output mostly the same, but there is a lot of
historical baggage to unwind and special cases to consider, and I
might not always have succeeded. One significant change is that
pg_rewind used to write all error messages to stdout. That is now
changed to stderr.
Reviewed-by: Donald Dong <xdong@csumb.edu>
Reviewed-by: Arthur Zakirov <a.zakirov@postgrespro.ru>
Discussion: https://www.postgresql.org/message-id/flat/6a609b43-4f57-7348-6480-bd022f924310@2ndquadrant.com
2019-04-01 14:24:37 +02:00
|
|
|
<literal>never</literal>.
|
|
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
2005-07-29 17:13:11 +02:00
|
|
|
</variablelist>
|
2007-02-20 19:10:59 +01:00
|
|
|
|
|
|
|
|
<para>
|
2017-10-09 03:44:17 +02:00
|
|
|
This utility, like most other <productname>PostgreSQL</productname> utilities,
|
|
|
|
|
also uses the environment variables supported by <application>libpq</application>
|
2017-11-23 15:39:47 +01:00
|
|
|
(see <xref linkend="libpq-envars"/>).
|
2007-02-20 19:10:59 +01:00
|
|
|
</para>
|
|
|
|
|
|
2005-07-29 17:13:11 +02:00
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
|
<title>Diagnostics</title>
|
|
|
|
|
|
|
|
|
|
<para>
|
2017-11-23 15:39:47 +01:00
|
|
|
In case of difficulty, see <xref linkend="sql-reindex"/>
|
|
|
|
|
and <xref linkend="app-psql"/> for
|
2005-07-29 17:13:11 +02:00
|
|
|
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>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>
|
2016-10-19 18:00:00 +02:00
|
|
|
<prompt>$ </prompt><userinput>reindexdb --table=foo --index=bar abcd</userinput>
|
2011-08-07 09:49:45 +02:00
|
|
|
</screen></para>
|
2005-07-29 17:13:11 +02:00
|
|
|
|
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
|
<title>See Also</title>
|
|
|
|
|
|
|
|
|
|
<simplelist type="inline">
|
2017-11-23 15:39:47 +01:00
|
|
|
<member><xref linkend="sql-reindex"/></member>
|
2005-07-29 17:13:11 +02:00
|
|
|
</simplelist>
|
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
</refentry>
|
