pg_isready

примечание

Эта страница переведена при помощи нейросети GigaChat.

pg_isready — проверяет состояние соединения с сервером PostgreSQL.

Синтаксис

pg_isready [connection-option...] [option...]

Описание

pg_isready — утилита для проверки состояния подключения к серверу базы данных PostgreSQL. Код завершения указывает результат проверки соединения.

Параметры

Для утилиты pg_isready существуют следующие параметры командной строки:

-d dbname
--dbname=dbname

Задает имя базы данных для подключения. dbname может быть строку подключения. В этом случае параметры строки подключения имеют приоритет над одноименными параметрами командной строки.

-h hostname
--host=hostname

Указывает хост компьютера, на котором запущен сервер. Если значение начинается с косой черты, оно определяет каталог Unix-сокета.

-p port
--port=port

Указывает TCP-порт или расширение файла локального Unix-сокета для подключения к серверу. Значение по умолчанию берется из переменной окружения PGPORT или задается при компиляции, j,sxyj 5432.

-q
--quiet

Не отображает сообщение о состоянии. Полезно при написании сценариев.

-t seconds
--timeout=seconds

Устанавливает максимальное время ожидания (в секундах) при попытке подключения к серверу. Если подключение не будет установлено за указанный период, будет выдано сообщение о недоступности сервера. Значение 0 отключает таймаут. По умолчанию используется 3 секунды.

-U username
--username=username

Указывает имя пользователя для подключения.

-V
--version

Выводит версию pg_isready и завершается.

-?
--help

Показывает справку о параметрах командной строки утилиты pg_isready и завершается.

Код завершения

pg_isready возвращает:

• 0, если сервер успешно принимает соединения;
• 1, если сервер отклоняет соединения (например, в процессе запуска);
• 2, если сервер не ответил на попытку подключения;
• 3, если подключение не было инициировано (например, из-за некорректных параметров).

Переменные окружения

Утилита pg_isready использует переменные окружения, поддерживаемые libpq.

Переменная окружения PG_COLOR указывает, использовать ли цвет в диагностических сообщениях. Возможные значения — always, auto и never.

Примечания

Для проверки состояния сервера не нужно указывать имя пользователя, пароль и имя базы данных. Но при указании некорректных данных сервер может зарегистрировать неудачную попытку подключения.

Примеры

Стандартное использование:

$ pg_isready
/tmp:5432 - accepting connections
$ echo $?
0

Запуск с параметрами подключения к кластеру PostgreSQL при запуске:

$ pg_isready -h localhost -p 5433
localhost:5433 - rejecting connections
$ echo $?
1

Запуск с параметрами подключения к не отвечающему кластеру PostgreSQL:

$ pg_isready -h someremotehost
someremotehost:5432 - no response
$ echo $?
2