金仓数据库KingbaseES客户端应用参考手册--13. sys_isready
目录
13.1. 简介 ¶
13.2. 命令行参数 ¶
13.3. 参数说明 ¶
13.4. 环境变量 ¶
13.5. 错误信息诊断 ¶
13.6. 示例 ¶
13.7. 备注 ¶
13.7.1. 退出状态 ¶
13.8. 参考 ¶
13.1. 简介 ¶
sys_isready — 检查KingbaseES服务器的连接状态
sys_isready 是一个用于检查KingbaseES数据库服务器的连接状态的工具。通过退出状态展示连接检查的结果。
13.2. 命令行参数 ¶
sys_isready [ connection-option ...] [ option ...]
13.3. 参数说明 ¶
-d dbname --dbname=dbname
指定要连接的数据库名。
如果这个参数包含一个
=记号或者以一个合法的URI前缀（kingbase://或kingbase://）开头，它会被视作一个 ``conninfo`` 字符串。
-h hostname --host=hostname
指定运行服务器的机器的主机名。如果该值以一个斜线开始，它会被视作 Unix 域套接字的目录。
--port=port --port=port
指定服务器监听连接的 TCP 端口或本地 Unix 域套接字文件扩展。默认值取自
KINGBASE_PORT环境变量。如果环境变量没有设置，则默认值使用编译时指定的端口（通常是 54321）。
-q --quiet
不显示状态消息。用于脚本编程的场景。
-t seconds --timeout=seconds
尝试连接时，在返回服务器未响应之前等待的最大秒数。设置为 0 则禁用。默认值是 3 秒。
-U username --username=username
作为用户 ``username`` 连接数据库，而不是用默认用户。
-V --version
打印sys_isready版本并退出。
-? --help
显示有关sys_isready命令行参数的帮助并退出。
13.4. 环境变量 ¶
和大部分其他KingbaseES工具相似， sys_isready 也使用libkci支持的环境变量。
环境变量 SYS_COLOR 指定是否在诊断消息中使用颜色。可能的值是 always , auto , never 。
13.5. 错误信息诊断 ¶
无
13.6. 示例 ¶
标准用法：
$ sys_isready /tmp:54321 - accepting connections $ echo $? 0
使用连接参数运行连接到处于启动中的KingbaseES集簇（该启动中状态通常只持续1~2秒）：
$ sys_isready -h localhost -p 5433 localhost:5433 - rejecting connections $ echo $? 1
使用连接参数运行连接到无响应的KingbaseES集簇：
$ sys_isready -h someremotehost someremotehost:54321 - no response $ echo $? 2
13.7. 备注 ¶
要获得服务器状态，不一定需要提供正确的用户名、口令或数据库名。但如果提供了不正确的值，服务器将会记录一次失败的尝试连接。
13.7.1. 退出状态 ¶
如果服务器正常接受连接，sys_isready返回 0 给 shell；如果服务器拒绝连接（例如处于启动阶段）则返回 1 ；如果连接尝试没有被响应则返回 2 ；如果没有尝试（例如由于非法参数）则返回 3 。
13.8. 参考 ¶
无