doc: Add referential actions to CREATE/ALTER TABLE synopsis
authorPeter Eisentraut <peter@eisentraut.org>
Thu, 11 Nov 2021 09:49:44 +0000 (10:49 +0100)
committerPeter Eisentraut <peter@eisentraut.org>
Thu, 11 Nov 2021 09:49:44 +0000 (10:49 +0100)
The general constraint synopsis references "referential_action", but
this was not further defined in the synopsis section.  Compared to the
level of detail that the synopsis gives to other subclauses, this
should surely be there.

extracted from a patch by Paul Martinez <hellopfm@gmail.com>

Discussion: https://www.postgresql.org/message-id/flat/CACqFVBZQyMYJV=njbSMxf+rbDHpx=W=B7AEaMKn8dWn9OZJY7w@mail.gmail.com

doc/src/sgml/ref/alter_table.sgml
doc/src/sgml/ref/create_table.sgml

index 2d639a66af0e318cc0be23b92969a4d2a948a328..bc5dcba59ced6e402e2c1c5ab6b77cbb6c8458c6 100644 (file)
@@ -135,6 +135,10 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM
 <phrase><replaceable class="parameter">exclude_element</replaceable> in an <literal>EXCLUDE</literal> constraint is:</phrase>
 
 { <replaceable class="parameter">column_name</replaceable> | ( <replaceable class="parameter">expression</replaceable> ) } [ <replaceable class="parameter">opclass</replaceable> ] [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
+
+<phrase><replaceable class="parameter">referential_action</replaceable> in a <literal>FOREIGN KEY</literal>/<literal>REFERENCES</literal> constraint is:</phrase>
+
+{ NO ACTION | RESTRICT | CASCADE | SET NULL | SET DEFAULT }
 </synopsis>
  </refsynopsisdiv>
 
index 61a584fa34c0318e0c9ab8070183a04976f05d44..57d51a676a739914514e93af494560685257fdc9 100644 (file)
@@ -105,6 +105,10 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM
 <phrase><replaceable class="parameter">exclude_element</replaceable> in an <literal>EXCLUDE</literal> constraint is:</phrase>
 
 { <replaceable class="parameter">column_name</replaceable> | ( <replaceable class="parameter">expression</replaceable> ) } [ <replaceable class="parameter">opclass</replaceable> ] [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
+
+<phrase><replaceable class="parameter">referential_action</replaceable> in a <literal>FOREIGN KEY</literal>/<literal>REFERENCES</literal> constraint is:</phrase>
+
+{ NO ACTION | RESTRICT | CASCADE | SET NULL | SET DEFAULT }
 </synopsis>
 
  </refsynopsisdiv>