diff options
| author | Tom Lane <tgl@sss.pgh.pa.us> | 2005-05-26 20:05:03 +0000 |
|---|---|---|
| committer | Tom Lane <tgl@sss.pgh.pa.us> | 2005-05-26 20:05:03 +0000 |
| commit | 357ea45b5772486395c7fbddccdca22ca1b7c1ae (patch) | |
| tree | d8370bfdfd5ce2287cbad4c9831ed29c259a4b5a /doc/src/sgml/ref/alter_function.sgml | |
| parent | 1b3bb23cc884eb0b25c5f708a0481dd49ff55ed7 (diff) | |
Document that utility commands such as DROP FUNCTION allow argument names
and modes to be included when naming an existing function.
Diffstat (limited to 'doc/src/sgml/ref/alter_function.sgml')
| -rw-r--r-- | doc/src/sgml/ref/alter_function.sgml | 50 |
1 files changed, 42 insertions, 8 deletions
diff --git a/doc/src/sgml/ref/alter_function.sgml b/doc/src/sgml/ref/alter_function.sgml index 468aa2b2e2e..2f4b901f48e 100644 --- a/doc/src/sgml/ref/alter_function.sgml +++ b/doc/src/sgml/ref/alter_function.sgml @@ -1,5 +1,5 @@ <!-- -$PostgreSQL: pgsql/doc/src/sgml/ref/alter_function.sgml,v 1.6 2005/03/14 00:19:36 neilc Exp $ +$PostgreSQL: pgsql/doc/src/sgml/ref/alter_function.sgml,v 1.7 2005/05/26 20:05:03 tgl Exp $ PostgreSQL documentation --> @@ -20,9 +20,12 @@ PostgreSQL documentation <refsynopsisdiv> <synopsis> -ALTER FUNCTION <replaceable>name</replaceable> ( [ <replaceable class="parameter">type</replaceable> [, ...] ] ) <replaceable class="PARAMETER">action</replaceable> [, ... ] [ RESTRICT ] -ALTER FUNCTION <replaceable>name</replaceable> ( [ <replaceable class="parameter">type</replaceable> [, ...] ] ) RENAME TO <replaceable>newname</replaceable> -ALTER FUNCTION <replaceable>name</replaceable> ( [ <replaceable class="parameter">type</replaceable> [, ...] ] ) OWNER TO <replaceable>newowner</replaceable> +ALTER FUNCTION <replaceable>name</replaceable> ( [ [ <replaceable class="parameter">argmode</replaceable> ] [ <replaceable class="parameter">argname</replaceable> ] <replaceable class="parameter">argtype</replaceable> [, ...] ] ) + <replaceable class="PARAMETER">action</replaceable> [, ... ] [ RESTRICT ] +ALTER FUNCTION <replaceable>name</replaceable> ( [ [ <replaceable class="parameter">argmode</replaceable> ] [ <replaceable class="parameter">argname</replaceable> ] <replaceable class="parameter">argtype</replaceable> [, ...] ] ) + RENAME TO <replaceable>newname</replaceable> +ALTER FUNCTION <replaceable>name</replaceable> ( [ [ <replaceable class="parameter">argmode</replaceable> ] [ <replaceable class="parameter">argname</replaceable> ] <replaceable class="parameter">argtype</replaceable> [, ...] ] ) + OWNER TO <replaceable>newowner</replaceable> where <replaceable class="PARAMETER">action</replaceable> is one of: @@ -55,10 +58,41 @@ where <replaceable class="PARAMETER">action</replaceable> is one of: </varlistentry> <varlistentry> - <term><replaceable class="parameter">type</replaceable></term> + <term><replaceable class="parameter">argmode</replaceable></term> + + <listitem> + <para> + The mode of an argument: either <literal>IN</>, <literal>OUT</>, + or <literal>INOUT</>. If omitted, the default is <literal>IN</>. + Note that <command>ALTER FUNCTION</command> does not actually pay + any attention to <literal>OUT</> arguments, since only the input + arguments are needed to determine the function's identity. + So it is sufficient to list the <literal>IN</> and <literal>INOUT</> + arguments. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable class="parameter">argname</replaceable></term> + + <listitem> + <para> + The name of an argument. + Note that <command>ALTER FUNCTION</command> does not actually pay + any attention to argument names, since only the argument data + types are needed to determine the function's identity. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable class="parameter">argtype</replaceable></term> + <listitem> <para> - The data type of an argument of the function. + The data type(s) of the function's arguments (optionally + schema-qualified), if any. </para> </listitem> </varlistentry> @@ -116,8 +150,8 @@ where <replaceable class="PARAMETER">action</replaceable> is one of: </varlistentry> <varlistentry> - <term><literal><optional>EXTERNAL</optional> SECURITY INVOKER</literal></term> - <term><literal><optional>EXTERNAL</optional> SECURITY DEFINER</literal></term> + <term><literal><optional> EXTERNAL </optional> SECURITY INVOKER</literal></term> + <term><literal><optional> EXTERNAL </optional> SECURITY DEFINER</literal></term> <listitem> <para> |