mirror of https://github.com/milvus-io/milvus.git
[skip ci]Format markdown for appendix (#9318)
Signed-off-by: ruiyi.jiang <ruiyi.jiang@zilliz.com>pull/9329/head
ryjiang
GitHub
parent
27b95cea35
commit
bf35fa5d25
|
|
@ -1,5 +1,3 @@
|
|||
|
||||
|
||||
## Appendix B. API Reference
|
||||
|
||||
In this section, we introduce the RPCs of milvus service. A brief description of the RPCs is listed as follows.
|
||||
|
|
@ -42,8 +40,6 @@ message MsgBase {
|
|||
|
||||
**MsgType** is the enum to distinguish different message types in message queue, such as insert msg, search msg, etc. **msgID** is the unique id identifier of message. **timestamp** is the time when this message was generated. **sourceID** is the unique id identifier of the source.
|
||||
|
||||
|
||||
|
||||
#### 3.1 Definition Requests
|
||||
|
||||
###### 3.1.1 CreateCollection
|
||||
|
|
@ -107,8 +103,6 @@ message FieldSchema {
|
|||
|
||||
**index_params**：For fast search, you build index for field. You specify detailed index information for a field. Detailed information about index can be seen in chapter 2.2.3
|
||||
|
||||
|
||||
|
||||
**Returns:**
|
||||
|
||||
- **common.Status**
|
||||
|
|
@ -122,8 +116,6 @@ ErrorCode error_code = 1;
|
|||
|
||||
**Status** represents the server error code. It doesn't contain grpc error but contains the server error code. We can get the executing result in common status. **error_code** is an enum type to distinguish the executing error type. The total Errorcode is shown in the last of this code. And the **reason** field is a string to describe the detailed error.
|
||||
|
||||
|
||||
|
||||
###### 3.1.2 DropCollection
|
||||
|
||||
**Interface:**
|
||||
|
|
@ -165,8 +157,6 @@ message Status {
|
|||
|
||||
**Status** represents the server error code. It doesn't contain grpc error but contains the server error code. We can get the executing result in common status. **error_code** is an enum type to distinguish the executing error type. The total Errorcode is shown in the last of this code. And the **reason** field is a string to describes the detailed error.
|
||||
|
||||
|
||||
|
||||
###### 3.1.3 HasCollection
|
||||
|
||||
**Interface:**
|
||||
|
|
@ -210,8 +200,6 @@ message BoolResponse {
|
|||
|
||||
**value** represents whether the collection exists. If collection exists, value will be true. If collection doesn't exist, value will be false.
|
||||
|
||||
|
||||
|
||||
###### 3.1.4 LoadCollection
|
||||
|
||||
**Interface:**
|
||||
|
|
@ -253,8 +241,6 @@ message Status {
|
|||
|
||||
**Status** represents the server error code. It doesn't contain grpc error but contains the server error code. We can get the executing result in common status. **error_code** is an enum type to distinguish the executing error type. The total Errorcode is shown in the last of this code. And the **reason** field is a string to describes the detailed error.
|
||||
|
||||
|
||||
|
||||
###### 3.1.5 ReleaseCollection
|
||||
|
||||
**Interface:**
|
||||
|
|
@ -384,8 +370,6 @@ message GetCollectionStatisticsResponse {
|
|||
|
||||
**stats** is a map saving different statistics. For example, you can get row_count of a collection with key 'row_count'.
|
||||
|
||||
|
||||
|
||||
###### 3.1.8 ShowCollections
|
||||
|
||||
**Interface:**
|
||||
|
|
@ -413,9 +397,7 @@ message ShowCollectionsResponse {
|
|||
|
||||
**status** represents the server error code. It doesn't contain grpc error but contains the server error code. We can get the executing result in common status. **error_code** is an enum type to distinguish the executing error type. The total Errorcode is shown in the last of this code. And the **reason** field is a string to describe the error details.
|
||||
|
||||
**collection_names** is a list contains all collections' names.
|
||||
|
||||
|
||||
**collection_names** is a list contains all collections' names.
|
||||
|
||||
###### 3.1.9 CreatePartition
|
||||
|
||||
|
|
@ -459,8 +441,6 @@ message Status {
|
|||
|
||||
**Status** represents the server error code. It doesn't contain grpc error but contains the server error code. We can get the executing result in common status. **error_code** is an enum type to distinguish the executing error type. The total Errorcode is shown in the last of this code. And the **reason** field is a string to describes the detailed error.
|
||||
|
||||
|
||||
|
||||
###### 3.1.10 DropPartition
|
||||
|
||||
**Interface:**
|
||||
|
|
@ -503,8 +483,6 @@ message Status {
|
|||
|
||||
**Status** represents the server error code. It doesn't contain grpc error but contains the server error code. We can get the executing result in common status. **error_code** is an enum type to distinguish the executing error type. The total Errorcode is shown in the last of this code. And the **reason** field is a string to describes the detailed error.
|
||||
|
||||
|
||||
|
||||
###### 3.1.11 HasPartition
|
||||
|
||||
**Interface:**
|
||||
|
|
@ -549,7 +527,6 @@ message BoolResponse {
|
|||
|
||||
**value** represents whether the partition exists. If partition exists, value will be true. If partition doesn't exist, value will be false.
|
||||
|
||||
|
||||
###### 3.1.12 LoadPartitions
|
||||
|
||||
**Interface:**
|
||||
|
|
@ -721,15 +698,13 @@ message ShowPartitionsResponse {
|
|||
|
||||
**status** represents the server error code. It doesn't contain grpc error but contains the server error code. We can get the executing result in common status. **error_code** is an enum type to distinguish the executing error type. The total Errorcode is shown in the last of this code. And the **reason** field is a string to describes the detailed error.
|
||||
|
||||
**partition_names** is a list contains all partitions' name.
|
||||
**partitionIDs** is a list contains all partitions' ids. And the index of a parition in **partition_names** and **partitionIDs** are same.
|
||||
|
||||
**partition_names** is a list contains all partitions' name.
|
||||
**partitionIDs** is a list contains all partitions' ids. And the index of a parition in **partition_names** and **partitionIDs** are same.
|
||||
|
||||
#### 3.2 Manipulation Requsts
|
||||
|
||||
###### 3.2.1 Insert
|
||||
|
||||
|
||||
**Interface:**
|
||||
|
||||
```
|
||||
|
|
@ -781,14 +756,12 @@ message InsertResponse {
|
|||
|
||||
###### 3.2.2 Delete
|
||||
|
||||
* DeleteByID
|
||||
|
||||
|
||||
- DeleteByID
|
||||
|
||||
#### 3.3 Query
|
||||
|
||||
|
||||
#### 3.3 Index
|
||||
|
||||
###### 3.3.1 CreateIndex
|
||||
|
||||
**Interface:**
|
||||
|
|
@ -821,8 +794,6 @@ CreateIndex for the field with **field_name** in collection with **collection_na
|
|||
|
||||
**extra_params**：For fast search, you build index for field. You specify detailed index information for a field. Detailed information about index can be seen in chapter 2.2.3
|
||||
|
||||
|
||||
|
||||
**Returns:**
|
||||
|
||||
- **common.Status**
|
||||
|
|
@ -947,7 +918,6 @@ enum IndexState {
|
|||
|
||||
**index state** is an enum type to distinguish the different processes in the index building process.
|
||||
|
||||
|
||||
###### 3.3.4 DropIndex
|
||||
|
||||
**Interface:**
|
||||
|
|
@ -992,4 +962,3 @@ message Status {
|
|||
```
|
||||
|
||||
**Status** represents the server error code. It doesn't contain grpc error but contains the server error code. We can get the executing result in common status. **error_code** is an enum type to distinguish the executing error type. The total Errorcode is shown in the last of this code. And the **reason** field is a string to describe the detailed error.
|
||||
|
||||
|
|
|
|||
|
|
@ -27,30 +27,30 @@ $ MILVUS_CONFIG_FILE=/path/to/milvus/configs/milvus.yaml milvus run rootcoord
|
|||
|
||||
`server type`：指定执行程序的类型。`server type` 有：
|
||||
|
||||
* `rootcoord`
|
||||
* `proxy`
|
||||
* `querycoord`
|
||||
* `querynode`
|
||||
* `datacoord`
|
||||
* `datanode`
|
||||
* `indexcoord`
|
||||
* `indexnode`
|
||||
* `standalone`
|
||||
* `mixture`
|
||||
- `rootcoord`
|
||||
- `proxy`
|
||||
- `querycoord`
|
||||
- `querynode`
|
||||
- `datacoord`
|
||||
- `datanode`
|
||||
- `indexcoord`
|
||||
- `indexnode`
|
||||
- `standalone`
|
||||
- `mixture`
|
||||
|
||||
`flags`：指定命令行选项。例如，你可以使用 `-f` 或者 `--config-file` 选项去指定配置文件路径。
|
||||
|
||||
当 `server type` 为 `mixture` 时，必须附加以下几个 `flag` 中的一个或多个，表示这几个服务在一个进程内启动
|
||||
|
||||
* `-rootcoord`
|
||||
* `-querycoord`
|
||||
* `-datacoord`
|
||||
* `-indexcoord`
|
||||
|
||||
- `-rootcoord`
|
||||
- `-querycoord`
|
||||
- `-datacoord`
|
||||
- `-indexcoord`
|
||||
|
||||
> Getting help
|
||||
>
|
||||
> You can get help for CLI tool using the `--help` flag, or `-h` for short.
|
||||
>
|
||||
> ```shell
|
||||
> $ milvus run rootcoord --help
|
||||
> ```
|
||||
|
|
@ -58,45 +58,47 @@ $ MILVUS_CONFIG_FILE=/path/to/milvus/configs/milvus.yaml milvus run rootcoord
|
|||
### 命令行参数
|
||||
|
||||
**--version**
|
||||
* 打印系统版本号和组件名并退出
|
||||
|
||||
- 打印系统版本号和组件名并退出
|
||||
|
||||
**--config-check**
|
||||
* 检查配置文件的有效性并退出
|
||||
* 默认：false
|
||||
|
||||
- 检查配置文件的有效性并退出
|
||||
- 默认：false
|
||||
|
||||
**--config-file**
|
||||
|
||||
* 从文件中加载系统配置。如果设置了配置文件，则其他的命令行选项和环境变量都将被忽略。
|
||||
* 默认值： ""
|
||||
* 环境变量：MILVUS_CONFIG_FILE
|
||||
- 从文件中加载系统配置。如果设置了配置文件，则其他的命令行选项和环境变量都将被忽略。
|
||||
- 默认值： ""
|
||||
- 环境变量：MILVUS_CONFIG_FILE
|
||||
|
||||
**--log-level**
|
||||
|
||||
* 指定日志的输出级别。当前支持 `debug`，`info`，`warning`，`error`
|
||||
* 默认值："info"
|
||||
* 环境变量："MILVUS_LOG_LEVEL"
|
||||
- 指定日志的输出级别。当前支持 `debug`，`info`，`warning`，`error`
|
||||
- 默认值："info"
|
||||
- 环境变量："MILVUS_LOG_LEVEL"
|
||||
|
||||
**--log-path**
|
||||
|
||||
* 指定日志的存储路径。
|
||||
* 默认值："/var/lib/milvus/logs"
|
||||
* 环境变量："MILVUS_LOG_PATH"
|
||||
- 指定日志的存储路径。
|
||||
- 默认值："/var/lib/milvus/logs"
|
||||
- 环境变量："MILVUS_LOG_PATH"
|
||||
|
||||
### 配置文件描述
|
||||
|
||||
配置文件比命令行参数支持更多的选项。你可以根据 milvus.yaml.sample 文件按照需要创建一个新的配置文件 milvus.yaml 即可。
|
||||
|
||||
| 名称 | 描述 | 默认值 |
|
||||
| --------- | --------- | --------- |
|
||||
| etcd.endpoints | etcd 服务接入端 | "localhost:2379" |
|
||||
| minio.address | minio 服务地址 | "localhost" |
|
||||
| minio.port | minio 服务端口 | 9000 |
|
||||
| pulsar.address | pulsar 服务地址 | "localhost" |
|
||||
| pulsar.port | pulsar 服务端口 | 6650 |
|
||||
| log.level | 指定日志的输出级别。当前支持 `debug`，`info`，`warning`，`error` | "info" |
|
||||
| log.format | 指定日志的输出格式。当前支持 `text` 和 `json` | "text" |
|
||||
| log.file.rootPath | 指定日志的存储路径| "/var/lib/milvus/logs" |
|
||||
| log.file.maxSize | 日志文件的大小限制 | 300MB |
|
||||
| log.file.maxAge | 日志最大保留的天数。默认不清理旧的日志文件。如果设置该参数值，则会清理 `maxAge` 天前的日志文件。 | 0 |
|
||||
| log.file.maxBackups | 保留日志文件的最大数量。默认保留所有旧的日志文件。如果设置该参数值为 `7`，则最多会保留 `7` 个旧的日志文件。 | 0 |
|
||||
| msgChannel.chanNamePrefix.cluster | 指定pulsar 中topic 前缀| "by-dev" |
|
||||
| 名称 | 描述 | 默认值 |
|
||||
| --------------------------------- | ----------------------------------------------------------------------------------------------------------- | ---------------------- |
|
||||
| etcd.endpoints | etcd 服务接入端 | "localhost:2379" |
|
||||
| minio.address | minio 服务地址 | "localhost" |
|
||||
| minio.port | minio 服务端口 | 9000 |
|
||||
| pulsar.address | pulsar 服务地址 | "localhost" |
|
||||
| pulsar.port | pulsar 服务端口 | 6650 |
|
||||
| log.level | 指定日志的输出级别。当前支持 `debug`，`info`，`warning`，`error` | "info" |
|
||||
| log.format | 指定日志的输出格式。当前支持 `text` 和 `json` | "text" |
|
||||
| log.file.rootPath | 指定日志的存储路径 | "/var/lib/milvus/logs" |
|
||||
| log.file.maxSize | 日志文件的大小限制 | 300MB |
|
||||
| log.file.maxAge | 日志最大保留的天数。默认不清理旧的日志文件。如果设置该参数值，则会清理 `maxAge` 天前的日志文件。 | 0 |
|
||||
| log.file.maxBackups | 保留日志文件的最大数量。默认保留所有旧的日志文件。如果设置该参数值为 `7`，则最多会保留 `7` 个旧的日志文件。 | 0 |
|
||||
| msgChannel.chanNamePrefix.cluster | 指定 pulsar 中 topic 前缀 | "by-dev" |
|
||||
|
|
|
|||
|
|
@ -35,4 +35,3 @@ enum ErrorCode {
|
|||
DDRequestRace = 1000;
|
||||
}
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -1,2 +1 @@
|
|||
## Appendix E. Statistics
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue