pg_isready
Описание
Утилита pg_isready предназначена для проверки соединения с сервером баз данных PostgreSQL. Результат проверки передаётся в коде завершения.
Параметры
- -d база_данных
--dbname=база_данных Задаёт имя базы данных, к которой нужно подключиться.
Если этот параметр содержит знак = или начинается с допустимого префикса URI (postgresql:// или postgres://), он воспринимается как строка conninfo. За дополнительными сведениями обратитесь к Подразделу 31.1.1.
- -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 (см. Раздел 31.14).
Замечания
Чтобы получить состояние сервера, передавать имя пользователя, пароль и имя базы данных не требуется; но если передать некорректные значения, сервер выведет в журнал сообщение о неудачной попытке подключения.
Примеры
Обычное использование:
$ 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
| Пред. | Начало | След. |
| pg_dumpall | Уровень выше | pg_receivexlog |