public inbox for [email protected]  
help / color / mirror / Atom feed
Documentation on Streaming Replication interface for Logical Decoding
3+ messages / 2 participants
[nested] [flat]

* Documentation on Streaming Replication interface for Logical Decoding
@ 2015-11-09 22:40  Daniel Gustafsson <[email protected]>
  0 siblings, 1 reply; 3+ messages in thread

From: Daniel Gustafsson @ 2015-11-09 22:40 UTC (permalink / raw)
  To: pgsql-docs

In section 46.3 (Streaming Replication Protocol Interface) the create command
for logical slots, CREATE_REPLICATION_SLOT, is defined as taking “options”
after the LOGICAL keyword when it in fact requires the plugin name.  The start
command is correctly listing the options but isn’t listing the required start
position.

The attached patch synchronizes these command signatures with the more detailed
descriptions in section 50.3* (Streaming Replication Protocol).

	cheers ./daniel

(*) Section number from the 9.5beta1 manual



-- 
Sent via pgsql-docs mailing list ([email protected])
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-docs


Attachments:

  [application/octet-stream] log_dec_doc.diff (1.2K, 2-log_dec_doc.diff)
  download | inline diff:
diff --git a/doc/src/sgml/logicaldecoding.sgml b/doc/src/sgml/logicaldecoding.sgml
index 02794cc..01626aa 100644
--- a/doc/src/sgml/logicaldecoding.sgml
+++ b/doc/src/sgml/logicaldecoding.sgml
@@ -280,7 +280,7 @@ $ pg_recvlogical -d postgres --slot test --drop-slot
     The commands
     <itemizedlist>
      <listitem>
-      <para><literal>CREATE_REPLICATION_SLOT <replaceable>slot_name</replaceable> LOGICAL <replaceable>options</replaceable></literal></para>
+      <para><literal>CREATE_REPLICATION_SLOT <replaceable>slot_name</replaceable> LOGICAL <replaceable>output_plugin</replaceable></literal></para>
      </listitem>
 
      <listitem>
@@ -288,7 +288,7 @@ $ pg_recvlogical -d postgres --slot test --drop-slot
      </listitem>
 
      <listitem>
-      <para><literal>START_REPLICATION SLOT <replaceable>slot_name</replaceable> LOGICAL <replaceable>options</replaceable></literal></para>
+      <para><literal>START_REPLICATION SLOT <replaceable>slot_name</replaceable> LOGICAL <replaceable>XXX/XXX</replaceable> <replaceable>[ plugin_options ]</replaceable></literal></para>
      </listitem>
     </itemizedlist>
     are used to create, drop, and stream changes from a replication


^ permalink  raw  reply  [nested|flat] 3+ messages in thread

* Re: Documentation on Streaming Replication interface for Logical Decoding
@ 2015-11-10 04:59  Michael Paquier <[email protected]>
  parent: Daniel Gustafsson <[email protected]>
  0 siblings, 1 reply; 3+ messages in thread

From: Michael Paquier @ 2015-11-10 04:59 UTC (permalink / raw)
  To: Daniel Gustafsson <[email protected]>; +Cc: pgsql-docs

On Tue, Nov 10, 2015 at 7:40 AM, Daniel Gustafsson <[email protected]> wrote:
> In section 46.3 (Streaming Replication Protocol Interface) the create command
> for logical slots, CREATE_REPLICATION_SLOT, is defined as taking “options”
> after the LOGICAL keyword when it in fact requires the plugin name.  The start
> command is correctly listing the options but isn’t listing the required start
> position.
>
> The attached patch synchronizes these command signatures with the more detailed
> descriptions in section 50.3* (Streaming Replication Protocol).
>
>         cheers ./daniel
>
> (*) Section number from the 9.5beta1 manual

Why do we need to maintain the semantics of those commands in two
places by the way? There is already a link to the replication protocol
page in logicaldecoding.sgml, hence it seems to me that we had better
just cite the command names, per se the attached.
-- 
Michael


-- 
Sent via pgsql-docs mailing list ([email protected])
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-docs


Attachments:

  [text/x-diff] 20151110_logdec_docs.patch (1.5K, 2-20151110_logdec_docs.patch)
  download | inline diff:
diff --git a/doc/src/sgml/logicaldecoding.sgml b/doc/src/sgml/logicaldecoding.sgml
index 02794cc..11fc715 100644
--- a/doc/src/sgml/logicaldecoding.sgml
+++ b/doc/src/sgml/logicaldecoding.sgml
@@ -277,23 +277,11 @@ $ pg_recvlogical -d postgres --slot test --drop-slot
    <title>Streaming Replication Protocol Interface</title>
 
    <para>
-    The commands
-    <itemizedlist>
-     <listitem>
-      <para><literal>CREATE_REPLICATION_SLOT <replaceable>slot_name</replaceable> LOGICAL <replaceable>options</replaceable></literal></para>
-     </listitem>
-
-     <listitem>
-      <para><literal>DROP_REPLICATION_SLOT <replaceable>slot_name</replaceable></literal></para>
-     </listitem>
-
-     <listitem>
-      <para><literal>START_REPLICATION SLOT <replaceable>slot_name</replaceable> LOGICAL <replaceable>options</replaceable></literal></para>
-     </listitem>
-    </itemizedlist>
-    are used to create, drop, and stream changes from a replication
-    slot, respectively. These commands are only available over a replication
-    connection; they cannot be used via SQL.
+    The commands <literal>CREATE_REPLICATION_SLOT</literal>,
+    <literal>DROP_REPLICATION_SLOT</literal> and 
+    <literal>START_REPLICATION SLOT</literal> are used to create, drop, and
+    stream changes from a replication slot, respectively. These commands are
+    only available over a replication connection; they cannot be used via SQL.
     See <xref linkend="protocol-replication"> for details on these commands.
    </para>
 


^ permalink  raw  reply  [nested|flat] 3+ messages in thread

* Re: Documentation on Streaming Replication interface for Logical Decoding
@ 2015-11-10 06:47  Daniel Gustafsson <[email protected]>
  parent: Michael Paquier <[email protected]>
  0 siblings, 0 replies; 3+ messages in thread

From: Daniel Gustafsson @ 2015-11-10 06:47 UTC (permalink / raw)
  To: Michael Paquier <[email protected]>; +Cc: pgsql-docs

> On 10 Nov 2015, at 05:59, Michael Paquier <[email protected]> wrote:
> 
> On Tue, Nov 10, 2015 at 7:40 AM, Daniel Gustafsson <[email protected]> wrote:
>> In section 46.3 (Streaming Replication Protocol Interface) the create command
>> for logical slots, CREATE_REPLICATION_SLOT, is defined as taking “options”
>> after the LOGICAL keyword when it in fact requires the plugin name.  The start
>> command is correctly listing the options but isn’t listing the required start
>> position.
>> 
>> The attached patch synchronizes these command signatures with the more detailed
>> descriptions in section 50.3* (Streaming Replication Protocol).
>> 
>> (*) Section number from the 9.5beta1 manual
> 
> Why do we need to maintain the semantics of those commands in two
> places by the way? There is already a link to the replication protocol
> page in logicaldecoding.sgml, hence it seems to me that we had better
> just cite the command names, per se the attached.

Thats a perfectly reasonable approach as well, admittedly I don’t see much
point in the duplication.

	cheers ./daniel

-- 
Sent via pgsql-docs mailing list ([email protected])
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-docs




^ permalink  raw  reply  [nested|flat] 3+ messages in thread


end of thread, other threads:[~2015-11-10 06:47 UTC | newest]

Thread overview: 3+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2015-11-09 22:40 Documentation on Streaming Replication interface for Logical Decoding Daniel Gustafsson <[email protected]>
2015-11-10 04:59 ` Michael Paquier <[email protected]>
2015-11-10 06:47   ` Daniel Gustafsson <[email protected]>

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