summaryrefslogtreecommitdiff
path: root/doc/src
diff options
context:
space:
mode:
authorTom Lane <tgl@sss.pgh.pa.us>2015-08-25 19:11:17 -0400
committerTom Lane <tgl@sss.pgh.pa.us>2015-08-25 19:11:27 -0400
commit7c0c4d07e777957a5fad54e81b4f42f420031060 (patch)
tree773e24b001527d437077dbc64d167baf7eb92dcc /doc/src
parentb8c91352a2e168e1c24cc33862a0d95f13fd0957 (diff)
Docs: be explicit about datatype matching for lead/lag functions.
The default argument, if given, has to be of exactly the same datatype as the first argument; but this was not stated in so many words, and the error message you get about it might not lead your thought in the right direction. Per bug #13587 from Robert McGehee. A quick scan says that these are the only two built-in functions with two anyelement arguments and no other polymorphic arguments. There are plenty of cases of, eg, anyarray and anyelement, but those seem less likely to confuse. For instance this doesn't seem terribly hard to figure out: "function array_remove(integer[], numeric) does not exist". So I've contented myself with fixing these two cases.
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/sgml/func.sgml16
1 files changed, 10 insertions, 6 deletions
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml
index 452ea6d832d..d63b1081acc 100644
--- a/doc/src/sgml/func.sgml
+++ b/doc/src/sgml/func.sgml
@@ -13606,9 +13606,9 @@ SELECT xmlagg(x) FROM (SELECT x FROM test ORDER BY y DESC) AS tab;
<primary>lag</primary>
</indexterm>
<function>
- lag(<replaceable class="parameter">value</replaceable> <type>any</>
+ lag(<replaceable class="parameter">value</replaceable> <type>anyelement</>
[, <replaceable class="parameter">offset</replaceable> <type>integer</>
- [, <replaceable class="parameter">default</replaceable> <type>any</> ]])
+ [, <replaceable class="parameter">default</replaceable> <type>anyelement</> ]])
</function>
</entry>
<entry>
@@ -13618,7 +13618,9 @@ SELECT xmlagg(x) FROM (SELECT x FROM test ORDER BY y DESC) AS tab;
returns <replaceable class="parameter">value</replaceable> evaluated at
the row that is <replaceable class="parameter">offset</replaceable>
rows before the current row within the partition; if there is no such
- row, instead return <replaceable class="parameter">default</replaceable>.
+ row, instead return <replaceable class="parameter">default</replaceable>
+ (which must be of the same type as
+ <replaceable class="parameter">value</replaceable>).
Both <replaceable class="parameter">offset</replaceable> and
<replaceable class="parameter">default</replaceable> are evaluated
with respect to the current row. If omitted,
@@ -13633,9 +13635,9 @@ SELECT xmlagg(x) FROM (SELECT x FROM test ORDER BY y DESC) AS tab;
<primary>lead</primary>
</indexterm>
<function>
- lead(<replaceable class="parameter">value</replaceable> <type>any</>
+ lead(<replaceable class="parameter">value</replaceable> <type>anyelement</>
[, <replaceable class="parameter">offset</replaceable> <type>integer</>
- [, <replaceable class="parameter">default</replaceable> <type>any</> ]])
+ [, <replaceable class="parameter">default</replaceable> <type>anyelement</> ]])
</function>
</entry>
<entry>
@@ -13645,7 +13647,9 @@ SELECT xmlagg(x) FROM (SELECT x FROM test ORDER BY y DESC) AS tab;
returns <replaceable class="parameter">value</replaceable> evaluated at
the row that is <replaceable class="parameter">offset</replaceable>
rows after the current row within the partition; if there is no such
- row, instead return <replaceable class="parameter">default</replaceable>.
+ row, instead return <replaceable class="parameter">default</replaceable>
+ (which must be of the same type as
+ <replaceable class="parameter">value</replaceable>).
Both <replaceable class="parameter">offset</replaceable> and
<replaceable class="parameter">default</replaceable> are evaluated
with respect to the current row. If omitted,