pg_ctl
Синтаксис
pg_ctl init[db] [ -s ] [-D datadir] [-o initdb-options]
pg_ctl start [ -w ] [-t секунды] [ -s ] [-D datadir] [-l имя_файла] [-o параметры] [-p path] [ -c ]
pg_ctl stop [ -W ] [-t секунды] [ -s ] [-D datadir] [-m s[mart] | f[ast] | i[mmediate] ]
pg_ctl restart [ -w ] [-t секунды] [ -s ] [-D datadir] [ -c ] [-m s[mart] | f[ast] | i[mmediate] ] [-o параметры]
pg_ctl reload [ -s ] [-D datadir]
pg_ctl status [-D datadir]
pg_ctl promote [ -s ] [-D datadir]
pg_ctl kill signal_name process_id
pg_ctl register [-N servicename] [-U имя_пользователя] [-P пароль] [-D datadir] [-S a[uto] | d[emand] ] [ -w ] [-t секунды] [ -s ] [-o параметры]
pg_ctl unregister [-N servicename]
Описание
pg_ctl — это утилита для начальной инициализации, запуска, остановки, повторного запуска и управления кластером баз данных PostgreSQL ( postgres ). Сервер можно стартовать в ручном режиме, но pg_ctl реализует задачи направления вывода в журнал и отсоединения от терминала и группы процессов, а также предоставляет удобный интерфейс остановки кластера.
Для инициализации нового кластера PostgreSQL используются режимы init или initdb. Кластер — это коллекция баз данных под управлением единого сервера. По факту вызывается команда initdb. За подробностями обратитесь к initdb.
Сервер запускается в режиме start. Процесс работает в фоновом режиме, а стандартный ввод связывается с /dev/null (или nul под управлением Windows). По умолчанию в Unix-подобных системах вывод и ошибки сервера пишутся в устройство стандартного вывода (не ошибок) pg_ctl. Вывод pg_ctl следует перенаправить в файл или процесс, например, приложение ротации журналов rotatelogs; в ином случае, postgres будет писать вывод в управляющий терминал (в фоновом режиме) и останется в группе процессов оболочки. В Windows вывод и ошибки сервера по умолчанию перенаправляются в терминал. Это поведение можно изменить и направить вывод сервера в файл, добавив ключ -l. Мы рекомендуем использовать ключ -l или перенаправлять вывод.
Чтобы остановить сервер, используется stop. Остановить можно в трёх режимах, задаваемых флагом -m. По умолчанию используется режим "Smart", который ожидает завершения всех активных клиентских соединений и удалённых процессов резервирования. Если сервер работает в режиме горячего резервирования, то восстановление и потоковая репликация будут остановлены, как только все клиентские сессии завершаться. Режим "Fast" не ожидает закрытия клиентских сессий и прерывает удалённые процессы резервирования. Все активные транзакции откатываются, а клиенты принудительно отсоединяются, после чего сервер останавливается. Режим "Immediate" незамедлительно прерывает все процессы и останавливает сервер, что приводит на следующем старте к необходимости восстановления после сбоя.
Для остановки с последующим стартом сервера используется restart. При этом доступны флаги команды postgres. restart может не отработать, если при старте сервера в командной строке был указан относительный путь к каталогу хранения данных.
Чтобы перечитать конфигурацию (postgresql.conf, pg_hba.conf и т. д.), используется reload, при этом процесс postgres получает системный сигнал SIGHUP. Это позволяет применить изменения без полного рестарта сервера.
Чтобы проверить статус кластера, используется status. Если кластер запущен, то будет выведен PID процесса, а также команда с использованными при запуске аргументами. Если кластер остановлен, то процесс вернёт статус завершения 3. Если не указан каталог хранения данных, то процесс вернёт статус завершения 4.
Чтобы перевести резервный сервер в режим основного, используется promote. При этом сервер прекращает работу в режиме восстановления и начинает работать в режиме чтения-записи.
Чтобы послать сигнал процессу, используется kill. Это особенно применимо в среде Microsoft Windows, которая не имеет в оснастке команды kill. Чтобы посмотреть список доступных сигналов, обратитесь к справке --help.
Для регистрации в качестве системной службы под управлением Microsoft Windows, используется register. Флаг -S устанавливает режим запуска службы, либо "auto" (на старте ОС), либо "demand" (по запросу).
Чтобы удалить зарегистрированную службу в Microsoft Windows, используется unregister.
Параметры
- -c
--core-file На платформах, где это поддерживается, сервер будет пытаться фиксировать снимки памяти при авариях. Это позволяет диагностировать и предотвращать потенциальные проблемы в будущем.
- -D datadir
--pgdata datadir Указывает размещение конфигурационных файлов кластера. Если не указано, используется значение переменной окружения PGDATA.
- -l имя_файла
--log имя_файла Выводит данные журнала в filename. Файл создаётся, если он ещё не существует. При этом umask выставляется в 077, что предотвращает доступ других пользователей к этому файлу.
- -m режим
--mode режим Устанавливает режим остановки кластера. mode принимает значения smart, fast, или immediate, либо по первой букве каждого из доступных значений, например, s[mart]. Если флаг опущен, то используется smart.
- -o параметры
Указывает флаги, которые будут переданы в postgres.
Значение необходимо обрамлять одинарными или двойными кавычками, чтобы гарантировать целостность группы.
- -o initdb-options
Указывает флаги, которые будут переданы в initdb.
Значение необходимо обрамлять одинарными или двойными кавычками, чтобы гарантировать целостность группы.
- -p path
Указывает размещение приложения postgres. По умолчанию используется тот же путь, по которому находится pg_ctl, либо, если это не удалось, то берётся путь инсталляции. Применять этот параметр чаще всего необходимости нет, кроме нестандартных ситуаций.
init принимает параметры аналогично initdb.
- -s
--silent Выводить лишь ошибки, без сообщений информационного характера.
- -t
--timeout Максимальное время (в секундах) ожидания запуска или остановки сервера. По умолчанию это 60 секунд.
- -V
--version Выводит версию pg_ctl и прерывает выполнение.
- -w
Ожидает завершения запуска или остановки. Это является режимом по умолчанию для операций остановки, но не запуска. На этапе запуска pg_ctl непрерывно пытается подключиться к серверу. На этапе остановки pg_ctl проверяет наличие PID файла. Этот параметр позволяет установить ввод контрольного слова для SSL на старте сервера. pg_ctl возвращает код завершения, основываясь на результате операций запуска или остановки.
- -W
Игнорировать ожидание завершения запуска или остановки сервера. Это поведение используется по умолчанию для режимов запуска и повторного запуска.
- -?
--help Вывести справку по команде pg_ctl и прервать выполнение.
Параметры, специфичные для Windows
- -N servicename
Имя регистрируемой системной службы. Оно используется в качестве системного и отображаемого значения.
- -P пароль
Пароль пользователя, стартующего службу.
- -S тип запуска
Тип запуска системной службы. Может принимать значения: auto, или demand, либо быть представлен первой буквой названия каждого приведённого значения. По умолчанию используется auto.
- -U имя_пользователя
Имя пользователя, от имени которого будут запущена служба. Для доменных пользователей необходимо использовать нотацию DOMAIN\username.
Переменные окружения
- PGDATA
Размещение каталога хранения данных по умолчанию.
pg_ctl, как и большинство других утилит PostgreSQL, также использует переменные окружения, поддерживаемые libpq (см. Раздел 31.14). Другие переменные сервера описаны в postgres .
Files
- postmaster.pid
Наличие файла в каталоге хранения данных помогает pg_ctl определить, работает ли сервер в настоящий момент.
- postmaster.opts
Если файл существует в каталоге хранения данных, то pg_ctl (при restart) передаст его содержимое в качестве аргументов postgres, если не указаны иные значения в -o. Содержимое файла также отображается при вызове в режиме status.
Примеры
Запуск сервера
Для запуска сервера:
$ pg_ctl start
Для запуска сервера с ожиданием готовности к приему подключений:
$ pg_ctl -w start
Для старта сервера на 5433 порту без использования fsync:
$ pg_ctl -o "-F -p 5433" start
Остановка сервера
Для остановки сервера:
$ pg_ctl stop
Параметр -m указывает режим остановки:
$ pg_ctl stop -m fast
Повторный запуск сервера
Повторный запуск сервера производится аналогично остановке с дальнейшим его запуском, за исключением того, что pg_ctl использует аргументы, которые были переданы при предыдущем запуске кластера. В простейшем случае повторный запуск выглядит так:
$ pg_ctl restart
Для повторного запуска сервера с ожиданием полной остановки и последующего запуска:
$ pg_ctl -w restart
Для повторного запуска на 5433 порту с выключенным fsync после старта:
$ pg_ctl -o "-F -p 5433" restart
| Пред. | Начало | След. |
| pg_controldata | Уровень выше | pg_resetxlog |