From: Amit Kapila <akapila@postgresql.org>
Date: Thu, 24 Jun 2021 04:52:46 +0000 (+0530)
Subject: Doc: Update caveats in synchronous logical replication.
X-Git-Tag: REL9_6_23~58
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=4be39ef9cbc5afc6078bdf9253e5981da6e0cf5f;p=thirdparty%2Fpostgresql.git

Doc: Update caveats in synchronous logical replication.

Reported-by: Simon Riggs
Author: Takamichi Osumi
Reviewed-by: Amit Kapila
Backpatch-through: 9.6
Discussion: https://www.postgresql.org/message-id/20210222222847.tpnb6eg3yiykzpky@alap3.anarazel.de
---

diff --git a/doc/src/sgml/logicaldecoding.sgml b/doc/src/sgml/logicaldecoding.sgml
index f044e80febe..b30c27e1488 100644
--- a/doc/src/sgml/logicaldecoding.sgml
+++ b/doc/src/sgml/logicaldecoding.sgml
@@ -715,16 +715,18 @@ OutputPluginWrite(ctx, true);
 
     <para>
      In synchronous replication setup, a deadlock can happen, if the transaction
-     has locked [user] catalog tables exclusively. This is because logical decoding of
-     transactions can lock catalog tables to access them. To avoid this users
-     must refrain from taking an exclusive lock on [user] catalog tables. This can
-     happen in the following ways:
+     has locked [user] catalog tables exclusively. See
+     <xref linkend="logicaldecoding-capabilities"> for information on user
+     catalog tables. This is because logical decoding of transactions can lock
+     catalog tables to access them. To avoid this users must refrain from taking
+     an exclusive lock on [user] catalog tables. This can happen in the following
+     ways:
 
      <itemizedlist>
       <listitem>
        <para>
         Issuing an explicit <command>LOCK</command> on <structname>pg_class</structname>
-        (or any other catalog table) in a transaction.
+        in a transaction.
        </para>
       </listitem>
 
@@ -742,6 +744,10 @@ OutputPluginWrite(ctx, true);
        </para>
       </listitem>
      </itemizedlist>
+
+     Note that these commands that can cause deadlock apply to not only explicitly
+     indicated system catalog tables above but also to any other [user] catalog
+     table.
     </para>
    </sect2>
   </sect1>