doc(*): The source/sink json clean up

Signed-off-by: Jiyong Huang <huangjy@emqx.io>

docs/en_US/rules/sinks/builtin/memory.md

@@ -4,9 +4,10 @@
 
 The action is used to flush the result into an in-memory topic so that it can be consumed by the [memory source](../../sources/builtin/memory.md). The topic is like pubsub topic such as mqtt, so that there could be multiple memory sinks which publish to the same topic and multiple memory sources which subscribe to the same topic. The typical usage for memory action is to form [rule pipelines](../../rule_pipeline.md).
 
-| Property name | Optional | Description                                    |
-|---------------|----------|------------------------------------------------|
-| topic         | false    | The in-memory topic, such as `analysis/result` |
+| Property name | Optional | Description                                                                                                        |
+|---------------|----------|--------------------------------------------------------------------------------------------------------------------|
+| topic         | false    | The in-memory topic, such as `analysis/result`                                                                     |
+| rowkindField  | true     | Specify which field represents the action like insert or update. If not specified, all rows are default to insert. |
 
 Below is a sample memory action configuration:
 

docs/en_US/rules/sinks/builtin/redis.md

@@ -26,9 +26,10 @@ Restart the eKuiper server to activate the plugin.
 | field         | true     | This field must exist and be of type string. Otherwise, use the field character as the key. Note: Do not use a data template to configure this value                                                 |
 | dataType      | false    | The default Redis data type is string. Note that the original key must be deleted after the Redis data type is changed. Otherwise, the modification is invalid. now only support "list" and "string" |
 | expiration    | false    | Timeout duration of Redis data. This parameter is valid only for string data in seconds. The default value is -1                                                                                     |
+| rowkindField  | true     | Specify which field represents the action like insert or update. If not specified, all rows are default to insert.                                                                                   |
 ## Sample usage
 
-Below is a sample for selecting temperature great than 50 degree, and some profiles only for your reference.
+Below is a sample for selecting temperature greater than 50 degree, and some profiles only for your reference.
 
 ### /tmp/redisRule.txt
 ```json

docs/en_US/rules/sinks/plugin/sql.md

@@ -33,6 +33,7 @@ for example, if he only wants mysql, then he can build with build tag `mysql`.
 | table          | false    | The table name of the result                                                                                                                                  |
 | fields         | true     | The fields to be inserted to. The result map and the database should both have these fields. If not specified, all fields in the result map will be inserted. |
 | tableDataField | true     | Write the nested values of the tableDataField into database.                                                                                                  |
+| rowkindField   | true     | Specify which field represents the action like insert or update. If not specified, all rows are default to insert.                                            |
 
 ## Sample usage
 

docs/zh_CN/rules/sinks/builtin/memory.md

@@ -4,9 +4,10 @@
 
 该动作用于将结果刷新到内存中的主题中，以便 [内存源](../../sources/builtin/memory.md) 可以使用它。 该主题类似于 pubsub 主题，例如 mqtt，因此可能有多个内存目标发布到同一主题，也可能有多个内存源订阅同一主题。 内存动作的典型用途是形成[规则管道](../../rule_pipeline.md)。
 
-| 属性名称  | 是否可选 | 描述                                  |
-|-------|------|-------------------------------------|
-| topic | 否    | 内存中的主题，例如 `analysis/result`, 支持动态属性 |
+| 属性名称         | 是否可选 | 描述                                     |
+|--------------|------|----------------------------------------|
+| topic        | 否    | 内存中的主题，例如 `analysis/result`, 支持动态属性    |
+| rowkindField | 是    | 指定哪个字段表示操作，例如插入或更新。如果不指定，默认所有的数据都是插入操作 |
 
 下面是一个内存动作配置示例：
 

docs/zh_CN/rules/sinks/builtin/redis.md

@@ -17,15 +17,16 @@ redis 源代码在 extensions 目录中，但是需要在 eKuiper 根目录编
 
 ## 属性
 
-| 属性名称       | 是否必填 | 说明                                                                                                                                                                                                                                       |
-|------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| addr       | 是    | Redis 的地址, 例如: 10.122.48.17:6379                                                                                                                                                                                                         |
-| password   | 否    | Redis 登陆密码                                                                                                                                                                                                                               |
-| db         | 是    | Redis 的数据库,例如0                                                                                                                                                                                                                           |
-| key        | 是    | Redis 数据的 Key， key 与 field 选择其中一个, 优先 field                                                                                                                                                                                              |
-| field      | 否    | json 数据某一个属性，配置它作为 redis 数据的 key 值, 例如 deviceName, 该字段必须存在且为 string 类型，否则以 field 字符作为 key。比如 field 属性为 "deviceName", 收到 {“deviceName":"abc"}, 那么存入redis用的key是 "abc"; 收到 {“deviceName": 2}, 那么存入redis用的key是 "deviceName"。 注意:配置该值不要使用数据模板 |
-| dataType   | 是    | Redis 数据的类型, 默认是 string, 注意修改类型之后，需在redis中删除原有 key，否则修改无效。目前只支持 "list" 和 "string"                                                                                                                                                        |
-| expiration | 是    | 超时时间                                                                                                                                                                                                                                     |
+| 属性名称         | 是否必填 | 说明                                                                                                                                                                                                                                       |
+|--------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| addr         | 是    | Redis 的地址, 例如: 10.122.48.17:6379                                                                                                                                                                                                         |
+| password     | 否    | Redis 登陆密码                                                                                                                                                                                                                               |
+| db           | 是    | Redis 的数据库,例如0                                                                                                                                                                                                                           |
+| key          | 是    | Redis 数据的 Key， key 与 field 选择其中一个, 优先 field                                                                                                                                                                                              |
+| field        | 否    | json 数据某一个属性，配置它作为 redis 数据的 key 值, 例如 deviceName, 该字段必须存在且为 string 类型，否则以 field 字符作为 key。比如 field 属性为 "deviceName", 收到 {“deviceName":"abc"}, 那么存入redis用的key是 "abc"; 收到 {“deviceName": 2}, 那么存入redis用的key是 "deviceName"。 注意:配置该值不要使用数据模板 |
+| dataType     | 是    | Redis 数据的类型, 默认是 string, 注意修改类型之后，需在redis中删除原有 key，否则修改无效。目前只支持 "list" 和 "string"                                                                                                                                                        |
+| expiration   | 是    | 超时时间                                                                                                                                                                                                                                     |
+| rowkindField | 是    | 指定哪个字段表示操作，例如插入或更新。如果不指定，默认所有的数据都是插入操作                                                                                                                                                                                                   |
 
 ## 示例用法
 

docs/zh_CN/rules/sinks/plugin/sql.md

@@ -30,6 +30,7 @@
 | table          | false    | 结果的表名                                       |
 | fields         | true     | 要插入的字段。结果映射和数据库都应该有这些字段。如果未指定，将插入结果映射中的所有字段 |
 | tableDataField | true     | 将 tableDataField 的嵌套值写入数据库。                 |
+| rowkindField   | true     | 指定哪个字段表示操作，例如插入或更新。如果不指定，默认所有的数据都是插入操作      |
 
 ## 使用样例
 

etc/mqtt_source.json

@@ -80,17 +80,21 @@
 			}
 		}, {
 			"name": "protocolVersion",
-			"default": "3.1",
+			"default": "3.1.1",
 			"optional": true,
 			"connection_related": true,
-			"control": "text",
+			"control": "select",
+			"values": [
+				"3.1",
+				"3.1.1"
+			],
 			"type": "string",
 			"hint": {
 				"en_US": "MQTT protocol version. 3.1 (also refer as MQTT 3) or 3.1.1 (also refer as MQTT 4). If not specified, the default value is 3.1.",
 				"zh_CN": "MQTT 协议版本。3.1 (也被称为 MQTT 3) 或者 3.1.1 (也被称为 MQTT 4)。 如果未指定，缺省值为 3.1。 "
 			},
 			"label": {
-				"en_US": "protocolVersion",
+				"en_US": "MQTT Protocol Version",
 				"zh_CN": "MQTT 协议版本"
 			}
 		}, {
@@ -105,7 +109,7 @@
 				"zh_CN": "MQTT 连接的客户端 ID。 如果未指定，将使用一个 uuid。"
 			},
 			"label": {
-				"en_US": "clientid",
+				"en_US": "MQTT Client ID",
 				"zh_CN": "客户端 ID"
 			}
 		}, {

etc/sinks/edgex.json

@@ -43,7 +43,7 @@
         "tcp",
         "redis"
       ],
-      "type": "list_string",
+      "type": "string",
       "hint": {
         "en_US": "The protocol. If it's not specified, then use default value 'redis'.",
         "zh_CN": "协议，如未指定，使用缺省值 redis。"
@@ -128,7 +128,7 @@
         "nats-jetstream",
         "nats-core"
       ],
-      "type": "list_string",
+      "type": "string",
       "hint": {
         "en_US": "The message bus type, two types of message buses are supported,'redis', 'zero' or 'mqtt', and 'redis' is the default value.",
         "zh_CN": "消息总线类型，目前支持两种类型的消息总线，'redis', 'zero' 或者 'mqtt'，其中 'redis' 为缺省类型。"
@@ -147,7 +147,7 @@
         "event",
         "request"
       ],
-      "type": "list_string",
+      "type": "string",
       "hint": {
         "en_US": "The EdgeX message model type. To publish the message as an event like EdgeX application service, use `event`. Otherwise, to publish the message as an event request like EdgeX device service or core data service, use `request`. If not specified, then use the default value `event`.",
         "zh_CN": "EdgeX 消息模型类型。若要将消息发送为类似 apllication service 的 event 类型，则应设置为 `event`。否则，若要将消息发送为类似 device service 或者 core data service 的 event request 类型，则应设置为 `request`。如未指定，使用缺省值 `event` 。"

etc/sinks/memory.json

@@ -31,6 +31,36 @@
         "en_US": "Topic",
         "zh_CN": "主题"
       }
+    },
+    {
+      "name": "rowkindField",
+      "default": "",
+      "optional": true,
+      "control": "text",
+      "type": "string",
+      "hint": {
+        "en_US": "Specify which field represents the action like insert or update. If not specified, all rows are default to insert",
+        "zh_CN": "指定哪个字段表示操作，例如插入或更新。如果不指定，默认所有的数据都是插入操作"
+      },
+      "label": {
+        "en_US": "Rowkind Field",
+        "zh_CN": "动作字段"
+      }
+    },
+    {
+      "name": "keyField",
+      "default": "",
+      "optional": true,
+      "control": "text",
+      "type": "string",
+      "hint": {
+        "en_US": "Specify which field represents the key of the message. It is required when rowkindField is specified.",
+        "zh_CN": "指定哪个字段表示消息的key。当指定了动作字段时，该字段是必须的。"
+      },
+      "label": {
+        "en_US": "Key Field",
+        "zh_CN": "Key字段"
+      }
     }
   ],
   "node": {

etc/sinks/mqtt.json

@@ -82,7 +82,7 @@
     },
     {
       "name": "protocolVersion",
-      "default": "3.1",
+      "default": "3.1.1",
       "optional": true,
       "control": "select",
       "values": [

etc/sinks/neuron.json

@@ -19,7 +19,7 @@
   "properties": [
     {
       "name": "nodeName",
-      "optional": false,
+      "optional": true,
       "control": "text",
       "default": "",
       "type": "string",
@@ -34,7 +34,7 @@
     },
     {
       "name": "groupName",
-      "optional": false,
+      "optional": true,
       "control": "text",
       "default": "",
       "type": "string",
@@ -50,7 +50,7 @@
     {
       "name": "tags",
       "default": [],
-      "optional": false,
+      "optional": true,
       "control": "list",
       "type": "list_string",
       "hint": {

etc/sinks/redis.json

@@ -31,7 +31,7 @@
 				"zh_CN": "Redis的地址, 例如: 10.122.48.17:6379"
 			},
 			"label": {
-				"en_US": "Addr",
+				"en_US": "Address",
 				"zh_CN": "地址"
 			}
 		},
@@ -68,7 +68,7 @@
 		{
 			"name": "key",
 			"default": "key",
-			"optional": false,
+			"optional": true,
 			"control": "text",
 			"type": "string",
 			"hint": {
@@ -91,8 +91,8 @@
 				"zh_CN": "json数据某一个属性，配置它作为redis数据的key值, 例如 deviceName,该字段必须存在且为string类型，否则以field字符作为key,注意:配置该值不要使用数据模板"
 			},
 			"label": {
-				"en_US": "field",
-				"zh_CN": "field"
+				"en_US": "Key Field",
+				"zh_CN": "Key 字段"
 			}
 		},
 		{
@@ -110,7 +110,7 @@
 				"zh_CN": "Redis 数据的类型, 默认是 string, 注意修改类型之后，需在redis中删除原有key，否则修改无效。"
 			},
 			"label": {
-				"en_US": "data type",
+				"en_US": "Data type",
 				"zh_CN": "数据类型"
 			}
 		},
@@ -125,9 +125,32 @@
 				"zh_CN": "Redis数据的超时时间，仅在string类型数据有效,单位是秒,默认是永久保存-1 "
 			},
 			"label": {
-				"en_US": "expiration",
+				"en_US": "Expiration",
 				"zh_CN": "超时时间"
 			}
+		},
+		{
+			"name": "rowkindField",
+			"default": "",
+			"optional": true,
+			"control": "text",
+			"type": "string",
+			"hint": {
+				"en_US": "Specify which field represents the action like insert or update. If not specified, all rows are default to insert",
+				"zh_CN": "指定哪个字段表示操作，例如插入或更新。如果不指定，默认所有的数据都是插入操作"
+			},
+			"label": {
+				"en_US": "Rowkind Field",
+				"zh_CN": "动作字段"
+			}
+		}
+	],
+	"node": {
+		"category": "sink",
+		"icon": "iconPath",
+		"label": {
+			"en": "Redis",
+			"zh": "Redis"
 		}
-	]
+	}
 }

etc/sinks/rest.json

@@ -37,7 +37,7 @@
       "optional": true,
       "control": "select",
       "default": "GET",
-      "type": "list_string",
+      "type": "string",
       "values": [
         "GET",
         "POST",
@@ -59,7 +59,7 @@
       "optional": true,
       "control": "select",
       "default": "none",
-      "type": "list_string",
+      "type": "string",
       "values": [
         "none",
         "json",

etc/sources/edgex.json

@@ -114,7 +114,7 @@
 					"nats-jetstream",
 					"nats-core"
 				],
-				"type": "list_string",
+				"type": "string",
 				"hint": {
 					"en_US": "The EdgeX message bus type, currently two types of message buses are supported. If specified other values, then will use the default redis value.",
 					"zh_CN": "EdgeX 消息总线类型，目前支持两种消息总线。如果指定了错误的消息总线类型，那么会使用缺省 redis 类型。"
@@ -133,7 +133,7 @@
 					"event",
 					"request"
 				],
-				"type": "list_string",
+				"type": "string",
 				"hint": {
 					"en_US": "The EdgeX message model type. If connected to the topic of EdgeX application service, the message model is an event. Otherwise, if connected to the topic of EdgeX message bus directly to receive the message from device service or core data, the message is request.",
 					"zh_CN": "EdgeX 消息模型类型。如果连接到 EdgeX application service 的 topic, 则消息为 event 类型。否则，如果直接连接到消息总线的 topic，接收到 device service 或者 core data 发出的数据，则消息类型为 request。"

etc/sources/httppush.json

@@ -22,7 +22,7 @@
 			"name": "method",
 			"default": "POST",
 			"optional": true,
-			"control": "text",
+			"control": "select",
 			"type": "string",
 			"values": ["POST","PUT"],
 			"hint": {

extensions/sinks/image/image.json

@@ -41,7 +41,7 @@
 			"jpeg",
 			"png"
 		],
-		"type": "list_string",
+		"type": "string",
 		"hint": {
 			"en_US": "File format, support jpeg and png.",
 			"zh_CN": "文件格式，支持 jpeg 和 png。"

extensions/sinks/sql/sql.json

@@ -74,6 +74,21 @@
 			"en_US": "Table field",
 			"zh_CN": "表字段"
 		}
+	},
+	{
+		"name": "rowkindField",
+		"default": "",
+		"optional": true,
+		"control": "text",
+		"type": "string",
+		"hint": {
+			"en_US": "Specify which field represents the action like insert or update. If not specified, all rows are default to insert",
+			"zh_CN": "指定哪个字段表示操作，例如插入或更新。如果不指定，默认所有的数据都是插入操作"
+		},
+		"label": {
+			"en_US": "Rowkind Field",
+			"zh_CN": "动作字段"
+		}
 	}
  ],
 	"node": {

extensions/sources/sql/sql.json

@@ -30,14 +30,14 @@
           "zh_CN": "数据库服务器的 URL"
         },
         "label": {
-          "en_US": "server address",
+          "en_US": "Server address",
           "zh_CN": "数据库地址"
         }
       },
       {
         "name": "interval",
         "default": 1000,
-        "optional": false,
+        "optional": true,
         "control": "text",
         "type": "int",
         "hint": {
@@ -63,7 +63,7 @@
               "zh_CN": "指定查询的数据库表名"
             },
             "label": {
-              "en_US": "tableName",
+              "en_US": "Table Name",
               "zh_CN": "表名"
             }
           },
@@ -78,7 +78,7 @@
               "zh_CN": "索引字段名"
             },
             "label": {
-              "en_US": "indexField",
+              "en_US": "Index Field",
               "zh_CN": "索引字段名"
             }
           },
@@ -93,7 +93,7 @@
               "zh_CN": "索引字段初始值"
             },
             "label": {
-              "en_US": "index init value",
+              "en_US": "Index init value",
               "zh_CN": "索引字段初始值"
             }
           },
@@ -118,14 +118,14 @@
             "optional": true,
             "control": "select",
             "type": "string",
-            "values": ["DATETIME"],
+            "values": ["DATETIME", "INT", "FLOAT", "STRING"],
             "hint": {
               "en_US": "is the index datetime type",
               "zh_CN": "是否为时间格式"
             },
             "label": {
-              "en_US": "indexFieldType",
-              "zh_CN": "indexFieldType"
+              "en_US": "Index Field Type",
+              "zh_CN": "索引字段格式"
             }
           },
           {
@@ -139,8 +139,8 @@
               "zh_CN": "dateTimeFormat"
             },
             "label": {
-              "en_US": "dateTimeFormat",
-              "zh_CN": "dateTimeFormat"
+              "en_US": "DateTime Format",
+              "zh_CN": "时间格式"
             }
           }
         ],
@@ -170,7 +170,7 @@
               "zh_CN": "查询语句模版"
             },
             "label": {
-              "en_US": "query template",
+              "en_US": "Query template",
               "zh_CN": "查询语句模版"
             }
           },
@@ -185,7 +185,7 @@
               "zh_CN": "索引字段名"
             },
             "label": {
-              "en_US": "indexField",
+              "en_US": "Index Field",
               "zh_CN": "索引字段名"
             }
           },
@@ -200,7 +200,7 @@
               "zh_CN": "索引字段初始值"
             },
             "label": {
-              "en_US": "index init value",
+              "en_US": "Index init value",
               "zh_CN": "索引字段初始值"
             }
           },
@@ -210,14 +210,14 @@
             "optional": true,
             "control": "select",
             "type": "string",
-            "values": ["DATETIME"],
+            "values": ["DATETIME", "INT", "FLOAT", "STRING"],
             "hint": {
               "en_US": "is the index datetime type",
               "zh_CN": "是否为时间格式"
             },
             "label": {
-              "en_US": "indexFieldType",
-              "zh_CN": "indexFieldType"
+              "en_US": "Index Field Type",
+              "zh_CN": "索引字段格式"
             }
           },
           {
@@ -231,8 +231,8 @@
               "zh_CN": "dateTimeFormat"
             },
             "label": {
-              "en_US": "dateTimeFormat",
-              "zh_CN": "dateTimeFormat"
+              "en_US": "DateTime Format",
+              "zh_CN": "时间格式"
             }
           }
         ],
@@ -260,7 +260,7 @@
     }
   ],
   "node": {
-    "category": ["Protocol","Protocol1"],
+    "category": "source",
     "icon": "iconPath",
     "label": {
       "en_US": "SQL",