diff options
| author | Tom Lane <tgl@sss.pgh.pa.us> | 2016-05-20 14:59:47 -0400 |
|---|---|---|
| committer | Tom Lane <tgl@sss.pgh.pa.us> | 2016-05-20 14:59:47 -0400 |
| commit | 960be4a9986d5c4fde585c531e726c85e2aa787a (patch) | |
| tree | b330f403890cd32630c5ed328251079660a50d79 | |
| parent | 16ea51a263bfbb009ba73f36494f49246933e93c (diff) | |
| download | postgresql-960be4a9986d5c4fde585c531e726c85e2aa787a.tar.gz postgresql-960be4a9986d5c4fde585c531e726c85e2aa787a.zip | |
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>
| -rw-r--r-- | doc/src/sgml/ref/pg_dump.sgml | 13 | ||||
| -rw-r--r-- | doc/src/sgml/ref/pg_dumpall.sgml | 13 |
2 files changed, 20 insertions, 6 deletions
diff --git a/doc/src/sgml/ref/pg_dump.sgml b/doc/src/sgml/ref/pg_dump.sgml index 25b3d9632dd..b354ba8add0 100644 --- a/doc/src/sgml/ref/pg_dump.sgml +++ b/doc/src/sgml/ref/pg_dump.sgml @@ -836,9 +836,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> diff --git a/doc/src/sgml/ref/pg_dumpall.sgml b/doc/src/sgml/ref/pg_dumpall.sgml index 6c34c257b3c..97168a08159 100644 --- a/doc/src/sgml/ref/pg_dumpall.sgml +++ b/doc/src/sgml/ref/pg_dumpall.sgml @@ -368,9 +368,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> |