pg_isready
pg_isready — 检查 PostgreSQL 服务器的连接状态
当前查看 PostgreSQL 18.6。
说明
pg_isready — 检查 PostgreSQL 服务器的连接状态
- 手册中的可执行程序
- pg_isready
- 程序版本
- 18.6
- 参考清单
- 客户端程序
- 选项定义组
- 8
用法
pg_isready [ connection-option ...] [ option ...]手册中的选项
| 选项与参数 | 说明 |
|---|---|
| -d dbname --dbname= dbname | 指定要连接的数据库名称。 dbname 也可以是 连接字符串 。如果是这样，连接字符串中的参数将覆盖任何冲突的命令行选项。 |
| -h hostname --host= hostname | 指定服务器所在机器的主机名。如果值以斜杠开头，则被用作 Unix 域套接字的目录。 |
| -p port --port= port | 指定服务器监听连接的 TCP 端口，或本地 Unix 域套接字的文件名后缀。默认使用 PGPORT 环境变量的值；未设置时，使用编译时指定的端口，通常为 5432。 |
| -q --quiet | 不显示状态消息。这在编写脚本时很有用。 |
| -t seconds --timeout= seconds | 在尝试连接时，返回服务器无响应之前等待的最大秒数。设为 0 表示禁用。默认值为 3 秒。 |
| -U username --username= username | 以用户 username 连接到数据库，而不是使用默认用户。 |
| -V --version | 打印 pg_isready 版本并退出。 |
| -? --help | 显示有关 pg_isready 命令行参数的帮助并退出。 |
手册定义
pg_isready
pg_isready — 检查PostgreSQL服务器的连接状态
大纲
pg_isready [connection-option...] [option...]
说明
pg_isready是一个用于检查 PostgreSQL数据库服务器连接状态的工具。其退出状态指示连接检查的结果。
选项
-ddbname--dbname=dbname-
指定要连接的数据库名称。
dbname也可以是连接字符串。如果是这样，连接字符串中的参数将覆盖任何冲突的命令行选项。 -hhostname--host=hostname-
指定服务器所在机器的主机名。如果值以斜杠开头，则被用作 Unix 域套接字的目录。
-pport--port=port-
指定服务器监听连接的 TCP 端口，或本地 Unix 域套接字的文件名后缀。默认使用 PGPORT 环境变量的值；未设置时，使用编译时指定的端口，通常为 5432。
-q--quiet-
不显示状态消息。这在编写脚本时很有用。
-tseconds--timeout=seconds-
在尝试连接时，返回服务器无响应之前等待的最大秒数。设为 0 表示禁用。默认值为 3 秒。
-Uusername--username=username-
以用户
username连接到数据库，而不是使用默认用户。 -V--version-
打印pg_isready版本并退出。
-?--help-
显示有关pg_isready命令行参数的帮助并退出。
退出状态
如果服务器正常接受连接，pg_isready会向 shell 返回0；如果服务器拒绝连接（例如处于启动阶段），则返回1；如果连接尝试未得到响应，则返回 2；如果未发起连接尝试（例如由于参数非法），则返回3。
环境
与大多数其他PostgreSQL工具一样，pg_isready也使用libpq 支持的环境变量（见第 32.15 节）。
环境变量PG_COLOR指定是否在诊断消息中使用颜色。可能的值为always、auto和never。
注解
要获得服务器状态，无需提供正确的用户名、密码或数据库名。不过，如果提供了不正确的值，服务器会记录一次失败的连接尝试。
示例
标准用法：
$pg_isready/tmp:5432 - accepting connections$echo $?0
使用连接参数检查一个处于启动阶段的 PostgreSQL集簇：
$pg_isready -h localhost -p 5433localhost:5433 - rejecting connections$echo $?1
使用连接参数检查一个无响应的 PostgreSQL集簇：
$pg_isready -h someremotehostsomeremotehost:5432 - no response$echo $?2
文档与源码
来源构建
- 版本
- 18.6
- 构建
- https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2
- 来源指纹
ee8d1a3612338fd9adf250730cb640fcc5233b5491337cc00a316a44e3a0b9f8
版本比较
PostgreSQL 17 → 18: 无变化。
比较已记录的接口与属性，排除来源指纹和构建元数据。某个样本中没有记录，不能据此判断实际引入或移除的版本。
相关条目
导出 JSON · 返回命令行工具 · 收录范围为 PostgreSQL 10 至 20；最早采样版本不一定是实际引入版本。