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