Postgres Pro Standard : Документация: 18: 55.7. Форматы сообщений : Компания Postgres Professional

55.7. Форматы сообщений
Пред.	Наверх	Глава 55. Клиент-серверный протокол	Начало	След.

55.7. Форматы сообщений #

В этом разделе подробно описывается формат каждого сообщения. Все сообщения помечены символами, обозначающими, какая сторона может их передавать: клиент (F), сервер (B) или обе стороны (F & B). Заметьте, что хотя каждое сообщение включает счётчик байт в начале, большинство сообщений определены так, чтобы конец сообщения можно было найти, не обращаясь к счётчику байт. Это сделано по историческим причинам, поскольку в изначальном теперь устаревшем протоколе версии 2 не было поля с явно определённой длиной. Это также помогает проверять корректность сообщений.

AuthenticationOk (B) #

Byte1('R'): Указывает, что это сообщение представляет запрос аутентификации.
Int32(8): Длина содержимого сообщения в байтах, включая само поле длины.
Int32(0): Показывает, что проверка подлинности прошла успешно.

AuthenticationKerberosV5 (B) #

Byte1('R'): Указывает, что это сообщение представляет запрос аутентификации.
Int32(8): Длина содержимого сообщения в байтах, включая само поле длины.
Int32(2): Указывает, что требуется проверка подлинности по протоколу Kerberos V5.

AuthenticationCleartextPassword (B) #

Byte1('R'): Указывает, что это сообщение представляет запрос аутентификации.
Int32(8): Длина содержимого сообщения в байтах, включая само поле длины.
Int32(3): Указывает, что требуется пароль, передаваемый открытым текстом.

AuthenticationMD5Password (B) #

Byte1('R'): Указывает, что это сообщение представляет запрос аутентификации.
Int32(12): Длина содержимого сообщения в байтах, включая само поле длины.
Int32(5): Указывает, что требуется пароль, преобразованный в хеш MD5.
Byte4: Значение соли, с которым должен хешироваться пароль.

AuthenticationGSS (B) #

Byte1('R'): Указывает, что это сообщение представляет запрос аутентификации.
Int32(8): Длина содержимого сообщения в байтах, включая само поле длины.
Int32(7): Указывает, что требуется проверка подлинности на базе GSSAPI.

AuthenticationGSSContinue (B) #

Byte1('R'): Указывает, что это сообщение представляет запрос аутентификации.
Int32: Длина содержимого сообщения в байтах, включая само поле длины.
Int32(8): Указывает, что это сообщение содержит данные GSSAPI или SSPI.
Byten: Данные аутентификации для GSSAPI или SSPI.

AuthenticationSSPI (B) #

Byte1('R'): Указывает, что это сообщение представляет запрос аутентификации.
Int32(8): Длина содержимого сообщения в байтах, включая само поле длины.
Int32(9): Указывает, что требуется проверка подлинности на базе SSPI.

AuthenticationSASL (B) #

Byte1('R'): Указывает, что это сообщение представляет запрос аутентификации.
Int32: Длина содержимого сообщения в байтах, включая само поле длины.
Int32(10): Указывает, что требуется проверка подлинности на базе SASL.

Тело сообщения содержит список механизмов аутентификации SASL в порядке предпочтений сервера. За последним именем механизма аутентификации должен идти завершающий нулевой байт. Для каждого механизма передаётся:

String: Имя механизма аутентификации SASL.

AuthenticationSASLContinue (B) #

Byte1('R'): Указывает, что это сообщение представляет запрос аутентификации.
Int32: Длина содержимого сообщения в байтах, включая само поле длины.
Int32(11): Указывает, что это сообщение содержит данные вызова SASL.
Byten: Данные SASL, специфичные для применяемого механизма SASL.

AuthenticationSASLFinal (B) #

Byte1('R'): Указывает, что это сообщение представляет запрос аутентификации.
Int32: Длина содержимого сообщения в байтах, включая само поле длины.
Int32(12): Указывает, что аутентификация SASL завершена.
Byten: «Дополнительные данные» результата SASL, специфичные для применяемого механизма SASL.

BackendKeyData (B) #

Byte1('K')

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

Int32

Длина содержимого сообщения в байтах, включая само поле длины.

Int32

PID обслуживающего процесса.

Byten

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

Минимальная длина ключа составляет 4 байта, а максимальная — 256 байт. Сейчас сервер Postgres Pro передаёт только ключи длиной до 32 байт, но увеличенная максимальная длина позволяет будущим версиям сервера, а также пулам соединений и другим компонентам среднего слоя использовать более длинные ключи. Один из возможных вариантов использования — добавление в ключ сервера дополнительной информации. По этой причине не рекомендуется использовать в среднем слое ключи с максимальной длиной на случай, если друг на друга наложится несколько приложений среднего слоя, в каждом из которых будут ключи с дополнительной информацией.

До протокола версии 3.2 всегда использовался секретный ключ длиной 4 байта.

Bind (F) #

Byte1('B'): Указывает, что это сообщение представляет команду Bind.
Int32: Длина содержимого сообщения в байтах, включая само поле длины.
String: Имя целевого портала (пустая строка выбирает безымянный портал).
String: Имя исходного подготовленного оператора (пустая строка выбирает безымянный подготовленный оператор).
Int16: Количество кодов форматов следующих параметров (обозначается ниже символом C). Может быть нулевым, что показывает, что параметры отсутствуют или все параметры передаются в формате по умолчанию (текстовом); либо равняться одному, в этом случае указанный один код формата применяется ко всем параметрам; либо может равняться действительному количеству параметров.
Int16[C]: Коды форматов параметров. В настоящее время допускаются коды ноль (текстовый формат) и один (двоичный).
Int16: Количество следующих значений параметров (может быть нулевым). Оно должно совпадать с количеством параметров, требующихся для запроса.

Затем для каждого параметра идёт следующая пара полей:

Int32: Длина значения параметра, в байтах (само поле длины не считается). Может быть нулевой. В качестве особого значения, -1 представляет значение NULL. В случае с NULL никакие байты значений далее не следуют.
Byten: Значение параметра в формате, определённом соответствующим кодом формата. Переменная n задаёт длину значения.

За последним параметром идёт следующее поле:

Int16: Количество кодов формата для следующих столбцов результата (обозначается ниже символом R). Может быть нулевым, что показывает, что столбцы результата отсутствуют или для всех столбцов должен использоваться формат по умолчанию (текстовый), либо равняться одному, в этом случае указанный один код формата применяется ко всем столбцам (если они есть), либо может равняться действительному количеству столбцов результата запроса.
Int16[R]: Коды форматов столбцов результата. В настоящее время допускаются коды ноль (текстовый формат) и один (двоичный).

BindComplete (B) #

Byte1('2'): Указывает, что это сообщение, сигнализирующее о завершении Bind.
Int32(4): Длина содержимого сообщения в байтах, включая само поле длины.

CancelRequest (F) #

Int32: Длина содержимого сообщения в байтах, включая само поле длины.
Int32(80877102): Код запроса отмены. Это специально выбранное значение содержит 1234 в старших 16 битах и 5678 в младших 16 битах. (Во избежание неоднозначности этот код не должен совпадать с номером версии протокола.)
Int32: PID целевого обслуживающего процесса.
Byten: Секретный ключ для целевого обслуживающего процесса. Это поле завершается в конце сообщения, определённом полем длины. Максимальная длина ключа — 256 байт.

До протокола версии 3.2 всегда использовался секретный ключ длиной 4 байта.

Close (F) #

Byte1('C'): Указывает, что это сообщение представляет команду Close.
Int32: Длина содержимого сообщения в байтах, включая само поле длины.
Byte1: 'S' для закрытия подготовленного оператора, 'P' для закрытия портала.
String: Имя подготовленного оператора или портала, который должен быть закрыт (пустая строка выбирает безымянный подготовленный оператор или портал).

CloseComplete (B) #

Byte1('3'): Указывает, что это сообщение, сигнализирующее о завершении Close.
Int32(4): Длина содержимого сообщения в байтах, включая само поле длины.

CommandComplete (B) #

Byte1('C')

Указывает, что это сообщение об успешном завершении команды.

Int32

Длина содержимого сообщения в байтах, включая само поле длины.

String

Тег команды. Обычно это одно слово, обозначающее завершённую команду SQL.

Для команды INSERT в качестве тега передаётся INSERT oid число_строк, где число_строк — количество вставленных строк. В поле oid передавался идентификатор объекта вставленной строки, когда число_строк было равно 1 и в целевой таблице содержались OID; таким образом, сейчас oid всегда равняется 0.

Для команды DELETE в качестве тега передаётся DELETE число_строк, где число_строк — количество удалённых строк.

Для команды UPDATE в качестве тега передаётся UPDATE число_строк, где число_строк — количество изменённых строк.

Для команды MERGE в качестве тега передаётся MERGE число_строк, где число_строк — количество вставленных, изменённых или удалённых строк.

Для команды SELECT или CREATE TABLE AS в качестве тега передаётся SELECT число_строк, где число_строк — число полученных строк.

Для команды MOVE в качестве тега передаётся MOVE число_строк, где число_строк — количество строк, на которое изменилась позиция курсора.

Для команды FETCH в качестве тега передаётся FETCH число_строк, где число_строк — количество строк, полученное через курсор.

Для команды COPY в качестве тега передаётся COPY число_строк, где число_строк — количество скопированных строк. (Заметьте: число строк выводится, начиная только с PostgreSQL 8.2.)

CopyData (F & B) #

Byte1('d'): Указывает, что в этом сообщении передаются данные COPY.
Int32: Длина содержимого сообщения в байтах, включая само поле длины.
Byten: Данные, образующие часть информационного потока COPY. Сообщения от сервера всегда соответствуют отдельным строкам данных, но сообщения, передаваемые клиентами, могут разделять поток произвольным образом.

CopyDone (F & B) #

Byte1('c'): Указывает, что это сообщение, сигнализирующее о завершении COPY.
Int32(4): Длина содержимого сообщения в байтах, включая само поле длины.

CopyFail (F) #

Byte1('f'): Указывает, что это сообщение, сигнализирующее об ошибке операции COPY.
Int32: Длина содержимого сообщения в байтах, включая само поле длины.
String: Сообщение об ошибке, описывающее причину сбоя операции.

CopyInResponse (B) #

Byte1('G'): Указывает, что это сообщение является ответом на запуск входящего копирования. Получив его, клиент начинает передавать данные на вход операции копирования (если клиент не готов к этому, он передаёт сообщение CopyFail).
Int32: Длина содержимого сообщения в байтах, включая само поле длины.
Int8: Значение 0 указывает, что для всей операции COPY применяется текстовый формат (строки разделяются символами новой строки, столбцы разделяются символами-разделителями и т. д.). Значение 1 указывает, что для всей операции копирования применяется двоичный формат (подобный формату DataRow). За дополнительными сведениями обратитесь к COPY.
Int16: Количество столбцов в копируемых данных (ниже обозначается символом N).
Int16[N]: Коды формата для каждого столбца. В настоящее время допускаются коды ноль (текстовый формат) и один (двоичный). Если общий формат копирования — текстовый, все эти коды должны быть нулевыми.

CopyOutResponse (B) #

Byte1('H'): Указывает, что это сообщение является ответом на запуск исходящего копирования. За этим сообщением следуют данные, исходящие со стороны сервера.
Int32: Длина содержимого сообщения в байтах, включая само поле длины.
Int8: Значение 0 указывает, что для всей операции COPY применяется текстовый формат (строки разделяются символами новой строки, столбцы разделяются символами-разделителями и т. д.). Значение 1 указывает, что для всей операции копирования применяется двоичный формат (подобный формату DataRow). За дополнительными сведениями обратитесь к COPY.
Int16: Количество столбцов в копируемых данных (ниже обозначается символом N).
Int16[N]: Коды формата для каждого столбца. В настоящее время допускаются коды ноль (текстовый формат) и один (двоичный). Если общий формат копирования — текстовый, все эти коды должны быть нулевыми.

CopyBothResponse (B) #

Byte1('W'): Указывает, что это сообщение является ответом на запуск двустороннего копирования. Это сообщение используется только для потоковой репликации.
Int32: Длина содержимого сообщения в байтах, включая само поле длины.
Int8: Значение 0 указывает, что для всей операции COPY применяется текстовый формат (строки разделяются символами новой строки, столбцы разделяются символами-разделителями и т. д.). Значение 1 указывает, что для всей операции копирования применяется двоичный формат (подобный формату DataRow). За дополнительными сведениями обратитесь к COPY.
Int16: Количество столбцов в копируемых данных (ниже обозначается символом N).
Int16[N]: Коды формата для каждого столбца. В настоящее время допускаются коды ноль (текстовый формат) и один (двоичный). Если общий формат копирования — текстовый, все эти коды должны быть нулевыми.

DataRow (B) #

Byte1('D'): Указывает, что в этом сообщении передаётся строка данных.
Int32: Длина содержимого сообщения в байтах, включая само поле длины.
Int16: Количество последующих значений столбцов (может быть нулевым).

Затем для каждого столбца идёт следующая пара полей:

Int32: Длина значения столбца, в байтах (само поле длины не считается). Может быть нулевой. В качестве особого значения, -1 представляет значение NULL. В случае с NULL никакие байты значений далее не следуют.
Byten: Значение столбца в формате, определённом соответствующим кодом формата. Переменная n задаёт длину значения.

Describe (F) #

Byte1('D'): Указывает, что это сообщение представляет команду Describe.
Int32: Длина содержимого сообщения в байтах, включая само поле длины.
Byte1: 'S' для получения описания подготовленного оператора, 'P' — портала.
String: Имя подготовленного оператора или портала, описание которого запрашивается (пустая строка выбирает безымянный подготовленный оператор или портал).

EmptyQueryResponse (B) #

Byte1('I'): Указывает, что это сообщение является ответом на пустую строку запроса. (Это сообщение заменяет CommandComplete.)
Int32(4): Длина содержимого сообщения в байтах, включая само поле длины.

ErrorResponse (B) #

Byte1('E'): Указывает, что это сообщение ошибки.
Int32: Длина содержимого сообщения в байтах, включая само поле длины.

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

Byte1: Код, задающий тип поля; ноль обозначает конец сообщения, после которого ничего нет. Типы полей, определённые в настоящее время, перечислены в Разделе 55.8. Так как в будущем могут появиться другие типы полей, клиенты должны просто игнорировать поля нераспознанного типа.
String: Значение поля.

Execute (F) #

Byte1('E'): Указывает, что это сообщение представляет команду Execute.
Int32: Длина содержимого сообщения в байтах, включая само поле длины.
String: Имя портала, подлежащего выполнению (пустая строка выбирает безымянный портал).
Int32: Максимальное число строк, которое должно быть возвращено, если портал содержит запрос, возвращающий строки (в противном случае игнорируется). Ноль означает «без ограничения».

Flush (F) #

Byte1('H'): Указывает, что это сообщение представляет команду Flush.
Int32(4): Длина содержимого сообщения в байтах, включая само поле длины.

FunctionCall (F) #

Byte1('F'): Указывает, что это сообщение представляет вызов функции.
Int32: Длина содержимого сообщения в байтах, включая само поле длины.
Int32: Задаёт идентификатор объекта вызываемой функции.
Int16: Количество кодов форматов следующих аргументов (обозначается ниже символом C). Может быть нулевым, что показывает, что аргументы отсутствуют или все аргументы передаются в формате по умолчанию (текстовом); либо равняться одному, в этом случае указанный один код формата применяется ко всем аргументами, либо может равняться действительному количеству аргументов.
Int16[C]: Коды форматов аргументов. В настоящее время допускаются коды ноль (текстовый формат) и один (двоичный).
Int16: Задаёт число аргументов, передаваемых функции.

Затем для каждого аргумента идёт следующая пара полей:

Int32: Длина значения аргумента, в байтах (само поле длины не считается). Может быть нулевой. В качестве особого значения, -1 представляет значение NULL. В случае с NULL никакие байты значений далее не следуют.
Byten: Значение аргумента, в формате, определённом соответствующим кодом формата. Переменная n задаёт длину значения.

За последним аргументом идёт следующее поле:

Int16: Код формата результата функции. В настоящее время допускается код ноль (текстовый формат) и один (двоичный).

FunctionCallResponse (B) #

Byte1('V'): Указывает, что в этом сообщении передаётся результат вызова функции.
Int32: Длина содержимого сообщения в байтах, включая само поле длины.
Int32: Длина значения результата функции, в байтах (само поле длины не считается). Может быть нулевой. В качестве особого значения, -1 представляет значение NULL. В случае с NULL никакие байты значения далее не следуют.
Byten: Значение результата функции в формате, определённом соответствующим кодом формата. Переменная n задаёт длину значения.

GSSENCRequest (F) #

Int32(8): Длина содержимого сообщения в байтах, включая само поле длины.
Int32(80877104): Код запроса GSSAPI Encryption. Это специально выбранное значение содержит 1234 в старших 16 битах и 5680 в младших 16 битах. (Во избежание неоднозначности этот код не должен совпадать с номером версии протокола.)

GSSResponse (F) #

Byte1('p'): Обозначает это сообщение как ответ GSSAPI или SSPI. Заметьте, что оно также применяется для ответов SASL и при аутентификации по паролю. Точный тип сообщения можно определить из контекста.
Int32: Длина содержимого сообщения в байтах, включая само поле длины.
Byten: Данные сообщения, специфичные для GSSAPI/SSPI.

NegotiateProtocolVersion (B) #

Byte1('v'): Указывает, что это сообщение согласования версии протокола.
Int32: Длина содержимого сообщения в байтах, включая само поле длины.
Int32: Новейшая младшая версия протокола, поддерживаемая сервером, для запрошенной клиентом старшей версии.
Int32: Число параметров протокола, не принятых сервером.

Затем для параметров протокола, не принятых сервером, передаётся:

String: Имя параметра.

NoData (B) #

Byte1('n'): Указывает, что это сообщение сигнализирует об отсутствии данных.
Int32(4): Длина содержимого сообщения в байтах, включая само поле длины.

NoticeResponse (B) #

Byte1('N'): Указывает, что это сообщение представляет замечание.
Int32: Длина содержимого сообщения в байтах, включая само поле длины.

Byte1: Код, задающий тип поля; ноль обозначает конец сообщения, после которого ничего нет. Типы полей, определённые в настоящее время, перечислены в Разделе 55.8. Так как в будущем могут появиться другие типы полей, клиенты должны просто игнорировать поля нераспознанного типа.
String: Значение поля.

NotificationResponse (B) #

Byte1('A'): Указывает, что это сообщение представляет уведомление.
Int32: Длина содержимого сообщения в байтах, включая само поле длины.
Int32: PID обслуживающего процесса, отправляющего уведомление.
String: Имя канала, для которого было выдано уведомление.
String: Строка «сообщения», сопровождающего уведомление.

ParameterDescription (B) #

Byte1('t'): Указывает, что это сообщение представляет описание параметра.
Int32: Длина содержимого сообщения в байтах, включая само поле длины.
Int16: Количество параметров для оператора (может быть нулевым).

Затем для каждого параметра передаётся:

Int32: Задаёт идентификатор объекта типа данных параметра.

ParameterStatus (B) #

Byte1('S'): Указывает, что в этом сообщении передаётся состояние параметра времени выполнения.
Int32: Длина содержимого сообщения в байтах, включая само поле длины.
String: Имя параметра времени выполнения, состояние которого передаётся.
String: Текущее значение параметра.

Parse (F) #

Byte1('P'): Указывает, что это сообщение представляет команду Parse.
Int32: Длина содержимого сообщения в байтах, включая само поле длины.
String: Имя целевого подготовленного оператора (пустая строка выбирает безымянный подготовленный оператор).
String: Строка запроса, которая должна быть разобрана.
Int16: Количество типов параметров (может быть нулевым). Заметьте, что это значение представляет не число параметров, которые могут фигурировать в строке запроса, а число параметров, для которых клиент хочет предопределить типы.

Затем для каждого параметра передаётся:

Int32: Задаёт идентификатор объекта типа данных параметра. Указание нулевого значения равносильно отсутствию указания типа.

ParseComplete (B) #

Byte1('1'): Указывает, что это сообщение, сигнализирующее о завершении Parse.
Int32(4): Длина содержимого сообщения в байтах, включая само поле длины.

PasswordMessage (F) #

Byte1('p'): Обозначает это сообщение как ответ SASL. Заметьте, что оно также применяется для ответов GSSAPI, SSPI и SASL. Точный тип сообщения можно определить из контекста.
Int32: Длина содержимого сообщения в байтах, включая само поле длины.
String: Пароль (зашифрованный, если требуется).

PortalSuspended (B) #

Byte1('s'): Указывает, что это сообщение сигнализирует о приостановке портала. Заметьте, что оно выдаётся только при достижении ограничения числа строк, заданного в сообщении Execute.
Int32(4): Длина содержимого сообщения в байтах, включая само поле длины.

Query (F) #

Byte1('Q'): Указывает, что это сообщение представляет простой протокол запросов.
Int32: Длина содержимого сообщения в байтах, включая само поле длины.
String: Собственно строка запроса.

ReadyForQuery (B) #

Byte1('Z'): Определяет тип сообщения. Сообщение ReadyForQuery передаётся, когда сервер готов к новому циклу запросов.
Int32(5): Длина содержимого сообщения в байтах, включая само поле длины.
Byte1: Индикатор текущего состояния транзакции на сервере. Возможные значения: 'I', транзакция неактивна (вне блока транзакции), 'T' в блоке транзакции, либо 'E' в блоке прерванной транзакции (запросы не будут обрабатываться до завершения блока).

RowDescription (B) #

Byte1('T'): Указывает, что это сообщение представляет описание строки.
Int32: Длина содержимого сообщения в байтах, включая само поле длины.
Int16: Задаёт количество полей в строке (может быть нулевым).

Затем для каждого поля передаётся:

String: Имя поля.
Int32: Если поле связано со столбцом определённой таблицы, идентификатор объекта этой таблицы; в противном случае — ноль.
Int16: Если поле связано со столбцом определённой таблицы, номер атрибута для этого столбца; в противном случае — ноль.
Int32: Идентификатор объекта типа данных поля.
Int16: Размер типа данных (см. pg_type.typlen). Заметьте, что отрицательные значения показывают, что тип имеет переменную длину.
Int32: Модификатор типа (см. pg_attribute.atttypmod). Смысл этого модификатора зависит от типа.
Int16: Код формата, используемого для поля. В настоящее время допускаются коды ноль (текстовый формат) и один (двоичный). В сообщении RowDescription, возвращаемом вариацией Describe для оператора, код формата ещё не известен и всегда будет нулевым.

SASLInitialResponse (F) #

Byte1('p'): Обозначает это сообщение как начальный ответ SASL. Заметьте, что оно также применяется для ответов GSSAPI, SSPI и при аутентификации по паролю. Точный тип сообщения определяется из контекста.
Int32: Длина содержимого сообщения в байтах, включая само поле длины.
String: Имя механизма аутентификации SASL, выбранного клиентом.
Int32: Длина последующего сообщения «Начальный ответ клиента», специфичного для механизма SASL, или -1, если начального ответа нет.
Byten: «Начальный ответ», специфичный для механизма SASL.

SASLResponse (F) #

Byte1('p'): Обозначает это сообщение как ответ SASL. Заметьте, что оно также применяется для ответов GSSAPI, SSPI и при аутентификации по паролю. Точный тип сообщения можно определить из контекста.
Int32: Длина содержимого сообщения в байтах, включая само поле длины.
Byten: Данные сообщения, специфичные для механизма SASL.

SSLRequest (F) #

Int32(8): Длина содержимого сообщения в байтах, включая само поле длины.
Int32(80877103): Код запроса SSL. Это специально выбранное значение содержит 1234 в старших 16 битах и 5679 в младших 16 битах. (Во избежание неоднозначности этот код не должен совпадать с номером версии протокола.)

StartupMessage (F) #

Int32: Длина содержимого сообщения в байтах, включая само поле длины.
Int32(196610): Номер версии протокола. В старших 16 битах задаётся старший номер версии (3 для протокола, описываемого здесь). В младших 16 битах задаётся младший номер версии (2 для протокола, описываемого здесь).

За номером версии протокола следует одна или несколько пар из имени параметра и строки значения. За последней парой имя/значение должен следовать нулевой байт. Передаваться параметры могут в любом порядке. Обязательным является только параметр user, остальные могут отсутствовать. Каждый параметр задаётся так:

String

Имя параметра. В настоящее время принимаются имена:

user: Имя пользователя баз данных, с которым выполняется подключение. Является обязательным, значения по умолчанию нет.
database: База данных, к которой выполняется подключение. По умолчанию подставляется имя пользователя.
options: Аргументы командной строки для обслуживающего процесса. (Этот способ считается устаревшим; теперь следует устанавливать отдельные параметры времени выполнения.) Пробелы в этой строке воспринимаются как разделяющие аргументы, если перед ними нет обратной косой черты (\); чтобы представить обратную косую черту буквально, продублируйте её (\\).
replication: Используется для подключения в режиме потоковой репликации, в котором вместо операторов SQL может выполняться небольшой набор команд репликации. Допустимые значения: true, false (по умолчанию) и database. За подробностями обратитесь к Разделу 55.4.

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

String

Значение параметра.

Sync (F) #

Byte1('S'): Указывает, что это сообщение представляет команду Sync.
Int32(4): Длина содержимого сообщения в байтах, включая само поле длины.

Terminate (F) #

Byte1('X'): Указывает, что это сообщение завершает сеанс.
Int32(4): Длина содержимого сообщения в байтах, включая само поле длины.

Пред.	Наверх	След.
55.6. Типы данных в сообщениях	Начало	55.8. Поля сообщений с ошибками и замечаниями

55.7. Message Formats
Prev	Up	Chapter 55. Frontend/Backend Protocol	Home	Next

55.7. Message Formats #

This section describes the detailed format of each message. Each is marked to indicate that it can be sent by a frontend (F), a backend (B), or both (F & B). Notice that although each message includes a byte count at the beginning, most messages are defined so that the message end can be found without reference to the byte count. This is for historical reasons, as the original, now-obsolete protocol version 2 did not have an explicit length field. It also aids validity checking though.

AuthenticationOk (B) #

Byte1('R'): Identifies the message as an authentication request.
Int32(8): Length of message contents in bytes, including self.
Int32(0): Specifies that the authentication was successful.

AuthenticationKerberosV5 (B) #

Byte1('R'): Identifies the message as an authentication request.
Int32(8): Length of message contents in bytes, including self.
Int32(2): Specifies that Kerberos V5 authentication is required.

AuthenticationCleartextPassword (B) #

Byte1('R'): Identifies the message as an authentication request.
Int32(8): Length of message contents in bytes, including self.
Int32(3): Specifies that a clear-text password is required.

AuthenticationMD5Password (B) #

Byte1('R'): Identifies the message as an authentication request.
Int32(12): Length of message contents in bytes, including self.
Int32(5): Specifies that an MD5-encrypted password is required.
Byte4: The salt to use when encrypting the password.

AuthenticationGSS (B) #

Byte1('R'): Identifies the message as an authentication request.
Int32(8): Length of message contents in bytes, including self.
Int32(7): Specifies that GSSAPI authentication is required.

AuthenticationGSSContinue (B) #

Byte1('R'): Identifies the message as an authentication request.
Int32: Length of message contents in bytes, including self.
Int32(8): Specifies that this message contains GSSAPI or SSPI data.
Byten: GSSAPI or SSPI authentication data.

AuthenticationSSPI (B) #

Byte1('R'): Identifies the message as an authentication request.
Int32(8): Length of message contents in bytes, including self.
Int32(9): Specifies that SSPI authentication is required.

AuthenticationSASL (B) #

Byte1('R'): Identifies the message as an authentication request.
Int32: Length of message contents in bytes, including self.
Int32(10): Specifies that SASL authentication is required.

The message body is a list of SASL authentication mechanisms, in the server's order of preference. A zero byte is required as terminator after the last authentication mechanism name. For each mechanism, there is the following:

String: Name of a SASL authentication mechanism.

AuthenticationSASLContinue (B) #

Byte1('R'): Identifies the message as an authentication request.
Int32: Length of message contents in bytes, including self.
Int32(11): Specifies that this message contains a SASL challenge.
Byten: SASL data, specific to the SASL mechanism being used.

AuthenticationSASLFinal (B) #

Byte1('R'): Identifies the message as an authentication request.
Int32: Length of message contents in bytes, including self.
Int32(12): Specifies that SASL authentication has completed.
Byten: SASL outcome "additional data", specific to the SASL mechanism being used.

BackendKeyData (B) #

Byte1('K')

Identifies the message as cancellation key data. The frontend must save these values if it wishes to be able to issue CancelRequest messages later.

Int32

Length of message contents in bytes, including self.

Int32

The process ID of this backend.

Byten

The secret key of this backend. This field extends to the end of the message, indicated by the length field.

The minimum and maximum key length are 4 and 256 bytes, respectively. The Postgres Pro server only sends keys up to 32 bytes, but the larger maximum size allows for future server versions, as well as connection poolers and other middleware, to use longer keys. One possible use case is augmenting the server's key with extra information. Middleware is therefore also encouraged to not use up all of the bytes, in case multiple middleware applications are layered on top of each other, each of which may wrap the key with extra data.

Before protocol version 3.2, the secret key was always 4 bytes long.

Bind (F) #

Byte1('B'): Identifies the message as a Bind command.
Int32: Length of message contents in bytes, including self.
String: The name of the destination portal (an empty string selects the unnamed portal).
String: The name of the source prepared statement (an empty string selects the unnamed prepared statement).
Int16: The number of parameter format codes that follow (denoted C below). This can be zero to indicate that there are no parameters or that the parameters all use the default format (text); or one, in which case the specified format code is applied to all parameters; or it can equal the actual number of parameters.
Int16[C]: The parameter format codes. Each must presently be zero (text) or one (binary).
Int16: The number of parameter values that follow (possibly zero). This must match the number of parameters needed by the query.

Next, the following pair of fields appear for each parameter:

Int32: The length of the parameter value, in bytes (this count does not include itself). Can be zero. As a special case, -1 indicates a NULL parameter value. No value bytes follow in the NULL case.
Byten: The value of the parameter, in the format indicated by the associated format code. n is the above length.

After the last parameter, the following fields appear:

Int16: The number of result-column format codes that follow (denoted R below). This can be zero to indicate that there are no result columns or that the result columns should all use the default format (text); or one, in which case the specified format code is applied to all result columns (if any); or it can equal the actual number of result columns of the query.
Int16[R]: The result-column format codes. Each must presently be zero (text) or one (binary).

BindComplete (B) #

Byte1('2'): Identifies the message as a Bind-complete indicator.
Int32(4): Length of message contents in bytes, including self.

CancelRequest (F) #

Int32: Length of message contents in bytes, including self.
Int32(80877102): The cancel request code. The value is chosen to contain 1234 in the most significant 16 bits, and 5678 in the least significant 16 bits. (To avoid confusion, this code must not be the same as any protocol version number.)
Int32: The process ID of the target backend.
Byten: The secret key for the target backend. This field extends to the end of the message, indicated by the length field. The maximum key length is 256 bytes.

Before protocol version 3.2, the secret key was always 4 bytes long.

Close (F) #

Byte1('C'): Identifies the message as a Close command.
Int32: Length of message contents in bytes, including self.
Byte1: 'S' to close a prepared statement; or 'P' to close a portal.
String: The name of the prepared statement or portal to close (an empty string selects the unnamed prepared statement or portal).

CloseComplete (B) #

Byte1('3'): Identifies the message as a Close-complete indicator.
Int32(4): Length of message contents in bytes, including self.

CommandComplete (B) #

Byte1('C')

Identifies the message as a command-completed response.

Int32

Length of message contents in bytes, including self.

String

The command tag. This is usually a single word that identifies which SQL command was completed.

For an INSERT command, the tag is INSERT oid rows, where rows is the number of rows inserted. oid used to be the object ID of the inserted row if rows was 1 and the target table had OIDs, but OIDs system columns are not supported anymore; therefore oid is always 0.

For a DELETE command, the tag is DELETE rows where rows is the number of rows deleted.

For an UPDATE command, the tag is UPDATE rows where rows is the number of rows updated.

For a MERGE command, the tag is MERGE rows where rows is the number of rows inserted, updated, or deleted.

For a SELECT or CREATE TABLE AS command, the tag is SELECT rows where rows is the number of rows retrieved.

For a MOVE command, the tag is MOVE rows where rows is the number of rows the cursor's position has been changed by.

For a FETCH command, the tag is FETCH rows where rows is the number of rows that have been retrieved from the cursor.

For a COPY command, the tag is COPY rows where rows is the number of rows copied. (Note: the row count appears only in PostgreSQL 8.2 and later.)

CopyData (F & B) #

Byte1('d'): Identifies the message as COPY data.
Int32: Length of message contents in bytes, including self.
Byten: Data that forms part of a COPY data stream. Messages sent from the backend will always correspond to single data rows, but messages sent by frontends might divide the data stream arbitrarily.

CopyDone (F & B) #

Byte1('c'): Identifies the message as a COPY-complete indicator.
Int32(4): Length of message contents in bytes, including self.

CopyFail (F) #

Byte1('f'): Identifies the message as a COPY-failure indicator.
Int32: Length of message contents in bytes, including self.
String: An error message to report as the cause of failure.

CopyInResponse (B) #

Byte1('G'): Identifies the message as a Start Copy In response. The frontend must now send copy-in data (if not prepared to do so, send a CopyFail message).
Int32: Length of message contents in bytes, including self.
Int8: 0 indicates the overall COPY format is textual (rows separated by newlines, columns separated by separator characters, etc.). 1 indicates the overall copy format is binary (similar to DataRow format). See COPY for more information.
Int16: The number of columns in the data to be copied (denoted N below).
Int16[N]: The format codes to be used for each column. Each must presently be zero (text) or one (binary). All must be zero if the overall copy format is textual.

CopyOutResponse (B) #

Byte1('H'): Identifies the message as a Start Copy Out response. This message will be followed by copy-out data.
Int32: Length of message contents in bytes, including self.
Int8: 0 indicates the overall COPY format is textual (rows separated by newlines, columns separated by separator characters, etc.). 1 indicates the overall copy format is binary (similar to DataRow format). See COPY for more information.
Int16: The number of columns in the data to be copied (denoted N below).
Int16[N]: The format codes to be used for each column. Each must presently be zero (text) or one (binary). All must be zero if the overall copy format is textual.

CopyBothResponse (B) #

Byte1('W'): Identifies the message as a Start Copy Both response. This message is used only for Streaming Replication.
Int32: Length of message contents in bytes, including self.
Int8: 0 indicates the overall COPY format is textual (rows separated by newlines, columns separated by separator characters, etc.). 1 indicates the overall copy format is binary (similar to DataRow format). See COPY for more information.
Int16: The number of columns in the data to be copied (denoted N below).
Int16[N]: The format codes to be used for each column. Each must presently be zero (text) or one (binary). All must be zero if the overall copy format is textual.

DataRow (B) #

Byte1('D'): Identifies the message as a data row.
Int32: Length of message contents in bytes, including self.
Int16: The number of column values that follow (possibly zero).

Next, the following pair of fields appear for each column:

Int32: The length of the column value, in bytes (this count does not include itself). Can be zero. As a special case, -1 indicates a NULL column value. No value bytes follow in the NULL case.
Byten: The value of the column, in the format indicated by the associated format code. n is the above length.

Describe (F) #

Byte1('D'): Identifies the message as a Describe command.
Int32: Length of message contents in bytes, including self.
Byte1: 'S' to describe a prepared statement; or 'P' to describe a portal.
String: The name of the prepared statement or portal to describe (an empty string selects the unnamed prepared statement or portal).

EmptyQueryResponse (B) #

Byte1('I'): Identifies the message as a response to an empty query string. (This substitutes for CommandComplete.)
Int32(4): Length of message contents in bytes, including self.

ErrorResponse (B) #

Byte1('E'): Identifies the message as an error.
Int32: Length of message contents in bytes, including self.

The message body consists of one or more identified fields, followed by a zero byte as a terminator. Fields can appear in any order. For each field there is the following:

Byte1: A code identifying the field type; if zero, this is the message terminator and no string follows. The presently defined field types are listed in Section 55.8. Since more field types might be added in future, frontends should silently ignore fields of unrecognized type.
String: The field value.

Execute (F) #

Byte1('E'): Identifies the message as an Execute command.
Int32: Length of message contents in bytes, including self.
String: The name of the portal to execute (an empty string selects the unnamed portal).
Int32: Maximum number of rows to return, if portal contains a query that returns rows (ignored otherwise). Zero denotes “no limit”.

Flush (F) #

Byte1('H'): Identifies the message as a Flush command.
Int32(4): Length of message contents in bytes, including self.

FunctionCall (F) #

Byte1('F'): Identifies the message as a function call.
Int32: Length of message contents in bytes, including self.
Int32: Specifies the object ID of the function to call.
Int16: The number of argument format codes that follow (denoted C below). This can be zero to indicate that there are no arguments or that the arguments all use the default format (text); or one, in which case the specified format code is applied to all arguments; or it can equal the actual number of arguments.
Int16[C]: The argument format codes. Each must presently be zero (text) or one (binary).
Int16: Specifies the number of arguments being supplied to the function.

Next, the following pair of fields appear for each argument:

Int32: The length of the argument value, in bytes (this count does not include itself). Can be zero. As a special case, -1 indicates a NULL argument value. No value bytes follow in the NULL case.
Byten: The value of the argument, in the format indicated by the associated format code. n is the above length.

After the last argument, the following field appears:

Int16: The format code for the function result. Must presently be zero (text) or one (binary).

FunctionCallResponse (B) #

Byte1('V'): Identifies the message as a function call result.
Int32: Length of message contents in bytes, including self.
Int32: The length of the function result value, in bytes (this count does not include itself). Can be zero. As a special case, -1 indicates a NULL function result. No value bytes follow in the NULL case.
Byten: The value of the function result, in the format indicated by the associated format code. n is the above length.

GSSENCRequest (F) #

Int32(8): Length of message contents in bytes, including self.
Int32(80877104): The GSSAPI Encryption request code. The value is chosen to contain 1234 in the most significant 16 bits, and 5680 in the least significant 16 bits. (To avoid confusion, this code must not be the same as any protocol version number.)

GSSResponse (F) #

Byte1('p'): Identifies the message as a GSSAPI or SSPI response. Note that this is also used for SASL and password response messages. The exact message type can be deduced from the context.
Int32: Length of message contents in bytes, including self.
Byten: GSSAPI/SSPI specific message data.

NegotiateProtocolVersion (B) #

Byte1('v'): Identifies the message as a protocol version negotiation message.
Int32: Length of message contents in bytes, including self.
Int32: Newest minor protocol version supported by the server for the major protocol version requested by the client.
Int32: Number of protocol options not recognized by the server.

Then, for protocol option not recognized by the server, there is the following:

String: The option name.

NoData (B) #

Byte1('n'): Identifies the message as a no-data indicator.
Int32(4): Length of message contents in bytes, including self.

NoticeResponse (B) #

Byte1('N'): Identifies the message as a notice.
Int32: Length of message contents in bytes, including self.

The message body consists of one or more identified fields, followed by a zero byte as a terminator. Fields can appear in any order. For each field there is the following:

Byte1: A code identifying the field type; if zero, this is the message terminator and no string follows. The presently defined field types are listed in Section 55.8. Since more field types might be added in future, frontends should silently ignore fields of unrecognized type.
String: The field value.

NotificationResponse (B) #

Byte1('A'): Identifies the message as a notification response.
Int32: Length of message contents in bytes, including self.
Int32: The process ID of the notifying backend process.
String: The name of the channel that the notify has been raised on.
String: The “payload” string passed from the notifying process.

ParameterDescription (B) #

Byte1('t'): Identifies the message as a parameter description.
Int32: Length of message contents in bytes, including self.
Int16: The number of parameters used by the statement (can be zero).

Then, for each parameter, there is the following:

Int32: Specifies the object ID of the parameter data type.

ParameterStatus (B) #

Byte1('S'): Identifies the message as a run-time parameter status report.
Int32: Length of message contents in bytes, including self.
String: The name of the run-time parameter being reported.
String: The current value of the parameter.

Parse (F) #

Byte1('P'): Identifies the message as a Parse command.
Int32: Length of message contents in bytes, including self.
String: The name of the destination prepared statement (an empty string selects the unnamed prepared statement).
String: The query string to be parsed.
Int16: The number of parameter data types specified (can be zero). Note that this is not an indication of the number of parameters that might appear in the query string, only the number that the frontend wants to prespecify types for.

Then, for each parameter, there is the following:

Int32: Specifies the object ID of the parameter data type. Placing a zero here is equivalent to leaving the type unspecified.

ParseComplete (B) #

Byte1('1'): Identifies the message as a Parse-complete indicator.
Int32(4): Length of message contents in bytes, including self.

PasswordMessage (F) #

Byte1('p'): Identifies the message as a password response. Note that this is also used for GSSAPI, SSPI and SASL response messages. The exact message type can be deduced from the context.
Int32: Length of message contents in bytes, including self.
String: The password (encrypted, if requested).

PortalSuspended (B) #

Byte1('s'): Identifies the message as a portal-suspended indicator. Note this only appears if an Execute message's row-count limit was reached.
Int32(4): Length of message contents in bytes, including self.

Query (F) #

Byte1('Q'): Identifies the message as a simple query.
Int32: Length of message contents in bytes, including self.
String: The query string itself.

ReadyForQuery (B) #

Byte1('Z'): Identifies the message type. ReadyForQuery is sent whenever the backend is ready for a new query cycle.
Int32(5): Length of message contents in bytes, including self.
Byte1: Current backend transaction status indicator. Possible values are 'I' if idle (not in a transaction block); 'T' if in a transaction block; or 'E' if in a failed transaction block (queries will be rejected until block is ended).

RowDescription (B) #

Byte1('T'): Identifies the message as a row description.
Int32: Length of message contents in bytes, including self.
Int16: Specifies the number of fields in a row (can be zero).

Then, for each field, there is the following:

String: The field name.
Int32: If the field can be identified as a column of a specific table, the object ID of the table; otherwise zero.
Int16: If the field can be identified as a column of a specific table, the attribute number of the column; otherwise zero.
Int32: The object ID of the field's data type.
Int16: The data type size (see pg_type.typlen). Note that negative values denote variable-width types.
Int32: The type modifier (see pg_attribute.atttypmod). The meaning of the modifier is type-specific.
Int16: The format code being used for the field. Currently will be zero (text) or one (binary). In a RowDescription returned from the statement variant of Describe, the format code is not yet known and will always be zero.

SASLInitialResponse (F) #

Byte1('p'): Identifies the message as an initial SASL response. Note that this is also used for GSSAPI, SSPI and password response messages. The exact message type is deduced from the context.
Int32: Length of message contents in bytes, including self.
String: Name of the SASL authentication mechanism that the client selected.
Int32: Length of SASL mechanism specific "Initial Client Response" that follows, or -1 if there is no Initial Response.
Byten: SASL mechanism specific "Initial Response".

SASLResponse (F) #

Byte1('p'): Identifies the message as a SASL response. Note that this is also used for GSSAPI, SSPI and password response messages. The exact message type can be deduced from the context.
Int32: Length of message contents in bytes, including self.
Byten: SASL mechanism specific message data.

SSLRequest (F) #

Int32(8): Length of message contents in bytes, including self.
Int32(80877103): The SSL request code. The value is chosen to contain 1234 in the most significant 16 bits, and 5679 in the least significant 16 bits. (To avoid confusion, this code must not be the same as any protocol version number.)

StartupMessage (F) #

Int32: Length of message contents in bytes, including self.
Int32(196610): The protocol version number. The most significant 16 bits are the major version number (3 for the protocol described here). The least significant 16 bits are the minor version number (2 for the protocol described here).

The protocol version number is followed by one or more pairs of parameter name and value strings. A zero byte is required as a terminator after the last name/value pair. Parameters can appear in any order. user is required, others are optional. Each parameter is specified as:

String

The parameter name. Currently recognized names are:

user: The database user name to connect as. Required; there is no default.
database: The database to connect to. Defaults to the user name.
options: Command-line arguments for the backend. (This is deprecated in favor of setting individual run-time parameters.) Spaces within this string are considered to separate arguments, unless escaped with a backslash (\); write \\ to represent a literal backslash.
replication: Used to connect in streaming replication mode, where a small set of replication commands can be issued instead of SQL statements. Value can be true, false, or database, and the default is false. See Section 55.4 for details.

In addition to the above, other parameters may be listed. Parameter names beginning with _pq_. are reserved for use as protocol extensions, while others are treated as run-time parameters to be set at backend start time. Such settings will be applied during backend start (after parsing the command-line arguments if any) and will act as session defaults.

String

The parameter value.

Sync (F) #

Byte1('S'): Identifies the message as a Sync command.
Int32(4): Length of message contents in bytes, including self.

Terminate (F) #

Byte1('X'): Identifies the message as a termination.
Int32(4): Length of message contents in bytes, including self.

Prev	Up	Next
55.6. Message Data Types	Home	55.8. Error and Notice Message Fields