Doc: Make link names consistent in logical replication commands.
authorAmit Kapila
Mon, 30 Oct 2023 05:16:31 +0000 (10:46 +0530)
committerAmit Kapila
Mon, 30 Oct 2023 05:16:31 +0000 (10:46 +0530)
Commit 536f410111 added links in the ALTER SUBSCRIPTION command page. The
link names used were slightly different from what other logical
replication commands like CREATE SUBSCRIPTION/PUBLICATION have but were
consistent with other docs. This patch changes the link names for all the
parameters to have 'params' word in the CREATE SUBSCRIPTION/PUBLICATION
pages.

Author: Peter Smith
Reviewed-by: Amit Kapila
Discussion: http://postgr.es/m/CAHut%2BPu2S4RdzYKR7H5_E7QYWyq5hB0hL4EFrYbP91Qso62jeg%40mail.gmail.com

doc/src/sgml/config.sgml
doc/src/sgml/logical-replication.sgml
doc/src/sgml/ref/alter_publication.sgml
doc/src/sgml/ref/alter_subscription.sgml
doc/src/sgml/ref/create_publication.sgml
doc/src/sgml/ref/create_subscription.sgml
doc/src/sgml/ref/pg_dump.sgml
doc/src/sgml/system-views.sgml

index 985cabfc0b3f3e33011997926723f7f43dbacee3..bd70ff2e4b88c8497bbf2c6f1bd8dd9d8e0e0fcc 100644 (file)
@@ -11702,7 +11702,7 @@ LOG:  CleanUpLock: deleting: lock(0xb7acd844) id(24688,24696,0,0,0,1)
         On the publisher side, debug_logical_replication_streaming
         allows streaming or serializing changes immediately in logical decoding.
         When set to immediate, stream each change if the
-        streaming
+        params-with-streaming">streaming
         option of
         CREATE SUBSCRIPTION
         is enabled, otherwise, serialize each change.  When set to
index 8c3837e89bdcc5073ce641e6f8df579a0f2e2f6c..1bb85e4ad9804897f5feb420704f2825e0fa9ebf 100644 (file)
    will be filled with the default value as specified in the definition of the
    target table. However, logical replication in binary format is more
    restrictive. See the
-   binary
+   params-with-binary">binary
    option of CREATE SUBSCRIPTION for details.
   
 
@@ -371,7 +371,7 @@ INSERT 0 3
     
      Create publications for the tables. The publications pub2
      and pub3a disallow some
-     publish
+     params-with-publish">publish
      operations. The publication pub3b has a row filter (see
      ).
 
@@ -593,7 +593,7 @@ ALTER SUBSCRIPTION
    
     Example 2: Where the subscription says connect = false,
     but also specifies the
-    slot_name
+    params-with-slot-name">slot_name
     option.
     
      
@@ -712,7 +712,7 @@ ALTER SUBSCRIPTION
     then the row is not replicated. The WHERE clause expression
     is evaluated with the same role used for the replication connection (i.e.
     the role specified in the
-    CONNECTION
+    params-connection">CONNECTION
     clause of the ). Row filters have
     no effect for TRUNCATE command.
    
@@ -805,7 +805,7 @@ ALTER SUBSCRIPTION
 
    
     If the publication contains a partitioned table, the publication parameter
-    publish_via_partition_root
+    params-with-publish-via-partition-root">publish_via_partition_root
     determines which row filter is used. If publish_via_partition_root
     is true, the root partitioned table's
     row filter is used. Otherwise, if publish_via_partition_root
@@ -834,7 +834,7 @@ ALTER SUBSCRIPTION
    
     
      Because initial data synchronization does not take into account the
-     publish
+     params-with-publish">publish
      parameter when copying existing table data, some rows may be copied that
      would not be replicated using DML. Refer to
      , and see
@@ -858,7 +858,7 @@ ALTER SUBSCRIPTION
    
     If the subscription has several publications in which the same table has
     been published with different row filters (for the same
-    publish
+    params-with-publish">publish
     operation), those expressions get ORed together, so that rows satisfying
     any of the expressions will be replicated. This means all
     the other row filters for the same table become redundant if:
@@ -871,14 +871,14 @@ ALTER SUBSCRIPTION
      
       
        One of the publications was created using
-       FOR ALL TABLES.
+       params-for-all-tables">FOR ALL TABLES.
        This clause does not allow row filters.
       
      
      
       
        One of the publications was created using
-       FOR TABLES IN SCHEMA
+       params-for-tables-in-schema">FOR TABLES IN SCHEMA
        and the table belongs to the referred schema. This clause does not allow
        row filters.
       
@@ -1145,7 +1145,7 @@ test_sub=# SELECT * FROM t1;
 
    
     The following examples show how the publication parameter
-    publish_via_partition_root
+    params-with-publish-via-partition-root">publish_via_partition_root
     determines whether the row filter of the parent or child table will be used
     in the case of partitioned tables.
    
@@ -1300,13 +1300,13 @@ test_sub=# SELECT * FROM child ORDER BY a;
 
   
    Specifying a column list when the publication also publishes
-   FOR TABLES IN SCHEMA
+   params-for-tables-in-schema">FOR TABLES IN SCHEMA
    is not supported.
   
 
   
    For partitioned tables, the publication parameter
-   publish_via_partition_root
+   params-with-publish-via-partition-root">publish_via_partition_root
    determines which column list is used. If publish_via_partition_root
    is true, the root partitioned table's column list is
    used. Otherwise, if publish_via_partition_root is
@@ -1518,7 +1518,7 @@ CONTEXT:  processing remote data for replication origin "pg_16395" during "INSER
    either by 
    ALTER SUBSCRIPTION ... DISABLE or, the
    subscription can be used with the
-   disable_on_error
+   params-with-disable-on-error">disable_on_error
    option. Then, you can use pg_replication_origin_advance()
    function with the node_name (i.e., pg_16395)
    and the next LSN of the finish LSN (i.e., 0/14C0379).  The current position of
@@ -1531,7 +1531,7 @@ CONTEXT:  processing remote data for replication origin "pg_16395" during "INSER
 
   
    When the
-   streaming
+   params-with-streaming">streaming
    mode is parallel, the finish LSN of failed transactions
    may not be logged. In that case, it may be necessary to change the streaming
    mode to on or off and cause the same
@@ -1624,7 +1624,7 @@ CONTEXT:  processing remote data for replication origin "pg_16395" during "INSER
      using the identity and schema of the partitioned root table instead of
      that of the individual leaf partitions in which the changes actually
      originate (see
-     publish_via_partition_root
+     params-with-publish-via-partition-root">publish_via_partition_root
      parameter of CREATE PUBLICATION).
     
    
@@ -1709,7 +1709,7 @@ CONTEXT:  processing remote data for replication origin "pg_16395" during "INSER
     
      
       The publication
-      publish
+      params-with-publish">publish
       parameter only affects what DML operations will be replicated. The
       initial data synchronization does not take this parameter into account
       when copying the existing table data.
@@ -1743,7 +1743,7 @@ CONTEXT:  processing remote data for replication origin "pg_16395" during "INSER
    zero rows in this view.  If the initial data synchronization of any
    table is in progress, there will be additional workers for the tables
    being synchronized. Moreover, if the
-   streaming
+   params-with-streaming">streaming
    transaction is applied in parallel, there may be additional parallel apply
    workers.
   
index 74fda82ed046de4333101c958ca476b07262b1e8..44ae7e0e871c89eb86c959e3fec04f880ec87606 100644 (file)
@@ -56,7 +56,7 @@ ALTER PUBLICATION name RENAME TO 
    subscribing side in order to become effective. Note also that
    DROP TABLES IN SCHEMA will not drop any schema tables
    that were specified using
-   FOR TABLE/
+   params-for-table">FOR TABLE/
    ADD TABLE, and the combination of DROP
    with a WHERE clause is not allowed.
   
@@ -82,8 +82,8 @@ ALTER PUBLICATION name RENAME TO 
    new owning role, and that role must have CREATE
    privilege on the database.
    Also, the new owner of a
-   FOR ALL TABLES
-   or FOR TABLES IN SCHEMA
+   params-for-all-tables">FOR ALL TABLES
+   or params-for-tables-in-schema">FOR TABLES IN SCHEMA
    publication must be a superuser. However, a superuser can
    change the ownership of a publication regardless of these restrictions.
   
index ba708555300cb16db8ddb39e16dac42c2c53e44d..6d36ff0dc90a34b17a61314733af92079845bdae 100644 (file)
@@ -72,9 +72,9 @@ ALTER SUBSCRIPTION name RENAME TO <
    executed inside a transaction block.
 
    These commands also cannot be executed when the subscription has
-   two_phase
+   params-with-two-phase">two_phase
    commit enabled, unless
-   copy_data
+   params-with-copy-data">copy_data
    is false. See column subtwophasestate
    of pg_subscription
    to know the actual two-phase state.
@@ -178,12 +178,12 @@ ALTER SUBSCRIPTION name RENAME TO <
          
           See  for details of
           how copy_data = true can interact with the
-          origin
+          params-with-origin">origin
           parameter.
          
          
           See the
-          binary
+          params-with-binary">binary
           parameter of CREATE SUBSCRIPTION for details about
           copying pre-existing data in binary format.
          
@@ -220,14 +220,14 @@ ALTER SUBSCRIPTION name RENAME TO <
       This clause alters parameters originally set by
       .  See there for more
       information.  The parameters that can be altered are
-      slot_name,
-      synchronous_commit,
-      binary,
-      streaming,
-      disable_on_error,
-      password_required,
-      run_as_owner, and
-      origin.
+      params-with-slot-name">slot_name,
+      params-with-synchronous-commit">synchronous_commit,
+      params-with-binary">binary,
+      params-with-streaming">streaming,
+      params-with-disable-on-error">disable_on_error,
+      params-with-password-required">password_required,
+      params-with-run-as-owner">run_as_owner, and
+      params-with-origin">origin.
       Only a superuser can set password_required = false.
      
     
@@ -243,7 +243,7 @@ ALTER SUBSCRIPTION name RENAME TO <
       the logical replication worker skips all data modification changes within
       the transaction.  This option has no effect on the transactions that are
       already prepared by enabling
-      two_phase
+      params-with-two-phase">two_phase
       on the subscriber.
       After the logical replication worker successfully skips the transaction or
       finishes a transaction, the LSN (stored in
index 606aa64ecfa3e62f140893947bf90a1c547171f9..fd9c5deac95dce9d7f6aca3df40858f4895efbe3 100644 (file)
@@ -54,7 +54,7 @@ CREATE PUBLICATION name
   Parameters
 
   
-   
+   params-name">
     name
     
      
@@ -63,7 +63,7 @@ CREATE PUBLICATION name
     
    
 
-   
+   params-for-table">
     FOR TABLE
     
      
@@ -117,7 +117,7 @@ CREATE PUBLICATION name
     
    
 
-   
+   params-for-all-tables">
     FOR ALL TABLES
     
      
@@ -127,7 +127,7 @@ CREATE PUBLICATION name
     
    
 
-   
+   params-for-tables-in-schema">
     FOR TABLES IN SCHEMA
     
      
@@ -158,7 +158,7 @@ CREATE PUBLICATION name
     
    
 
-   
+   params-with">
     WITH ( publication_parameter [= value] [, ... ] )
     
      
@@ -166,7 +166,7 @@ CREATE PUBLICATION name
       following parameters are supported:
 
       
-       
+       params-with-publish">
         publish (string)
         
          
@@ -188,7 +188,7 @@ CREATE PUBLICATION name
         
        
 
-       
+       params-with-publish-via-partition-root">
         publish_via_partition_root (boolean)
         
          
index c1bafbfa06ae2a4a548c0df8106e6ed55063086c..f1c20b3a465197d7246f4e6b8720876e448c51ad 100644 (file)
@@ -68,7 +68,7 @@ CREATE SUBSCRIPTION subscription_name
   Parameters
 
   
-   
+   params-name">
     subscription_name
     
      
@@ -77,7 +77,7 @@ CREATE SUBSCRIPTION subscription_name
     
    
 
-   
+   params-connection">
     CONNECTION 'conninfo'
     
      
@@ -88,7 +88,7 @@ CREATE SUBSCRIPTION subscription_name
     
    
 
-   
+   arams-publication">
     PUBLICATION publication_name [, ...]
     
      
@@ -97,7 +97,7 @@ CREATE SUBSCRIPTION subscription_name
     
    
 
-   
+   params-with">
     WITH ( subscription_parameter [= value] [, ... ] )
     
      
@@ -109,7 +109,7 @@ CREATE SUBSCRIPTION subscription_name
 
       
 
-       
+       params-with-connect">
         connect (boolean)
         
          
@@ -136,7 +136,7 @@ CREATE SUBSCRIPTION subscription_name
         
        
 
-       
+       params-with-create-slot">
         create_slot (boolean)
         
          
@@ -152,7 +152,7 @@ CREATE SUBSCRIPTION subscription_name
         
        
 
-       
+       params-with-enabled">
         enabled (boolean)
         
          
@@ -163,7 +163,7 @@ CREATE SUBSCRIPTION subscription_name
         
        
 
-       
+       params-with-slot-name">
         slot_name (string)
         
          
@@ -192,7 +192,7 @@ CREATE SUBSCRIPTION subscription_name
 
       
 
-       
+       params-with-binary">
         binary (boolean)
         
          
@@ -229,7 +229,7 @@ CREATE SUBSCRIPTION subscription_name
         
        
 
-       
+       params-with-copy-data">
         copy_data (boolean)
         
          
@@ -250,7 +250,7 @@ CREATE SUBSCRIPTION subscription_name
         
        
 
-       
+       params-with-streaming">
         streaming (enum)
         
          
@@ -278,7 +278,7 @@ CREATE SUBSCRIPTION subscription_name
         
        
 
-       
+       params-with-synchronous-commit">
         synchronous_commit (enum)
         
          
@@ -310,7 +310,7 @@ CREATE SUBSCRIPTION subscription_name
         
        
 
-       
+       params-with-two-phase">
         two_phase (boolean)
         
          
@@ -341,7 +341,7 @@ CREATE SUBSCRIPTION subscription_name
         
        
 
-       
+       params-with-disable-on-error">
         disable_on_error (boolean)
         
          
@@ -353,7 +353,7 @@ CREATE SUBSCRIPTION subscription_name
         
        
 
-       
+       params-with-password-required">
         password_required (boolean)
         
          
@@ -366,7 +366,7 @@ CREATE SUBSCRIPTION subscription_name
         
        
 
-       
+       params-with-run-as-owner">
         run_as_owner (boolean)
         
          
@@ -380,7 +380,7 @@ CREATE SUBSCRIPTION subscription_name
         
        
 
-       
+       params-with-origin">
         origin (string)
         
          
@@ -452,8 +452,8 @@ CREATE SUBSCRIPTION subscription_name
    the case of different WHERE clauses, if one of the
    publications has no WHERE clause (referring to that
    publish operation) or the publication is declared as
-   FOR ALL TABLES
-   or FOR TABLES IN SCHEMA,
+   params-for-all-tables">FOR ALL TABLES
+   or params-for-tables-in-schema">FOR TABLES IN SCHEMA,
    rows are always published regardless of the definition of the other
    expressions. If the subscriber is a PostgreSQL
    version before 15, then any row filtering is ignored during the initial data
@@ -461,7 +461,7 @@ CREATE SUBSCRIPTION subscription_name
    deleting any initially copied data that would be incompatible with
    subsequent filtering. Because initial data synchronization does not take
    into account the publication
-   publish
+   params-with-publish">publish
    parameter when copying existing table data, some rows may be copied that
    would not be replicated using DML. See
     for examples.
index 1417d70a28d1a3d415c5f1dfcec3228195c42f95..8695571045b2d0aab5f21f9ee755d632ff5921fa 100644 (file)
@@ -1488,7 +1488,7 @@ CREATE DATABASE foo WITH TEMPLATE template0;
    truncate the target tables before initiating a new full table copy.  If users
    intend to copy initial data during refresh they must create the slot with
    two_phase = false.  After the initial sync, the
-   two_phase
+   params-with-two-phase">two_phase
    option will be automatically enabled by the subscriber if the subscription
    had been originally created with two_phase = true option.
   
index 970b3bd44b0b9e5b00a6b37b93888e8ef28d1415..7078491c4c065d46cf8a2f86c0320d7263e86aef 100644 (file)
@@ -2151,8 +2151,8 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
    tables they contain.  Unlike the underlying catalog
    pg_publication_rel,
    this view expands publications defined as
-   FOR ALL TABLES
-   and FOR TABLES IN SCHEMA,
+   params-for-all-tables">FOR ALL TABLES
+   and params-for-tables-in-schema">FOR TABLES IN SCHEMA,
    so for such publications there will be a row for each eligible table.