# CREATE AGGREGATE
#### 功能描述
创建一个新的聚集函数。
#### 语法格式
```
CREATE AGGREGATE name ( input_data_type [ , ... ] ) (
    SFUNC = sfunc,
    -- SFUNC1 = sfunc, 
    STYPE = state_data_type
    -- STYPE1 = state_data_type, 
    [ , FINALFUNC = ffunc ]
    [ , INITCOND = initial_condition ]
    -- [ , INITCOND1 = initial_condition ] 
    [ , SORTOP = sort_operator ]
    [ , CFUNC = collection_func ]
    [ , INITCOLLECT = initial_collection_condition ]
    [ , IFUNC = init_func ]
    [ , SHIPPABLE = is_shippable ]
);
```
也可使用：
```
CREATE AGGREGATE name (
    BASETYPE = base_type,
    SFUNC = sfunc,
    -- SFUNC1 = sfunc, 
    STYPE = state_data_type
    -- STYPE1 = state_data_type, 
    [ , FINALFUNC = ffunc ]
    [ , INITCOND = initial_condition ]
    -- [ , INITCOND1 = initial_condition ] 
    [ , SORTOP = sort_operator ]
    [ , CFUNC = collection_func ]
    [ , INITCOLLECT = initial_collection_condition ]
    [ , IFUNC = init_func ]
);
```
#### 参数说明
- **name**
  要创建的聚集函数名（可以有模式修饰)）。
  
- **input_data_type**
  该聚集函数要处理的输入数据类型。要创建一个零参数聚集函数，可以使用\*代替输入数据类型列表。（count(\*)就是这种聚集函数的一个实例。）
  

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

- **sfunc**
  将在每一个输入行上调用的状态转换函数的名称。 对于有N个参数的聚合函数，sfunc必须有+1个参数，其中的第一个参数类型为state_data_type，其余的匹配已声明的输入数据类型。 函数必须返回一个state_data_type类型的值。 这个函数接受当前状态值和当前输入数据，并返回下个状态值。ORA数据库的转换函数默认行为为strict，即会跳过null输入值。GaussDB需要用户自行定义转换函数strict属性。
  

- **state_data_type**
  聚合的状态值的数据类型。
  

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

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

- **sort_operator**
  用于MIN或MAX类型聚合的排序操作符。 这个只是一个操作符名(可以有模式修饰)。这个操作符假设接受和聚合一样的输入数据类型。
  
- **collection_func**
  如果希望分布式聚合来提高性能，用户可以提供collection_func。collection_func本质上是组合不同Datanode产生的状态转换结果。如果没有最终函数，collection_func产生的结果就是聚合的结果。如果需要collection_func跳过null值，请将collection_func标记为strict函数。如果没有标记为strict，用户需要妥善处理好null值输入。collection_func必须有两个类型为state_data_type的入参。第一个入参state_data_type将传给下一次collection_func执行的第一个参数。如果is_shippable为false，则不会执行collection_func。
  
- **initial_collection_condition**
  collection_func状态值的初始设置(值)。 它必须是一个state_data_type类型可以接受的文本常量值。 如果没有声明，状态值初始为null。
  
- **init_func**
  sfunc状态值的初始设置函数。 它不能返回null值，必须返回state_data_type类型并且没有入参。如果同时设置init_func和initial_condition，init_func的返回值将会优先作为初始状态值。
  
- **is_shippable**
  标记该聚集函数是否能够下推执行，仅可以取值true或者false。目前该参数不影响系统内置聚集函数的下推行为，仅影响用户自定义聚集函数的行为，默认值为false。仅当存在collection_func且is_shippable为true时，用户自定义聚集可以下推。
  
 
![](https://support.huaweicloud.com/distributed-devg-v8-gaussdb/public_sys-resources/note_3.0-zh-cn.png)
如果AGGREGATE函数支持下推执行，那么AGGREGATE函数不能引用PACKAGE的内容，包括变量、函数等，否则可能会在执行中报错。如sfunc、cfunc、finalfunc、ifunc不能是PACKAGE函数，sfunc、finalfunc、ifunc内部也不能引用PACKAGE变量、调用PACKAGE函数等。
#### 示例
```
--创建自定义函数。
gaussdb=# CREATE OR REPLACE FUNCTION int_add(int,int)
returns int as $BODY$
declare
begin
return $1 + $2;
end;
$BODY$ language plpgsql;
--创建聚集函数。
gaussdb=# CREATE AGGREGATE sum_add(int)
(
    sfunc = int_add,
    
    stype = int,
    
    initcond = '0'
    
);
--创建测试表和添加数据。
gaussdb=# CREATE TABLE test_sum(a int,b int,c int);
gaussdb=# INSERT INTO test_sum VALUES(1,2),(2,3),(3,4),(4,5);
--执行聚集函数。
gaussdb=# SELECT sum_add(a) FROM test_sum;
   sum_add
-----------
   10
--删除聚集函数。
gaussdb=# DROP AGGREGATE sum_add(int);
--删除自定义函数。
gaussdb=# DROP FUNCTION int_add(int,int);
--删除测试表。
gaussdb=# DROP TABLE test_sum;
```
#### 相关链接
[ALTER AGGREGATE](https://support.huaweicloud.com/distributed-devg-v8-gaussdb/gaussdb-12-0477.html#ZH-CN_TOPIC_0000002558945977)，[DROP AGGREGATE](https://support.huaweicloud.com/distributed-devg-v8-gaussdb/gaussdb-12-0585.html#ZH-CN_TOPIC_0000002527826222)