Skip to content

Commit 357ea45

Browse files
tglsfdctglsfdc
committed
Document that utility commands such as DROP FUNCTION allow argument names
and modes to be included when naming an existing function.
1 parent 1b3bb23 commit 357ea45

File tree

5 files changed

+142
-36
lines changed

5 files changed

+142
-36
lines changed

‎doc/src/sgml/ref/alter_function.sgml

Lines changed: 42 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/alter_function.sgml,v 1.6 2005/03/14 00:19:36 neilc Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/alter_function.sgml,v 1.7 2005/05/26 20:05:03 tgl Exp $
33
PostgreSQL documentation
44
-->
55

@@ -20,9 +20,12 @@ PostgreSQL documentation
2020

2121
<refsynopsisdiv>
2222
<synopsis>
23-
ALTER FUNCTION <replaceable>name</replaceable> ( [ <replaceable class="parameter">type</replaceable> [, ...] ] ) <replaceable class="PARAMETER">action</replaceable> [, ... ] [ RESTRICT ]
24-
ALTER FUNCTION <replaceable>name</replaceable> ( [ <replaceable class="parameter">type</replaceable> [, ...] ] ) RENAME TO <replaceable>newname</replaceable>
25-
ALTER FUNCTION <replaceable>name</replaceable> ( [ <replaceable class="parameter">type</replaceable> [, ...] ] ) OWNER TO <replaceable>newowner</replaceable>
23+
ALTER FUNCTION <replaceable>name</replaceable> ( [ [ <replaceable class="parameter">argmode</replaceable> ] [ <replaceable class="parameter">argname</replaceable> ] <replaceable class="parameter">argtype</replaceable> [, ...] ] )
24+
<replaceable class="PARAMETER">action</replaceable> [, ... ] [ RESTRICT ]
25+
ALTER FUNCTION <replaceable>name</replaceable> ( [ [ <replaceable class="parameter">argmode</replaceable> ] [ <replaceable class="parameter">argname</replaceable> ] <replaceable class="parameter">argtype</replaceable> [, ...] ] )
26+
RENAME TO <replaceable>newname</replaceable>
27+
ALTER FUNCTION <replaceable>name</replaceable> ( [ [ <replaceable class="parameter">argmode</replaceable> ] [ <replaceable class="parameter">argname</replaceable> ] <replaceable class="parameter">argtype</replaceable> [, ...] ] )
28+
OWNER TO <replaceable>newowner</replaceable>
2629

2730
where <replaceable class="PARAMETER">action</replaceable> is one of:
2831

@@ -55,10 +58,41 @@ where <replaceable class="PARAMETER">action</replaceable> is one of:
5558
</varlistentry>
5659

5760
<varlistentry>
58-
<term><replaceable class="parameter">type</replaceable></term>
61+
<term><replaceable class="parameter">argmode</replaceable></term>
62+
63+
<listitem>
64+
<para>
65+
The mode of an argument: either <literal>IN</>, <literal>OUT</>,
66+
or <literal>INOUT</>. If omitted, the default is <literal>IN</>.
67+
Note that <command>ALTER FUNCTION</command> does not actually pay
68+
any attention to <literal>OUT</> arguments, since only the input
69+
arguments are needed to determine the function's identity.
70+
So it is sufficient to list the <literal>IN</> and <literal>INOUT</>
71+
arguments.
72+
</para>
73+
</listitem>
74+
</varlistentry>
75+
76+
<varlistentry>
77+
<term><replaceable class="parameter">argname</replaceable></term>
78+
79+
<listitem>
80+
<para>
81+
The name of an argument.
82+
Note that <command>ALTER FUNCTION</command> does not actually pay
83+
any attention to argument names, since only the argument data
84+
types are needed to determine the function's identity.
85+
</para>
86+
</listitem>
87+
</varlistentry>
88+
89+
<varlistentry>
90+
<term><replaceable class="parameter">argtype</replaceable></term>
91+
5992
<listitem>
6093
<para>
61-
The data type of an argument of the function.
94+
The data type(s) of the function's arguments (optionally
95+
schema-qualified), if any.
6296
</para>
6397
</listitem>
6498
</varlistentry>
@@ -116,8 +150,8 @@ where <replaceable class="PARAMETER">action</replaceable> is one of:
116150
</varlistentry>
117151

118152
<varlistentry>
119-
<term><literal><optional>EXTERNAL</optional> SECURITY INVOKER</literal></term>
120-
<term><literal><optional>EXTERNAL</optional> SECURITY DEFINER</literal></term>
153+
<term><literal><optional> EXTERNAL </optional> SECURITY INVOKER</literal></term>
154+
<term><literal><optional> EXTERNAL </optional> SECURITY DEFINER</literal></term>
121155

122156
<listitem>
123157
<para>

‎doc/src/sgml/ref/comment.sgml

Lines changed: 60 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/comment.sgml,v 1.27 2005/03/07 04:30:51 momjian Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/comment.sgml,v 1.28 2005/05/26 20:05:03 tgl Exp $
33
PostgreSQL documentation
44
-->
55

@@ -30,7 +30,7 @@ COMMENT ON
3030
CONVERSION <replaceable class="PARAMETER">object_name</replaceable> |
3131
DATABASE <replaceable class="PARAMETER">object_name</replaceable> |
3232
DOMAIN <replaceable class="PARAMETER">object_name</replaceable> |
33-
FUNCTION <replaceable class="PARAMETER">func_name</replaceable> (<replaceable class="PARAMETER">arg1_type</replaceable>, <replaceable class="PARAMETER">arg2_type</replaceable>, ...) |
33+
FUNCTION <replaceable class="PARAMETER">func_name</replaceable> ( [ [ <replaceable class="parameter">argmode</replaceable> ] [ <replaceable class="parameter">argname</replaceable> ] <replaceable class="parameter">argtype</replaceable> [, ...] ] ) |
3434
INDEX <replaceable class="PARAMETER">object_name</replaceable> |
3535
LARGE OBJECT <replaceable class="PARAMETER">large_object_oid</replaceable> |
3636
OPERATOR <replaceable class="PARAMETER">op</replaceable> (<replaceable class="PARAMETER">leftoperand_type</replaceable>, <replaceable class="PARAMETER">rightoperand_type</replaceable>) |
@@ -103,6 +103,64 @@ COMMENT ON
103103
</para>
104104
</listitem>
105105
</varlistentry>
106+
107+
<varlistentry>
108+
<term><replaceable>sourcetype</replaceable></term>
109+
<listitem>
110+
<para>
111+
The name of the source data type of the cast.
112+
</para>
113+
</listitem>
114+
</varlistentry>
115+
116+
<varlistentry>
117+
<term><replaceable>targettype</replaceable></term>
118+
<listitem>
119+
<para>
120+
The name of the target data type of the cast.
121+
</para>
122+
</listitem>
123+
</varlistentry>
124+
125+
<varlistentry>
126+
<term><replaceable class="parameter">argmode</replaceable></term>
127+
128+
<listitem>
129+
<para>
130+
The mode of a function argument: either <literal>IN</>, <literal>OUT</>,
131+
or <literal>INOUT</>. If omitted, the default is <literal>IN</>.
132+
Note that <command>COMMENT ON FUNCTION</command> does not actually pay
133+
any attention to <literal>OUT</> arguments, since only the input
134+
arguments are needed to determine the function's identity.
135+
So it is sufficient to list the <literal>IN</> and <literal>INOUT</>
136+
arguments.
137+
</para>
138+
</listitem>
139+
</varlistentry>
140+
141+
<varlistentry>
142+
<term><replaceable class="parameter">argname</replaceable></term>
143+
144+
<listitem>
145+
<para>
146+
The name of a function argument.
147+
Note that <command>COMMENT ON FUNCTION</command> does not actually pay
148+
any attention to argument names, since only the argument data
149+
types are needed to determine the function's identity.
150+
</para>
151+
</listitem>
152+
</varlistentry>
153+
154+
<varlistentry>
155+
<term><replaceable class="parameter">argtype</replaceable></term>
156+
157+
<listitem>
158+
<para>
159+
The data type(s) of the function's arguments (optionally
160+
schema-qualified), if any.
161+
</para>
162+
</listitem>
163+
</varlistentry>
106164

107165
<varlistentry>
108166
<term><replaceable class="parameter">large_object_oid</replaceable></term>
@@ -122,24 +180,6 @@ COMMENT ON
122180
</para>
123181
</listitem>
124182
</varlistentry>
125-
126-
<varlistentry>
127-
<term><replaceable>sourcetype</replaceable></term>
128-
<listitem>
129-
<para>
130-
The name of the source data type of the cast.
131-
</para>
132-
</listitem>
133-
</varlistentry>
134-
135-
<varlistentry>
136-
<term><replaceable>targettype</replaceable></term>
137-
<listitem>
138-
<para>
139-
The name of the target data type of the cast.
140-
</para>
141-
</listitem>
142-
</varlistentry>
143183

144184
<varlistentry>
145185
<term><replaceable class="parameter">text</replaceable></term>

‎doc/src/sgml/ref/drop_function.sgml

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/drop_function.sgml,v 1.29 2003/11/29 19:51:38 pgsql Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/drop_function.sgml,v 1.30 2005/05/26 20:05:03 tgl Exp $
33
PostgreSQL documentation
44
-->
55

@@ -20,7 +20,8 @@ PostgreSQL documentation
2020

2121
<refsynopsisdiv>
2222
<synopsis>
23-
DROP FUNCTION <replaceable class="parameter">name</replaceable> ( [ <replaceable class="parameter">type</replaceable> [, ...] ] ) [ CASCADE | RESTRICT ]
23+
DROP FUNCTION <replaceable class="parameter">name</replaceable> ( [ [ <replaceable class="parameter">argmode</replaceable> ] [ <replaceable class="parameter">argname</replaceable> ] <replaceable class="parameter">argtype</replaceable> [, ...] ] )
24+
[ CASCADE | RESTRICT ]
2425
</synopsis>
2526
</refsynopsisdiv>
2627

@@ -50,10 +51,41 @@ DROP FUNCTION <replaceable class="parameter">name</replaceable> ( [ <replaceable
5051
</varlistentry>
5152

5253
<varlistentry>
53-
<term><replaceable class="parameter">type</replaceable></term>
54+
<term><replaceable class="parameter">argmode</replaceable></term>
55+
56+
<listitem>
57+
<para>
58+
The mode of an argument: either <literal>IN</>, <literal>OUT</>,
59+
or <literal>INOUT</>. If omitted, the default is <literal>IN</>.
60+
Note that <command>DROP FUNCTION</command> does not actually pay
61+
any attention to <literal>OUT</> arguments, since only the input
62+
arguments are needed to determine the function's identity.
63+
So it is sufficient to list the <literal>IN</> and <literal>INOUT</>
64+
arguments.
65+
</para>
66+
</listitem>
67+
</varlistentry>
68+
69+
<varlistentry>
70+
<term><replaceable class="parameter">argname</replaceable></term>
71+
72+
<listitem>
73+
<para>
74+
The name of an argument.
75+
Note that <command>DROP FUNCTION</command> does not actually pay
76+
any attention to argument names, since only the argument data
77+
types are needed to determine the function's identity.
78+
</para>
79+
</listitem>
80+
</varlistentry>
81+
82+
<varlistentry>
83+
<term><replaceable class="parameter">argtype</replaceable></term>
84+
5485
<listitem>
5586
<para>
56-
The data type of an argument of the function.
87+
The data type(s) of the function's arguments (optionally
88+
schema-qualified), if any.
5789
</para>
5890
</listitem>
5991
</varlistentry>

‎doc/src/sgml/ref/grant.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/grant.sgml,v 1.46 2005/04/28 21:47:09 tgl Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/grant.sgml,v 1.47 2005/05/26 20:05:03 tgl Exp $
33
PostgreSQL documentation
44
-->
55

@@ -30,7 +30,7 @@ GRANT { { CREATE | TEMPORARY | TEMP } [,...] | ALL [ PRIVILEGES ] }
3030
TO { <replaceable class="PARAMETER">username</replaceable> | GROUP <replaceable class="PARAMETER">groupname</replaceable> | PUBLIC } [, ...] [ WITH GRANT OPTION ]
3131

3232
GRANT { EXECUTE | ALL [ PRIVILEGES ] }
33-
ON FUNCTION <replaceable>funcname</replaceable> ([<replaceable>type</replaceable>, ...]) [, ...]
33+
ON FUNCTION <replaceable>funcname</replaceable> ( [ [ <replaceable class="parameter">argmode</replaceable> ] [ <replaceable class="parameter">argname</replaceable> ] <replaceable class="parameter">argtype</replaceable> [, ...] ] ) [, ...]
3434
TO { <replaceable class="PARAMETER">username</replaceable> | GROUP <replaceable class="PARAMETER">groupname</replaceable> | PUBLIC } [, ...] [ WITH GRANT OPTION ]
3535

3636
GRANT { USAGE | ALL [ PRIVILEGES ] }

‎doc/src/sgml/ref/revoke.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/revoke.sgml,v 1.32 2004/11/05 19:15:52 tgl Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/revoke.sgml,v 1.33 2005/05/26 20:05:03 tgl Exp $
33
PostgreSQL documentation
44
-->
55

@@ -35,7 +35,7 @@ REVOKE [ GRANT OPTION FOR ]
3535

3636
REVOKE [ GRANT OPTION FOR ]
3737
{ EXECUTE | ALL [ PRIVILEGES ] }
38-
ON FUNCTION <replaceable>funcname</replaceable> ([<replaceable>type</replaceable>, ...]) [, ...]
38+
ON FUNCTION <replaceable>funcname</replaceable> ( [ [ <replaceable class="parameter">argmode</replaceable> ] [ <replaceable class="parameter">argname</replaceable> ] <replaceable class="parameter">argtype</replaceable> [, ...] ] ) [, ...]
3939
FROM { <replaceable class="PARAMETER">username</replaceable> | GROUP <replaceable class="PARAMETER">groupname</replaceable> | PUBLIC } [, ...]
4040
[ CASCADE | RESTRICT ]
4141

0 commit comments

Comments
 (0)