granicus.if.org Git - postgresql/blob - doc/src/sgml/ref/drop_function.sgml

   1 <!--
   2 $Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_function.sgml,v 1.28 2003/09/22 00:16:58 petere Exp $
   3 PostgreSQL documentation
   4 -->
   5
   6 <refentry id="SQL-DROPFUNCTION">
   7  <refmeta>
   8   <refentrytitle id="SQL-DROPFUNCTION-TITLE">DROP FUNCTION</refentrytitle>
   9   <refmiscinfo>SQL - Language Statements</refmiscinfo>
  10  </refmeta>
  11
  12  <refnamediv>
  13   <refname>DROP FUNCTION</refname>
  14   <refpurpose>remove a function</refpurpose>
  15  </refnamediv>
  16
  17  <indexterm zone="sql-dropfunction">
  18   <primary>DROP FUNCTION</primary>
  19  </indexterm>
  20
  21  <refsynopsisdiv>
  22 <synopsis>
  23 DROP FUNCTION <replaceable class="parameter">name</replaceable> ( [ <replaceable class="parameter">type</replaceable> [, ...] ] ) [ CASCADE | RESTRICT ]
  24 </synopsis>
  25  </refsynopsisdiv>
  26
  27  <refsect1>
  28   <title>Description</title>
  29
  30   <para>
  31    <command>DROP FUNCTION</command> removes the definition of an existing
  32    function. To execute this command the user must be the
  33    owner of the function. The argument types to the
  34    function must be specified, since several different functions
  35    may exist with the same name and different argument lists.
  36   </para>
  37  </refsect1>
  38
  39  <refsect1>
  40   <title>Parameters</title>
  41
  42   <variablelist>
  43    <varlistentry>
  44     <term><replaceable class="parameter">name</replaceable></term>
  45     <listitem>
  46      <para>
  47       The name (optionally schema-qualified) of an existing function.
  48      </para>
  49     </listitem>
  50    </varlistentry>
  51
  52    <varlistentry>
  53     <term><replaceable class="parameter">type</replaceable></term>
  54     <listitem>
  55      <para>
  56       The data type of an argument of the function.
  57      </para>
  58     </listitem>
  59    </varlistentry>
  60
  61    <varlistentry>
  62     <term><literal>CASCADE</literal></term>
  63     <listitem>
  64      <para>
  65       Automatically drop objects that depend on the function (such as
  66       operators or triggers).
  67      </para>
  68     </listitem>
  69    </varlistentry>
  70
  71    <varlistentry>
  72     <term><literal>RESTRICT</literal></term>
  73     <listitem>
  74      <para>
  75       Refuse to drop the function if any objects depend on it.  This
  76       is the default.
  77      </para>
  78     </listitem>
  79    </varlistentry>
  80   </variablelist>
  81  </refsect1>
  82
  83  <refsect1 id="SQL-DROPFUNCTION-examples">
  84   <title>Examples</title>
  85
  86   <para>
  87    This command removes the square root function:
  88
  89 <programlisting>
  90 DROP FUNCTION sqrt(integer);
  91 </programlisting>
  92   </para>
  93  </refsect1>
  94
  95  <refsect1 id="SQL-DROPFUNCTION-compatibility">
  96   <title>Compatibility</title>
  97
  98   <para>
  99    A <command>DROP FUNCTION</command> statement is defined in the SQL
 100    standard, but it is not compatible with this command.
 101   </para>
 102  </refsect1>
 103
 104  <refsect1>
 105   <title>See Also</title>
 106
 107   <simplelist type="inline">
 108    <member><xref linkend="sql-createfunction" endterm="sql-createfunction-title"></member>
 109    <member><xref linkend="sql-alterfunction" endterm="sql-alterfunction-title"></member>
 110   </simplelist>
 111  </refsect1>
 112
 113 </refentry>
 114
 115 <!-- Keep this comment at the end of the file
 116 Local variables:
 117 mode: sgml
 118 sgml-omittag:nil
 119 sgml-shorttag:t
 120 sgml-minimize-attributes:nil
 121 sgml-always-quote-attributes:t
 122 sgml-indent-step:1
 123 sgml-indent-data:t
 124 sgml-parent-document:nil
 125 sgml-default-dtd-file:"../reference.ced"
 126 sgml-exposed-tags:nil
 127 sgml-local-catalogs:"/usr/lib/sgml/catalog"
 128 sgml-local-ecat-files:nil
 129 End:
 130 -->