diff options
| author | Tom Lane <tgl@sss.pgh.pa.us> | 2016-05-20 14:59:48 -0400 |
|---|---|---|
| committer | Tom Lane <tgl@sss.pgh.pa.us> | 2016-05-20 14:59:48 -0400 |
| commit | 800a102c623fde5a7d213242d77da5d8009b1896 (patch) | |
| tree | af2702186902f29bc84fd3975b70f5a7d851f04a /doc/src | |
| parent | 4fedeb98dd77b7611242a416b9804561895ca757 (diff) | |
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>
Diffstat (limited to 'doc/src')
| -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 b7aa43fc2dd..9147144f6f6 100644 --- a/doc/src/sgml/ref/pg_dump.sgml +++ b/doc/src/sgml/ref/pg_dump.sgml @@ -804,9 +804,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 fcf5f77a6db..bc5ad7e0e82 100644 --- a/doc/src/sgml/ref/pg_dumpall.sgml +++ b/doc/src/sgml/ref/pg_dumpall.sgml @@ -378,9 +378,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> |