postgresql/doc/src/sgml/ref/drop_function.sgml

184 lines
4.0 KiB
Plaintext
Raw Normal View History

<REFENTRY ID="SQL-DROPFUNCTION">
1998-05-13 07:34:00 +02:00
<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>
1998-09-22 17:48:03 +02:00
DROP FUNCTION <replaceable class="parameter">name</replaceable> ( [ <replaceable class="parameter">type</replaceable> [, ...] ] )
1998-05-13 07:34:00 +02:00
</SYNOPSIS>
<REFSECT2 ID="R2-SQL-DROPFUNCTION-1">
<REFSECT2INFO>
<DATE>1998-04-15</DATE>
</REFSECT2INFO>
<TITLE>
Inputs
</TITLE>
<PARA>
</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>
</REFSECT2>
<REFSECT2 ID="R2-SQL-DROPFUNCTION-2">
<REFSECT2INFO>
<DATE>1998-04-15</DATE>
</REFSECT2INFO>
<TITLE>
Outputs
</TITLE>
<PARA>
1998-05-13 07:34:00 +02:00
<VARIABLELIST>
<VARLISTENTRY>
<TERM>
<ReturnValue>DROP</ReturnValue>
</TERM>
<LISTITEM>
<PARA>
Message returned if the command completes successfully.
</PARA>
</LISTITEM>
</VARLISTENTRY>
<VARLISTENTRY>
<TERM>
1998-09-22 17:48:03 +02:00
<ReturnValue>WARN RemoveFunction: Function "<replaceable class="parameter">name</replaceable>" ("<replaceable class="parameter">types</replaceable>") does not exist</ReturnValue>
1998-05-13 07:34:00 +02:00
</TERM>
<LISTITEM>
<PARA>
This message is given if the function specified does not
1998-09-22 17:48:03 +02:00
exist in the current database.
1998-05-13 07:34:00 +02:00
</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>
1998-09-22 17:48:03 +02:00
Refer to <citerefentry>
<refentrytitle>
CREATE FUNCTION
</refentrytitle>
1998-05-13 07:34:00 +02:00
</citerefentry>
1998-09-22 17:48:03 +02:00
to create aggregate functions.
1998-05-13 07:34:00 +02:00
</PARA>
</REFSECT2>
<REFSECT1 ID="R1-SQL-DROPFUNCTION-2">
<TITLE>
Usage
</TITLE>
<PARA>
This command removes the square root function:
</PARA>
<ProgramListing>
1998-09-22 17:48:03 +02:00
DROP FUNCTION sqrt(int4);
1998-05-13 07:34:00 +02:00
</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>
1998-09-22 17:48:03 +02:00
<PARA>
DROP FUNCTION is a <productname>Postgres</productname> language extension.
1998-05-13 07:34:00 +02:00
</PARA>
<REFSECT2 ID="R2-SQL-DROPFUNCTION-4">
<REFSECT2INFO>
<DATE>1998-04-15</DATE>
</REFSECT2INFO>
<TITLE>
SQL/PSM
</TITLE>
<PARA>
1998-09-22 17:48:03 +02:00
SQL/PSM is a proposed standard to enable function extensibility.
The SQL/PSM DROP FUNCTION statement has the following syntax:
1998-05-13 07:34:00 +02:00
<programlisting>
1998-09-22 17:48:03 +02:00
DROP [ SPECIFIC ] FUNCTION <replaceable class="parameter">name</replaceable> { RESTRICT | CASCADE }</programlisting>
1998-05-13 07:34:00 +02:00
</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:
-->