2024年9月26日: PostgreSQL 17 发布!
支持的版本:当前 (17) / 16 / 15 / 14 / 13 / 12
开发版本:devel
不支持的版本:11 / 10 / 9.6 / 9.5 / 9.4 / 9.3

pg_isready

pg_isready — 检查 PostgreSQL 服务器的连接状态

概要

pg_isready [连接选项...] [选项...]

描述

pg_isready 是一个用于检查 PostgreSQL 数据库服务器连接状态的实用程序。退出状态指定连接检查的结果。

选项

-d 数据库名
--dbname=数据库名

指定要连接到的数据库的名称。 数据库名 可以是 连接字符串。如果是,连接字符串参数将覆盖任何冲突的命令行选项。

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

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

-p 端口
--port=端口

指定服务器正在监听连接的 TCP 端口或本地 Unix 域套接字文件扩展名。默认为 PGPORT 环境变量的值,如果未设置,则默认为编译时指定的端口,通常为 5432。

-q
--quiet

不显示状态消息。这在编写脚本时很有用。

-t 秒数
--timeout=秒数

尝试连接时等待的最长时间(以秒为单位),然后返回服务器无响应。设置为 0 将禁用。默认为 3 秒。

-U 用户名
--username=用户名

以用户 用户名 而不是默认用户连接到数据库。

-V
--version

打印 pg_isready 版本并退出。

-?
--help

显示有关 pg_isready 命令行参数的帮助,并退出。

退出状态

pg_isready 如果服务器正常接受连接,则返回 0 给 shell,如果服务器拒绝连接(例如在启动期间),则返回 1,如果连接尝试没有响应,则返回 2,如果未进行任何尝试(例如由于参数无效),则返回 3

环境

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

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

注释

无需提供正确的用户名、密码或数据库名称值即可获取服务器状态;但是,如果提供了不正确的值,服务器将记录连接尝试失败。

示例

标准用法

$ pg_isready
/tmp:5432 - accepting connections
$ echo $?
0

使用连接参数运行启动中的 PostgreSQL 集群

$ pg_isready -h localhost -p 5433
localhost:5433 - rejecting connections
$ echo $?
1

使用连接参数运行无响应的 PostgreSQL 集群

$ pg_isready -h someremotehost
someremotehost:5432 - no response
$ echo $?
2

提交更正

如果您在文档中看到任何不正确的内容,与您对特定功能的体验不符或需要进一步说明,请使用 此表单 报告文档问题。