Improve documentation about pg_dump's --quote-all-identifiers switch.

Per bug #14152 from Alejandro Martínez.  Back-patch to all supported
branches.

Discussion: <20160520165824.22598.31426@wrigleys.postgresql.org>
This commit is contained in:
Tom Lane 2016-05-20 14:59:48 -04:00
parent 79e4deaf83
commit 608e466141
2 changed files with 20 additions and 6 deletions

View File

@ -688,9 +688,16 @@ PostgreSQL documentation
<term><option>--quote-all-identifiers</></term>
<listitem>
<para>
Force quoting of all identifiers. This may be useful when dumping a
database for migration to a future version that may have introduced
additional keywords.
Force quoting of all identifiers. This option is recommended when
dumping a database from a server whose <productname>PostgreSQL</>
major version is different from <application>pg_dump</>'s, or when
the output is intended to be loaded into a server of a different
major version. By default, <application>pg_dump</> quotes only
identifiers that are reserved words in its own major version.
This sometimes results in compatibility issues when dealing with
servers of other versions that may have slightly different sets
of reserved words. Using <option>--quote-all-identifiers</> prevents
such issues, at the price of a harder-to-read dump script.
</para>
</listitem>
</varlistentry>

View File

@ -367,9 +367,16 @@ PostgreSQL documentation
<term><option>--quote-all-identifiers</></term>
<listitem>
<para>
Force quoting of all identifiers. This may be useful when dumping a
database for migration to a future version that may have introduced
additional keywords.
Force quoting of all identifiers. This option is recommended when
dumping a database from a server whose <productname>PostgreSQL</>
major version is different from <application>pg_dumpall</>'s, or when
the output is intended to be loaded into a server of a different
major version. By default, <application>pg_dumpall</> quotes only
identifiers that are reserved words in its own major version.
This sometimes results in compatibility issues when dealing with
servers of other versions that may have slightly different sets
of reserved words. Using <option>--quote-all-identifiers</> prevents
such issues, at the price of a harder-to-read dump script.
</para>
</listitem>
</varlistentry>