PostgreSQL 中文参考文档
🌐 英文原版 官方 ↗

vacuumdb

vacuumdb — 回收一个 PostgreSQL 数据库的垃圾并进行分析

Synopsis

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

vacuumdb [connection-option...] [option...] [ -n | --schema schema ] ... [ dbname | -a | --all ]

vacuumdb [connection-option...] [option...] [ -N | --exclude-schema schema ] ... [ dbname | -a | --all ]

描述

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

vacuumdb 是 SQL 命令 VACUUM 的一个包装程序。通过此工具与通过其他访问服务器的方式清理和分析数据库没有实质区别。

选项

vacuumdb 接受下列命令行参数:

-a
--all

清理所有数据库。

--buffer-usage-limit size

指定 缓冲区访问策略 环形缓冲区的大小,适用于一次 vacuumdb 调用。此大小用于计算作为该策略一部分将被重复使用的共享缓冲区的数量。参见 VACUUM。

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

在未使用 -a/--all 的情况下,指定要清理或分析的数据库的名称。如果没有指定,将从环境变量 PGDATABASE 中读取数据库名。如果该变量也没有设置,则使用为连接指定的用户名。dbname 可以是一个 connection string。如果是这样,连接字符串参数将覆盖与之冲突的命令行选项。

--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 回卷(参见 Section 24.1.5.1)。

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

--min-xid-age xid_age

只对事务 ID 年龄至少为 xid_age 的表执行清理或分析命令。此设置有助于确定要处理的表的优先级,以防止事务 ID 回卷(参见 Section 24.1.5)。

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

--missing-stats-only

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

此选项只能与 --analyze-only 或 --analyze-in-stages 一起使用。

注意,--missing-stats-only 需要 SELECT 权限才能访问 pg_statistic 和 pg_statistic_ext_data,而这些权限默认仅限于超级用户。

-n schema
--schema=schema

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

-N schema
--exclude-schema=schema

不对 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 [ (column [,...]) ]
--table=table [ (column [,...]) ]

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

Tip

如果指定了列,你可能需要对 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
--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。它可以是一个 connection string。如果是这样,连接字符串参数将覆盖与之冲突的命令行选项。此外,在连接到其他数据库时,除数据库名本身之外的连接字符串参数也会被重新使用。

环境

PGDATABASE
PGHOST
PGPORT
PGUSER

默认连接参数

PG_COLOR

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

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

诊断

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

示例

清理数据库 test:

$ vacuumdb test

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

$ vacuumdb --analyze bigdb

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

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

清理 foo 和 bar 这两个模式中的所有表,所在的数据库名为 xyzzy:

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

另请参阅

VACUUM