summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Lane <tgl@sss.pgh.pa.us>2015-08-25 19:12:57 -0400
committerTom Lane <tgl@sss.pgh.pa.us>2015-08-25 19:12:57 -0400
commit23ddcd77b72bdbec4f8e5fb618febefa1fea4d2d (patch)
tree4e90eb466a0b7765b5b861fc5c7f1a2fe58d307a
parent7c57449fc5855361d3a69374192c58fb68ce3e67 (diff)
downloadpostgresql-23ddcd77b72bdbec4f8e5fb618febefa1fea4d2d.tar.gz
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.
-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 779c368a10..0d614024a7 100644
--- a/doc/src/sgml/func.sgml
+++ b/doc/src/sgml/func.sgml
@@ -10603,9 +10603,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>
@@ -10615,7 +10615,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,
@@ -10630,9 +10632,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>
@@ -10642,7 +10644,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,