2025年9月25日: PostgreSQL 18 发布!
支持的版本: 当前 (18) / 17 / 16 / 15 / 14 / 13
开发版本: devel
不支持的版本: 12 / 11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0 / 8.4 / 8.3 / 8.2 / 8.1 / 8.0 / 7.4 / 7.3 / 7.2 / 7.1

vacuumdb

vacuumdb — 清理和分析 PostgreSQL 数据库的垃圾回收程序

概要

vacuumdb [连接选项...] [选项...] [ -t | --table 表名 [( 列名 [,...] )] ] ... [ 数据库名 | -a | --all ]

vacuumdb [连接选项...] [选项...] [ -n | --schema 模式名 ] ... [ 数据库名 | -a | --all ]

vacuumdb [连接选项...] [选项...] [ -N | --exclude-schema 模式名 ] ... [ 数据库名 | -a | --all ]

描述

vacuumdb 是一个用于清理 PostgreSQL 数据库的实用程序。vacuumdb 还会生成 PostgreSQL 查询优化器使用的内部统计信息。

vacuumdb 是 SQL 命令 VACUUM 的包装器。通过此实用程序和通过其他访问服务器的方法来清理和分析数据库之间没有实际区别。

选项

vacuumdb 接受以下命令行参数

-a
--all

清理所有数据库。

--buffer-usage-limit 大小

为给定的 vacuumdb 调用指定 缓冲区访问策略 环形缓冲区的大小。此大小用于计算将作为此策略一部分重用的共享缓冲区数量。请参阅 VACUUM

[-d] 数据库名
[--dbname=]数据库名

指定要清理或分析的数据库名称,当未使用 -a/--all 时。如果未指定,则从环境变量 PGDATABASE 读取数据库名。如果未设置,则使用为连接指定的用户名。数据库名 可以是 连接字符串。如果是,则连接字符串参数将覆盖任何冲突的命令行选项。

--disable-page-skipping

根据可见性映射的内容禁用页面跳过。

-e
--echo

回显 vacuumdb 生成并发送到服务器的命令。

-f
--full

执行 完整 清理。

-F
--freeze

积极地 冻结 元组。

--force-index-cleanup

始终删除指向死元组的索引条目。

-j njobs
--jobs=njobs

通过同时运行 njobs 个命令来并行执行清理或分析命令。此选项可能会减少处理时间,但也会增加数据库服务器的负载。

vacuumdb 将打开 njobs 个到数据库的连接,因此请确保您的 max_connections 设置足够高以容纳所有连接。

请注意,将此模式与 -f (FULL) 选项一起使用可能会在并行处理某些系统目录时导致死锁失败。

--min-mxid-age mxid_age

仅对多事务 ID 年龄至少为 mxid_age 的表执行清理或分析命令。此设置对于确定处理表的优先级以防止多事务 ID 环绕非常有用(请参阅 第 24.1.5.1 节)。

在此选项的目的中,关系的多事务 ID 年龄是主关系及其关联的TOAST表(如果存在)的最大年龄。由于 vacuumdb 发出的命令在必要时也会处理关系的TOAST表,因此无需单独考虑。

--min-xid-age xid_age

仅对事务 ID 年龄至少为 xid_age 的表执行清理或分析命令。此设置对于确定处理表的优先级以防止事务 ID 环绕非常有用(请参阅 第 24.1.5 节)。

在此选项的目的中,关系事务 ID 年龄是主关系及其关联的TOAST表(如果存在)的最大年龄。由于 vacuumdb 发出的命令在必要时也会处理关系的TOAST表,因此无需单独考虑。

--missing-stats-only

仅分析缺少列、索引表达式或扩展统计信息对象的统计信息的表。与 --analyze-in-stages 一起使用时,此选项可防止 vacuumdb 临时用由较低统计信息目标生成的统计信息替换现有统计信息,从而避免临时查询优化器选择变差。

此选项只能与 --analyze-only--analyze-in-stages 结合使用。

请注意,--missing-stats-only 需要对 pg_statisticpg_statistic_ext_data 具有 SELECT 权限,这些权限默认情况下仅限于超级用户。

-n 模式名
--schema=模式名

仅清理或分析 模式名 中的所有表。可以通过编写多个 -n 开关来清理多个模式。

-N 模式名
--exclude-schema=模式名

不清理或分析 模式名 中的任何表。可以通过编写多个 -N 开关来排除多个模式。

--no-index-cleanup

不删除指向死元组的索引条目。

--no-process-main

跳过主关系。

--no-process-toast

如果存在,则跳过与表关联的 TOAST 表进行清理。

--no-truncate

不截断表末尾的空页面。

-P parallel_workers
--parallel=parallel_workers

并行清理 指定并行工作程序数量。这允许清理利用多个 CPU 来处理索引。请参阅 VACUUM

-q
--quiet

不显示进度消息。

--skip-locked

跳过无法立即锁定以进行处理的关系。

-t 表名 [ (列名 [,...]) ]
--table=表名 [ (列名 [,...]) ]

仅清理或分析 表名。列名只能与 --analyze--analyze-only 选项结合使用。可以通过编写多个 -t 开关来清理多个表。

提示

如果您指定了列,则可能需要从 shell 中转义括号。(请参阅下面的示例。)

-v
--verbose

在处理过程中显示详细信息。

-V
--version

显示 vacuumdb 版本并退出。

-z
--analyze

同时为优化器计算统计信息。

-Z
--analyze-only

仅为优化器计算统计信息(不清理)。

--analyze-in-stages

仅为优化器计算统计信息(不清理),类似于 --analyze-only。运行三个阶段的分析;第一阶段使用可能的最低统计信息目标(请参阅 default_statistics_target)以更快地生成可用统计信息,后续阶段构建完整的统计信息。

此选项仅对当前没有统计信息或具有完全不正确统计信息的数据库(例如,刚从恢复的转储或 pg_upgrade 填充的数据库)进行分析有用。请注意,在具有现有统计信息的数据库中使用此选项运行时,由于早期阶段的统计信息目标较低,查询优化器选择可能会暂时变差。

-?
--help

显示关于 vacuumdb 命令行参数的帮助,然后退出。

vacuumdb 还接受以下用于连接参数的命令行参数

-h 主机
--host=主机

指定服务器运行所在计算机的主机名。如果值以斜杠开头,则用作 Unix 域套接字目录。

-p 端口
--port=端口

指定服务器正在监听连接的 TCP 端口或本地 Unix 域套接字文件扩展名。

-U 用户名
--username=用户名

要连接的用户。:

-w
--no-password

绝不发出密码提示。如果服务器需要密码身份验证且密码不可用(例如通过 .pgpass 文件),则连接尝试将失败。此选项在没有用户在场输入密码的批处理作业和脚本中很有用。

-W
--password

强制 vacuumdb 在连接到数据库之前提示输入密码。

此选项永远不是必需的,因为如果服务器要求密码身份验证,vacuumdb 会自动提示输入密码。但是,vacuumdb 会浪费一次连接尝试来发现服务器需要密码。在某些情况下,输入 -W 以避免额外的连接尝试是值得的。

--maintenance-db=数据库名

当使用 -a/--all 时,连接到此数据库以收集要清理的数据库列表。如果未指定,则使用 postgres 数据库,如果该数据库不存在,则使用 template1 数据库。这可以是一个 连接字符串。如果是,则连接字符串参数将覆盖任何冲突的命令行选项。此外,连接到其他数据库时,除了数据库名称本身以外的连接字符串参数将被重用。

环境变量

PGDATABASE
PGHOST
PGPORT
PGUSER

默认连接参数

PG_COLOR

指定是否在诊断消息中使用颜色。可能的值为 alwaysautonever

此实用程序以及大多数其他 PostgreSQL 实用程序也使用 libpq 支持的环境变量(请参阅 第 32.15 节)。

诊断

如果遇到困难,请参阅 VACUUMpsql 以了解潜在问题和错误消息的讨论。数据库服务器必须在目标主机上运行。此外,libpq 前端库使用的任何默认连接设置和环境变量都将适用。

示例

清理数据库 test

$ vacuumdb test

清理并为优化器分析名为 bigdb 的数据库

$ vacuumdb --analyze bigdb

清理名为 xyzzy 的数据库中的单个表 foo,并为优化器分析表中的单个列 bar

$ vacuumdb --analyze --verbose --table='foo(bar)' xyzzy

清理名为 xyzzy 的数据库中的 foobar 模式中的所有表

$ vacuumdb --schema='foo' --schema='bar' xyzzy

另请参阅

VACUUM

提交更正

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