Wiki / Protocol Messages / Logical replication formats
TupleData (logical replication)
Logical replication TupleData format. Number of columns.
Reading PostgreSQL 18.6.
Description
Logical replication TupleData format. Number of columns.
- Layer
- Logical replication payload; distinct from the frontend/backend message envelope
- First field
- Int16
Usage
TupleDataProtocol context
This section describes the detailed format of each logical replication message. These messages are either returned by the replication slot SQL interface or are sent by a walsender. In the case of a walsender, they are encapsulated inside replication protocol WAL messages as described in Section 54.4 , and generally obey the same message flow as physical replication. The following messages (Stream Start, Stream Stop, Stream Commit, and Stream Abort) are available since protocol version 2. The following messages (Begin Prepare, Prepare, Commit Prepared, Rollback Prepared, Stream Prepare) are available since protocol version 3. The following message parts are shared by the above messages.
Fields in documented order
| Position | Format | Meaning |
|---|---|---|
| 1 | Int16 | Number of columns. |
| 2 | Byte1('n') | Identifies the data as NULL value. |
| 3 | Byte1('u') | Identifies unchanged TOASTed value (the actual value is not sent). |
| 4 | Byte1('t') | Identifies the data as text formatted value. |
| 5 | Byte1('b') | Identifies the data as binary formatted value. |
| 6 | Int32 | Length of the column value. |
| 7 | Byte n | The value of the column, either in binary or in text format. (As specified in the preceding format byte). n is the above length. |
Manual definition
-
- Int16
-
Number of columns.
Next, one of the following submessages appears for each published column:
- Byte1('n')
-
Identifies the data as NULL value.
Or
- Byte1('u')
-
Identifies unchanged TOASTed value (the actual value is not sent).
Or
- Byte1('t')
-
Identifies the data as text formatted value.
Or
- Byte1('b')
-
Identifies the data as binary formatted value.
- Int32
-
Length of the column value.
- Byte
n -
The value of the column, either in binary or in text format. (As specified in the preceding format byte).
nis the above length.
Related entries
Documentation and source
Source build
- Version
- 18.6
- Build
- https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2
- Source fingerprint
555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f
Compare versions
PostgreSQL 17 → 18: unchanged.
Compares recorded interfaces and attributes. Source fingerprints and build metadata are excluded; an absent sample is not proof of the introduction or removal release.
Related entries
Begin (logical replication)Begin Prepare (logical replication)Commit (logical replication)Commit Prepared (logical replication)Delete (logical replication)Insert (logical replication)Message (logical replication)Origin (logical replication)Prepare (logical replication)Relation (logical replication)Rollback Prepared (logical replication)Stream Abort (logical replication)
Export JSON · Back to Protocol Messages · Recorded in PostgreSQL 10 through 20; the first sample is not necessarily its introduction.