Bind

Bind is a frontend protocol message. Identifies the message as a Bind command.

Reading PG 18·Select a recorded version

10 11 12 13 14 15 16 17 18 19 20

Direction: Frontend → backend
First wire field: Byte1('B')
Field entries: 11
Documented flow contexts: Extended Query; Function Call
direction: F
manual path: /docs/18/protocol-message-formats.html
signature: Bind (F)

Definition PG 18

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).

Wire fields in documented order

Position	Format	Meaning
1	Byte1('B')	Identifies the message as a Bind command.
2	Int32	Length of message contents in bytes, including self.
3	String	The name of the destination portal (an empty string selects the unnamed portal).
4	String	The name of the source prepared statement (an empty string selects the unnamed prepared statement).
5	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.
6	Int16[ C ]	The parameter format codes. Each must presently be zero (text) or one (binary).
7	Int16	The number of parameter values that follow (possibly zero). This must match the number of parameters needed by the query.
8	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.
9	Byte n	The value of the parameter, in the format indicated by the associated format code. n is the above length.
10	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.
11	Int16[ R ]	The result-column format codes. Each must presently be zero (text) or one (binary).

Compare versions

Complete source facts

fields

map[description:Identifies the message as a Bind command. format:Byte1('B')], map[description:Length of message contents in bytes, including self. format:Int32], map[description:The name of the destination portal (an empty string selects the unnamed portal). format:String], map[description:The name of the source prepared statement (an empty string selects the unnamed prepared statement). format:String], map[description: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. format:Int16], map[description:The parameter format codes. Each must presently be zero (text) or one (binary). format:Int16[ C ]], map[description:The number of parameter values that follow (possibly zero). This must match the number of parameters needed by the query. format:Int16], map[description: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. format:Int32], map[description:The value of the parameter, in the format indicated by the associated format code. n is the above length. format:Byte n], map[description: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. format:Int16], map[description:The result-column format codes. Each must presently be zero (text) or one (binary). format:Int16[ R ]]

Source references

Full definition and evidence JSON

Definition sources

center · PostgreSQL 18 · 555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f

Text language: en · 555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f