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=секундыМаксимальное время ожидания (в секундах) при попытке подключения, по истечении которого констатируется, что сервер не отвечает. Значение по умолчанию — 3 секунды.
-Uимя_пользователя--username=имя_пользователяПодключиться к базе данных с заданным именем пользователя вместо подразумеваемого по умолчанию.
-V--versionСообщить версию pg_isready и завершиться.
-?--helpПоказать справку по аргументам командной строки pg_isready и завершиться.
Код завершения
Утилита pg_isready возвращает в оболочку 0, если сервер принимает подключения, 1, если он сбрасывает подключения (например, во время загрузки), 2, если при попытке подключения не получен ответ, и 3, если попытки подключения не было (например, из-за некорректных параметров).
Переменные окружения
Как и большинство других утилит PostgreSQL, pg_isready также использует переменные среды, поддерживаемые libpq (см. Раздел 34.14).
Замечания
Чтобы получить состояние сервера, передавать имя пользователя, пароль и имя базы данных не требуется; но если передать некорректные значения, сервер выведет в журнал сообщение о неудачной попытке подключения.
Примеры
Обычное использование:
$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