diff options
| author | Peter Eisentraut <peter@eisentraut.org> | 2023-08-29 15:15:54 +0200 |
|---|---|---|
| committer | Peter Eisentraut <peter@eisentraut.org> | 2023-08-29 15:24:09 +0200 |
| commit | 39d4207e876fa55971cd20a7677b78f067971fd3 (patch) | |
| tree | a989386b1e8b9cebacc2d9935a54ce5965d23452 /doc/src | |
| parent | cd59fcff256d68e028bf8a181d4e166e81b6474b (diff) | |
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 <houzj.fnst@cn.fujitsu.com>
Reviewed-by: Peter Smith <smithpb2250@gmail.com>
Discussion: https://www.postgresql.org/message-id/flat/d672d774-c44b-6fec-f993-793e744f169a%40eisentraut.org
Diffstat (limited to 'doc/src')
| -rw-r--r-- | doc/src/sgml/config.sgml | 12 | ||||
| -rw-r--r-- | doc/src/sgml/release-16.sgml | 2 |
2 files changed, 7 insertions, 7 deletions
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml index a5cb15febaa..bc140c35667 100644 --- a/doc/src/sgml/config.sgml +++ b/doc/src/sgml/config.sgml @@ -11743,10 +11743,10 @@ LOG: CleanUpLock: deleting: lock(0xb7acd844) id(24688,24696,0,0,0,1) </listitem> </varlistentry> - <varlistentry id="guc-logical-replication-mode" xreflabel="logical_replication_mode"> - <term><varname>logical_replication_mode</varname> (<type>enum</type>) + <varlistentry id="guc-debug-logical-replication-streaming" xreflabel="debug_logical_replication_streaming"> + <term><varname>debug_logical_replication_streaming</varname> (<type>enum</type>) <indexterm> - <primary><varname>logical_replication_mode</varname> configuration parameter</primary> + <primary><varname>debug_logical_replication_streaming</varname> configuration parameter</primary> </indexterm> </term> <listitem> @@ -11755,12 +11755,12 @@ LOG: CleanUpLock: deleting: lock(0xb7acd844) id(24688,24696,0,0,0,1) <literal>immediate</literal>. The default is <literal>buffered</literal>. This parameter is intended to be used to test logical decoding and replication of large transactions. The effect of - <varname>logical_replication_mode</varname> is different for the + <varname>debug_logical_replication_streaming</varname> is different for the publisher and subscriber: </para> <para> - On the publisher side, <varname>logical_replication_mode</varname> + On the publisher side, <varname>debug_logical_replication_streaming</varname> allows streaming or serializing changes immediately in logical decoding. When set to <literal>immediate</literal>, stream each change if the <link linkend="sql-createsubscription-with-streaming"><literal>streaming</literal></link> @@ -11773,7 +11773,7 @@ LOG: CleanUpLock: deleting: lock(0xb7acd844) id(24688,24696,0,0,0,1) <para> On the subscriber side, if the <literal>streaming</literal> option is set to - <literal>parallel</literal>, <varname>logical_replication_mode</varname> + <literal>parallel</literal>, <varname>debug_logical_replication_streaming</varname> 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 <literal>buffered</literal>, the leader sends changes to parallel apply diff --git a/doc/src/sgml/release-16.sgml b/doc/src/sgml/release-16.sgml index 21843618ee7..2eb172eaa63 100644 --- a/doc/src/sgml/release-16.sgml +++ b/doc/src/sgml/release-16.sgml @@ -1709,7 +1709,7 @@ Author: Amit Kapila <akapila@postgresql.org> <para> The variable is <link - linkend="guc-logical-replication-mode"><varname>logical_replication_mode</varname></link>. + linkend="guc-debug-logical-replication-streaming"><varname>debug_logical_replication_streaming</varname></link>. </para> </listitem> |