2025年9月25日: PostgreSQL 18 发布!
支持的版本: 当前 (18) / 17 / 16 / 15 / 14
开发版本: devel

pg_amcheck

pg_amcheck — 检查一个或多个 PostgreSQL 数据库中的损坏情况

概要

pg_amcheck [选项...] [数据库名]

描述

pg_amcheck 支持对一个或多个数据库运行 amcheck 的损坏检查函数,并提供选项来选择要检查的模式、表和索引,执行哪种类型的检查,以及是否并行执行检查,如果并行执行,则建立和使用的并行连接数。

目前只支持普通表和 TOAST 表关系、物化视图、序列和 B-tree 索引。其他关系类型将被静默跳过。

如果指定了 数据库名,则它应该是要检查的单个数据库的名称,并且不应存在其他数据库选择选项。否则,如果存在任何数据库选择选项,将检查所有匹配的数据库。如果不存在此类选项,将检查默认数据库。数据库选择选项包括 --all--database--exclude-database。它们还包括 --relation--exclude-relation--table--exclude-table--index--exclude-index,但仅当这些选项与三部分模式一起使用时(例如 mydb*.myschema*.myrel*)。最后,它们包括 --schema--exclude-schema,但仅当这些选项与两部分模式一起使用时(例如 mydb*.myschema*)。

数据库名 也可以是一个 连接字符串

选项

以下命令行选项控制检查内容

-a
--all

检查所有数据库,除非通过 --exclude-database 排除。

-d 模式
--database=模式

检查与指定 模式 匹配的数据库,除非被 --exclude-database 排除。此选项可以指定多次。

-D 模式
--exclude-database=模式

排除与给定 模式 匹配的数据库。此选项可以指定多次。

-i 模式
--index=模式

检查与指定 模式 匹配的索引,除非它们被其他方式排除。此选项可以指定多次。

这与 --relation 选项类似,只是它仅适用于索引,而不适用于其他关系类型。

-I 模式
--exclude-index=模式

排除与指定 模式 匹配的索引。此选项可以指定多次。

这与 --exclude-relation 选项类似,只是它仅适用于索引,而不适用于其他关系类型。

-r 模式
--relation=模式

检查与指定 模式 匹配的关系,除非它们被其他方式排除。此选项可以指定多次。

模式可以是未限定的,例如 myrel*,也可以是模式限定的,例如 myschema*.myrel*,或者数据库和模式限定的,例如 mydb*.myschema*.myrel*。数据库限定的模式将添加匹配的数据库到要检查的数据库列表中。

-R 模式
--exclude-relation=模式

排除与指定 模式 匹配的关系。此选项可以指定多次。

--relation 一样,模式 可以是未限定的、模式限定的,或者数据库和模式限定的。

-s 模式
--schema=模式

检查与指定 模式 匹配的模式中的表和索引,除非它们被其他方式排除。此选项可以指定多次。

要仅选择匹配特定模式的模式中的表,请考虑使用类似 --table=SCHEMAPAT.* --no-dependent-indexes 的方式。要仅选择索引,请考虑使用类似 --index=SCHEMAPAT.* 的方式。

模式可以被数据库限定。例如,您可以编写 --schema=mydb*.myschema* 来选择在匹配 mydb* 的数据库中匹配 myschema* 的模式。

-S 模式
--exclude-schema=模式

排除与指定 模式 匹配的模式中的表和索引。此选项可以指定多次。

--schema 一样,模式可以被数据库限定。

-t 模式
--table=模式

检查与指定 模式 匹配的表,除非它们被其他方式排除。此选项可以指定多次。

这与 --relation 选项类似,只是它仅适用于表、物化视图和序列,而不适用于索引。

-T 模式
--exclude-table=模式

排除与指定 模式 匹配的表。此选项可以指定多次。

这与 --exclude-relation 选项类似,只是它仅适用于表、物化视图和序列,而不适用于索引。

--no-dependent-indexes

默认情况下,如果检查了表,那么该表的任何 B-tree 索引也会被检查,即使它们没有被 --index--relation 等选项明确选择。此选项将抑制此行为。

--no-dependent-toast

默认情况下,如果检查了表,那么它的 TOAST 表(如果存在)也会被检查,即使它没有被 --table--relation 等选项明确选择。此选项将抑制此行为。

--no-strict-names

默认情况下,如果 --database--table--index--relation 的参数没有匹配到任何对象,则会生成一个致命错误。此选项将该错误降级为警告。

以下命令行选项控制表的检查

--exclude-toast-pointers

默认情况下,每当在表中遇到 TOAST 指针时,都会进行查找,以确保它引用 TOAST 表中似乎有效的条目。这些检查可能非常慢,可以使用此选项来跳过它们。

--on-error-stop

在报告了第一个出现损坏的表页面上的所有损坏之后,停止处理该表关系,然后继续处理下一个表或索引。

请注意,索引检查总是会在第一个损坏的页面后停止。此选项仅对表关系有意义。

--skip=选项

如果给出 all-frozen,则表损坏检查将跳过所有表中标记为“all frozen”的页面。

如果给出 all-visible,则表损坏检查将跳过所有表中标记为“all visible”的页面。

默认情况下,不跳过任何页面。这可以指定为 none,但由于这是默认设置,因此无需提及。

--startblock=块号

从指定的块号开始检查。如果正在检查的表关系拥有的块数少于此数字,则会发生错误。此选项不适用于索引,并且可能仅在检查单个表关系时有用。有关进一步的注意事项,请参阅 --endblock

--endblock=块号

在指定的块号结束检查。如果正在检查的表关系拥有的块数少于此数字,则会发生错误。此选项不适用于索引,并且可能仅在检查单个表关系时有用。如果同时检查普通表和 TOAST 表,此选项将适用于两者,但除非使用 --exclude-toast-pointers 禁用,否则在验证 TOAST 指针时仍可能访问较高编号的 TOAST 块。

以下命令行选项控制 B-tree 索引的检查

--checkunique

对于每个具有唯一约束的索引,使用 amcheckcheckunique 选项,验证索引中可见的重复项不超过一个。

--heapallindexed

对于每个检查的索引,使用 amcheckheapallindexed 选项,验证索引中是否存在所有堆元组作为索引元组。

--parent-check

对于每个检查的 B-tree 索引,使用 amcheckbt_index_parent_check 函数,该函数在索引检查期间执行额外的父/子关系检查。

默认使用 amcheckbt_index_check 函数,但请注意,使用 --rootdescend 选项会隐式选择 bt_index_parent_check

--rootdescend

对于每个检查的索引,使用 amcheckrootdescend 选项,通过为每个元组从根页面重新搜索来查找叶子级别的元组。

使用此选项还会隐式选择 --parent-check 选项。

这种形式的验证最初是为了帮助开发 B-tree 索引功能而编写的。它在帮助检测实际发生的损坏类型方面可能用途有限,甚至没有用途。它还可能导致损坏检查花费更长的时间并在服务器上消耗更多的资源。

警告

当指定 --parent-check--rootdescend 选项时,对 B-tree 索引执行的额外检查需要相对强的关系级别锁。这些检查是唯一会阻止 INSERTUPDATEDELETE 命令进行并发数据修改的检查。

以下命令行选项控制与服务器的连接

-h 主机名
--host=主机名

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

-p 端口
--port=端口

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

-U
--username=用户名

要连接的用户。:

-w
--no-password

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

-W
--password

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

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

--maintenance-db=数据库名

指定用于发现数据库列表的数据库或 连接字符串。如果未使用 --all 或任何包含数据库模式的选项,则不需要此类连接,并且此选项无效。否则,此选项值中包含的其他除数据库名称外的任何连接字符串参数也将在连接到要检查的数据库时使用。如果省略此选项,则默认为 postgres,或者如果失败,则为 template1

还提供其他选项

-e
--echo

将发送到服务器的所有 SQL 回显到 stdout。

-j 数量
--jobs=数量

使用 数量 个并发连接到服务器,或者每个要检查的对象一个连接(取较小者)。

默认使用单个连接。

-P
--progress

显示进度信息。进度信息包括已完成检查的关系数量以及这些关系的总大小。它还包括最终将要检查的关系总数以及这些关系的估计大小。

-v
--verbose

打印更多消息。特别是,这会为每个正在检查的关系打印一条消息,并增加服务器错误显示的详细程度。

-V
--version

打印 pg_amcheck 版本并退出。

--install-missing
--install-missing=模式

安装检查数据库所需的任何缺失的扩展。如果尚未安装,每个扩展的对象将安装到给定的 模式 中,或者如果未指定,则安装到 pg_catalog 模式中。

目前,唯一必需的扩展是 amcheck

-?
--help

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

环境变量

pg_amcheck 与大多数其他 PostgreSQL 工具一样,也使用 libpq 支持的环境变量(请参阅 第 32.15 节)。

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

注释

pg_amcheck 设计用于与 PostgreSQL 14.0 及更高版本配合使用。

另请参阅

amcheck

提交更正

如果您在文档中发现任何不正确、与您的实际经验不符或需要进一步澄清的内容,请使用 此表格 来报告文档问题。