# 流管理

eKuiper REST api 可用于管理流,例如创建、描述、显示和删除流定义。

# 创建流

该 API 用于创建流。 有关流定义的更多详细信息,请参考

POST http://localhost:9081/streams
1

请求示例,请求命令是带有 sql 字段的 json 字符串。

{"sql":"create stream my_stream (id bigint, name string, score float) WITH ( datasource = \"topic/temperature\", FORMAT = \"json\", KEY = \"id\")"}
1

该 API 可以运行任何流 sql 语句,而不仅可以创建流。

# 显示流

该 API 用于显示服务器中定义的所有流。

GET http://localhost:9081/streams
1

响应示例:

["mystream"]
1

# 描述流

该 API 用于打印流的详细定义。

GET http://localhost:9081/streams/{id}}
1

响应示例:

{
  "Name": "demo",
  "StreamFields": [
    {
      "Name": "temperature",
      "FieldType": {
        "Type": 2
      }
    },
    {
      "Name": "ts",
      "FieldType": {
        "Type": 1
      }
    }
  ],
  "Options": {
    "DATASOURCE": "demo",
    "FORMAT": "JSON"
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

# 更新流

该 API 用于更新流定义。

PUT http://localhost:9081/streams/{id}
1

路径参数 id 是原有流定义的 id 或名称。

请求示例,请求命令是带有 sql 字段的 json 字符串。

{"sql":"create stream my_stream (id bigint, name string, score float) WITH ( datasource = \"topic/temperature\", FORMAT = \"json\", KEY = \"id\")"}
1

# 删除流

该 API 用于删除流定义。

DELETE http://localhost:9081/streams/{id}
1