1
0
mirror of https://github.com/postgres/postgres.git synced 2025-07-30 11:03:19 +03:00

doc: Alphabetize long options for pg_dump[all].

The current ordering strategy for these pages is to list the short
options in alphabetical order followed by the long options in
alphabetical order.  If an option has both a short variant and a
long variant, the short variant takes precedence.  This commit
moves a few recently added options to match this style.  We should
probably adjust all pages and --help output to list the long and
short options in one combined alphabetical list (with the long
variants taking precedence), but that is a much larger change, so
it is left as a future exercise.

Oversights in commits a5cf808be5, 1fd1bd8710, and bde2fb797a.

Reviewed-by: Álvaro Herrera <alvherre@kurilemu.de>
Reviewed-by: Peter Eisentraut <peter@eisentraut.org>
Discussion: https://postgr.es/m/aBFBtsltgu3-IU1d%40nathan
This commit is contained in:
Nathan Bossart
2025-04-30 13:07:51 -05:00
parent 368c3fbf9d
commit f60420cff6
2 changed files with 109 additions and 110 deletions

View File

@ -655,17 +655,6 @@ PostgreSQL documentation
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><option>--statistics-only</option></term>
<listitem>
<para>
Dump only the statistics, not the schema (data definitions) or data.
Statistics for tables, materialized views, and indexes are dumped.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><option>-Z <replaceable class="parameter">level</replaceable></option></term> <term><option>-Z <replaceable class="parameter">level</replaceable></option></term>
<term><option>-Z <replaceable class="parameter">method</replaceable></option>[:<replaceable>detail</replaceable>]</term> <term><option>-Z <replaceable class="parameter">method</replaceable></option>[:<replaceable>detail</replaceable>]</term>
@ -1124,19 +1113,19 @@ PostgreSQL documentation
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--no-security-labels</option></term> <term><option>--no-schema</option></term>
<listitem> <listitem>
<para> <para>
Do not dump security labels. Do not dump schema (data definitions).
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--no-schema</option></term> <term><option>--no-security-labels</option></term>
<listitem> <listitem>
<para> <para>
Do not dump schema (data definitions). Do not dump security labels.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -1232,33 +1221,6 @@ PostgreSQL documentation
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><option>--with-data</option></term>
<listitem>
<para>
Dump data. This is the default.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--with-schema</option></term>
<listitem>
<para>
Dump schema (data definitions). This is the default.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--with-statistics</option></term>
<listitem>
<para>
Dump statistics. This is the default.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><option>--on-conflict-do-nothing</option></term> <term><option>--on-conflict-do-nothing</option></term>
<listitem> <listitem>
@ -1392,6 +1354,16 @@ PostgreSQL documentation
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><option>--statistics-only</option></term>
<listitem>
<para>
Dump only the statistics, not the schema (data definitions) or data.
Statistics for tables, materialized views, and indexes are dumped.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><option>--strict-names</option></term> <term><option>--strict-names</option></term>
<listitem> <listitem>
@ -1467,6 +1439,33 @@ PostgreSQL documentation
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><option>--with-data</option></term>
<listitem>
<para>
Dump data. This is the default.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--with-schema</option></term>
<listitem>
<para>
Dump schema (data definitions). This is the default.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--with-statistics</option></term>
<listitem>
<para>
Dump statistics. This is the default.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><option>-?</option></term> <term><option>-?</option></term>
<term><option>--help</option></term> <term><option>--help</option></term>

View File

@ -205,37 +205,6 @@ PostgreSQL documentation
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><option>--filter=<replaceable class="parameter">filename</replaceable></option></term>
<listitem>
<para>
Specify a filename from which to read patterns for databases excluded
from the dump. The patterns are interpreted according to the same rules
as <option>--exclude-database</option>.
To read from <literal>STDIN</literal>, use <filename>-</filename> as the
filename. The <option>--filter</option> option can be specified in
conjunction with <option>--exclude-database</option> for excluding
databases, and can also be specified more than once for multiple filter
files.
</para>
<para>
The file lists one database pattern per row, with the following format:
<synopsis>
exclude database <replaceable class="parameter">PATTERN</replaceable>
</synopsis>
</para>
<para>
Lines starting with <literal>#</literal> are considered comments and
ignored. Comments can be placed after an object pattern row as well.
Blank lines are also ignored. See <xref linkend="app-psql-patterns"/>
for how to perform quoting in patterns.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><option>-g</option></term> <term><option>-g</option></term>
<term><option>--globals-only</option></term> <term><option>--globals-only</option></term>
@ -345,16 +314,6 @@ exclude database <replaceable class="parameter">PATTERN</replaceable>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><option>--statistics-only</option></term>
<listitem>
<para>
Dump only the statistics, not the schema (data definitions) or data.
Statistics for tables, materialized views, and indexes are dumped.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><option>--binary-upgrade</option></term> <term><option>--binary-upgrade</option></term>
<listitem> <listitem>
@ -444,6 +403,37 @@ exclude database <replaceable class="parameter">PATTERN</replaceable>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><option>--filter=<replaceable class="parameter">filename</replaceable></option></term>
<listitem>
<para>
Specify a filename from which to read patterns for databases excluded
from the dump. The patterns are interpreted according to the same rules
as <option>--exclude-database</option>.
To read from <literal>STDIN</literal>, use <filename>-</filename> as the
filename. The <option>--filter</option> option can be specified in
conjunction with <option>--exclude-database</option> for excluding
databases, and can also be specified more than once for multiple filter
files.
</para>
<para>
The file lists one database pattern per row, with the following format:
<synopsis>
exclude database <replaceable class="parameter">PATTERN</replaceable>
</synopsis>
</para>
<para>
Lines starting with <literal>#</literal> are considered comments and
ignored. Comments can be placed after an object pattern row as well.
Blank lines are also ignored. See <xref linkend="app-psql-patterns"/>
for how to perform quoting in patterns.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><option>--if-exists</option></term> <term><option>--if-exists</option></term>
<listitem> <listitem>
@ -640,33 +630,6 @@ exclude database <replaceable class="parameter">PATTERN</replaceable>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><option>--with-data</option></term>
<listitem>
<para>
Dump data. This is the default.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--with-schema</option></term>
<listitem>
<para>
Dump schema (data definitions). This is the default.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--with-statistics</option></term>
<listitem>
<para>
Dump statistics. This is the default.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><option>--no-unlogged-table-data</option></term> <term><option>--no-unlogged-table-data</option></term>
<listitem> <listitem>
@ -722,6 +685,16 @@ exclude database <replaceable class="parameter">PATTERN</replaceable>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><option>--statistics-only</option></term>
<listitem>
<para>
Dump only the statistics, not the schema (data definitions) or data.
Statistics for tables, materialized views, and indexes are dumped.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><option>--use-set-session-authorization</option></term> <term><option>--use-set-session-authorization</option></term>
<listitem> <listitem>
@ -735,6 +708,33 @@ exclude database <replaceable class="parameter">PATTERN</replaceable>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><option>--with-data</option></term>
<listitem>
<para>
Dump data. This is the default.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--with-schema</option></term>
<listitem>
<para>
Dump schema (data definitions). This is the default.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--with-statistics</option></term>
<listitem>
<para>
Dump statistics. This is the default.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><option>-?</option></term> <term><option>-?</option></term>
<term><option>--help</option></term> <term><option>--help</option></term>