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

Устанавливает параметры запроса для следующего выполнения запроса, с указанными параметрами, переданными для любых заполнителей параметров ($1 и т.д.).

Пример:

INSERT INTO tbl1 VALUES ($1, $2) \bind 'first value' 'second value' \g

Это также работает для команд выполнения запросов, кроме \g, таких как \gx и \gset.

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

Устанавливает новое соединение с сервером Tantor SE. Параметры соединения можно указать либо с использованием позиционного синтаксиса (один или несколько из имени базы данных, пользователя, хоста и порта), либо с использованием строки соединения conninfo, подробно описанной в разделе Раздел 32.1.1. Если аргументы не указаны, создается новое соединение с использованием тех же параметров, что и ранее.

Спецификация любого из параметров dbname, username, host или port как - эквивалентна опусканию этого параметра.

Соединение может повторно использовать параметры соединения из предыдущего соединения; не только имя базы данных, пользователя, хоста и порт, но и другие настройки, такие как sslmode. По умолчанию параметры повторно используются в позиционном синтаксисе, но не при указании строки conninfo. Передача первого аргумента -reuse-previous=on или -reuse-previous=off переопределяет это поведение по умолчанию. Если параметры повторно используются, то любой параметр, не явно указанный как позиционный параметр или в строке conninfo, берется из параметров существующего соединения. Исключение составляет то, что если параметр host изменяется относительно предыдущего значения с использованием позиционного синтаксиса, то любой параметр hostaddr, присутствующий в параметрах существующего соединения, будет удален. Кроме того, пароль, используемый для существующего соединения, будет повторно использоваться только если не изменены настройки пользователя, хоста и порта. Когда команда не указывает и не повторно использует определенный параметр, используется значение по умолчанию 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    -- changes only sslmode
=> \c postgresql://tom@localhost/mydb?application_name=myapp

Устанавливает заголовок для таблиц, выводимых в результате запроса, или сбрасывает такой заголовок. Эта команда эквивалентна \pset title title. (Название этой команды происходит от “caption”, так как ранее она использовалась только для установки заголовка в таблице HTML).

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

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

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

Когда указывается program, command выполняется с помощью psql, и данные, передаваемые из или к command, маршрутизируются между сервером и клиентом. Опять же, привилегии выполнения принадлежат локальному пользователю, а не серверу, и не требуются привилегии SQL суперпользователя.

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

Синтаксис этой команды аналогичен синтаксису команды SQL COPY. Все опции, кроме источника/приемника данных, указываются так же, как и для команды COPY. Из-за этого для метакоманды \copy применяются специальные правила разбора. В отличие от большинства других метакоманд, весь оставшийся фрагмент строки всегда считается аргументами \copy, и в аргументах не выполняется интерполяция переменных или раскрытие обратных кавычек.

Показывает условия авторского права и распространения Tantor SE.

Выполняет текущий буфер запросов (как \g) и показывает результаты в виде кросс-таблицы. Запрос должен возвращать как минимум три столбца. Выходной столбец, идентифицированный как colV, становится вертикальным заголовком, а выходной столбец, идентифицированный как colH, становится горизонтальным заголовком. colD идентифицирует выходной столбец для отображения в сетке. sortcolH идентифицирует необязательный столбец сортировки для горизонтального заголовка.

Каждая спецификация столбца может быть номером столбца (начиная с 1) или именем столбца. Применяются обычные правила преобразования регистра и кавычек для имен столбцов. Если не указано, colV принимается как столбец 1, а colH - как столбец 2. colH должен отличаться от colV. Если colD не указан, то в результате запроса должно быть ровно три столбца, и столбец, который не является ни colV, ни colH, считается colD.

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

Горизонтальный заголовок, отображаемый в качестве первой строки, содержит значения, найденные в столбце colH, с удаленными дубликатами. По умолчанию они отображаются в том же порядке, что и в результатах запроса. Но если задан необязательный аргумент sortcolH, он определяет столбец, значения которого должны быть целыми числами, и значения из colH будут отображаться в горизонтальном заголовке, отсортированные в соответствии с соответствующими значениями sortcolH.

Внутри сетки crosstab, для каждого отдельного значения x из colH и каждого отдельного значения y из colV, ячейка, расположенная на пересечении (x,y), содержит значение столбца colD в строке результата запроса, для которой значение colH равно x, а значение colV равно y. Если такой строки нет, ячейка пуста. Если есть несколько таких строк, выводится ошибка.

Для каждого отношения (таблицы, представления, материализованного представления, индекса, последовательности или внешней таблицы) или составного типа, соответствующего заданному шаблону pattern, показываются все столбцы, их типы, табличное пространство (если не является пространством по умолчанию) и любые специальные атрибуты, такие как NOT NULL или значения по умолчанию. Также показываются связанные индексы, ограничения, правила и триггеры. Для внешних таблиц также показывается связанный внешний сервер. (Соответствие шаблону определено в разделе Patterns ниже).

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

Форма команды \d+ идентична, за исключением того, что отображается больше информации: показываются любые комментарии, связанные с колонками таблицы, наличие OID в таблице, определение представления, если отношение является представлением, нестандартная настройка идентификации реплики и имя метода доступа, если у отношения есть метод доступа.

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

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

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

Списки классов операторов (см. Раздел 36.15.1). Если указан параметр access-method-pattern, перечисляются только классы операторов, связанные с методами доступа, имена которых соответствуют этому шаблону. Если указан параметр input-type-pattern, перечисляются только классы операторов, связанные с типами ввода, имена которых соответствуют этому шаблону. Если к имени команды добавлен символ +, каждый класс операторов перечисляется вместе с его связанной семьей операторов и владельцем.

Списки семейств операторов (см. Раздел 36.15.5). Если указан параметр access-method-pattern, перечисляются только семейства операторов, связанные с методами доступа, имена которых соответствуют этому шаблону. Если указан параметр input-type-pattern, перечисляются только семейства операторов, связанные с типами ввода, имена которых соответствуют этому шаблону. Если к имени команды добавлен символ +, каждое семейство операторов перечисляется вместе с его владельцем.

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

Списки содержат функции, связанные с семействами операторов (см. Раздел 36.15.3). Если указан параметр access-method-pattern, перечисляются только функции семейств операторов, связанных с методами доступа, имена которых соответствуют этому шаблону. Если указан параметр operator-family-pattern, перечисляются только функции семейств операторов, имена которых соответствуют этому шаблону. Если к имени команды добавлен символ +, функции отображаются подробно, с указанием их фактических списков параметров.

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

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

Список параметров конфигурации сервера и их значений. Если указан pattern, выводятся только параметры, имена которых соответствуют шаблону. Если pattern не указан, выводятся только параметры, установленные в нестандартные значения. (Используйте \dconfig *, чтобы увидеть все параметры). Если к имени команды добавлен символ +, каждый параметр выводится со своим типом данных, контекстом, в котором можно установить параметр, и правами доступа (если были предоставлены нестандартные права доступа).

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

Показывает описания объектов типа constraint, operator class, operator family, rule и trigger. Все остальные комментарии могут быть просмотрены с помощью соответствующих обратных слэш-команд для этих типов объектов.

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

Описания для объектов могут быть созданы с помощью команды COMMENT SQL.

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

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

Команда ALTER DEFAULT PRIVILEGES используется для установки привилегий доступа по умолчанию. Значение отображения привилегий объясняется в Раздел 5.7.

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

Список внешних серверов (мнемоника: “внешние серверы”). Если указан параметр pattern, перечисляются только те серверы, имена которых соответствуют шаблону. Если используется форма \des+, отображается полное описание каждого сервера, включая его права доступа, тип, версию, опции и описание.

Список внешних таблиц (мнемоника: “внешние таблицы”). Если указан шаблон, перечисляются только записи, в которых имя таблицы или схемы соответствует шаблону. Если используется форма \det+, также отображаются общие параметры и описание внешней таблицы.

Список отображений пользователей (мнемоника: “внешние пользователи”). Если указан параметр pattern, перечисляются только те отображения, имена пользователей которых соответствуют шаблону. Если используется форма \deu+, показывается дополнительная информация о каждом отображении.

Список внешних оберток (мнемоника: “внешние обертки”). Если указан pattern, перечисляются только те внешние обертки, имя которых соответствует шаблону. Если используется форма \dew+, также показываются права доступа, параметры и описание внешней обертки.

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

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

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

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

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

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

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

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

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

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

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

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

Команды GRANT и REVOKE используются для установки привилегий доступа. Значение отображения привилегий объясняется в Раздел 5.7.

Списки секционированных отношений. Если указан pattern, то перечисляются только записи, имя которых соответствует шаблону. Модификаторы t (таблицы) и i (индексы) могут быть добавлены к команде для фильтрации типа отношений, которые нужно перечислить. По умолчанию перечисляются секционированные таблицы и индексы.

Если используется модификатор n (“nested”), или указан шаблон, то включаются не корневые секционированные отношения, и отображается столбец, показывающий родительское отношение каждого секционированного отношения.

Если к имени команды добавлен символ +, то будет отображаться сумма размеров каждой разделенной связи, а также описание связи. Если символ n объединен с символом +, то будут показаны два размера: один, включающий общий размер непосредственно присоединенных листовых секций, и другой, показывающий общий размер всех секций, включая косвенно присоединенные подсекции.

Список настроек конфигурации. Эти настройки могут быть специфичными для роли, специфичными для базы данных или и тем, и другим. role-pattern и database-pattern используются для выбора конкретных ролей и баз данных для перечисления, соответственно. Если они не указаны или указан символ *, перечисляются все настройки, включая те, которые не являются специфичными для роли или базы данных, соответственно.

С помощью команд ALTER ROLE и ALTER DATABASE можно определить настройки конфигурации для каждой роли и базы данных.

Перечисляет информацию о каждом предоставленном членстве в роли, включая назначенные опции (ADMIN, INHERIT и/или SET) и праводателя. См. команду GRANT для получения информации о членствах в ролях.

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

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

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

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

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

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

Списки расширенной статистики. Если указан параметр pattern, выводятся только те расширенные статистики, имена которых соответствуют указанному шаблону.

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

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

Если указан параметр filename, то файл редактируется; после выхода из редактора содержимое файла копируется в текущий буфер запроса. Если параметр filename не указан, то текущий буфер запроса копируется во временный файл, который затем редактируется таким же образом. Или, если текущий буфер запроса пуст, то последний выполненный запрос копируется во временный файл и редактируется таким же образом.

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

Обработка буфера как одной строки в основном влияет на мета-команды: все, что находится в буфере после мета-команды, будет воспринято как аргумент(ы) для мета-команды, даже если оно занимает несколько строк. (Таким образом, нельзя создавать сценарии, использующие мета-команды, таким образом. Для этого используйте \i).

Если указан номер строки, psql разместит курсор на указанной строке файла или буфера запросов. Обратите внимание, что если указано только число, psql предполагает, что это номер строки, а не имя файла.

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

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

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

Эта команда извлекает и редактирует определение именованной функции или процедуры, в форме команды CREATE OR REPLACE FUNCTION или CREATE OR REPLACE PROCEDURE. Редактирование выполняется так же, как и для \edit. Если вы выйдете из редактора без сохранения, оператор будет отменен. Если вы сохраните и выйдете из редактора, обновленная команда будет немедленно выполнена, если вы добавили к ней точку с запятой. В противном случае она будет отображена снова; введите точку с запятой или \g для отправки ее или \r для отмены.

Целевая функция может быть указана только по имени или по имени и аргументам, например foo(integer, text). Типы аргументов должны быть указаны, если существует более одной функции с одним и тем же именем.

Если не указана функция, предлагается пустой шаблон CREATE FUNCTION для редактирования.

Если указан номер строки, psql разместит курсор на указанной строке тела функции. (Обратите внимание, что тело функции обычно не начинается с первой строки файла).

В отличие от большинства других мета-команд, весь оставшийся текст в строке всегда считается аргументом(ами) команды \ef, и ни переменная интерполяция, ни раскрытие обратных кавычек не выполняются в аргументах.

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

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

Эта команда извлекает и редактирует определение именованного представления, в виде команды CREATE OR REPLACE VIEW. Редактирование выполняется так же, как и для \edit. Если вы выйдете из редактора без сохранения, оператор будет отменен. Если вы сохраните и выйдете из редактора, обновленная команда будет немедленно выполнена, если вы добавили к ней точку с запятой. В противном случае она будет отображена снова; введите точку с запятой или \g для отправки ее, или \r для отмены.

Если не указано представление, предлагается пустой шаблон CREATE VIEW для редактирования.

Если указан номер строки, psql разместит курсор на указанной строке определения представления.

В отличие от большинства других мета-команд, весь оставшийся текст на строке всегда считается аргументом(ами) команды \ev, и ни переменная интерполяция, ни раскрытие обратных кавычек не выполняются в аргументах.

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

Отправляет текущий буфер запроса на сервер для выполнения.

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

Если задан аргумент filename или |command, то вывод запроса записывается в указанный файл или передается в указанную команду оболочки, вместо обычного отображения. Файл или команда записываются только в случае успешного выполнения запроса и возврата нуля или более кортежей, а не в случае ошибки запроса или выполнения SQL-команды, не возвращающей данные.

Если текущий буфер запросов пуст, то вместо этого повторно выполняется последний отправленный запрос. За исключением этого поведения, \g без аргументов фактически эквивалентен точке с запятой. С аргументами \g предоставляет альтернативу “одноразовой” команде \o и, кроме того, позволяет одноразово настраивать параметры форматирования вывода, обычно устанавливаемые с помощью \pset.

Когда последний аргумент начинается с тега |, весь оставшийся текст до конца строки считается командой для выполнения, и в ней не выполняется ни интерполяция переменных, ни раскрытие обратных кавычек. Остаток строки передается в оболочку буквально.

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

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

Получает значение переменной окружения env_var и присваивает его переменной psql с именем psql_var. Если переменная env_var не определена в окружении процесса psql, переменная psql_var не изменяется. Пример:

=> \getenv home HOME
=> \echo :home
/home/postgres

Отправляет текущий буфер запроса на сервер, а затем выполняет каждый столбец каждой строки вывода запроса (если таковые имеются) как 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. (Часто рекомендуется установить значение ECHO на all или queries при использовании \gexec). ведение журнала запросов, режим пошагового выполнения, время выполнения и другие функции выполнения запросов также применяются к каждому генерируемому запросу.

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

Отправляет текущий буфер запросов на сервер и сохраняет вывод запроса в переменные psql (см. ниже Variables). Запрос, который будет выполнен, должен вернуть ровно одну строку. Каждый столбец строки сохраняется в отдельную переменную с тем же именем, что и столбец. Например:

=> 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 эквивалентно \g, за исключением того, что оно принудительно включает режим расширенного вывода для этого запроса, как если бы expanded=on был включен в список опций \pset. См. также \x.

Дает справку о синтаксисе указанной команды SQL. Если не указана команда command, то psql перечислит все команды, для которых доступна справка о синтаксисе. Если command является звездочкой (*), то будет показана справка о синтаксисе всех команд SQL.

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

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

Читает входные данные из файла filename и выполняет их так, как если бы они были введены с клавиатуры.

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

Эта группа команд реализует вложенные условные блоки. Условный блок должен начинаться с \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.

Выражения, которые не правильно вычисляются как true или false, будут генерировать предупреждение и рассматриваться как false.

Пропускаются строки, которые обрабатываются нормально для идентификации запросов и обратных команд с обратным слэшем, но запросы не отправляются на сервер, и игнорируются обратные команды, отличные от условных (\if, \elif, \else, \endif). Условные команды проверяются только на правильное вложение. Ссылки на переменные в прне указанных строках не расширяются, и также не выполняется расширение обратных кавычек.

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

Вот пример:

-- check for the existence of two separate records in the database and store
-- the results in separate psql variables
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 похожа на \i, но разрешает относительные имена файлов по-разному. При выполнении в интерактивном режиме эти две команды ведут себя одинаково. Однако, когда они вызываются из скрипта, \ir интерпретирует имена файлов относительно каталога, в котором находится скрипт, а не текущего рабочего каталога.

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

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

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

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

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

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

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

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

Организует сохранение будущих результатов запроса в файл filename или перенаправление будущих результатов в команду оболочки команда. Если аргумент не указан, вывод запроса сбрасывается на стандартный вывод.

Если аргумент начинается с |, то весь оставшийся текст в строке считается командой command для выполнения, и в ней не выполняется ни интерполяция переменных, ни раскрытие обратных кавычек. Остаток строки передается в оболочку буквально.

“Результаты запроса” включают все таблицы, ответы команды и уведомления, полученные от сервера базы данных, а также вывод различных команд с обратной косой чертой, которые запрашивают базу данных (например, \d); но не сообщения об ошибках.

Распечатать текущий буфер запроса в стандартный вывод. Если текущий буфер запроса пуст, будет напечатан вместо него последний выполненный запрос.

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

Запрашивает у пользователя ввод текста, который присваивается переменной name. Можно указать необязательную строку приглашения text. (Для многословных приглашений заключите текст в апострофы).

По умолчанию, команда \prompt использует терминал для ввода и вывода. Однако, если был использован параметр командной строки -f, \prompt использует стандартный ввод и стандартный вывод.

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

\pset без аргументов отображает текущий статус всех параметров печати.

Настройки печати можно настроить следующим образом:

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

Завершает программу psql. В скриптовом файле просто прекращается выполнение этого скрипта.

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

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

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

Устанавливает переменную psql с именем name в значение value, или если указано несколько значений, в значение, полученное путем их конкатенации. Если указан только один аргумент, переменная устанавливается в пустое строковое значение. Чтобы сбросить переменную, используйте команду \unset.

\set без аргументов отображает имена и значения всех текущих установленных переменных psql.

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

Определенные переменные являются особыми, поскольку они управляют поведением psql или автоматически устанавливаются для отражения состояния подключения. Эти переменные описаны в разделе Variables, ниже.

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

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

Эта команда извлекает и показывает определение именованной функции или процедуры в виде команды CREATE OR REPLACE FUNCTION или CREATE OR REPLACE PROCEDURE. Определение выводится в текущий канал вывода запроса, установленный с помощью \o.

Целевая функция может быть указана только по имени или по имени и аргументам, например foo(integer, text). Типы аргументов должны быть указаны, если существует более одной функции с одним и тем же именем.

Если к имени команды добавлен символ +, то выводимые строки нумеруются, начиная с первой строки тела функции, которая будет являться первой строкой.

В отличие от большинства других мета-команд, весь оставшийся текст на строке всегда считается аргументом(ами) команды \sf, и ни переменная интерполяция, ни раскрытие обратных кавычек не выполняются в аргументах.

Эта команда извлекает и показывает определение именованного представления в виде команды CREATE OR REPLACE VIEW. Определение выводится в текущий канал вывода запроса, установленный с помощью \o.

Если к имени команды добавить +, то выводимые строки будут пронумерованы, начиная с 1.

В отличие от большинства других мета-команд, весь оставшийся текст на строке всегда считается аргументом(ами) команды \sv, и ни интерполяция переменных, ни раскрытие обратных кавычек не выполняются в аргументах.

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

Указывает атрибуты, которые должны быть размещены внутри table тег в HTML формат вывода. Эта команда эквивалентна \pset tableattr table_options.

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

Снимает (удаляет) переменную psql с именем name.

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

Записывает текущий буфер запроса в файл filename или передает его в команду оболочки команда. Если текущий буфер запроса пуст, то вместо него будет записан последний выполненный запрос.

Если аргумент начинается с |, то весь оставшийся текст в строке считается командой command для выполнения, и в ней не выполняется ни интерполяция переменных, ни раскрытие обратных кавычек. Остаток строки передается в оболочку буквально.

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

Повторно выполняйте текущий буфер запросов (как делает \g) до прерывания, сбоя запроса или достижения лимита количества выполнений (если указан). Ожидайте указанное количество секунд (по умолчанию 2) между выполнениями. Для обратной совместимости seconds можно указывать с префиксом interval= или без него. Каждый результат запроса отображается с заголовком, который включает строку \pset title (если есть), время начала запроса и интервал задержки.

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

Устанавливает или переключает режим форматирования таблицы с расширенным выводом. Таким образом, это эквивалентно \pset expanded.

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

Это псевдоним для команды \dp (“отображение привилегий”).

Без аргумента, переходит в подоболочку; psql возобновляется, когда подоболочка завершается. С аргументом выполняет команду оболочки command.

В отличие от большинства других мета-команд, весь оставшийся текст на строке всегда считается аргументом(ами) \!, и ни интерполяция переменных, ни раскрытие обратных кавычек не выполняются в аргументах. Оставшаяся часть строки просто передается буквально оболочке.

Показывает информацию справки. Опциональный параметр topic (по умолчанию 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, включенных для разделения ее на несколько транзакций. (См. Раздел 53.2.2.1 для получения более подробной информации о том, как сервер обрабатывает множественные запросы).