diff options
Diffstat (limited to 'doc/src/sgml/ref/create_constraint.sgml')
-rw-r--r-- | doc/src/sgml/ref/create_constraint.sgml | 150 |
1 files changed, 150 insertions, 0 deletions
diff --git a/doc/src/sgml/ref/create_constraint.sgml b/doc/src/sgml/ref/create_constraint.sgml new file mode 100644 index 00000000000..474b848a91b --- /dev/null +++ b/doc/src/sgml/ref/create_constraint.sgml @@ -0,0 +1,150 @@ +<!-- +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_constraint.sgml,v 1.1 2000/04/14 15:17:28 thomas Exp $ +Postgres documentation +--> + +<refentry id="SQL-CREATECONSTRAINT"> + <refmeta> + <refentrytitle id="sql-createconstraint-title"> + CREATE CONSTRAINT TRIGGER + </refentrytitle> + <refmiscinfo>SQL - Language Statements</refmiscinfo> + </refmeta> + <refnamediv> + <refname> + CREATE CONSTRAINT TRIGGER + </refname> + <refpurpose> + Create a trigger to support a constraint + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <refsynopsisdivinfo> + <date>2000-04-13</date> + </refsynopsisdivinfo> + <synopsis> +CREATE CONSTRAINT TRIGGER <replaceable class="parameter">name</replaceable> + AFTER <replaceable class="parameter">events</replaceable> ON + <replaceable class="parameter">relation</replaceable> <replaceable class="parameter">constraint</replaceable> <replaceable class="parameter">attributes</replaceable> + FOR EACH ROW EXECUTE PROCEDURE <replaceable class="parameter">func</replaceable> '(' <replaceable class="parameter">args</replaceable> ')' + </synopsis> + + <refsect2 id="R2-SQL-CREATECONSTRAINT-1"> + <title> + Inputs + </title> + <para> + + <variablelist> + <varlistentry> + <term><replaceable class="PARAMETER">name</replaceable></term> + <listitem> + <para> + The name of the constraint trigger. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable class="PARAMETER">events</replaceable></term> + <listitem> + <para> + The event categories for which this trigger should be fired. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable class="PARAMETER">relation</replaceable></term> + <listitem> + <para> + Table name of the triggering relation. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable class="PARAMETER">constraint</replaceable></term> + <listitem> + <para> + Actual onstraint specification. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable class="PARAMETER">attributes</replaceable></term> + <listitem> + <para> + Contraint attributes. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable class="PARAMETER">func</replaceable>(<replaceable class="PARAMETER">args</replaceable>)</term> + <listitem> + <para> + Function to call as part of the trigger processing. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect2> + + <refsect2 id="R2-SQL-CREATECONSTRAINT-2"> + <title> + Outputs + </title> + <para> + + <variablelist> + <varlistentry> + <term><computeroutput> +CREATE CONSTRAINT + </computeroutput></term> + <listitem> + <para> + Message returned if successful. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect2> + </refsynopsisdiv> + + <refsect1 id="R1-SQL-CREATECONSTRAINT-1"> + <title> + Description + </title> + <para> + <command>CREATE CONSTRAINT TRIGGER</command> is used from inside of + <command>CREATE/ALTER TABLE</command> and by + <application>pg_dump</application> to create the special triggers for + referential integrity. + </para> + + <para> + It is not intended for general use. + </para> + </refsect1> +</refentry> + +<!-- Keep this comment at the end of the file +Local variables: +mode: sgml +sgml-omittag:nil +sgml-shorttag:t +sgml-minimize-attributes:nil +sgml-always-quote-attributes:t +sgml-indent-step:1 +sgml-indent-data:t +sgml-parent-document:nil +sgml-default-dtd-file:"../reference.ced" +sgml-exposed-tags:nil +sgml-local-catalogs:"/usr/lib/sgml/catalog" +sgml-local-ecat-files:nil +End: +--> |