支持的版本: 当前 (17) / 16 / 15 / 14 / 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

vacuumdb

vacuumdb — 垃圾收集和分析 PostgreSQL 数据库

概要

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 可以是连接字符串。如果是这样,连接字符串参数将覆盖任何冲突的命令行选项。

--disable-page-skipping

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

-e
--echo

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

-f
--full

执行“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表,因此不需要单独考虑。

-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 开关来清理多个表。

提示

如果指定列,则可能需要从 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。这可以是一个连接字符串。如果是这样,连接字符串参数将覆盖任何冲突的命令行选项。此外,连接到其他数据库时,将重用数据库名称本身以外的连接字符串参数。

环境变量

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

提交更正

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