public inbox for [email protected]  
help / color / mirror / Atom feed
From: Li Japin <[email protected]>
To: Fujii Masao <[email protected]>
Cc: PostgreSQL Developers <[email protected]>
Subject: Re: Confused about stream replication protocol documentation
Date: Thu, 24 Dec 2020 02:28:53 +0000
Message-ID: <[email protected]> (raw)
In-Reply-To: <[email protected]>
References: <[email protected]>
	<[email protected]>
	<[email protected]>
	<[email protected]>


On Dec 23, 2020, at 8:11 PM, Fujii Masao <[email protected]<mailto:[email protected]>> wrote:


On 2020/12/23 11:08, Li Japin wrote:
On Dec 22, 2020, at 11:13 PM, Fujii Masao <[email protected]<mailto:[email protected]> <mailto:[email protected]>> wrote:

‘B’ means a backend and ‘F’ means a frontend. Maybe as [1] does, we should
add the note like "Each is marked to indicate that it can be sent by
a frontend (F) and a backend (B)" into the description about each message
format for START_REPLICATION.

[1]
https://www.postgresql.org/docs/devel/protocol-message-formats.html <https://www.postgresql.org/docs/devel/protocol-message-formats.html;
Thanks for your clarify.  Maybe we should move the "protocol message formats”
before “stream replication protocol” or referenced it in "stream replication protocol”.

I like the latter. And maybe it's better to reference to also
"53.6. Message Data Types" there because the messages for
START_REPLICATION use the message data types.

Add reference about “protocol message types” and “protocol message formats”.

index 4899bacda7..5793936b42 100644
--- a/doc/src/sgml/protocol.sgml
+++ b/doc/src/sgml/protocol.sgml
@@ -2069,8 +2069,9 @@ The commands accepted in replication mode are:
      </para>

      <para>
-      WAL data is sent as a series of CopyData messages.  (This allows
-      other information to be intermixed; in particular the server can send
+      WAL data is sent as a series of CopyData messages
+      (See <xref linkend="protocol-message-types"/> and <xref linkend="protocol-message-formats"/>).
+      (This allows other information to be intermixed; in particular the server can send
       an ErrorResponse message if it encounters a failure after beginning
       to stream.)  The payload of each CopyData message from server to the
       client contains a message of one of the following formats:

--
Best regards
Japin Li



Attachments:

  [application/octet-stream] stream-replication-protocol-documentation.patch (900B, ../[email protected]/3-stream-replication-protocol-documentation.patch)
  download | inline diff:
diff --git a/doc/src/sgml/protocol.sgml b/doc/src/sgml/protocol.sgml
index 4899bacda7..5793936b42 100644
--- a/doc/src/sgml/protocol.sgml
+++ b/doc/src/sgml/protocol.sgml
@@ -2069,8 +2069,9 @@ The commands accepted in replication mode are:
      </para>
 
      <para>
-      WAL data is sent as a series of CopyData messages.  (This allows
-      other information to be intermixed; in particular the server can send
+      WAL data is sent as a series of CopyData messages
+      (See <xref linkend="protocol-message-types"/> and <xref linkend="protocol-message-formats"/>).
+      (This allows other information to be intermixed; in particular the server can send
       an ErrorResponse message if it encounters a failure after beginning
       to stream.)  The payload of each CopyData message from server to the
       client contains a message of one of the following formats:


view thread (5+ messages)

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: [email protected]
  Cc: [email protected], [email protected], [email protected]
  Subject: Re: Confused about stream replication protocol documentation
  In-Reply-To: <[email protected]>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox