В этом разделе подробно описывается формат каждого сообщения. Все сообщения помечены символами, обозначающими, какая сторона может их передавать: сервер (F), клиент (B) или обе стороны (F & B). Заметьте, что хотя каждое сообщение включает счётчик байт в начале, формат сообщения разработан так, чтобы конец сообщения можно было найти, не обращаясь к счётчику байт. Это помогает проверять корректность сообщений. (Исключением является сообщение CopyData, так как оно образует часть потока данных; содержимое любого отдельного сообщения CopyData нельзя интерпретировать само по себе.)
Указывает, что это сообщение представляет запрос аутентификации.
Длина содержимого сообщения в байтах, включая само поле длины.
Показывает, что проверка подлинности прошла успешно.
Указывает, что это сообщение представляет запрос аутентификации.
Длина содержимого сообщения в байтах, включая само поле длины.
Указывает, что требуется проверка подлинности по протоколу Kerberos V5.
Указывает, что это сообщение представляет запрос аутентификации.
Длина содержимого сообщения в байтах, включая само поле длины.
Указывает, что требуется пароль, передаваемый открытым текстом.
Указывает, что это сообщение представляет запрос аутентификации.
Длина содержимого сообщения в байтах, включая само поле длины.
Указывает, что требуется пароль, преобразованный в хеш MD5.
Значение соли, с которым должен хешироваться пароль.
Указывает, что это сообщение представляет запрос аутентификации.
Длина содержимого сообщения в байтах, включая само поле длины.
Указывает, что требуется сообщение с учётными данными SCM.
Указывает, что это сообщение представляет запрос аутентификации.
Длина содержимого сообщения в байтах, включая само поле длины.
Указывает, что требуется проверка подлинности на базе GSSAPI.
Указывает, что это сообщение представляет запрос аутентификации.
Длина содержимого сообщения в байтах, включая само поле длины.
Указывает, что требуется проверка подлинности на базе SSPI.
Указывает, что это сообщение представляет запрос аутентификации.
Длина содержимого сообщения в байтах, включая само поле длины.
Указывает, что это сообщение содержит данные GSSAPI или SSPI.
nДанные аутентификации для GSSAPI или SSPI.
Указывает, что это сообщение представляет запрос аутентификации.
Длина содержимого сообщения в байтах, включая само поле длины.
Указывает, что требуется проверка подлинности на базе SASL.
Тело сообщения содержит список механизмов аутентификации SASL, в порядке предпочтений сервера. За последним именем механизма аутентификации должен идти завершающий нулевой байт. Для каждого механизма передаётся:
Имя механизма аутентификации SASL.
Указывает, что это сообщение представляет запрос аутентификации.
Длина содержимого сообщения в байтах, включая само поле длины.
Указывает, что это сообщение содержит данные вызова SASL.
nДанные SASL, специфичные для применяемого механизма SASL.
Указывает, что это сообщение представляет запрос аутентификации.
Длина содержимого сообщения в байтах, включая само поле длины.
Указывает, что аутентификация SASL завершена.
n«Дополнительные данные» результата SASL, специфичные для применяемого механизма SASL.
Указывает, что это сообщение содержит ключевые данные для отмены запросов. Клиент должен сохранить эти данные, если ему нужна возможность впоследствии выдавать сообщения CancelRequest.
Длина содержимого сообщения в байтах, включая само поле длины.
PID обслуживающего процесса.
Секретный ключ обслуживающего процесса.
Указывает, что это сообщение представляет команду Bind.
Длина содержимого сообщения в байтах, включая само поле длины.
Имя целевого портала (пустая строка выбирает безымянный портал).
Имя исходного подготовленного оператора (пустая строка выбирает безымянный подготовленный оператор).
Количество кодов форматов следующих параметров (обозначается ниже символом C). Может быть нулевым, что показывает, что параметры отсутствуют или все параметры передаются в формате по умолчанию (текстовом); либо равняться одному, в этом случае указанный один код формата применяется ко всем параметрам; либо может равняться действительному количеству параметров.
C]Коды форматов параметров. В настоящее время допускаются коды ноль (текстовый формат) и один (двоичный).
Количество следующих значений параметров (может быть нулевым). Оно должно совпадать с количеством параметров, требующихся для запроса.
Затем для каждого параметра идёт следующая пара полей:
Длина значения параметра, в байтах (само поле длины не считается). Может быть нулевой. В качестве особого значения, -1 представляет значение NULL. В случае с NULL никакие байты значений далее не следуют.
nЗначение параметра в формате, определённом соответствующим кодом формата. Переменная n задаёт длину значения.
За последним параметром идут следующие поля:
Количество кодов формата для следующих столбцов результата (обозначается ниже символом R). Может быть нулевым, что показывает, что столбцы результата отсутствуют или для всех столбцов должен использоваться формат по умолчанию (текстовый), либо равняться одному, в этом случае указанный один код формата применяется ко всем столбцам (если они есть), либо может равняться действительному количеству столбцов результата запроса.
R]Коды форматов столбцов результата. В настоящее время допускаются коды ноль (текстовый формат) и один (двоичный).
Указывает, что это сообщение, сигнализирующее о завершении Bind.
Длина содержимого сообщения в байтах, включая само поле длины.
Длина содержимого сообщения в байтах, включая само поле длины.
Код запроса отмены. Это специально выбранное значение содержит 1234 в старших 16 битах и 5678 в младших 16 битах. (Во избежание неоднозначности этот код не должен совпадать с номером версии протокола.)
PID целевого обслуживающего процесса.
Секретный ключ целевого обслуживающего процесса.
Указывает, что это сообщение представляет команду Close.
Длина содержимого сообщения в байтах, включая само поле длины.
'S' для закрытия подготовленного оператора, 'P' для закрытия портала.
Имя подготовленного оператора или портала, который должен быть закрыт (пустая строка выбирает безымянный подготовленный оператор или портал).
Указывает, что это сообщение, сигнализирующее о завершении Close.
Длина содержимого сообщения в байтах, включая само поле длины.
Указывает, что это сообщение об успешном завершении команды.
Длина содержимого сообщения в байтах, включая само поле длины.
Тег команды. Обычно это одно слово, обозначающее завершённую команду SQL.
Для команды INSERT в качестве тега передаётся INSERT , где oid строкстрок — количество вставленных строк. В поле oid передаётся идентификатор объекта вставленной строки, если число строк равно 1 и в целевой таблице содержатся OID; в противном случае вместо oid передаётся 0.
Для команды DELETE в качестве тега передаётся DELETE , где строкстрок — количество удалённых строк.
Для команды UPDATE в качестве тега передаётся UPDATE , где строкстрок — количество изменённых строк.
Для команды SELECT или CREATE TABLE AS в качестве тега передаётся SELECT , где строкстрок — число полученных строк.
Для команды MOVE в качестве тега передаётся MOVE , где строкстрок — количество строк, на которое изменилась позиция курсора.
Для команды FETCH в качестве тега передаётся FETCH , где строкстрок — количество строк, полученное через курсор.
Для команды COPY в качестве тега передаётся COPY , где строкстрок — количество скопированных строк. (Заметьте: число строк выводится, начиная только с PostgreSQL 8.2.)
Указывает, что в этом сообщении передаются данные COPY.
Длина содержимого сообщения в байтах, включая само поле длины.
nДанные, образующие часть информационного потока COPY. Сообщения от сервера всегда соответствуют отдельным строкам данных, но сообщения, передаваемые клиентами, могут разделять поток произвольным образом.
Указывает, что это сообщение, сигнализирующее о завершении COPY.
Длина содержимого сообщения в байтах, включая само поле длины.
Указывает, что это сообщение, сигнализирующее об ошибке операции COPY.
Длина содержимого сообщения в байтах, включая само поле длины.
Сообщение об ошибке, описывающее причину сбоя операции.
Указывает, что это сообщение является ответом на запуск входящего копирования. Получив его, клиент начинает передавать данные на вход операции копирования (если клиент не готов к этому, он передаёт сообщение CopyFail).
Длина содержимого сообщения в байтах, включая само поле длины.
Значение 0 указывает, что для всей операции COPY применяется текстовый формат (строки разделяются символами новой строки, столбцы разделяются символами-разделителями и т. д.). Значение 1 указывает, что для всей операции копирования применяется двоичный формат (подобный формату DataRow). За дополнительными сведениями обратитесь к COPY.
Количество столбцов в копируемых данных (ниже обозначается символом N).
N]Коды формата для каждого столбца. В настоящее время допускаются коды ноль (текстовый формат) и один (двоичный). Если общий формат копирования — текстовый, все эти коды должны быть нулевыми.
Указывает, что это сообщение является ответом на запуск исходящего копирования. За этим сообщением следуют данные, исходящие со стороны сервера.
Длина содержимого сообщения в байтах, включая само поле длины.
Значение 0 указывает, что для всей операции COPY применяется текстовый формат (строки разделяются символами новой строки, столбцы разделяются символами-разделителями и т. д.). Значение 1 указывает, что для всей операции копирования применяется двоичный формат (подобный формату DataRow). За дополнительными сведениями обратитесь к COPY.
Количество столбцов в копируемых данных (ниже обозначается символом N).
N]Коды формата для каждого столбца. В настоящее время допускаются коды ноль (текстовый формат) и один (двоичный). Если общий формат копирования — текстовый, все эти коды должны быть нулевыми.
Указывает, что это сообщение является ответом на запуск двустороннего копирования. Это сообщение используется только для потоковой репликации.
Длина содержимого сообщения в байтах, включая само поле длины.
Значение 0 указывает, что для всей операции COPY применяется текстовый формат (строки разделяются символами новой строки, столбцы разделяются символами-разделителями и т. д.). Значение 1 указывает, что для всей операции копирования применяется двоичный формат (подобный формату DataRow). За дополнительными сведениями обратитесь к COPY.
Количество столбцов в копируемых данных (ниже обозначается символом N).
N]Коды формата для каждого столбца. В настоящее время допускаются коды ноль (текстовый формат) и один (двоичный). Если общий формат копирования — текстовый, все эти коды должны быть нулевыми.
Указывает, что в этом сообщении передаётся строка данных.
Длина содержимого сообщения в байтах, включая само поле длины.
Количество последующих значений столбцов (может быть нулевым).
Затем для каждого столбца идёт следующая пара полей:
Длина значения столбца, в байтах (само поле длины не считается). Может быть нулевой. В качестве особого значения, -1 представляет значение NULL. В случае с NULL никакие байты значений далее не следуют.
nЗначение столбца в формате, определённом соответствующим кодом формата. Переменная n задаёт длину значения.
Указывает, что это сообщение представляет команду Describe.
Длина содержимого сообщения в байтах, включая само поле длины.
'S' для получения описания подготовленного оператора, 'P' — портала.
Имя подготовленного оператора или портала, описание которого запрашивается (пустая строка выбирает безымянный подготовленный оператор или портал).
Указывает, что это сообщение является ответом на пустую строку запроса. (Это сообщение заменяет CommandComplete.)
Длина содержимого сообщения в байтах, включая само поле длины.
Указывает, что это сообщение ошибки.
Длина содержимого сообщения в байтах, включая само поле длины.
Тело сообщения состоит из одного или нескольких определённых полей, за которыми в качестве завершающего следует нулевой байт. Поля могут идти в любом порядке. Для каждого поля передаётся:
Код, задающий тип поля; ноль обозначает конец сообщения, после которого ничего нет. Типы полей, определённые в настоящее время, перечислены в Разделе 53.8. Так как в будущем могут появиться другие типы полей, клиенты должны просто игнорировать поля нераспознанного типа.
Значение поля.
Указывает, что это сообщение представляет команду Execute.
Длина содержимого сообщения в байтах, включая само поле длины.
Имя портала, подлежащего выполнению (пустая строка выбирает безымянный портал).
Максимальное число строк, которое должно быть возвращено, если портал содержит запрос, возвращающий строки (в противном случае игнорируется). Ноль означает «без ограничения».
Указывает, что это сообщение представляет команду Flush.
Длина содержимого сообщения в байтах, включая само поле длины.
Указывает, что это сообщение представляет вызов функции.
Длина содержимого сообщения в байтах, включая само поле длины.
Задаёт идентификатор объекта вызываемой функции.
Количество кодов форматов следующих аргументов (обозначается ниже символом C). Может быть нулевым, что показывает, что аргументы отсутствуют или все аргументы передаются в формате по умолчанию (текстовом); либо равняться одному, в этом случае указанный один код формата применяется ко всем аргументами, либо может равняться действительному количеству аргументов.
C]Коды форматов аргументов. В настоящее время допускаются коды ноль (текстовый формат) и один (двоичный).
Задаёт число аргументов, передаваемых функции.
Затем для каждого аргумента идёт следующая пара полей:
Длина значения аргумента, в байтах (само поле длины не считается). Может быть нулевой. В качестве особого значения, -1 представляет значение NULL. В случае с NULL никакие байты значений далее не следуют.
nЗначение аргумента, в формате, определённом соответствующим кодом формата. Переменная n задаёт длину значения.
За последним аргументом идут следующие поля:
Код формата результата функции. В настоящее время допускается код ноль (текстовый формат) и один (двоичный).
Указывает, что в этом сообщении передаётся результат вызова функции.
Длина содержимого сообщения в байтах, включая само поле длины.
Длина значения результата функции, в байтах (само поле длины не считается). Может быть нулевой. В качестве особого значения, -1 представляет значение NULL. В случае с NULL никакие байты значения далее не следуют.
nЗначение результата функции в формате, определённом соответствующим кодом формата. Переменная n задаёт длину значения.
Обозначает это сообщение как ответ GSSAPI или SSPI. Заметьте, что оно также применяется для ответов SASL и при аутентификации по паролю. Точный тип сообщения можно определить из контекста.
Длина содержимого сообщения в байтах, включая само поле длины.
nДанные сообщения, специфичные для GSSAPI/SSPI.
Указывает, что это сообщение согласования версии протокола.
Длина содержимого сообщения в байтах, включая само поле длины.
Новейшая младшая версия протокола, поддерживаемая сервером, для запрошенной клиентом старшей версии.
Число параметров протокола, не принятых сервером.
Затем для параметров протокола, не принятых сервером, передаётся:
Имя параметра.
Указывает, что это сообщение сигнализирует об отсутствии данных.
Длина содержимого сообщения в байтах, включая само поле длины.
Указывает, что это сообщение представляет замечание.
Длина содержимого сообщения в байтах, включая само поле длины.
Тело сообщения состоит из одного или нескольких определённых полей, за которыми в качестве завершающего следует нулевой байт. Поля могут идти в любом порядке. Для каждого поля передаётся:
Код, задающий тип поля; ноль обозначает конец сообщения, после которого ничего нет. Типы полей, определённые в настоящее время, перечислены в Разделе 53.8. Так как в будущем могут появиться другие типы полей, клиенты должны просто игнорировать поля нераспознанного типа.
Значение поля.
Указывает, что это сообщение представляет уведомление.
Длина содержимого сообщения в байтах, включая само поле длины.
PID обслуживающего процесса, отправляющего уведомление.
Имя канала, для которого было выдано уведомление.
Строка «сообщения», сопровождающего уведомление.
Указывает, что это сообщение представляет описание параметра.
Длина содержимого сообщения в байтах, включая само поле длины.
Количество параметров для оператора (может быть нулевым).
Затем для каждого параметра передаётся:
Задаёт идентификатор объекта типа данных параметра.
Указывает, что в этом сообщении передаётся состояние параметра времени выполнения.
Длина содержимого сообщения в байтах, включая само поле длины.
Имя параметра времени выполнения, состояние которого передаётся.
Текущее значение параметра.
Указывает, что это сообщение представляет команду Parse.
Длина содержимого сообщения в байтах, включая само поле длины.
Имя целевого подготовленного оператора (пустая строка выбирает безымянный подготовленный оператор).
Строка запроса, которая должна быть разобрана.
Количество типов параметров (может быть нулевым). Заметьте, что это значение представляет не число параметров, которые могут фигурировать в строке запроса, а число параметров, для которых клиент хочет предопределить типы.
Затем для каждого параметра передаётся:
Задаёт идентификатор объекта типа данных параметра. Указание нулевого значения равносильно отсутствию указания типа.
Указывает, что это сообщение, сигнализирующее о завершении Parse.
Длина содержимого сообщения в байтах, включая само поле длины.
Обозначает это сообщение как ответ SASL. Заметьте, что оно также применяется для ответов GSSAPI, SSPI и SASL. Точный тип сообщения можно определить из контекста.
Длина содержимого сообщения в байтах, включая само поле длины.
Пароль (зашифрованный, если требуется).
Указывает, что это сообщение сигнализирует о приостановке портала. Заметьте, что оно выдаётся только при достижении ограничения числа строк, заданного в сообщении Execute.
Длина содержимого сообщения в байтах, включая само поле длины.
Указывает, что это сообщение представляет простой запрос.
Длина содержимого сообщения в байтах, включая само поле длины.
Собственно строка запроса.
Определяет тип сообщения. Сообщение ReadyForQuery передаётся, когда сервер готов к новому циклу запросов.
Длина содержимого сообщения в байтах, включая само поле длины.
Индикатор текущего состояния транзакции на сервере. Возможные значения: 'I', транзакция неактивна (вне блока транзакции), 'T' в блоке транзакции, либо 'E' в блоке прерванной транзакции (запросы не будут обрабатываться до завершения блока).
Указывает, что это сообщение представляет описание строки.
Длина содержимого сообщения в байтах, включая само поле длины.
Задаёт количество полей в строке (может быть нулевым).
Затем для каждого поля передаётся:
Имя поля.
Если поле связано со столбцом определённой таблицы, идентификатор объекта этой таблицы; в противном случае — ноль.
Если поле связано со столбцом определённой таблицы, номер атрибута для этого столбца; в противном случае — ноль.
Идентификатор объекта типа данных поля.
Размер типа данных (см. pg_type.typlen). Заметьте, что отрицательные значения показывают, что тип имеет переменную длину.
Модификатор типа (см. pg_attribute.atttypmod). Смысл этого модификатора зависит от типа.
Код формата, используемого для поля. В настоящее время допускаются коды ноль (текстовый формат) и один (двоичный). В сообщении RowDescription, возвращаемом вариацией Describe для оператора, код формата ещё не известен и всегда будет нулевым.
Обозначает это сообщение как начальный ответ SASL. Заметьте, что оно также применяется для ответов GSSAPI, SSPI и при аутентификации по паролю. Точный тип сообщения определяется из контекста.
Длина содержимого сообщения в байтах, включая само поле длины.
Имя механизма аутентификации SASL, выбранного клиентом.
Длина последующего сообщения «Начальный ответ клиента», специфичного для механизма SASL, или -1, если начального ответа нет.
n«Начальный ответ», специфичный для механизма SASL.
Обозначает это сообщение как ответ SASL. Заметьте, что оно также применяется для ответов GSSAPI, SSPI и при аутентификации по паролю. Точный тип сообщения можно определить из контекста.
Длина содержимого сообщения в байтах, включая само поле длины.
nДанные сообщения, специфичные для механизма SASL.
Длина содержимого сообщения в байтах, включая само поле длины.
Код запроса SSL. Это специально выбранное значение содержит 1234 в старших 16 битах и 5679 в младших 16 битах. (Во избежание неоднозначности этот код не должен совпадать с номером версии протокола.)
Длина содержимого сообщения в байтах, включая само поле длины.
Номер версии протокола. В старших 16 битах задаётся старший номер версии (3 для протокола, описываемого здесь). В младших 16 битах задаётся младший номер версии (0 для протокола, описываемого здесь).
За номером версии протокола следует одна или несколько пар из имени параметра и строки значения. За последней парой имя/значение должен следовать нулевой байт. Передаваться параметры могут в любом порядке. Обязательным является только параметр user, остальные могут отсутствовать. Каждый параметр задаётся так:
Имя параметра. В настоящее время принимаются имена:
user
Имя пользователя баз данных, с которым выполняется подключение. Является обязательным, значения по умолчанию нет.
database
База данных, к которой выполняется подключение. По умолчанию подставляется имя пользователя.
options
Аргументы командной строки для обслуживающего процесса. (Этот способ считается устаревшим; теперь следует устанавливать отдельные параметры времени выполнения.) Пробелы в этой строке воспринимаются как разделяющие аргументы, если перед ними нет обратной косой черты (\); чтобы представить обратную косую черту буквально, продублируйте её (\\).
replication
Используется для подключения в режиме потоковой репликации, в котором вместо операторов SQL может выполняться небольшой набор команд репликации. Допустимые значения: true, false (по умолчанию) и database. За подробностями обратитесь к Разделу 53.4.
В дополнение к ним могут задаваться и другие параметры. Имена параметров, начинающиеся с _pq_., резервируются для использования в расширениях протокола, а остальные воспринимаются как параметры времени выполнения, передаваемые во время запуска серверному процессу. Такие параметры будут применяться при запуске серверного процесса (после разбора аргументов командной строки, если они есть) и будут действовать как параметры сеанса по умолчанию.
Значение параметра.
Указывает, что это сообщение представляет команду Sync.
Длина содержимого сообщения в байтах, включая само поле длины.
Указывает, что это сообщение завершает сеанс.
Длина содержимого сообщения в байтах, включая само поле длины.