| PostgreSQL 9.4.1 Documentation | |||
|---|---|---|---|
| Prev | Up | Chapter 49. Frontend/Backend Protocol | Next |
49.5. 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, the message format is defined so that the message end can be found without reference to the byte count. This aids validity checking. (The CopyData message is an exception, because it forms part of a data stream; the contents of any individual CopyData message cannot be interpretable on their own.)
- 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.
- AuthenticationSCMCredential (B)
- Byte1('R')
Identifies the message as an authentication request.
- Int32(8)
Length of message contents in bytes, including self.
- Int32(6)
Specifies that an SCM credentials message is required.
- 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.
- 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.
- 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.
- 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(12)
Length of message contents in bytes, including self.
- Int32
The process ID of this backend.
- Int32
The secret key of this backend.
- 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(16)
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 16 significant bits. (To avoid confusion, this code must not be the same as any protocol version number.)
- Int32
The process ID of the target backend.
- Int32
The secret key for the target backend.
- 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 is the object ID of the inserted row if rows is 1 and the target table has OIDs; otherwise oid is 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 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 49.6. 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.
- 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 49.6. 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 and SSPI response messages (which is really a design error, since the contained data is not a null-terminated string in that case, but can be arbitrary binary data).
- 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.
- 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 16 significant 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(196608)
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 (0 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.)
In addition to the above, any run-time parameter that can be set at backend start time might be listed. Such settings will be applied during backend start (after parsing the command-line options if any). The values 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.