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

--disable-page-skipping

根据可见性地图的内容禁用跳过页面。

注意

此选项仅对运行PostgreSQL 9.6或更高版本的服务器有效。

-e
--echo

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

-f
--full

执行完全清理。

-F
--freeze

强有力地冻结元组。

--force-index-cleanup

总是移除指向死元组的索引条目。

注意

这个选项仅在服务器运行PostgreSQL12或更晚版本时有效。

-j njobs
--jobs=njobs

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

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

注意如果某些系统目录被并行处理,使用这种模式加上 -fFULL)选项可能会导致 死锁失败。

--min-mxid-age mxid_age

仅在multixact ID 年龄至少为mxid_age的表上执行清空或分析命令。 此设置对于确定要处理的表的优先级比较有用,以防止multixact ID 回绕。(参见第 25.1.5.1 节)。

对于此选项的用途,关系的multixact ID年龄是主关系及其关联的TOAST表的年龄中最大的,如果存在的话。 由于vacuumdb发出的命令在需要时还将处理TOAST表的关系,它无需单独考虑。

注意

此选项仅对运行PostgreSQL 9.6或更高版本的服务器有效。

--min-xid-age xid_age

仅在事务ID 年龄至少为xid_age的表上执行清空或分析命令。 此设置对于确定要处理的表的优先级比较有用,以防止事务ID 回绕(参见 第 25.1.5 节)。

对于此选项的用途,关系的事务ID年龄是主关系及其关联的TOAST表的年龄中最大的,如果存在的话。 由于vacuumdb发出的命令在需要时还将处理TOAST表的关系,它无需单独考虑。

注意

此选项仅对运行PostgreSQL 9.6或更高版本的服务器有效。

--no-index-cleanup

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

注意

这个选项仅在服务器运行PostgreSQL 12 或更新版本时有效。

--no-process-toast

略过与要清理的表有关联的任何 TOAST 表。

注意

这个选项仅在服务器运行PostgreSQL 14 或更新版本时有效。

--no-truncate

不要在表的结尾截断空页面。

注意

这个选项仅在服务器运行PostgreSQL 12 或更新版本时有效。

-P parallel_workers
--parallel=parallel_workers

指定parallel vacuum的并发数量。 这允许清理利用多个 CPU 来处理索引。 请参见VACUUM

注意

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

-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相似,只计算优化器使用的统计信息(不做清理)。 使用不同的配置设置运行分析的几个(目前是 3个)阶段以更快地产生可用的统计信息。

这个选项对分析一个刚从转储恢复或者通过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

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

和大部分其他PostgreSQL工具相似,这个工具也使用libpq(见第 34.15 节)支持的环境变量。

诊断

在有困难时,可以在VACUUMpsql中找潜在问题和错误消息的讨论。数据库服务器必须运行在目标主机上。同样,任何libpq前端库使用的默认连接设置和环境变量都将适用于此。

注解

vacuumdb可能需要多次连接到PostgreSQL服务器,每次都询问一个口令。在这种情况下有一个~/.pgpass文件会很方便。详见第 34.16 节

例子

要清理数据库test

$ vacuumdb test

要清理和为优化器分析一个名为bigdb的数据库:

$ vacuumdb --analyze bigdb

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

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

参见

VACUUM