# 函数

eKuiper 具有许多内置函数,可以对数据执行计算。

# 聚合函数

聚合函数对一组值执行计算并返回单个值。聚合函数只能用作以下表达式:

  • select 语句的 select 列表(子查询或外部查询)。
  • HAVING 子句。
函数示例说明
avgavg(col1)组中的平均值。空值不参与计算。
countcount(*)组中的项目数。空值不参与计算。
maxmax(col1)组中的最大值。空值不参与计算。
minmin(col1)组中的最小值。空值不参与计算。
sumsum(col1)组中所有值的总和。空值不参与计算。
collectcollect(*), collect(col1)返回组中指定的列或整个消息(参数为*时)的值组成的数组。
deduplicatededuplicate(col, false)返回当前组去重的结果,通常用在窗口中。其中,第一个参数指定用于去重的列;第二个参数指定是否返回全部结果。若为 false ,则仅返回最近的未重复的项;若最近的项有重复,则返回空数组;此时可以设置 sink 参数 omitIfEmpty,使得 sink 接到空结果后不触发。

# Collect() 示例

  • 获取当前窗口所有消息的列 a 的值组成的数组。假设列 a 的类型为 int, 则结果为: [{"r1":[32, 45]}]

    SELECT collect(a) as r1 FROM test GROUP BY TumblingWindow(ss, 10)
    
    1
  • 获取当前窗口所有消息的列 a 的值组成的数组。结果为: [{"r1":{"a":32, "b":"hello"}, {"a":45, "b":"world"}}]

    SELECT collect(*) as r1 FROM test GROUP BY TumblingWindow(ss, 10)
    
    1
  • 获取当前窗口第二个消息的列 a 的值。结果为: [{"r1":32}]

    SELECT collect(*)[1]->a as r1 FROM test GROUP BY TumblingWindow(ss, 10)
    
    1

# Deduplicate() 示例

  • 获取当前窗口中,列 a 值不重复的所有消息组成的数组。结果为: [{"r1":{"a":32, "b":"hello"}, {"a":45, "b":"world"}}]
    SELECT deduplicate(a, true) as r1 FROM test GROUP BY TumblingWindow(ss, 10)
    
    1
  • 获取列 a 值在过去一小时中不重复的值。每收到一条新消息,都会检测列 a 是否重复,若不重复则输出:[{"r1":32}] 或者 [{"r1":45}]。若检测到重复值,则输出 [{}] 。此时,可以设置 omitIfEmpty 的 sink 参数使得检测到重复值时不触发规则。
    SELECT deduplicate(a, false)->a as r1 FROM demo GROUP BY SlidingWindow(hh, 1)
    
    1

# 数学函数

函数示例说明
absabs(col1)绝对值
acosacos(col1)弧度数的反余弦值
asinasin(col1)弧度数的反正弦值
atanatan(col1)弧度数的反正切值
atan2atan2(col1, col2)正x轴与两个自变量中定义的(x,y)点之间的弧度角
bitandbitand(col1, col2)对两个Int(-converted)参数的位表示执行按位“与”运算
bitorbitor(col1, col2)对两个参数的位表示进行或运算
bitxorbitxor(col1, col2)对两个Int(-converted)参数的位表示执行逐位异或运算
bitnotbitnot(col1)在Int(-converted)参数的位表示形式上执行按位NOT运算
ceilceil(col1)将值舍入到最接近的BIGINT值。
coscos(col1)返回以弧度为单位的数字的余弦值。
coshcosh(col1)返回弧度数的双曲余弦值。
expexp(col1)返回小数点参数的e。
lnln(col1)返回参数的自然对数。
loglog(col1)返回参数的以10为底的对数。
modmod(col1, col2)返回第一个参数除以第二个参数的余数。
powerpower(x, y)返回 x 的 y 次方。
randrand()返回一个伪随机数,其均匀分布在0.0和1.0之间。
roundround(col1)将值四舍五入到最接近的 BIGINT 值。
signsign(col1)返回给定数字的符号。 当参数的符号为正时,将返回1。 当参数的符号为负数时,返回-1。 如果参数为0,则返回0。
sinsin(col1)返回弧度数的正弦值。
sinhsinh(col1)返回弧度数的双曲正弦值。
sqrtsqrt(col1)返回数字的平方根。
tantan(col1)返回以弧度表示的数字的正切值。
tanhtanh(col1)返回弧度数的双曲正切值。

# 字符串函数

函数示例说明
concatconcat(col1...)连接数组或字符串。 此函数接受任意数量的参数并返回 String 或 Array
endswithendswith(col1, col2)返回一个布尔值,该布尔值指示第一个 String参数是否以第二个 String 参数结尾。
format_timeformat_time(col1, format)将日期时间格式化为字符串。其中,若参数 col1 为兼容类型,则在格式化之前 转换为 datetime 类型。关于格式字符串,请参考 时间格式
indexofindexof(col1, col2)返回第二个参数的第一个索引(从0开始),作为第一个参数中的子字符串。
lengthlength(col1)返回提供的字符串中的字符数。
lowerlower(col1)返回给定 String 的小写版本。
lpadlpad(col1, 2)返回 String,在左侧用第二个参数指定的空格数填充。
ltrimltrim(col1)从提供的字符串中删除所有前导空格(制表符和空格)。
numbytesnumbytes(col1)以提供的字符串的 UTF-8 编码返回字节数。
regexp_matchesregexp_matches(col1, regex)如果字符串(第一个参数)包含正则表达式的匹配项,则返回 true。
regexp_replaceregexp_replace(col1, regex, str)将第一个参数中所有出现的第二个参数(正则表达式)替换为第三个参数。
regexp_substrregexp_substr(col1, regex)在第一个参数中找到第二个参数(regex)的第一个匹配项。
rpadrpad(col1, 2)返回字符串参数,在右侧填充第二个参数指定的空格数。
rtrimrtrim(col1)从提供的字符串中删除所有尾随空白(制表符和空格)。
substringsubstring(col1, start, end)从提供的 Int 索引(从0开始,包括0)到字符串的结尾,返回提供的String的子字符串。
startswithstartswith(col1, str)返回布尔值,是否第一个字符串参数是否以第二个字符串参数开头。
split_valuesplit_value(col1, splitter, index)将第一个字符串参数以第二个字符串参数作为分隔符切分,返回切分后的第 index(参数三)个值。
trimtrim(col1)从提供的字符串中删除所有前导和尾随空格(制表符和空格)。
upperupper(col1)返回给定 String 的大写版本。

# 时间格式

时间格式为一些特定符号和字母组成的字符串。eKuiper 里支持的符号如下表所示:

符号含义示例
G公元G(AD)
YYYYY(2004), YY(04)
MM(1), MM(01), MMM(Jan), MMMM(January)
d日期d(2), dd(02)
E星期几EEE(Mon), EEEE(Monday)
H24小时制的小时HH(15)
h12小时制的小时h(2), hh(03)
aAM 或 PMa(PM)
mm(4), mm(04)
ss(5), ss(05)
S秒的分数S(.0), SS(.00), SSS(.000)
z时区名z(MST)
Z4位数的时区Z(-0700)
X时区X(-07), XX(-0700), XXX(-07:00)

示例:

  • YYYY-MM-dd T HH:mm:ss -> 2006-01-02 T 15:04:05
  • YYYY/MM/dd HH:mm:ssSSS XXX -> 2006/01/02 15:04:05.000 -07:00

# 转换函数

函数示例说明
castcast(col, "bigint")将值从一种数据类型转换为另一种数据类型。 支持的类型包括:bigint,float,string,boolean 和 datetime。
chrchr(col1)返回与给定 Int 参数对应的 ASCII 字符
encodeencode(col1, "base64")使用 encode 函数根据编码方案将负载(可能是非 JSON 数据)编码为其字符串表示形式。目前,只支持"base64" 编码类型。
trunctrunc(dec, int)将第一个参数截断为第二个参数指定的小数位数。 如果第二个参数小于零,则将其设置为零。 如果第二个参数大于34,则将其设置为34。从结果中去除尾随零。
object_constructobject_construct(key1, col, ...)返回由参数构建的 oject/map 。参数为一系列的键值对,因此必须为偶数个。键必须为 string 类型,值可以为任意类型。如果值为空,则该键值对不会出现在最终的对象中。

# 转换为 datetime 类型

使用 cast 函数转换到 datetime 类型时,转换规则如下:

  1. 如果参数为 datetime 类型,则直接返回原值。
  2. 如果参数为 bigint 或者 float 类型,则其数值会作为自 1970年1月1日0时起至今的毫秒值而转换为 datetime 类型。
  3. 如果参数为 string 类型,则会用默认格式 "2006-01-02T15:04:05.000Z07:00" 将其转换为 datetime类型。
  4. 其他类型的参数均不支持转换。

# 哈希函数

函数示例说明
md5md5(col1)参数的哈希值
sha1sha1(col1)参数的哈希值
sha256sha256(col1)参数的哈希值
sha384sha384(col1)参数的哈希值
sha512sha512(col1)参数的哈希值

# JSON 函数

函数示例说明
json_path_existsjson_path_exists(col1, "$.name")检查 JSON 路径是否返回指定JSON 值的任何项目。 返回布尔值。
json_path_queryjson_path_query(col1, "$.name")获取 JSON 路径返回的指定 JSON值的所有项目。
json_path_query_firstjson_path_query_first(col1, "$.name")获取 JSON 路径返回的指定 JSON值的第一项。

请参阅 json 路径函数 了解如何编写json路径。

# 其它函数

函数示例说明
isNullisNull(col1)如果参数为空值,则返回 true。
cardinalitycardinality(col1)组中成员的数量。空值为0。
newuuidnewuuid()返回一个随机的16字节 UUID。
tstamptstamp()返回当前时间戳,以1970年1月1日星期四00:00:00协调世界时(UTC)为单位。
mqttmqtt(topic)返回指定键的 MQTT 元数据。 当前支持的键包括
-topic:返回消息的主题。 如果有多个流源,则在参数中指定源名称。 如 mqtt(src1.topic)
- messageid:返回消息的消息ID。 如果有多个流源,则在参数中指定源名称。 如 mqtt(src2.messageid)
metameta(topic)返回指定键的元数据。 键可能是:
-如果 from 子句中只有一个来源,则为独立键,例如meta(device)
-用于指定流的合格键,例如 meta(src1.device)
-用于多级元数据的带有箭头的键,例如 meta(src1.reading->device->name)。这里假定读取是地图结构元数据。
window_startwindow_start()返回窗口的开始时间戳,格式为 int64。若运行时没有时间窗口,则返回默认值0。窗口的时间与规则所用的时间系统相同。若规则采用处理时间,则窗口的时间也为处理时间;若规则采用事件事件,则窗口的时间也为事件时间。
window_endwindow_end()返回窗口的结束时间戳,格式为 int64。若运行时没有时间窗口,则返回默认值0。窗口的时间与规则所用的时间系统相同。若规则采用处理时间,则窗口的时间也为处理时间;若规则采用事件事件,则窗口的时间也为事件时间。
laglag(expr, [offset], [default value])返回表达式前一个值在偏移 offset 处的结果,如果没有找到,则返回默认值,如果没有指定默认值则返回 nil。如果除 expression 外其余参数均未指定,偏移量默认为 1,默认值为 nil
changed_colchanged_col(true, col)返回列的相比上次执行后的变化值。若未变化则返回 null 。
had_changedhad_changed(true, expr1, expr2, ...)返回是否上次运行后列的值有变化。 其参数可以为 * 以方便地监测所有列。

# 多列函数

多列函数执行运算之后会返回多个列。相对来说,普通的标量函数只返回单列。

多列函数仅可在 SELECT 子句中使用。

函数示例说明
changed_colschanged_cols(prefix, ignoreNull, colA, colB)返回值有变化的列,列名添加指定前缀。请看 changed_cols 了解更多用法。

# 监控变化的函数

# Changed_col 函数

该函数为普通的标量函数,因此可在任意的子句,包括 SELECT 和 WHERE 中使用。

语法

CHANGED_COL(<ignoreNull>, <expr>)

参数

ignoreNull: 判断变化时是否忽略 null 值。若为 true,则收到 null 值或未收到值不会触发变化。

expr: 用来监控变化状态和输出变化值的表达式。

返回值

返回变化后的值或者 null (未变化)。与所有标量函数相同,该函数默认返回的列名未函数的名字 changed_col 。可使用 as alias 赋别名。

# Changed_cols 函数

该函数返回多个列的结果,因此只能在 SELECT 子句中使用。

语法

CHANGED_COLS (<prefix>, <ignoreNull>, <expr> [,...,<exprN>])

参数

prefix: 返回的列名的前缀。默认情况下,返回的变化列名与原列名相同,例如 CHANGED_COLS("", true, col1) 返回 col1。如果设置了前缀参数,则返回的列名将加上前缀以区别于普通的列,例如 CHANGED_COLS("changed_", true, col1) 将返回 changed_col1

ignoreNull: 判断变化时是否忽略 null 值。若为 true,则收到 null 值或未收到值不会触发变化。

expr: 用来监控变化状态和输出变化值的表达式。可以为任何可在 SELECT 子句中使用的表达式。若表达式为 * 则会返回所有列的变化。

返回值

返回所有与上一次运行的值有变化的表达式的新值。如果在普通规则中使用,则与上次事件触发时的值比较。如果在窗口规则中使用,则与上次窗口输出的值比较。

首次运行时,返回所有表达式的值,因为没有前一次的运行,所有表达式都判定为有变化。

在接下来的运行中,如果选择的所有表达式都没有值变化,则返回空值。

注意事项

多列函数仅可在 select 子句中使用。其选出的值不能用于 WHERE 或其他子句中。若需要根据变化值做过滤,则应使用 CHANGED_COL 函数,或者将 CHANGED_COLS 的规则作为规则流水线的前置规则。

函数返回的列命别名仅能通过 prefix 参数做全局的设置。若需要给每个列设置单独的别名,则需要使用 CHANGED_COL 函数。

# Had_changed 函数

该函数为向量函数,支持不定长度参数。

HAD_CHANGED (<ignoreNull>, <expr> [,...,<exprN>])

参数

ignoreNull: 判断变化时是否忽略 null 值。若为 true,则收到 null 值或未收到值不会触发变化。

expr: 用来监控变化状态和输出变化值的表达式。可以为任何可在 SELECT 子句中使用的表达式。若表达式为 * 则监测所有列的变化。

返回值

返回一个 bool 值,表示上次运行后的变化状态。多参数版本与用或连接使用单个参数的版本相同,即 HAD_CHANGED(expr1) OR HAD_CHANGED(expr2) ... OR HAD_CHANGED(exprN) 。若需要监测别的关系,可单独使用此函数。例如,监测是否所有值都有变化,可使用 HAD_CHANGED(expr1) AND HAD_CHANGED(expr2) ... AND HAD_CHANGED(exprN) 。

# 范例

创建流 demo,并给与如下输入。

{"ts":1, "temperature":23, "humidity":88}
{"ts":2, "temperature":23, "humidity":88}
{"ts":3, "temperature":23, "humidity":88}
{"ts":4, "temperature":25, "humidity":88}
{"ts":5, "temperature":25, "humidity":90}
{"ts":6, "temperature":25, "humidity":91}
{"ts":7, "temperature":25, "humidity":91}
{"ts":8, "temperature":25, "humidity":91}
1
2
3
4
5
6
7
8

获取 temperature 变化值的规则:

SQL: SELECT CHANGED_COLS("", true, temperature) FROM demo
___________________________________________________
{"temperature":23}
{"temperature":25}
1
2
3
4

获取 temperature 或 humidity 的变化值并添加名称前缀的规则:

SQL: SELECT CHANGED_COLS("c_", true, temperature, humidity) FROM demo
_________________________________________________________
{"c_temperature":23,"c_humidity":88}
{"c_temperature":25}
{"c_humidity":90}
{"c_humidity":91}
1
2
3
4
5
6

获取所有列的变化值并且不忽略 null 值的规则:

SQL: SELECT CHANGED_COLS("c_", false, *) FROM demo
_________________________________________________________
{"c_ts":1, "c_temperature":23, "c_humidity":88}
{"c_ts":2}
{"c_ts":3}
{"c_ts":4, "c_temperature":25}
{"c_ts":5, "c_humidity":90}
{"c_ts":6, "c_humidity":91}
{"c_ts":7}
{"c_ts":8}
1
2
3
4
5
6
7
8
9
10

获取窗口中平均值变化的规则:

SQL: SELECT CHANGED_COLS("t", true, avg(temperature)) FROM demo GROUP BY CountWindow(2)
_________________________________________________________________
{"tavg":23}
{"tavg":24}
{"tavg":25}
1
2
3
4
5

当 temperature 或者 humidity 变化时获取数据:

SQL: SELECT ts, temperature, humidity FROM demo
WHERE HAD_CHANGED(true, temperature, humidity) = true
_________________________________________________________
{"ts":1,temperature":23,"humidity":88}
{"ts":4,temperature":25,"humidity":88}
{"ts":5,temperature":25,"humidity":90}
{"ts":6,temperature":25,"humidity":91}
1
2
3
4
5
6
7

当 temperature 变化且 humidity 未变化时获取数据:

SQL: SELECT ts, temperature, humidity FROM demo 
WHERE HAD_CHANGED(true, temperature) = true AND HAD_CHANGED(true, humidity) = false
_________________________________________________________
{"ts":4,temperature":25,"humidity":88}
1
2
3
4

获取 temperature 和 humidity 的变化值并赋自定义名:

SQL: SELECT CHANGED_COL(true, temperature) AS myTemp, CHANGED_COL(true, humidity) AS myHum FROM demo
_________________________________________________________
{"myTemp":23,"myHum":88}
{"myTemp":25}
{"myHum":90}
{"myHum":91}
1
2
3
4
5
6

当 temperature 值变化后大于 24 时获取数据:

SQL: SELECT ts, temperature, humidity FROM demo 
WHERE CHANGED_COL(true, temperature) > 24
_________________________________________________________
{"ts":4,temperature":25,"humidity":88}
1
2
3
4