Commit ee4dcf14 authored by Tom Lane's avatar Tom Lane

Update/improve documentation about creating aggregate functions.

parent 0a27641c
This diff is collapsed.
...@@ -2,26 +2,57 @@ ...@@ -2,26 +2,57 @@
<Title>Extending <Acronym>SQL</Acronym>: Aggregates</Title> <Title>Extending <Acronym>SQL</Acronym>: Aggregates</Title>
<Para> <Para>
Aggregates in <ProductName>Postgres</ProductName> Aggregate functions in <ProductName>Postgres</ProductName>
are expressed in terms of state are expressed as <firstterm>state values</firstterm>
transition functions. That is, an aggregate can be and <firstterm>state transition functions</firstterm>.
That is, an aggregate can be
defined in terms of state that is modified whenever an defined in terms of state that is modified whenever an
instance is processed. Some state functions look at a input item is processed. To define a new aggregate
particular value in the instance when computing the new function, one selects a datatype for the state value,
state (<Acronym>sfunc1</Acronym> in the an initial value for the state, and a state transition
create aggregate syntax) while function. The state transition function is just an
others only keep track of their own internal state ordinary function that could also be used outside the
(<Acronym>sfunc2</Acronym>). context of the aggregate.
If we define an aggregate that uses only </Para>
<Acronym>sfunc1</Acronym>, we
define an aggregate that computes a running function of <Para>
Actually, in order to make it easier to construct useful
aggregates from existing functions, an aggregate can have
one or two separate state values, one or two transition
functions to update those state values, and a
<firstterm>final function</firstterm> that computes the
actual aggregate result from the ending state values.
</Para>
<Para>
Thus there can be as many as four datatypes involved:
the type of the input data items, the type of the aggregate's
result, and the types of the two state values. Only the
input and result datatypes are seen by a user of the aggregate.
</Para>
<Para>
Some state transition functions need to look at each successive
input to compute the next state value, while others ignore the
specific input value and simply update their internal state.
(The most useful example of the second kind is a running count
of the number of input items.) The <ProductName>Postgres</ProductName>
aggregate machinery defines <Acronym>sfunc1</Acronym> for
an aggregate as a function that is passed both the old state
value and the current input value, while <Acronym>sfunc2</Acronym>
is a function that is passed only the old state value.
</Para>
<Para>
If we define an aggregate that uses only <Acronym>sfunc1</Acronym>,
we have an aggregate that computes a running function of
the attribute values from each instance. "Sum" is an the attribute values from each instance. "Sum" is an
example of this kind of aggregate. "Sum" starts at example of this kind of aggregate. "Sum" starts at
zero and always adds the current instance's value to zero and always adds the current instance's value to
its running total. We will use the its running total. For example, if we want to make a Sum
<Acronym>int4pl</Acronym> that is aggregate to work on a datatype for complex numbers,
built into <ProductName>Postgres</ProductName> we only need the addition function for that datatype.
to perform this addition. The aggregate definition is:
<ProgramListing> <ProgramListing>
CREATE AGGREGATE complex_sum ( CREATE AGGREGATE complex_sum (
...@@ -39,11 +70,15 @@ SELECT complex_sum(a) FROM test_complex; ...@@ -39,11 +70,15 @@ SELECT complex_sum(a) FROM test_complex;
|(34,53.9) | |(34,53.9) |
+------------+ +------------+
</ProgramListing> </ProgramListing>
(In practice, we'd just name the aggregate "sum", and rely on
<ProductName>Postgres</ProductName> to figure out which kind
of sum to apply to a complex column.)
</Para> </Para>
<Para> <Para>
If we define only <Acronym>sfunc2</Acronym>, we are If we define only <Acronym>sfunc2</Acronym>, we are
specifying an aggregate specifying an aggregate
that computes a running function that is independent of that computes a running function that is independent of
the attribute values from each instance. the attribute values from each instance.
"Count" is the most common example of this kind of "Count" is the most common example of this kind of
...@@ -104,4 +139,10 @@ SELECT my_average(salary) as emp_average FROM EMP; ...@@ -104,4 +139,10 @@ SELECT my_average(salary) as emp_average FROM EMP;
+------------+ +------------+
</ProgramListing> </ProgramListing>
</Para> </Para>
<Para>
For further details see
<xref endterm="sql-createaggregate-title"
linkend="sql-createaggregate-title">.
</Para>
</Chapter> </Chapter>
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment