35.10. 用户定义聚合

在PostgreSQL里的聚合是用状态值 和状态转换函数表达的。 也就是说，聚合操作使用一个随着每个输入行被处理而变化的状态值。 要定义一个新的聚合函数，就要选择表示状态值的数据类型、状态初始值、状态转换函数。 该状态转换函数只是一个普通函数，也可以用于聚合的环境之外。 还可以声明一个最终处理函数， 用于对付期望的聚合结果不同于需要保留在状态值中数据的情况。

因此，除了被聚合用户看到的参数和结果数据类型外，还有一种内部状态值数据类型， 这种类型可能与参数和结果类型都不一样。

如果定义了一个不使用最终处理函数的聚合，那么聚合就是对每条记录的字段值进行函数计算。 sum(求和)是这类聚合的例子。它从零开始， 依次向"总和"状态值追加当前的记录值。比如，如果要把sum聚合用于复数， 只需要该数据类型的加法函数就行了。该聚合可以这样定义：

CREATE AGGREGATE sum (complex)
(
    sfunc = complex_add,
    stype = complex,
    initcond = '(0,0)'
);

SELECT sum(a) FROM test_complex;

   sum
-----------
 (34,53.9)

请注意，上述依赖于函数重载：有多个名为sum的聚合函数， 但是PostgreSQL能够正确选出作用于complex列类型的那个。

如果不存在非 NULL 输入值，上面的sum定义将返回零值(初始状态条件)。 要按照 SQL 标准的要求返回 NULL 只需忽略initcond 段就可以实现(这样初始状态条件将变为 NULL)。 通常这也意味着sfunc需要检查 NULL 状态条件输入，不过对于sum， max，min这类的简单聚合来说，把第一个非空输入插入到状态值里面， 然后从第二个非空输入状态值开始使用转换函数就足够了。 如果初始条件是 NULL 并且转换函数被标记为"strict"(不能对 NULL 输入调用)， PostgreSQL就会自动处理这些内容。

另外一个"strict"转换函数的缺省特性是：当碰到一个 NULL 输入的时候， 前面一个状态值会被保留下来不做改动。这样，就忽略了 NULL 。 如果你希望对 NULL 输入进行其它处理，只需要别把你的转换函数定义为"strict"， 并在编写代码的时候测试 NULL 并做相应处理即可。

avg(平均)是聚合更复杂一点的例子。它需要两个运行时状态： 输入的总和以及输入的数量。最终结果是通过把两者相除得到的。 平均的典型实现是用一个数组做状态值。比如，内建的avg(float8)实现是这样的：

CREATE AGGREGATE avg (float8)
(
    sfunc = float8_accum,
    stype = float8[],
    finalfunc = float8_avg,
    initcond = '{0,0,0}'
);

（float8_accum要求一个三元素数组，而不是两元素， 因为它累积平方和和输入的总和和计数。这样它就可以在一些除了avg 之外的聚合中使用了。）

聚合函数可以使用多态转换函数或者最终处理函数，这样，同一个函数就可以用于实现多个聚合。 参阅第 35.2.5 节获取多态函数的解释。再进一步， 聚合函数本身可以用多态的基本类型和状态类型来声明， 这样就允许一个聚合定义用于多种输入数据类型。下面是一个多态聚合的例子：

CREATE AGGREGATE array_accum (anyelement)
(
    sfunc = array_append,
    stype = anyarray,
    initcond = '{}'
);

这里，任意聚合调用的实际状态类型是和元素输入类型相同的数组类型。 聚合的特征是连接所有的输入到那个类型的数组里。（注意： 内建的聚合array_agg支持相同的功能，并且有比这个定义更好的性能。）

下面的例子使用两个不同实际数据类型作为参数输出：

SELECT attrelid::regclass, array_accum(attname)
    FROM pg_attribute
    WHERE attnum > 0 AND attrelid = 'pg_tablespace'::regclass
    GROUP BY attrelid;

   attrelid    |              array_accum              
---------------+---------------------------------------
 pg_tablespace | {spcname,spcowner,spcacl,spcoptions}
(1 row)

SELECT attrelid::regclass, array_accum(atttypid::regtype)
    FROM pg_attribute
    WHERE attnum > 0 AND attrelid = 'pg_tablespace'::regclass
    GROUP BY attrelid;

   attrelid    |        array_accum        
---------------+---------------------------
 pg_tablespace | {name,oid,aclitem[],text[]}
(1 row)

一个用 C 写的函数可以判断它是被当作一个聚合转换函数调用还是通过调用AggCheckCallContext 作为最终的函数，例如：

if (AggCheckCallContext(fcinfo, NULL))

检查这个的一个原因是，在它对于一个转换函数为真的时候，左边的输入必须是一个临时的转换值， 因此可以安全地现场修改，而不用分配新的拷贝。参阅int8inc()的例子。 （这是函数里唯一可以修改输入的传递引用的地方。特别的， 聚合最终的函数不应该在任何情况下修改他们的输入， 因为在某些情况下它们将在相同的最终转换值下重复执行。）

更详细的信息请参考CREATE AGGREGATE命令。