Explorar el Código

doc: schemas and uploads folder are moved from etc to data

Signed-off-by: Jiyong Huang <huangjy@emqx.io>
Jiyong Huang hace 2 años
padre
commit
13ba8c6e4d

+ 1 - 1
docs/en_US/operation/cli/schemas.md

@@ -30,7 +30,7 @@ Example:
 # bin/kuiper create schema protobuf schema1 '{"name": "schema1","file": "file:///tmp/aschema.proto"}'
 # bin/kuiper create schema protobuf schema1 '{"name": "schema1","file": "file:///tmp/aschema.proto"}'
 ```
 ```
 
 
-This command creates a schema named `schema1` whose content is provided by `file` field in the json. The file will be copied into `etc/schemas/protobuf` and renamed to `schema1.proto.
+This command creates a schema named `schema1` whose content is provided by `file` field in the json. The file will be copied into `data/schemas/protobuf` and renamed to `schema1.proto.
 
 
 ### Parameters
 ### Parameters
 
 

+ 1 - 1
docs/en_US/operation/restapi/schemas.md

@@ -29,7 +29,7 @@ Schema content in a file:
 ### Parameters
 ### Parameters
 
 
 1. name:the unique name of the schema.
 1. name:the unique name of the schema.
-2. schema content, use `file` or `content` parameter to specify. After schema created, the schema content will be written into file `etc/schemas/$shcema_type/$schema_name`.
+2. schema content, use `file` or `content` parameter to specify. After schema created, the schema content will be written into file `data/schemas/$shcema_type/$schema_name`.
    - file: the url of the schema file. The url can be `http` or `https` scheme or `file` scheme to refer to a local file path of the eKuiper server. The schema file must be the file type of the corresponding schema type. For example, protobuf schema file's extension name must be .proto.
    - file: the url of the schema file. The url can be `http` or `https` scheme or `file` scheme to refer to a local file path of the eKuiper server. The schema file must be the file type of the corresponding schema type. For example, protobuf schema file's extension name must be .proto.
    - content: the text content of the schema.
    - content: the text content of the schema.
 
 

+ 5 - 5
docs/en_US/operation/restapi/uploads.md

@@ -2,7 +2,7 @@ The eKuiper REST api for configuration file uploads allows you to upload configu
 
 
 ## Upload a configuration file
 ## Upload a configuration file
 
 
-The API supports to upload a local file or provide the text content of file. The upload request will save the file into your `${configPath}/uploads`. It will override the existed file of the same name. The response is the absolute path of the uploaded file which you can refer in other configurations.
+The API supports to upload a local file or provide the text content of file. The upload request will save the file into your `${dataPath}/uploads`. It will override the existed file of the same name. The response is the absolute path of the uploaded file which you can refer in other configurations.
 
 
 ### Upload by a file
 ### Upload by a file
 
 
@@ -45,7 +45,7 @@ POST http://localhost:9081/config/uploads
 
 
 ## Show uploaded file list
 ## Show uploaded file list
 
 
-The API is used for displaying all files in the `${configPath}/uploads` path.
+The API is used for displaying all files in the `${dataPath}/uploads` path.
 
 
 ```shell
 ```shell
 GET http://localhost:9081/config/uploads
 GET http://localhost:9081/config/uploads
@@ -55,14 +55,14 @@ Response Sample:
 
 
 ```json
 ```json
 [
 [
-   "/ekuiper/etc/uploads/zk.gif",
-   "/ekuiper/etc/uploads/abc.gif"
+   "/ekuiper/data/uploads/zk.gif",
+   "/ekuiper/data/uploads/abc.gif"
 ]
 ]
 ```
 ```
 
 
 ## Delete an uploaded file
 ## Delete an uploaded file
 
 
-The API is used for deleting a file in the `${configPath}/uploads` path.
+The API is used for deleting a file in the `${dataPath}/uploads` path.
 
 
 ```shell
 ```shell
 DELETE http://localhost:9081/config/uploads/{fileName}
 DELETE http://localhost:9081/config/uploads/{fileName}

+ 1 - 1
docs/en_US/rules/codecs.md

@@ -24,7 +24,7 @@ A schema is a set of metadata that defines the data structure. For example, the
 
 
 ### Schema Registry
 ### Schema Registry
 
 
-Schemas are stored as files. The user can register the schema through the configuration file or the API. The schema is stored in `etc/schemas/${type}`. For example, a schema file in protobuf format should be placed in `etc/schemas/protobuf`.
+Schemas are stored as files. The user can register the schema through the configuration file or the API. The schema is stored in `data/schemas/${type}`. For example, a schema file in protobuf format should be placed in `data/schemas/protobuf`.
 
 
 When eKuiper starts, it will scan this configuration folder and automatically register the schemas inside. If you need to register or manage schemas on the fly, this can be done through the schema registry API, which acts on the file system.
 When eKuiper starts, it will scan this configuration folder and automatically register the schemas inside. If you need to register or manage schemas on the fly, this can be done through the schema registry API, which acts on the file system.
 
 

+ 1 - 1
docs/en_US/sqls/streams.md

@@ -74,7 +74,7 @@ The stream will subscribe to MQTT topic `test/`, the server connection uses sett
 demo () WITH (DATASOURCE="test/", FORMAT="protobuf", SCHEMAID="proto1.Book");
 demo () WITH (DATASOURCE="test/", FORMAT="protobuf", SCHEMAID="proto1.Book");
 ```
 ```
 
 
-The stream will subscribe to MQTT topic `test/` and using PROTOBUF format to decode the data. The decode schema is defined by `BOOK` message type in `$ekuiper/etc/schemas/protobuf/schema1.proto` file. Regardng the management of schema, please refer to [schema registry](../rules/codecs.md#schema).
+The stream will subscribe to MQTT topic `test/` and using PROTOBUF format to decode the data. The decode schema is defined by `BOOK` message type in `$ekuiper/data/schemas/protobuf/schema1.proto` file. Regardng the management of schema, please refer to [schema registry](../rules/codecs.md#schema).
 
 
 - See [MQTT source](../rules/sources/builtin/mqtt.md) for more info.
 - See [MQTT source](../rules/sources/builtin/mqtt.md) for more info.
 
 

+ 1 - 1
docs/zh_CN/operation/cli/schemas.md

@@ -30,7 +30,7 @@ create schema $schema_type $schema_name $schema_json
 # bin/kuiper create schema protobuf schema1 '{"name": "schema1","file": "file:///tmp/aschema.proto"}'
 # bin/kuiper create schema protobuf schema1 '{"name": "schema1","file": "file:///tmp/aschema.proto"}'
 ```
 ```
 
 
-该命令创建一个名为 `schema1` 的模式,模式内容由 json 中的 file 指定。文件将被复制到 `etc/schemas/protobuf` 下并重命名为 `schema1.proto`。
+该命令创建一个名为 `schema1` 的模式,模式内容由 json 中的 file 指定。文件将被复制到 `data/schemas/protobuf` 下并重命名为 `schema1.proto`。
 
 
 ### 参数
 ### 参数
 
 

+ 1 - 1
docs/zh_CN/operation/restapi/schemas.md

@@ -29,7 +29,7 @@ POST http://localhost:9081/schemas/protobuf
 ### 参数
 ### 参数
 
 
 1. name:模式的唯一名称。
 1. name:模式的唯一名称。
-2. 模式的内容,可选用 file 或 content 参数来指定。模式创建后,模式内容将写入 `etc/schemas/$shcema_type/$schema_name` 文件中。
+2. 模式的内容,可选用 file 或 content 参数来指定。模式创建后,模式内容将写入 `data/schemas/$shcema_type/$schema_name` 文件中。
    - file:模式文件的 URL。URL 支持 http 和 https 以及 file 模式。当使用 file 模式时,该文件必须在 eKuiper 服务器所在的机器上。它必须是模式类型对应的格式。例如 protobuf 模式的文件扩展名应为 .proto。
    - file:模式文件的 URL。URL 支持 http 和 https 以及 file 模式。当使用 file 模式时,该文件必须在 eKuiper 服务器所在的机器上。它必须是模式类型对应的格式。例如 protobuf 模式的文件扩展名应为 .proto。
    - content:模式文件的内容。
    - content:模式文件的内容。
 
 

+ 5 - 5
docs/zh_CN/operation/restapi/uploads.md

@@ -2,7 +2,7 @@ eKuiper REST api允许您上传配置文件并列出所有上传的文件。
 
 
 ## 上传配置文件
 ## 上传配置文件
 
 
-支持两种方式上传配置文件:上传文件或者提供文件名和文本内容。上传请求将把文件保存到你的 `${configPath}/uploads` 。它将覆盖现有的同名文件。返回的响应是上传文件的绝对路径,从而可以在其他配置中使用。
+支持两种方式上传配置文件:上传文件或者提供文件名和文本内容。上传请求将把文件保存到你的 `${dataPath}/uploads` 。它将覆盖现有的同名文件。返回的响应是上传文件的绝对路径,从而可以在其他配置中使用。
 
 
 ### 上传文件
 ### 上传文件
 
 
@@ -45,7 +45,7 @@ POST http://localhost:9081/config/uploads
 
 
 ## 获取上传文件的列表
 ## 获取上传文件的列表
 
 
-该API用于显示 `${configPath}/uploads` 路径中的所有文件。
+该API用于显示 `${dataPath}/uploads` 路径中的所有文件。
 
 
 ```shell
 ```shell
 GET http://localhost:9081/config/uploads
 GET http://localhost:9081/config/uploads
@@ -55,15 +55,15 @@ GET http://localhost:9081/config/uploads
 
 
 ```json
 ```json
 [
 [
-   "/ekuiper/etc/uploads/zk.gif",
-   "/ekuiper/etc/uploads/abc.gif"
+   "/ekuiper/data/uploads/zk.gif",
+   "/ekuiper/data/uploads/abc.gif"
 ]
 ]
 ```
 ```
 
 
 
 
 ## 删除已上传文件
 ## 删除已上传文件
 
 
-该 API 用于删除 `${configPath}/uploads` 路径下的文件。
+该 API 用于删除 `${dataPath}/uploads` 路径下的文件。
 
 
 ```shell
 ```shell
 DELETE http://localhost:9081/config/uploads/{fileName}
 DELETE http://localhost:9081/config/uploads/{fileName}

+ 1 - 1
docs/zh_CN/rules/codecs.md

@@ -24,7 +24,7 @@ eKuiper 计算过程中使用的是基于 Map 的数据结构,因此 source/si
 
 
 ### 模式注册
 ### 模式注册
 
 
-模式采用文件的形式存储。用户可以通过配置文件或者 API 进行模式的注册。模式的存放位置位于 `etc/schemas/${type}`。例如,protobuf 格式的模式文件,应该放置于 `etc/schemas/protobuf`。
+模式采用文件的形式存储。用户可以通过配置文件或者 API 进行模式的注册。模式的存放位置位于 `data/schemas/${type}`。例如,protobuf 格式的模式文件,应该放置于 `data/schemas/protobuf`。
 
 
 eKuiper 启动时,将会扫描该配置文件夹并自动注册里面的模式。若需要在运行中注册或管理模式,可通过模式注册表 API 来完成。API 的操作会作用到文件系统中。
 eKuiper 启动时,将会扫描该配置文件夹并自动注册里面的模式。若需要在运行中注册或管理模式,可通过模式注册表 API 来完成。API 的操作会作用到文件系统中。
 
 

+ 1 - 1
docs/zh_CN/sqls/streams.md

@@ -76,7 +76,7 @@ demo (
 demo () WITH (DATASOURCE="test/", FORMAT="protobuf", SCHEMAID="proto1.Book");
 demo () WITH (DATASOURCE="test/", FORMAT="protobuf", SCHEMAID="proto1.Book");
 ```
 ```
 
 
-流将订阅 MQTT 主题 `test/`,使用 PROTOBUF 格式,根据在 `$ekuiper/etc/schemas/protobuf/schema1.proto` 文件中的 `Book` 定义对流入的数据进行解码。其中,模式的管理详见[模式注册表](../rules/codecs.md#模式)。
+流将订阅 MQTT 主题 `test/`,使用 PROTOBUF 格式,根据在 `$ekuiper/data/schemas/protobuf/schema1.proto` 文件中的 `Book` 定义对流入的数据进行解码。其中,模式的管理详见[模式注册表](../rules/codecs.md#模式)。
 
 
 - 有关更多信息,请参见 [MQTT source](../rules/sources/builtin/mqtt.md) 
 - 有关更多信息,请参见 [MQTT source](../rules/sources/builtin/mqtt.md)