From 4d6a1f234c57f5be94da7b28435615b5700eb517 Mon Sep 17 00:00:00 2001 From: Ajin Cherian Date: Thu, 8 Apr 2021 03:13:41 -0400 Subject: [PATCH v3] doc: Update information of new messages for logical replication. Updated documentation for new messages added for streaming in-progress transactions, as well as changes made to the existing messages. It also updates the information of protocol versions supported for logical replication. Author: Ajin Cherian Reviewed-by: Amit Kapila, Peter Smith Discussion: https://postgr.es/m/CAFPTHDYHN9m=MZZct-B=BYg_TETvv+kXvL9RD2DpaBS5pGxGYg@mail.gmail.com --- doc/src/sgml/protocol.sgml | 298 ++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 292 insertions(+), 6 deletions(-) diff --git a/doc/src/sgml/protocol.sgml b/doc/src/sgml/protocol.sgml index 380be5f..6f4931e 100644 --- a/doc/src/sgml/protocol.sgml +++ b/doc/src/sgml/protocol.sgml @@ -2797,9 +2797,11 @@ The commands accepted in replication mode are: - Protocol version. Currently only version 1 is - supported. - + Protocol version. Currently versions 1 and + 2 are supported. The version 2 + is supported only for server versions 14 and above, and is used to allow + streaming of large in-progress transactions. + @@ -2855,7 +2857,10 @@ The commands accepted in replication mode are: The logical replication protocol sends individual transactions one by one. This means that all messages between a pair of Begin and Commit messages - belong to the same transaction. + belong to the same transaction. It also sends changes of large in-progress + transactions between a pair of Stream Start and Stream Stop messages. The + last stream of such a transaction contains Stream Commit or Stream Abort + message. @@ -6457,8 +6462,10 @@ Message - Xid of the transaction. The XID is sent only when user has - requested streaming of in-progress transactions. + Since: 2 + + + Xid of the transaction (only present for streamed transactions). @@ -6647,6 +6654,19 @@ Relation + Since: 2 + + + Xid of the transaction (only present for streamed transactions). + + + + + + Int32 + + + ID of the relation. @@ -6768,6 +6788,19 @@ Type + Since: 2 + + + Xid of the transaction (only present for streamed transactions). + + + + + + Int32 + + + ID of the data type. @@ -6822,6 +6855,19 @@ Insert + Since: 2 + + + Xid of the transaction (only present for streamed transactions). + + + + + + Int32 + + + ID of the relation corresponding to the ID in the relation message. @@ -6878,6 +6924,19 @@ Update + Since: 2 + + + Xid of the transaction (only present for streamed transactions). + + + + + + Int32 + + + ID of the relation corresponding to the ID in the relation message. @@ -6981,6 +7040,19 @@ Delete + Since: 2 + + + Xid of the transaction (only present for streamed transactions). + + + + + + Int32 + + + ID of the relation corresponding to the ID in the relation message. @@ -7059,6 +7131,19 @@ Truncate + Since: 2 + + + Xid of the transaction (only present for streamed transactions). + + + + + + Int32 + + + Number of relations @@ -7091,6 +7176,207 @@ Truncate + + +Stream Start + + + + + + + + Byte1('S') + + + + Since: 2 + + + Identifies the message as a stream start message. + + + + + + Int32 + + + + Xid of the transaction. + + + + + + Int8 + + + + A value of 1 indicates this is the first stream segment for + this XID, 0 for any other stream segment. + + + + + + + + + + + +Stream Stop + + + + + + + + Byte1('E') + + + + Since: 2 + + + Identifies the message as a stream stop message. + + + + + + + + + + + +Stream Commit + + + + + + + + Byte1('c') + + + + Since: 2 + + + Identifies the message as a stream commit message. + + + + + + Int32 + + + + Xid of the transaction. + + + + + + Int8 + + + + Flags; currently unused (must be 0). + + + + + + Int64 + + + + The LSN of the commit. + + + + + + Int64 + + + + The end LSN of the transaction. + + + + + + Int64 + + + + Commit timestamp of the transaction. The value is in number + of microseconds since PostgreSQL epoch (2000-01-01). + + + + + + + + + + + +Stream Abort + + + + + + + + Byte1('A') + + + + Since: 2 + + + Identifies the message as a stream abort message. + + + + + + Int32 + + + + Xid of the transaction. + + + + + + Int32 + + + + Xid of the sub-transaction (will be same as xid of the transaction for top-level + transactions). + + + + + + + + + -- 1.8.3.1