aboutsummaryrefslogtreecommitdiff
path: root/doc/src/sgml/ref/drop_function.sgml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/sgml/ref/drop_function.sgml')
-rw-r--r--doc/src/sgml/ref/drop_function.sgml202
1 files changed, 202 insertions, 0 deletions
diff --git a/doc/src/sgml/ref/drop_function.sgml b/doc/src/sgml/ref/drop_function.sgml
new file mode 100644
index 00000000000..5a857bc9307
--- /dev/null
+++ b/doc/src/sgml/ref/drop_function.sgml
@@ -0,0 +1,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:
+-->