Postgresql rollback if error

I’m writing a script for PostgreSQL and since I want it to be executed atomically, I’m wrapping it inside a transaction.
I expected the script to look something like this:

BEGIN
-- 1) Execute some valid actions;
-- 2) Execute some action that causes an error.
EXCEPTION
    WHEN OTHERS THEN
        ROLLBACK;
END; -- A.k.a. COMMIT;

However, in this case pgAdmin warns me about a syntax error right after the initial BEGIN. If I terminate the command there by appending a semicolon like so: BEGIN; it instead informs me about error near EXCEPTION.
I realize that perhaps I’m mixing up syntax for control structures and transactions, however I couldn’t find any mention of how to roll back a failed transaction in the docs (nor in SO for that matter).

I also considered that perhaps the transaction is rolled back automatically on error, but it doesn’t seem to be the case since the following script:

BEGIN;
-- 1) Execute some valid actions;
-- 2) Execute some action that causes an error.
COMMIT;

warns me that: ERROR: current transaction is aborted, commands ignored until end of transaction block and I have to then manually ROLLBACK; the transaction.

It seems I’m missing something fundamental here, but what?

EDIT:
I tried using DO as well like so:

DO $$
BEGIN
-- 1) Execute some valid actions;
-- 2) Execute some action that causes an error.
EXCEPTION
    WHEN OTHERS THEN
        ROLLBACK;
END; $$

pgAdmin hits me back with a: ERROR: cannot begin/end transactions in PL/pgSQL. HINT: Use a BEGIN block with an EXCEPTION clause instead. which confuses me to no end, because that is exactly what I am (I think) doing.

POST-ACCEPT EDIT:
Regarding Laurenz’s comment: «Your SQL script would contain a COMMIT. That ends the transaction and rolls it back.» — this is not the behavior that I observe. Please consider the following example (which is just a concrete version of an example I already provided in my original question):

BEGIN;

-- Just a simple, self-referencing table.
CREATE TABLE "Dummy" (
    "Id" INT GENERATED ALWAYS AS IDENTITY,
    "ParentId" INT NULL,
    CONSTRAINT "PK_Dummy" PRIMARY KEY ("Id"),
    CONSTRAINT "FK_Dummy_Dummy" FOREIGN KEY ("ParentId") REFERENCES "Dummy" ("Id")
);

-- Foreign key violation terminates the transaction.
INSERT INTO "Dummy" ("ParentId")
VALUES (99);

COMMIT;

When I execute the script above, I’m greeted with: ERROR: insert or update on table "Dummy" violates foreign key constraint "FK_Dummy_Dummy". DETAIL: Key (ParentId)=(99) is not present in table "Dummy". which is as expected.
However, if I then try to check whether my Dummy table was created or rolled back like so:

SELECT EXISTS (
    SELECT FROM information_schema."tables"
    WHERE "table_name" = 'Dummy');

instead of a simple false, I get the same error that I already mentioned twice: ERROR: current transaction is aborted, commands ignored until end of transaction block. Then I have to manually terminate the transaction via issuing ROLLBACK;.

So to me it seems that either the comment mentioned above is false or at least I’m heavily misinterpreting something here.

An Explained psqlrc

Let’s walk through my short psqlrc(5) to see what I’ve set, and to inspire you to find your own configuration that fits into your workflow. Here is my complete psqlrc:

PostgreSQL’s shell, psql(1), can be configured using set and pset . pset is for changing the output format — HTML , pager, field separator, and so on — while set is for everything else.

ON_ERROR_ROLLBACK

The ON_ERROR_ROLLBACK settings affects how psql(1) handles errors. The default value is off .

When this setting is on , errors are effectively ignored at all times. So if you have this script, slint.sql :

And run it from the command line:

You would end up with a members table with Brian McMahan but without David Pajo .

When it is set to off , the default, then you get nothing: no members table and no Brian McMahan . It either all works or it doesn’t, just like a transaction should.

There is a third value: interactive . Under interactive , the above command in which statements are piped into psql(1) non-interactively is treated like off , but if you type them into the interactive prompt it is treated like on . This gives you a chance to fix things without starting over:

COMP_KEYWORD_CASE

Possibly the greatest feature of any shell is tab completion, and psql(1) doesn’t disappoint. However, there’s a question of which case it should use to complete keywords.

The straight-forward thing to do is to set it to lower or upper .

But even fancier are preserve-lower and preserve-upper , with preserve-upper as the default. These preserve whatever case you were using, falling back to lower (or upper). For example:

There, up was completed to update and S was completed to SET , preserving the case as the user typed it; n was completed to name , preserving the case of the object in the database; and the space after order was completed to BY , favoring uppercase when the user has typed nothing.

HISTFILE

Like any good shell, psql(1) will save the commands you have entered so you can run them again (it’s full Readline; try a ^R some time). By default it stores the history in

/.psql_history , but we can do better than that.

To start, let’s introduce another psql(1) command: echo

The variable :DBNAME is automatically set to the name of the database and available to all psql(1) commands. There are other pre-set variables like :PORT , :HOST , :USER , :ENCODING , and so on, but we’re going to use :DBNAME to start.

It just so happens that psql(1) will concatenate strings for you, so if you want different history for each database (the queries against the desserts table won’t make sense in the zoology database, for example), you can set that up:

You can combine these as much as you please, such as:

The pager is the program that paginates text. The classic is more(1), and the improvement is less(1). Puns.

The default value for the pager setting is on which — unlike the name suggests — only uses the pager sometimes. A few lines are shown without a pager, but 25 or more lines invoke pagination. (Specifically, if the text would scroll off the screen, it invokes the pager.)

To always have a pager, use the value always . To never use the pager — useful inside a terminal multiplexer or terminal emulator with good scrolling — use the value off .

You can also change the pager itself by setting the PAGER environment variable. For example:

This will use gvim(1) as your pager.

By default NULL values show as blank spaces. Also by default the empty string shows as a blank space.

To better distinguish NULL values from empty strings, you can have psql(1) show anything you want instead:

And more

You can find all of this and more in the psql(1) manpage or in the official PostgreSQL Web documentation. We have also written previously on this topic.

As you read the documentation we’d love to see your favorite settings as pull requests against the .psqlrc in our dotfiles.

If you enjoyed this post, you might also like:

Upgrade your codebase with a Code Audit

Learn how we can help you understand the current state of your code quality, speed up delivery times, improve developer happiness, and level up your user experience

© 2023 thoughtbot, inc. The design of a robot and thoughtbot are registered trademarks of thoughtbot, inc. Privacy Policy

Источник

Our Blog

Ongoing observations by End Point Dev people

Postgres ON_ERROR_ROLLBACK explained

Way back in 2005 I added the ON_ERROR_ROLLBACK feature to psql, the Postgres command line client. When enabled, any errors cause an immediate rollback to just before the previous command. What this means is that you can stay inside your transaction, even if you make a typo (the main error-causing problem and the reason I wrote it!). Since I sometimes see people wanting to emulate this feature in their application or driver, I thought I would explain exactly how it works in psql.

First, it must be understood that this is not a Postgres feature, and there is no way you can instruct Postgres itself to ignore errors inside of a transaction. The work must be done by a client (such as psql) that can do some voodoo behind the scenes. The ON_ERROR_ROLLBACK feature is available since psql version 8.1.

Normally, any error you make will throw an exception and cause your current transaction to be marked as aborted. This is sane and expected behavior, but it can be very, very annoying if it happens when you are in the middle of a large transaction and mistype something! At that point, the only thing you can do is rollback the transaction and lose all of your work. For example:

When ON_ERROR_ROLLBACK is enabled, psql will issue a SAVEPOINT before every command you send to Postgres. If an error is detected, it will then issue a ROLLBACK TO the previous savepoint, which basically rewinds history to the point in time just before you issued the command. Which then gives you a chance to re-enter the command without the mistake. If an error was not detected, psql does a RELEASE savepoint behind the scenes, as there is no longer any reason to keep the savepoint around. So our example above becomes:

What about if you create a savepoint yourself? Or even a savepoint with the same name as the one that psql uses internally? Not a problem—​Postgres allows multiple savepoints with the same name, and will rollback or release the latest one created, which allows ON_ERROR_ROLLBACK to work seamlessly with user-provided savepoints.

Note that the example above sets ON_ERROR_ROLLBACK (yes it is case sensitive!) to ‘interactive’, not just ‘on’. This is a good idea, as you generally want it to catch human errors, and not just plow through a SQL script.

So, if you want to add this to your own application, you will need to wrap each command in a hidden savepoint, and then rollback or release it. The end-user should not see the SAVEPOINT, ROLLBACK TO, or RELEASE commands. Thus, the SQL sent to the backend will change from this:

Источник

Postgresql rollback on error

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

Описание

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

Параметры

Отправляет в стандартный вывод все непустые входные строки по мере их чтения. (Это не относится к строкам, считанным в интерактивном режиме.) Эквивалентно установке переменной ECHO в значение all . -A
—no-align

Переключение на невыровненный режим вывода. (По умолчанию, наоборот, используется выровненный режим вывода.) Равнозначно команде pset format unaligned . -b
—echo-errors

Выводит все команды SQL с ошибками в стандартный канал ошибок. Равнозначно присваиванию переменной ECHO значения errors . -c команда
—command= команда

Передаёт psql команду для выполнения. Этот ключ можно повторять и комбинировать в любом порядке с ключом -f . Когда указывается -c или -f , psql не читает команды со стандартного ввода; вместо этого она завершается сразу после обработки всех ключей -c и -f по порядку.

Заданная команда должна быть либо командной строкой, которая полностью интерпретируется сервером (т. е. не использует специфические функции psql ), либо одиночной командой с обратной косой чертой. Таким образом, используя -c , нельзя смешивать метакоманды SQL и psql . Но это можно сделать, передав несколько ключей -c или передав строку в psql через канал:

Из-за такого поведения указание нескольких команд в одной строке -c часто приводит к неожиданным результатам. Поэтому лучше использовать несколько ключей -c или подавать команды на стандартный ввод psql , применяя либо echo , как показано выше, либо создаваемый прямо в оболочке документ, например: -d имя_бд
—dbname= имя_бд

Указывает имя базы данных для подключения. Равнозначно указанию имя_бд в первом аргументе, не являющемся ключом, в командной строке. Вместо имени может задаваться строка подключения. В этом случае параметры в строке подключения переопределяют одноимённые параметры, заданные в командной строке. -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

Выводит список всех доступных баз данных и завершает работу. Другие параметры, не связанные с соединением, игнорируются. Это похоже на метакоманду list .

Когда используется этот аргумент, psql будет подключаться к базе данных postgres , если только в командной строке не задана другая база данных (в параметре -d или не через параметры, а, например, через запись службы, но не через переменную окружения). -L имя_файла
—log-file= имя_файла

В дополнение к обычному выводу, записывает вывод результатов всех запросов в файл имя_файла . -n
—no-readline

Отключает использование Readline для редактирования командной строки и использования истории команд. Может быть полезно для выключения расширенных действий клавиши табуляции при вырезании и вставке. -o имя_файла
—output= имя_файла

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

Указывает TCP-порт или расширение файла локального Unix-сокета, через который сервер принимает подключения. Значение по умолчанию определяется переменной среды PGPORT , если она установлена, либо числом, заданным при компиляции, обычно 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 или pset tuples_only . -T параметры_таблицы
—table-attr= параметры_таблицы

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

Выполняет присваивание значения переменной, как метакоманда set . Обратите внимание, что необходимо разделить имя переменной и значение (при наличии) знаком равенства в командной строке. Чтобы сбросить переменную, оставьте имя переменной без знака равенства. Чтобы установить пустое значение, добавьте знак равенства, но опустите значение. Эти присваивания выполняются во время обработки командной строки, так что переменные, отражающие состояние соединения, будут перезаписаны позже. -V
—version

Выводит версию psql и завершает работу. -w
—no-password

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

Обратите внимание, что этот параметр действует на протяжении всей сессии и, таким образом, влияет на метакоманду connect , так же как и на первую попытку соединения. -W
—password

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

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

Обратите внимание, что этот параметр действует на протяжении всей сессии и, таким образом, влияет на метакоманду connect , так же как и на первую попытку соединения. -x
—expanded

Включает режим развёрнутого вывода таблицы. Равнозначно команде x или pset expanded . -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 это клиент для Postgres Pro . Для подключения к базе данных нужно знать имя базы данных, имя сервера, номер порта сервера и имя пользователя, под которым вы хотите подключиться. Эти свойства можно задать через аргументы командной строки, а именно -d , -h , -p и -U соответственно. Если в командной строке есть аргумент, который не относится к параметрам psql , то он используется в качестве имени базы данных (или имени пользователя, если база данных уже задана). Задавать все эти аргументы необязательно, у них есть разумные значения по умолчанию. Если опустить имя сервера, psql будет подключаться через Unix-сокет к локальному серверу, либо подключаться к localhost по TCP/IP в системах, не поддерживающих UNIX-сокеты. Номер порта по умолчанию определяется во время компиляции. Поскольку сервер базы данных использует то же значение по умолчанию, чаще всего указывать номер порта не нужно. Имя пользователя по умолчанию, как и имя базы данных по умолчанию, совпадает с именем пользователя в операционной системе. Заметьте, что просто так подключаться к любой базе данных под любым именем пользователя вы не сможете. Узнать о ваших правах можно у администратора баз данных.

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

/.pgpass , чтобы не вводить пароли снова и снова. За дополнительными сведениями обратитесь к Разделу 31.15.

Этот способ также позволяет использовать LDAP для получения параметров подключения, как описано в Разделе 31.17. Более полно все имеющиеся параметры соединения описаны в Подразделе 31.1.2.

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

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

Ввод SQL-команд

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

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

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

Комментарии в стиле C передаются для обработки на сервер, в то время как комментарии в стандарте SQL psql удаляет перед отправкой.

Метакоманды

Всё, что вводится в psql не взятое в кавычки и начинающееся с обратной косой черты, является метакомандой psql и обрабатывается самим psql . Эти команды делают psql полезным для задач администрирования и разработки скриптов.

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

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

Если внутри аргумента не в кавычках встречается имя переменной psql с предшествующим двоеточием ( : ), оно заменяется значением переменной, как описано в Интерполяция SQL . Также будет работать описанная ниже форма :’ имя_переменной ‘ и :» имя_переменной » .

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

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

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

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

Если текущий режим вывода таблицы невыровненный, то он переключается на выровненный режим. Если текущий режим выровненный, то устанавливается невыровненный. Эта команда поддерживается для обратной совместимости. См. pset для более общего решения. c или connect [ -reuse-previous= on|off ] [ имя_бд [ имя_пользователя ] [ компьютер ] [ порт ] | строка_подключения ]

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

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

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

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

Примеры: C [ заголовок ]

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

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

Подсказка

для печати текущего рабочего каталога используйте ! pwd .

Выводит информацию о текущем подключении к базе данных. copy < таблица [ ( список_столбцов ) ] | ( запрос ) > < from | to > < ‘имя_файла’ | program ‘команда’ | stdin | stdout | pstdin | pstdout > [ [ with ] ( параметр [, . ] ) ]

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

С указанием program psql выполняет команду и данные, поступающие из/в неё, передаются между сервером и клиентом. Это опять же означает, что для выполнения программ используются привилегии локального пользователя, а не сервера, и не требуются привилегии суперпользователя SQL.

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

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

Подсказка

Подсказка

Показывает информацию об авторских правах и условиях распространения Postgres Pro . crosstabview [ столбВ [ столбГ [ столбТ [ столбсортГ ] ] ] ]

Выполняет содержимое буфера текущего запроса (как g ) и показывает результат в виде перекрёстной таблицы. Заданный запрос должен возвращать минимум три столбца. Столбец результата, заданный параметром столбВ , будет образовывать вертикальные заголовки, а столбец, заданный параметром столбГ , — горизонтальные. Заданный параметром столбТ столбец будет поставлять данные для отображения внутри таблицы. Столбец, выбранный параметром столбсортГ , будет необязательным столбцом сортировки горизонтальных заголовков.

Каждое указание столбца может представлять собой имя или номер столбца (начиная с 1). К именам применяются обычные принятые в SQL правила учёта регистра и кавычек. По умолчанию в качестве столбВ подразумевается столбец 1, а в качестве столбГ — столбец 2. Если столбВ и столбГ задаются явно, они должны различаться. Если столбТ не задан, в результате запроса должно быть ровно три столбца, и в качестве столбТ выбирается столбец, отличный от столбВ и столбГ .

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

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

Внутри перекрёстной таблицы для каждого уникального значения x в столбГ и каждого уникального значения y в столбВ , ячейка, размещённая на пересечении (x,y) содержит значение столбТ в строке результата запроса, в которой значение столбГ равно x , а значение столбВ — y . Если такой строки не находится, ячейка остаётся пустой. Если же находится несколько таких строк, выдаётся ошибка. d[S+] [ шаблон ]

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

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

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

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

Примечание

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

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

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

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

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

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

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

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

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

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

Права доступа по умолчанию устанавливаются командой ALTER DEFAULT PRIVILEGES . Смысл отображаемых прав объясняется в описании GRANT . 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+ также может отображать имя и пароль удалённого пользователя, поэтому следует позаботиться о том, чтобы не раскрывать их.

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

Выводит список функций с типами данных их результатов, аргументов и классификацией: « agg » (агрегатная), « normal » (обычная), « trigger » (триггерная) или « window » (оконная). Чтобы получить функции только определённого вида (видов), добавьте в команду соответствующие буквы a , n , 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 . При добавлении + к команде для каждого объекта дополнительно будет выводиться описание, при наличии. Обратите внимание, что отображаются только правила сортировки, применимые к кодировке текущей базы данных, поэтому результат команды может отличаться для различных баз данных этой же установки PostgreSQL . dp [ шаблон ]

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

Для установки прав доступа используются команды GRANT и REVOKE . Смысл отображаемых прав объясняется в описании GRANT . drds [ шаблон-ролей [ шаблон-баз ] ]

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

Команды ALTER ROLE и ALTER DATABASE используются для определения параметров конфигурации, специфичных для роли или базы данных. dRp[+] [ шаблон ]

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

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

Выводит список типов данных. Если указан шаблон , выводятся только те типы, имена которых соответствуют ему. При добавлении + к команде для каждого типа данных дополнительно будет выводиться: внутреннее имя типа, размер, допустимые значения для типа enum и права доступа. По умолчанию показываются только объекты, созданные пользователями. Для включения системных объектов нужно задать шаблон или добавить модификатор S . du[S+] [ шаблон ]

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

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

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

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

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

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

Подсказка

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

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

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

Подсказка

Если используется команда o для перенаправления вывода запросов, возможно, следует применять команду qecho вместо этой.

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

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

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

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

В отличие от большинства других метакоманд весь остаток строки всегда воспринимается как аргументы ef , и в этих аргументах не выполняется ни подстановка переменных, ни раскрытие обратных кавычек.

Подсказка

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

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

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

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

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

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

В отличие от большинства других метакоманд весь остаток строки всегда воспринимается как аргументы ev , и в этих аргументах не выполняется ни подстановка переменных, ни раскрытие обратных кавычек. f [ строка ]

Устанавливает разделитель полей для невыровненного режима вывода запросов. По умолчанию используется вертикальная черта ( | ). Равнозначно команде pset fieldsep . g [ имя_файла ]
g [ | команда ]

Отправляет содержимое буфера текущего запроса на сервер для выполнения. Если передаётся аргумент, вывод запроса записывается в указанный файл или передаётся через поток заданной команде оболочки, а не отображается как обычно. Вывод направляется в файл или команду, только если запрос успешно вернул 0 или более строк, но не когда запрос завершился неудачно или выполнялась команда, не возвращающая данные.

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

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

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

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

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

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

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

Если значение столбца NULL, то вместо присваивания значения соответствующая переменная удаляется.

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

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

Метакоманда gx подобна g , но принудительно включает расширенный режим вывода для текущего запроса. См. x . h или help [ команда ]

В отличие от большинства других метакоманд весь остаток строки всегда воспринимается как аргументы help , и в этих аргументах не выполняется ни подстановка переменных, ни раскрытие обратных кавычек.

Примечание

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

Читает ввод из файла имя_файла и выполняет его, как будто он был набран на клавиатуре.

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

Примечание

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

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

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

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

Например: ir или include_relative имя_файла

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

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

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

Подсказка

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

Сохраняет файл в большом объекте Postgres Pro . При этом с объектом может быть связан указанный комментарий. Пример:

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

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

Показывает список всех больших объектов Postgres Pro , хранящихся в базе данных, вместе с предоставленными комментариями. lo_unlink oid_БО

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

Подсказка

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

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

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

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

Подсказка

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

Печатает содержимое буфера текущего запроса в стандартный вывод. Если этот буфер пуст, будет напечатан последний выполненный запрос. password [ имя_пользователя ]

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

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

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

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

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

Имеются следующие параметры:

Устанавливает максимальную ширину для формата wrapped , а также ограничение по ширине, свыше которого будет требоваться постраничник или произойдёт переключение в вертикальное отображение при режиме expanded auto . При значении 0 (по умолчанию) максимальная ширина управляется переменной среды COLUMNS или шириной экрана, если COLUMNS не установлена. Кроме того, если columns равно нулю, то формат wrapped влияет только на вывод на экран. Если columns не равно 0, то это также влияет на вывод в файл или в другую команду через канал. expanded (или x )

Указанное значение допускает варианты on или off , которые включают или отключают развёрнутый режим, либо auto . Если значение опущено, команда включает/отключает режим. Когда развёрнутый режим включён, результаты запроса выводятся в две колонки: имя столбца в левой, данные в правой. Этот режим полезен, если данные не помещаются на экране в обычном « горизонтальном » режиме. При выборе auto развёрнутый режим используется, когда результат запроса содержит несколько столбцов и по ширине не умещается на экране; в противном случае используется обычный режим. Режим auto распространяется только на форматы aligned и wrapped . С другими форматами он всегда равнозначен отключённому состоянию. fieldsep

Устанавливает разделитель полей для невыровненного режима вывода запросов. Таким образом, можно формировать вывод, в котором значения будут разделены табуляцией или запятыми. Это может быть предпочтительным для использования в других программах. Для установки символа табуляции в качестве разделителя полей введите pset fieldsep ‘t’ . По умолчанию используется вертикальная черта ( ‘|’ ). fieldsep_zero

Устанавливает разделитель полей для невыровненного режима вывода в нулевой байт. footer

Возможны два варианта значения : on или off , которые включают или отключают вывод результирующей строки с количеством выбранных записей ( n строк) . Если значение не указано, то команда переключает текущее значение в on или off . format

Устанавливает один из следующих форматов вывода: unaligned , aligned , wrapped , html , asciidoc , latex (использует tabular ), latex-longtable или troff-ms . Допускается сокращение слова до уникального значения.

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

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

Формат wrapped похож на aligned , но переносит длинные значения столбцов на новые строки, чтобы общий вывод поместился в заданную ширину. Задание ширины вывода описано в параметре columns . Обратите внимание, что psql не будет пытаться переносить на новые строки заголовки столбцов. Поэтому формат wrapped работает так же, как aligned если общая ширина, требуемая для всех заголовков столбцов, превышает установленную максимальную ширину.

Форматы html , asciidoc , latex , latex-longtable и troff-ms выводят таблицы, которые предназначены для включения в документы с помощью соответствующего языка разметки. Они не являются полноценными документами! Это может быть не критично для HTML , но для LaTeX обязателен документ-контейнер. Формат latex-longtable также требует наличия пакетов LaTeX longtable и booktabs . linestyle

Задаёт стиль отрисовки линий границы: ascii , old-ascii или unicode . Допускается сокращение слова до уникального значения. (Это значит, что одной буквы будет достаточно.) Значение по умолчанию: ascii . Этот параметр действует только в форматах aligned и wrapped .

Стиль unicode использует символы Юникода для рисования линий. Символы новой строки в данных показываются с использованием символа возврата каретки в правом поле. Когда при формате wrapped происходит перенос данных на новую строку (без символа новой строки), ставится символ многоточия в правом поле первой строки и в левом поле следующей строки.

Когда значение border больше нуля, параметр linestyle также определяет символы, которыми будут рисоваться границы. Обычные символы ASCII работают везде, но символы Юникода смотрятся лучше на терминалах, распознающих их. null

Устанавливает строку, которая будет напечатана вместо значения null. По умолчанию не печатается ничего, что можно ошибочно принять за пустую строку. Например, можно было бы предпочесть pset null ‘(null)’ . numericlocale

Если задаётся значение , возможны два варианта: on или off , которые включают или отключают отображение специфичного для локали символа, разделяющего группы цифр левее десятичной точки. Если значение не указано, то команда переключает вывод чисел с локализованного на обычный и обратно. pager

Управляет использованием постраничника для просмотра результатов запросов и справочной информации psql . Если переменная среды PAGER установлена, то данные передаются в указанную программу. В противном случае используется платформозависимая программа по умолчанию (например, more ).

Если pager имеет значение off , программа постраничного просмотра (постраничник) не используется. Если pager имеет значение on , эта программа используется при необходимости, т. е. когда вывод на терминал не помещается на экране. Параметр pager также может иметь значение always , при этом постраничник будет использоваться всегда, независимо от того, помещается вывод на экран терминала или нет. Команда pset pager без указания значения переключает варианты on и off . pager_min_lines

Если в pager_min_lines задаётся число, превышающее высоту страницы, программа постраничного вывода не будет вызываться, пока не наберётся заданное число строк для вывода. Значение по умолчанию — 0. recordsep

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

Устанавливает разделитель записей для невыровненного режима вывода в нулевой байт. tableattr (или T )

В формате 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 .

Выход из psql . При использовании в скрипте прекращается только выполнение этого скрипта. qecho текст [ . ]

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

Сбрасывает (очищает) буфер запроса. s [ имя_файла ]

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

Задаёт для переменной psql имя указанное значение или, если указано несколько значений, все эти значения, соединённые вместе. Если присутствует только один аргумент, значением переменной становится пустая строка. Для сброса переменной используйте команду unset .

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

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

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

Примечание

Эта команда не имеет отношения к SQL -команде SET .

Задаёт для переменной среды имя значение или, если значение не задано, удаляет переменную среды. Пример: sf[+] описание_функции

Извлекает из базы данных и выводит определение заданной функции в форме команды CREATE OR REPLACE FUNCTION . Определение печатается в текущий канал вывода запросов, установленный o .

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

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

В отличие от большинства других метакоманд весь остаток строки всегда воспринимается как аргументы sf , и в этих аргументах не выполняется ни подстановка переменных, ни раскрытие обратных кавычек. sv[+] имя_представления

Извлекает из базы данных и выводит определение указанного представления в форме команды CREATE OR REPLACE VIEW . Определение выводится в текущий канал вывода запросов, установленный o .

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

В отличие от большинства других метакоманд весь остаток строки всегда воспринимается как аргументы sv , и в этих аргументах не выполняется ни подстановка переменных, ни раскрытие обратных кавычек. t

Включает/выключает отображение имён столбцов и результирующей строки с количеством выбранных записей для запросов. Эта команда эквивалентна pset tuples_only и предоставлена для удобства. T параметры_таблицы

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

Удаляет psql переменную имя .

Большинство переменных, управляющих поведением psql , нельзя сбросить; команда unset для них воспринимается как установка значений по умолчанию. См. раздел Переменные ниже. w или write имя_файла
w или write | команда

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

Если аргумент начинается с | , весь остаток строки воспринимается как команда , подлежащая выполнению, в которой не производится ни подстановка переменных, ни раскрытие обратных кавычек. Это продолжение строки просто передаётся оболочке в буквальном виде. watch [ секунды ]

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

Если буфер текущего запроса пуст, будет повторно выполнен последний переданный запрос. x [ on | off | auto ]

Устанавливает или переключает режим развёрнутого вывода таблицы. Это эквивалентно pset expanded . z [ шаблон ]

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

Это псевдоним для dp ( « показать права доступа » ). ! [ команда ]

Без аргументов запускает подчинённую оболочку; когда эта оболочка завершается, psql продолжает работу. Если добавлен аргумент, запускает команду оболочки команда .

В отличие от большинства других метакоманд весь остаток строки всегда воспринимается как аргументы ! , и в этих аргументах не выполняется ни подстановка переменных, ни раскрытие обратных кавычек. Этот текст просто передаётся оболочке в буквальном виде. ? [ тема ]

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

Шаблоны поиска

Различные 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] соответствует любой цифре. Все специальные символы регулярных выражений работают как описано в Подразделе 9.7.3, за исключением: . используется в качестве разделителя, как говорилось выше; * соответствует регулярному выражению .* ; ? соответствует . , а также символ $ , который не имеет специального значения. При необходимости эти символы можно эмулировать указывая ? для эмуляции . , ( R +|) для R * , ( R |) для R ? . $ не требуется, как символ регулярного выражения, потому что шаблон должен соответствовать имени целиком, в отличие от обычной интерпретации регулярных выражений (другими словами, $ автоматически добавляется в шаблон). Используйте * в начале и/или в конце, если не хотите, чтобы шаблон закреплялся. Обратите внимание, что внутри двойных кавычек, все специальные символы регулярных выражений теряют своё специальное значение и соответствуют сами себе. Также, специальные символы регулярных выражений не действуют в шаблонах для имён операторов (т. е. в аргументе команды do ).

Расширенные возможности

Переменные

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

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

присваивает переменной 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 .

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

Примечание

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

Примечание

Включённый режим autocommit является традиционным для Postgres Pro , а выключенный режим ближе к спецификации SQL. Если вы предпочитаете отключить режим autocommit , это можно сделать в общесистемном файле psqlrc или в персональном файле

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

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

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

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

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

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

Подсказка

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

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

Примечание

Эта функциональность была бессовестно списана с Bash .

Имя файла, в котором будет сохраняться список истории команд. Если эта переменная не определена, имя файла берётся из переменной окружения PSQL_HISTORY . Если и она не задана, используется имя по умолчанию —

/.psql_history или %APPDATA%postgresqlpsql_history в Windows. Например, если установить:

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

Примечание

Эта функциональность была бессовестно списана с Bash .

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

Примечание

Эта функциональность была бессовестно списана с Bash .

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

Примечание

Эта функциональность была бессовестно списана с Bash .

Содержит значение последнего OID, полученного командой INSERT или lo_import . Корректное значение переменной гарантируется до тех пор, пока не будет отображён результат следующей SQL -команды. ON_ERROR_ROLLBACK

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

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

Содержит порт сервера базы данных, к которому вы сейчас подключены. Устанавливается всякий раз при подключении к базе данных (в том числе при старте программы), но эту переменную можно изменить или сбросить. PROMPT1
PROMPT2
PROMPT3

Указывают, как должны выглядеть приглашения psql . См. Настройка приглашений. QUIET

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

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

Этой переменной можно присвоить значения never (никогда), errors (ошибки) или always (всегда), определяющие, когда в сообщениях с сервера будут выводиться поля КОНТЕКСТ . По умолчанию выбран вариант errors (который означает, что контекст будет выводиться в сообщениях об ошибках, но не в предупреждениях и уведомлениях). Этот параметр не действует, когда установлен уровень VERBOSITY terse . (Когда вам потребуется подробная версия только что выданной ошибки, может быть полезна команда errverbose .) SINGLELINE

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

Эта переменная эквивалентна параметру командной строки -s . USER

Содержит имя пользователя базы данных, который сейчас подключён. Устанавливается всякий раз при подключении к базе данных (в том числе при старте программы), но эту переменную можно изменить или сбросить. VERBOSITY

Этой переменной можно присвоить значения default , verbose или terse для изменения уровня детализации в сообщениях об ошибках. (См. также команду errverbose , полезную, когда требуется подробная версия только что выданной ошибки.) VERSION
VERSION_NAME
VERSION_NUM

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

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

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

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

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

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

Так как двоеточие может легально присутствовать в SQL-командах, попытка подстановки (например для :name , :’name’ или :»name» ) не выполняется, если переменная не установлена. В любом случае можно экранировать двоеточие с помощью обратной косой черты, чтобы предотвратить подстановку.

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

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

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

Полное имя компьютера (с именем домена) сервера базы данных или [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 работали правильно, непечатаемые символы нужно расположить между %[ и %] , чтобы сделать невидимыми. Можно делать несколько таких включений в приглашение. Например:

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

Чтобы вставить знак процента, нужно написать %% . По умолчанию используются значения ‘%/%R%# ‘ для PROMPT1 и PROMPT2 и ‘>> ‘ для PROMPT3 .

Примечание

Эта функциональность была бессовестно списана с tcsh .

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

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

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

Переменные окружения

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

Если результат запроса не помещается на экране, он пропускается через эту программу. Обычно это more или less . Значение по умолчанию зависит от платформы. От использования постраничника можно отказаться, очистив переменную PAGER или установив соответствующие параметры с помощью команды pset . PGDATABASE
PGHOST
PGPORT
PGUSER

Параметры подключения по умолчанию (см. Раздел 31.14). PSQL_EDITOR
EDITOR
VISUAL

Редактор, используемый командами e , ef и ev . Эти переменные рассматриваются в этом же порядке; в силу вступает значение, установленное первым.

По умолчанию в Unix-подобных системах используется vi , а в Windows — notepad.exe . PSQL_EDITOR_LINENUMBER_ARG

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

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

Альтернативное расположение файла с историей команд. Допускается использование тильды (

Альтернативное расположение пользовательского файла .psqlrc . Допускается использование тильды (

Команда операционной системы, выполняемая метакомандой ! . TMPDIR

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

Эта утилита, как и большинство других утилит Postgres Pro , также использует переменные среды, поддерживаемые libpq (см. Раздел 31.14).

Файлы

При запуске без параметра -X программа psql пытается считать и выполнить команды из общесистемного стартового файла ( psqlrc ), а затем из персонального стартового файла пользователя (

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

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

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

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

/.psqlrc-9.2.5 . При наличии нескольких файлов, файл с более детальным номером версии будет иметь предпочтение. .psql_history

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

/.psql_history или %APPDATA%postgresqlpsql_history на Windows.

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

Замечания

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

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

В Postgres Pro до версии 9.6 параметр -c подразумевал -X ( —no-psqlrc ); теперь это не так.

В PostgreSQL до 8.4 программа psql могла принять первый аргумент однобуквенной команды с обратной косой чертой сразу после команды, без промежуточного пробела. Теперь разделительный пробельный символ обязателен.

Замечания для пользователей Windows

psql создан как « консольное приложение » . Поскольку в Windows консольные окна используют кодировку символов отличную от той, что используется для остальной системы, нужно проявить особую осторожность при использовании 8-битных символов. Если psql обнаружит проблемную кодовую страницу консоли, он предупредит вас при запуске. Чтобы изменить кодовую страницу консоли, необходимы две вещи:

Задать кодовую страницу, выполнив cmd.exe /c chcp 1251 . (1251 это кодовая страница для России, замените на ваше значение.) При использовании Cygwin, эту команду можно записать в /etc/profile .

Установите консольный шрифт в Lucida Console , потому что растровый шрифт не работает с кодовой страницей ANSI.

По умолчанию psql работает в кодировке UTF-8 и использует для вывода в консоли API Windows Unicode. Чтобы все символы, поддерживаемые вашим консольным шрифтом Windows отображались корректно, необходимо установить для этой консоли кодовую страницу 65001.

Инсталлятор Postgres Pro для Windows устанавливает постраничник less.exe с поддержкой UTF-8 и создаёт ярлык, открывающий консольное окно со шрифтом Lucida Console и кодовой страницей 65001. Если вы используете другой постраничник, убедитесь в том, что он тоже поддерживает UTF-8.

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

Примеры

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

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

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

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

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

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

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

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

Источник

Way back in 2005 I added the ON_ERROR_ROLLBACK feature to psql, the Postgres command line client. When enabled, any errors cause an immediate rollback to just before the previous command. What this means is that you can stay inside your transaction, even if you make a typo (the main error-causing problem and the reason I wrote it!). Since I sometimes see people wanting to emulate this feature in their application or driver, I thought I would explain exactly how it works in psql.

First, it must be understood that this is not a Postgres feature, and there is no way you can instruct Postgres itself to ignore errors inside of a transaction. The work must be done by a client (such as psql) that can do some voodoo behind the scenes. The ON_ERROR_ROLLBACK feature is available since psql version 8.1.

Normally, any error you make will throw an exception and cause your current transaction to be marked as aborted. This is sane and expected behavior, but it can be very, very annoying if it happens when you are in the middle of a large transaction and mistype something! At that point, the only thing you can do is rollback the transaction and lose all of your work. For example:

greg=# CREATE TABLE somi(fav_song TEXT, passphrase TEXT, avatar TEXT);
CREATE TABLE
greg=# begin;
BEGIN
greg=# INSERT INTO somi VALUES ('The Perfect Partner', 'ZrgRQaa9ZsUHa', 'Andrastea');
INSERT 0 1
greg=# INSERT INTO somi VALUES ('Holding Out For a Hero', 'dx8yGUbsfaely', 'Janus');
INSERT 0 1
greg=# INSERT INTO somi BALUES ('Three Little Birds', '2pX9V8AKJRzy', 'Charon');
ERROR:  syntax error at or near "BALUES"
LINE 1: INSERT INTO somi BALUES ('Three Little Birds', '2pX9V8AKJRzy'...
greg=# INSERT INTO somi VALUES ('Three Little Birds', '2pX9V8AKJRzy', 'Charon');
ERROR:  current transaction is aborted, commands ignored until end of transaction block
greg=# rollback;
ROLLBACK
greg=# select count(*) from somi;
 count
-------
     0

When ON_ERROR_ROLLBACK is enabled, psql will issue a SAVEPOINT before every command you send to Postgres. If an error is detected, it will then issue a ROLLBACK TO the previous savepoint, which basically rewinds history to the point in time just before you issued the command. Which then gives you a chance to re-enter the command without the mistake. If an error was not detected, psql does a RELEASE savepoint behind the scenes, as there is no longer any reason to keep the savepoint around. So our example above becomes:

greg=# set ON_ERROR_ROLLBACK interactive
greg=# begin;
BEGIN
greg=# INSERT INTO somi VALUES ('Volcano', 'jA0EBAMCV4e+-^', 'Phobos');
INSERT 0 1
greg=# INSERT INTO somi VALUES ('Son of a Son of a Sailor', 'H0qHJ3kMoVR7e', 'Proteus');
INSERT 0 1
greg=# INSERT INTO somi BALUES ('Xanadu', 'KaK/uxtgyT1ni', 'Metis');
ERROR:  syntax error at or near "BALUES"
LINE 1: INSERT INTO somi BALUES ('Xanadu', 'KaK/uxtgyT1ni'...
greg=# INSERT INTO somi VALUES ('Xanadu', 'KaK/uxtgyT1ni', 'Metis');
INSERT 0 1
greg=# commit;
COMMIT
greg=# select count(*) from somi;
 count
-------
     3

What about if you create a savepoint yourself? Or even a savepoint with the same name as the one that psql uses internally? Not a problem—​Postgres allows multiple savepoints with the same name, and will rollback or release the latest one created, which allows ON_ERROR_ROLLBACK to work seamlessly with user-provided savepoints.

Note that the example above sets ON_ERROR_ROLLBACK (yes it is case sensitive!) to ‘interactive’, not just ‘on’. This is a good idea, as you generally want it to catch human errors, and not just plow through a SQL script.

So, if you want to add this to your own application, you will need to wrap each command in a hidden savepoint, and then rollback or release it. The end-user should not see the SAVEPOINT, ROLLBACK TO, or RELEASE commands. Thus, the SQL sent to the backend will change from this:

BEGIN; ## entered by the user
INSERT INTO somi VALUES ('Mr. Roboto', '3gNc841Rmy+a', 'Triton');
INSERT INTO somi VALUES ('A Mountain We Will Climb', 'O2DMZfqnfj8Tle', 'Tethys');
INSERT INTO somi BALUES ('Samba de Janeiro', 'W2rQpGU0MfIrm', 'Dione');

to this:

BEGIN; ## entered by the user
SAVEPOINT myapp_temporary_savepoint ## entered by the application
INSERT INTO somi VALUES ('Mr. Roboto', '3gNc841Rmy+a', 'Triton');
RELEASE myapp_temporary_savepoint

SAVEPOINT myapp_temporary_savepoint
INSERT INTO somi VALUES ('A Mountain We Will Climb', 'O2DMZfqnfj8Tle', 'Tethys');
RELEASE myapp_temporary_savepoint

SAVEPOINT myapp_temporary_savepoint
INSERT INTO somi BALUES ('Samba de Janeiro', 'W2rQpGU0MfIrm', 'Dione');
ROLLBACK TO myapp_temporary_savepoint

Here is some pseudo-code illustrating the sequence of events. To see the actual implementation in psql, take a look at bin/psql/common.c

run("SAVEPOINT myapp_temporary_savepoint");
run($usercommand);
if (txn_status == ERROR) {
  run("ROLLBACK TO myapp_temporary_savepoint");
}
if (command was "savepoint" or "release" or "rollback") {
  ## do nothing
}
elsif (txn_status == IN_TRANSACTION) {
  run("RELEASE myapp_temporary_savepoint");
}

While there is there some overhead in constantly creating and tearing down so many savepoints, it is quite small, especially if you are using it in an interactive session. This ability to automatically roll things back is especially powerful when you remember that Postgres can roll everything back, including DDL (e.g. CREATE TABLE). Certain other expensive database systems do not play well when mixing DDL and transactions.

database

postgres

---

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

Заголовок

Как мы уже говорили, каждая строка может одновременно присутствовать в базе данных в нескольких версиях. Одну версию от другой надо как-то отличать С этой целью каждая версия имеет две отметки, определяющие «время» действия данной версии (xmin и xmax). В кавычках — потому, что используется не время как таковое, а специальный увеличивающийся счетчик. И этот счетчик — номер транзакции.

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

Когда строка создается, значение xmin устанавливается в номер транзакции, выполнившей команду INSERT, а xmax не заполняется.

Когда строка удаляется, значение xmax текущей версии помечается номером транзакции, выполнившей DELETE.

Когда строка изменяется командой UPDATE, фактически выполняются две операции: DELETE и INSERT. В текущей версии строки устанавливается xmax, равный номеру транзакции, выполнившей UPDATE. Затем создается новая версия той же строки; значение xmin у нее совпадает с значением xmax предыдущей версии.

Поля xmin и xmax входят в заголовок версии строки. Кроме этих полей, заголовок содержит и другие, например:

• infomask — ряд битов, определяющих свойства данной версии. Их довольно много; основные из них мы постепенно рассмотрим.
• ctid — ссылка на следующую, более новую, версию той же строки. У самой новой, актуальной, версии строки ctid ссылается на саму эту версию. Номер имеет вид (x,y), где x — номер страницы, y — порядковый номер указателя в массиве.
• битовая карта неопределенных значений — отмечает те столбцы данной версии, которые содержат неопределенное значение (NULL). NULL не является одним из обычных значений типов данных, поэтому признак приходится хранить отдельно.

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

Вставка

Рассмотрим подробнее, как выполняются операции со строками на низком уровне, и начнем со вставки.

Для экспериментов создадим новую таблицу с двумя столбцами и индекс по одному из них:

=> CREATE TABLE t(
  id serial,
  s text
);
=> CREATE INDEX ON t(s);

Вставим одну строку, предварительно начав транзакцию.

=> BEGIN;
=> INSERT INTO t(s) VALUES ('FOO');

Вот номер нашей текущей транзакции:

=> SELECT txid_current();

 txid_current 
--------------
         3664
(1 row)

Заглянем в содержимое страницы. Функция heap_page_items расширения pageinspect позволяет получить информацию об указателях и версиях строк:

=> SELECT * FROM heap_page_items(get_raw_page('t',0)) gx

-[ RECORD 1 ]-------------------
lp          | 1
lp_off      | 8160
lp_flags    | 1
lp_len      | 32
t_xmin      | 3664
t_xmax      | 0
t_field3    | 0
t_ctid      | (0,1)
t_infomask2 | 2
t_infomask  | 2050
t_hoff      | 24
t_bits      | 
t_oid       | 
t_data      | x0100000009464f4f

Заметим, что словом heap (куча) в PostgreSQL обозначаются таблицы. Это еще одно странное употребление термина — куча является известной структурой данных, которая не имеет с таблицей ничего общего. Здесь это слово употребляется в смысле «все свалено в кучу», в отличие от упорядоченных индексов.

Функция показывает данные «как есть», в формате, сложном для восприятия. Чтобы разобраться, мы оставим только часть информации и расшифруем ее:

=> SELECT '(0,'||lp||')' AS ctid,
       CASE lp_flags
         WHEN 0 THEN 'unused'
         WHEN 1 THEN 'normal'
         WHEN 2 THEN 'redirect to '||lp_off
         WHEN 3 THEN 'dead'
       END AS state,
       t_xmin as xmin,
       t_xmax as xmax,
       (t_infomask & 256) > 0  AS xmin_commited,
       (t_infomask & 512) > 0  AS xmin_aborted,
       (t_infomask & 1024) > 0 AS xmax_commited,
       (t_infomask & 2048) > 0 AS xmax_aborted,
       t_ctid
FROM heap_page_items(get_raw_page('t',0)) gx

-[ RECORD 1 ]-+-------
ctid          | (0,1)
state         | normal
xmin          | 3664
xmax          | 0
xmin_commited | f
xmin_aborted  | f
xmax_commited | f
xmax_aborted  | t
t_ctid        | (0,1)

Вот что мы сделали:

• Добавили к номеру указателя нолик, чтобы привести его к такому же виду, как t_ctid: (номер страницы, номер указателя).
• Расшифровали состояние указателя lp_flags. Здесь он «normal» — это значит, что указатель действительно ссылается на версию строки. Другие значения рассмотрим позже.
• Из всех информационных битов выделили пока только две пары. Биты xmin_committed и xmin_aborted показывают, зафиксирована ли (отменена ли) транзакция с номером xmin. Два аналогичных бита относятся к транзакции с номером xmax.

Что же мы видим? При вставке строки в табличной странице появится указатель с номером 1, ссылающийся на первую и единственную версию строки.

В версии строки поле xmin заполнено номером текущей транзакции. Транзакция еще активна, поэтому оба бита xmin_committed и xmin_aborted не установлены.

Поле ctid версии строки ссылается на эту же строку. Это означает, что более новой версии не существует.

Поле xmax заполнено фиктивным номером 0, поскольку данная версия строки не удалена и является актуальной. Транзакции не будут обращать внимание на этот номер, поскольку установлен бит xmax_aborted.

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

=> CREATE FUNCTION heap_page(relname text, pageno integer)
RETURNS TABLE(ctid tid, state text, xmin text, xmax text, t_ctid tid)
AS $$
SELECT (pageno,lp)::text::tid AS ctid,
       CASE lp_flags
         WHEN 0 THEN 'unused'
         WHEN 1 THEN 'normal'
         WHEN 2 THEN 'redirect to '||lp_off
         WHEN 3 THEN 'dead'
       END AS state,
       t_xmin || CASE
         WHEN (t_infomask & 256) > 0 THEN ' (c)'
         WHEN (t_infomask & 512) > 0 THEN ' (a)'
         ELSE ''
       END AS xmin,
       t_xmax || CASE
         WHEN (t_infomask & 1024) > 0 THEN ' (c)'
         WHEN (t_infomask & 2048) > 0 THEN ' (a)'
         ELSE ''
       END AS xmax,
       t_ctid
FROM heap_page_items(get_raw_page(relname,pageno))
ORDER BY lp;
$$ LANGUAGE SQL;

В таком виде значительно понятнее, что творится в заголовке версии строки:

=> SELECT * FROM heap_page('t',0);

 ctid  | state  | xmin | xmax  | t_ctid 
-------+--------+------+-------+--------
 (0,1) | normal | 3664 | 0 (a) | (0,1)
(1 row)

Похожую, но существенно менее детальную, информацию можно получить и из самой таблицы, используя псевдостолбцы xmin и xmax:

=> SELECT xmin, xmax, * FROM t;

 xmin | xmax | id |  s  
------+------+----+-----
 3664 |    0 |  1 | FOO
(1 row)

Фиксация

При успешном завершении транзакции нужно запомнить ее статус — отметить, что она зафиксирована. Для этого используется структура, называемая XACT (а до версии 10 она называлась CLOG (commit log) и это название еще может встречаться в разных местах).

XACT — не таблица системного каталога; это файлы в каталоге PGDATA/pg_xact. В них для каждой транзакции отведено два бита: committed и aborted — точно так же, как в заголовке версии строки. На несколько файлов эта информация разбита исключительно для удобства, мы еще вернемся к этому вопросу, когда будем рассматривать заморозку. А работа с этими файлами ведется постранично, как и со всеми другими.

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

Когда какая-либо другая транзакция обратится к табличной странице, на которую мы только что смотрели, ей придется ответить на несколько вопросов.

1. Завершилась ли транзакция xmin? Если нет, то созданная версия строки не должна быть видна.
   Такая проверка выполняется просмотром еще одной структуры, которая располагается в общей памяти экземпляра и называется ProcArray. В ней находится список всех активных процессов, и для каждого указан номер его текущей (активной) транзакции.
2. Если завершилась, то как — фиксацией или отменой? Если отменой, то версия строки тоже не должны быть видна.
   Вот для этого как раз и нужен XACT. Но, хотя последние страницы XACT сохраняются в буферах в оперативной памяти, все же каждый раз проверять XACT накладно. Поэтому выясненный однажды статус транзакции записывается в биты xmin_committed и xmin_aborted версии строки. Если один из этих битов установлен, то состояние транзакции xmin считается известным и следующей транзакции уже не придется обращаться к XACT.

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

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

Итак, зафиксируем изменение.

=> COMMIT;

В странице ничего не изменилось (но мы знаем, что статус транзакции уже записан в XACT):

=> SELECT * FROM heap_page('t',0);

 ctid  | state  | xmin | xmax  | t_ctid 
-------+--------+------+-------+--------
 (0,1) | normal | 3664 | 0 (a) | (0,1)
(1 row)

Теперь транзакция, первой обратившаяся к странице, должна будет определить статус транзакции xmin и запишет его в информационные биты:

=> SELECT * FROM t;

 id |  s  
----+-----
  1 | FOO
(1 row)

=> SELECT * FROM heap_page('t',0);

 ctid  | state  |   xmin   | xmax  | t_ctid 
-------+--------+----------+-------+--------
 (0,1) | normal | 3664 (c) | 0 (a) | (0,1)
(1 row)

Удаление

При удалении строки в поле xmax актуальной версии записывается номер текущей удаляющей транзакции, а бит xmax_aborted сбрасывается.

Заметим, что установленное значение xmax, соответствующее активной транзакции, выступает в качестве блокировки строки. Если другая транзакция собирается обновить или удалить эту строку, она будет вынуждена дождаться завершения транзакции xmax. Подробнее про блокировки мы будем говорить позже. Пока отметим только, что число блокировок строк ничем не ограничено. Они не занимают место в оперативной памяти и производительность системы не страдает от их количества. Правда, у “длинных” транзакций есть другие минусы, но об этом тоже позже.

Удалим строку.

=> BEGIN;
=> DELETE FROM t;
=> SELECT txid_current();

 txid_current 
--------------
         3665
(1 row)

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

=> SELECT * FROM heap_page('t',0);

 ctid  | state  |   xmin   | xmax | t_ctid 
-------+--------+----------+------+--------
 (0,1) | normal | 3664 (c) | 3665 | (0,1)
(1 row)

Отмена

Отмена изменений работает аналогично фиксации, только в XACT для транзакции выставляется бит aborted. Отмена выполняется так же быстро, как и фиксация. Хоть команда и называется ROLLBACK, отката изменений не происходит: все, что транзакция успела изменить в страницах данных, остается без изменений.

=> ROLLBACK;
=> SELECT * FROM heap_page('t',0);

 ctid  | state  |   xmin   | xmax | t_ctid 
-------+--------+----------+------+--------
 (0,1) | normal | 3664 (c) | 3665 | (0,1)
(1 row)

При обращении к странице будет проверен статус и в версию строки будет установлен бит подсказки xmax_aborted. Сам номер xmax при этом остается в странице, но смотреть на него уже никто не будет.

=> SELECT * FROM t;

 id |  s  
----+-----
  1 | FOO
(1 row)

=> SELECT * FROM heap_page('t',0);

 ctid  | state  |   xmin   |   xmax   | t_ctid 
-------+--------+----------+----------+--------
 (0,1) | normal | 3664 (c) | 3665 (a) | (0,1)
(1 row)

Обновление

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

=> BEGIN;
=> UPDATE t SET s = 'BAR';
=> SELECT txid_current();

 txid_current 
--------------
         3666
(1 row)

Запрос выдает одну строку (новую версию):

=> SELECT * FROM t;

 id |  s  
----+-----
  1 | BAR
(1 row)

Но в странице мы видим обе версии:

=> SELECT * FROM heap_page('t',0);

 ctid  | state  |   xmin   | xmax  | t_ctid 
-------+--------+----------+-------+--------
 (0,1) | normal | 3664 (c) | 3666  | (0,2)
 (0,2) | normal | 3666     | 0 (a) | (0,2)
(2 rows)

Удаленная версия помечена номером текущей транзакции в поле xmax. Причем это значение записано поверх старого, поскольку предыдущая транзакция была отменена. А бит xmax_aborted сброшен, так как статус текущей транзакции еще неизвестен.

Первая версия строки ссылается теперь на вторую (поле t_ctid), как на более новую.

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

Так же, как и при удалении, значение xmax в первой версии строки служит признаком того, что строка заблокирована.

Ну и завершим транзакцию.

=> COMMIT;

Индексы

До сих пор мы говорили только о табличных страницах. А что происходит внутри индексов?

Информация в индексных страницах сильно зависит от конкретного типа индекса. И даже у одного типа индекса бывают разные виды страниц. Например, у B-дерева есть страница с метаданными и «обычные» страницы.

Тем не менее, обычно в странице имеется массив указателей на строки и сами строки (так же, как и в табличной странице). Кроме того, в конце страницы отводится место под специальные данные.

Строки в индексах тоже могут иметь очень разную структуру в зависимости от типа индекса. Например, для B-дерева строки, относящиеся к листовым страницам, содержат значение ключа индексирования и ссылку (ctid) на соответствующую строку таблицы. В общем случае индекс может быть устроен совсем другим образом.

Самый важный момент состоит в том, что в индексах любого типа не бывает версий строк. Ну или можно считать, что каждая строка представлена ровно одной версией. Иными словами, в заголовке индексной строки не бывает полей xmin и xmax. Можно считать, что ссылки из индекса ведут на все табличные версии строк — так что разобраться, какую из версий увидит транзакция, можно только заглянув в таблицу. (Как обычно, это не вся правда. В некоторых случаях карта видимости позволяет оптимизировать процесс, но подробнее рассмотрим это позже.)

При этом в индексной странице обнаруживаем указатели на обе версии, как на актуальную, так и на старую:

=> SELECT itemoffset, ctid FROM bt_page_items('t_s_idx',1);

 itemoffset | ctid  
------------+-------
          1 | (0,2)
          2 | (0,1)
(2 rows)

Виртуальные транзакци

На практике PostgreSQL использует оптимизацию, позволяющую «экономить» номера транзакций.

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

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

Виртуальные номера никак не учитываются в снимках данных.

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

=> BEGIN;
=> SELECT txid_current_if_assigned();

 txid_current_if_assigned 
--------------------------
                         
(1 row)

Если же транзакция начинает менять данные, ей выдается настоящий, уникальный номер транзакции.

=> UPDATE accounts SET amount = amount - 1.00;
=> SELECT txid_current_if_assigned();

 txid_current_if_assigned 
--------------------------
                     3667
(1 row)

=> COMMIT;

Вложенные транзакции

Точки сохранения

В SQL определены точки сохранения (savepoint), которые позволяют отменить часть операцией транзакции, не прерывая ее полностью. Но это не укладывается в приведенную выше схему, поскольку статус у транзакции один на все ее изменения, а физически никакие данные не откатываются.

Чтобы реализовать такой функционал, транзакция с точкой сохранения разбивается на несколько отдельных вложенных транзакций (subtransaction), статусом которых можно управлять отдельно.

Вложенные транзакции имеют свой собственный номер (бóльший, чем номер основной транзакции). Статус вложенных транзакций записывается обычным образом в XACT, однако финальный статус зависит от статуса основной транзакции: если она отменена, то отменяются также и все вложенные транзакции.

Информация о вложенности транзакций хранится в файлах в каталоге PGDATA/pg_subtrans. Обращение к файлам происходит через буферы в общей памяти экземпляра, организованные так же, как и буферы XACT.

Не путайте вложенные транзакции и автономные транзакции. Автономные транзакции никак не зависят друг от друга, а вложенные — зависят. Автономных транзакций в обычном PostgreSQL нет, и, пожалуй, к лучшему: по делу они нужны очень и очень редко, а их наличие в других СУБД провоцирует злоупотребление, от которого потом все страдают.

Очистим таблицу, начнем транзакцию и вставим строку:

=> TRUNCATE TABLE t;
=> BEGIN;
=> INSERT INTO t(s) VALUES ('FOO');
=> SELECT txid_current();

 txid_current 
--------------
         3669
(1 row)

=> SELECT xmin, xmax, * FROM t;

 xmin | xmax | id |  s  
------+------+----+-----
 3669 |    0 |  2 | FOO
(1 row)

=> SELECT * FROM heap_page('t',0);

 ctid  | state  | xmin | xmax  | t_ctid 
-------+--------+------+-------+--------
 (0,1) | normal | 3669 | 0 (a) | (0,1)
(1 row)

Теперь поставим точку сохранения и вставим еще одну строку.

=> SAVEPOINT sp;
=> INSERT INTO t(s) VALUES ('XYZ');
=> SELECT txid_current();

 txid_current 
--------------
         3669
(1 row)

Заметьте, что функция txid_current() выдает номер основной, а не вложенной, транзакции.

=> SELECT xmin, xmax, * FROM t;

 xmin | xmax | id |  s  
------+------+----+-----
 3669 |    0 |  2 | FOO
 3670 |    0 |  3 | XYZ
(2 rows)

=> SELECT * FROM heap_page('t',0);

 ctid  | state  | xmin | xmax  | t_ctid 
-------+--------+------+-------+--------
 (0,1) | normal | 3669 | 0 (a) | (0,1)
 (0,2) | normal | 3670 | 0 (a) | (0,2)
(2 rows)

Откатимся к точке сохранения и вставим третью строку.

=> ROLLBACK TO sp;
=> INSERT INTO t(s) VALUES ('BAR');
=> SELECT xmin, xmax, * FROM t;

 xmin | xmax | id |  s  
------+------+----+-----
 3669 |    0 |  2 | FOO
 3671 |    0 |  4 | BAR
(2 rows)

=> SELECT * FROM heap_page('t',0);

 ctid  | state  |   xmin   | xmax  | t_ctid 
-------+--------+----------+-------+--------
 (0,1) | normal | 3669     | 0 (a) | (0,1)
 (0,2) | normal | 3670 (a) | 0 (a) | (0,2)
 (0,3) | normal | 3671     | 0 (a) | (0,3)
(3 rows)

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

Фиксируем изменения.

=> COMMIT;
=> SELECT xmin, xmax, * FROM t;

 xmin | xmax | id |  s  
------+------+----+-----
 3669 |    0 |  2 | FOO
 3671 |    0 |  4 | BAR
(2 rows)

=> SELECT * FROM heap_page('t',0);

 ctid  | state  |   xmin   | xmax  | t_ctid 
-------+--------+----------+-------+--------
 (0,1) | normal | 3669 (c) | 0 (a) | (0,1)
 (0,2) | normal | 3670 (a) | 0 (a) | (0,2)
 (0,3) | normal | 3671 (c) | 0 (a) | (0,3)
(3 rows)

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

Заметим, что вложенные транзакции нельзя использовать в SQL явно, то есть нельзя начать новую транзакцию, не завершив текущую. Этот механизм задействуется неявно при использовании точек сохранения, а еще при обработке исключений PL/pgSQL и в ряде других, более экзотических, случаев.

=> BEGIN;

BEGIN

=> BEGIN;

WARNING:  there is already a transaction in progress
BEGIN

=> COMMIT;

COMMIT

=> COMMIT;

WARNING:  there is no transaction in progress
COMMIT

Ошибки и атомарность операций

Что случится, если при выполнении операции произойдет ошибка? Например, так:

=> BEGIN;
=> SELECT * FROM t;

 id |  s  
----+-----
  2 | FOO
  4 | BAR
(2 rows)

=> UPDATE t SET s = repeat('X', 1/(id-4));

ERROR:  division by zero

Произошла ошибка. Теперь транзакция считается прерванной и ни одна операция в ней не допускается:

=> SELECT * FROM t;

ERROR:  current transaction is aborted, commands ignored until end of transaction block

И даже если попытаться зафиксировать изменения, PostgreSQL сообщит об отмене:

=> COMMIT;

ROLLBACK

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

=> SELECT * FROM heap_page('t',0);

 ctid  | state  |   xmin   | xmax  | t_ctid 
-------+--------+----------+-------+--------
 (0,1) | normal | 3669 (c) | 3672  | (0,4)
 (0,2) | normal | 3670 (a) | 0 (a) | (0,2)
 (0,3) | normal | 3671 (c) | 0 (a) | (0,3)
 (0,4) | normal | 3672     | 0 (a) | (0,4)
(4 rows)

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

=> set ON_ERROR_ROLLBACK on
=> BEGIN;
=> SELECT * FROM t;

 id |  s  
----+-----
  2 | FOO
  4 | BAR
(2 rows)

=> UPDATE t SET s = repeat('X', 1/(id-4));

ERROR:  division by zero

=> SELECT * FROM t;

 id |  s  
----+-----
  2 | FOO
  4 | BAR
(2 rows)

=> COMMIT;

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

Продолжение.