规则管理

eKuiper 规则命令行工具可以管理规则，例如创建、显示、删除、描述、启动、停止和重新启动规则。

创建规则

如下命令用于创建规则。 规则的定义以 JSON 格式指定，请阅读 规则 以获取更多详细信息。

create rule $rule_name '$rule_json' | create rule $rule_name -f $rule_def_file

可以通过两种方式创建规则。

• 在命令行中指定规则定义。注意规则 json 明文必须放在引号里。

示例：

# bin/kuiper create rule rule1 '{"sql": "SELECT * from demo","actions": [{"log":  {}},{"mqtt":  {"server":"tcp://127.0.0.1:1883", "topic":"demoSink"}}]}'

该命令创建一个名为 rule1 的规则。

请注意，在命令行中使用单引号字符串字面量时可能会遇到以下问题：

$ bin/kuiper create rule myrule '{"sql": "SELECT lower('abc') FROM demo"...}'

在使用上述命令创建规则时，单引号字符串字面量中的 'abc' 会被识别为变量 abc，这是由于 Shell 的引用机制导致的：

$ echo '{"sql": "SELECT lower('abc') FROM demo"}'
{"sql": "SELECT lower(abc) FROM demo"}

如果遇到以上问题，建议使用双引号字符串字面量 "abc" 来代替单引号字符串字面量 'abc'，以避免变量替代的情况发生。

• 在文件中明确规则定义。 如果规则很复杂，或者规则已经以组织良好的格式写在文本文件中，则只需通过 -f 选项指定规则定义即可。

示例：

# bin/kuiper create rule rule1 -f /tmp/rule.txt

以下是 rule.txt 的内容。

{
  "sql": "SELECT * from demo",
  "actions": [
    {
      "log": {}
    },
    {
      "mqtt": {
        "server": "tcp://127.0.0.1:1883",
        "topic": "demoSink"
      }
    }
  ]
}

展示规则

该命令用于显示服务器中定义的所有规则，包括规则 id 和当前状态。

show rules

示例：

# bin/kuiper show rules
[
  {
    "id": "rule1",
    "status": "Running"
  },
  {
     "id": "rule2",
     "status": "Stopped: canceled by error."
  }
]

描述规则

该命令用于打印规则的详细定义。

describe rule $rule_name

示例：

# bin/kuiper describe rule rule1
{
  "sql": "SELECT * from demo",
  "actions": [
    {
      "log": {}
    },
    {
      "mqtt": {
        "server": "tcp://127.0.0.1:1883",
        "topic": "demoSink"
      }
    }
  ]
}

删除规则

该命令用于删除规则。

drop rule $rule_name

示例：

# bin/kuiper drop rule rule1
rule rule1 dropped

启动规则

该命令用于开始运行规则。

start rule $rule_name

示例：

# bin/kuiper start rule rule1
rule rule1 started

停止规则

该命令用于停止运行规则。

stop rule $rule_name

示例：

# bin/kuiper stop rule rule1
rule rule1 stopped

重启规则

该命令用于重启规则。

restart rule $rule_name

示例：

# bin/kuiper restart rule rule1
rule rule1 restarted

获取规则的状态

该命令用于获取规则的状态。 状态可以是

• 运行: $metrics
• 停止: $reason

getstatus rule $rule_name

示例：

# bin/kuiper getstatus rule rule1
{
    "source_demo_0_records_in_total":5,
    "source_demo_0_records_out_total":5,
    "source_demo_0_exceptions_total":0,
    "source_demo_0_process_latency_ms":0,
    "source_demo_0_buffer_length":0,
    "source_demo_0_last_invocation":"2020-01-02T11:28:33.054821",
    ...
    "op_filter_0_records_in_total":5,
    "op_filter_0_records_out_total":2,
    "op_filter_0_exceptions_total":0,
    "op_filter_0_process_latency_ms":0,
    "op_filter_0_buffer_length":0,
    "op_filter_0_last_invocation":"2020-01-02T11:28:33.054821",
    ...
}

验证规则

如下命令用于验证规则。 规则的定义以 JSON 格式指定，请阅读 规则 以获取更多详细信息。

validate rule $rule_name '$rule_json' | validate rule $rule_name -f $rule_def_file

可以通过两种方式验证规则，和创建规则的两种方式相同。

• 在命令行中指定规则定义。

示例：

# bin/kuiper validate rule rule1 '{"sql": "SELECT * from demo","actions": [{"log":  {}},{"mqtt":  {"server":"tcp://127.0.0.1:1883", "topic":"demoSink"}}]}'
The rule has been successfully validated and is confirmed to be correct.

该命令验证一个名为 rule1 的规则。

• 在文件中明确规则定义。

示例：

# bin/kuiper validate rule rule1 -f /tmp/rule.txt
The rule has been successfully validated and is confirmed to be correct.

以下是 rule.txt 的内容。

{
  "sql": "SELECT * from demo",
  "actions": [
    {
      "log": {}
    },
    {
      "mqtt": {
        "server": "tcp://127.0.0.1:1883",
        "topic": "demoSink"
      }
    }
  ]
}