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