summaryrefslogtreecommitdiffstats
path: root/doc/src/sgml/ref/drop_domain.sgml
blob: b18faf391752d5f9aeb4fbef41fe2fb607148820 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
<!--
doc/src/sgml/ref/drop_domain.sgml
PostgreSQL documentation
-->

<refentry id="sql-dropdomain">
 <indexterm zone="sql-dropdomain">
  <primary>DROP DOMAIN</primary>
 </indexterm>

 <refmeta>
  <refentrytitle>DROP DOMAIN</refentrytitle>
  <manvolnum>7</manvolnum>
  <refmiscinfo>SQL - Language Statements</refmiscinfo>
 </refmeta>

 <refnamediv>
  <refname>DROP DOMAIN</refname>
  <refpurpose>remove a domain</refpurpose>
 </refnamediv>

 <refsynopsisdiv>
<synopsis>
DROP DOMAIN [ IF EXISTS ] <replaceable class="parameter">name</replaceable> [, ...] [ CASCADE | RESTRICT ]
</synopsis>
 </refsynopsisdiv>

 <refsect1>
  <title>Description</title>

  <para>
   <command>DROP DOMAIN</command> removes a domain.  Only the owner of
   a domain can remove it.
  </para>
 </refsect1>

 <refsect1>
  <title>Parameters</title>

  <variablelist>
   <varlistentry>
    <term><literal>IF EXISTS</literal></term>
    <listitem>
     <para>
      Do not throw an error if the domain does not exist. A notice is issued
      in this case.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term><replaceable class="parameter">name</replaceable></term>
    <listitem>
     <para>
      The name (optionally schema-qualified) of an existing domain.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term><literal>CASCADE</literal></term>
    <listitem>
     <para>
      Automatically drop objects that depend on the domain (such as
      table columns),
      and in turn all objects that depend on those objects
      (see <xref linkend="ddl-depend"/>).
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term><literal>RESTRICT</literal></term>
    <listitem>
     <para>
      Refuse to drop the domain if any objects depend on it.  This is
      the default.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 id="sql-dropdomain-examples">
  <title>Examples</title>

  <para>
   To remove the domain <type>box</type>:

<programlisting>
DROP DOMAIN box;
</programlisting></para>
 </refsect1>

 <refsect1 id="sql-dropdomain-compatibility">
  <title>Compatibility</title>

  <para>
   This command conforms to the SQL standard, except for the
   <literal>IF EXISTS</literal> option, which is a <productname>PostgreSQL</productname>
   extension.
  </para>
 </refsect1>

 <refsect1 id="sql-dropdomain-see-also">
  <title>See Also</title>

  <simplelist type="inline">
   <member><xref linkend="sql-createdomain"/></member>
   <member><xref linkend="sql-alterdomain"/></member>
  </simplelist>
 </refsect1>

</refentry>