↑↓ 选择↵ 打开⌫ 切换范围完整搜索

PG.CENTER 连接 PostgreSQL 文档、百科与生态知识。由 Pigsty 维护。

支持中的版本: 当前版本 (18) / 17 / 16 / 15 / 14
开发中的版本: 19 / 20devel
已结束支持的版本: 13 / 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 / 7.0 / 6.5
历史版本。 PostgreSQL 13 已结束支持。 2025-11-13. 请参阅 当前版本手册.

vacuumdb

vacuumdb — 清理并分析一个 PostgreSQL 数据库

大纲

vacuumdb [connection-option...] [option...] [ -t | --table table [( column [,...] )] ] ... [dbname]

vacuumdb [connection-option...] [option...] -a | --all

描述

vacuumdb 是用于清理 PostgreSQL 数据库的工具。vacuumdb 还会生成供 PostgreSQL 查询优化器使用的内部统计信息。

vacuumdb 是 SQL 命令 VACUUM 的包装器。通过该工具或通过访问服务器的其他方式来清理和分析数据库,在效果上没有区别。

选项

vacuumdb 接受下列命令行参数:

-a
--all

清理所有数据库。

[-d] dbname
[--dbname=]dbname

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

--disable-page-skipping

禁止基于可见性映射内容跳过页面。

注意

此选项仅适用于运行 PostgreSQL 9.6 及更高版本的服务器。

-e
--echo

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

-f
--full

执行“完全”清理。

-F
--freeze

激进地“冻结”元组。

-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 表,因此无需单独考虑它。

注意

此选项仅适用于运行 PostgreSQL 9.6 及更高版本的服务器。

--min-xid-age xid_age

仅对事务 ID 年龄至少为 xid_age 的表执行清理或分析命令。此设置可用于优先处理表,以防止事务 ID 回卷(见第 24.1.5 节)。

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

注意

此选项仅适用于运行 PostgreSQL 9.6 及更高版本的服务器。

-P parallel_workers
--parallel=parallel_workers

指定并行清理的并行工作进程数量。这样可以让清理利用多个 CPU 处理索引。参见 VACUUM。

注意

此选项仅适用于运行 PostgreSQL 13 及更高版本的服务器。

-q
--quiet

不显示进度消息。

--skip-locked

跳过那些无法立即加锁并进行处理的关系。

注意

此选项仅适用于运行 PostgreSQL 12 及更高版本的服务器。

-t table [ (column [,...]) ]
--table=table [ (column [,...]) ]

仅清理或分析 table。只有与 --analyze 或 --analyze-only 选项一起使用时,才能指定列名。可以通过多次指定 -t 来清理多个表。

提示

如果指定了列,你很可能需要在 shell 中转义括号。(见下面的示例。)

-v
--verbose

在处理过程中输出详细信息。

-V
--version

输出 vacuumdb 的版本并退出。

-z
--analyze

同时计算供优化器使用的统计信息。

-Z
--analyze-only

仅计算供优化器使用的统计信息(不执行清理)。

--analyze-in-stages

仅计算供优化器使用的统计信息(不执行清理),类似 --analyze-only。使用不同的配置设置运行多个(目前为三个)分析阶段,以便更快地生成可用统计信息。

此选项适合分析刚通过恢复转储或 pg_upgrade 填充的数据库。它会尽快尝试生成一些统计信息,让数据库能够使用,然后在后续阶段生成完整统计信息。

-?
--help

显示 vacuumdb 命令行参数的帮助并退出。

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

-h host
--host=host

指定服务器所在机器的主机名。如果该值以斜杠开头,则它会被用作 Unix 域套接字目录。

-p port
--port=port

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

-U username
--username=username

连接时使用的用户名。

-w
--no-password

绝不提示输入密码。如果服务器要求密码认证,而又无法通过其他方式获得密码,例如 .pgpass 文件,则连接尝试将失败。此选项可用于无人输入密码的批处理作业和脚本。

-W
--password

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

这个选项绝非必需,因为如果服务器要求密码认证,vacuumdb 会自动提示输入密码。不过,vacuumdb 会先浪费一次连接尝试,才得知服务器需要密码。在某些情况下,输入 -W 以避免这次额外的连接尝试是值得的。

--maintenance-db=dbname

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

环境

PGDATABASE
PGHOST
PGPORT
PGUSER

默认连接参数

PG_COLOR

指定是否在诊断消息中使用颜色。可选值为 always、auto 和 never。

与大多数其他 PostgreSQL 工具一样,此工具也使用 libpq 支持的环境变量(见第 33.14 节)。

诊断

如遇困难,请参见 VACUUM 和 psql 中关于潜在问题和错误消息的讨论。数据库服务器必须在目标主机上运行。此外,libpq 前端库所使用的任何默认连接设置和环境变量也都会生效。

注解

vacuumdb 可能需要多次连接到 PostgreSQL 服务器,每次都要询问密码。在这种情况下,使用 ~/.pgpass 文件会比较方便。更多信息见第 33.15 节。

示例

清理数据库 test:

$ vacuumdb test

清理并分析名为 bigdb 的数据库,以供优化器使用:

$ vacuumdb --analyze bigdb

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

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

另见

VACUUM

报告文档问题

阅读 上游文档. 反馈更正前请先核对 当前版本手册.