diff options
author | Tom Lane <tgl@sss.pgh.pa.us> | 2011-03-23 16:57:37 -0400 |
---|---|---|
committer | Tom Lane <tgl@sss.pgh.pa.us> | 2011-03-23 16:57:37 -0400 |
commit | 5b6c27a607641145d29b64c2f90907db0ed4b36f (patch) | |
tree | b44c1e249c6eeb63c9e45302271fedef3438722e | |
parent | 03f957fe1dffff10b7950bac75929be17fad87ee (diff) | |
download | postgresql-5b6c27a607641145d29b64c2f90907db0ed4b36f.tar.gz |
Improve user-defined-aggregates documentation.
On closer inspection, that two-element initcond value seems to have been
a little white lie to avoid explaining the full behavior of float8_accum.
But if people are going to expect the examples to be exactly correct,
I suppose we'd better explain. Per comment from Thom Brown.
-rw-r--r-- | doc/src/sgml/xaggr.sgml | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/doc/src/sgml/xaggr.sgml b/doc/src/sgml/xaggr.sgml index 15ef46cc1e..d050d876de 100644 --- a/doc/src/sgml/xaggr.sgml +++ b/doc/src/sgml/xaggr.sgml @@ -70,7 +70,7 @@ SELECT sum(a) FROM test_complex; expects <function>sum</function> to behave that way. We can do this simply by omitting the <literal>initcond</literal> phrase, so that the initial state condition is null. Ordinarily this would mean that the <literal>sfunc</literal> - would need to check for a null state-condition input, but for + would need to check for a null state-condition input. But for <function>sum</function> and some other simple aggregates like <function>max</> and <function>min</>, it is sufficient to insert the first nonnull input value into @@ -95,8 +95,8 @@ SELECT sum(a) FROM test_complex; It requires two pieces of running state: the sum of the inputs and the count of the number of inputs. The final result is obtained by dividing - these quantities. Average is typically implemented by using a - two-element array as the state value. For example, + these quantities. Average is typically implemented by using an + array as the state value. For example, the built-in implementation of <function>avg(float8)</function> looks like: @@ -106,9 +106,14 @@ CREATE AGGREGATE avg (float8) sfunc = float8_accum, stype = float8[], finalfunc = float8_avg, - initcond = '{0,0,0}' + initcond = '{0,0}' ); </programlisting> + + (<function>float8_accum</> requires a three-element array, not just + two elements, because it accumulates the sum of squares as well as + the sum and count of the inputs. This is so that it can be used for + some other aggregates besides <function>avg</>.) </para> <para> |