From bfe275135ac30093a55621df61a2f14cda9c458e Mon Sep 17 00:00:00 2001 From: ngjaying Date: Mon, 28 Oct 2024 13:42:44 +0800 Subject: [PATCH] docs(rule): doc of triggered prop (#3338) Signed-off-by: Jiyong Huang --- docs/en_US/guide/rules/overview.md | 1 + docs/zh_CN/guide/rules/overview.md | 17 +++++++++-------- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/en_US/guide/rules/overview.md b/docs/en_US/guide/rules/overview.md index 38e9f98424..ae235b6960 100644 --- a/docs/en_US/guide/rules/overview.md +++ b/docs/en_US/guide/rules/overview.md @@ -38,6 +38,7 @@ The table below is a detailed explanation of the row component: | actions | required if graph is not defined | An array of sink actions | | graph | required if sql is not defined | The json presentation of the rule's DAG(directed acyclic graph) | | options | true | A map of options | +| triggerd | true | Whether to start the rule after creation. Default is true. | ## Rule Logic diff --git a/docs/zh_CN/guide/rules/overview.md b/docs/zh_CN/guide/rules/overview.md index 69c466bc4c..c4be58fad4 100644 --- a/docs/zh_CN/guide/rules/overview.md +++ b/docs/zh_CN/guide/rules/overview.md @@ -24,14 +24,15 @@ ## 参数 -| 参数名 | 是否可选 | 说明 | -|---------|-----------------------|-----------------------------------| -| id | 否 | 规则 id, 规则 id 在同一 eKuiper 实例中必须唯一。 | -| name | 是 | 规则显示的名字或者描述。 | -| sql | 如果 graph 未定义，则该属性必须定义 | 为规则运行的 sql 查询 | -| actions | 如果 graph 未定义，则该属性必须定义 | Sink 动作数组 | -| graph | 如果 sql 未定义，则该属性必须定义 | 规则有向无环图的 JSON 表示 | -| options | 是 | 选项列表 | +| 参数名 | 是否可选 | 说明 | +|----------|-----------------------|-----------------------------------| +| id | 否 | 规则 id, 规则 id 在同一 eKuiper 实例中必须唯一。 | +| name | 是 | 规则显示的名字或者描述。 | +| sql | 如果 graph 未定义，则该属性必须定义 | 为规则运行的 sql 查询 | +| actions | 如果 graph 未定义，则该属性必须定义 | Sink 动作数组 | +| graph | 如果 sql 未定义，则该属性必须定义 | 规则有向无环图的 JSON 表示 | +| options | 是 | 选项列表 | +| triggerd | 是 | 布尔值，设置是否创建完规则后立刻运行，默认是 true | ## 规则逻辑