psql

psql — интерактивный терминал QHB

Синтаксис

psql [параметр...] [имя_бд [имя_пользователя]]

psql — это терминальный клиент для работы с QHB. Он позволяет интерактивно вводить запросы, выполнять их в QHB и просматривать их результаты. Как вариант, запросы можно получать из файла или из аргументов командной строки. Кроме того, psql предоставляет ряд метакоманд и различную функциональность, схожую с имеющимися у командных оболочек, для облегчения написания скриптов и автоматизации широкого спектра задач.

Параметры

-a
--echo-all
Отправить все непустые входные строки в стандартный вывод по мере их чтения. (Это не относится к строкам, считанным интерактивно.) Это равнозначно установке переменной ECHO в значение all.

-A
--no-align
Переключает на режим невыровненного вывода. (По умолчанию используется режим aligned (выровненный).) Это равнозначно команде \pset format unaligned.

-b
--echo-errors
Отправлять команды SQL с ошибками в стандартный вывод для ошибок. Это равнозначно установке переменной ECHO в значение errors.

-c команда
--command=команда
Указывает, что psql должна выполнить заданную командную строку (команду). Этот параметр можно вводить несколько раз и комбинировать в любом порядке с параметром -f. Когда указывается -c или -f, psql не читает команды со стандартного ввода; вместо этого она завершается после обработки всех параметров -c и -f по порядку.
Заданная команда должна быть либо командной строкой, которая полностью анализируется сервером (т. е. не содержит специфическую функциональность psql), либо одиночной командой с обратным слэшем. Таким образом, в параметре -c нельзя смешивать метакоманды SQL и psql. Чтобы добиться этого, можно передать несколько ключей -c или передать строку в psql через канал, например:

psql -c '\x' -c 'SELECT * FROM foo;'

или

echo '\x \\ SELECT * FROM foo;' | psql

(\\ — разделитель метакоманд.)
Каждая строка команд SQL, переданная в -c, отправляется на сервер как один запрос. Поэтому сервер выполняет ее в одной транзакции, даже когда эта строка содержит несколько команд SQL, если только в ней не содержатся явные команды BEGIN/COMMIT, разделяющие ее на несколько транзакций. (Подробнее о том, как сервер обрабатывает строки с несколькими командами, рассказывается в подразделе Несколько операторов в простом запросе.) Кроме того, psql выводит результат только последней команды SQL в строке. Это отличается от поведения, когда та же строка считывается из файла или подается на стандартный ввод, потому что в последнем случае psql передает каждую команду SQL по отдельности.
Из-за такого поведения указание нескольких команд SQL в одной строке -c зачастую приводит к неожиданным результатам. Лучше использовать параметр -c несколько раз или подавать команды на стандартный ввод psql, применяя либо параметр echo, как показано выше, либо создаваемый непосредственно в оболочке документ, например:

psql <<EOF
\x
SELECT * FROM foo;
EOF

--csv
Переключает в режим вывода CSV (Comma-Separated Values, значения, разделенные запятыми). Это равнозначно команде \pset format csv.

-d имя_бд
--database=имя_бд
Задает имя базы данных для подключения. Это равнозначно указанию имени_бд в качестве первого аргумента, не являющегося ключом, в командной строке. В имени_бд может задаваться строка подключения. В этом случае параметры в строке подключения переопределяют любые конфликтующие параметры в командной строке.

-e
--echo-queries
Копировать все команды SQL, отправляемые на сервер, еще и на стандартный вывод. Это равнозначно установке переменой ECHO в значение queries.

-E
--echo-hidden
Отображать фактические запросы, генерируемые \d и другими командами, начинающимися с обратного слэша. Это можно использовать для изучения внутренних операций psql. Это равнозначно установке переменой ECHO_HIDDEN в значение on (включен).

-f имя_файла
--file=имя_файла
Читать команды из файла имя_файла, а не из стандартного ввода. Этот параметр можно вводить несколько раз и комбинировать в любом порядке с параметром -c. Когда указывается -c или -f, psql не читает команды со стандартного ввода; вместо этого она завершается после обработки всех параметров -c и -f по порядку. Не считая этого, данный параметр практически равнозначен метакоманде \i.
Если имя_файла задано символом - (минус), то стандартный ввод считывается до признака конца файла или до метакоманды \q. Это позволяет перемежать интерактивный ввод с вводом из файлов. Однако обратите внимание, что Readline в таком случае не применяется (почти так же, как с указанием -n).
Использование этого параметра немного отличается от написания psql < имя_файла. В целом, оба варианта будут делать то, что вы ожидаете, но с -f доступна некоторая полезная функциональность, например, сообщения об ошибках с номерами строк. Также есть небольшая вероятность, что использование этого параметра снизит издержки при запуске. С другой стороны, вариант с перенаправлением ввода из оболочки (в теории) гарантирует получение точно такого же вывода, какой вы получили бы, введя все вручную.

-F разделитель
--field-separator=разделитель
Использовать разделитель в качестве разделителя полей для невыровненного вывода. Это равнозначно команде \pset fieldsep или \f.

-h имя_хоста
--host=имя_хоста
Задает имя хост-компьютера, на котором работает сервер. Если значение начинается со слэша, оно используется в качестве каталога для сокета домена Unix.

-H
--html
Переключает в режим вывода HTML. Это равнозначно команде \pset format html или \H.

-l
--list
Вывести список всех доступных баз данных и завершиться. Другие параметры, не связанные с подключением, игнорируются. Это похоже на метакоманду \list.
При использовании этого параметра psql будет подключаться к базе данных qhb, если только в командной строке не задана другая база (в параметре -d или не через параметры, а, допустим, через запись службы, но не через переменную среды).

-L имя_файла
--log-file=имя_файла
В дополнение к обычному расположению вывода, записывать вывод результатов всех запросов в файл имя_файла.

-n
--no-readline
Не использовать Readline для редактирования командной строки и не использовать историю команд. Это может быть полезно для выключения расширенных действий клавиш табуляции при вырезании и вставке.

-o имя_файла
--output=имя_файла
Записать вывод результатов всех запросов в файл имя_файла. Это равнозначно команде \o.

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

-P присвоение
--pset=присвоение
Задает параметры печати, в стиле команды \pset. Обратите внимание, что здесь придется разделить имя присваиваемого параметра и значение знаком равенства, а не пробела. Например, чтобы установить формат вывода в LaTeX, нужно написать -P format=latex.

-q
--quiet
Указывает, что psql должна работать «тихо». По умолчанию она выводит приветствия и различные информационные сообщения. При использовании данного параметра этого не произойдет. Имеет смысл применять его вместе с параметром c. Это равнозначно установке переменной QUIET в значение on (включена).

-R разделитель
--record-separator=разделитель
Использовать разделитель в качестве разделителя записей для невыровненного вывода. Это равнозначно команде \pset recordsep.

-s
--single-step
Работать в пошаговом режиме. Это означает, что пользователь будет подтверждать выполнение каждой команды перед ее отправкой на сервер, с возможностью отменить выполнение. Используется для отладки скриптов.

-S
--single-line
Запуск в построчном режиме, при котором символ новой строки завершает команду SQL, так же как это делает точка с запятой.

Примечание
Этот режим предусмотрен для тех, кто настаивал на его необходимости, но это не значит, что его обязательно использовать всем. В частности, если смешивать в одной строке команды SQL и метакоманды, порядок их выполнения может быть не всегда понятен для неопытного пользователя.

-t
--tuples-only
Выключить вывод имен столбцов и результирующей строки с количеством выбранных записей и т. д. Это равнозначно команде \t или \pset tuples_only.

-T параметры_таблицы
--table-attr=параметры_таблицы
Задает параметры, которые будут вставлены в тег HTML table. Подробную информацию см. в описании команды \pset tableattr.

-U имя_пользователя
--username=имя_пользователя
Использовать для подключения имя_пользователя вместо установленного по умолчанию. (Разумеется, это потребует соответствующего разрешения.)

-v присвоение
--set=присвоение
--variable=присвоение
Произвести присвоение значения переменной, как делает метакоманда \set. Обратите внимание, что в командной строке нужно разделить имя переменной и значение (если таковое имеется) знаком равенства. Чтобы сбросить переменную, опустите знак равенства. Чтобы установить пустое значение, добавьте знак равенства, но опустите значение. Эти присвоения выполняются во время обработки командной строки, поэтому переменные, отражающие состояние подключения, потом будут переписаны.

--version
Вывести версию psql и завершиться.

-w
--no-password
Никогда не запрашивать ввод пароля. Если серверу требуется аутентификация по паролю, и пароль недоступен с помощью иных средств, таких как файл .pgpass, попытка подключения завершится неудачно. Этот параметр может быть полезен в пакетных заданиях и скриптах, где нет пользователя, чтобы ввести пароль.
Обратите внимание, что этот параметр действует в течение всего сеанса и, следовательно, влияет на использование метакоманды \connect, а также на первую попытку подключения.

-W
--password
Принудительно запрашивать пароль перед подключением к базе данных, даже если он не будет использоваться.
Если сервер требует аутентификацию по паролю и пароль нельзя получить из других источников, например из файла .pgpass, psql запросит пароль в любом случае. Однако чтобы понять, что требуется пароль, psql потребуется дополнительная попытка подключения к серверу. В некоторых случаях имеет смысл ввести -W, чтобы исключить эту лишнюю попытку.
Обратите внимание, что этот параметр действует в течение всего сеанса и, следовательно, влияет на использование метакоманды \connect, а также на первую попытку подключения.

-x
--expanded
Включить режим развернутого форматирования таблицы. Это равнозначно команде \x или \pset.

-X
--no-psqlrc
Не читать стартовые файлы (ни общесистемный файл psqlrc, ни пользовательский файл ~/.psqlrc).

-z
--field-separator-zero
Установить нулевой байт в качестве разделителя полей для невыровненного вывода. Это равнозначно команде \pset fieldsep_zero.

-0
--record-separator-zero
Установить нулевой байт в качестве разделителя записей для невыровненного вывода. Это полезно при взаимодействии, например, с xargs -0. Равнозначно команде \pset recordsep_zero.

-1
--single-transaction
Этот параметр можно использовать только в сочетании с одним или несколькими параметрами -c и/или -f. С ним psql выполняет команду BEGIN перед обработкой первого такого параметра и команду COMMIT после последнего, тем самым заворачивая все команды в одну транзакцию. Это гарантирует, что либо все команды завершатся успешно, либо никакие изменения не сохранятся.
Если в самих этих командах содержатся операторы BEGIN, COMMIT или ROLLBACK, этот параметр не даст желаемого эффекта. Кроме того, если какая-либо отдельная команда не может выполняться внутри блока транзакции, указание этого параметра приведет к тому, что вся транзакция прервется с ошибкой.

-?
--help[=тема]
Показать справку по psql и завершиться. Необязательный параметр тема (по умолчанию options) выбирает описание интересующей части psql: commands описывает команды psql с обратным слэшем; options описывает параметры командной строки, которые можно передать psql; а variables выдает справку по переменным конфигурации psql.

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

psql возвращает в командную оболочку 0 при нормальном завершении, 1 — если произошла фатальная ошибка в самой psql (например недостаточно памяти, файл не найден), 2 — при неудачном подключении к серверу и неинтерактивном сеансе и 3 — при ошибке в скрипте и установленной переменной ON_ERROR_STOP.

Использование

Подключение к базе данных

psql — это обычное клиентское приложение QHB. Для подключения к базе данных необходимо знать имя целевой базы, имя хоста и номер порта сервера, а также имя пользователя, под которым вы хотите подключиться. Для psql эти параметры можно задать через аргументы командной строки, а именно -d, -h, -p и -U соответственно. При обнаружении в командной строке аргумента, не относящегося ни к одному параметру, оно будет воспринято как имя базы данных (или имя пользователя, если имя базы данных уже задано). Задавать все эти аргументы необязательно; у них есть подходящие значения по умолчанию. Если опустить имя хоста, psql подключится через сокет домена Unix к серверу на локальном хосте или через TCP/IP к localhost, если в системе нет сокетов домена Unix. Номер порта по умолчанию определяется во время компиляции. Поскольку сервер базы данных использует то же значение по умолчанию, в большинстве случаев указывать порт нет необходимости. Имя пользователя по умолчанию, как и имя базы данных по умолчанию — это ваше имя пользователя в операционной системе. Обратите внимание, что просто так подключиться к любой базе данных под любым именем пользователя не получится. О правах доступа можно узнать у администратора баз данных.

Если значения по умолчанию не вполне подходят, вместо ввода нужных параметров вручную можно установить переменные среды PGDATABASE, PGHOST, PGPORT и/или PGUSER в подходящие значения. (Другие переменные среды описаны в разделе Переменные среды.) Также удобно иметь файл ~/.pgpass, чтобы каждый раз не вводить пароли. Дополнительную информацию см. в разделе Файл паролей.)

Альтернативный способ указания параметров подключения — использование вместо имени базы данных строки conninfo или URI. Этот механизм дает широкие возможности для управления подключением. Например:

$ psql "service=myservice sslmode=require"
$ psql postgresql://dbmaster:5433/mydb?sslmode=require

Этот способ также позволяет использовать для получения параметров подключения LDAP, как описано в разделе Поиск параметров подключения через LDAP. Более подробную информацию обо всех доступных параметрах подключения см. в подразделе Ключевые слова-параметры.

Если по какой-либо причине соединение не может быть установлено (например, недостаточно прав, сервер на целевом хосте не работает и т. д.), psql вернет ошибку и прекратит работу.

Если и стандартный ввод, и стандартный вывод являются терминалом, то psql установит кодировку клиента в «auto», и подходящая клиентская кодировка будет определяться из настроек локалей (переменная среды LC_CTYPE в системах Unix). Если это работает не так, как ожидалось, клиентскую кодировку можно изменить, установив переменную среды PGCLIENTENCODING.

Ввод команд SQL

При работе в штатном режиме в командной строке psql отображается имя базы данных, к которой psql подключена в данный момент, а затем идет строка =>. Например:

$ psql testdb
psql (1.0)
Type "help" for help.

testdb=>

В командной строке пользователь может вводить команды SQL. Обычно введенные строки отправляются на сервер по достижении точки с запятой, завершающей команду. Конец строки не завершает команду. Таким образом, команды можно для ясности разбить на несколько строк. Если команда была отправлена и выполнена без ошибок, ее результаты отображаются на экране.

Если к базе данных, в которой не был внедрен шаблон безопасного использования схем, имеют доступ недоверенные пользователи, начинайте сеанс с удаления общедоступных схем из search_path (пути поиска). Для этого перед выполнением других команд SQL можно выполнить команду SELECT pg_catalog.set_config('search_path', '', false). Это касается не только psql, но и всех остальных интерфейсов для выполнения произвольных команд SQL.

При каждом выполнении команды psql также проверяет асинхронные уведомления о событиях, генерируемые командами LISTEN и NOTIFY.

Тогда как блоки комментариев в стиле C/RUST передаются на сервер для обработки и удаления, комментарии в стандарте SQL удаляются psql.

Метакоманды

Все, что вводится в psql без кавычек, и начинается с обратного слэша, является метакомандой psql, которая обрабатывается самой утилитой. Эти команды делают psql более полезной для администрирования или написания скриптов. Метакоманды часто называют командами слэша или обратного слэша.

Команды psql имеют следующий формат: обратный слэш, сразу за ним команда, затем аргументы. Аргументы отделяются от команды и друг от друга любым числом пробелов.

Чтобы включить в аргумент пробел, нужно заключить его в апострофы. Чтобы включить в аргумент апостроф, нужно написать два апострофа внутри текста в апострофах. Все, что содержится в апострофах, в дальнейшем подлежит заменам, принятым в языке C: \n (новая строка), \t (табуляция), \b (backspace), \r (возврат каретки), \f (подача страницы), \цифры (восьмеричное число) и \xцифры (шестнадцатеричное число). Внутри апострофов обратный слэш, стоящий перед любым другим символом, экранирует этот символ.

Если внутри аргумента встречается двоеточие (:) без кавычек с последующим именем переменной psql, оно заменяется значением этой переменной, как описано ниже в параграфе Интерполяция SQL. Также будут работать описанные там формы :'имя_переменной' и :"имя_переменной". Синтаксис :{?имя_переменной} позволяет проверить, определена ли переменная. Он заменяется значением TRUE или FALSE. Экранирование двоеточия обратным слэшем защищает его от замены.

Внутри аргумента текст, взятый в обратные кавычки (`), считается командной строкой, которая передается в командную оболочку. Вывод этой команды (с удаленными в конце символами новой строки) заменяет текст в обратных кавычках. Внутри этого текста не обрабатываются никакие кавычки или другие управляющие символы или последовательности, за исключением того, что все вхождения :имени_переменной, где имя_переменной — это имя переменной psql, заменяются значением этой переменной. Также вхождения :'имени_переменной' заменяются значением переменной, заключенным в подходящие кавычки, и становятся одним аргументом команды оболочки. (Последняя форма почти всегда предпочтительна, если только вы не абсолютно точно знаете, что содержится в переменной.) Поскольку символы возврата каретки и перевода строки невозможно надежно защитить на всех платформах, форма :'имя_переменной' выводит сообщение об ошибке и не производит подстановку значения переменной, когда это значение содержит такие символы.

Некоторые команды принимают в качестве аргумента идентификатор SQL (например имя таблицы). Такие аргументы следуют правилам синтаксиса SQL: буквы, не заключенные в кавычки, преобразуются в нижний регистр, тогда как кавычки (") защищают буквы от преобразования регистра и позволяют включать пробелы в идентификатор. Внутри кавычек в итоговом имени две кавычки сокращаются до одной. Например, FOO"BAR"BAZ интерпретируется как fooBARbaz, а "A weird"" name" становится A weird" name.

Разбор аргументов останавливается в конце строки или когда встречается другой обратный слэш, не взятый в кавычки. Обратный слэш не внутри кавычек принимается за начало новой метакоманды. Специальная последовательность \\ (два обратных слэша) обозначает окончание аргументов и продолжение разбора команд SQL, если таковые имеются. Таким образом, команды SQL и psql можно свободно смешивать в одной строке. Но в любом случае аргументы метакоманд не могут выходить за пределы текущей строки.

Многие из метакоманд оперируют с буфером текущего запроса. Это обычный буфер, содержащий произвольный текст команды SQL, который был введен, но еще не передан серверу для выполнения. В него будут входить и предыдущие строки ввода, а также текст, находящийся в той же строке перед метакомандой.

Определены следующие метакоманды:

\a

Если текущий формат вывода таблицы невыровненный, то он переключается на выровненный. Если текущий формат выровненный, то устанавливается невыровненный. Эта команда поддерживается для обратной совместимости. См. \pset для более общего решения.

\c или \connect [ -reuse-previous=on|off ] [ имя_бд [ имя_пользователя ] [ хост ] [ порт ] | строка_подключения ]

Устанавливает новое подключение к серверу QHB. Параметры подключения можно указывать как позиционно (один или несколько по списку: база данных, пользователь, хост и порт), так и передавая аргумент строка_подключения (подробнее о строках подключения рассказывается в подразделе Строки подключения). Если аргументы отсутствуют, новое подключение устанавливается с теми же параметрами, что и предыдущее.

Указание в параметре имя_бд, имя_пользователя, хост или порт значения - равнозначно опущению этого параметра.

Новое подключение может повторно использовать параметры предыдущего; не только имя базы данных, пользователя, хост и порт, но и, к примеру, режим_ssl. По умолчанию параметры используются повторно при позиционной записи, но не когда указывается строка_подключения. Если передать в первом аргументе -reuse- revious=on или -reuse-previous=off, это поведение переопределяется. При повторном использовании любой параметр, не заданный явно в виде позиционного или в строке_подключения, берется из параметров текущего подключения. Исключение составляет параметр адрес_хоста — если в новом подключении значение хост меняется в позиционной записи, значение адрес_хоста из текущих параметров подключения сбрасывается. Кроме того, пароль существующего подключения будет использован повторно, только если имя пользователя, хост и порт не меняются. Если какой-либо параметр не указан в этой команде и не используется повторно, действует принятое в libpq значение по умолчанию.

Если новое подключение успешно установлено, предыдущее подключение закрывается. Если попытка подключения не удалась (неверное имя пользователя, доступ запрещен и т. д.), то предыдущее соединение останется активным, если psql находится в интерактивном режиме. Но если скрипт выполняется неинтерактивно, предыдущее соединение закрывается с сообщением об ошибке. При этом скрипт может завершиться или не завершиться; в последнем случае все команды, обращающиеся к базе данных, будут неуспешными, пока не будет успешно выполнена еще одна команда \connect. Различное поведение было выбрано для удобства пользователя: с одной стороны в качестве защиты от опечаток, а с другой — как защитный механизм, не позволяющий случайно запустить скрипты в неправильной базе данных. Обратите внимание, что когда команда \connect пытается повторно использовать параметры, она использует параметры последнего удачного подключения, а не какой-либо из последующих неудачных попыток. Однако в случае неудачи при неинтерактивном выполнении команды \connect никакие параметры не позволено использовать впоследствии, так как скрипт, скорее всего, рассчитывает на то, что должны повторно использоваться значения именно от неуспешной команды \connect.

Примеры:

=> \c mydb myuser host.dom 6432
=> \c service=foo
=> \c "host=localhost port=5432 dbname=mydb connect_timeout=10 sslmode=disable"
=> \c -reuse-previous=on sslmode=require    -- меняется только sslmode
=> \c qhb://tom@localhost/mydb?application_name=myapp

\C [ заголовок ]

Задает заголовок любых таблиц, который будет выводиться в результате запроса, или отменяет установленный ранее заголовок. Эта команда равнозначна \pset title заголовок. (Название этой команды происходит от слова «caption» (заголовок), поскольку раньше она применялась только для задания заголовков HTML-таблиц.)

\cd [ каталог ]

Меняет текущий рабочий каталог на каталог. Без аргумента устанавливается домашний каталог текущего пользователя.

Совет
Для отображения текущего рабочего каталога используйте команду \! pwd.

\conninfo

Выводит информацию о текущем подключении к базе данных.

\copy { таблица [ ( список_столбцов ) ] } from { 'имя_файла' | program 'команда' | stdin | pstdin } [ [ with ] ( параметр [, ...] ) ] [ where условие ]
\copy { таблица [ ( список_столбцов ) ] | ( запрос ) } to { 'имя_файла' | program 'команда' | stdout | pstdout } [ [ with ] ( параметр [, ...] ) ]

Производит копирование данных с участием терминала (клиента). Данная операция запускает выполнение команды SQL COPY, но вместо чтения или записи указанного файла на сервере, его читает или записывает psql и пересылает данные между сервером и терминалом. Это означает, что здесь используются доступ к файлу и права локального пользователя, а не сервера, и не требуются права суперпользователя SQL.
Если указан параметр program, psql выполняет команду, и данные, поступающие из/в нее, передаются между сервером и клиентом. Опять же, для выполнения программ используются права локального пользователя, а не сервера, и не требуются права суперпользователя SQL.
При выполнении \copy ... from stdin строки данных считываются из источника, выполнившего команду, и считываются до тех пор, пока не встретится \. или не будет достигнут конец файла. Этот параметр полезен для заполнения таблиц непосредственно в SQL-скриптах. При выполнении \copy ... to stdout вывод направляется в то же место, что и вывод команд psql, а статус команды COPY не отображается (так как его можно перепутать со строкой данных). Для чтения/ записи стандартного ввода или вывода psql, вне зависимости от источника текущей команды или параметра \o, напишите from pstdin или to pstdout.
Синтаксис этой команды похож на синтаксис команды SQL COPY. Все параметры, кроме источника/получателя данных, задаются так же, как в COPY. Из-за этого при разборе метакоманды \copy применяются другие правила. В отличие от большинства других метакоманд, для нее остаток строки всегда воспринимается как аргументы \copy, и в этих аргументах не выполняется ни интерполяция переменных, ни раскрытие обратных кавычек.

Совет
Другой способ получить тот же результат, что и с \copy ... to, — использовать команду SQL COPY ... TO STDOUT и завершить ее командой \g имя_файла или \g |программа. В отличие от \copy, этот метод позволяет разбивать команду на несколько строк, а также использовать интерполяцию переменных и раскрытие обратных кавычек.

Совет
Эти операции не так эффективны, как команда SQL COPY, в которой источником или получателем данных является файл, поскольку все данных должны перемещаться по клиент-серверному соединению. Для больших объемов данных команда SQL может оказаться предпочтительнее.

\copyright

Показывает информацию об авторских правах и условиях распространения QHB.

\crosstabview [ столбВ [ столбГ [ столбД [ столбсортГ ] ] ] ]

Выполняет содержимое буфера текущего запроса (как \g) и показывает результаты в виде перекрестной таблицы. Этот запрос должен возвращать как минимум три столбца. Столбец вывода, заданный параметром столбВ, становится вертикальным заголовком, а столбец вывода, заданный параметром столбГ — горизонтальным заголовком. Параметр столбД задает столбец с данными для отображения внутри таблицы. столбсортГ задает необязательный столбец сортировки для горизонтального заголовка.
Каждое указание столбца может быть номером (начиная с 1) или именем столбца. К именам применяются обычные принятые в SQL правила учета регистра и кавычек. Если аргументы опущены, то в качестве столбВ подразумевается столбец 1, а в качестве столбГ — столбец 2. столбГ должен отличаться от столбВ. Если столбД не задан, в результате запроса должно быть ровно три столбца, и в качестве столбД выбирается столбец, отличный от столбВ и столбГ.
Вертикальный заголовок, отображаемый в самом левом столбце, содержит значения из столбца столбВ в том же порядке, что и в результате запроса, но без дубликатов.
Горизонтальный заголовок, отображаемых в первой строке, содержит значения из столбца столбГ без дубликатов. По умолчанию они располагаются в том же порядке, что и в результате запроса. Но если задан необязательный аргумент столбсортГ, он определяет столбец, который должен содержать целые числа, и тогда значения из столбГ будут располагаться в горизонтальном заголовке в соответствии с порядком значений в столбсортГ.
Внутри перекрестной таблицы для каждого уникального значения x в столбГ и каждого уникального значения y в столбВ ячейка, находящаяся на пересечении (x,y), содержит значение столбД в строке результата запроса, в которой значение столбГ равно х, а значение столбВ — у. Если такой строки нет, ячейка остается пустой. Если таких строк несколько, выдается ошибка.

\d[S+] [ шаблон ]

Для каждого отношения (таблицы, представления, материализованного представления, индекса, последовательности или сторонней таблицы) или составного типа, соответствующих шаблону, показать все столбцы, их типы, табличное пространство (если это не значение по умолчанию) и все специальные атрибуты, например, NOT NULL или значения по умолчанию. Также показываются связанные индексы, ограничения, правила и триггеры. Для сторонних таблиц также показывается связанный сторонний сервер. («Соответствие шаблону» определяется ниже в подразделе Шаблоны.)
Для некоторых типов отношений \d показывает дополнительную информацию по каждому столбцу: значения столбца для последовательностей, индексируемые выражения для индексов и параметры обертки сторонних данных для сторонних таблиц.
Форма команды \d+ идентична \d, но отображает больше информации: показываются все комментарии к столбцам таблицы, а также наличие в таблице OID, определение представления, если отношение является представлением, значение параметра replica identity, если оно нестандартное, и имя метода доступа, если для отношения определен метод доступа.
По умолчанию показываются только объекты, созданные пользователями; чтобы включить системные объекты, нужно задать шаблон или добавить модификатор S.

Примечание
Если \d используется без аргумента шаблон, эта команда равнозначна \dtvmsE, то есть показывает список всех видимых таблиц, представлений, материализованных представлений, последовательностей и сторонних таблиц. Это сделано исключительно ради удобства.

\da[S] [ шаблон ]

Выводит список агрегатных функций вместе с типом возвращаемого значения и типами данных, которыми они оперируют. Если задан шаблон, показываются только те агрегатные функции, имена которых соответствуют этому шаблону. По умолчанию показываются только объекты, созданные пользователями; чтобы включить системные объекты, нужно задать шаблон или добавить модификатор S.

\dA[+] [ шаблон ]

Выводит список методов доступа. Если задан шаблон, показываются только те методы доступа, имена которых соответствуют этому шаблону. При добавлении к имени команды + каждый метод доступа выводится вместе со своей функцией обработки и описанием.

\dAc[+] [шаблон-методов-доступа [шаблон-входных-типов]]

Выводит список классов операторов (см. подраздел Индексные методы и классы операторов). Если задан шаблон-методов-доступа, выводятся только классы операторов, связанные с методами доступа, имена которых соответствуют этому шаблону. Если задан шаблон-входных-типов, выводятся только классы операторов, связанные с входными типами, имена которых соответствуют этому шаблону. При добавлении к имени команды + каждый класс операторов выводится вместе со своими семейством операторов и владельцем.

\dAf[+] [шаблон-методов-доступа [шаблон-входных-типов]]

Выводит список семейств операторов (см. подраздел Классы операторов и семейства операторов). Если задан шаблон-методов-доступа, выводятся только семейства операторов, связанные с методами доступа, имена которых соответствуют этому шаблону. Если задан шаблон-входных-типов, выводятся только семейства операторов, связанные с входными типами, имена которых соответствуют этому шаблону. При добавлении к имени команды + каждое семейство операторов выводится вместе со своим владельцем.

\dAo[+] [шаблон-методов-доступа [шаблон-семейств-операторов]]

Выводит список операторов, связанных с семействами операторов (см. подраздел Стратегии индексного метода). Если задан шаблон-методов-доступа, выводятся только члены семейств операторов, связанных с методами доступа, имена которых соответствуют этому шаблону. Если задан шаблон-семейств-операторов, выводятся только члены семейств операторов, имена которых соответствуют этому шаблону. При добавлении к имени команды + каждый оператор выводится вместе со своим семейством операторов сортировки (если это оператор упорядочивания).

\dAp[+] [шаблон-методов-доступа [шаблон-семейств-операторов]]

Выводит список вспомогательных функций, связанных с семействами операторов (см. подраздел Вспомогательные процедуры индексного метода). Если задан шаблон-методов-доступа, выводятся только функции семейств операторов, связанных с методами доступа, имена которых соответствуют этому шаблону. Если задан шаблон-семейств-операторов, выводятся только функции семейств операторов, имена которых соответствуют этому шаблону. При добавлении к имени команды + функции отображаются в развернутом виде, со списками их фактических параметров.

\db[+] [ шаблон ]

Выводит список табличных пространств. Если задан шаблон, показываются только те табличные пространства, имена которых соответствуют этому шаблону. При добавлении к имени команды + каждое табличное пространство выводится вместе со своими параметрами, объемом на диске, правами и описанием.

\dc[S+] [ шаблон ]

Выводит список преобразований между кодировками наборов символов. Если задан шаблон, выводятся только те преобразования кодировок, имена которых соответствуют этому шаблону. По умолчанию показываются только объекты, созданные пользователями; чтобы включить системные объекты, нужно задать шаблон или добавить модификатор S. При добавлении к имени команды + каждый объект выводится вместе со своим описанием.

\dC[+] [ шаблон ]

Выводит список приведений типов. Если задан шаблон, выводятся только те приведения типов, у которых исходные или целевые типы соответствуют этому шаблону. При добавлении к имени команды + каждый объект выводится вместе со своим описанием.

\dd[S] [ шаблон ]

Показывает описания объектов следующих видов: constraint (ограничение), operator class (класс операторов), operator family (семейство операторов), rule (правило) и trigger (триггер). Все остальные комментарии можно посмотреть посредством соответствующих метакоманд для этих типов объектов.
\dd отображает описания для объектов, соответствующих шаблону, или для доступных объектов указанных типов, если аргументы не заданы. Но в любом случае выводятся только те объекты, у которых есть описание. По умолчанию показываются только объекты, созданные пользователями; чтобы включить системные объекты, нужно задать шаблон или добавить модификатор S.
Описания для объектов можно создать при помощи команды SQL COMMENT.

\dD[S+] [ шаблон ]

Выводит список доменов. Если задан шаблон, показываются только те домены, имена которых соответствуют этому шаблону. По умолчанию показываются только объекты, созданные пользователями; чтобы включить системные объекты, нужно задать шаблон или добавить модификатор S. При добавлении к имени команды + каждый объект выводится вместе со своими правами и описанием.

\ddp [ шаблон ]

Выводит список прав доступа по умолчанию. Показывается запись для каждой роли (и схемы, если применимо), для которой права доступа по умолчанию отличаются от встроенных. Если задан шаблон, выводятся строки только для тех ролей или схем, имена которых соответствуют этому шаблону.
Права доступа по умолчанию устанавливаются командой ALTER DEFAULT PRIVILEGES. Смысл отображаемых прав объясняется в разделе Права.

\dE[S+] [ шаблон ]
\di[S+] [ шаблон ]
\dm[S+] [ шаблон ]
\ds[S+] [ шаблон ]
\dt[S+] [ шаблон ]
\dv[S+] [ шаблон ]

В этой группе команд буквы E, i, m, s, t и v обозначают стороннюю таблицу, индекс, материализованное представление, последовательность, таблицу и представление соответственно. Можно указывать все или часть этих букв в произвольном порядке, чтобы получить список объектов этих типов. Например, \dit выводит список индексов и таблиц. При добавлении к имени команды + каждый объект выводится вместе со своими состоянием хранения (постоянный, временный или нежурналируемый), физическим размером на диске и описанием, если таковое имеется. Если задан шаблон, выводятся только те объекты, имена которых соответствуют этому шаблону. По умолчанию показываются только объекты, созданные пользователями; чтобы включить системные объекты, нужно задать шаблон или добавить модификатор S.

\des[+] [ шаблон ]

Выводит список сторонних серверов (мнемоника: «external servers» (внешние серверы)). Если задан шаблон, выводятся только те серверы, имена которых соответствуют этому шаблону. Если используется форма \des+, то показывается полное описание каждого сервера, включая права доступа, тип, версию, параметры и описание.

\det[+] [ шаблон ]

Выводит список сторонних таблиц (мнемоника: «external tables» (внешние таблицы)). Если задан шаблон, выводятся только те записи, у которых имя таблицы или схемы соответствует этому шаблону. Если используется форма \det+, то также отображаются общие параметры и описание сторонней таблицы.

\deu[+] [ шаблон ]

Выводит список сопоставлений пользователей (мнемоника: «external users» (внешние пользователи)). Если задан шаблон, выводятся только те сопоставления, в которых имена пользователей соответствуют этому шаблону. Если используется форма \deu+, то показывается дополнительная информация о каждом сопоставлении пользователя.

ВНИМАНИЕ!
\deu+ также может отображать имя и пароль удаленного пользователя, поэтому следует позаботиться о том, чтобы не раскрывать их.

\dew[+] [ шаблон ]

Выводит список оберток сторонних данных (мнемоника: «external wrappers» (внешние обертки)). Если задан шаблон, выводятся только те обертки сторонних данных, имена которых соответствуют этому шаблону. Если используется форма \dew+, то также показываются права доступа, параметры и описание обертки.

\df[antwS+] [ шаблон [ арг_шаблон ... ] ]

Выводит список функций с типами данных их результатов, аргументов и классификацией: «agg» (агрегатная), «normal» (обычная), «procedure» (процедурная), «trigger» (триггерная) или «window» (оконная). Чтобы получить функции только определенного вида(ов), добавьте в команду буквы a, n, p, t или w соответственно. Если задан шаблон, показываются только те функции, имена которых соответствуют этому шаблону. Любые дополнительные аргументы являются шаблонами имен типов, которые сопоставляются с именами типов первого, второго и последующих аргументов функций. (У сопоставленных функций может быть больше аргументов, чем вы задали. Чтобы предотвратить это, напишите в качестве последнего арг_шаблона минус (-).) По умолчанию показываются только объекты, созданные пользователями; чтобы включить системные объекты, нужно задать шаблон или добавить модификатор S. Если используется форма \df+, то показывается дополнительная информация по каждой функции, включая изменчивость, допустимость распараллеливания, владельца, классификацию по безопасности, права доступа, язык, исходный код и описание.

\dF[+] [ шаблон ]

Выводит список конфигураций текстового поиска. Если задан шаблон, показываются только те конфигурации, имена которых соответствуют этому шаблону. Если используется форма \dF+, то показывается полное описание каждой конфигурации, включая нижележащий синтаксический анализатор и список словарей для каждого типа синтаксических единиц.

\dFd[+] [ шаблон ]

Выводит список словарей текстового поиска. Если задан шаблон, показываются только те словари, имена которых соответствуют этому шаблону. Если используется форма \dFd+, то показывается дополнительная информация о каждом выбранном словаре, включая нижележащий шаблон текстового поиска и параметры инициализации.

\dFp[+] [ шаблон ]

Выводит список анализаторов текстового поиска. Если задан шаблон, показываются только те анализаторы, имена которых соответствуют этому шаблону. Если используется форма \dFp+, то показывается полное описание каждого анализатора, включая нижележащие функции и список распознаваемых типов синтаксических единиц.

\dFt[+] [ шаблон ]

Выводит список шаблонов текстового поиска. Если задан шаблон, показываются только те шаблоны, имена которых соответствуют этому шаблону. Если используется форма \dFt+, то показывается дополнительная информация о каждом шаблоне, включая имена нижележащих функций.

\dg[S+] [ шаблон ]

Выводит список ролей базы данных. (Поскольку понятия «пользователи» и «группы» были объединены в «роли», теперь эта команда равнозначна \du.) По умолчанию показываются только роли, созданные пользователями; чтобы включить системные роли, нужно добавить модификатор S. Если задан шаблон, выводятся только те роли, имена которых соответствуют этому шаблону. Если используется форма \dg+, показывается дополнительная информация о каждой роли; в настоящее время это комментарий к роли.

\dl

Это псевдоним для \lo_list, который показывает список больших объектов.

\dL[S+] [ шаблон ]

Выводит список процедурных языков. Если задан шаблон, выводятся только те языки, имена которых соответствуют этому шаблону. По умолчанию показываются только языки, созданные пользователями; чтобы включить системные объекты, нужно добавить модификатор S. При добавлении к имени команды + каждый язык выводится вместе со своими функциями обработки вызова и проверки, правами доступа и указанием, является ли этот язык системным объектом.

\dn[S+] [ шаблон ]

Выводит список схем (пространств имен). Если задан шаблон, выводятся только те схемы, имена которых соответствуют этому шаблону. По умолчанию показываются только объекты, созданные пользователями; чтобы включить системные объекты, нужно задать шаблон или добавить модификатор S. При добавлении к имени команды + каждый объект выводится вместе со своими правами и описанием, если таковое имеются.

\do[S+] [ шаблон [ арг_шаблон [ арг_шаблон ] ] ]

Выводит список операторов с их операндами и типами результатов. Если задан шаблон, выводятся только те операторы, имена которых соответствуют этому шаблону. Если задан один арг_шаблон, выводятся только те префиксные операторы, у которых тип правого аргумента соответствует этому шаблону. Если задано два арг_шаблона, выводятся только те бинарные операторы, у которых имена типов аргументов соответствуют этому шаблону. (Как вариант, можно написать - (минус) в качестве неиспользуемого аргумента унарного оператора.) По умолчанию показываются только объекты, созданные пользователями; чтобы включить системные объекты, нужно задать шаблон или добавить модификатор S. При добавлении к имени команды + показывается дополнительная информация о каждом операторе; в настоящее время это только имя нижележащей функции.

\dO[S+] [ шаблон ]

Выводит список правил сортировки. Если задан шаблон, выводятся только те правила, имена которых соответствуют этому шаблону. По умолчанию показываются только объекты, созданные пользователями; чтобы включить системные объекты, нужно задать шаблон или добавить модификатор S. При добавлении к имени команды + каждое правило выводится вместе со своим описанием, если таковое имеется. Обратите внимание, что показываются только правила сортировки, применимые к кодировке текущей базы данных, поэтому в разных базах данных одной установки результаты этой команды могут отличаться.

\dp [ шаблон ]

Выводит список таблиц, представлений и последовательностей с их правами доступа. Если задан шаблон, выводятся только те таблицы, представления и последовательности, имена которых соответствуют этому шаблону.
Для установки прав доступа используются команды GRANT и REVOKE. Смысл отображаемых прав объясняется в разделе Права.

\dP[itn+] [ шаблон ]

Выводит список партиционированных отношений. Если задан шаблон, выводятся только те записи, имена которых соответствуют этому шаблону. К команде можно добавить модификаторы t (tables, таблицы) и i (indexes, индексы), отфильтровав список по типу отношений. По умолчанию выводятся и партиционированные таблицы, и индексы.
При использовании модификатора n («nested», вложенные) или указании шаблона в список включаются также вложенные партиционированные отношения и показывается столбец, отображающий родителя каждого партиционированного отношения.
При добавлении к имени команды + также отображается суммарный размер партиций каждого отношения и его описание. Если + дополняет модификатор n, показывается два размера: общий размер партиций листового уровня, напрямую связанных с отношением, и общий размер всех партиций, включая вложенные партиции, связанные с отношением опосредованно.

\drds [ шаблон-ролей [ шаблон-баз ] ]

Выводит список определенных параметров конфигурации. Эти параметры могут быть специфичными для роли, специфичными для базы данных или для обеих. Параметры шаблон-ролей и шаблон-баз используются для отбора определенных ролей и баз данных соответственно. Если они опущены или указано *, выводятся все параметры, в том числе неспецифичные для ролей или баз данных соответственно.
Для определения параметров конфигурации, специфичных для роли и базы данных, используются команды ALTER ROLE и ALTER DATABASE.

\dRp[+] [ шаблон ]

Выводит список публикаций репликации. Если задан шаблон, выводятся только те публикации, имена которых соответствуют этому шаблону. При добавлении к имени команды + также показываются таблицы, связанные с каждой публикацией.

\dRs[+] [ шаблон ]

Выводит список подписок на репликацию. Если задан шаблон, выводятся только те подписки, имена которых соответствуют этому шаблону. При добавлении к имени команды + показываются дополнительные свойства подписок.

\dT[S+] [ шаблон ]

Выводит список типов данных. Если задан шаблон, выводятся только те типы, имена которых соответствуют этому шаблону. При добавлении к имени команды + каждый тип выводится вместе со своими внутренним именем и размером, допустимыми значениями (если это тип enum) и связанными правами. По умолчанию показываются только объекты, созданные пользователями; для включения системных объектов нужно задать шаблон или добавить модификатор S.

\du[S+] [ шаблон ]

Выводит список ролей базы данных. (Поскольку понятия «пользователи» и «группы» были объединены в «роли», теперь эта команда равнозначна \dg.) По умолчанию показываются только роли, созданные пользователями; чтобы включить системные роли, нужно добавить модификатор S. Если задан шаблон, выводятся только те роли, имена которых соответствуют этому шаблону. Если используется форма \du+, показывается дополнительная информация о каждой роли; в настоящее время это комментарий к роли.

\dx[+] [ шаблон ]

Выводит список установленных расширений. Если задан шаблон, выводятся только те расширения, имена которых соответствуют этому шаблону. Если используется форма \dx+, то выводятся все объекты, принадлежащие каждому соответствующему расширению.

\dX [ шаблон ]

Выводит объекты расширенной статистики. Если задан шаблон, выводятся только те объекты, имена которых соответствуют этому шаблону.
Состояние каждого вида расширенной статистки показывается в столбце с именем, отражающим ее вид (например Ndistinct). Состояние defined (определен) означает, что этот вид был запрошен при создании статистики, а NULL — что он не был запрошен. Чтобы узнать, запускалась ли команда ANALYZE и доступна ли статистика для планировщика, можно обратиться к представлению pg_stats_ext.

\dy[+] [ шаблон ]

Выводит список триггеров событий. Если задан шаблон, выводятся только те триггеры событий, имена которых соответствуют этому шаблону. При добавлении к имени команды + каждый объект выводится вместе со своим описанием.

\e или \edit [ имя_файла ] [ номер_строки ]

Если задано имя_файла, этот файл открывается для редактирования; после выхода из редактора содержимое файла копируется в буфер текущего запроса. Если имя_файла не задано, буфер текущего запроса копируется во временный файл, который затем редактируется таким же образом. Либо, если буфер текущего запроса пуст, во временный файл копируется последний выполненный запрос, который затем редактируется таким же образом.
Если после редактирования файла или предыдущего запроса выйти из редактора без сохранения файла, буфер запроса очищается. В ином случае новое содержимое буфера запроса повторно разбирается в соответствии с обычными правилами psql, при этом весь буфер обрабатывается как одна строка. Все завершенные запросы немедленно выполняются; то есть если буфер запроса содержит или заканчивается точкой с запятой, все его содержимое до этой точки выполняется и удаляется из буфера. Все, что остается в буфере, повторно выводится на экран. Для его передачи серверу нужно ввести точку с запятой или \g, а для отмены путем очищения буфера запроса — \r.
Обработка буфера как одной стоки в основном влияет на метакоманды: все, что находится в буфере после метакоманды, будет восприниматься как аргумент(ы) этой метакоманды, даже если этот текст занимает несколько строк. (Поэтому таким способом нельзя выполнять скрипты с метакомандами. Для таких скриптов используйте \i.)
Если задан номер строки, psql будет позиционировать курсор на указанную строку файла или буфера запроса. Обратите внимание, что если указан один аргумент, и он числовой, psql предполагает, что это номер строки, а не имя файла.

Совет
Как конфигурировать редактор и настроить его поведение, рассказывается ниже в параграфе Переменные среды.

\echo текст [ ... ]

Печатает вычисленные аргументы в стандартный вывод, разделяя их пробелами с переводом строки в конце. Это может быть полезно для добавления дополнительной информации в вывод скриптов. Например:

=> \echo `date`
Tue Oct 26 21:40:57 CEST 1999

Если в первом аргументе передается -n без кавычек, перевод строки в конце не добавляется (и не выводится сам первый аргумент).

Совет
Если вы перенаправляете вывод запросов с помощью команды \o, возможно, вместо этой команды будет лучше применить \qecho. См. также описание \warn.

\ef [ описание_функции [ номер_строки ] ]

Эта команда извлекает определение именованной функции или процедуры в форме команды CREATE OR REPLACE FUNCTION или CREATE OR REPLACE PROCEDURE и открывает его для редактирования. Редактирование производится тем же образом, что и при выполнении \edit. Если выйти из редактора без сохранения, этот оператор сбрасывается. Если сохранить файл и выйти из редактора, измененная команда немедленно выполняется, если вы добавили к ней точку с запятой. В противном случае она повторно выводится на экран; для ее передачи серверу нужно ввести точку с запятой или \g, а для отмены — \r.
Целевую функцию можно задать только по имени или именем и аргументами, например foo(integer, text). Типы аргументов необходимо давать, если существует более одной функции с таким именем.
Если функция не задана, для редактирования открывается пустая строка CREATE FUNCTION.
Если задан номер строки, psql будет позиционировать курсор на указанную строку тела функции. (Обратите внимание, что обычно тело функции не начинается на первой строке файла.)
В отличие от большинства других метакоманд, здесь весь остаток строки всегда воспринимается как аргумент(ы) \ef, и в этих аргументах не выполняется ни интерполяция переменных, ни раскрытие обратных кавычек.

Совет
Как конфигурировать редактор и настроить его поведение, рассказывается ниже в параграфе Переменные среды.

\encoding [ кодировка ]

Устанавливает кодировку набора символов на клиенте. Без аргумента эта команда показывает текущую кодировку.

\errverbose

Повторяет последнее серверное сообщение об ошибке с максимальным уровнем детализации, как если бы для переменной VERBOSITY было установлено значение verbose, а для SHOW_CONTEXT — always.

\ev [ имя_представления [ номер_строки ] ]

Эта команда извлекает определение именованного представления в форме команды CREATE OR REPLACE VIEW и открывает его для редактирования. Редактирование производится тем же образом, что и при выполнении \edit. Если выйти из редактора без сохранения, этот оператор сбрасывается. Если сохранить файл и выйти из редактора, измененная команда немедленно выполняется, если вы добавили к ней точку с запятой. В противном случае она повторно выводится на экран; для ее передачи серверу нужно ввести точку с запятой или \g, а для отмены — \r.
Если представление не задано, для редактирования открывается пустая строка CREATE VIEW.
Если задан номер строки, psql будет позиционировать курсор на указанную строку определения представления.
В отличие от большинства других метакоманд, здесь весь остаток строки всегда воспринимается как аргумент(ы) \ev, и в этих аргументах не выполняется ни интерполяция переменных, ни раскрытие обратных кавычек.

\f [ строка ]

Устанавливает разделитель полей для невыровненного вывода запросов. По умолчанию используется вертикальная черта (|). Это равнозначно команде \pset fieldsep.

\g [ (параметр=значение [...]) ] [ имя_файла ]
\g [ (параметр=значение [...]) ] [ |команда ]

Передает содержимое буфера текущего запроса серверу для выполнения.
Если после \g идут скобки, внутри них содержится разделенный пробелами список предложений параметров форматирования в виде параметр=значение, которые воспринимаются так же, как и в команде \pset параметр значение, но действуют только во время выполнения этого запроса. В этом списке пробелы не должны находиться вокруг знаков =, но должны разделять предложения параметров. Если =значение опускается, именованный параметр меняется так же, как и при выполнении \pset параметр без явно заданного значения.
Если заданы имя_файла или |команда, вывод запроса записывается в именованный файл или передается через поток заданной команде оболочки, а не отображается как обычно. Вывод записывается в файл или команду, только если запрос успешно возвращает ноль или более кортежей, но не при сбое запроса или выполнении команды SQL, не возвращающей данные.
Если буфер текущего запроса пуст, вместо этого повторно выполняется последний из запросов. За исключением этого поведения \g без аргументов по сути равнозначна точке с запятой. С аргументами же \g предоставляет «одноразовую» альтернативу команде \o и вдобавок позволяет корректировать на время выполнения параметры форматирования вывода, которые обычно устанавливаются командой \pset.
Когда последний аргумент начинается с |, весь остаток строки воспринимается как команда, подлежащая выполнению, и в ней не производится ни интерполяция переменных, ни раскрытие обратных кавычек. Этот остаток строки просто передается оболочке в буквальном виде.

\gdesc

Показывает описание (то есть имена и типы данных столбцов) результата текущего запроса в буфере. При этом в действительности этот запрос не выполняется; однако если он содержит какие-либо синтаксические ошибки, о них сообщается обычным способом.
Если буфер текущего запроса пуст, вместо этого будет описан последний переданный запрос.

\gexec

Передает буфер текущего запроса серверу, а затем обрабатывает содержимое каждого столбца каждой строки вывода запроса (если таковой имеется) как оператор SQL, подлежащий выполнению. Например, создание индекса по каждому столбцу my_table:

=> SELECT format('create index on my_table(%I)', attname)
-> FROM pg_attribute
-> WHERE attrelid = 'my_table'::regclass AND attnum > 0
-> ORDER BY attnum
-> \gexec
CREATE INDEX
CREATE INDEX
CREATE INDEX
CREATE INDEX

Генерируемые запросы выполняются в том порядке, в каком возвращаются строки, и слева направо, если возвращается более одного столбца. Поля NULL игнорируются. Генерируемые запросы передаются для обработки на сервер в буквальном виде, так что они не могут быть метакомандами psql или содержать ссылки на переменные psql. В случае сбоя в одном из запросов, выполнение оставшихся запросов продолжается, если только не установлена переменная ON_ERROR_STOP. Выполнение каждого запроса подвергается влиянию переменной ECHO. (Используя команду \gexec, часто рекомендуется устанавливать для ECHO значение all или queries.) Протоколирование запросов, пошаговый режим, замер времени и другая функциональность, тоже действуют при выполнении каждого генерируемого запроса.
Если буфер текущего запроса пуст, вместо этого повторно выполняется последний переданный запрос.

\gset [ префикс ]

Передает буфер текущего запроса на сервер и сохраняет вывод запроса в переменных psql (см. ниже в параграфе Переменные). Выполняемый запрос должен возвращать ровно одну строку. Каждый столбец этой строки сохраняется в отдельной переменной, которая называется так же, как и столбец. Например:

=> SELECT 'hello' AS var1, 10 AS var2
-> \gset
=> \echo :var1 :var2
hello 10

Если указан префикс, то он добавляется в начало имен столбцов запроса для создания имен переменных:

=> SELECT 'hello' AS var1, 10 AS var2
-> \gset result_
=> \echo :result_var1 :result_var2
hello 10

Если результат столбца равен NULL, то вместо присвоения значения соответствующая переменная сбрасывается.
Если запрос завершается неудачно или не возвращает одну строку, то переменные не изменяются.
Если буфер текущего запроса пуст, вместо этого повторно выполняется последний переданный запрос.

\gx [ (параметр=значение [...]) ] [ имя_файла ]
\gx [ (параметр=значение [...]) ] [ |команда ]

Метакоманда \gx равнозначна метакоманде \g, за исключением того, что она принудительно включает расширенный режим вывода для этого запроса, так же, как если бы в список параметров \pset было включено указание expanded=on. См. также описание \x.

\h или \help [ команда ]

Выдает справку по синтаксису указанной команды SQL. Если команда не указана, то psql выведет список всех команд, для которых доступна справка по синтаксису. Если в качестве команды указана звездочка (*), показывается справка по синтаксису для всех команд SQL.
В отличие от большинства других метакоманд, здесь весь остаток строки всегда воспринимается как аргумент(ы) \help, и в этих аргументах не выполняется ни интерполяция переменных, ни раскрытие обратных кавычек.

Примечание
Для упрощения ввода команды, состоящие из нескольких слов, необязательно заключать в кавычки. Таким образом, можно просто писать \help alter table.

\H или \html

Включает вывод запросов в формате HTML. Если формат HTML уже включен, происходит переключение обратно на выровненный формат текста. Эта команда предназначена для совместимости и удобства, но в описании \pset можно узнать о настройке других вариантов вывода.

\i или \include имя_файла

Читает ввод из файла имя_файла и выполняет его, как если бы он был набран на клавиатуре.
Если имя_файла задано как - (минус), читается стандартный ввод до обозначения конца файла или до метакоманды \q. Это можно использовать для совмещения интерактивного ввода с вводом из файлов. Обратите внимание, что поведение Readline будет применяться, только если оно активно на внешнем уровне.

Примечание
Если вы хотите видеть строки файла на экране по мере их прочтения, следует установить для переменной ECHO значение all.

\if выражение
\elif выражение
\else
\endif

Эта группа команд реализует вложенные условные блоки. Условный блок должен начинаться командой \if и заканчиваться \endif. Между ними может быть любое количество предложений \elif, за которыми может дополнительно следовать одно предложение \else. Между командами, формирующими условный блок, могут располагаться (и обычно располагаются) обычные запросы и другие типы метакоманд.
Команды \if и \elif считывают свои аргументы и вычисляют их как логические выражения. Если такое выражение выдает true, обработка продолжается как обычно; в противном случае строки пропускаются до достижения соответствующих команд \elif, \else или \endif. Как только проверка \if или \elif успешно завершается, аргументы последующих команд \elif в том же блоке не вычисляются, а считаются ложными. Строки после \else обрабатываются, только если ни одна из предыдущих проверок \if или \elif не была успешной.
В аргументе выражение команды \if или \elif производится интерполяция переменных и раскрытие обратных кавычек, как и в аргументе любой другой метакоманды. После этого он вычисляется как значение переменной параметра вкл/выкл. Поэтому допустимым значением является любое однозначное значение (без учета регистра) из следующих: true, false, 1, 0, on, off, yes, no. Например, значения t, T и tR все будут восприниматься как true.
Если выражения не удается оценить как истинное или ложное, будет сгенерировано предупреждение, а их результат будет считаться ложным.
Пропускаемые строки анализируются как обычно для идентификации запросов и метакоманд, но запросы не передаются на сервер, а метакоманды, отличные от условных (\if, \elif, \else, \endif), игнорируются. Условные команды проверяются только на правильность вложенности. Ссылки на переменные в пропускаемых строках не разворачиваются, как и не производится раскрытие обратных кавычек.
Все метакоманды в заданном условном блоке должны находиться в одном исходном файле. Если до того, как были закрыты все локальные блоки \if, в основном файле входа будет достигнут конец файла или встретится включение другого файла (команда \include), psql выдаст ошибку.

Например:

-- проверка на существование двух отдельных записей в базе данных и сохранение
-- результатов в двух разных переменных psql
SELECT
    EXISTS(SELECT 1 FROM customer WHERE customer_id = 123) as is_customer,
    EXISTS(SELECT 1 FROM employee WHERE employee_id = 456) as is_employee
\gset
\if :is_customer
    SELECT * FROM customer WHERE customer_id = 123;
\elif :is_employee
    \echo 'is not a customer but is an employee'
    SELECT * FROM employee WHERE employee_id = 456;
\else
    \if yes
        \echo 'not a customer or employee'
    \else
        \echo 'this will never print'
    \endif
\endif

\ir или \include_relative имя_файла

Команда \ir схожа с \i, но по-другому разрешает относительные имена файлов. При выполнении в интерактивном режиме обе команды ведут себя одинаково. Однако при вызове из скрипта \ir интерпретирует имена файлов относительно каталога, в котором расположен скрипт, а не текущего рабочего каталога.

\l[+] или \list[+] [ шаблон ]

Выводит список баз данных на сервере и показывает их имена, владельцев, кодировку набора символов и права доступа. Если задан шаблон, выводятся только те базы данных, имена которых соответствуют этому шаблону. При добавлении к имени команды + также отображаются размеры баз данных, табличные пространства по умолчанию и описания. (Информация о размере доступна только для тех баз данных, к которым может подключиться текущий пользователь.)

\lo_export oid_БО имя_файла

Читает большой объект с OID oid_БО из базы данных и записывает его в файл имя_файла. Обратите внимание, что это несколько отличается от серверной функции lo_export, действующей с правами пользователя, от имени которого работает сервер баз данных, и в файловой системе сервера.

Совет
Используйте для получения OID больших объектов команду \lo_list.

\lo_import имя_файла [ комментарий ]

Сохраняет файл в большом объекте QHB. Кроме того, с объектом можно связать заданный комментарий. Пример:

foo=> \lo_import '/home/peter/pictures/photo.xcf' 'a picture of me'
lo_import 152801

Ответ указывает на то, что большой объект получил OID 152801, который в будущем можно использовать для доступа ко вновь созданному большому объекту. Для удобочитаемости рекомендуется всегда связывать все объекты с понятными для человека комментариями. OID и комментарии можно посмотреть с помощью команды \lo_list.
Обратите внимание, что эта команда слегка отличается от серверной функции lo_import, поскольку действует от имени локального пользователя в локальной файловой системе, а не пользователя сервера в файловой системе сервера.

\lo_list

Показывает список всех больших объектов QHB, в настоящее время хранящихся в базе данных, вместе с предоставленными комментариями.

\lo_unlink oid_БО

Удаляет большой объект с OID oid_БО из базы данных.

Совет
Используйте для получения OID больших объектов команду \lo_list.

\o или \out [ имя_файла ]
\o или \out [ |команда ]

Организует сохранение результатов будущих запросов в файле имя_файла или передачу их через поток команде оболочки команда. Если аргументы не заданы, результат запроса перенаправляется на стандартный вывод.
Когда последний аргумент начинается с |, весь остаток строки воспринимается как команда, подлежащая выполнению, и в ней не производится ни интерполяция переменных, ни раскрытие обратных кавычек. Этот остаток строки просто передается оболочке в буквальном виде.
«Результаты запросов» включают в себя все таблицы, ответы команд и замечания, полученные от сервера баз данных, а также вывод от метакоманд, обращающихся к базе данных (например \d), но не сообщения об ошибках.

Совет
Чтобы вставить текстовый вывод между результатами запросов, используйте команду \qecho.

\p или \print

Вывести содержимое буфера текущего запроса в стандартный вывод. Если буфер текущего запроса пуст, вместо этого выводится последний выполненный запрос.

\password [ имя_пользователя ]

Изменяет пароль указанного пользователя (по умолчанию текущего пользователя). Эта команда запрашивает новый пароль, шифрует его и передает на сервер в виде команды ALTER ROLE. Это гарантирует, что новый пароль не отображается в открытом виде в истории команд, журнале сервера или где-то еще.

\prompt [ текст ] имя

Предлагает пользователю ввести значение, которое будет присвоено переменной имя. Дополнительно можно указать строку подсказки текст. (Если подсказка состоит из нескольких слов, ее текст следует заключить в апострофы.)
По умолчанию \prompt использует для ввода и вывода терминал. Однако при указании ключа командной строки -f, \prompt использует стандартные ввод и вывод.

\pset [ параметр [ значение ] ]

Эта команда устанавливает параметры, влияющие на вывод таблиц результатов запросов. Аргумент параметр определяет, какой параметр нужно установить. Семантика значения меняется в зависимости от выбранного параметра. Для некоторых параметров отсутствие значения вызывает переключение или сброс параметра, как рассказывается ниже в описании конкретного параметра. Если такое поведение не упоминается, то отсутствие значения приводит всего лишь к отображению текущего значения параметра.
\pset без аргументов отображает текущий статус всех выведенных параметров.
Имеются следующие настраиваемые параметры:

border
значение должно быть номером. В целом, чем больше это число, тем больше границ и линий будет в таблицах, но детали зависят от конкретного формата. В формате HTML заданное значение будет напрямую переводиться в атрибут border=.... Для большинства других форматов имеют смысл только значения 0 (нет границы), 1 (внутренние разделительные линии) и 2 (рамка таблицы), а значения больше 2 будут восприниматься как border = 2. Форматы latex и latex-longtable дополнительно поддерживают значение 3, добавляющее разделительные линии между строками данных.
columns
Устанавливает целевую ширину для формата wrapped, а также ограничение по ширине вывода, свыше которого потребуется программа листания или переключение на вертикальное отображение в режиме expanded auto. При значении ноль (по умолчанию) целевая ширина управляется переменной среды COLUMNS или, если COLUMNS не установлена, определенной шириной экрана. Кроме того, если columns равен нулю, то формат wrapped влияет только на вывод на экран. Если columns не равен нулю, то это также влияет на вывод данных в файл и передачу через поток.
csv_fieldsep
Задает разделитель полей для формата вывода CSV. Если символ-разделитель оказывается в значении поля, это поле выводится в кавычках согласно стандартным правилам CSV. Разделитель по умолчанию — запятая.
expanded (или x)
При указании значения допускаются варианты on или off, которые включают или выключают развернутый режим, или auto. Если значение опущено, команда переключает режим на противоположный. Когда развернутый режим включен, результаты запроса выводятся в два столбца: в левом имя столбца, в правом данные. Этот режим полезен, если данные не помещаются на экране в обычном «горизонтальном» режиме. Со значением auto развернутый режим используется, когда вывод запроса содержит более одного столбца и по ширине не умещается на экране; в противном случае используется обычный режим. Вариант auto действует только в форматах aligned и wrapped. С другими форматами он всегда равнозначен выключению развернутого режима.
fieldsep
Задает разделитель полей для невыровненного режима вывода. Таким способом можно создать вывод со значениями, разделенными, к примеру, табуляцией, что может быть предпочтительным для других программ. Для установки символа табуляции в качестве разделителя полей нужно написать \pset fieldsep '\t'. Разделитель по умолчанию — '|' (вертикальная черта).
fieldsep_zero
Устанавливает разделитель полей для невыровненного режима вывода в нулевой байт.
footer
При указании значения допускаются варианты on или off, которые включают или выключают отображение итоговой части таблицы с количеством выбранных записей (n rows). Если значение опущено, команда переключает состояние отображения итоговой строки на противоположное.
format
Устанавливает один из следующих форматов вывода: aligned, asciidoc, csv, html, latex, latex-longtable, troff-ms, unaligned или wrapped. Допускаются уникальные сокращения этих слов.
- Формат aligned — это стандартный, удобочитаемый, хорошо отформатированный текстовый вывод; это значение по умолчанию.
- В формате unaligned все столбцы выводятся в одной строке, отделенные друг от друга активным на данный момент разделителем полей. Это полезно для создания вывода, который может быть предназначен для чтения другими программами, например, для форматов с символом табуляции или запятой в качестве разделителя. Однако если разделитель полей оказывается в значении столбца, он обрабатывается как часть значения, поэтому для таких целей больше подходит формат CSV.
- В формате csv значения столбцов выводятся через запятую и могут заключаться в кавычки по правилам, описанным в RFC 4180. Этот вывод совместим с форматом CSV серверной команды COPY. Если не включен параметр tuples_only, то генерируется строка заголовка с именами столбцов. Верхний и нижний колонтитулы не выводятся. Каждая строка заканчивается символом конца строки, зависящим от операционной системы; В Unix-подобных системах это обычно символ новой строки (\n). Разделители полей, отличные от запятой, можно выбрать командой \pset csv_fieldsep.
- Формат wrapped похож на aligned, но переносит длинные значения на новые строки, чтобы вывод поместился в целевую ширину столбца. Задание целевой ширины описано в параметре columns. Обратите внимание, что psql не будет пытаться переносить на новые строки заголовки столбцов; таким образом, формат wrapped работает так же, как aligned, если общая ширина, требуемая для заголовков столбцов, превышает целевую.
- Форматы asciidoc, html, latex, latex-longtable и troff-ms выводят таблицы, которые предназначены для включения в документы со помощью соответствующего языка разметки. Они не являются полноценными документами! Возможно, в этом нет необходимости в HTML, но для LaTeX обязателен документ- контейнер. Формат latex использует среду LaTeX tabular. Формату latex-longtable требуются пакеты LaTeX longtable и booktabs.
linestyle
Задает стиль отрисовки линий границы: ascii, old-ascii или unicode. Допускаются уникальные сокращения этих слов. (Это значит, что достаточно и одной буквы.) Стиль по умолчанию — ascii. Этот параметр действует только в форматах вывода aligned и wrapped.
- Стиль ascii использует простые символы ASCII. Символы новой строки в данных показываются с использованием символа + с правого края. Когда при формате wrapped происходит перенос данных на новую строку без символа новой строки, с правого края первой строки и с левого края следующей строки ставится точка (.).
- Стиль old-ascii использует простые символы ASCII в стиле форматирования более старых версий QHB. Символы новой строки в данных показываются с использованием символа : вместо левого разделителя столбцов. Когда происходит перенос данных на новую строку без символа новой строки, вместо левого разделителя столбцов используется символ ;.
- Стиль unicode использует символы Unicode для рисования рамок. Символы новой строки в данных показываются с использованием символа возврата каретки с правого края. Когда происходит перенос данных на новую строку без символа новой строки, с правого края первой строки и с левого края следующей строки ставится многоточие. Когда значение border больше нуля, параметр linestyle также определяет символы, которыми будут рисоваться линии границы. Простые символы ASCII работают везде, но символы Unicode лучше выглядят на распознающих их терминалах.
null
Задает строку, которая будет выводиться вместо значения NULL. По умолчанию не выводится ничего, что можно по ошибке принять за пустую строку. Например, можно было бы предпочесть \pset null '(null)'.
numericlocale
При указании значения допускаются варианты on или off, которые включают или выключают отображение специфичного для локали символа, отделяющие группы цифр слева от десятичного знака. Если значение опущено, команда переключает формат отображение чисел на противоположный.
pager
Управляет использованием программы листания для вывода результатов запросов и справки по psql. Если установлена переменная среды PSQL_PAGER или PAGER, вывод передается через поток указанной программе. В противном случае используется платформо-зависимая программа по умолчанию (например more).
Когда параметр pager установлен в значение off, программа листания не используется. Когда pager имеет значение on, программа листания применяется при необходимости, т. е. когда вывод на терминал не помещается на экране. Кроме того, параметр pager может принимать значение always, при котором программа листания будет использоваться для всех выводов на терминал, независимо от того, помещается ли тот на экране. Команда \pset pager без указания значения включает/выключает программу листания.
pager_min_lines
Если в pager_min_lines задается число, превышающее высоту страницы, программа листания не будет вызываться, пока не наберется это число строк вывода для показа. Значение по умолчанию — 0.
recordsep
Задает разделитель записей (строк) для невыровненного режима вывода. Разделитель по умолчанию — символ новой строки.
recordsep_zero
Устанавливает разделитель записей для невыровненного режима вывода в нулевой байт.
tableattr (или T)
В формате HTML этот параметр задает атрибуты, которые будут помещены в тег table. Например, это может быть cellpadding или bgcolor. Обратите внимание, что, возможно, здесь необязательно задавать border, поскольку для этого уже есть \pset border. Если значение не задано, атрибуты таблицы удаляются.
В формате latex-longtable этот параметр управляет пропорциональной шириной каждого столбца, содержащего тип данных, выровненный по левому краю. Он задается как список значений, разделенных пробелами, например '0.2 0.2 0.6'. Для столбцов вывода, которым не хватает значений, используется последнее из заданных.
title (или C)
Устанавливает заголовок таблицы для любых выводимых впоследствии таблиц. Это можно использовать для задания описательных тегов при создании вывода. Если значение не задано, заголовок удаляется.
tuples_only (или t)
При указании значения допустимы варианты on или off, которые будут включать или выключать режим вывода только кортежей. Если значение опущено, команда переключает режим на противоположный. Обычный вывод включает в себя дополнительную информацию, например заголовки столбцов и различные колонтитулы. В режиме вывода только кортежей отображаются только фактические данные таблицы.
unicode_border_linestyle
Устанавливает стиль отрисовки границы для стиля линий unicode: single (одинарный) или double (двойной).
unicode_column_linestyle
Устанавливает стиль отрисовки столбцов для стиля линий unicode: single (одинарный) или double (двойной).
unicode_header_linestyle
Устанавливает стиль отрисовки заголовка для стиля линий unicode: single (одинарный) или double (двойной).

Иллюстрации того, как могут выглядеть различные форматы, можно увидеть ниже в параграфе Примеры.

Совет
Для некоторых параметров \pset существуют короткие команды. См. \a, \C, \f, \H, \t, \T и \x.

\q или \quit

Завершает программу psql. При использовании в скрипте прекращается только выполнение этого скрипта.

\qecho текст [ ... ]

Эта команда идентична \echo за исключением того, что вывод будет записываться в канал вывода запросов, установленный командой \o.

\r или \reset

Сбрасывает (очищает) буфер запроса.

\s [ имя_файла ]

Вывести историю командной строки psql в файл имя_файла. Если имя_файла опущено, история записывается в стандартный вывод (с использованием программы листания в случае необходимости). Эта команда недоступна, если psql была собрана без поддержки Readline.

\set [ имя [ значение [ ... ] ] ]

Задает для переменной psql с заданным именем указанное значение или, если указано более одного значения, конкатенацию всех этих значений. Если задан только один аргумент, значением переменной становится пустая строка. Для сброса переменной воспользуйтесь командой \unset.
\set без аргументов отображает имена и значения всех установленных на данный момент переменных psql.
В именах переменных допустимы буквы, цифры и знаки подчеркивания. Подробнее см. ниже в параграфе Переменные. Имена переменных чувствительны к регистру.
Некоторые переменные отличаются от остальные тем, что управляют поведением psql или устанавливаются автоматически, отражая состояние соединения. Эти переменные описаны ниже в параграфе Переменные.

Примечание
Эта команда не имеет отношения к команде SQL SET.

\setenv имя [ значение ]

Устанавливает в переменной среды имя заданное значение или, если значение не задано, сбрасывает переменную среды. Пример:

testdb=> \\setenv PAGER less
testdb=> \\setenv LESS -imx4F

\sf[+] описание_функции

Эта команда извлекает и показывает определение именованной функции или процедуры в форме команды CREATE OR REPLACE FUNCTION или CREATE OR REPLACE PROCEDURE. Определение записывается в текущий канал вывода запросов, заданный командой \o.
Целевую функцию можно задать только именем или именем и аргументами, например foo(integer, text). Типы аргументов необходимо задавать, если существует более одной функции с тем же именем.
При добавлении к имени команды + строки вывода нумеруются, при этом первая строка тела функции получит номер 1.
В отличие от большинства других метакоманд, весь остаток строки всегда воспринимается как аргумент(ы) \sf, и в этих аргументах не выполняется ни интерполяция переменных, ни раскрытие обратных кавычек.

\sv[+] имя_представления

Эта команда извлекает и показывает определение именованного представления в форме команды CREATE OR REPLACE VIEW command. Определение записывается в текущий канал вывода запросов, заданный командой \o.
При добавлении к имени команды + строки вывода нумеруются, начиная с 1.
В отличие от большинства других метакоманд, весь остаток строки всегда воспринимается как аргумент(ы) \sv, и в этих аргументах не выполняется ни интерполяция переменных, ни раскрытие обратных кавычек.

\t

Включает/выключает в выводе отображение заголовков с именами столбцов и итоговой строки с количеством записей. Эта команда равнозначна \pset tuples_only и предоставлена для удобства.

\T параметры_таблицы

Задает атрибуты, которые будут помещены в тег table при формате вывода HTML. Эта команда равнозначна \pset tableattr параметры_таблицы.

\timing [ on | off ]

С параметром (в зависимости от него) эта команда включает или выключает отображение времени выполнения каждого оператора SQL. Без параметра она переключает состояние отображения на противоположное. Время отображается в миллисекундах; интервалы больше 1 секунды показываются в формате минуты:секунды, а при необходимости добавляются поля часов и дней.

\unset имя

Сбрасывает (удаляет) переменную psql с заданным именем.
Большинство переменных, управляющих поведением psql, нельзя сбросить, поэтому команда \unset воспринимается для них как установка значений по умолчанию. См. ниже в параграфе Переменные.

\w или \write имя_файла
\w или \write |команда

Записывает буфер текущего запроса в файл имя_файла или передает через поток в команду оболочки команда. Если буфер текущего запроса пуст, вместо этого будет записан последний выполненный запрос.
Если аргумент начинается с |, то весь остаток строки воспринимается как команда, подлежащая выполнению, и в ней не производится ни интерполяция переменных, ни раскрытие обратных кавычек. Этот остаток строки просто передается оболочке в буквальном виде.

\warn текст [ ... ]

Эта команда идентична \echo за исключением того, что вывод будет записываться в канал вывода ошибок psql, а не в канал стандартного вывода.

\watch [ секунды ]

Многократно выполнять текущий запрос в буфере (как делает \g), пока команда не будет прервана или не возникнет ошибка в запросе. Между выполнениями запроса ждать заданное количество секунд (по умолчанию 2). Результат каждого запроса отображается с заголовком, включающим строку \pset title (если она задана), время запуска запроса и интервал задержки.
Если буфер текущего запроса пуст, вместо этого повторно выполняется последний переданный запрос.

\x [ on | off | auto ]

Задает или переключает режим развернутого форматирования таблицы. По сути равнозначна \pset expanded.

\z [ шаблон ]

Выводит список таблиц, представлений и последовательностей с их правами доступа. Если задан шаблон, выводятся только те таблицы, представления и последовательности, имена которых соответствуют этому шаблону.
Это псевдоним для \dp («отобразить права доступа»).

\! [ команда ]

Без аргументов запускает подчиненную оболочку; когда эта оболочка завершается, psql продолжает работу. С аргументом выполняет команду оболочки команда.
В отличие от большинства других метакоманд, весь остаток строки всегда воспринимается как аргумент(ы) \!, и в этих аргументах не выполняется ни интерполяция переменных, ни раскрытие обратных кавычек. Этот остаток строки просто передается оболочке в буквальном виде.

\? [ тема ]

Показывает справочную информацию. Необязательный параметр тема (по умолчанию commands) определяет, описание какой части psql будет показано: commands описывает метакоманды psql; options — параметры командной строки, которые можно передать psql; а variables показывает справку по переменным конфигурации psql.

\;

Точка с запятой после обратного слэша не является метакомандой в том же смысле, что предыдущие; при ее вводе в буфер запросов просто добавляется точка с запятой без дальнейшей обработки.
Обычно psql передает команду SQL серверу, как только доходит до завершающей команду точки с запятой, даже если в текущей строке еще остались данные на ввод. Таким образом, например, ввод

select 1; select 2; select 3;

приведет к тому, что на сервер будут по отдельности переданы три команды SQL, и результат каждой команды будет выведен перед переходом к следующей. Однако если точку с запятой ввести как \;, она не запустит обработку команды, так что команды перед и после этих символов в сущности объединяются и передаются серверу в одном запросе. Так, например, при вводе

select 1\; select 2\; select 3;

три команды SQL передаются серверу в одном запросе по достижении неэкранированной обратным слэшем точки с запятой. Сервер выполняет такую строку как одну транзакцию, если только туда не включены явные команды BEGIN/COMMIT, разделяющие ее на несколько транзакций. (Подробнее о том, как сервер обрабатывает строки с несколькими командами, рассказывается в подразделе Несколько операторов в простом запросе.) psql выводит результат только последнего запроса из всей строки; в этом примере, несмотря на то что определенно выполнялись все три команды SELECT, psql выводит только 3.

Шаблоны

Различные команды \d принимают параметр шаблон для указания имен объектов, которые будут отображены. В простейшем случае шаблон — это просто точное имя объекта. Обычно символы внутри шаблона переводятся в нижний регистр, как в именах SQL; например, \dt FOO отобразит таблицу с именем foo. Как и в именах SQL, заключение шаблона в кавычки предотвращает перевод в нижний регистр. Если нужно включить в шаблон настоящий символ кавычки, он записывается как пара кавычек внутри последовательности в кавычках; опять же, это соответствует правилам для идентификаторов SQL в кавычках. Например \dt "FOO""BAR" отобразит таблицу с именем FOO"BAR (не foo"bar). В отличие от обычных правил для имен SQL, можно взять в кавычки только часть шаблона, например \dt FOO"FOO"BAR отобразит таблицу с именем fooFOObar.

Если шаблон вообще опущен, команды \d отображают все объекты, видимые в текущем пути поиска схем — это равнозначно использованию в качестве шаблона символа *. (Объект считается видимым, если схема, в которой он содержится, находится в пути поиска, и объект того же типа и с тем же именем в пути поиска еще не встречался. Это равнозначно утверждению, что на объект можно ссылаться по имени без явного указания схемы.) Чтобы увидеть все объекты в базе данных, независимо от видимости, используйте в качестве шаблона *.*.

Внутри шаблона * приравнивается к любой последовательности символов (включая отсутствие символов), а ? приравнивается к любому одному символу. (Это обозначение соответствует шаблонам имен файлов в Unix.) Например, \dt int* отображает таблицы, имена которых начинаются с int. Но в кавычках * и ? теряют свое специальное значение и воспринимаются буквально.

Шаблон, содержащий точку (.) интерпретируется как шаблон имени схемы, за которым следует шаблон имени объекта. Например, \dt foo*.*bar* отображает все таблицы, имена которых включают bar, расположенные в схемах, имена которых начинаются с foo. Шаблону, не содержащему точку, соответствуют только объекты, видимые в пути поиска текущей схемы. Опять же, точка в кавычках теряет свое специальное значение и воспринимается буквально.

Продвинутые пользователи могут использовать записи регулярных выражений, таких как классы символов. Например [0-9] соответствует любой цифре. Все специальные символы регулярных выражений работают, как описано в подразделе Регулярные выражения POSIX, за исключением: ., который используется в качестве разделителя, как упоминалось выше, *, который переводится в запись регулярного выражения .*, ?, который переводится в ., и $, который воспринимается буквально. При необходимости эти шаблонные символы можно эмулировать, записав ? для эмуляции ., (R+|) для R* или (R|) для R?. Символ $ не требуется в качестве символа регулярного выражения, поскольку шаблон должен соответствовать имени целиком, в отличие от обычной интерпретации регулярных выражений (другими словами, $ добавляется в шаблон автоматически). Если не хотите, чтобы шаблон закрепился, напишите * в начале и/или в конце. Обратите внимание, что в кавычках все специальные символы регулярных выражений теряют свое специальное значение и воспринимаются буквально. Кроме того, специальные символы регулярных выражений воспринимаются буквально в шаблонах имен операторов (т. е. в аргументе команды \do).

Расширенная функциональность

Переменные

psql предоставляет возможности подстановки переменных, схожие с имеющимися в обычных командных оболочках Unix. Переменные — это просто пары имя/значение, где значением может быть любая строка любой длины. Имя должно состоять из букв (включая нелатинские), цифр и символов подчеркивания.

Чтобы установить переменную, используется метакоманда psql \set. Например,

testdb=> \set foo bar

задает для переменной foo значение bar. Чтобы получить содержимое переменной, нужно поставить перед ее именем двоеточие, например:

testdb=> \echo :foo
bar

Это работает как в обычных командах SQL, так и в метакомандах; более подробно это описывается ниже в параграфе Интерполяция SQL.

При вызове \set без второго аргумента значением переменной становится пустая строка. Для сброса (т. е. удаления) переменной используйте команду \unset. Чтобы показать значения всех переменных, вызовите \set без аргументов.

Примечание
Аргументы \set подчиняются тем же правилам подстановки, что и другие команды. Таким образом, можно конструировать интересные ссылки, такие как \set :foo 'something', и получать «гибкие ссылки» или «переменные переменных» в Perl или PHP соответственно. К сожалению (или к счастью?), с этими конструкциями нельзя сделать ничего полезного. С другой стороны, \set bar :foo является прекрасным способом копирования переменной.

Ряд этих переменных обрабатывается в psql особым образом. Они представляют определенные параметры, которые можно менять во время выполнения путем изменения значения переменной, а в некоторых случаях отражают изменяемое состояние psql. По соглашению имена всех специальных переменных состоят только из заглавных букв ASCII (и, возможно, цифр и символов подчеркивания). В целях максимальной совместимости в будущем не рекомендуется использовать такие имена для собственных переменных.

Переменные, управляющие поведением psql, как правило, нельзя сбросить или задать для них недопустимые значения. Команда \unset допустима, но интерпретируется как установка в переменной значения по умолчанию. Команда \set без второго аргумента интерпретируется как присвоение переменной значения on (включен) для управляющих переменных, принимающих это значение, и не принимается для других. Кроме того, управляющие переменные, принимающие значения on и off (выключен), также примут и другие общепринятые написания логических значений, например true и false.

Специальные переменные:

AUTOCOMMIT
При значении on (по умолчанию), все команды SQL после успешного выполнения автоматически фиксируются. Чтобы отложить фиксацию в этом режиме, необходимо выполнить команду SQL BEGIN или START TRANSACTION. При значении off или сбросе переменной команды SQL не фиксируются, пока явно не выполнена команда COMMIT или END. В режиме выключенной автофиксации неявно выполняется BEGIN непосредственно перед любой командой, кроме команд, уже находящихся в транзакционном блоке, самой команды BEGIN или другой команды управления транзакциями и команды, которая не может выполняться внутри транзакционного блока (например VACUUM).

Примечание
В режиме выключенной автофиксации требуется явно откатывать неуспешные транзакции, выполняя команду ABORT или ROLLBACK. Также имейте в виду, что при выходе из сеанса без фиксации изменений проделанная работа пропадет.

Примечание
Режим включенной автофиксации является традиционным поведением QHB, а режим выключенной автофиксации ближе к спецификации SQL. Если вы предпочитаете выключить режим автофиксации, это можно сделать в общесистемном файле psqlrc или в персональном файле ~/.psqlrc.

COMP_KEYWORD_CASE
Определяет, какой буквенный регистр будет использоваться при автоматическом завершении ключевых слов SQL. Если установлено значение lower или upper, то завершаемое слово будет в нижнем или верхнем регистре соответственно. Если установлено значение preserve-lower или preserve-upper (по умолчанию), то завершаемое слово будет в том же регистре, что и уже введенное начало слова, но последующие слова, завершаемые полностью, будут в нижнем или верхнем регистре соответственно.

DBNAME
Имя базы данных, к которой вы подключены в настоящий момент. Эта переменная устанавливается каждый раз при подключении к базе данных (в том числе при запуске программы), но ее можно изменить или сбросить.

ECHO
Если установлено значение all, все непустые входные строки выдаются в стандартный вывод по мере их прочтения. (Это не относится к строкам, считываемым интерактивно.) Чтобы выбрать это поведение при запуске программы, нужно добавить ключ -a. Если установлено значение queries, psql выдает в стандартный вывод каждый запрос, отправляемый серверу. За выбор этого поведения отвечает ключ -e. Если установлено значение errors, то в стандартном выводе ошибок отображаются только неудавшиеся запросы. За выбор этого поведения отвечает ключ -b. Со значением none (по умолчанию) никакие запросы не отображаются.

ECHO_HIDDEN
Когда для этой переменной установлено значение on и метакоманда обращается к базе данных, сначала показывается текст этого запроса. Эта возможность помогает изучить внутреннее устройство QHB и реализовать похожую функциональность в своих программах. (Чтобы выбрать это поведение при запуске программы, используйте ключ -E.) Если установить для этой переменной значение noexec, запросы будут просто показываться, но не будут отправляться серверу и выполняться. Значение по умолчанию — off.

ENCODING
Текущая кодировка набора символов на стороне клиента. Эта переменная устанавливается всякий раз при подключении к базе данных (в том числе при запуске программы) и при смене кодировки с помощью команды \encoding, но ее можно изменить или сбросить.

ERROR
true в случае ошибки последнего запроса SQL, false в случае его успешного выполнения. См. также SQLSTATE.

FETCH_COUNT
Если в качестве значения этой переменной установлено целое число больше нуля, результаты запросов SELECT извлекаются из базы данных и отображаются группами с заданным количеством строк, в отличие от поведения по умолчанию, когда результирующий набор перед отображением собирается целиком. Таким образом, используется лишь ограниченный объем памяти, независимо от размера результирующего набора. При включении этой функциональности обычно устанавливаются значения от 100 до

Имейте в виду, что при использовании этого функциональности запрос может завершиться ошибкой уже после отображения нескольких строк.

Совет
Хотя с этим функционалом можно использовать любой формат вывода, формат по умолчанию (aligned), как правило, выглядит плохо, потому что каждая группа из FETCH_COUNT строк будет форматироваться отдельно, приводя к разной ширине столбцов в разных группах строк. Другие форматы вывода работают лучше.

HIDE_TABLEAM
Если для этой переменной установлено значение true, информация о методах доступа таблицы не отображается. Это полезно в основном для регрессионных тестов.

HIDE_TOAST_COMPRESSION
Если для этой переменной установлено значение true, информация о методах сжатия столбцов не отображается. Это полезно в основном для регрессионных тестов.

HISTCONTROL
Если для этой переменной установлено значение ignorespace, строки, начинающиеся с пробела, не добавляются в историю. Если установлено значение ignoredups, в историю не добавляются строки, соответствующие тем, которые в ней уже есть. Значение ignoreboth объединяет эти два варианта. Если установлено значение none (по умолчанию), все строки, считываемые в интерактивном режиме, сохраняются в списке истории.

Примечание
Эта функциональность была списана с Bash.

HISTFILE
Имя файла, который будет использоваться для сохранения истории. При сбросе этой переменной имя файла берется из переменной среды PSQL_HISTORY. Если и эта переменная не установлена, имя по умолчанию — ~/.psql_history. Например, если в ~/.psqlrc записать:

\set HISTFILE ~/.psql_history-:DBNAME

psql будет вести отдельный файл истории для каждой базы данных.

Примечание
Эта функциональность была списана с Bash.

HISTSIZE
Максимальное количество команд, которые будут сохраняться в истории команд (по умолчанию 500). Если установлено отрицательное значение, ограничение не накладывается.

Примечание
Эта функциональность была списана с Bash.

HOST
Имя хоста, где работает сервер баз данных, к которому вы подключены в настоящий момент. Эта переменная устанавливается всякий раз при подключении к базе данных (включая запуск программы), но ее можно изменить или сбросить.

IGNOREEOF
Если установлено значение 1 или меньше, передача символа конца файла (обычно вводится Ctrl+D) интерактивному сеансу psql завершит работу приложения. Если установлено большее числовое значение, оно определяет, сколько последовательных символов конца файла нужно ввести, чтобы завершить интерактивный сеанс. Если для переменной установлено значение, отличное от числового, оно воспринимается как 10. Значение по умолчанию — 0.

Примечание
Эта функциональность была списана с Bash.

LASTOID
Значение последнего обработанного OID, возвращенного командой INSERT или \lo_import. Эта переменная будет гарантированно иметь корректное значение лишь до тех пор, пока не будет отображен результат следующей команды SQL. Серверы QHB последней версии больше не поддерживают системные столбцы OID, поэтому при обращении к таким серверам после INSERT значение LASTOID всегда будет равно 0.

LAST_ERROR_MESSAGE
LAST_ERROR_SQLSTATE
Основное сообщение об ошибке и связанный код SQLSTATE для последнего неудавшегося запроса в текущем сеансе psql или пустая строка и 00000, если в текущем сеансе не происходили ошибки.

ON_ERROR_ROLLBACK
Когда установлено значение on, если оператор в блоке транзакции выдает ошибку, эта ошибка игнорируется, и транзакция продолжается. Когда установлено значение interactive, такие ошибки игнорируются только в интерактивных сеансах, но не при чтении файлов скриптов. Когда установлено значение off (по умолчанию), оператор в блоке транзакции, выдающий ошибку, прерывает всю транзакцию. В режиме отката транзакции при ошибке непосредственно перед каждой командой в блоке транзакции неявно выполняется команда SAVEPOINT, и в случае неудачного завершения команды происходит откат к этой точке сохранения.

ON_ERROR_STOP
По умолчанию после возникновения ошибки обработка команд продолжается. Когда для этой переменной установлено значение on, обработка команд будет немедленно прекращена. В интерактивном режиме psql вернется в командную строку; иначе psql завершит работу, вернув код ошибки 3, чтобы отличить этот случай от состояний критической ошибки, о которых сообщается с помощью кода ошибки 1. В любом случае выполнение всех запущенных в настоящий момент скриптов (высокоуровневого скрипта и любых других, которые он мог запустить) будет немедленно прекращено. Если высокоуровневая командная строка содержит несколько команд SQL, выполнение остановится на текущей команде.

PORT
Порт сервера баз данных, к которому вы подключены в настоящий момент. Эта переменная устанавливается всякий раз при подключении к базе данных (включая запуск программы), но ее можно изменить или сбросить.

PROMPT1
PROMPT2
PROMPT3
Эти переменные определяют, как должны выглядеть приглашения psql. См. ниже в параграфе Настройка приглашений.

QUIET
Установка для этой переменной значения on равнозначна параметру командной строки -q. Вероятно, она не слишком полезна в интерактивном режиме.

ROW_COUNT
Количество строк, возвращенных или обработанных последним запросом SQL, или 0, если запрос завершился с ошибкой или не выдал количество строк.

SERVER_VERSION_NAME
SERVER_VERSION_NUM
Номер версии сервера в виде строки, например 9.6.2, 1.5 или 11beta1, и в числовом виде, например 90602 или 100001. Эта переменная устанавливается всякий раз при подключении к базе данных (включая запуск программы), но ее можно изменить или сбросить.

SHOW_CONTEXT
Для этой переменной можно установить значения never (никогда), errors (ошибки) или always (всегда), управляющие тем, будут ли в сообщениях с сервера отображаться поля CONTEXT. По умолчанию установлено значение errors (то есть контекст будет выводиться в сообщениях об ошибках, но не в замечаниях или предупреждениях). Этот параметр не действует, когда в VERBOSITY установлен уровень terse или sqlstate. (Если вам нужна подробная версия только что полученной ошибки, см. также описание команды \errverbose.)

SINGLELINE
Установка для этой переменной значения on равнозначна параметру командной строки -S.

SINGLESTEP
Установка для этой переменной значения on равнозначна параметру командной строки -s.

SQLSTATE
Код ошибки (см. раздел Приложения Коды ошибок QHB), связанной с неудачным выполнением последнего запроса SQL, или 00000, если тот завершился успешно.

USER
Пользователь базы данных, который подключен в настоящий момент. Эта переменная устанавливается всякий раз при подключении к базе данных (включая запуск программы), но ее можно изменить или сбросить.

VERBOSITY
Для этой переменной можно установить значения default, verbose, terse или sqlstate для управления уровнем детализации в сообщениях об ошибках. (Если вам нужна подробная версия только что полученной ошибки, см. также описание команды \errverbose.)

VERSION
VERSION_NAME
VERSION_NUM
Эти переменные устанавливаются при запуске программы и отражают версию psql в виде развернутой строки, краткой строки (например 9.6.2, 1.5 или 11beta1) и числа (например 90602 или 100001) соответственно. Их можно изменить или сбросить.

Интерполяция SQL

Ключевой особенностью переменных psql является возможность подставлять («интерполировать») их в обычные операторы SQL, а также в аргументы метакоманд. Помимо этого psql предоставляет средства для обеспечения корректного применения кавычек для значений переменных, используемых как литералы и идентификаторы SQL. Чтобы интерполировать значение без кавычек, необходимо добавить перед именем переменной двоеточие (:). Например,

testdb=> \set foo 'my_table'
testdb=> SELECT * FROM :foo;

будет запрашивать таблицу my_table. Обратите внимание, что это может быть небезопасно: значение переменной копируется буквально, поэтому может содержать непарные кавычки или даже метакоманды. При его применении следует убедиться, что это имеет смысл.

Когда значение предназначено к использованию в качестве литерала или идентификатора SQL, безопаснее всего заключить его в кавычки. Для заключения в кавычки значения переменной, используемого как литерал SQL, необходимо после двоеточия написать имя переменной в апострофах. Для заключения в кавычки значения переменной, используемого как идентификатор SQL, необходимо после двоеточия написать имя переменной в кавычках. Эти конструкции корректно работают с кавычками и другими специальными символами, содержащимися в значении переменной. Предыдущий пример безопаснее было бы записать так:

testdb=> \set foo 'my_table'
testdb=> SELECT * FROM :"foo";

Интерполяция переменных не будет выполняться в литералах и идентификаторах SQL, заключенных в кавычки. Поэтому такая конструкция, как ':foo', не приведет к превращению значения переменной во взятый в кавычки литерал (и если бы это работало, это было бы небезопасно, поскольку не получилось бы корректно обработать кавычки внутри значения переменной).

Один из примеров использования этого механизма — копирование содержимого файла в столбец таблицы. Сперва загрузим файл в переменную, а затем интерполируем значение переменной как строку в кавычках:

testdb=> \set content `cat my_file.txt`
testdb=> INSERT INTO my_table VALUES (:'content');

(Обратите внимание, что это все равно не будет работать, если my_file.txt содержит байты NUL. psql не поддерживает байты NUL в значениях переменных.)

Поскольку двоеточие вполне законно может присутствовать в командах SQL, явная попытка интерполяции (например, для :name, :'name' или :"name") не выполняется, если именованная переменная в настоящий момент не установлена. В любом случае можно экранировать двоеточие с помощью обратного слэша, чтобы защитить его от подстановки.

Специальный синтаксис :{?имя} возвращает TRUE или FALSE в зависимости от того, существует ли такая переменная, и поэтому всегда подменяется значением, если только двоеточие не экранировано обратным слэшем.

Синтаксис с двоеточием для переменных является стандартом SQL для встраиваемых языков запросов, таких как ECPG. Синтаксисы с двоеточием для срезов массивов и приведения типов являются расширениями QHB, которые иногда могут конфликтовать со стандартным использованием. Синтаксис с двоеточием и кавычками для экранирования значения переменной при подстановке в качестве литерала или идентификатора SQL является расширением psql.

Настройка приглашений

Приглашения, выдаваемые psql, можно настроить по своему вкусу. Три переменные PROMPT1, PROMPT2 и PROMPT3 содержат строки и специальные управляющие последовательности, описывающие внешний вид приглашения. Приглашение 1 (PROMPT1) — это обычное приглашение, которое выдается, когда psql запрашивает ввод новой команды. Приглашение 2 (PROMPT2) выдается, когда при вводе команды ожидаются дополнительные данные, например, потому что команда не была завершена точкой с запятой или не закрыты кавычки. Приглашение 3 (PROMPT3) выдается при выполнении команды SQL COPY FROM STDIN, когда в терминале нужно ввести значение новой строки.

Значение выбранных переменных приглашений выводится буквально, за исключением случаев, когда в нем фигурирует знак процента (%). В зависимости от следующего символа будет подставляться определенный текст. Описаны следующие подстановки:

%M
Полное имя хоста (с именем домена) сервера баз данных, или [local], если подключение выполнено через сокет домена Unix, или [local:/каталог/имя], если при компиляции было изменено расположение сокета домена Unix по умолчанию.

%m
Имя хоста сервера баз данных, усеченное до первой точки, или [local], если подключение выполнено через сокет домена Unix.

%>
Номер порта, который прослушивает сервер баз данных.

%n
Имя пользователя базы данных в текущем сеансе. (Это значение может меняться в течение сеанса в результате выполнения команды SET SESSION AUTHORIZATION.)

%/
Имя текущей базы данных.

%~
Похоже на %/, но выводит ~ (тильду), если текущая база данных является базой данных по умолчанию.

%#
Если пользователь сеанса является суперпользователем базы данных, то выводит #, иначе >. (Это значение может меняться в течение сеанса в результате выполнения команды SET SESSION AUTHORIZATION.)

%p
PID обслуживающего процесса для текущего подключения.

%R
В приглашении 1 это обычно =, но будет @, если сеанс находится в неактивной ветви блока условия, либо ^ в однострочном режиме, либо !, если сеанс не подключен к базе данных (что может произойти, если \connect завершилась неудачно). В приглашении 2 %R заменяется символом, который зависит от того, почему psql ожидает ввод дополнительных строк: -, если команда просто еще не была завершена; *, если есть незавершенный комментарий /* ... */; апостроф, если не завершена строка в апострофах; кавычки, если не завершен идентификатор в кавычках; знак доллара, если не завершена стока в долларах, или (, если не закрыты скобки. В приглашении 3 %R не выдает ничего.

%x
Состояние транзакции: пустая строка, когда она не в блоке транзакции; *, когда в блоке транзакции; !, когда она в блоке транзакции, в котором произошла ошибка; ?, когда состояние транзакции не определено (например, потому что отсутствует подключение).

%l
Номер строки в текущем операторе, начиная с 1.

%цифры
Подставляется символ с указанным восьмеричным кодом.

%:имя:
Значение переменной psql с заданным именем. Подробную информацию см. выше в подразделе Переменные.

%`команда`
Вывод команды; схоже с обычной подстановкой с обратными апострофами.

%[ ... %]
Приглашения могут содержать символы управления терминалом, которые, например, меняют цвет, фон и стиль текста приглашения или изменяют заголовок окна терминала. Для того чтобы возможности редактирования строк Readline работали как следует, эти невыводимые управляющие символы нужно сделать невидимыми, расположив их между %[ и %]. В приглашении может находиться несколько таких включений. Например:

testdb=> \set PROMPT1 '%[%033[1;33;40m%]%n@%/%R%[%033[0m%]%# '

сделает жирное (1;), желтое на черном фоне (33;40) приглашение для VT100-совместимых цветных терминалов.

%w
Пробелы той же ширины, что и в последнем выведенном приглашении PROMPT1. Это можно использовать при установке PROMPT2, чтобы многострочные операторы были выровнены по первой строке, но при этом вторичного приглашения не было видно.

Чтобы вставить знак процента, напишите %%. По умолчанию для приглашений 1 и 2 используется значение '%/%R%x%# ', а для приглашения 3 — '>> '.

Примечание
Эта функциональность была взята из tcsh.

Редактирование командной строки

psql поддерживает библиотеку Readline для удобного редактирования и извлечения командной строки. История команд автоматически сохраняется при выходе из psql и загружается при ее запуске. Кроме того, поддерживается завершение клавишей Tab, хотя логика завершения не претендует на роль анализатора SQL. Кроме того, запросы, генерируемые завершением по Tab, могут создавать помехи для других команд SQL, например SET TRANSACTION ISOLATION LEVEL. Если по какой-то причине вам не нравится завершение по Tab, его можно выключить, записав в файле .inputrc в вашем домашнем каталоге следующее:

$if psql
set disable-completion on
$endif

(Это функциональность не psql, а Readline. Дополнительную информацию см. в документации к Readline.)

Переменные среды

COLUMNS
Если \pset columns равна нулю, управляет шириной формата вывода wrapped, а также шириной, определяющей, требуется ли использовать в широком выводе программу листания или нужно переключиться в вертикальный формат, в режиме expanded auto.

PGDATABASE
PGHOST
PGPORT
PGUSER
Параметры подключения по умолчанию (см. раздел Переменные среды).

PG_COLOR
Указывает, использовать ли цвет в диагностических сообщениях. Возможные значения: always (всегда), auto (автоматически) и never (никогда).

PSQL_EDITOR
EDITOR
VISUAL
Редактор, используемый командами \e, \ef и \ev. Эти переменные проверяются в вышеуказанном порядке; применяется первая установленная переменная. Если ни одна из них не установлена, по умолчанию в системах Unix используется vi.

PSQL_EDITOR_LINENUMBER_ARG
Когда команда \e, \ef или \ev используется с аргументом номера строки, эта переменная задает аргумент командной строки, применяемый для передачи начального номера строки в редактор пользователя. Для таких редакторов, как Emacs или vi, это знак плюс. Добавьте в конец значения переменной пробел, если он требуется для разделения имени параметра и номера строки. Примеры:

PSQL_EDITOR_LINENUMBER_ARG='+'
PSQL_EDITOR_LINENUMBER_ARG='--line '

Значением по умолчанию является + в системах Unix (соответствует редактору по умолчанию vi и полезно для многих других распространенных редакторов).

PSQL_HISTORY
Альтернативное расположение файла истории команд. Выполняется добавление тильды (~).

PSQL_PAGER
PAGER
Если результаты запросов не помещаются на экране, они пропускаются через эту команду. Обычные значения это more или less. Использование программы листания можно выключить, присвоив переменной PSQL_PAGER или PAGER пустую строку или изменив связанные с этой программой параметры в команде \pset. Эти переменные проверяются в вышеуказанном порядке применяется первая установленная переменная. Если ни одна из них не установлена, на большинстве платформ по умолчанию используется more, а на Cygwin — less.

PSQLRC
Альтернативное расположение пользовательского файла .psqlrc. Выполняется добавление тильды (~).

SHELL
Команда оболочки, выполняемая командой \!.

TMPDIR
Каталог для хранения временных файлов. По умолчанию /tmp.

Кроме того, эта утилита, как и большинство других утилит QHB, использует переменные среды, поддерживаемые libpq (см. раздел Переменные среды).

Файлы

psqlrc и ~/.psqlrc

При запуске без параметра -X psql пытается считать и выполнить команды из общесистемного файла запуска (psqlrc), а затем из пользовательского файла запуска (~/.psqlrc) после подключения к базе данных, но до получения обычных команд. Эти файлы можно использовать для настройки клиента и/или сервера по своему вкусу, обычно с помощью команд \set и SET.

Общесистемный файл запуска называется psqlrc и ищется в каталоге установки «конфигурация системы», который надежнее всего определяется с помощью команды pg_config --sysconfdir. По умолчанию этот каталог будет расположен в ../etc/ относительно каталога, содержащего исполняемые файлы QHB. Имя этого каталога можно задать явно через переменную среды PGSYSCONFDIR.

Персональный файл запуска называется .psqlrc и ищется в домашнем каталоге вызывающего пользователя. Расположение пользовательского файла запуска можно задать явно через переменную среды PSQLRC.

Как общесистемный, так и персональный файлы запуска можно привязать к конкретной версии psql, добавив к имени файла старший или младший номер релиза QHB, например, ~/.psqlrc-1.2 или ~/.psqlrc-1.5.1. При наличии нескольких файлов будет прочитан файл с наиболее детальным номером версии.

.psql_history

История командной строки хранится в файле ~/.psql_history.

Расположение файла истории можно задать явно через переменную psql HISTFILE или через переменную среды PSQL_HISTORY.

Примечания

psql лучше всего работает с серверами той же или более старой основной версии. Сбой метакоманд наиболее вероятен, если версия сервера новее версии самой psql. Общая функциональность выполнения команд SQL и отображение результатов запросов должны работать на серверах с более новой основной версией, но это не гарантируется во всех случаях.

Если вы хотите использовать psql для подключения к нескольким серверам с различными основными версиями, рекомендуется использовать последнюю версию psql. Как вариант, можно держать под рукой копии psql от каждой основной версии и использовать ту, которая соответствует версии сервера. Но на практике в этих дополнительных сложностях нет необходимости.

Примеры

Первый пример показывает, как распределить команду на несколько строк ввода. Обратите внимание на изменение приглашения:

testdb=> CREATE TABLE my_table (
testdb(>  first integer not null default 0,
testdb(>  second text)
testdb-> ;
CREATE TABLE

Теперь снова посмотрим на определение таблицы:

testdb=> \d my_table
              Table "public.my_table"
 Column |  Type   | Collation | Nullable | Default
--------+---------+-----------+----------+---------
 first  | integer |           | not null | 0
 second | text    |           |          |

Теперь изменим приглашение на что-нибудь более интересное:

testdb=> \set PROMPT1 '%n@%m %~%R%# '
peter@localhost testdb=>

Предположим, что вы внесли данные в таблицу и хотите на них посмотреть:

peter@localhost testdb=> SELECT * FROM my_table;
 first | second
-------+--------
     1 | один
     2 | два
     3 | три
     4 | четыре
(4 rows)

Таблицу можно вывести разными способами с помощью команды \pset:

peter@localhost testdb=> \pset border 2
Установлен стиль границ 2.
peter@localhost testdb=> SELECT * FROM my_table;
+-------+--------+
| first | second |
+-------+--------+
|     1 | один   |
|     2 | два    |
|     3 | три    |
|     4 | четыре |
+-------+--------+
(4 rows)

peter@localhost testdb=> \pset border 0
Установлен стиль границ 0.
peter@localhost testdb=> SELECT * FROM my_table;
first second
----- ------
    1 один
    2 два
    3 три
    4 четыре
(4 rows)

peter@localhost testdb=> \pset border 1
Установлен стиль границ 1.
peter@localhost testdb=> \pset format csv
Формат вывода: csv.
peter@localhost testdb=> \pset tuples_only
Режим вывода только кортежей включен.
peter@localhost testdb=> SELECT second, first FROM my_table;
один,1
два,2
три,3
четыре,4
peter@localhost testdb=> \pset format unaligned
Формат вывода: unaligned.
peter@localhost testdb=> \pset fieldsep '\t'
Разделитель полей: "    ".
peter@localhost testdb=> SELECT second, first FROM my_table;
один      1
два       2
три       3
четыре    4

Либо можно использовать короткие команды:

peter@localhost testdb=> \a \t \x
Формат вывода: aligned.
Режим вывода только кортежей выключен.
Расширенный вывод включен.
peter@localhost testdb=> SELECT * FROM my_table;
-[ RECORD 1 ]-
first  | 1
second | один
-[ RECORD 2 ]-
first  | 2
second | два
-[ RECORD 3 ]-
first  | 3
second | три
-[ RECORD 4 ]-
first  | 4
second | четыре

Кроме того, эти параметры формата вывода можно задать только для одного запроса, используя команду \g:

peter@localhost testdb=> SELECT * FROM my_table
peter@localhost testdb-> \g (format=aligned tuples_only=off expanded=on)
-[ RECORD 1 ]-
first  | 1
second | один
-[ RECORD 2 ]-
first  | 2
second | два
-[ RECORD 3 ]-
first  | 3
second | три
-[ RECORD 4 ]-
first  | 4
second | четыре

Вот пример использования команды \df для нахождения только тех функций, имя которых соответствует шаблону int*pl, а второй аргумент имеет тип bigint:

testdb=> \df int*pl * bigint
                          List of functions
   Schema   |  Name   | Result data type | Argument data types | Type
------------+---------+------------------+---------------------+------
 pg_catalog | int28pl | bigint           | smallint, bigint    | func
 pg_catalog | int48pl | bigint           | integer, bigint     | func
 pg_catalog | int8pl  | bigint           | bigint, bigint      | func
(3 rows)

Когда это уместно, результаты запросов можно показать в виде перекрестной таблицы с помощью команды \crosstabview:

testdb=> SELECT first, second, first > 2 AS gt2 FROM my_table;
 first | second | gt2
-------+--------+-----
     1 | один   | f
     2 | два    | f
     3 | три    | t
     4 | четыре | t
(4 rows)

testdb=> \crosstabview first second
 first | один | два | три | четыре
-------+------+-----+-----+--------
     1 | f    |     |     |
     2 |      | f   |     |
     3 |      |     | t   |
     4 |      |     |     | t
(4 rows)

Второй пример показывает таблицу умножения со строками, отсортированными в обратном числовом порядке, и столбцами, отсортированными независимо, в порядке возрастания числовых значений.

testdb=> SELECT t1.first as "A", t2.first+100 AS "B", t1.first*(t2.first+100) as "AxB",
testdb(> row_number() over(order by t2.first) AS ord
testdb(> FROM my_table t1 CROSS JOIN my_table t2 ORDER BY 1 DESC
testdb(> \crosstabview "A" "B" "AxB" ord
 A | 101 | 102 | 103 | 104
---+-----+-----+-----+-----
 4 | 404 | 408 | 412 | 416
 3 | 303 | 306 | 309 | 312
 2 | 202 | 204 | 206 | 208
 1 | 101 | 102 | 103 | 104
(4 rows)