drop_function.sgml 4.31 KB
Newer Older
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 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
<REFENTRY ID="SQL-DROPFUNCTION-1">
 <REFMETA>
  <REFENTRYTITLE>
   DROP FUNCTION
  </REFENTRYTITLE>
  <REFMISCINFO>SQL - Language Statements</REFMISCINFO>
 </REFMETA>
 <REFNAMEDIV>
  <REFNAME>
   DROP FUNCTION
  </REFNAME>
  <REFPURPOSE>
   Removes a user-defined C function
  </REFPURPOSE>
  
 <REFSYNOPSISDIV>
  <REFSYNOPSISDIVINFO>
   <DATE>1998-04-15</DATE>
  </REFSYNOPSISDIVINFO>
  <SYNOPSIS>
   DROP FUNCTION <replaceable class="parameter">name</replaceable> ( [<replaceable class="parameter">type</replaceable> [, ...]] )
  </SYNOPSIS>
  
  <REFSECT2 ID="R2-SQL-DROPFUNCTION-1">
   <REFSECT2INFO>
    <DATE>1998-04-15</DATE>
   </REFSECT2INFO>
   <TITLE>
    Inputs
   </TITLE>
   <PARA>
   </PARA>
   <VARIABLELIST>
    <VARLISTENTRY>
     <TERM>
     </TERM>
     <LISTITEM>
      <PARA>
       <VARIABLELIST>
	<VARLISTENTRY>
	 <TERM>
	  <replaceable class="parameter"> name</replaceable>
	 </TERM>
	 <LISTITEM>
	  <PARA>
	   The name of an existing function.
	  </PARA>
	 </LISTITEM>
	</VARLISTENTRY>
	<VARLISTENTRY>
	 <TERM>
	  <replaceable class="parameter">type</replaceable>
	 </TERM>
	 <LISTITEM>
	  <PARA>
	   The type of function parameters.
	  </PARA>
	 </LISTITEM>
	</VARLISTENTRY>
       </variablelist>
     </LISTITEM>
    </VARLISTENTRY>
   </VARIABLELIST>
  </REFSECT2>
  
  <REFSECT2 ID="R2-SQL-DROPFUNCTION-2">
   <REFSECT2INFO>
    <DATE>1998-04-15</DATE>
   </REFSECT2INFO>
   <TITLE>
    Outputs
   </TITLE>
   <PARA>
   </PARA>
   <VARIABLELIST>
    <VARLISTENTRY>
     <TERM>
     </TERM>
     <LISTITEM>
      <PARA>
       <VARIABLELIST>
	<VARLISTENTRY>
	 <TERM>
	  <ReturnValue>DROP</ReturnValue>
	 </TERM>
	 <LISTITEM>
	  <PARA>
	   Message returned if the command completes successfully.
	  </PARA>
	 </LISTITEM>
	</VARLISTENTRY>
	<VARLISTENTRY>
	 <TERM>
	  <ReturnValue>
	   WARN RemoveFunction: Function "<replaceable class="parameter">name</replaceable>" ("<replaceable class="parameter">types</replaceable>") does not exist</ReturnValue>
	 </TERM>
	 <LISTITEM>
	  <PARA>
	   This message is given if the function specified does not
exist into database.
	  </PARA>
	 </LISTITEM>
	</VARLISTENTRY>
       </variablelist>
     </LISTITEM>
    </VARLISTENTRY>
   </VARIABLELIST>
  </REFSECT2>
 </REFSYNOPSISDIV>
 
 <REFSECT1 ID="R1-SQL-DROPFUNCTION-1">
  <REFSECT1INFO>
   <DATE>1998-04-15</DATE>
  </REFSECT1INFO>
  <TITLE>
   Description
  </TITLE>
  <PARA>
   DROP FUNCTION will remove references to an existing C
   function. To execute this command the user must be the
   owner of the function. The input argument types to the
   function must be specified, as only the function with the
   given name and argument types will be removed.
  </PARA>
  
  <REFSECT2 ID="R2-SQL-DROPFUNCTION-3">
   <REFSECT2INFO>
    <DATE>1998-04-15</DATE>
   </REFSECT2INFO>
   <TITLE>
    Notes
   </TITLE>
   <PARA>
    Refer to the <citerefentry>
     <refentrytitle>
      CREATE FUNCTION</refentrytitle>
    </citerefentry>
 statement to create aggregate functions.
   </PARA>
  </REFSECT2>
  
 <REFSECT1 ID="R1-SQL-DROPFUNCTION-2">
  <TITLE>
   Usage
  </TITLE>
  <PARA>
   This command removes the square root function:
  </PARA>
  <ProgramListing>
   DROP FUNCTION sqrt(int4);
  </ProgramListing>
 </REFSECT1>
 <REFSECT1 ID="R1-SQL-DROPFUNCTION-3">
  <TITLE>
   Bugs
  </TITLE>
  <PARA>
   No checks are made to ensure that types, operators or access
   methods that rely on the function have been removed first.
  </PARA>
 </REFSECT1>
 
 <REFSECT1 ID="R1-SQL-DROPFUNCTION-4">
  <TITLE>
   Compatibility
  </TITLE>
  <PARA
   >DROP FUNCTION statement is a PostgreSQL language extension.
  </PARA>
  
  <REFSECT2 ID="R2-SQL-DROPFUNCTION-4">
   <REFSECT2INFO>
    <DATE>1998-04-15</DATE>
   </REFSECT2INFO>
   <TITLE>
    SQL/PSM
   </TITLE>
   <PARA>
   The SQL/PSM DROP FUNCTION statement has the following syntax:
    <programlisting>
     DROP [ SPECIFIC ] FUNCTION <replaceable class="parameter">name</replaceable> { RESTRICT | CASCADE }</programlisting>
   </PARA>
  </refsect2>
 </refsect1>
</REFENTRY>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
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:
-->