规则

规则由 JSON 定义，下面是一个示例。

{
  "id": "rule1",
  "sql": "SELECT demo.temperature, demo1.temp FROM demo left join demo1 on demo.timestamp = demo1.timestamp where demo.temperature > demo1.temp GROUP BY demo.temperature, HOPPINGWINDOW(ss, 20, 10)",
  "actions": [
    {
      "log": {}
    },
    {
      "mqtt": {
        "server": "tcp://47.52.67.87:1883",
        "topic": "demoSink"
      }
    }
  ]
}

创建规则需要以下3个参数。

参数

id

规则的标识。 规则名称不能在同一 eKuiper 实例中重复。

sql

为规则运行的 sql 查询。

选项

当前的选项包括：

有关 qos 和 checkpointInterval 的详细信息，请查看状态和容错。

可以在 rules 下属的 etc/kuiper.yaml 中全局定义规则选项。 规则 json 中定义的选项将覆盖全局设置。

源

• eKuiper 支持以下 3 种内置源：
  • MQTT 源，有关更多详细信息，请参阅 MQTT source stream。
  • EdgeX 源缺省是包含在容器镜像中发布的，但是没有包含在单独下载的二进制包中，您可以使用 make pkg_with_edgex 命令来编译出一个支持 EdgeX 源的程序。更多关于它的详细信息，请参考 EdgeX source stream。
  • HTTP 定时拉取源，按照用户指定的时间间隔，定时从 HTTP 服务器中拉取数据，更多详细信息，请参考这里 。
• 有关eKuiper SQL 的更多信息，请参阅 SQL。
• 可以自定义来源，请参阅 extension了解更多详细信息。

目标/动作

当前，支持以下目标/动作：

• log: 将结果发送到日志文件。
• mqtt: 将结果发送到 MQTT 消息服务器。
• edgex: 将结果发送到 EdgeX 消息总线。
• rest: 将结果发送到 Rest HTTP 服务器。
• nop: 将结果发送到 nop 操作。

每个动作可以定义自己的属性。当前有以下的公共属性:

数据模板

用户可以参考 eKuiper 中使用 Golang 模版 (template) 定制分析结果 来获取更多的关于数据模版的使用场景。

如果 sendSingle 为 true，则数据模板将针对某一条记录执行操作； 否则，它将对整个记录数组执行操作。 典型的数据模板是：

例如，我们的目标输入为

[]map[string]interface{}{{
    "ab" : "hello1",
},{
    "ab" : "hello2",
}}

在 sendSingle=true 模式下：

• 打印整个记录

"dataTemplate": "{\"content\":{{json .}}}",

• 打印 ab 字段

"dataTemplate": "{\"content\":{{.ab}}}",

如果 ab 字段是字符串，请添加引号

"dataTemplate": "{\"content\":\"{{.ab}}\"}",

在 sendSingle=false 模式下：

• 打印出整个记录数组

"dataTemplate": "{\"content\":{{json .}}}",

• 打印出第一条记录

"dataTemplate": "{\"content\":{{json (index . 0)}}}",

• 打印出第一个记录的字段 ab

"dataTemplate": "{\"content\":{{index . 0 \"ab\"}}}",

• 将数组中每个记录的字段 ab 打印为 html 格式

"dataTemplate": "<div>results</div><ul>{{range .}}<li>{{.ab}}</li>{{end}}</ul>",

可以自定义动作以支持不同种类的输出，有关更多详细信息，请参见 extension 。

模版中支持的函数

用户可通过模板函数，对数据进行各种转换，包括但不限于格式转换，数学计算和编码等。eKuiper 中支持的模板函数包括以下几类：

1. Go 语言内置模板函数。
2. 来自 sprig library 的丰富的扩展函数集。
3. eKuiper 扩展的函数。

eKuiper 扩展了几个可以在模版中使用的函数。

• (deprecated)json para1: json 函数用于将 map 内容转换为 JSON 字符串。本函数已弃用，建议使用 sprig 扩展的 toJson 函数。
• (deprecated)base64 para1: base64 函数用于将参数值编码为 base64 字符串。本函数已弃用，建议将参数转换为 string 类型后，使用 sprig 扩展的 b64enc 函数。

动态属性

有些情况下，用户需要按照数据把结果发送到不同的目标中。例如，根据收到的数据，把计算结果发到不同的 mqtt 主题中。使用基于数据模板格式的动态属性，可以实现这样的功能。在以下的例子中，目标的 topic 属性是一个数据模板格式的字符串从而在运行时会将消息发送到动态的主题中。

{
  "id": "rule1",
  "sql": "SELECT topic FROM demo",
  "actions": [{
    "mqtt": {
      "sendSingle": true,
      "topic": "prefix/{{.topic}}"
    }
  }]
}

需要注意的是，上例中的 sendSingle 属性已设置。在默认情况下，目标接收到的是数组，使用的 jsonpath 需要采用 {{index . 0 “topic”}}。