Document lock taken on referenced table when adding a foreign key

This can happen for CREATE TABLE and ALTER TABLE, so a mention is added
to both of them in the concerned subsections.

Author: Adrien Nayrat
Discussion: https://postgr.es/m/c4e8af11-1dfc-766a-c953-76979b9fcdaa@anayrat.info

diff --git a/doc/src/sgml/ref/alter_table.sgml b/doc/src/sgml/ref/alter_table.sgml
index ec6b4c331137d62398d75bfa0fbae92eec39ac31..f13a6cd944df57278fc289fa79425a649675f032 100644 (file)
--- a/doc/src/sgml/ref/alter_table.sgml
+++ b/doc/src/sgml/ref/alter_table.sgml
@@ -372,6 +372,11 @@ WITH ( MODULUS numeric_literal, REM
       tables may not be declared NOT VALID at present.
      
 
+     
+      The addition of a foreign key constraint requires a
+      SHARE ROW EXCLUSIVE lock on the referenced table.
+     
+
      
       Additional restrictions apply when unique or primary key constraints
       are added to partitioned tables; see .

diff --git a/doc/src/sgml/ref/create_table.sgml b/doc/src/sgml/ref/create_table.sgml
index 5a19f94ce91f67ca19b958a09133240098771b93..10428f8ff03cc4799a7e1ef0630cde33cf41721a 100644 (file)
--- a/doc/src/sgml/ref/create_table.sgml
+++ b/doc/src/sgml/ref/create_table.sgml
@@ -992,7 +992,9 @@ WITH ( MODULUS numeric_literal, REM
       is used.  The referenced columns must be the columns of a non-deferrable
       unique or primary key constraint in the referenced table.  The user
       must have REFERENCES permission on the referenced table
-      (either the whole table, or the specific referenced columns).
+      (either the whole table, or the specific referenced columns).  The
+      addition of a foreign key constraint requires a
+      SHARE ROW EXCLUSIVE lock on the referenced table.
       Note that foreign key constraints cannot be defined between temporary
       tables and permanent tables.  Also note that while it is possible to
       define a foreign key on a partitioned table, it is not possible to