Doc: Add missing pgoutput options.
authorAmit Kapila
Tue, 26 Dec 2023 05:26:45 +0000 (10:56 +0530)
committerAmit Kapila
Tue, 26 Dec 2023 05:26:45 +0000 (10:56 +0530)
We forgot to update the docs while adding new options in pgoutput.

Author: Emre Hasegeli
Reviewed-by: Peter Smith, Amit Kapila
Backpatch-through: 12
Discussion: https://postgr.es/m/CAE2gYzwdwtUbs-tPSV-QBwgTubiyGD2ZGsSnAVsDfAGGLDrGOA%40mail.gmail.com

doc/src/sgml/logical-replication.sgml
doc/src/sgml/protocol.sgml

index 5ff37a20186f56089004dc2085ceb4dccf0f17fd..eeddea3e52377742cae46b4d58a58176265e8e6d 100644 (file)
    implemented by walsender and apply
    processes.  The walsender process starts logical decoding (described
    in ) of the WAL and loads the standard
-   logical decoding plugin (pgoutput).  The plugin transforms the changes read
+   logical decoding output plugin (pgoutput).  The plugin
+   transforms the changes read
    from WAL to the logical replication protocol
    (see ) and filters the data
    according to the publication specification.  The data is then continuously
index 7141f6c277a64888fd05c4c841027fb421460b9b..a23a1033632d96779f23ced350e0664e5aa8f7e8 100644 (file)
@@ -2525,7 +2525,10 @@ The commands accepted in replication mode are:
        option_name
        
         
-         The name of an option passed to the slot's logical decoding plugin.
+         The name of an option passed to the slot's logical decoding output
+         plugin.  See  for
+         options that are accepted by the standard (pgoutput)
+         plugin.
         
        
       
@@ -2870,12 +2873,18 @@ The commands accepted in replication mode are:
   the physical streaming replication protocol.
  
 
+  PostgreSQL logical decoding supports output
+  plugins.  pgoutput is the standard one used for
+  the built-in logical replication.
+
  
   Logical Streaming Replication Parameters
 
   
-   The logical replication START_REPLICATION command
-   accepts following parameters:
+   Using the START_REPLICATION command,
+   pgoutput accepts the following options:
 
    
     
@@ -2885,7 +2894,8 @@ The commands accepted in replication mode are:
      
       
        Protocol version. Currently versions 1 and
-       2 are supported. The version 2
+       2 are supported.  A valid version is required.
+       The version 2
        is supported only for server version 14 and above, and it allows
        streaming of large in-progress transactions.
      
@@ -2901,6 +2911,43 @@ The commands accepted in replication mode are:
        Comma separated list of publication names for which to subscribe
        (receive changes). The individual publication names are treated
        as standard objects names and can be quoted the same as needed.
+       At least one publication name is required.
+      
+     
+    
+
+    
+     
+      binary
+     
+     
+      
+       Boolean option to use binary transfer mode.  Binary mode is faster
+       than the text mode but slightly less robust.
+      
+     
+    
+
+    
+     
+      messages
+     
+     
+      
+       Boolean option to enable sending the messages that are written
+       by pg_logical_emit_message.
+      
+     
+    
+
+    
+     
+      streaming
+     
+     
+      
+       Boolean option to enable streaming of in-progress transactions.
+       Minimum protocol version 2 is required to turn it on.