pg_amcheck

-a
--all

检查所有数据库，但通过 --exclude-database 排除的除外。

-d pattern
--database=pattern

检查匹配指定 pattern 的数据库，但通过 --exclude-database 排除的除外。此选项可指定多次。

-D pattern
--exclude-database=pattern

排除匹配指定 pattern 的数据库。此选项可指定多次。

-i pattern
--index=pattern

检查匹配指定 pattern 的索引，除非另有排除。此选项可指定多次。

这与 --relation 选项类似，但它只适用于索引，不适用于其他关系类型。

-I pattern
--exclude-index=pattern

排除匹配指定 pattern 的索引。此选项可指定多次。

这与 --exclude-relation 选项类似，但它只适用于索引，不适用于其他关系类型。

-r pattern
--relation=pattern

检查匹配指定 pattern 的关系，除非另有排除。此选项可指定多次。

匹配模式可以是未经限定的，例如 myrel*；也可以是模式限定的，例如 myschema*.myrel*；或者同时带数据库限定和模式限定，例如 mydb*.myschema*.myrel*。数据库限定的模式会把匹配的数据库加入待检查数据库列表。

-R pattern
--exclude-relation=pattern

排除匹配指定 pattern 的关系。此选项可指定多次。

与 --relation 一样，pattern 可以是未经限定的、模式限定的，或者同时带数据库限定和模式限定的。

-s pattern
--schema=pattern

检查匹配指定 pattern 的模式中的表和索引，除非另有排除。此选项可指定多次。

若只想选择名称匹配特定模式的那些模式中的表，可考虑使用类似 --table=SCHEMAPAT.* --no-dependent-indexes 的写法。若只想选择索引，可考虑使用类似 --index=SCHEMAPAT.* 的写法。

模式匹配串可以带数据库限定。例如，可以写 --schema=mydb*.myschema*，以在匹配 mydb* 的数据库中选择匹配 myschema* 的模式。

-S pattern
--exclude-schema=pattern

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

与 --schema 一样，该模式可以带数据库限定。

-t pattern
--table=pattern

检查匹配指定 pattern 的表，除非另有排除。此选项可指定多次。

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

-T pattern
--exclude-table=pattern

排除匹配指定 pattern 的表。此选项可指定多次。

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

--no-dependent-indexes

默认情况下，如果检查某个表，则该表上的任何 B-树索引也会一并检查，即使它们没有通过 --index 或 --relation 等选项显式选中。此选项会禁止这种行为。

--no-dependent-toast

默认情况下，如果检查某个表，则它的 TOAST 表（如果有）也会一并检查，即使该 TOAST 表没有通过 --table 或 --relation 等选项显式选中。此选项会禁止这种行为。

--no-strict-names

默认情况下，如果 --database、--table、--index 或 --relation 的某个参数没有匹配到任何对象，就会报致命错误。此选项会将该错误降级为警告。

--exclude-toast-pointers

默认情况下，只要在表中遇到 TOAST 指针，就会执行查找，以确保它引用的是 TOAST 表中表面看来有效的条目。这些检查可能相当慢，可用此选项跳过。

--on-error-stop

在某个表中发现损坏后，在报告完该表第一个损坏页面上的全部损坏后，停止处理该表关系并转到下一个表或索引。

注意，索引检查总是在第一个损坏页后停止。此选项只对表关系有意义。

--skip=option

如果给定 all-frozen，表损坏检查会跳过所有表中标记为全冻结的页面。

如果给定 all-visible，表损坏检查会跳过所有表中标记为全可见的页面。

默认不跳过任何页面。这可以显式指定为 none，但因为这是默认值，通常无需写出。

--startblock=block

从指定块号开始检查。如果被检查的表关系块数少于这个数字，将发生错误。此选项不适用于索引，而且大概只在检查单个表关系时才有用。进一步的注意事项见 --endblock。

--endblock=block

在指定块号结束检查。如果被检查的表关系块数少于这个数字，将发生错误。此选项不适用于索引，而且大概只在检查单个表关系时才有用。如果同时检查普通表和 TOAST 表，此选项会同时作用于两者；但在验证 TOAST 指针时，仍可能访问更高编号的 TOAST 块，除非使用 --exclude-toast-pointers 抑制这一行为。

--checkunique

对于检查的每个带唯一约束的索引，使用 amcheck 的 checkunique 选项，验证重复条目中在索引里可见的项不超过一个。

--heapallindexed

对于检查的每个索引，使用 amcheck 的 heapallindexed 选项，验证所有堆元组都以索引元组的形式出现在该索引中。

--parent-check

对于检查的每个 B-树索引，使用 amcheck 的 bt_index_parent_check 函数，该函数会在索引检查期间额外检查父子关系。

默认使用 amcheck 的 bt_index_check 函数，但请注意，使用 --rootdescend 选项会隐式选择 bt_index_parent_check。

--rootdescend

对于检查的每个索引，使用 amcheck 的 rootdescend 选项，为每个元组从根页重新执行一次搜索，从而在叶级重新找到这些元组。

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

这种验证形式最初是为协助开发 B-树索引特性而编写的。它在帮助检测实际发生的那类损坏方面可能用途有限，甚至毫无帮助。它还可能使损坏检查耗时显著增加，并显著增加服务器上的资源消耗。

警告

当指定 --parent-check 或 --rootdescend 时，对 B-树索引执行的额外检查需要相对较强的关系级锁。这些检查也是唯一会阻塞 INSERT、UPDATE 和 DELETE 命令并发修改数据的检查。

-h hostname
--host=hostname

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

-p port
--port=port

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

-U
--username=username

连接时使用的用户名。

-w
--no-password

永不发出密码提示。如果服务器要求密码认证，而又无法通过其他方式获取密码，例如通过.pgpass 文件，则连接尝试会失败。此选项可用于没有用户在场输入密码的批处理作业和脚本。

-W
--password

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

该选项并非必需，因为如果服务器要求密码认证，pg_amcheck 会自动提示输入密码。不过，pg_amcheck 会先浪费一次连接尝试，才能发现服务器需要密码。在某些场景下，值得显式指定 -W，以避免这次额外的连接尝试。

--maintenance-db=dbname

指定一个数据库或连接字符串，用于确定待检查的数据库列表。如果既未使用 --all，也未使用任何包含数据库名称匹配模式的选项，则不需要这样的连接，此选项也不起作用。否则，此选项值中除数据库名之外的任何连接字符串参数，在连接待检查的数据库时也会一并使用。如果省略此选项，默认值为 postgres；若失败，则为 template1。

-e
--echo

将发送到服务器的所有 SQL 回显到标准输出。

-j num
--jobs=num

使用 num 个到服务器的并发连接，或者为每个待检查对象使用一个连接，以较小者为准。

默认使用单个连接。

-P
--progress

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

-v
--verbose

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

-V
--version

打印 pg_amcheck 版本并退出。

--install-missing
--install-missing=schema

安装检查数据库所需的任何缺失扩展。如果某个扩展尚未安装，则其对象将安装到给定的 schema 中；如果未指定，则安装到 pg_catalog 模式中。

目前，唯一必需的扩展是 amcheck。

-?
--help

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