mirror of
https://gitee.com/rulego/streamsql.git
synced 2025-07-13 11:03:50 +00:00
146 lines
3.6 KiB
Markdown
146 lines
3.6 KiB
Markdown
# StreamSQL Functions 模块扩展
|
|
|
|
## 概述
|
|
|
|
本次扩展实现了统一的聚合函数和分析函数管理，简化了自定义函数的扩展过程。现在只需要在 `functions` 模块中实现函数，就可以自动在 `aggregator` 模块中使用。
|
|
|
|
## 主要改进
|
|
|
|
### 1. 统一的函数接口
|
|
|
|
- **AggregatorFunction**: 支持增量计算的聚合函数接口
|
|
- **AnalyticalFunction**: 支持状态管理的分析函数接口
|
|
- **Function**: 基础函数接口
|
|
|
|
### 2. 自动适配器
|
|
|
|
- **AggregatorAdapter**: 将 functions 模块的聚合函数适配到 aggregator 模块
|
|
- **AnalyticalAdapter**: 将 functions 模块的分析函数适配到 aggregator 模块
|
|
|
|
### 3. 简化的扩展流程
|
|
|
|
现在添加自定义函数只需要：
|
|
1. 在 functions 模块中实现函数
|
|
2. 注册函数和适配器
|
|
3. 无需修改 aggregator 模块
|
|
|
|
## 使用方法
|
|
|
|
### 创建自定义聚合函数
|
|
|
|
```go
|
|
// 1. 定义函数结构
|
|
type CustomSumFunction struct {
|
|
*BaseFunction
|
|
sum float64
|
|
}
|
|
|
|
// 2. 实现基础接口
|
|
func (f *CustomSumFunction) Execute(ctx *FunctionContext, args []interface{}) (interface{}, error) {
|
|
// 实现函数逻辑
|
|
}
|
|
|
|
// 3. 实现AggregatorFunction接口
|
|
func (f *CustomSumFunction) New() AggregatorFunction {
|
|
return &CustomSumFunction{BaseFunction: f.BaseFunction}
|
|
}
|
|
|
|
func (f *CustomSumFunction) Add(value interface{}) {
|
|
// 增量计算逻辑
|
|
}
|
|
|
|
func (f *CustomSumFunction) Result() interface{} {
|
|
return f.sum
|
|
}
|
|
|
|
func (f *CustomSumFunction) Reset() {
|
|
f.sum = 0
|
|
}
|
|
|
|
func (f *CustomSumFunction) Clone() AggregatorFunction {
|
|
return &CustomSumFunction{BaseFunction: f.BaseFunction, sum: f.sum}
|
|
}
|
|
|
|
// 4. 注册函数
|
|
func init() {
|
|
Register(NewCustomSumFunction())
|
|
RegisterAggregatorAdapter("custom_sum")
|
|
}
|
|
```
|
|
|
|
### 创建自定义分析函数
|
|
|
|
```go
|
|
// 1. 定义函数结构
|
|
type CustomAnalyticalFunction struct {
|
|
*BaseFunction
|
|
state interface{}
|
|
}
|
|
|
|
// 2. 实现基础接口
|
|
func (f *CustomAnalyticalFunction) Execute(ctx *FunctionContext, args []interface{}) (interface{}, error) {
|
|
// 实现分析逻辑
|
|
}
|
|
|
|
// 3. 实现AnalyticalFunction接口
|
|
func (f *CustomAnalyticalFunction) Reset() {
|
|
f.state = nil
|
|
}
|
|
|
|
func (f *CustomAnalyticalFunction) Clone() AnalyticalFunction {
|
|
return &CustomAnalyticalFunction{BaseFunction: f.BaseFunction, state: f.state}
|
|
}
|
|
|
|
// 4. 注册函数
|
|
func init() {
|
|
Register(NewCustomAnalyticalFunction())
|
|
RegisterAnalyticalAdapter("custom_analytical")
|
|
}
|
|
```
|
|
|
|
### 使用简化的注册方式
|
|
|
|
```go
|
|
// 注册简单的自定义函数
|
|
RegisterCustomFunction("double", TypeAggregation, "数学函数", "将值乘以2", 1, 1,
|
|
func(ctx *FunctionContext, args []interface{}) (interface{}, error) {
|
|
val, err := cast.ToFloat64E(args[0])
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return val * 2, nil
|
|
})
|
|
```
|
|
|
|
## 内置函数
|
|
|
|
### 聚合函数
|
|
- `sum`: 求和
|
|
- `avg`: 平均值
|
|
- `min`: 最小值
|
|
- `max`: 最大值
|
|
- `count`: 计数
|
|
- `stddev`: 标准差
|
|
- `median`: 中位数
|
|
- `percentile`: 百分位数
|
|
- `collect`: 收集所有值
|
|
- `last_value`: 最后一个值
|
|
- `merge_agg`: 合并聚合
|
|
- `stddevs`: 样本标准差
|
|
- `deduplicate`: 去重
|
|
- `var`: 总体方差
|
|
- `vars`: 样本方差
|
|
|
|
### 分析函数
|
|
- `lag`: 滞后函数
|
|
- `latest`: 最新值
|
|
- `changed_col`: 变化列
|
|
- `had_changed`: 是否变化
|
|
|
|
## 自定义函数示例
|
|
|
|
参考 `custom_example.go` 文件中的示例：
|
|
- `CustomProductFunction`: 乘积聚合函数
|
|
- `CustomGeometricMeanFunction`: 几何平均聚合函数
|
|
- `CustomMovingAverageFunction`: 移动平均分析函数
|