2024年9月26日:PostgreSQL 17 发布!
支持的版本:当前 (17) / 16 / 15 / 14 / 13 / 12
开发版本:devel
不支持的版本:11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0

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 接受以下命令行参数

-b bindir
--old-bindir=bindir

旧的 PostgreSQL 可执行文件目录;环境变量 PGBINOLD

-B bindir
--new-bindir=bindir

新的 PostgreSQL 可执行文件目录;默认为 pg_upgrade 所在的目录;环境变量 PGBINNEW

-c
--check

仅检查集群,不更改任何数据

-d configdir
--old-datadir=configdir

旧数据库集群配置目录;环境变量 PGDATAOLD

-D configdir
--new-datadir=configdir

新的数据库集群配置目录;环境变量 PGDATANEW

-j njobs
--jobs=njobs

要使用的同时进程或线程数

-k
--link

使用硬链接而不是将文件复制到新集群

-N
--no-sync

默认情况下,pg_upgrade 将等待升级集群的所有文件安全写入磁盘。此选项会导致 pg_upgrade 返回而不等待,这更快,但意味着随后的操作系统崩溃可能会导致数据目录损坏。通常,此选项适用于测试,但不应在生产安装中使用。

-o options
--old-options options

要直接传递给旧的 postgres 命令的选项;多个选项调用将追加

-O options
--new-options options

要直接传递给新的 postgres 命令的选项;多个选项调用将追加

-p port
--old-port=port

旧集群端口号;环境变量 PGPORTOLD

-P port
--new-port=port

新集群端口号;环境变量 PGPORTNEW

-r
--retain

即使成功完成也要保留 SQL 和日志文件

-s dir
--socketdir=dir

在升级期间要使用的 postmaster 套接字目录;默认为当前工作目录;环境变量 PGSOCKETDIR

-U username
--username=username

集群的安装用户名;环境变量 PGUSER

-v
--verbose

启用详细的内部日志记录

-V
--version

显示版本信息,然后退出

--clone

使用高效的文件克隆(在某些系统上也称为“reflinks”)而不是将文件复制到新集群。这可以使数据文件的复制几乎立即完成,从而获得 -k/--link 的速度优势,同时保持旧集群不变。

文件克隆仅在某些操作系统和文件系统上受支持。如果选择了它但不受支持,则 pg_upgrade 运行将出错。目前,它在 Linux(内核 4.5 或更高版本)上与 Btrfs 和 XFS(在创建具有 reflink 支持的文件系统上)以及在 macOS 上与 APFS 一起受支持。

--copy

将文件复制到新集群。这是默认值。(另请参阅 --link--clone。)

--copy-file-range

使用 copy_file_range 系统调用进行高效复制。在某些文件系统上,这会产生类似于 --clone 的结果,共享物理磁盘块,而在其他文件系统上,它可能仍然会复制块,但通过优化的路径执行。目前,它在 Linux 和 FreeBSD 上受支持。

--sync-method=method

当设置为 fsync 时,这是默认值,pg_upgrade 将递归打开并同步升级集群数据目录中的所有文件。文件搜索将遵循 WAL 目录和每个配置的表空间的符号链接。

在 Linux 上,可以使用 syncfs 代替,以要求操作系统同步包含升级集群数据目录、其 WAL 文件和每个表空间的整个文件系统。有关使用 syncfs 时需要注意的注意事项,请参阅 recovery_init_sync_method

当使用 --no-sync 时,此选项无效。

-?
--help

显示帮助,然后退出

用法

以下是使用 pg_upgrade 执行升级的步骤

  1. 可选地移动旧集群

    如果使用版本特定的安装目录,例如 /opt/PostgreSQL/17,则无需移动旧集群。所有图形安装程序都使用版本特定的安装目录。

    如果安装目录不是版本特定的,例如 /usr/local/pgsql,则必须移动当前 PostgreSQL 安装目录,以使其不干扰新的 PostgreSQL 安装。关闭当前 PostgreSQL 服务器后,可以安全地重命名 PostgreSQL 安装目录;假设旧目录是 /usr/local/pgsql,您可以执行以下操作

    mv /usr/local/pgsql /usr/local/pgsql.old
    

    以重命名目录。

  2. 对于源代码安装,构建新版本

    使用与旧集群兼容的 configure 标志构建新的 PostgreSQL 源代码。pg_upgrade 将检查 pg_controldata 以确保所有设置在开始升级之前都是兼容的。

  3. 安装新的 PostgreSQL 二进制文件

    安装新服务器的二进制文件和支持文件。pg_upgrade 包含在默认安装中。

    对于源代码安装,如果希望在新服务器的自定义位置安装,请使用 prefix 变量

    make prefix=/usr/local/pgsql.new install
    
  4. 初始化新的 PostgreSQL 集群

    使用 initdb 初始化新集群。同样,使用与旧集群匹配的兼容 initdb 标志。许多预构建的安装程序会自动执行此步骤。无需启动新集群。

  5. 安装扩展共享对象文件

    许多扩展和自定义模块(无论是来自 contrib 还是其他来源)都使用共享对象文件(或 DLL),例如 pgcrypto.so。如果旧集群使用了这些文件,则必须在新集群中安装与新服务器二进制文件匹配的共享对象文件,通常通过操作系统命令。不要加载模式定义,例如 CREATE EXTENSION pgcrypto,因为这些将从旧集群复制。如果扩展更新可用,pg_upgrade 将报告此情况并创建一个稍后可以运行的脚本以更新它们。

  6. 复制自定义全文搜索文件

    将任何自定义全文搜索文件(词典、同义词、词库、停用词)从旧集群复制到新集群。

  7. 调整身份验证

    pg_upgrade 将多次连接到旧服务器和新服务器,因此您可能希望在 pg_hba.conf 中将身份验证设置为 peer 或使用 ~/.pgpass 文件(请参阅 第 32.16 节)。

  8. 准备发布者升级

    pg_upgrade 尝试迁移逻辑槽位。这有助于避免在新的发布者上手动定义相同的逻辑槽位。仅当旧集群版本为 17.0 或更高版本时,才支持逻辑槽位的迁移。版本低于 17.0 的集群上的逻辑槽位将被静默忽略。

    在开始升级发布者集群之前,请确保订阅已暂时禁用,方法是执行 ALTER SUBSCRIPTION ... DISABLE。升级后重新启用订阅。

    pg_upgrade 能够升级逻辑槽位需要满足一些先决条件。如果未满足这些条件,将报告错误。

    • 新集群必须将 wal_level 设置为 logical

    • 新集群必须将 max_replication_slots 配置为大于或等于旧集群中槽位数量的值。

    • 旧集群上的槽位引用的输出插件必须安装在新 PostgreSQL 可执行文件目录中。

    • 旧集群已将所有事务和逻辑解码消息复制到订阅者。

    • 旧集群上的所有槽位都必须可用,即没有 pg_replication_slots.conflicting 不为 true 的槽位。

    • 新集群不能有永久逻辑槽位,即 pg_replication_slots.temporary 不为 false 的槽位。

  9. 准备订阅者升级

    在新的订阅者中设置 订阅者配置pg_upgrade 尝试迁移订阅依赖项,其中包括存在于 pg_subscription_rel 系统目录中的订阅的表信息以及订阅的复制源。这允许新的订阅者上的逻辑复制从旧订阅者到达的位置继续。仅当旧集群版本为 17.0 或更高版本时,才支持订阅依赖项的迁移。版本低于 17.0 的集群上的订阅依赖项将被静默忽略。

    pg_upgrade 能够升级订阅需要满足一些先决条件。如果未满足这些条件,将报告错误。

    • 旧订阅者中的所有订阅表都应处于 i(初始化)或 r(就绪)状态。可以通过检查 pg_subscription_rel.srsubstate 来验证。

    • 每个订阅对应的复制源条目都应存在于旧集群中。可以通过检查 pg_subscriptionpg_replication_origin 系统表找到。

    • 新集群必须将 max_replication_slots 配置为大于或等于旧集群中订阅数量的值。

  10. 停止两个服务器

    确保两个数据库服务器都已停止,例如在 Unix 上使用:

    pg_ctl -D /opt/PostgreSQL/12 stop
    pg_ctl -D /opt/PostgreSQL/17 stop
    

    或在 Windows 上使用正确的服务名称。

    NET STOP postgresql-12
    NET STOP postgresql-17
    

    流复制和日志传输备用服务器必须在此关闭期间运行,以便它们接收所有更改。

  11. 准备备用服务器升级

    如果您使用第 13 步中概述的方法升级备用服务器,请验证旧备用服务器是否已赶上,方法是对旧主服务器和备用集群运行 pg_controldata。验证所有集群中的 最新检查点位置 值是否匹配。此外,请确保新主集群的 postgresql.conf 文件中未将 wal_level 设置为 minimal

  12. 运行 pg_upgrade

    始终运行新服务器的 pg_upgrade 二进制文件,而不是旧的。 pg_upgrade 需要指定旧集群和新集群的数据和可执行文件 (bin) 目录。您还可以指定用户和端口值,以及是否希望数据文件链接或克隆而不是默认的复制行为。

    如果您使用链接模式,升级将快得多(没有文件复制)并且使用更少的磁盘空间,但是一旦您在升级后启动新集群,您将无法访问旧集群。链接模式还要求旧集群和新集群数据目录位于同一文件系统中。(表空间和 pg_wal 可以位于不同的文件系统中。)克隆模式提供相同的速度和磁盘空间优势,但不会导致旧集群在启动新集群后无法使用。克隆模式还要求旧集群和新集群数据目录位于同一文件系统中。此模式仅在某些操作系统和文件系统上可用。

    --jobs 选项允许使用多个 CPU 内核并行复制/链接文件以及转储和还原数据库模式;一个好的起点是 CPU 内核数和表空间数的最大值。此选项可以大大减少在多处理器机器上运行的多数据库服务器的升级时间。

    对于 Windows 用户,您必须登录到管理员帐户,然后使用带引号的目录运行 pg_upgrade,例如:

    pg_upgrade.exe
            --old-datadir "C:/Program Files/PostgreSQL/12/data"
            --new-datadir "C:/Program Files/PostgreSQL/17/data"
            --old-bindir "C:/Program Files/PostgreSQL/12/bin"
            --new-bindir "C:/Program Files/PostgreSQL/17/bin"
    

    启动后,pg_upgrade 将验证两个集群是否兼容,然后进行升级。即使旧服务器仍在运行,您也可以使用 pg_upgrade --check 仅执行检查。pg_upgrade --check 还会概述升级后您需要进行的任何手动调整。如果您要使用链接或克隆模式,则应使用选项 --link--clone--check 一起使用以启用特定于模式的检查。pg_upgrade 需要当前目录的写权限。

    显然,在升级期间没有人应该访问集群。pg_upgrade 默认在端口 50432 上运行服务器,以避免意外的客户端连接。在进行升级时,您可以对两个集群使用相同的端口号,因为旧集群和新集群不会同时运行。但是,在检查旧的正在运行的服务器时,旧端口号和新端口号必须不同。

    如果在还原数据库模式时发生错误,pg_upgrade 将退出,您必须按照下面 第 19 步 中概述的方法恢复到旧集群。要再次尝试 pg_upgrade,您需要修改旧集群以使 pg_upgrade 模式还原成功。如果问题是 contrib 模块,则可能需要从旧集群中卸载 contrib 模块,并在升级后将其安装在新集群中,假设该模块不用于存储用户数据。

  13. 升级流复制和日志传输备用服务器

    如果您使用了链接模式并且有流复制(参见 第 26.2.5 节)或日志传输(参见 第 26.2 节)备用服务器,您可以按照以下步骤快速升级它们。您不会在备用服务器上运行 pg_upgrade,而是运行主服务器上的 rsync。尚未启动任何服务器。

    如果您没有使用链接模式,没有或不想使用 rsync,或者想要一个更简单的解决方案,请跳过本节中的说明,并在 pg_upgrade 完成并运行新的主服务器后简单地重新创建备用服务器。

    1. 在备用服务器上安装新的 PostgreSQL 二进制文件

      确保所有备用服务器上都安装了新的二进制文件和支持文件。

    2. 确保新的备用数据目录不存在

      确保新的备用数据目录不存在或为空。如果运行了 initdb,请删除备用服务器的新数据目录。

    3. 安装扩展共享对象文件

      在新备用服务器上安装与在新主集群中安装的相同的扩展共享对象文件。

    4. 停止备用服务器

      如果备用服务器仍在运行,请立即使用上述说明停止它们。

    5. 保存配置文件

      保存您需要保留的旧备用服务器配置目录中的任何配置文件,例如 postgresql.conf(以及其中包含的任何文件)、postgresql.auto.confpg_hba.conf,因为这些文件将在下一步中被覆盖或删除。

    6. 运行 rsync

      使用链接模式时,可以使用 rsync 快速升级备用服务器。为此,从主服务器上位于旧数据库集群目录和新数据库集群目录上方的目录中,对每个备用服务器在主服务器上运行以下命令:

      rsync --archive --delete --hard-links --size-only --no-inc-recursive old_cluster new_cluster remote_dir
      

      其中 old_clusternew_cluster 相对于主服务器上的当前目录,而 remote_dir 位于备用服务器上的旧集群目录和新集群目录上方。主服务器和备用服务器上指定目录下的目录结构必须匹配。有关指定远程目录的详细信息,请参阅 rsync 手册页,例如:

      rsync --archive --delete --hard-links --size-only --no-inc-recursive /opt/PostgreSQL/12 \
            /opt/PostgreSQL/17 standby.example.com:/opt/PostgreSQL
      

      您可以使用 rsync--dry-run 选项验证命令将执行的操作。虽然必须至少在一个备用服务器上为主服务器运行 rsync,但如果已升级的备用服务器尚未启动,则可以在已升级的备用服务器上运行 rsync 以升级其他备用服务器。

      此操作的作用是记录 pg_upgrade 的链接模式创建的连接主服务器上旧集群和新集群中文件的链接。然后,它会在备用服务器的旧集群中找到匹配的文件,并在备用服务器的新集群中为它们创建链接。主服务器上未链接的文件将从主服务器复制到备用服务器。(它们通常很小。)这提供了快速的备用服务器升级。不幸的是,rsync 无需复制与临时表和非日志表关联的文件,因为这些文件通常不存在于备用服务器上。

      如果您有表空间,则需要为每个表空间目录运行类似的 rsync 命令,例如:

      rsync --archive --delete --hard-links --size-only --no-inc-recursive /vol1/pg_tblsp/PG_12_201909212 \
            /vol1/pg_tblsp/PG_17_202307071 standby.example.com:/vol1/pg_tblsp
      

      如果您已将 pg_wal 重新定位到数据目录之外,则也必须在这些目录上运行 rsync

    7. 配置流复制和日志传输备用服务器

      配置服务器以进行日志传送。(您无需运行pg_backup_start()pg_backup_stop() 或执行文件系统备份,因为备用服务器仍与主服务器同步。)如果旧主服务器版本早于 17.0,则主服务器上的插槽不会复制到新的备用服务器,因此必须手动重新创建旧备用服务器上的所有插槽。如果旧主服务器版本为 17.0 或更高版本,则仅将主服务器上的逻辑插槽复制到新的备用服务器,但旧备用服务器上的其他插槽不会复制,因此必须手动重新创建。

  14. 恢复 pg_hba.conf

    如果您修改了 pg_hba.conf,请恢复其原始设置。可能还需要调整新集群中的其他配置文件以匹配旧集群,例如 postgresql.conf(以及它包含的任何文件)、postgresql.auto.conf

  15. 启动新服务器

    现在可以安全地启动新服务器,然后启动任何使用 rsync 同步的备用服务器。

  16. 升级后处理

    如果需要任何升级后处理,pg_upgrade将在完成时发出警告。它还会生成管理员必须运行的脚本文件。脚本文件将连接到每个需要升级后处理的数据库。每个脚本都应使用以下命令运行:

    psql --username=postgres --file=script.sql postgres
    

    这些脚本可以按任何顺序运行,并且在运行后可以删除。

    注意

    通常,在重建脚本完成运行之前,访问重建脚本中引用的表是不安全的;这样做可能会产生不正确的结果或性能下降。未在重建脚本中引用的表可以立即访问。

  17. 统计信息

    由于 pg_upgrade 不会传输优化器统计信息,因此您将在升级结束时收到重新生成该信息的命令提示。您可能需要设置连接参数以匹配您的新集群。

    使用 vacuumdb --all --analyze-only 可以有效地生成此类统计信息,并且使用 --jobs 可以加快速度。选项 --analyze-in-stages 可用于快速生成最少的统计信息。如果 vacuum_cost_delay 设置为非零值,则可以使用 PGOPTIONS 覆盖它以加快统计信息生成速度,例如 PGOPTIONS='-c vacuum_cost_delay=0' vacuumdb ...

  18. 删除旧集群

    一旦您对升级满意,就可以通过运行 pg_upgrade 完成时提到的脚本删除旧集群的数据目录。(如果您在旧数据目录中包含用户定义的表空间,则无法自动删除。)您还可以删除旧的安装目录(例如 binshare)。

  19. 恢复到旧集群

    如果在运行 pg_upgrade 后,您希望恢复到旧集群,则有多种选择

    • 如果使用了 --check 选项,则旧集群未被修改;它可以重新启动。

    • 如果未使用 --link 选项,则旧集群未被修改;它可以重新启动。

    • 如果使用了 --link 选项,则旧集群和新集群之间可能会共享数据文件

      • 如果 pg_upgrade 在链接开始之前中止,则旧集群未被修改;它可以重新启动。

      • 如果您没有启动新集群,则旧集群未被修改,只是在链接开始时,$PGDATA/global/pg_control 附加了 .old 后缀。要重用旧集群,请从 $PGDATA/global/pg_control 中删除 .old 后缀;然后您可以重新启动旧集群。

      • 如果您启动了新集群,则它已写入共享文件,并且使用旧集群是不安全的。在这种情况下,需要从备份中恢复旧集群。

环境

一些环境变量可用于为命令行选项提供默认值

PGBINOLD

旧 PostgreSQL 可执行文件目录;选项 -b/--old-bindir

PGBINNEW

新 PostgreSQL 可执行文件目录;选项 -B/--new-bindir

PGDATAOLD

旧数据库集群配置目录;选项 -d/--old-datadir

PGDATANEW

新数据库集群配置目录;选项 -D/--new-datadir

PGPORTOLD

旧集群端口号;选项 -p/--old-port

PGPORTNEW

新集群端口号;选项 -P/--new-port

PGSOCKETDIR

升级期间用于 postmaster 套接字的目录;选项 -s/--socketdir

PGUSER

集群的安装用户名;选项 -U/--username

备注

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

regclassregroleregtype 可以升级。)

如果您想使用链接模式并且不希望在启动新集群时修改旧集群,请考虑使用克隆模式。如果该模式不可用,请复制旧集群并在链接模式下进行升级。要创建旧集群的有效副本,请使用 rsync 在服务器运行时创建旧集群的脏副本,然后关闭旧服务器并再次运行 rsync --checksum 以更新副本并使其保持一致。(--checksum 是必要的,因为 rsync 只有 1 秒的文件修改时间粒度。)您可能希望排除某些文件,例如 postmaster.pid,如 第 25.3.4 节 中所述。如果您的文件系统支持文件系统快照或写时复制文件副本,则可以使用它来备份旧集群和表空间,尽管必须同时或在数据库服务器关闭时创建快照和副本。

另请参阅

initdbpg_ctlpg_dumppostgres

提交更正

如果您在文档中发现任何不正确的内容,与您对特定功能的体验不符或需要进一步澄清的内容,请使用 此表单 报告文档问题。