pg_upgrade
pg_upgrade — 升级一个 PostgreSQL 服务器实例
大纲
pg_upgrade -b oldbindir [-B newbindir] -d oldconfigdir -D newconfigdir [option...]
描述
pg_upgrade(以前称为 pg_migrator)允许将存储在 PostgreSQL 数据文件中的数据升级到更新的 PostgreSQL 主版本,而无需执行主版本升级通常所需的数据转储/恢复,例如从 12.14 升级到 13.10,或从 14.9 升级到 15.5。次版本升级不需要使用它,例如从 12.7 升级到 12.8 或从 14.1 升级到 14.5。
PostgreSQL 主版本会定期增加新特性,这些特性常常会改变系统表的布局,但内部数据存储格式很少改变。pg_upgrade 利用这一点,通过创建新的系统表并直接重用旧的用户数据文件来快速完成升级。如果未来某个主版本改变了数据存储格式,致使旧数据格式无法读取,那么 pg_upgrade 就不能用于这类升级。(社区会尽量避免这种情况。)
pg_upgrade 会尽最大努力确保新旧集簇在二进制上兼容,例如会检查兼容的编译时设置,包括 32/64 位二进制程序。任何外部模块也同样必须二进制兼容,这一点很重要,但 pg_upgrade 无法检查。
pg_upgrade 支持从 9.2.X 及更高版本升级到当前 PostgreSQL 主版本,包括快照版和 beta 版。
警告
升级集簇会使目标集簇执行由源集簇超级用户所选择的任意代码。升级前,务必确认源集簇超级用户是受信任的。
选项
pg_upgrade 接受下列命令行参数:
-bbindir--old-bindir=bindir旧 PostgreSQL 可执行文件目录;环境变量
PGBINOLD-Bbindir--new-bindir=bindir新 PostgreSQL 可执行文件目录;默认是 pg_upgrade 所在目录;环境变量
PGBINNEW-c--check仅检查集簇,不更改任何数据
-dconfigdir--old-datadir=configdir旧数据库集簇配置目录;环境变量
PGDATAOLD-Dconfigdir--new-datadir=configdir新数据库集簇配置目录;环境变量
PGDATANEW-jnjobs--jobs=njobs要使用的并发进程或线程数
-k--link使用硬链接而不是把文件复制到新集簇
-N--no-sync默认情况下,
pg_upgrade会等待升级后集簇的所有文件都被安全地写入磁盘。该选项会使pg_upgrade不等待即返回,这样更快,但也意味着后续若发生操作系统崩溃,数据目录可能会损坏。通常来说,这个选项适用于测试,但不应在生产安装中使用。-ooptions--old-optionsoptions将直接传递给旧
postgres命令的选项;多次指定会追加-Ooptions--new-optionsoptions将直接传递给新
postgres命令的选项;多次指定会追加-pport--old-port=port旧集簇端口号;环境变量
PGPORTOLD-Pport--new-port=port新集簇端口号;环境变量
PGPORTNEW-r--retain即使成功完成后也保留 SQL 和日志文件
-sdir--socketdir=dir升级期间用于 postmaster 套接字的目录;默认值为当前工作目录;环境变量
PGSOCKETDIR-Uusername--username=username集簇安装用户名称;环境变量
PGUSER-v--verbose启用详细的内部日志记录
-V--version显示版本信息,然后退出
--clone使用高效的文件克隆(在某些系统中也称为“reflinks”)代替将文件复制到新集簇。这可以几乎瞬间复制数据文件,从而在保持旧集簇不变的同时,获得
-k/--link的速度优势。文件克隆只在某些操作系统和文件系统上受支持。如果选择了该选项但系统不支持,pg_upgrade 就会报错。目前,它在 Linux(内核 4.5 或更高版本)上的 Btrfs 和 XFS(文件系统需在创建时启用 reflink 支持)以及 macOS 上的 APFS 中受支持。
--copy将文件复制到新集簇。这是默认行为。(另见
--link和--clone。)-?--help显示帮助,然后退出
用法
使用 pg_upgrade 执行升级的步骤如下:
移动旧集簇(可选)
如果你使用的是带版本号的安装目录,例如
/opt/PostgreSQL/16,则不必移动旧集簇。图形化安装程序都使用带版本号的安装目录。如果你的安装目录不是带版本号的,例如
/usr/local/pgsql,就必须移动当前的 PostgreSQL 安装目录,以免它干扰新的 PostgreSQL 安装。当前的 PostgreSQL 服务器关闭后,就可以安全地重命名 PostgreSQL 安装目录。假设旧目录是/usr/local/pgsql,你可以这样做:mv /usr/local/pgsql /usr/local/pgsql.old
以上命令会重命名该目录。
对于源码安装,编译新版本
使用与旧集簇兼容的
configure标志编译新的 PostgreSQL 源码。pg_upgrade 会在开始升级前检查pg_controldata,以确保所有设置都兼容。安装新的 PostgreSQL 二进制文件
安装新服务器的二进制文件和支持文件。默认安装中包含 pg_upgrade。
对于源码安装,如果你希望把新服务器安装到自定义位置,可以使用
prefix变量:make prefix=/usr/local/pgsql.new install
初始化新的 PostgreSQL 集簇
使用
initdb初始化新集簇。这里同样要使用与旧集簇匹配的兼容initdb标志。许多预构建的安装程序会自动执行该步骤。无需启动新集簇。安装扩展共享对象文件
许多来自
contrib或其他来源的扩展和自定义模块都会使用共享对象文件(或 DLL),例如pgcrypto.so。如果旧集簇使用了这些模块,则必须在新集簇中安装与新服务器二进制相匹配的共享对象文件,这通常通过操作系统命令完成。不要装载模式定义,例如CREATE EXTENSION pgcrypto,因为这些会从旧集簇复制过来。如果有可用的扩展更新,pg_upgrade 会报告这一点,并创建一个稍后可运行的脚本来更新它们。复制自定义全文检索文件
将所有自定义全文检索文件(词典、同义词、词库、停用词)从旧集簇复制到新集簇。
调整认证
pg_upgrade会多次连接旧服务器和新服务器,因此你可能希望将认证设置为peer(在pg_hba.conf中),或者使用~/.pgpass文件(见第 34.16 节)。停止两个服务器
确保两个数据库服务器都已停止,在 Unix 上例如:
pg_ctl -D /opt/PostgreSQL/12 stop pg_ctl -D /opt/PostgreSQL/16 stop
或者在 Windows 上使用合适的服务名:
NET STOP postgresql-12 NET STOP postgresql-16
在此次关闭期间,流复制和日志传送备库必须保持运行,以便接收所有更改。
为备库升级做准备
如果你要使用步骤 11 节概述的方法升级备库,请通过对旧主库集簇和备库集簇运行 pg_controldata 来确认旧备库已追上主库。确认所有集簇中的“Latest checkpoint location”值一致。另外,请确保
wal_level没有被设置为minimal,这一点可在新主库集簇的postgresql.conf文件中检查。运行 pg_upgrade
始终运行新服务器的 pg_upgrade 二进制,而不是旧服务器的。pg_upgrade 需要指定新旧集簇的数据目录和可执行文件(
bin)目录。你还可以指定用户和端口值,以及是否希望将数据文件链接或克隆,而不是采用默认的复制行为。如果使用链接模式,升级将快得多(无需复制文件)且占用更少磁盘空间,但一旦在升级后启动新集簇,就无法再访问旧集簇。链接模式还要求新旧集簇的数据目录位于同一文件系统中。(表空间和
pg_wal可以位于不同文件系统中。)克隆模式具有相同的速度和磁盘空间优势,但在启动新集簇后不会使旧集簇不可用。克隆模式同样要求新旧数据目录位于同一文件系统中。该模式只在某些操作系统和文件系统上可用。--jobs选项允许使用多个 CPU 核心复制/链接文件,并行转储和恢复数据库模式;一个不错的起始值是 CPU 核心数与表空间数量中的较大值。对于运行在多处理器机器上的多数据库服务器,此选项可以显著减少升级时间。Windows 用户必须先登录管理员帐号,然后以
postgres用户身份启动 shell,并设置正确的路径:RUNAS /USER:postgres "CMD.EXE" SET PATH=%PATH%;C:\Program Files\PostgreSQL\16\bin;
然后运行 pg_upgrade,并用引号括起目录,例如:
pg_upgrade.exe --old-datadir "C:/Program Files/PostgreSQL/12/data" --new-datadir "C:/Program Files/PostgreSQL/16/data" --old-bindir "C:/Program Files/PostgreSQL/12/bin" --new-bindir "C:/Program Files/PostgreSQL/16/bin"启动后,
pg_upgrade会验证两个集簇是否兼容,然后执行升级。你可以使用pg_upgrade --check仅执行检查,即使旧服务器仍在运行。pg_upgrade --check还会概述升级后需要手工进行的调整。如果你打算使用链接或克隆模式,则应将选项--link或--clone与--check一起使用,以启用对应模式的专用检查。pg_upgrade需要对当前目录具有写权限。显然,在升级期间不应有人访问这些集簇。pg_upgrade 默认会在 50432 端口上运行服务器,以避免意外的客户端连接。升级时可以让两个集簇使用相同的端口号,因为新旧集簇不会同时运行。不过,在检查仍在运行的旧服务器时,新旧端口号必须不同。
如果在恢复数据库模式时发生错误,
pg_upgrade将退出,你必须按照下文步骤 17 所述回退到旧集簇。若要再次尝试pg_upgrade,你需要修改旧集簇,使 pg_upgrade 的模式恢复步骤能够成功完成。如果问题出在某个contrib模块,而该模块并未用于存储用户数据,则你可能需要先从旧集簇卸载这个contrib模块,并在升级后将其安装到新集簇。升级流复制和日志传送备库
如果你使用了链接模式,并且有流复制(见第 27.2.5 节)或日志传送(见第 27.2 节)备库,可以按照下列步骤快速升级它们。你无需在备库上运行 pg_upgrade,而是要在主库上运行 rsync。现在先不要启动任何服务器。
如果你没有使用链接模式、没有或不想使用 rsync,或者想要更简单的方案,请跳过本节说明;待 pg_upgrade 完成且新主库集簇启动后,直接重建备库即可。
在备库上安装新的 PostgreSQL 二进制文件
确保所有备库都已安装新的二进制文件和支持文件。
确保新的备库数据目录不存在
确保新的备库数据目录不存在,或者为空。如果运行过 initdb,请删除备库的新数据目录。
安装扩展共享对象文件
在新备库上安装与新主库集簇中相同的扩展共享对象文件。
停止备库
如果备库仍在运行,请按上述说明立即停止它们。
保存配置文件
保存旧备库配置目录中需要保留的配置文件,例如
postgresql.conf(以及其包含的所有文件)、postgresql.auto.conf、pg_hba.conf,因为在下一步中它们会被覆盖或删除。运行 rsync
在使用链接模式时,可以通过 rsync 快速升级备库。为此,在主库上选择一个位于新旧数据库集簇目录之上的目录,并在主库上针对每个备库运行:
rsync --archive --delete --hard-links --size-only --no-inc-recursive old_cluster new_cluster remote_dir
其中,
old_cluster和new_cluster是相对于主库当前目录的路径,remote_dir则是备库上位于新旧集簇目录上层的目录。主库和备库在指定目录下的目录结构必须一致。关于如何指定远程目录的细节,请参阅 rsync 手册页,例如:rsync --archive --delete --hard-links --size-only --no-inc-recursive /opt/PostgreSQL/12 \ /opt/PostgreSQL/16 standby.example.com:/opt/PostgreSQL你可以使用 rsync 的
--dry-run选项来验证命令将执行什么操作。尽管至少要在主库上为一个备库运行 rsync,但只要某个已升级的备库尚未启动,也可以在该备库上运行 rsync 来升级其他备库。其原理是记录主库上新旧集簇文件之间由 pg_upgrade 链接模式创建的硬链接,然后在备库的旧集簇中找到匹配文件,并在其新集簇中为这些文件创建链接。主库上未被链接的文件会从主库复制到备库(通常都很小)。这使得备库能够快速升级。不幸的是,rsync 会无谓地复制与临时表和不记录 WAL 的表相关的文件,因为这些文件通常不存在于备库上。
如果你有表空间,则需要对每个表空间目录运行类似的 rsync 命令,例如:
rsync --archive --delete --hard-links --size-only --no-inc-recursive /vol1/pg_tblsp/PG_12_201909212 \ /vol1/pg_tblsp/PG_16_202307071 standby.example.com:/vol1/pg_tblsp如果你把
pg_wal迁移到了数据目录之外,也必须对这些目录运行 rsync。配置流复制和日志传送备库
为服务器配置日志传送。(由于备库仍与主库保持同步,因此无需运行
pg_backup_start()和pg_backup_stop(),也无需进行文件系统备份。)复制槽不会被复制,必须重建。
恢复
pg_hba.conf如果你修改了
pg_hba.conf,请恢复其原始设置。也可能需要调整新集簇中的其他配置文件以匹配旧集簇,例如postgresql.conf(以及其包含的所有文件)和postgresql.auto.conf。启动新服务器
现在可以安全地启动新服务器,然后启动所有经 rsync 同步的备库。
升级后处理
如果需要任何升级后处理,pg_upgrade 在完成时会发出警告。它还会生成必须由管理员运行的脚本文件。这些脚本会连接到每个需要升级后处理的数据库。每个脚本应通过以下方式运行:
psql --username=postgres --file=script.sql postgres
这些脚本可以按任意顺序运行,运行完毕后即可删除。
小心
一般来说,在重建脚本运行完成之前访问其中引用的表是不安全的;这样做可能产生错误结果或较差的性能。未在重建脚本中引用的表则可以立即访问。
统计信息
由于优化器统计信息不会由
pg_upgrade传输,升级结束时你会被要求运行命令来重新生成这些信息。你可能需要设置连接参数以匹配新集簇。删除旧集簇
一旦你确认升级结果令人满意,就可以运行
pg_upgrade完成时提到的脚本,删除旧集簇的数据目录。(如果旧数据目录中包含用户定义的表空间,则无法自动删除。)你也可以删除旧的安装目录(例如bin、share)。恢复到旧集簇
如果在运行
pg_upgrade之后,你想恢复到旧集簇,可以选择以下几种方法:如果使用了
--check选项,旧集簇不会被修改;可以重新启动。如果
--link选项没有被使用,旧集簇就未被修改,可以重新启动。如果使用了
--link选项,数据文件可能会在新旧集簇之间共享:如果
pg_upgrade在开始建立链接之前就已中止,旧集簇不会被修改;可以重新启动。如果你没有启动新集簇,则旧集簇没有被修改,只是在开始建立链接时,会把一个
.old后缀附加到$PGDATA/global/pg_control。要重新使用旧集簇,请移除.old这个附加在$PGDATA/global/pg_control上的后缀;随后即可重新启动旧集簇。如果你启动了新集簇,它就已经写入了共享文件,此时再使用旧集簇是不安全的。在这种情况下,旧集簇必须从备份恢复。
注解
pg_upgrade 会创建各种工作文件,例如模式转储,并将它们存放在新集簇目录下的 pg_upgrade_output.d 中。每次运行都会新建一个以 ISO 8601 格式时间戳(%Y%m%dT%H%M%S)命名的子目录,其中保存该次运行生成的全部文件。pg_upgrade_output.d 及其中的文件会在
pg_upgrade 成功完成后被自动删除;但如果出现问题,那里的文件可能提供有用的调试信息。
pg_upgrade 会在新旧数据目录中启动短生命周期的 postmaster。默认情况下,与这些 postmaster 通信所需的临时 Unix 套接字文件会创建在当前工作目录中。在某些情况下,当前目录的路径名可能太长,无法作为有效的套接字名。此时可以使用
-s 选项,将套接字文件放到路径较短的目录中。出于安全考虑,务必确保该目录对其他任何用户都不可读也不可写。(Windows 不支持此功能。)
凡是会影响你安装环境的失败、重建和重新索引情况,pg_upgrade 都会报告;用于重建表和索引的升级后脚本也会自动生成。如果你试图自动化升级很多集簇,你会发现具有相同数据库模式的集簇在所有升级中需要相同的升级后步骤;这是因为升级后步骤依据的是数据库模式,而不是用户数据。
为了测试部署,请创建旧集簇的纯模式副本,插入虚拟数据,然后对其升级。
pg_upgrade 不支持升级包含使用下列
reg* OID 引用系统数据类型的表列的数据库:
regcollation |
regconfig |
regdictionary |
regnamespace |
regoper |
regoperator |
regproc |
regprocedure |
(regclass、regrole 和 regtype 可以升级。)
如果你想使用链接模式,又不希望在启动新集簇时修改旧集簇,可以考虑使用克隆模式。如果不可用,可以先复制旧集簇,再对该副本使用链接模式升级。要创建旧集簇的有效副本,可在服务器运行时使用 rsync 创建旧集簇的脏拷贝,然后关闭旧服务器,再运行 rsync --checksum,把所有变更同步到该副本,使其达到一致状态。(之所以需要 --checksum,是因为 rsync
对文件修改时间的粒度只有一秒。)你可能还想排除某些文件,例如
postmaster.pid,如第 26.3.3 节所述。如果你的文件系统支持文件系统快照或写时复制文件副本,也可以用这些方式备份旧集簇和表空间,不过快照和副本必须同时创建,或者在数据库服务器关闭时创建。
报告文档问题
阅读 上游文档. 通过 PostgreSQL 文档反馈表单.