open-dsi
/
postgres
mirror of https://github.com/postgres/postgres
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: Group options in pg_amcheck reference page

Browse Source 
The previous arrangement was just one big list, and the internal order
was not all consistent either.  Now arrange the options by group and
sort them, the way it's already done in the --help output and one
other reference pages.  Also fix some ordering in the --help output.
pull/64/merge
Peter Eisentraut 4 years ago
parent f736e188ce
commit cb3cffe694
2 changed files with 239 additions and 216 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 451
      doc/src/sgml/ref/pg_amcheck.sgml
  2. 4
      src/bin/pg_amcheck/pg_amcheck.c

451
doc/src/sgml/ref/pg_amcheck.sgml
Unescape View File

@ -73,7 +73,7 @@ PostgreSQL documentation
<title>Options</title> <title>Options</title>
<para> <para>
pg_amcheck accepts the following command-line arguments: The following command-line options control what is checked:
<variablelist> <variablelist>
<varlistentry> <varlistentry>
@ -113,168 +113,170 @@ PostgreSQL documentation
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-e</option></term> <term><option>-i <replaceable class="parameter">pattern</replaceable></option></term>
<term><option>--echo</option></term> <term><option>--index=<replaceable class="parameter">pattern</replaceable></option></term>
<listitem> <listitem>
<para> <para>
Echo to stdout all SQL sent to the server. Check indexes matching the specified
<link linkend="app-psql-patterns"><replaceable class="parameter">pattern</replaceable></link>,
unless they are otherwise excluded.
This option can be specified more than once.
</para> </para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--endblock=<replaceable class="parameter">block</replaceable></option></term>
<listitem>
<para> <para>
End checking at the specified block number. An error will occur if the This is similar to the <option>--relation</option> option, except that
table relation being checked has fewer than this number of blocks. it applies only to indexes, not tables.
This option does not apply to indexes, and is probably only useful when
checking a single table relation. If both a regular table and a toast
table are checked, this option will apply to both, but higher-numbered
toast blocks may still be accessed while validating toast pointers,
unless that is suppressed using
<option>--exclude-toast-pointers</option>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--exclude-toast-pointers</option></term> <term><option>-I <replaceable class="parameter">pattern</replaceable></option></term>
<term><option>--exclude-index=<replaceable class="parameter">pattern</replaceable></option></term>
<listitem> <listitem>
<para> <para>
By default, whenever a toast pointer is encountered in a table, Exclude indexes matching the specified
a lookup is performed to ensure that it references apparently-valid <link linkend="app-psql-patterns"><replaceable class="parameter">pattern</replaceable></link>.
entries in the toast table. These checks can be quite slow, and this This option can be specified more than once.
option can be used to skip them.
</para> </para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--heapallindexed</option></term>
<listitem>
<para> <para>
For each index checked, verify the presence of all heap tuples as index This is similar to the <option>--exclude-relation</option> option,
tuples in the index using <xref linkend="amcheck"/>'s except that it applies only to indexes, not tables.
<option>heapallindexed</option> option.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-?</option></term> <term><option>-r <replaceable class="parameter">pattern</replaceable></option></term>
<term><option>--help</option></term> <term><option>--relation=<replaceable class="parameter">pattern</replaceable></option></term>
<listitem> <listitem>
<para> <para>
Show help about <application>pg_amcheck</application> command line Check relations matching the specified
arguments, and exit. <link linkend="app-psql-patterns"><replaceable class="parameter">pattern</replaceable></link>,
unless they are otherwise excluded.
This option can be specified more than once.
</para>
<para>
Patterns may be unqualified, e.g. <literal>myrel*</literal>, or they
may be schema-qualified, e.g. <literal>myschema*.myrel*</literal> or
database-qualified and schema-qualified, e.g.
<literal>mydb*.myscheam*.myrel*</literal>. A database-qualified
pattern will add matching databases to the list of databases to be
checked.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-h <replaceable class="parameter">hostname</replaceable></option></term> <term><option>-R <replaceable class="parameter">pattern</replaceable></option></term>
<term><option>--host=<replaceable class="parameter">hostname</replaceable></option></term> <term><option>--exclude-relation=<replaceable class="parameter">pattern</replaceable></option></term>
<listitem> <listitem>
<para> <para>
Specifies the host name of the machine on which the server is running. Exclude relations matching the specified
If the value begins with a slash, it is used as the directory for the <link linkend="app-psql-patterns"><replaceable class="parameter">pattern</replaceable></link>.
Unix domain socket. This option can be specified more than once.
</para>
<para>
As with <option>--relation</option>, the
<link linkend="app-psql-patterns"><replaceable class="parameter">pattern</replaceable></link> may be unqualified, schema-qualified,
or database- and schema-qualified.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-i <replaceable class="parameter">pattern</replaceable></option></term> <term><option>-s <replaceable class="parameter">pattern</replaceable></option></term>
<term><option>--index=<replaceable class="parameter">pattern</replaceable></option></term> <term><option>--schema=<replaceable class="parameter">pattern</replaceable></option></term>
<listitem> <listitem>
<para> <para>
Check indexes matching the specified Check tables and indexes in schemas matching the specified
<link linkend="app-psql-patterns"><replaceable class="parameter">pattern</replaceable></link>, <link linkend="app-psql-patterns"><replaceable class="parameter">pattern</replaceable></link>, unless they are otherwise excluded.
unless they are otherwise excluded.
This option can be specified more than once. This option can be specified more than once.
</para> </para>
<para> <para>
This is similar to the <option>--relation</option> option, except that To select only tables in schemas matching a particular pattern,
it applies only to indexes, not tables. consider using something like
<literal>--table=SCHEMAPAT.* --no-dependent-indexes</literal>.
To select only indexes, consider using something like
<literal>--index=SCHEMAPAT.*</literal>.
</para>
<para>
A schema pattern may be database-qualified. For example, you may
write <literal>--schema=mydb*.myschema*</literal> to select
schemas matching <literal>myschema*</literal> in databases matching
<literal>mydb*</literal>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-I <replaceable class="parameter">pattern</replaceable></option></term> <term><option>-S <replaceable class="parameter">pattern</replaceable></option></term>
<term><option>--exclude-index=<replaceable class="parameter">pattern</replaceable></option></term> <term><option>--exclude-schema=<replaceable class="parameter">pattern</replaceable></option></term>
<listitem> <listitem>
<para> <para>
Exclude indexes matching the specified Exclude tables and indexes in schemas matching the specified
<link linkend="app-psql-patterns"><replaceable class="parameter">pattern</replaceable></link>. <link linkend="app-psql-patterns"><replaceable class="parameter">pattern</replaceable></link>.
This option can be specified more than once. This option can be specified more than once.
</para> </para>
<para> <para>
This is similar to the <option>--exclude-relation</option> option, As with <option>--schema</option>, the pattern may be
except that it applies only to indexes, not tables. database-qualified.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--install-missing</option></term> <term><option>-t <replaceable class="parameter">pattern</replaceable></option></term>
<term><option>--install-missing=<replaceable class="parameter">schema</replaceable></option></term> <term><option>--table=<replaceable class="parameter">pattern</replaceable></option></term>
<listitem> <listitem>
<para> <para>
Install any missing extensions that are required to check the Check tables matching the specified
database(s). If not yet installed, each extension's objects will be <link linkend="app-psql-patterns"><replaceable class="parameter">pattern</replaceable></link>,
installed into the given unless they are otherwise excluded.
<replaceable class="parameter">schema</replaceable>, or if not specified This option can be specified more than once.
into schema <literal>pg_catalog</literal>.
</para> </para>
<para> <para>
At present, the only required extension is <xref linkend="amcheck"/>. This is similar to the <option>--relation</option> option, except that
it applies only to tables, not indexes.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-j <replaceable class="parameter">num</replaceable></option></term> <term><option>-T <replaceable class="parameter">pattern</replaceable></option></term>
<term><option>--jobs=<replaceable class="parameter">num</replaceable></option></term> <term><option>--exclude-table=<replaceable class="parameter">pattern</replaceable></option></term>
<listitem> <listitem>
<para> <para>
Use <replaceable>num</replaceable> concurrent connections to the server, Exclude tables matching the specified
or one per object to be checked, whichever is less. <link linkend="app-psql-patterns"><replaceable class="parameter">pattern</replaceable></link>.
This option can be specified more than once.
</para> </para>
<para> <para>
The default is to use a single connection. This is similar to the <option>--exclude-relation</option> option,
except that it applies only to tables, not indexes.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--maintenance-db=<replaceable class="parameter">dbname</replaceable></option></term> <term><option>--no-dependent-indexes</option></term>
<listitem> <listitem>
<para> <para>
Specifies a database or By default, if a table is checked, any btree indexes of that table
<link linkend="libpq-connstring">connection string</link> to be will also be checked, even if they are not explicitly selected by
used to discover the list of databases to be checked. If neither an option such as <literal>--index</literal> or
<option>--all</option> nor any option including a database pattern is <literal>--relation</literal>. This option suppresses that behavior.
used, no such connection is required and this option does nothing.
Otherwise, any connection string parameters other than
the database name which are included in the value for this option
will also be used when connecting to the databases
being checked. If this option is omitted, the default is
<literal>postgres</literal> or, if that fails,
<literal>template1</literal>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--no-dependent-indexes</option></term> <term><option>--no-dependent-toast</option></term>
<listitem> <listitem>
<para> <para>
By default, if a table is checked, any btree indexes of that table By default, if a table is checked, its toast table, if any, will also
will also be checked, even if they are not explicitly selected by be checked, even if it is not explicitly selected by an option
an option such as <literal>--index</literal> or such as <literal>--table</literal> or <literal>--relation</literal>.
<literal>--relation</literal>. This option suppresses that behavior. This option suppresses that behavior.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -292,15 +294,21 @@ PostgreSQL documentation
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist>
</para>
<para>
The following command-line options control checking of tables:
<variablelist>
<varlistentry> <varlistentry>
<term><option>--no-dependent-toast</option></term> <term><option>--exclude-toast-pointers</option></term>
<listitem> <listitem>
<para> <para>
By default, if a table is checked, its toast table, if any, will also By default, whenever a toast pointer is encountered in a table,
be checked, even if it is not explicitly selected by an option a lookup is performed to ensure that it references apparently-valid
such as <literal>--table</literal> or <literal>--relation</literal>. entries in the toast table. These checks can be quite slow, and this
This option suppresses that behavior. option can be used to skip them.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -321,91 +329,83 @@ PostgreSQL documentation
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--parent-check</option></term> <term><option>--skip=<replaceable class="parameter">option</replaceable></option></term>
<listitem> <listitem>
<para> <para>
For each btree index checked, use <xref linkend="amcheck"/>'s If <literal>all-frozen</literal> is given, table corruption checks
<function>bt_index_parent_check</function> function, which performs will skip over pages in all tables that are marked as all frozen.
additional checks of parent/child relationships during index checking.
</para> </para>
<para> <para>
The default is to use <application>amcheck</application>'s If <literal>all-visible</literal> is given, table corruption checks
<function>bt_index_check</function> function, but note that use of the will skip over pages in all tables that are marked as all visible.
<option>--rootdescend</option> option implicitly selects
<function>bt_index_parent_check</function>.
</para> </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> <para>
Specifies the TCP port or local Unix domain socket file extension on By default, no pages are skipped. This can be specified as
which the server is listening for connections. <literal>none</literal>, but since this is the default, it need not be
mentioned.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-P</option></term> <term><option>--startblock=<replaceable class="parameter">block</replaceable></option></term>
<term><option>--progress</option></term>
<listitem> <listitem>
<para> <para>
Show progress information. Progress information includes the number Start checking at the specified block number. An error will occur if
of relations for which checking has been completed, and the total the table relation being checked has fewer than this number of blocks.
size of those relations. It also includes the total number of relations This option does not apply to indexes, and is probably only useful
that will eventually be checked, and the estimated size of those when checking a single table relation. See <literal>--endblock</literal>
relations. for further caveats.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-q</option></term> <term><option>--endblock=<replaceable class="parameter">block</replaceable></option></term>
<term><option>--quiet</option></term>
<listitem> <listitem>
<para> <para>
Print fewer messages, and less detail regarding any server errors. End checking at the specified block number. An error will occur if the
table relation being checked has fewer than this number of blocks.
This option does not apply to indexes, and is probably only useful when
checking a single table relation. If both a regular table and a toast
table are checked, this option will apply to both, but higher-numbered
toast blocks may still be accessed while validating toast pointers,
unless that is suppressed using
<option>--exclude-toast-pointers</option>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist>
</para>
<para>
The following command-line options control checking of B-tree indexes:
<variablelist>
<varlistentry> <varlistentry>
<term><option>-r <replaceable class="parameter">pattern</replaceable></option></term> <term><option>--heapallindexed</option></term>
<term><option>--relation=<replaceable class="parameter">pattern</replaceable></option></term>
<listitem> <listitem>
<para> <para>
Check relations matching the specified For each index checked, verify the presence of all heap tuples as index
<link linkend="app-psql-patterns"><replaceable class="parameter">pattern</replaceable></link>, tuples in the index using <xref linkend="amcheck"/>'s
unless they are otherwise excluded. <option>heapallindexed</option> option.
This option can be specified more than once.
</para>
<para>
Patterns may be unqualified, e.g. <literal>myrel*</literal>, or they
may be schema-qualified, e.g. <literal>myschema*.myrel*</literal> or
database-qualified and schema-qualified, e.g.
<literal>mydb*.myscheam*.myrel*</literal>. A database-qualified
pattern will add matching databases to the list of databases to be
checked.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-R <replaceable class="parameter">pattern</replaceable></option></term> <term><option>--parent-check</option></term>
<term><option>--exclude-relation=<replaceable class="parameter">pattern</replaceable></option></term>
<listitem> <listitem>
<para> <para>
Exclude relations matching the specified For each btree index checked, use <xref linkend="amcheck"/>'s
<link linkend="app-psql-patterns"><replaceable class="parameter">pattern</replaceable></link>. <function>bt_index_parent_check</function> function, which performs
This option can be specified more than once. additional checks of parent/child relationships during index checking.
</para> </para>
<para> <para>
As with <option>--relation</option>, the The default is to use <application>amcheck</application>'s
<link linkend="app-psql-patterns"><replaceable class="parameter">pattern</replaceable></link> may be unqualified, schema-qualified, <function>bt_index_check</function> function, but note that use of the
or database- and schema-qualified. <option>--rootdescend</option> option implicitly selects
<function>bt_index_parent_check</function>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -431,119 +431,148 @@ PostgreSQL documentation
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist>
</para>
<para>
The following command-line options control the connection to the server:
<variablelist>
<varlistentry> <varlistentry>
<term><option>-s <replaceable class="parameter">pattern</replaceable></option></term> <term><option>-h <replaceable class="parameter">hostname</replaceable></option></term>
<term><option>--schema=<replaceable class="parameter">pattern</replaceable></option></term> <term><option>--host=<replaceable class="parameter">hostname</replaceable></option></term>
<listitem> <listitem>
<para> <para>
Check tables and indexes in schemas matching the specified Specifies the host name of the machine on which the server is running.
<link linkend="app-psql-patterns"><replaceable class="parameter">pattern</replaceable></link>, unless they are otherwise excluded. If the value begins with a slash, it is used as the directory for the
This option can be specified more than once. Unix domain socket.
</para>
<para>
To select only tables in schemas matching a particular pattern,
consider using something like
<literal>--table=SCHEMAPAT.* --no-dependent-indexes</literal>.
To select only indexes, consider using something like
<literal>--index=SCHEMAPAT.*</literal>.
</para> </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> <para>
A schema pattern may be database-qualified. For example, you may Specifies the TCP port or local Unix domain socket file extension on
write <literal>--schema=mydb*.myschema*</literal> to select which the server is listening for connections.
schemas matching <literal>myschema*</literal> in databases matching
<literal>mydb*</literal>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-S <replaceable class="parameter">pattern</replaceable></option></term> <term><option>-U</option></term>
<term><option>--exclude-schema=<replaceable class="parameter">pattern</replaceable></option></term> <term><option>--username=<replaceable class="parameter">username</replaceable></option></term>
<listitem> <listitem>
<para> <para>
Exclude tables and indexes in schemas matching the specified User name to connect as.
<link linkend="app-psql-patterns"><replaceable class="parameter">pattern</replaceable></link>.
This option can be specified more than once.
</para> </para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-w</option></term>
<term><option>--no-password</option></term>
<listitem>
<para> <para>
As with <option>--schema</option>, the pattern may be Never issue a password prompt. If the server requires password
database-qualified. 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> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--skip=<replaceable class="parameter">option</replaceable></option></term> <term><option>-W</option></term>
<term><option>--password</option></term>
<listitem> <listitem>
<para> <para>
If <literal>all-frozen</literal> is given, table corruption checks Force <application>pg_amcheck</application> to prompt for a password
will skip over pages in all tables that are marked as all frozen. before connecting to a database.
</para> </para>
<para> <para>
If <literal>all-visible</literal> is given, table corruption checks This option is never essential, since
will skip over pages in all tables that are marked as all visible. <application>pg_amcheck</application> will automatically prompt for a
password if the server demands password authentication. However,
<application>pg_amcheck</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> </para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--maintenance-db=<replaceable class="parameter">dbname</replaceable></option></term>
<listitem>
<para> <para>
By default, no pages are skipped. This can be specified as Specifies a database or
<literal>none</literal>, but since this is the default, it need not be <link linkend="libpq-connstring">connection string</link> to be
mentioned. used to discover the list of databases to be checked. If neither
<option>--all</option> nor any option including a database pattern is
used, no such connection is required and this option does nothing.
Otherwise, any connection string parameters other than
the database name which are included in the value for this option
will also be used when connecting to the databases
being checked. If this option is omitted, the default is
<literal>postgres</literal> or, if that fails,
<literal>template1</literal>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist>
</para>
<para>
Other options are also available:
<variablelist>
<varlistentry> <varlistentry>
<term><option>--startblock=<replaceable class="parameter">block</replaceable></option></term> <term><option>-e</option></term>
<term><option>--echo</option></term>
<listitem> <listitem>
<para> <para>
Start checking at the specified block number. An error will occur if Echo to stdout all SQL sent to the server.
the table relation being checked has fewer than this number of blocks.
This option does not apply to indexes, and is probably only useful
when checking a single table relation. See <literal>--endblock</literal>
for further caveats.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-t <replaceable class="parameter">pattern</replaceable></option></term> <term><option>-j <replaceable class="parameter">num</replaceable></option></term>
<term><option>--table=<replaceable class="parameter">pattern</replaceable></option></term> <term><option>--jobs=<replaceable class="parameter">num</replaceable></option></term>
<listitem> <listitem>
<para> <para>
Check tables matching the specified Use <replaceable>num</replaceable> concurrent connections to the server,
<link linkend="app-psql-patterns"><replaceable class="parameter">pattern</replaceable></link>, or one per object to be checked, whichever is less.
unless they are otherwise excluded.
This option can be specified more than once.
</para> </para>
<para> <para>
This is similar to the <option>--relation</option> option, except that The default is to use a single connection.
it applies only to tables, not indexes.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-T <replaceable class="parameter">pattern</replaceable></option></term> <term><option>-q</option></term>
<term><option>--exclude-table=<replaceable class="parameter">pattern</replaceable></option></term> <term><option>--quiet</option></term>
<listitem> <listitem>
<para> <para>
Exclude tables matching the specified Print fewer messages, and less detail regarding any server errors.
<link linkend="app-psql-patterns"><replaceable class="parameter">pattern</replaceable></link>.
This option can be specified more than once.
</para>
<para>
This is similar to the <option>--exclude-relation</option> option,
except that it applies only to tables, not indexes.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-U</option></term> <term><option>-P</option></term>
<term><option>--username=<replaceable class="parameter">username</replaceable></option></term> <term><option>--progress</option></term>
<listitem> <listitem>
<para> <para>
User name to connect as. Show progress information. Progress information includes the number
of relations for which checking has been completed, and the total
size of those relations. It also includes the total number of relations
that will eventually be checked, and the estimated size of those
relations.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -571,38 +600,32 @@ PostgreSQL documentation
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-w</option></term> <term><option>--install-missing</option></term>
<term><option>--no-password</option></term> <term><option>--install-missing=<replaceable class="parameter">schema</replaceable></option></term>
<listitem> <listitem>
<para> <para>
Never issue a password prompt. If the server requires password Install any missing extensions that are required to check the
authentication and a password is not available by other means such as database(s). If not yet installed, each extension's objects will be
a <filename>.pgpass</filename> file, the connection attempt will fail. installed into the given
This option can be useful in batch jobs and scripts where no user is <replaceable class="parameter">schema</replaceable>, or if not specified
present to enter a password. into schema <literal>pg_catalog</literal>.
</para>
<para>
At present, the only required extension is <xref linkend="amcheck"/>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-W</option></term> <term><option>-?</option></term>
<term><option>--password</option></term> <term><option>--help</option></term>
<listitem> <listitem>
<para> <para>
Force <application>pg_amcheck</application> to prompt for a password Show help about <application>pg_amcheck</application> command line
before connecting to a database. arguments, and exit.
</para>
<para>
This option is never essential, since
<application>pg_amcheck</application> will automatically prompt for a
password if the server demands password authentication. However,
<application>pg_amcheck</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> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</para> </para>
</refsect1> </refsect1>

4
src/bin/pg_amcheck/pg_amcheck.c
Unescape View File

@ -1187,11 +1187,11 @@ help(const char *progname)
printf(_(" -e, --echo show the commands being sent to the server\n")); printf(_(" -e, --echo show the commands being sent to the server\n"));
printf(_(" -j, --jobs=NUM use this many concurrent connections to the server\n")); printf(_(" -j, --jobs=NUM use this many concurrent connections to the server\n"));
printf(_(" -q, --quiet don't write any messages\n")); printf(_(" -q, --quiet don't write any messages\n"));
printf(_(" -P, --progress show progress information\n"));
printf(_(" -v, --verbose write a lot of output\n")); printf(_(" -v, --verbose write a lot of output\n"));
printf(_(" -V, --version output version information, then exit\n")); printf(_(" -V, --version output version information, then exit\n"));
printf(_(" -P, --progress show progress information\n"));
printf(_(" -?, --help show this help, then exit\n"));
printf(_(" --install-missing install missing extensions\n")); printf(_(" --install-missing install missing extensions\n"));
printf(_(" -?, --help show this help, then exit\n"));
printf(_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT); printf(_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);
printf(_("%s home page: <%s>\n"), PACKAGE_NAME, PACKAGE_URL); printf(_("%s home page: <%s>\n"), PACKAGE_NAME, PACKAGE_URL);

Write Preview
Loading…
Cancel
Save