diff options
author | Tom Lane | 2014-12-21 20:30:39 +0000 |
---|---|---|
committer | Tom Lane | 2014-12-21 20:31:24 +0000 |
commit | 3c6fd1f84e97c5e0dfa70cea69abdfbcd2d76421 (patch) | |
tree | 4d7e78187af48a0113dba6203419a17088dccc37 | |
parent | 86b9424e8620093cd5568476eb98a9fe5134ca62 (diff) |
Docs: clarify treatment of variadic functions with zero variadic arguments.
Explain that you have to use "VARIADIC ARRAY[]" to pass an empty array
to a variadic parameter position. This was already implicit in the text
but it seems better to spell it out.
Per a suggestion from David Johnston, though I didn't use his proposed
wording. Back-patch to all supported branches.
-rw-r--r-- | doc/src/sgml/xfunc.sgml | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/src/sgml/xfunc.sgml b/doc/src/sgml/xfunc.sgml index a6d2a1355c6..e14854def0c 100644 --- a/doc/src/sgml/xfunc.sgml +++ b/doc/src/sgml/xfunc.sgml @@ -706,6 +706,20 @@ SELECT mleast(VARIADIC ARRAY[10, -1, 5, 4.4]); </para> <para> + Specifying <literal>VARIADIC</> in the call is also the only way to + pass an empty array to a variadic function, for example: + +<screen> +SELECT mleast(VARIADIC ARRAY[]::numeric[]); +</screen> + + Simply writing <literal>SELECT mleast()</> does not work because a + variadic parameter must match at least one actual argument. + (You could define a second function also named <literal>mleast</>, + with no parameters, if you wanted to allow such calls.) + </para> + + <para> The array element parameters generated from a variadic parameter are treated as not having any names of their own. This means it is not possible to call a variadic function using named arguments (<xref |