Skip to content

Commit 49450f0

Browse files
committed
Update pg_upgrade docs to mention its use in a less risk-warning way,
and update the pg_upgrade docs to mention its reliance on no changes to the storage format (the later based on Robert Haas's patch).
1 parent ff20fbd commit 49450f0

File tree

2 files changed

+18
-12
lines changed

2 files changed

+18
-12
lines changed

doc/src/sgml/pgupgrade.sgml

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,19 @@
1717
</para>
1818

1919
<para>
20-
<application>pg_upgrade</> works because, though new features are
21-
regularly added to PostgreSQL major releases, the internal data storage
22-
format rarely changes. <application>pg_upgrade</> does its best to
20+
Major PostgreSQL releases regularly add new features that often
21+
change the layout of the system tables, but the internal data storage
22+
format rarely changes. <application>pg_upgrade</> uses this fact
23+
to perform rapid upgrades by creating new system tables and simply
24+
reusing the old user data files. If a future major release ever
25+
changes the data storage format in a way that makes the old data
26+
format unreadable, <application>pg_upgrade</> will not be usable
27+
for such upgrades. (The community will attempt to avoid such
28+
situations.)
29+
</para>
30+
31+
<para>
32+
<application>pg_upgrade</> does its best to
2333
make sure the old and new clusters are binary-compatible, e.g. by
2434
checking for compatible compile-time settings, including 32/64-bit
2535
binaries. It is important that

doc/src/sgml/runtime.sgml

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1692,17 +1692,13 @@ pg_dumpall -p 5432 | psql -d postgres -p 5433
16921692
</sect2>
16931693

16941694
<sect2 id="upgrading-methods-other">
1695-
<title>Other data migration methods</title>
1695+
<title>Non-Dump Upgrade Methods</title>
16961696

16971697
<para>
1698-
The <filename>contrib</> program
1699-
<link linkend="pgupgrade"><application>pg_upgrade</application></link>
1700-
allows an installation to be migrated in-place from one major
1701-
<productname>PostgreSQL</> version to the next. Keep in mind that this
1702-
method does not provide any scope for running old and new versions
1703-
concurrently. Also, <application>pg_upgrade</application> is much less
1704-
battle-tested than <application>pg_dump</application>, so having an
1705-
up-to-date backup is strongly recommended in case something goes wrong.
1698+
The <link linkend="pgupgrade">pg_upgrade</link> module allows an
1699+
installation to be migrated in-place from one major
1700+
<productname>PostgreSQL</> version to the next. Upgrades can be
1701+
performed in minutes.
17061702
</para>
17071703

17081704
<para>

0 commit comments

Comments
 (0)