diff options
Diffstat (limited to 'doc/src/sgml/ref/alter_function.sgml')
| -rw-r--r-- | doc/src/sgml/ref/alter_function.sgml | 127 |
1 files changed, 127 insertions, 0 deletions
diff --git a/doc/src/sgml/ref/alter_function.sgml b/doc/src/sgml/ref/alter_function.sgml new file mode 100644 index 00000000000..621350980b8 --- /dev/null +++ b/doc/src/sgml/ref/alter_function.sgml @@ -0,0 +1,127 @@ +<!-- +$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_function.sgml,v 1.1 2003/06/27 14:45:25 petere Exp $ +PostgreSQL documentation +--> + +<refentry id="SQL-ALTERFUNCTION"> + <refmeta> + <refentrytitle id="SQL-ALTERFUNCTION-TITLE">ALTER FUNCTION</refentrytitle> + <refmiscinfo>SQL - Language Statements</refmiscinfo> + </refmeta> + + <refnamediv> + <refname>ALTER FUNCTION</refname> + <refpurpose>change the definition of a function</refpurpose> + </refnamediv> + + <refsynopsisdiv> +<synopsis> +ALTER FUNCTION <replaceable>name</replaceable> ( [ <replaceable class="parameter">type</replaceable> [, ...] ] ) RENAME TO <replaceable>newname</replaceable> +</synopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + <command>ALTER FUNCTION</command> changes the definition of a + function. The only functionality is to rename the function. + </para> + </refsect1> + + <refsect1> + <title>Parameters</title> + + <variablelist> + <varlistentry> + <term><replaceable class="parameter">name</replaceable></term> + <listitem> + <para> + The name (optionally schema-qualified) of an existing function. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable class="parameter">type</replaceable></term> + <listitem> + <para> + The data type of an argument of the function. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable class="parameter">newname</replaceable></term> + <listitem> + <para> + The new name of the function. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Diagnostics</title> + + <variablelist> + <varlistentry> + <term><computeroutput>ALTER FUNCTION</computeroutput></term> + <listitem> + <para> + Message returned if the command was successful. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Examples</title> + + <para> + To rename the function <literal>sqrt</literal> for type + <type>integer</type> to <literal>square_root</literal>: +<programlisting> +ALTER FUNCTION sqrt(integer) RENAME TO square_root; +</programlisting> + </para> + </refsect1> + + <refsect1> + <title>Compatibility</title> + + <para> + There is an <command>ALTER FUNCTION</command> statement in the SQL + standard, but it does not provide the option to rename the + function. + </para> + </refsect1> + + <refsect1> + <title>See Also</title> + + <simplelist type="inline"> + <member><xref linkend="sql-createfunction" endterm="sql-createfunction-title"></member> + <member><xref linkend="sql-dropfunction" endterm="sql-dropfunction-title"></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: +--> |
