postgresql/doc/src/sgml/ref/drop_domain.sgml

<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_domain.sgml,v 1.6 2002/05/18 15:44:47 petere Exp $
PostgreSQL documentation
-->

<refentry id="SQL-DROPDOMAIN">
 <refmeta>
  <refentrytitle id="SQL-DROPDOMAIN-TITLE">
   DROP DOMAIN
  </refentrytitle>
  <refmiscinfo>SQL - Language Statements</refmiscinfo>
 </refmeta>
 <refnamediv>
  <refname>
   DROP DOMAIN
  </refname>
  <refpurpose>
   remove a user-defined domain
  </refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  <refsynopsisdivinfo>
   <date>1999-07-20</date>
  </refsynopsisdivinfo>
  <synopsis>
DROP DOMAIN <replaceable class="PARAMETER">domainname</replaceable> [, ...]  [ CASCADE | RESTRICT ]
  </synopsis>

  <refsect2 id="R2-SQL-DROPDOMAIN-1">
   <refsect2info>
    <date>2002-02-24</date>
   </refsect2info>
   <title>
    Inputs
   </title>
   <para>
    <variablelist>
     <varlistentry>
      <term><replaceable class="PARAMETER">domainname</replaceable></term>
      <listitem>
       <para>
	The name (optionally schema-qualified) of an existing domain.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><literal>CASCADE</></term>
      <listitem>
       <para>
        Automatically drop objects that depend on the domain.  This
	behavior is not currently supported.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><literal>RESTRICT</></term>
      <listitem>
       <para>
        Do not drop dependent objects.  This is the default.
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </para>
  </refsect2>

  <refsect2 id="R2-SQL-DROPDOMAIN-2">
   <refsect2info>
    <date>2002-02-24</date>
   </refsect2info>
   <title>
    Outputs
   </title>
   <para>
    <variablelist>
     <varlistentry>
      <term><computeroutput>
DROP DOMAIN
       </computeroutput></term>
      <listitem>
       <para>
	The message returned if the command is successful.
       </para>
      </listitem>
     </varlistentry>
     <varlistentry>
      <term><computeroutput>
ERROR:  RemoveDomain: type '<replaceable class="parameter">domainname</replaceable>' does not exist
       </computeroutput></term>
      <listitem>
       <para>
	This message occurs if the specified domain (or type) is not found.
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </para>
  </refsect2>
 </refsynopsisdiv>

 <refsect1 id="R1-SQL-DROPDOMAIN-1">
  <refsect1info>
   <date>2002-02-24</date>
  </refsect1info>
  <title>
   Description
  </title>
  <para>
   <command>DROP DOMAIN</command> will remove a user domain from the
   system catalogs.
  </para>
  <para>
   Only the owner of a domain can remove it.
  </para>
 </refsect1>

 <refsect1 id="SQL-DROPDOMAIN-notes">
  <title>Notes</title>

  <itemizedlist>
   <listitem>
    <para>
     It is the user's responsibility to remove any operators,
     functions, aggregates, access methods, and tables that
     use a deleted domain.
    </para>
   </listitem>
  </itemizedlist>
 </refsect1>

 <refsect1 id="SQL-DROPDOMAIN-examples">
  <title>Examples</title>
  <para>
   To remove the <type>box</type> domain:

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

 <refsect1 id="SQL-DROPDOMAIN-compatibility">
  <title>Compatibility</title>

  <para>
   A <command>DROP DOMAIN</command> statement exists in SQL99.  As with
   most other <quote>drop</quote> commands, <command>DROP
   DOMAIN</command> in SQL99 requires a <quote>drop behavior</quote>
   clause to select between dropping all dependent objects or refusing
   to drop if dependent objects exist:
<synopsis>
DROP DOMAIN <replaceable>name</replaceable> { CASCADE | RESTRICT }
</synopsis>
   <productname>PostgreSQL</productname> accepts only the RESTRICT
   option, and currently does not check for existence of dependent objects.
  </para>
 </refsect1>

 <refsect1 id="SQL-DROPDOMAIN-see-also">
  <title>See Also</title>

  <simplelist type="inline">
   <member><xref linkend="sql-createdomain"></member>
  </simplelist>
 </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:
-->