postgres
postgres — сервер баз данных PostgreSQL
Синтаксис
postgres
[параметр
...]
Описание
postgres
это сервер баз данных PostgreSQL. Для получения доступа к базе данных клиент устанавливает соединение (локально или по сети) с сервером postgres
. После установки соединения сервер postgres
поднимает выделенный процесс для его обслуживания.
Один экземпляр postgres
всегда управляет данными ровно одного кластера баз данных. Кластер — это коллекция баз данных, хранящихся в файловой системе в определённом размещении («области данных»). На одном физическом сервере можно запустить несколько экземпляров postgres
одновременно, при условии, что они используют различные области данных и порты. При запуске postgres
необходимо указать размещение данных, которое задаётся в параметре -D
или переменной окружения PGDATA
, значение по умолчанию отсутствует. Обычно -D
или PGDATA
указывает на каталог, созданный во время развёртывания кластера с помощью initdb. Иные варианты рассмотрены в Разделе 20.2.
По умолчанию postgres
запускается не в фоновом режиме, а вывод журнала осуществляет в стандартный поток ошибок. На практике postgres
должен запускаться в фоновом режиме, возможно, при старте системы.
Команду postgres
также возможно использовать в однопользовательском режиме. В основном этот режим используется на этапе инициализации при выполнении initdb. Иногда он также применяется в целях отладки или после аварийного сбоя. Заметьте, что однопользовательский режим не вполне подходит для отладки сервера ввиду отсутствия в нём межпроцессного взаимодействия и блокировок. Когда сервер запускается в однопользовательском режиме из командной строки, он может принимать запросы и выводить их результаты на экран, но формат этого вывода ориентирован больше на разработчиков, чем на обычных пользователей. В этом режиме текущим пользователем считается пользователь под номером 1, который неявно наделяется правами суперпользователя. При этом данный пользователь может фактически не существовать, поэтому в ряде случаев этот режим даёт возможность вручную восстановить базу при повреждении системных каталогов.
Параметры
Программа postgres
принимает следующие аргументы командной строки. За подробным описанием параметров обратитесь к Главе 20. От необходимости вводить большинство этих параметров можно избавиться, записав их в файл конфигурации. Некоторые (безопасные) параметры можно также задать со стороны подключающегося клиента (в зависимости от приложения), чтобы они применялись только к одному сеансу. Например, если установлена переменная окружения PGOPTIONS
, клиенты на базе libpq передадут эту строку серверу, который воспримет её как параметры, передаваемые в командной строке postgres
.
Параметры общего назначения
-B
количество-буферов
Устанавливает количество разделяемых между процессами буферов. Значение по умолчанию выбирается автоматически при развёртывании кластера с помощью initdb. Установка флага аналогична конфигурации параметра shared_buffers.
-c
имя
=значение
Устанавливает заданный параметр времени выполнения. Конфигурационные параметры, поддерживаемые PostgreSQL, описаны в Главе 20. Большинство других параметров командной строки на самом деле представляют собой краткие формы такого присваивания значений параметрам. Для установления нескольких параметров
-c
можно указывать многократно.-C
имя
Отображает значение заданного параметра времени выполнения и завершается. (См. также описание параметра
-c
выше.) При этом выдаются значения изpostgresql.conf
с учётом возможных переопределений параметров при вызове. Однако параметры, установленные при запущенном сервере, в выводе не отражаются.Для большинства параметров можно запросить значения при работающем сервере. Однако для некоторых параметров, вычисляемых во время выполнения, сервер должен быть отключён (например, shared_memory_size, shared_memory_size_in_huge_pages и wal_segment_size).
Параметр предназначен для приложений, взаимодействующих с сервером, например pg_ctl, и запрашивающих параметры конфигурации. Пользовательские приложения должны использовать команду
SHOW
или представлениеpg_settings
.-d
уровень-отладки
Устанавливает уровень отладки (от 1 до 5). Чем выше значение, тем подробнее осуществляется вывод в журнал сервера. Также возможно передать
-d 0
для отдельного сеанса, что предотвратит в его рамках влияние выставленного дляpostgres
значения.-D
каталог_данных
Указывает размещение конфигурационных файлов базы в пределах файловой системы. За подробностями обратитесь к Разделу 20.2.
-e
Устанавливает формат вводимых дат по умолчанию в «European» с последовательностью значений
DMY
. Также влияет на вывод дня, идущего перед значением месяца, более подробно см. Раздел 8.5.-F
Отключает вызовы
fsync
для увеличения производительности, но с увеличением рисков потери данных в случае краха системы. Этот параметр работает аналогично параметру конфигурации fsync. Внимательно прочтите документацию перед использованием данного параметра!-h
компьютер
Указывает IP-адрес или имя компьютера, на котором сервер
postgres
принимает клиентские подключения по TCP/IP. Значением может быть список адресов, разделённых запятыми, либо символ*
, обозначающий все доступные интерфейсы. Если значение опущено, то подключения принимаются только через Unix-сокеты. По умолчанию принимаются подключения только к localhost. Флаг работает аналогично конфигурационному параметру listen_addresses.-i
Позволяет клиентам подключаться по TCP/IP. Без этого параметра допускаются лишь локальные подключения. Действие этого параметра аналогично действию параметра конфигурации
listen_addresses
со значением*
вpostgresql.conf
или ключа-h
.Параметр устарел, так как не даёт полной функциональности listen_addresses. Лучше устанавливать значение
listen_addresses
напрямую.-k
каталог
Указывает каталог Unix-сокета, через который
postgres
будет принимать подключения. Значением параметра может быть список каталогов через запятую. Если это значение пустое, использование Unix-сокетов запрещается, разрешаются только подключения по TCP/IP. По умолчанию выбирается каталог/tmp
, но его можно сменить на этапе компиляции. Этот параметр действует аналогично параметру конфигурации unix_socket_directories.-l
Включает поддержку безопасных соединений с использованием SSL шифрования. PostgreSQL необходимо скомпилировать с поддержкой SSL для использования этого флага. Подробнее использование SSL описано в Раздел 19.9.
-N
максимальное количество соединений
Устанавливает максимально возможное количество одновременных клиентских соединений. Значение по умолчанию устанавливается автоматически на этапе развёртывания с помощью initdb. Флаг работает аналогично конфигурационному параметру max_connections.
-p
порт
Указывает порт TCP/IP или расширение файла локального Unix-сокета, через который
postgres
принимает подключения клиентских приложений. По умолчанию принимает значение переменной окруженияPGPORT
, или, если значениеPGPORT
не установлено, то используется значение, установленное на этапе компиляции (обычно это 5432). Если значение порта меняется, то на стороне клиентов это необходимо учитывать, установив, либоPGPORT
, либо флаг командной строки.-s
Отображает информацию о времени и другую статистику после каждой выполненной команды, что полезно для оценки производительности во время настройки количества буферов.
-S
рабочая-память
Указывает базовый объём памяти, который сервер будет использовать для сортировок и хеш-таблиц, прежде чем прибегнуть к использованию временных файлов на диске. Обратитесь к описанию параметра
work_mem
, приведённому в Подразделе 20.4.1.-V
--version
Отображает версию postgres и прерывает дальнейшее выполнение.
--
имя
=значение
Устанавливает заданный параметр времени выполнения. Является короткой формой ключа
-c
.--describe-config
Выводит значения конфигурационных переменных сервера, их описаний и значений по умолчанию в формате команды
COPY
со знаком табуляции в качестве разделителя. В основном это предназначено для средств администрирования.-?
--help
Выводит помощь по аргументам команды postgres.
Параметры для внутреннего использования
Далее описанные параметры, в основном, применяются в целях отладки, а в некоторых случаях при восстановлении сильно повреждённых баз данных. Их описание приведено для системных разработчиков PostgreSQL, поэтому они могут быть изменены без уведомления.
-f
{ s | i | o | b | t | n | m | h }
Запрещает использование специфических методов сканирования и объединения:
s
иi
выключают последовательное сканирование и по индексу соответственно, аo
,b
иt
выключает сканирование только по индексу, сканирование по битовым векторам, и сканирование по ID кортежей соответственно, в то время какn
,m
иh
выключает вложенные циклы, слияния и хеширование соответственно.Ни последовательное сканирование, ни вложенные циклы невозможно выключить полностью. Флаги
-fs
и-fn
просто указывают планировщику избегать выполнения этих операций при наличии других альтернатив.-n
Параметр предназначен для отладки сервера в случае аномального завершения процесса. Обычная практика в таком случае — завершение порождённых процессов с дальнейшей инициализацией разделяемой памяти и семафоров. Это связано с тем, что потерянный процесс мог повредить область разделяемой памяти. Параметр указывает
postgres
не производить повторной инициализации общих структур данных, что позволяет произвести дальнейшую отладку текущего состояния памяти и семафоров.-O
Разрешает модифицировать структуру системных таблиц. Используется командой
initdb
.-P
Игнорировать системные индексы при чтении, но продолжать обновлять их при изменениях системных таблиц. Это используется при их восстановлении после повреждения.
-t
pa[rser] | pl[anner] | e[xecutor]
Выводит статистику по времени исполнения каждого запроса в контексте каждого системного модуля. Использование флага совместно с
-s
невозможно.-T
Параметр предназначен для отладки сервера в случае аномального завершения процесса. Обычная практика в таком случае — завершение порождённых процессов с дальнейшей инициализацией разделяемой памяти и семафоров. Это связано с тем, что потерянный процесс мог повредить область разделяемой памяти. Параметр указывает
postgres
на необходимость остановки порождённых процессов сигналомSIGSTOP
, но не завершит их, что позволяет разработчикам сделать снимки памяти процессов.-v
протокол
Указывает для данного сеанса версию протокола взаимодействия сервера с клиентом. Флаг используется лишь для внутренних целей.
-W
секунды
При старте сервера производится задержка на указанное количество секунд, после чего производится процедура аутентификации, что позволяет подключить отладчик к процессу.
Параметры для однопользовательского режима
Следующие параметры применимы только для однопользовательского режима (см. раздел Однопользовательский режим ниже).
--single
Устанавливает однопользовательский режим. Параметр должен идти первым в командной строке.
база_данных
Указывает имя базы данных, к которой производится подключение. Параметр должен идти последним в командной строке. Если не указан, то используется имя текущего системного пользователя.
-E
Выводить все команды в устройство стандартного вывода прежде чем выполнять их.
-j
Считать признаком окончания ввода команды точку с запятой с двумя переводами строки, а не один перевод строки.
-r
имя_файла
Отправляет вывод журнала сервера в файл
filename
. Этот параметр применяется лишь при запуске из командной строки.
Переменные окружения
PGCLIENTENCODING
Кодировка, используемая клиентом по умолчанию. Может переопределяться на стороне клиента, а также устанавливаться в конфигурационном файле сервера.
PGDATA
Каталог размещения данных кластера по умолчанию
PGDATESTYLE
Значение по умолчанию для параметра времени выполнения DateStyle. Применение этой переменной является устаревшим.
PGPORT
Порт по умолчанию, лучше устанавливать в конфигурационном файле.
Диагностика
Ошибки с упоминанием о semget
или shmget
говорят о возможной необходимости проведения более оптимального конфигурирования ядра. Подробнее это обсуждается в Разделе 19.4. Отложить переконфигурирование можно, уменьшив shared_buffers для снижения общего потребления разделяемой памяти PostgreSQL и/или уменьшив max_connections для снижения затрат на использование семафоров.
Необходимо внимательно проверять сообщения об ошибке с упоминанием о другом запущенном экземпляре, например, с использованием команды
$
ps ax | grep postgres
или
$
ps -ef | grep postgres
в зависимости от ОС. Если есть полная уверенность, что противоречий нет, необходимо самостоятельно удалить упомянутый в сообщении запирающий файл и повторить попытку.
Упоминание о невозможности привязки к порту в сообщениях об ошибках может указывать на то, что он уже занят другим процессом помимо PostgreSQL. Также сообщение может возникнуть при мгновенном рестарте postgres
на том же порту. В этом случае нужно немного подождать, пока ОС не закроет порт, и повторить попытку. Ещё возможна ситуация, в которой используется резервный системный порт. Например, многие Unix-подобные ОС резервируют «доверительные» порты от 1024 и ниже, и лишь суперпользователь имеет к ним доступ.
Примечания
Для комфортного запуска и остановки сервера можно использовать утилиту pg_ctl.
Если возможно, не используйте сигнал SIGKILL
для головного процесса postgres
. В этом случае postgres
не освободит системные ресурсы, например, разделяемую память и семафоры. Это может привести к проблемам при повторном запуске postgres
.
Для корректного завершения postgres
используются сигналы SIGTERM
, SIGINT
или SIGQUIT
. При первом будут ожидаться все дочерние процессы до их завершения, второй приведёт к принудительному закрытию соединений, а третий — к незамедлительному выходу без корректного завершения, приводящему к необходимости выполнения процедуры восстановления на следующем старте.
Получая сигнал SIGHUP
, сервер перечитывает свои файлы конфигурации. Также возможно отправить SIGHUP
отдельному процессу, но это чаще всего бессмысленно.
Для отмены исполняющегося запроса, отправьте SIGINT
обслуживающему его процессу. Для чистого завершения серверного процесса отправьте ему SIGTERM
. Также см. pg_cancel_backend
и pg_terminate_backend
в Подразделе 9.27.2, которые являются аналогами в форме SQL-инструкций.
Сервер postgres
обрабатывает SIGQUIT
для завершения дочерних процессов в грязную, и сигнал не должен отправляться пользователем. Также не стоит посылать SIGKILL
серверному процессу — головной postgres
процесс расценит это как аварию и принудительно завершит остальные порождённые, как это было бы сделано при процедуре восстановления после сбоя.
Ошибки
Флаги, начинающиеся с --
не работают в ОС FreeBSD или OpenBSD. Чтобы обойти это, используйте -c
. Это ошибка ОС. В будущих релизах PostgreSQL будет предоставлен обходной путь, если ошибка так и не будет устранена.
Однопользовательский режим
Для запуска сервера в однопользовательском режиме используется, например, команда
postgres --single -D /usr/local/pgsql/data другие параметры
my_database
Необходимо указать корректный путь к каталогу хранения данных в параметре -D
, или установить переменную окружения PGDATA
. Также замените имя базы данных на необходимое.
Обычно перевод строки в однопользовательском режиме сервер воспринимает как завершение ввода команды; точка с запятой не имеет для него такого значения, как для psql. Поэтому, чтобы ввести команду, занимающую несколько строк, необходимо добавлять в конце каждой строки, кроме последней, обратную косую черту. Обратная косая черта и следующий за ней символ перевода строки автоматически убираются из вводимой команды. Заметьте, что это происходит даже внутри строковой константы или комментария.
Но если применить аргумент командной строки -j
, одиночный символ перевода строки не будет завершать ввод команды; это будет делать последовательность «точка с запятой, перевод строки, перевод строки». То есть для завершения команды нужно ввести точку с запятой, и сразу за ней пустую строку. Просто точка с запятой, дополненная переводом строки, в этом режиме не имеет специального значения. Внутри строковых констант и комментариев такая завершающая последовательность воспринимается в том же ключе.
Вне зависимости от режима ввода, символ точки с запятой, введённый не прямо перед или в составе последовательности завершения команды, воспринимается как разделитель команд. После ввода завершающей последовательности введённые с разделителями несколько операторов будут выполняться в одной транзакции.
Для завершения сеанса введите символ конца файла (EOF, обычно это сочетание Control+D). Если вы вводили текст после окончания ввода последней команды, символ EOF будет воспринят как символ завершения команды, и для выхода потребуется ещё один EOF.
Заметьте, что однопользовательский режим не предоставляет особых возможностей для редактирования команд (например, нет истории команд). Также в однопользовательском режиме не производятся никакие фоновые действия, например, не выполняются автоматические контрольные точки или репликация.
Примеры
Для запуска postgres
в фоновом режиме с параметрами по умолчанию:
$
nohup postgres >logfile 2>&1 </dev/null &
Для запуска postgres
с определённым портом, например, 1234:
$
postgres -p 1234
Для соединения с помощью psql укажите этот порт в параметре -p:
$
psql -p 1234
или в переменной окружения PGPORT
:
$
export PGPORT=1234
$
psql
Именованный параметр времени выполнения можно указать одним из приведённых способом:
$
postgres -c work_mem=1234
$
postgres --work-mem=1234
Любой из методов переопределяет значение work_mem
конфигурации postgresql.conf
. Символ подчёркивания в именах можно указать и в виде тире. Задавать параметры обычно (не считая кратковременных экспериментов) лучше в postgresql.conf
, а не в аргументах командной строки.
postgres
postgres — PostgreSQL database server
Synopsis
postgres
[option
...]
Description
postgres
is the PostgreSQL database server. In order for a client application to access a database it connects (over a network or locally) to a running postgres
instance. The postgres
instance then starts a separate server process to handle the connection.
One postgres
instance always manages the data of exactly one database cluster. A database cluster is a collection of databases that is stored at a common file system location (the “data area”). More than one postgres
instance can run on a system at one time, so long as they use different data areas and different communication ports (see below). When postgres
starts it needs to know the location of the data area. The location must be specified by the -D
option or the PGDATA
environment variable; there is no default. Typically, -D
or PGDATA
points directly to the data area directory created by initdb. Other possible file layouts are discussed in Section 20.2.
By default postgres
starts in the foreground and prints log messages to the standard error stream. In practical applications postgres
should be started as a background process, perhaps at boot time.
The postgres
command can also be called in single-user mode. The primary use for this mode is during bootstrapping by initdb. Sometimes it is used for debugging or disaster recovery; note that running a single-user server is not truly suitable for debugging the server, since no realistic interprocess communication and locking will happen. When invoked in single-user mode from the shell, the user can enter queries and the results will be printed to the screen, but in a form that is more useful for developers than end users. In the single-user mode, the session user will be set to the user with ID 1, and implicit superuser powers are granted to this user. This user does not actually have to exist, so the single-user mode can be used to manually recover from certain kinds of accidental damage to the system catalogs.
Options
postgres
accepts the following command-line arguments. For a detailed discussion of the options consult Chapter 20. You can save typing most of these options by setting up a configuration file. Some (safe) options can also be set from the connecting client in an application-dependent way to apply only for that session. For example, if the environment variable PGOPTIONS
is set, then libpq-based clients will pass that string to the server, which will interpret it as postgres
command-line options.
General Purpose
-B
nbuffers
Sets the number of shared buffers for use by the server processes. The default value of this parameter is chosen automatically by initdb. Specifying this option is equivalent to setting the shared_buffers configuration parameter.
-c
name
=value
Sets a named run-time parameter. The configuration parameters supported by PostgreSQL are described in Chapter 20. Most of the other command line options are in fact short forms of such a parameter assignment.
-c
can appear multiple times to set multiple parameters.-C
name
Prints the value of the named run-time parameter, and exits. (See the
-c
option above for details.) This returns values frompostgresql.conf
, modified by any parameters supplied in this invocation. It does not reflect parameters supplied when the cluster was started.This can be used on a running server for most parameters. However, the server must be shut down for some runtime-computed parameters (e.g., shared_memory_size, shared_memory_size_in_huge_pages, and wal_segment_size).
This option is meant for other programs that interact with a server instance, such as pg_ctl, to query configuration parameter values. User-facing applications should instead use
SHOW
or thepg_settings
view.-d
debug-level
Sets the debug level. The higher this value is set, the more debugging output is written to the server log. Values are from 1 to 5. It is also possible to pass
-d 0
for a specific session, which will prevent the server log level of the parentpostgres
process from being propagated to this session.-D
datadir
Specifies the file system location of the database configuration files. See Section 20.2 for details.
-e
Sets the default date style to “European”, that is
DMY
ordering of input date fields. This also causes the day to be printed before the month in certain date output formats. See Section 8.5 for more information.-F
Disables
fsync
calls for improved performance, at the risk of data corruption in the event of a system crash. Specifying this option is equivalent to disabling the fsync configuration parameter. Read the detailed documentation before using this!-h
hostname
Specifies the IP host name or address on which
postgres
is to listen for TCP/IP connections from client applications. The value can also be a comma-separated list of addresses, or*
to specify listening on all available interfaces. An empty value specifies not listening on any IP addresses, in which case only Unix-domain sockets can be used to connect to the server. Defaults to listening only on localhost. Specifying this option is equivalent to setting the listen_addresses configuration parameter.-i
Allows remote clients to connect via TCP/IP (Internet domain) connections. Without this option, only local connections are accepted. This option is equivalent to setting
listen_addresses
to*
inpostgresql.conf
or via-h
.This option is deprecated since it does not allow access to the full functionality of listen_addresses. It's usually better to set
listen_addresses
directly.-k
directory
Specifies the directory of the Unix-domain socket on which
postgres
is to listen for connections from client applications. The value can also be a comma-separated list of directories. An empty value specifies not listening on any Unix-domain sockets, in which case only TCP/IP sockets can be used to connect to the server. The default value is normally/tmp
, but that can be changed at build time. Specifying this option is equivalent to setting the unix_socket_directories configuration parameter.-l
Enables secure connections using SSL. PostgreSQL must have been compiled with support for SSL for this option to be available. For more information on using SSL, refer to Section 19.9.
-N
max-connections
Sets the maximum number of client connections that this server will accept. The default value of this parameter is chosen automatically by initdb. Specifying this option is equivalent to setting the max_connections configuration parameter.
-p
port
Specifies the TCP/IP port or local Unix domain socket file extension on which
postgres
is to listen for connections from client applications. Defaults to the value of thePGPORT
environment variable, or ifPGPORT
is not set, then defaults to the value established during compilation (normally 5432). If you specify a port other than the default port, then all client applications must specify the same port using either command-line options orPGPORT
.-s
Print time information and other statistics at the end of each command. This is useful for benchmarking or for use in tuning the number of buffers.
-S
work-mem
Specifies the base amount of memory to be used by sorts and hash tables before resorting to temporary disk files. See the description of the
work_mem
configuration parameter in Section 20.4.1.-V
--version
Print the postgres version and exit.
--
name
=value
Sets a named run-time parameter; a shorter form of
-c
.--describe-config
This option dumps out the server's internal configuration variables, descriptions, and defaults in tab-delimited
COPY
format. It is designed primarily for use by administration tools.-?
--help
Show help about postgres command line arguments, and exit.
Semi-Internal Options
The options described here are used mainly for debugging purposes, and in some cases to assist with recovery of severely damaged databases. There should be no reason to use them in a production database setup. They are listed here only for use by PostgreSQL system developers. Furthermore, these options might change or be removed in a future release without notice.
-f
{ s | i | o | b | t | n | m | h }
Forbids the use of particular scan and join methods:
s
andi
disable sequential and index scans respectively,o
,b
andt
disable index-only scans, bitmap index scans, and TID scans respectively, whilen
,m
, andh
disable nested-loop, merge and hash joins respectively.Neither sequential scans nor nested-loop joins can be disabled completely; the
-fs
and-fn
options simply discourage the optimizer from using those plan types if it has any other alternative.-n
This option is for debugging problems that cause a server process to die abnormally. The ordinary strategy in this situation is to notify all other server processes that they must terminate and then reinitialize the shared memory and semaphores. This is because an errant server process could have corrupted some shared state before terminating. This option specifies that
postgres
will not reinitialize shared data structures. A knowledgeable system programmer can then use a debugger to examine shared memory and semaphore state.-O
Allows the structure of system tables to be modified. This is used by
initdb
.-P
Ignore system indexes when reading system tables, but still update the indexes when modifying the tables. This is useful when recovering from damaged system indexes.
-t
pa[rser] | pl[anner] | e[xecutor]
Print timing statistics for each query relating to each of the major system modules. This option cannot be used together with the
-s
option.-T
This option is for debugging problems that cause a server process to die abnormally. The ordinary strategy in this situation is to notify all other server processes that they must terminate and then reinitialize the shared memory and semaphores. This is because an errant server process could have corrupted some shared state before terminating. This option specifies that
postgres
will stop all other server processes by sending the signalSIGSTOP
, but will not cause them to terminate. This permits system programmers to collect core dumps from all server processes by hand.-v
protocol
Specifies the version number of the frontend/backend protocol to be used for a particular session. This option is for internal use only.
-W
seconds
A delay of this many seconds occurs when a new server process is started, after it conducts the authentication procedure. This is intended to give an opportunity to attach to the server process with a debugger.
Options for Single-User Mode
The following options only apply to the single-user mode (see Single-User Mode below).
--single
Selects the single-user mode. This must be the first argument on the command line.
database
Specifies the name of the database to be accessed. This must be the last argument on the command line. If it is omitted it defaults to the user name.
-E
Echo all commands to standard output before executing them.
-j
Use semicolon followed by two newlines, rather than just newline, as the command entry terminator.
-r
filename
Send all server log output to
filename
. This option is only honored when supplied as a command-line option.
Environment
PGCLIENTENCODING
Default character encoding used by clients. (The clients can override this individually.) This value can also be set in the configuration file.
PGDATA
Default data directory location
PGDATESTYLE
Default value of the DateStyle run-time parameter. (The use of this environment variable is deprecated.)
PGPORT
Default port number (preferably set in the configuration file)
Diagnostics
A failure message mentioning semget
or shmget
probably indicates you need to configure your kernel to provide adequate shared memory and semaphores. For more discussion see Section 19.4. You might be able to postpone reconfiguring your kernel by decreasing shared_buffers to reduce the shared memory consumption of PostgreSQL, and/or by reducing max_connections to reduce the semaphore consumption.
A failure message suggesting that another server is already running should be checked carefully, for example by using the command
$
ps ax | grep postgres
or
$
ps -ef | grep postgres
depending on your system. If you are certain that no conflicting server is running, you can remove the lock file mentioned in the message and try again.
A failure message indicating inability to bind to a port might indicate that that port is already in use by some non-PostgreSQL process. You might also get this error if you terminate postgres
and immediately restart it using the same port; in this case, you must simply wait a few seconds until the operating system closes the port before trying again. Finally, you might get this error if you specify a port number that your operating system considers to be reserved. For example, many versions of Unix consider port numbers under 1024 to be “trusted” and only permit the Unix superuser to access them.
Notes
The utility command pg_ctl can be used to start and shut down the postgres
server safely and comfortably.
If at all possible, do not use SIGKILL
to kill the main postgres
server. Doing so will prevent postgres
from freeing the system resources (e.g., shared memory and semaphores) that it holds before terminating. This might cause problems for starting a fresh postgres
run.
To terminate the postgres
server normally, the signals SIGTERM
, SIGINT
, or SIGQUIT
can be used. The first will wait for all clients to terminate before quitting, the second will forcefully disconnect all clients, and the third will quit immediately without proper shutdown, resulting in a recovery run during restart.
The SIGHUP
signal will reload the server configuration files. It is also possible to send SIGHUP
to an individual server process, but that is usually not sensible.
To cancel a running query, send the SIGINT
signal to the process running that command. To terminate a backend process cleanly, send SIGTERM
to that process. See also pg_cancel_backend
and pg_terminate_backend
in Section 9.27.2 for the SQL-callable equivalents of these two actions.
The postgres
server uses SIGQUIT
to tell subordinate server processes to terminate without normal cleanup. This signal should not be used by users. It is also unwise to send SIGKILL
to a server process — the main postgres
process will interpret this as a crash and will force all the sibling processes to quit as part of its standard crash-recovery procedure.
Bugs
The --
options will not work on FreeBSD or OpenBSD. Use -c
instead. This is a bug in the affected operating systems; a future release of PostgreSQL will provide a workaround if this is not fixed.
Single-User Mode
To start a single-user mode server, use a command like
postgres --single -D /usr/local/pgsql/data other-options
my_database
Provide the correct path to the database directory with -D
, or make sure that the environment variable PGDATA
is set. Also specify the name of the particular database you want to work in.
Normally, the single-user mode server treats newline as the command entry terminator; there is no intelligence about semicolons, as there is in psql. To continue a command across multiple lines, you must type backslash just before each newline except the last one. The backslash and adjacent newline are both dropped from the input command. Note that this will happen even when within a string literal or comment.
But if you use the -j
command line switch, a single newline does not terminate command entry; instead, the sequence semicolon-newline-newline does. That is, type a semicolon immediately followed by a completely empty line. Backslash-newline is not treated specially in this mode. Again, there is no intelligence about such a sequence appearing within a string literal or comment.
In either input mode, if you type a semicolon that is not just before or part of a command entry terminator, it is considered a command separator. When you do type a command entry terminator, the multiple statements you've entered will be executed as a single transaction.
To quit the session, type EOF (Control+D, usually). If you've entered any text since the last command entry terminator, then EOF will be taken as a command entry terminator, and another EOF will be needed to exit.
Note that the single-user mode server does not provide sophisticated line-editing features (no command history, for example). Single-user mode also does not do any background processing, such as automatic checkpoints or replication.
Examples
To start postgres
in the background using default values, type:
$
nohup postgres >logfile 2>&1 </dev/null &
To start postgres
with a specific port, e.g., 1234:
$
postgres -p 1234
To connect to this server using psql, specify this port with the -p option:
$
psql -p 1234
or set the environment variable PGPORT
:
$
export PGPORT=1234
$
psql
Named run-time parameters can be set in either of these styles:
$
postgres -c work_mem=1234
$
postgres --work-mem=1234
Either form overrides whatever setting might exist for work_mem
in postgresql.conf
. Notice that underscores in parameter names can be written as either underscore or dash on the command line. Except for short-term experiments, it's probably better practice to edit the setting in postgresql.conf
than to rely on a command-line switch to set a parameter.