Doc: Add missing pgoutput options.
authorAmit Kapila
Tue, 26 Dec 2023 05:36:59 +0000 (11:06 +0530)
committerAmit Kapila
Tue, 26 Dec 2023 05:36:59 +0000 (11:06 +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 bc3f5ec78d0bb8b65e74ca6cc8bb39b2e46c5bb5..4abfb32f77bf062bbb28f9610ec627cdda1d3420 100644 (file)
@@ -1451,7 +1451,8 @@ CONTEXT:  processing remote data for replication origin "pg_16395" during "INSER
    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 405046f83cd038deea8aa50f924f6d53e6967e68..fdd3d0514831bd8cf92b4b622d5d48a536413719 100644 (file)
@@ -2559,7 +2559,10 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
         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.
          
         
        
@@ -3088,12 +3091,18 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
   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:
 
    
     
@@ -3103,7 +3112,7 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
      
       
        Protocol version. Currently versions 12,
-       and 3 are supported.
+       and 3 are supported.  A valid version is required.
       
       
        Version 2 is supported only for server version 14
@@ -3125,6 +3134,55 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
        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.
+      
+     
+    
+
+    
+     
+      two_phase
+     
+     
+      
+       Boolean option to enable two-phase transactions.   Minimum protocol
+       version 3 is required to turn it on.