Doc: Warn about two_phase when altering a subscription's slot name.
authorAmit Kapila
Mon, 11 Mar 2024 04:03:04 +0000 (09:33 +0530)
committerAmit Kapila
Mon, 11 Mar 2024 04:03:04 +0000 (09:33 +0530)
We expect the 'two_phase' and 'failover' properties to match between the
slot on the publisher and a subscription option on the subscriber.
Otherwise, the slot on the publisher may behave differently from what the
subscription's failover option says.

Author: Bertrand Drouvot
Reviewed-by: Peter Smith, Tristen Raab, Amit Kapila
Discussion: https://postgr.es/m/[email protected]

doc/src/sgml/ref/alter_subscription.sgml

index e9e6d9d74ad92773d6b2056df5601c38683f97bf..413ce68ce2c6962594513ce5927b1199a4346c55 100644 (file)
@@ -235,15 +235,15 @@ ALTER SUBSCRIPTION name RENAME TO <
      
       When altering the
       slot_name,
-      the failover property value of the named slot may differ from the
+      the failover and two_phase property
+      values of the named slot may differ from the counterpart
       failover
-      parameter specified in the subscription. When creating the slot,
-      ensure the slot failover property matches the
-      failover
-      parameter value of the subscription. Otherwise, the slot on the
-      publisher may behave differently from what subscription's
-      failover
-      option says. The slot on the publisher could either be
+      and two_phase
+      parameters specified in the subscription. When creating the slot, ensure
+      the slot properties failover and two_phase
+      match their counterpart parameters of the subscription.
+      Otherwise, the slot on the publisher may behave differently from what these
+      subscription options say: for example, the slot on the publisher could either be
       synced to the standbys even when the subscription's
       failover
       option is disabled or could be disabled for sync