qhb_isready
qhb_isready — проверить состояние соединения с сервером QHB
Синтаксис
qhb_isready [параметр-подключения...] [параметр...]
Описание
qhb_isready — это утилита для проверки состояния соединения с сервером базы данных QHB. Результат проверки соединения указывается в коде завершения.
Параметры
-d имя_бд
--dbname=имя_бд
Задает имя базы данных для подключения. В имени_бд может задаваться
строка подключения. В этом случае параметры в строке подключения переопределяют
любые конфликтующие параметры в командной строке.
-h хост
--host=хост
Задает имя хост-компьютера, на котором работает сервер. Если значение начинается
со слэша, оно используется в качестве каталога для сокета домена Unix.
-p порт
--port=порт
Указывает TCP-порт или расширение файла локального сокета домена Unix, через который
сервер принимает подключения. Значение по умолчанию определяется переменной
среды PGPORT, если она установлена, или значением по умолчанию, заданным при
компиляции (обычно это 5432).
-q
--quiet
Не отображать сообщение о состоянии. Это полезно при выполнении скриптов.
-t секунды
--timeout=секунды
Максимальное количество секунд ожидания при попытке соединения, по истечении
которого будет возвращено сообщение, что сервер не отвечает. При значении 0
выключается. Значение по умолчанию — 3 секунды.
-U имя_пользователя
--username=имя_пользователя
Подключиться к базе данных как пользователь имя_пользователя вместо
пользователя по умолчанию.
-V
--version
Вывести версию qhb_isready и завершиться.
-?
--help
Показать справку об аргументах командной строки qhb_isready и завершиться.
Код завершения
Утилита qhb_isready возвращает оболочке 0, если сервер нормально принимает подключения, 1, если сервер отказывает в подключении (например, во время загрузки), 2, если при попытке подключения нет ответа, и 3, если попыток подключения не было (например, из-за неверных параметров).
Переменные среды
qhb_isready, как и большинство других утилит QHB, использует переменные среды, поддерживаемые libpq (см. раздел Переменные среды).
Переменная среды PG_COLOR указывает, использовать ли цвет в диагностических сообщениях. Возможные значения: always (всегда), auto (автоматически) и never (никогда).
Примечания
Для получения статуса сервера необязательно указывать правильные значения имени пользователя, пароля или имени базы данных, однако при предоставлении неправильных значений сервер запротоколирует в журнал неудачную попытку подключения.
Примеры
Стандартное использование:
$ qhb_isready
/tmp:5432 - accepting connections
$ echo $?
0
Запуск с параметрами подключения во время загрузки кластера QHB:
$ qhb_isready -h localhost -p 5433
localhost:5433 - rejecting connections
$ echo $?
1
Запуск с параметрами подключения при недоступном кластере QHB:
$ qhb_isready -h someremotehost
someremotehost:5432 - no response
$ echo $?
2