↑↓ select↵ open⌫ change scopeOpen full search

PG.CENTER connects PostgreSQL documentation, reference, and ecosystem knowledge. Maintained by Pigsty.

Wiki / Protocol Messages

CopyOutResponse

CopyOutResponse is a backend protocol message. Identifies the message as a Start Copy Out response. This message will be followed by copy-out data.

Reading PG 18·Select a recorded version

1011121314151617181920
Direction
Backend → frontend
First wire field
Byte1('H')
Field entries
5
Documented flow contexts
Simple Query; COPY Operations
direction
B
manual path
/docs/18/protocol-message-formats.html
signature
CopyOutResponse (B)

Definition PG 18

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.

Wire fields in documented order

PositionFormatMeaning
1Byte1('H')Identifies the message as a Start Copy Out response. This message will be followed by copy-out data.
2Int32Length of message contents in bytes, including self.
3Int80 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.
4Int16The number of columns in the data to be copied (denoted N below).
5Int16[ 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.

Compare versions

Complete source facts

fields

map[description:Identifies the message as a Start Copy Out response. This message will be followed by copy-out data. format:Byte1('H')], map[description:Length of message contents in bytes, including self. format:Int32], map[description: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. format:Int8], map[description:The number of columns in the data to be copied (denoted N below). format:Int16], map[description: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. format:Int16[ N ]]

Source references

Full definition and evidence JSON

Definition sources

center · PostgreSQL 18 · 555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f

Text language: en · 555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f