Improvements to the replication protocol documentation.
authorAndres Freund
Sat, 31 May 2014 13:58:04 +0000 (15:58 +0200)
committerAndres Freund
Sat, 31 May 2014 13:58:04 +0000 (15:58 +0200)
Document the CREATE_REPLICATION_SLOT's output_plugin parameter; that
START_REPLICATION ... LOGICAL takes parameters; that START_REPLICATION
... LOGICAL uses the same messages as ... PHYSICAL; and be more
consistent with the usage of .

Michael Paquier, with some additional changes by me.

doc/src/sgml/protocol.sgml

index 3a2421bf458ffddacac0dfc26bfd2fee12b23f6f..ee3d9de4c071b8bb10b6fb1fd2ca8b5948adeaeb 100644 (file)
@@ -1428,10 +1428,10 @@ The commands accepted in walsender mode are:
   
 
   
-    CREATE_REPLICATION_SLOT slotname PHYSICALCREATE_REPLICATION_SLOT
+    CREATE_REPLICATION_SLOT slotname { PHYSICAL | LOGICAL output_plugin } CREATE_REPLICATION_SLOT
     
      
-      Create a physical replication
+      Create a physical or logical replication
       slot. See  for more about
       replication slots.
      
@@ -1445,12 +1445,22 @@ The commands accepted in walsender mode are:
          
        
       
+
+      
+       output_plugin
+       
+         
+          The name of the output plugin used for logical decoding
+          (see ).
+         
+       
+      
      
     
   
 
   
-    START_REPLICATION [SLOT slotname] [PHYSICALXXX/XXX [TIMELINE tli]
+    START_REPLICATION [SLOT slotname] [PHYSICALXXX/XXX [TIMELINE tli]
     
      
       Instructs server to start streaming WAL, starting at
@@ -1778,7 +1788,7 @@ The commands accepted in walsender mode are:
     
   
   
-    START_REPLICATION SLOT slotname LOGICAL XXX/XXX
+    START_REPLICATION SLOT slotname LOGICAL XXX/XXX [ ( option_name [option_value] [, ... ] ) ]
     
      
       Instructs server to start streaming WAL for logical replication, starting
@@ -1787,10 +1797,17 @@ The commands accepted in walsender mode are:
       been recycled. On success, server responds with a CopyBothResponse
       message, and then starts to stream WAL to the frontend.
      
+
+     
+      The messages inside the CopyBothResponse messages are of the same format
+      documented for START_REPLICATION ... PHYSICAL.
+     
+
      
       The output plugin associated with the selected slot is used
       to process the output for streaming.
      
+
      
       
        SLOT slotname
@@ -1811,12 +1828,29 @@ The commands accepted in walsender mode are:
         
        
       
+      
+       option_name
+       
+        
+         The name of an option passed to the slot's logical decoding plugin.
+        
+       
+      
+      
+       option_value
+       
+        
+         Optional value, in the form of a string constant, associated with the
+         specified option.
+        
+       
+      
      
     
   
 
   
-    DROP_REPLICATION_SLOT slotname
+    DROP_REPLICATION_SLOT slotname
     
      
       Drops a replication slot, freeing any reserved server-side resources. If