eKuiper REST api 允许您管理模式，例如创建、删除和列出模式。

创建模式

该 API 接受 JSON 内容以创建新的模式。 每种模式类型都有一个独立的端点。当前模式类型仅有一种 protobuf。模式由名称标识。名称必须唯一。

POST http://localhost:9081/schemas/protobuf

模式内容在请求体上的请求示例：

{
  "name": "schema1",
  "content": "message Book {required string title = 1; required int32 price = 2;}"
}

模式内容在文件上的请求示例：

{
  "name": "schema2",
  "file": "file:///tmp/ekuiper/internal/schema/test/test2.proto"
}

模式包含静态插件示例：

{
  "name": "schema2",
  "file": "file:///tmp/ekuiper/internal/schema/test/test2.proto",
   "soFile": "file:///tmp/ekuiper/internal/schema/test/so.proto"
}

参数

1. name：模式的唯一名称。
2. 模式的内容，可选用 file 或 content 参数来指定。模式创建后，模式内容将写入 data/schemas/$shcema_type/$schema_name 文件中。

   • file：模式文件的 URL。URL 支持 http 和 https 以及 file 模式。当使用 file 模式时，该文件必须在 eKuiper 服务器所在的机器上。引用的文件可以是单个模式文件，也可以是 ZIP 压缩文件。

     • 单个模式文件: 文件扩展名必须与相应的模式类型匹配。例如：Protobuf 模式文件必须是 .proto 扩展名。
     • ZIP 压缩文件: ZIP 文件根目录中必须包含一个主模式文件。可选地，ZIP 文件中还可以包含一个与模式名称相同（不带扩展名）的文件夹，用于存放支持文件。ZIP 归档中的任何其他文件或文件夹都将被忽略。例如：对于名为 test 的模式，test.zip 文件应具有以下结构：

       test.zip/
       ├── test.proto  (主文件)
       └── test/          (可选文件夹，包含支持文件)
         ├── helper.proto
         └── config.json

   • content：模式文件的内容。

3. soFile：静态插件 so。插件创建请看自定义格式。

显示模式

该 API 用于显示服务器中为模式类型定义的所有模式。

GET http://localhost:9081/schemas/protobuf

响应示例：

["schema1","schema2"]

描述模式

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

GET http://localhost:9081/schemas/protobuf/{name}

路径参数 name 是模式的名称。

响应示例：

{
  "type": "protobuf",
  "name": "schema1",
  "content": "message Book {required string title = 1; required int32 price = 2;}",
  "file": "ekuiper\\etc\\schemas\\protobuf\\schema1.proto"
}

删除模式

该 API 用于删除模式。

DELETE http://localhost:9081/schemas/protobuf/{name}

修改模式

该 API 用于修改模式，其消息体格式与创建时相同。

PUT http://localhost:9081/schemas/protobuf/{name}

{
  "name": "schema2",
  "file": "http://ahot.com/test2.proto"
}

版本控制 (Versioning)

模式（schema）可以包含一个可选的 version 字段。此字段对于控制更新和确保正确应用新模式至关重要。当您更新一个模式时，系统会将新的版本字符串与现有版本进行比较。只有当新版本在 词典顺序上更大时，更新才会被接受。这个比较是逐个字符的字符串比较，而不是数值比较。

版本控制逻辑

• 未指定版本：如果新旧模式都没有 version 字段，更新将直接进行。此行为与原始未版本化模式的逻辑一致。
• 已设置版本：如果新旧模式中有一个包含 version 字段，系统将始终执行版本比较。任何版本字符串的存在都会触发新的比较逻辑。
• 词典比较：更新基于词典（字符串）比较。为了使更新成功，新模式的 version 必须在词典顺序上大于当前版本。
• 最小版本：不带 version 字段的模式被视为具有“最小可能”版本。这意味着，向一个现有的、未版本化的模式添加 version 字段总能成功更新，因为任何新的版本字符串在词典顺序上都会大于不存在的版本。

为了避免混淆并确保正确的顺序，强烈建议使用时间戳作为版本字符串。例如，Unix 纪元时间戳可以提供一个全球唯一且单调递增的值，这天然满足了词典比较规则。

以下是一个带有版本字段的模式请求示例：

{
  "name": "schema2",
  "file": "file:///tmp/ekuiper/internal/schema/test/test2.proto",
  "version": "1756436910"
}