Rename logical_replication_mode to debug_logical_replication_streaming

The logical_replication_mode GUC is intended for testing and debugging
purposes, but its current name may be misleading and encourage users to make
unnecessary changes.

To avoid confusion, renaming the GUC to a less misleading name
debug_logical_replication_streaming that casual users are less likely to mistakenly
assume needs to be modified in a regular logical replication setup.

Author: Hou Zhijie 
Reviewed-by: Peter Smith 
Discussion: https://www.postgresql.org/message-id/flat/d672d774-c44b-6fec-f993-793e744f169a%40eisentraut.org

diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index 11251fa05ea9cc7554afa45b9de44ba5314f3835..694d667bf9701c5e79eb6e88d6195afc59708bd9 100644 (file)
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -11712,10 +11712,10 @@ LOG:  CleanUpLock: deleting: lock(0xb7acd844) id(24688,24696,0,0,0,1)
       
      
 
-     logical-replication-mode" xreflabel="logical_replication_mode">
-      logical_replication_mode (enum)
+     debug-logical-replication-streaming" xreflabel="debug_logical_replication_streaming">
+      debug_logical_replication_streaming (enum)
       
-       logical_replication_mode configuration parameter
+       debug_logical_replication_streaming configuration parameter
       
       
       
@@ -11724,12 +11724,12 @@ LOG:  CleanUpLock: deleting: lock(0xb7acd844) id(24688,24696,0,0,0,1)
         immediate. The default is buffered.
         This parameter is intended to be used to test logical decoding and
         replication of large transactions.  The effect of
-        logical_replication_mode is different for the
+        debug_logical_replication_streaming is different for the
         publisher and subscriber:
        
 
        
-        On the publisher side, logical_replication_mode
+        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
@@ -11742,7 +11742,7 @@ LOG:  CleanUpLock: deleting: lock(0xb7acd844) id(24688,24696,0,0,0,1)
 
        
         On the subscriber side, if the streaming option is set to
-        parallel, logical_replication_mode
+        parallel, debug_logical_replication_streaming
         can be used to direct the leader apply worker to send changes to the
         shared memory queue or to serialize all changes to the file.  When set to
         buffered, the leader sends changes to parallel apply

diff --git a/src/backend/replication/logical/applyparallelworker.c b/src/backend/replication/logical/applyparallelworker.c
index 4e8ee2973e0a115caae16625df3376860d05ee7e..82f48a488e9fa6bc536488e49b684200dd5d29c5 100644 (file)
--- a/src/backend/replication/logical/applyparallelworker.c
+++ b/src/backend/replication/logical/applyparallelworker.c
@@ -1160,7 +1160,7 @@ pa_send_data(ParallelApplyWorkerInfo *winfo, Size nbytes, const void *data)
     * We don't try to send data to parallel worker for 'immediate' mode. This
     * is primarily used for testing purposes.
     */
-   if (unlikely(logical_replication_mode == LOGICAL_REP_MODE_IMMEDIATE))
+   if (unlikely(debug_logical_replication_streaming == DEBUG_LOGICAL_REP_STREAMING_IMMEDIATE))
        return false;
 
 /*

diff --git a/src/backend/replication/logical/reorderbuffer.c b/src/backend/replication/logical/reorderbuffer.c
index 87a4d2a24b7ac2259cd264b39c0070639c440d51..0dab0bb64e8d6c668abf44166118e523f3270baa 100644 (file)
--- a/src/backend/replication/logical/reorderbuffer.c
+++ b/src/backend/replication/logical/reorderbuffer.c
@@ -210,7 +210,7 @@ int         logical_decoding_work_mem;
 static const Size max_changes_in_memory = 4096; /* XXX for restore only */
 
 /* GUC variable */
-int            logical_replication_mode = LOGICAL_REP_MODE_BUFFERED;
+int            debug_logical_replication_streaming = DEBUG_LOGICAL_REP_STREAMING_BUFFERED;
 
 /* ---------------------------------------
  * primary reorderbuffer support routines
@@ -3566,8 +3566,8 @@ ReorderBufferLargestStreamableTopTXN(ReorderBuffer *rb)
  * pick the largest (sub)transaction at-a-time to evict and spill its changes to
  * disk or send to the output plugin until we reach under the memory limit.
  *
- * If logical_replication_mode is set to "immediate", stream or serialize the
- * changes immediately.
+ * If debug_logical_replication_streaming is set to "immediate", stream or
+ * serialize the changes immediately.
  *
  * XXX At this point we select the transactions until we reach under the memory
  * limit, but we might also adapt a more elaborate eviction strategy - for example
@@ -3580,25 +3580,25 @@ ReorderBufferCheckMemoryLimit(ReorderBuffer *rb)
    ReorderBufferTXN *txn;
 
    /*
-    * Bail out if logical_replication_mode is buffered and we haven't
-    * exceeded the memory limit.
+    * Bail out if debug_logical_replication_streaming is buffered and we
+    * haven't exceeded the memory limit.
     */
-   if (logical_replication_mode == LOGICAL_REP_MODE_BUFFERED &&
+   if (debug_logical_replication_streaming == DEBUG_LOGICAL_REP_STREAMING_BUFFERED &&
        rb->size < logical_decoding_work_mem * 1024L)
        return;
 
    /*
-    * If logical_replication_mode is immediate, loop until there's no change.
-    * Otherwise, loop until we reach under the memory limit. One might think
-    * that just by evicting the largest (sub)transaction we will come under
-    * the memory limit based on assumption that the selected transaction is
-    * at least as large as the most recent change (which caused us to go over
-    * the memory limit). However, that is not true because a user can reduce
-    * the logical_decoding_work_mem to a smaller value before the most recent
-    * change.
+    * If debug_logical_replication_streaming is immediate, loop until there's
+    * no change. Otherwise, loop until we reach under the memory limit. One
+    * might think that just by evicting the largest (sub)transaction we will
+    * come under the memory limit based on assumption that the selected
+    * transaction is at least as large as the most recent change (which
+    * caused us to go over the memory limit). However, that is not true
+    * because a user can reduce the logical_decoding_work_mem to a smaller
+    * value before the most recent change.
     */
    while (rb->size >= logical_decoding_work_mem * 1024L ||
-          (logical_replication_mode == LOGICAL_REP_MODE_IMMEDIATE &&
+          (debug_logical_replication_streaming == DEBUG_LOGICAL_REP_STREAMING_IMMEDIATE &&
            rb->size > 0))
    {
        /*

diff --git a/src/backend/utils/misc/guc_tables.c b/src/backend/utils/misc/guc_tables.c
index e0ca48a27d4174d0915c18085df3b5ca818a4d3e..e565a3092f6eedba58c4224e081ded79f2cbf6ad 100644 (file)
--- a/src/backend/utils/misc/guc_tables.c
+++ b/src/backend/utils/misc/guc_tables.c
@@ -420,9 +420,9 @@ static const struct config_enum_entry ssl_protocol_versions_info[] = {
    {NULL, 0, false}
 };
 
-static const struct config_enum_entry logical_replication_mode_options[] = {
-   {"buffered", LOGICAL_REP_MODE_BUFFERED, false},
-   {"immediate", LOGICAL_REP_MODE_IMMEDIATE, false},
+static const struct config_enum_entry debug_logical_replication_streaming_options[] = {
+   {"buffered", DEBUG_LOGICAL_REP_STREAMING_BUFFERED, false},
+   {"immediate", DEBUG_LOGICAL_REP_STREAMING_IMMEDIATE, false},
    {NULL, 0, false}
 };
 
@@ -4969,15 +4969,15 @@ struct config_enum ConfigureNamesEnum[] =
    },
 
    {
-       {"logical_replication_mode", PGC_USERSET, DEVELOPER_OPTIONS,
-           gettext_noop("Controls when to replicate or apply each change."),
+       {"debug_logical_replication_streaming", PGC_USERSET, DEVELOPER_OPTIONS,
+           gettext_noop("Forces immediate streaming or serialization of changes in large transactions."),
            gettext_noop("On the publisher, it allows streaming or serializing each change in logical decoding. "
                         "On the subscriber, it allows serialization of all changes to files and notifies the "
                         "parallel apply workers to read and apply them at the end of the transaction."),
            GUC_NOT_IN_SAMPLE
        },
-       &logical_replication_mode,
-       LOGICAL_REP_MODE_BUFFERED, logical_replication_mode_options,
+       &debug_logical_replication_streaming,
+       DEBUG_LOGICAL_REP_STREAMING_BUFFERED, debug_logical_replication_streaming_options,
        NULL, NULL, NULL
    },
 

diff --git a/src/include/replication/reorderbuffer.h b/src/include/replication/reorderbuffer.h
index 1b9db22acbd7fd74c251d2bb505147ea204505f1..3cb03168de246ce32ebd78068a30a36d6cd397d4 100644 (file)
--- a/src/include/replication/reorderbuffer.h
+++ b/src/include/replication/reorderbuffer.h
@@ -19,14 +19,14 @@
 
 /* GUC variables */
 extern PGDLLIMPORT int logical_decoding_work_mem;
-extern PGDLLIMPORT int logical_replication_mode;
+extern PGDLLIMPORT int debug_logical_replication_streaming;
 
-/* possible values for logical_replication_mode */
+/* possible values for debug_logical_replication_streaming */
 typedef enum
 {
-   LOGICAL_REP_MODE_BUFFERED,
-   LOGICAL_REP_MODE_IMMEDIATE
-}          LogicalRepMode;
+   DEBUG_LOGICAL_REP_STREAMING_BUFFERED,
+   DEBUG_LOGICAL_REP_STREAMING_IMMEDIATE
+}          DebugLogicalRepStreamingMode;
 
 /* an individual tuple, stored in one chunk of memory */
 typedef struct ReorderBufferTupleBuf

diff --git a/src/test/subscription/t/015_stream.pl b/src/test/subscription/t/015_stream.pl
index b450a78adf78d614ab80ae10c111da6532c6ddcb..603d00f9e78f60c4d69403bb12e5707e4ebc04ef 100644 (file)
--- a/src/test/subscription/t/015_stream.pl
+++ b/src/test/subscription/t/015_stream.pl
@@ -295,7 +295,7 @@ is($result, qq(10000), 'data replicated to subscriber after dropping index');
 # Test serializing changes to files and notify the parallel apply worker to
 # apply them at the end of the transaction.
 $node_subscriber->append_conf('postgresql.conf',
-   'logical_replication_mode = immediate');
+   'debug_logical_replication_streaming = immediate');
 # Reset the log_min_messages to default.
 $node_subscriber->append_conf('postgresql.conf',
    "log_min_messages = warning");

diff --git a/src/test/subscription/t/016_stream_subxact.pl b/src/test/subscription/t/016_stream_subxact.pl
index 838049af65c36ff435f005652475dcd4ca754a77..9a2f06f272080b34bb17ea94c9361258706c2a74 100644 (file)
--- a/src/test/subscription/t/016_stream_subxact.pl
+++ b/src/test/subscription/t/016_stream_subxact.pl
@@ -79,7 +79,7 @@ sub test_streaming
 my $node_publisher = PostgreSQL::Test::Cluster->new('publisher');
 $node_publisher->init(allows_streaming => 'logical');
 $node_publisher->append_conf('postgresql.conf',
-   'logical_replication_mode = immediate');
+   'debug_logical_replication_streaming = immediate');
 $node_publisher->start;
 
 # Create subscriber node

diff --git a/src/test/subscription/t/018_stream_subxact_abort.pl b/src/test/subscription/t/018_stream_subxact_abort.pl
index 77c96011a9236f3edb81edcca57384e5a9b42fe2..201138882c383393656808206fb44998e369845a 100644 (file)
--- a/src/test/subscription/t/018_stream_subxact_abort.pl
+++ b/src/test/subscription/t/018_stream_subxact_abort.pl
@@ -130,7 +130,7 @@ sub test_streaming
 my $node_publisher = PostgreSQL::Test::Cluster->new('publisher');
 $node_publisher->init(allows_streaming => 'logical');
 $node_publisher->append_conf('postgresql.conf',
-   'logical_replication_mode = immediate');
+   'debug_logical_replication_streaming = immediate');
 $node_publisher->start;
 
 # Create subscriber node
@@ -203,7 +203,7 @@ test_streaming($node_publisher, $node_subscriber, $appname, 1);
 # Test serializing changes to files and notify the parallel apply worker to
 # apply them at the end of the transaction.
 $node_subscriber->append_conf('postgresql.conf',
-   'logical_replication_mode = immediate');
+   'debug_logical_replication_streaming = immediate');
 # Reset the log_min_messages to default.
 $node_subscriber->append_conf('postgresql.conf',
    "log_min_messages = warning");

diff --git a/src/test/subscription/t/019_stream_subxact_ddl_abort.pl b/src/test/subscription/t/019_stream_subxact_ddl_abort.pl
index 6c2a9c5bf123fc75731829900011b11636a9d0b2..1ad7ace84a09e2a9d121f4088cbf718f15961b23 100644 (file)
--- a/src/test/subscription/t/019_stream_subxact_ddl_abort.pl
+++ b/src/test/subscription/t/019_stream_subxact_ddl_abort.pl
@@ -16,7 +16,7 @@ use Test::More;
 my $node_publisher = PostgreSQL::Test::Cluster->new('publisher');
 $node_publisher->init(allows_streaming => 'logical');
 $node_publisher->append_conf('postgresql.conf',
-   'logical_replication_mode = immediate');
+   'debug_logical_replication_streaming = immediate');
 $node_publisher->start;
 
 # Create subscriber node

diff --git a/src/test/subscription/t/023_twophase_stream.pl b/src/test/subscription/t/023_twophase_stream.pl
index fdc9e2a0f047c9df63d0ded0d4848602932ad1a5..be9f2aab282e7861160cc9d225b18d033c5379a3 100644 (file)
--- a/src/test/subscription/t/023_twophase_stream.pl
+++ b/src/test/subscription/t/023_twophase_stream.pl
@@ -301,7 +301,7 @@ $node_publisher->init(allows_streaming => 'logical');
 $node_publisher->append_conf(
    'postgresql.conf', qq(
 max_prepared_transactions = 10
-logical_replication_mode = immediate
+debug_logical_replication_streaming = immediate
 ));
 $node_publisher->start;
 
@@ -389,7 +389,7 @@ test_streaming($node_publisher, $node_subscriber, $appname, 1);
 # Test serializing changes to files and notify the parallel apply worker to
 # apply them at the end of the transaction.
 $node_subscriber->append_conf('postgresql.conf',
-   'logical_replication_mode = immediate');
+   'debug_logical_replication_streaming = immediate');
 # Reset the log_min_messages to default.
 $node_subscriber->append_conf('postgresql.conf',
    "log_min_messages = warning");