# 其他函数

本节介绍未分类到其余文档页面的内置函数。

# ISNULL

isNull(col)
1

如果参数为空值,则返回 true ,否则返回 false 。

# COALESCE

coalesce(expr1, expr2, ...)
1

返回第一个非空参数,如果所有参数都是 null ,则返回 null 。

# NEWUUID

newuuid()
1

返回一个随机的 16 字节 UUID。

# TSTAMP

tstamp()
1

返回当前时间戳,以1970年1月1日星期四00:00:00协调世界时(UTC)为单位。

# EVENT_TIME

event_time()
1

返回当前处理事件的 int64 格式时间戳。由于处理延迟,该时间戳可能早于当前时间。 若在窗口规则中用作聚合函数,则返回窗口结束时间。

# RULE_ID

rule_id()
1

返回当前匹配到的规则的ID。

# RULE_START

rule_start()
1

返回规则开始运行的时间戳,格式为 int64。

# MQTT

mqtt(topic)
1

返回指定键的 MQTT 元数据。 当前支持的键包括:

  • topic:返回消息的主题。 如果有多个流源,则在参数中指定源名称。如 mqtt(src1.topic)
  • messageid:返回消息的消息ID。如果有多个流源,则在参数中指定源名称。 如 mqtt(src2.messageid)

该函数仅用于数据源为 MQTT 的情况。其余数据源请使用 META 函数。

# META

meta(key)
1

返回指定键的元数据。

# LAST_HIT_COUNT

last_hit_count()
1

返回该函数的总命中次数。通常用于获取聚合规则的累计触发次数。如果在 WHERE 子句中使用,只有当条件为真时才会更新计数。 该函数仅可用于非聚合规则中或 Sliding Window 的条件中。若要在聚合规则中实现类似功能,请使用 last_agg_hit_count

若在滑动窗口触发条件中使用,当触发条件满足时就会更新计数而无需考虑规则整体触发情况。

# LAST_HIT_TIME

last_hit_time()
1

返回该函数最后一次命中时的 int64 格式时间戳。通常用于获取聚合规则的最后一次触发时间。如果在 WHERE 子句中使用,只有当条件为真时才会更新时间戳。 该函数仅可用于非聚合规则中或 Sliding Window 的条件中。若要在聚合规则中实现类似功能,请使用 last_agg_hit_time

若在滑动窗口触发条件中使用,当触发条件满足时就会更新时间而无需考虑规则整体触发情况。

# WINDOW_START

window_start()
1

返回窗口的开始时间戳,格式为 int64。若运行时没有时间窗口,则返回默认值0。窗口的时间与规则所用的时间系统相同。若规则采用处理时间,则窗口的时间也为处理时间;若规则采用事件事件,则窗口的时间也为事件时间。

# WINDOW_END

window_end()
1

返回窗口的结束时间戳,格式为 int64。若运行时没有时间窗口,则返回默认值0。窗口的时间与规则所用的时间系统相同。若规则采用处理时间,则窗口的时间也为处理时间;若规则采用事件事件,则窗口的时间也为事件时间。

# GET_KEYED_STATE

get_keyed_state(key, state_name)
1

返回键在数据库中对应的值。第一个参数为 键 表达式,第二个参数为值类型,支持 bigint, float, string, boolean and datetime 格式,第三个参数为默认值。默认数据库是sqlite,用户可以通过这个配置 更改数据库。

# DELAY

delay(delayTime, returnVal)
1

延迟执行规则一段时间后返回第二个参数作为返回值。第一个参数为延迟时间,单位为毫秒,第二个参数为返回值。