Debian Codegraph @

doc/src/sgml/ref/drop_rule.sgml

raw
1 <!--
2 doc/src/sgml/ref/drop_rule.sgml
3 PostgreSQL documentation
4 -->
5
6 <refentry id="sql-droprule">
7 <indexterm zone="sql-droprule">
8 <primary>DROP RULE</primary>
9 </indexterm>
10
11 <refmeta>
12 <refentrytitle>DROP RULE</refentrytitle>
13 <manvolnum>7</manvolnum>
14 <refmiscinfo>SQL - Language Statements</refmiscinfo>
15 </refmeta>
16
17 <refnamediv>
18 <refname>DROP RULE</refname>
19 <refpurpose>remove a rewrite rule</refpurpose>
20 </refnamediv>
21
22 <refsynopsisdiv>
23 <synopsis>
24 DROP RULE [ IF EXISTS ] <replaceable class="parameter">name</replaceable> ON <replaceable class="parameter">table_name</replaceable> [ CASCADE | RESTRICT ]
25 </synopsis>
26 </refsynopsisdiv>
27
28 <refsect1>
29 <title>Description</title>
30
31 <para>
32 <command>DROP RULE</command> drops a rewrite rule.
33 </para>
34 </refsect1>
35
36 <refsect1>
37 <title>Parameters</title>
38
39 <variablelist>
40
41 <varlistentry>
42 <term><literal>IF EXISTS</literal></term>
43 <listitem>
44 <para>
45 Do not throw an error if the rule does not exist. A notice is issued
46 in this case.
47 </para>
48 </listitem>
49 </varlistentry>
50
51 <varlistentry>
52 <term><replaceable class="parameter">name</replaceable></term>
53 <listitem>
54 <para>
55 The name of the rule to drop.
56 </para>
57 </listitem>
58 </varlistentry>
59
60 <varlistentry>
61 <term><replaceable class="parameter">table_name</replaceable></term>
62 <listitem>
63 <para>
64 The name (optionally schema-qualified) of the table or view that
65 the rule applies to.
66 </para>
67 </listitem>
68 </varlistentry>
69
70 <varlistentry>
71 <term><literal>CASCADE</literal></term>
72 <listitem>
73 <para>
74 Automatically drop objects that depend on the rule,
75 and in turn all objects that depend on those objects
76 (see <xref linkend="ddl-depend"/>).
77 </para>
78 </listitem>
79 </varlistentry>
80
81 <varlistentry>
82 <term><literal>RESTRICT</literal></term>
83 <listitem>
84 <para>
85 Refuse to drop the rule if any objects depend on it. This is
86 the default.
87 </para>
88 </listitem>
89 </varlistentry>
90 </variablelist>
91 </refsect1>
92
93 <refsect1>
94 <title>Examples</title>
95
96 <para>
97 To drop the rewrite rule <literal>newrule</literal>:
98
99 <programlisting>
100 DROP RULE newrule ON mytable;
101 </programlisting></para>
102 </refsect1>
103
104 <refsect1>
105 <title>Compatibility</title>
106
107 <para>
108 <command>DROP RULE</command> is a
109 <productname>PostgreSQL</productname> language extension, as is the
110 entire query rewrite system.
111 </para>
112 </refsect1>
113
114 <refsect1>
115 <title>See Also</title>
116
117 <simplelist type="inline">
118 <member><xref linkend="sql-createrule"/></member>
119 <member><xref linkend="sql-alterrule"/></member>
120 </simplelist>
121 </refsect1>
122
123 </refentry>