支持的版本:当前 (17) / 16 / 15 / 14 / 13
开发版本:devel
不支持的版本:12 / 11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0 / 8.4 / 8.3 / 8.2 / 8.1 / 8.0 / 7.4 / 7.3 / 7.2 / 7.1

53.7. 消息格式 #

本节描述每个消息的详细格式。每个消息都标记为指示它可以由前端 (F)、后端 (B) 或两者 (F & B) 发送。请注意,虽然每个消息的开头都包含一个字节计数,但消息格式的定义使得可以在不参考字节计数的情况下找到消息结尾。这有助于有效性检查。(CopyData 消息是一个例外,因为它构成数据流的一部分;任何单个 CopyData 消息的内容本身都无法解释。)

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(12)

消息内容的字节长度,包括自身。

Int32

此后端的进程 ID。

Int32

此后端的密钥。

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(16)

消息内容的字节长度,包括自身。

Int32(80877102)

取消请求代码。该值被选择为在最高有效 16 位中包含 1234,在最低有效 16 位中包含 5678。(为避免混淆,此代码不得与任何协议版本号相同。)

Int32

目标后端的进程 ID。

Int32

目标后端的密钥。

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 rows,其中 rows 是插入的行数。oid 如果 rows 为 1 且目标表具有 OID,则曾经是插入行的对象 ID,但不再支持 OID 系统列;因此 oid 始终为 0。

对于 DELETE 命令,标签为 DELETE rows,其中 rows 是删除的行数。

对于 UPDATE 命令,标签为 UPDATE rows,其中 rows 是更新的行数。

对于 MERGE 命令,标签为 MERGE rows,其中 rows 是插入、更新或删除的行数。

对于 SELECTCREATE TABLE AS 命令,标签为 SELECT rows,其中 rows 是检索的行数。

对于 MOVE 命令,标签为 MOVE rows,其中 rows 是游标位置已更改的行数。

对于 FETCH 命令,标签为 FETCH rows,其中 rows 是从游标检索的行数。

对于 COPY 命令,标签为 COPY rows,其中 rows 是复制的行数。(注意:行计数仅在 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

标识字段类型的代码;如果为零,则为消息终止符,后面不跟字符串。当前定义的字段类型列在第 53.8 节中。由于将来可能会添加更多字段类型,因此前端应静默忽略无法识别类型的字段。

String

字段值。

Execute (F) #
Byte1('E')

标识消息为 Execute 命令。

Int32

消息内容的字节长度,包括自身。

String

要执行的门户的名称(空字符串选择未命名的门户)。

Int32

要返回的最大行数,如果门户包含返回行的查询(否则将被忽略)。零表示 无限制

Flush (F) #
Byte1('H')

标识消息为 Flush 命令。

Int32(4)

消息内容的字节长度,包括自身。

FunctionCall (F) #
Byte1('F')

标识消息为函数调用。

Int32

消息内容的字节长度,包括自身。

Int32

指定要调用的函数的对象 ID。

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加密请求代码。选择该值,使其最高有效 16 位包含 1234,最低有效 16 位包含 5680。(为避免混淆,此代码不得与任何协议版本号相同。)

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

标识字段类型的代码;如果为零,则为消息终止符,后面不跟字符串。当前定义的字段类型列在第 53.8 节中。由于将来可能会添加更多字段类型,因此前端应静默忽略无法识别类型的字段。

String

字段值。

NotificationResponse (B) #
Byte1('A')

标识消息为通知响应。

Int32

消息内容的字节长度,包括自身。

Int32

发出通知的后端进程的进程 ID。

String

已引发通知的通道的名称。

String

从通知进程传递的 有效负载 字符串。

ParameterDescription (B) #
Byte1('t')

标识消息为参数描述。

Int32

消息内容的字节长度,包括自身。

Int16

语句使用的参数数量(可以为零)。

然后,对于每个参数,有以下内容

Int32

指定参数数据类型的对象 ID。

ParameterStatus (B) #
Byte1('S')

标识消息为运行时参数状态报告。

Int32

消息内容的字节长度,包括自身。

String

正在报告的运行时参数的名称。

String

参数的当前值。

Parse (F) #
Byte1('P')

标识消息为 Parse 命令。

Int32

消息内容的字节长度,包括自身。

String

目标预处理语句的名称(空字符串选择未命名的预处理语句)。

String

要解析的查询字符串。

Int16

指定的参数数据类型的数量(可以为零)。请注意,这并不表示可能出现在查询字符串中的参数数量,而仅表示前端想要预先指定类型的参数数量。

然后,对于每个参数,有以下内容

Int32

指定参数数据类型的对象 ID。在此处放置零等效于不指定类型。

ParseComplete (B) #
Byte1('1')

标识消息为“解析完成”指示符。

Int32(4)

消息内容的字节长度,包括自身。

PasswordMessage (F) #
Byte1('p')

标识消息为密码响应。请注意,这也用于 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

如果该字段可以标识为特定表的列,则为该表的对象 ID;否则为零。

Int16

如果该字段可以被识别为特定表的列,则为该列的属性编号;否则为零。

Int32

该字段数据类型的对象 ID。

Int16

数据类型的大小(请参阅 pg_type.typlen)。请注意,负值表示可变宽度类型。

Int32

类型修饰符(请参阅 pg_attribute.atttypmod)。修饰符的含义是类型特定的。

Int16

该字段使用的格式代码。目前将为零(文本)或一(二进制)。在从 Describe 的语句变体返回的 RowDescription 中,格式代码尚不可知,将始终为零。

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请求代码。该值被选择为在最高有效 16 位包含 1234,在最低有效 16 位包含 5679。(为了避免混淆,此代码不得与任何协议版本号相同。)

StartupMessage (F) #
Int32

消息内容的字节长度,包括自身。

Int32(196608)

协议版本号。最高有效 16 位是主版本号(此处描述的协议为 3)。最低有效 16 位是次版本号(此处描述的协议为 0)。

协议版本号之后是一个或多个参数名称和值字符串对。最后一个名称/值对之后需要一个零字节作为终止符。参数可以以任何顺序出现。 user 是必需的,其他是可选的。每个参数都指定为

String

参数名称。目前可识别的名称是

user

要连接的数据库用户名。必需;没有默认值。

database

要连接的数据库。默认为用户名。

options

后端的命令行参数。(这已被弃用,赞成设置单个运行时参数。)此字符串中的空格被视为分隔参数,除非使用反斜杠 (\) 转义;写 \\ 表示字面反斜杠。

replication

用于以流式复制模式连接,其中可以发出少量复制命令而不是 SQL 语句。值可以是 truefalsedatabase,默认值为 false。有关详细信息,请参阅 第 53.4 节

除了上述参数之外,还可以列出其他参数。以 _pq_. 开头的参数名称保留用作协议扩展,而其他参数则被视为在后端启动时设置的运行时参数。此类设置将在后端启动期间应用(如果在命令行参数之后,则为分析命令行参数之后),并将充当会话默认值。

String

参数值。

Sync (F) #
Byte1('S')

将消息标识为 Sync 命令。

Int32(4)

消息内容的字节长度,包括自身。

Terminate (F) #
Byte1('X')

将消息标识为终止。

Int32(4)

消息内容的字节长度,包括自身。

提交更正

如果您在文档中发现任何不正确的内容,与您使用特定功能的体验不符,或需要进一步澄清,请使用此表单报告文档问题。