PostgreSQL 文档检索
PG 18 · 按类别浏览,或输入名称与关键词
分类索引819
keepalives_interval控制 TCP 保活消息未获服务器确认后,等待多少秒再重新发送。零表示使用系统默认值。通过 Unix 域套接字连接或禁用保活时,此参数被忽略。仅在提供 TCP_KEEPINTVL 或等价套接字选项的系统以及 Windows 上支持;其他系统中无效。
超时与保活
keepalives_interval
客户端库 libpq 10.23
手册定义 手册已记载
源码中的环境变量回退 …连接参数 · 超时与保活
krbsrvnameGSSAPI 认证使用的 Kerberos 服务名。此值必须与服务器配置中的服务名匹配,Kerberos 认证才能成功,另见第 20.6 节。默认值通常为 postgres,但构建 PostgreSQL 时可通过 configure 的 --with-krb-srvnam 选项更改。多数环境无需修改此参数;某些 Kerberos 实现可能要求不同的服务名,例如 Microsof…连接参数 · GSSAPI 与 Kerberos
load_balance_hosts控制客户端尝试连接可用主机和地址的顺序。一旦某次连接尝试成功,就不会再尝试其他主机和地址。该参数通常与多个主机名或返回多个 IP 地址的 DNS 记录一起使用。它还可以与 target_session_attrs 组合使用,例如只在备库之间进行负载均衡。连接一旦成功建立,随后在返回的连接上发出的所有查询都会发送到同一台服务器。目前有两种模式:
连接目标
load_balanc…连接参数 · 连接目标
max_protocol_version这个参数指定要向服务器请求的协议版本。默认会使用 PostgreSQL 协议的 3.0 版本;但如果连接字符串指定了依赖更高协议版本的特性,则会使用 libpq 支持的最新版本。如果服务器不支持客户端请求的协议版本,连接会自动降级为服务器支持的较低次版本协议。连接尝试完成后,你可以使用 PQfullProtocolVersion 来确定最终协商得到的确切协议版本。
会话与协议…连接参数 · 会话与协议
min_protocol_version这个参数指定该连接允许的最低协议版本。默认情况下,允许使用 libpq 所支持的任何 PostgreSQL 协议版本,目前即 3.0 。如果服务器不支持此协议版本或更高版本,则连接将被关闭。
会话与协议
min_protocol_version
客户端库 libpq 18.6
手册定义 手册已记载
源码中的环境变量回退 PGMINPROTOCOLVERSION
编译时回退表达…连接参数 · 会话与协议
oauth_ca_file包含一个或多个 SSL 证书颁发机构( CA )证书的文件名,用于验证授权服务器及其端点的身份。默认使用 Curl 的系统证书包。
身份认证
oauth_ca_file
客户端库 libpq 19beta4
手册定义 手册已记载
源码中的环境变量回退 PGOAUTHCAFILE
编译时回退表达式 NULL
默认值解析与服务文件优先级
以下环境变量可用于选择连接参数的默认值,供…连接参数 · 身份认证
oauth_client_id由授权服务器发放的 OAuth 2.0 客户端标识符。如果 PostgreSQL 服务器为该连接 请求 OAuth 令牌 ,并且没有安装 自定义 OAuth 钩子 来提供该令牌,那么就必须设置此参数;否则连接会失败。
身份认证
oauth_client_id
客户端库 libpq 18.6
手册定义 手册已记载
源码中的环境变量回退 选项表中未声明
编译时回退表达式 NULL…连接参数 · 身份认证
oauth_client_secret与 OAuth 授权服务器通信时要使用的客户端密码(如果有)。该参数是否必需由 OAuth 提供者决定;公开客户端(public client)通常不使用密钥,而机密客户端(confidential client)通常会使用。
身份认证
oauth_client_secret
客户端库 libpq 18.6
手册定义 手册已记载
源码中的环境变量回退 选项表中未声明
编译时回…连接参数 · 身份认证
oauth_issuer如果服务器为该连接请求 OAuth 令牌,要联系的受信任签发者的 HTTPS URL。所有 OAuth 连接都必须设置此参数;它应当与 服务器 HBA 配置 中的 issuer 设置完全一致。
身份认证
oauth_issuer
客户端库 libpq 18.6
手册定义 手册已记载
源码中的环境变量回退 选项表中未声明
编译时回退表达式 NULL
默认值解析与服务文件优先级
…连接参数 · 身份认证
oauth_scope发送给授权服务器的访问请求的授权范围,以空格分隔的 OAuth 授权范围标识符列表指定(列表可以为空)。该参数是可选的,面向高级用法。
身份认证
oauth_scope
客户端库 libpq 18.6
手册定义 手册已记载
源码中的环境变量回退 选项表中未声明
编译时回退表达式 NULL
默认值解析与服务文件优先级
以下环境变量可用于选择连接参数的默认值,供 PQconnec…连接参数 · 身份认证
options指定连接开始时发送到服务器的命令行选项。例如,将其设置为 -c geqo=off 或 --geqo=off 会把会话的 geqo 参数值设为 off 。此字符串中的空格被视为分隔命令行参数,除非用反斜杠( \ )转义;写 \\ 表示字面上的反斜杠。有关可用选项的详细讨论,请参阅 第 19 章 。
会话与协议
指定连接建立时发送给服务器的命令行选项。例如,设为 -c geqo=…连接参数 · 会话与协议
passfile指定用于存储密码的文件名(参见 第 32.15 节 )。默认为 ~/.pgpass ,或在Microsoft Windows上为 %APPDATA%\postgresql\pgpass.conf 。(如果此文件不存在,则不会报告错误。)
身份认证
指定存储密码的文件名,见第 33.15 节。默认为 ~/.pgpass;Microsoft Windows 上为 %APPDATA…连接参数 · 身份认证
password服务器要求密码认证时使用的密码。
身份认证
password
客户端库 libpq 10.23
手册定义 手册已记载
源码中的环境变量回退 PGPASSWORD
编译时回退表达式 NULL
默认值解析与服务文件优先级
以下环境变量可用于选择连接参数的默认值,供 PQconnectdb 、 PQsetdbLogin 和 PQsetdb 在调用代码未直接指定参数值时使用。例如,这…连接参数 · 身份认证
pg_amcheckpg_amcheck — 检查一个或多个 PostgreSQL 数据库中的损坏情况
客户端程序
pg_amcheck [ option ...] [ dbname ]
手册中的可执行程序 pg_amcheck
程序版本 14.24
参考清单 客户端程序
选项定义组 35
手册中的选项
检查所有数据库,但通过 --exclude-database 排除的除外。 -a --all…命令行工具 · 客户端程序
pg_amcheck --all-a--all
检查所有数据库,但通过--exclude-database排除的除外。pg_amcheck › 选项
pg_amcheck --checkunique--checkunique
对于检查的每个带唯一约束的索引,使用amcheck的checkunique选项,验证重复条目中在索引里可见的项不超过一个。pg_amcheck › 选项
pg_amcheck --database=pattern-d pattern--database=pattern
检查匹配指定pattern的数据库,但通过--exclude-database排除的除外。此选项可指定多次。pg_amcheck › 选项
pg_amcheck --echo-e--echo
将发送到服务器的所有 SQL 回显到标准输出。pg_amcheck › 选项
pg_amcheck --endblock=block--endblock=block
在指定块号结束检查。如果被检查的表关系块数少于这个数字,将发生错误。此选项不适用于索引,而且大概只在检查单个表关系时才有用。如果同时检查普通表和 TOAST 表,此选项会同时作用于两者;但在验证 TOAST 指针时,仍可能访问更高编号的 TOAST 块,除非使用--exclude-toast-pointers抑制这一行为。pg_amcheck › 选项
pg_amcheck --exclude-database=pattern-D pattern--exclude-database=pattern
排除匹配指定pattern的数据库。此选项可指定多次。pg_amcheck › 选项
pg_amcheck --exclude-index=pattern-I pattern--exclude-index=pattern
排除匹配指定pattern的索引。此选项可指定多次。 这与--exclude-relation选项类似,但它只适用于索引,不适用于其他关系类型。pg_amcheck › 选项
pg_amcheck --exclude-relation=pattern-R pattern--exclude-relation=pattern
排除匹配指定pattern的关系。此选项可指定多次。 与--relation一样,pattern可以是未经限定的、模式限定的,或者同时带数据库限定和模式限定的。pg_amcheck › 选项
pg_amcheck --exclude-schema=pattern-S pattern--exclude-schema=pattern
排除匹配指定pattern的模式中的表和索引。此选项可指定多次。 与--schema一样,该模式可以带数据库限定。pg_amcheck › 选项
pg_amcheck --exclude-table=pattern-T pattern--exclude-table=pattern
排除匹配指定pattern的表。此选项可指定多次。 这与--exclude-relation选项类似,但它只适用于表、物化视图和序列,不适用于索引。pg_amcheck › 选项
pg_amcheck --exclude-toast-pointers--exclude-toast-pointers
默认情况下,只要在表中遇到 TOAST 指针,就会执行查找,以确保它引用的是 TOAST 表中表面看来有效的条目。这些检查可能相当慢,可用此选项跳过。pg_amcheck › 选项
pg_amcheck --heapallindexed--heapallindexed
对于检查的每个索引,使用amcheck的heapallindexed选项,验证所有堆元组都以索引元组的形式出现在该索引中。pg_amcheck › 选项
pg_amcheck --help-?--help
显示pg_amcheck命令行参数的帮助并退出。pg_amcheck › 选项
pg_amcheck --host=hostname-h hostname--host=hostname
指定服务器所在机器的主机名。如果该值以斜杠开头,则将其用作 Unix 域套接字所在的目录。pg_amcheck › 选项
pg_amcheck --index=pattern-i pattern--index=pattern
检查匹配指定pattern的索引,除非另有排除。此选项可指定多次。 这与--relation选项类似,但它只适用于索引,不适用于其他关系类型。pg_amcheck › 选项
pg_amcheck --install-missing=schema--install-missing--install-missing=schema
安装检查数据库所需的任何缺失扩展。如果某个扩展尚未安装,则其对象将安装到给定的schema中;如果未指定,则安装到pg_catalog模式中。 目前,唯一必需的扩展是amcheck。pg_amcheck › 选项
pg_amcheck --jobs=num-j num--jobs=num
使用num个到服务器的并发连接,或者为每个待检查对象使用一个连接,以较小者为准。 默认使用单个连接。pg_amcheck › 选项
pg_amcheck --maintenance-db=dbname--maintenance-db=dbname
指定一个数据库或连接字符串,用于确定待检查的数据库列表。如果既未使用--all,也未使用任何包含数据库名称匹配模式的选项,则不需要这样的连接,此选项也不起作用。否则,此选项值中除数据库名之外的任何连接字符串参数,在连接待检查的数据库时也会一并使用。如果省略此选项,默认值为postgres;若失败,则为template1。pg_amcheck › 选项
pg_amcheck --no-dependent-indexes--no-dependent-indexes
默认情况下,如果检查某个表,则该表上的任何 B-树索引也会一并检查,即使它们没有通过--index或--relation等选项显式选中。此选项会禁止这种行为。pg_amcheck › 选项
pg_amcheck --no-dependent-toast--no-dependent-toast
默认情况下,如果检查某个表,则它的 TOAST 表(如果有)也会一并检查,即使该 TOAST 表没有通过--table或--relation等选项显式选中。此选项会禁止这种行为。pg_amcheck › 选项
pg_amcheck --no-password-w--no-password
永不发出密码提示。如果服务器要求密码认证,而又无法通过其他方式获取密码,例如通过.pgpass文件,则连接尝试会失败。此选项可用于没有用户在场输入密码的批处理作业和脚本。pg_amcheck › 选项
pg_amcheck --no-strict-names--no-strict-names
默认情况下,如果--database、--table、--index或--relation的某个参数没有匹配到任何对象,就会报致命错误。此选项会将该错误降级为警告。pg_amcheck › 选项
pg_amcheck --on-error-stop--on-error-stop
在某个表中发现损坏后,在报告完该表第一个损坏页面上的全部损坏后,停止处理该表关系并转到下一个表或索引。 注意,索引检查总是在第一个损坏页后停止。此选项只对表关系有意义。pg_amcheck › 选项
pg_amcheck --parent-check--parent-check
对于检查的每个 B-树索引,使用amcheck的bt_index_parent_check函数,该函数会在索引检查期间额外检查父子关系。 默认使用amcheck的bt_index_check函数,但请注意,使用--rootdescend选项会隐式选择bt_index_parent_check。pg_amcheck › 选项
pg_amcheck --password-W--password
强制pg_amcheck在连接数据库前提示输入密码。 该选项并非必需,因为如果服务器要求密码认证,pg_amcheck会自动提示输入密码。不过,pg_amcheck会先浪费一次连接尝试,才能发现服务器需要密码。在某些场景下,值得显式指定-W,以避免这次额外的连接尝试。pg_amcheck › 选项
pg_amcheck --port=port-p port--port=port
指定服务器监听连接的 TCP 端口或本地 Unix 域套接字文件扩展名。pg_amcheck › 选项
更多结果
输入名称或关键词,从 PostgreSQL 手册与扩展目录中直接找到定义。
pg17: 限定版本 ex: 只搜扩展 ↑↓ 选择 ↵ 打开