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 |
pg_ctl
Synopsis
pg_ctl init[db] [-s] [-D datadir] [-o initdb-options]
pg_ctl start [-w] [-t seconds] [-s] [-D datadir] [-l filename] [-o options] [-p path] [-c]
pg_ctl stop [-W] [-t seconds] [-s] [-D datadir] [-m s[mart] | f[ast] | i[mmediate] ]
pg_ctl restart [-w] [-t seconds] [-s] [-D datadir] [-c] [-m s[mart] | f[ast] | i[mmediate] ] [-o options]
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 username] [-P password] [-D datadir] [-S a[uto] | d[emand] ] [-w] [-t seconds] [-s] [-o options]
pg_ctl unregister [-N servicename]
Description
pg_ctl is a utility for initializing a PostgreSQL database cluster, starting, stopping, or restarting the PostgreSQL database server (postgres), or displaying the status of a running server. Although the server can be started manually, pg_ctl encapsulates tasks such as redirecting log output and properly detaching from the terminal and process group. It also provides convenient options for controlled shutdown.
The init or initdb mode creates a new PostgreSQL database cluster. A database cluster is a collection of databases that are managed by a single server instance. This mode invokes the initdb command. See initdb for details.
In start mode, a new server is launched. The server is started in the background, and its standard input is attached to /dev/null (or nul on Windows). On Unix-like systems, by default, the server's standard output and standard error are sent to pg_ctl's standard output (not standard error). The standard output of pg_ctl should then be redirected to a file or piped to another process such as a log rotating program like rotatelogs; otherwise postgres will write its output to the controlling terminal (from the background) and will not leave the shell's process group. On Windows, by default the server's standard output and standard error are sent to the terminal. These default behaviors can be changed by using -l to append the server's output to a log file. Use of either -l or output redirection is recommended.
In stop mode, the server that is running in the specified data directory is shut down. Three different shutdown methods can be selected with the -m option. "Smart" mode (the default) waits for all active clients to disconnect and any online backup to finish. If the server is in hot standby, recovery and streaming replication will be terminated once all clients have disconnected. "Fast" mode does not wait for clients to disconnect and will terminate an online backup in progress. All active transactions are rolled back and clients are forcibly disconnected, then the server is shut down. "Immediate" mode will abort all server processes immediately, without a clean shutdown. This will lead to a crash-recovery run on the next restart.
restart mode effectively executes a stop followed by a start. This allows changing the postgres command-line options. restart might fail if relative paths specified were specified on the command-line during server start.
reload mode simply sends the postgres process a SIGHUP signal, causing it to reread its configuration files (postgresql.conf, pg_hba.conf, etc.). This allows changing of configuration-file options that do not require a complete restart to take effect.
status mode checks whether a server is running in the specified data directory. If it is, the PID and the command line options that were used to invoke it are displayed. If the server is not running, the process returns an exit status of 3. If an accessible data directory is not specified, the process returns an exit status of 4.
In promote mode, the standby server that is running in the specified data directory is commanded to exit recovery and begin read-write operations.
kill mode allows you to send a signal to a specified process. This is particularly valuable for Microsoft Windows which does not have a kill command. Use --help to see a list of supported signal names.
register mode allows you to register a system service on Microsoft Windows. The -S option allows selection of service start type, either "auto" (start service automatically on system startup) or "demand" (start service on demand).
unregister mode allows you to unregister a system service on Microsoft Windows. This undoes the effects of the register command.
Options
- -c
--core-file Attempt to allow server crashes to produce core files, on platforms where this is possible, by lifting any soft resource limit placed on core files. This is useful in debugging or diagnosing problems by allowing a stack trace to be obtained from a failed server process.
- -D datadir
--pgdata datadir Specifies the file system location of the database configuration files. If this is omitted, the environment variable PGDATA is used.
- -l filename
--log filename Append the server log output to filename. If the file does not exist, it is created. The umask is set to 077, so access to the log file is disallowed to other users by default.
- -m mode
--mode mode Specifies the shutdown mode. mode can be smart, fast, or immediate, or the first letter of one of these three. If this is omitted, smart is used.
- -o options
Specifies options to be passed directly to the postgres command.
The options should usually be surrounded by single or double quotes to ensure that they are passed through as a group.
- -o initdb-options
Specifies options to be passed directly to the initdb command.
The options should usually be surrounded by single or double quotes to ensure that they are passed through as a group.
- -p path
Specifies the location of the postgres executable. By default the postgres executable is taken from the same directory as pg_ctl, or failing that, the hard-wired installation directory. It is not necessary to use this option unless you are doing something unusual and get errors that the postgres executable was not found.
In init mode, this option analogously specifies the location of the initdb executable.
- -s
--silent Print only errors, no informational messages.
- -t
--timeout The maximum number of seconds to wait when waiting for startup or shutdown to complete. The default is 60 seconds.
- -V
--version Print the pg_ctl version and exit.
- -w
Wait for the startup or shutdown to complete. Waiting is the default option for shutdowns, but not startups. When waiting for startup, pg_ctl repeatedly attempts to connect to the server. When waiting for shutdown, pg_ctl waits for the server to remove its PID file. This option allows the entry of an SSL passphrase on startup. pg_ctl returns an exit code based on the success of the startup or shutdown.
- -W
Do not wait for startup or shutdown to complete. This is the default for start and restart modes.
- -?
--help Show help about pg_ctl command line arguments, and exit.
Options for Windows
- -N servicename
Name of the system service to register. The name will be used as both the service name and the display name.
- -P password
Password for the user to start the service.
- -S start-type
Start type of the system service to register. start-type can be auto, or demand, or the first letter of one of these two. If this is omitted, auto is used.
- -U username
User name for the user to start the service. For domain users, use the format DOMAIN\username.
Environment
- PGDATA
Default data directory location.
pg_ctl, like most other PostgreSQL utilities, also uses the environment variables supported by libpq (see Section 31.14). For additional server variables, see postgres.
Files
- postmaster.pid
The existence of this file in the data directory is used to help pg_ctl determine if the server is currently running.
- postmaster.opts
If this file exists in the data directory, pg_ctl (in restart mode) will pass the contents of the file as options to postgres, unless overridden by the -o option. The contents of this file are also displayed in status mode.
Examples
Starting the Server
To start the server:
$ pg_ctl start
To start the server, waiting until the server is accepting connections:
$ pg_ctl -w start
To start the server using port 5433, and running without fsync, use:
$ pg_ctl -o "-F -p 5433" start
Stopping the Server
To stop the server, use:
$ pg_ctl stop
The -m option allows control over how the server shuts down:
$ pg_ctl stop -m fast
Restarting the Server
Restarting the server is almost equivalent to stopping the server and starting it again, except that pg_ctl saves and reuses the command line options that were passed to the previously running instance. To restart the server in the simplest form, use:
$ pg_ctl restart
To restart the server, waiting for it to shut down and restart:
$ pg_ctl -w restart
To restart using port 5433, disabling fsync upon restart:
$ pg_ctl -o "-F -p 5433" restart
