Stream Start (logical replication)

Description

Logical replication Stream Start format. Identifies the message as a stream start message.

Layer

Logical replication payload; distinct from the frontend/backend message envelope

First field

Byte1('S')

Usage

Stream Start

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

Related entries

• Streaming replication protocol
• Logical Decoding Plugins

Documentation and source

• PostgreSQL 18 English manual

Compare versions

PostgreSQL 13 → 14: added.

--- PostgreSQL 13
+++ PostgreSQL 14
@@ -1 +1,17 @@
-Not recorded in this version
+{
+  "fields": [
+    {
+      "description": "Identifies the message as a stream start message.",
+      "format": "Byte1('S')"
+    },
+    {
+      "description": "Xid of the transaction.",
+      "format": "Int32"
+    },
+    {
+      "description": "A value of 1 indicates this is the first stream segment for this XID, 0 for any other stream segment.",
+      "format": "Int8"
+    }
+  ],
+  "layer": "logical replication"
+}

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)