Redrock Postgres 搜索 英文
版本: 9.3 / 9.4 / 9.5 / 9.6 / 10 / 11 / 12 / 13 / 14

CREATE AGGREGATE

名称

CREATE AGGREGATE -- 定义一个新的聚合函数

大纲

CREATE AGGREGATE name ( input_data_type [ , ... ] ) (
    SFUNC = sfunc,
    STYPE = state_data_type
    [ , FINALFUNC = ffunc ]
    [ , INITCOND = initial_condition ]
    [ , SORTOP = sort_operator ]
)

or the old syntax

CREATE AGGREGATE name (
    BASETYPE = base_type,
    SFUNC = sfunc,
    STYPE = state_data_type
    [ , FINALFUNC = ffunc ]
    [ , INITCOND = initial_condition ]
    [ , SORTOP = sort_operator ]
)

描述

CREATE AGGREGATE定义一个新的聚合函数。 一些常用的聚合函数已经包含在基础软件包里了;在第 9.20 节里有文档说明。 如果你需要定义一个新类型或需要一个还没有提供的聚合函数,这时CREATE AGGREGATE便可派上用场。

如果给出了一个模式的名字(比如CREATE AGGREGATE myschema.myagg ...),那么该聚合函数是在指定模式中创建的。 否则它是在当前模式中创建的。

一个聚合函数是用它的名字和输入数据类型来标识的。 同一模式中如果两个聚合处理的输入数据不同,它们可以有相同的名字。 一个聚合函数的输入数据类型必须和所有同一模式中的普通函数的名字和输入 类型不同。

一个聚合函数是用一个或两个普通函数组成的:一个状态转换函数sfunc和一个可选的最终计算函数ffunc。 它们是这样使用的:

sfunc( internal-state, next-data-values ) ---> next-internal-state
ffunc( internal-state ) ---> aggregate-value

PostgreSQL创建一个类型为stype的临时变量。 它保存这个聚合的当前内部状态。对于每个输入数据条目,都调用状态转换函数计算内部状态值的新数值。 在处理完所有数据后,调用一次最终处理函数以计算聚合的返回值。如果没有最终处理函数, 则将最后的状态值当做返回值。

一个聚合函数还可能提供一个初始条件,也就是内部状态值的初始值。 这个值是作为一个类型为text的字段存储在数据库里的,不过它们必须是状态值数据类型的合法的外部 表现形式的常量。 如果没有提供状态,那么状态值初始化为 NULL 。

如果该状态转换函数被定义为"strict",那么就不能用 NULL 输入调用它。 此时, 聚合的执行如下所述。带有任何 NULL 输入值的行将被忽略(不调用此函数并且保留前一个状态值)。 如果初始状态值是 NULL ,那么在第一个含有非 NULL 值的行上,使用第一个参数值替换状态值, 然后状态转换函数在随后所有的含有非 NULL 值的行上调用。 这样做让比较容易实现像max这样的聚合。 请注意这种行为只是当state_data_typeinput_data_type相同的时候才表现出来。 如果这些类型不同,你必须提供一个非 NULL 的初始条件或者使用一个非"strict"的状态转换函数。

如果状态转换函数不是严格(strict)的,那么它将无条件地在每个输入行上调用,并且必须自行处理 NULL 输入和NULL 转换值,这样就允许聚合的作者对聚合中的 NULL 有完全的控制。

如果最终转换函数定义为"strict",那么如果最终状态值是NULL 时就不会调用它; 而是自动输出一个 NULL 结果。(这才是 strict 函数的正常特征。) 不管是那种情况,最终处理函数 可以自由选择是否返回 NULL 。 比如,avg的最终处理函数在零输入记录时 就会返回 NULL 。

行为类似MINMAX的聚合有时候可以优化为使用索引,而不用扫描 每个输入行。 如果这个聚合可以如此优化,则用一个排序操作符标识它。 这里基本的要求是聚合 必须以操作符归纳出来的排序顺序生成第一个元素;换句话说:

SELECT agg(col) FROM tab;

必须等于:

SELECT col FROM tab ORDER BY col USING sortop LIMIT 1;

更多的假设是聚合忽略 NULL 输入,并且只有在输入没有非空数值的时候,它才生成NULL结果。 通常,数据类型的 < 操作符是MIN的适用排序操作符,而 >MAX 的适用操作符。 请注意,除非声明的操作符是 B-tree 索引操作符类的"小于"或者"大于"策略号, 否则这种优化将不会生效。

要创建聚合函数,你必须具有相关参数类型、状态类型和返回类型的使用权限,也必须具有转换函数和最终函数的执行权限。

参数

name

要创建的聚合函数名(可以有模式修饰) 。

input_data_type

该聚合函数要处理的输入数据类型。要创建一个零参数聚合函数,可以使用*代替输入数据类型列表。 (count(*)就是这种聚合函数的一个实例。 )

base_type

在以前的CREATE AGGREGATE语法中,输入数据类型是通过basetype参数指定的,而不是写在聚合的名称之后。 需要注意的是这种以前语法仅允许一个输入参数。 要创建一个零参数聚合函数,可以将basetype指定为"ANY"(而不是*)。

sfunc

将在每一个输入行上调用的状态转换函数的名称。 对于有N个参数的聚合函数,sfunc必须有 +1 个参数,其中的第一个参数类型为state_data_type,其余的匹配已声明的输入数据类型。 函数必须返回一个state_data_type类型的值。 这个函数接受当前状态值和当前输入数据,并返回下个状态值。

state_data_type

聚合的状态值的数据类型。

ffunc

在转换完所有输入行后调用的最终处理函数,它计算聚合的结果。 此函数必须接受一个类型为state_data_type的参数。 聚合的输出数据 类型被定义为此函数的返回类型。 如果没有声明ffunc则使用聚合结果的状态值作为聚合的结果,且输出类型为state_data_type

initial_condition

状态值的初始设置(值)。 它必须是一个state_data_type类型可以接受的文本常量值。 如果没有声明,状态值初始为 NULL 。

sort_operator

用于MINMAX类型聚合的排序操作符。 这个只是一个操作符名 (可以有模式修饰)。这个操作符假设接受和聚合一样的输入数据类型。

CREATE AGGREGATE的参数可以以任何顺序书写,而不只是上面显示的顺序。

例子

参见第 35.10 节

兼容性

CREATE AGGREGATEPostgreSQL语言的扩展。 SQL标准没有提供用户自定义聚合函数的功能。

参见

ALTER AGGREGATE, DROP AGGREGATE