pg_upgrade
A server utility for performing a binary upgrade of a PostgreSQL database
pg_upgrade
is a server utility for performing a binary upgrade of a PostgreSQL database cluster to a new major version.
pg_upgrade
was added in PostgreSQL 9.0, initially as a contrib module based on pg_migrator
.
Change history
- PostgreSQL 13
- default new bindir is now the same location as the
pg_upgrade
binary being executed, removing the need to explicitly specify-B newbindir
in most cases (commit 959f6d6a)
- default new bindir is now the same location as the
- PostgreSQL 12
- PostgreSQL 10
- hash indexes from older PostgreSQL versions will be invalidated and a script generated for recreating them (commit a95410e2)
- PostgreSQL 9.5
- converted to a server utility (commit 9fa8b0ee)
- support for PostgreSQL 8.2 and earlier removed (commit 2209b392)
- support for multiple
-o
/-O
options (commit ebe30ad5) - improvements for database collation handling (commit 33755e8e)
- PostgreSQL 9.4
- PostgreSQL 9.3
--jobs
option added to enable parallel schema dump/restore of databases, as well as parallel copy/link of data files (commit 6f1b9e4e and commit a89c46f9)- improvements to status display (commit 6dd95845)
- performance improvement for databases with large numbers of tables (commit 29add0de)
- properly detect the location of non-default socket directories (commit f763b771)
- PostgreSQL 9.2
- environment variables specific to
pg_upgrade
renamed to start with PG; PGPORT now ignored and replaced byPGPORTOLD
/PGPORTNEW
(commit a88f4496) - uses port 50432 by default (commit a88f4496)
- general logging improvements (commit 717f6d60)
- old cluster will only be locked if link mode used (commit 2127aac6)
- script to incrementally generate more accurate statistics added (commit faec2815)
-g
/-G
/-l
logging options removed (commit 717f6d60)-o
/-O
options added (commit 0dc3f57b)-r
/--retain
option added (commit 717f6d60)-v
/--verbose
behaviour improved (commit 717f6d60)- support upgrading clusters without a postgres database (commit a50d860a)
- environment variables specific to
- PostgreSQL 9.0
- added as a contrib module (commit c2e9b2f2)
Note that an earlier version of pg_upgrade
was originally added as a contrib module in PostgreSQL 7.2 (commit 92a8bc96) and removed in PostgreSQL 8.1 (commit d20763db).
Source code
pg_upgrade
source code is located at src/bin/pg_upgrade/.
See src/bin/pg_upgrade/IMPLEMENTATION for a technical description of the implementation.
Examples
Sample output of a pg_upgrade
operation:
$ pg_upgrade \ --old-bindir=/usr/local/pg12/bin \ --old-datadir=/var/lib/pg12/data \ --new-datadir=/var/lib/pg13/data \ --old-port=5432 \ --new-port=5433 \ --jobs 4 Performing Consistency Checks ----------------------------- Checking cluster versions ok Checking database user is the install user ok Checking database connection settings ok Checking for prepared transactions ok Checking for reg* data types in user tables ok Checking for contrib/isn with bigint-passing mismatch ok Checking for user-defined postfix operators ok Creating dump of global objects ok Creating dump of database schemas ok Checking for presence of required libraries ok Checking database user is the install user ok Checking for prepared transactions ok Checking for new cluster tablespace directories ok If pg_upgrade fails after this point, you must re-initdb the new cluster before continuing. Performing Upgrade ------------------ Analyzing all rows in the new cluster ok Freezing all rows in the new cluster ok Deleting files from new pg_xact ok Copying old pg_xact to new server ok Setting next transaction ID and epoch for new cluster ok Deleting files from new pg_multixact/offsets ok Copying old pg_multixact/offsets to new server ok Deleting files from new pg_multixact/members ok Copying old pg_multixact/members to new server ok Setting next multixact ID and offset for new cluster ok Resetting WAL archives ok Setting frozenxid and minmxid counters in new cluster ok Restoring global objects in the new cluster ok Restoring database schemas in the new cluster ok Copying user relation files ok Setting next OID for new cluster ok Sync data directory to disk ok Creating script to delete old cluster ok Upgrade Complete ---------------- Optimizer statistics are not transferred by pg_upgrade. Once you start the new server, consider running: /usr/local/pg13/bin/vacuumdb --all --analyze-in-stages Running this script will delete the old cluster's data files: ./delete_old_cluster.sh
References
- PostgreSQL documentation: pg_upgrade
Useful links
- Rapid Upgrades With Pg_Upgrade - presentation by Bruce Momjian, main author of pg_upgrade