Skip to content

用户配置

用户配置主要定义系统端口以及数据存放路径等普通配置,这些配置需要根据系统运行的环境进行配置。

说明

用户配置文件是一个 YAML 文件,文件名为config.user.yaml,它的内容是一个 YAML 对象,包含以下字段:

listen:

监听端口,它有 2 个子字段,也即是两个端口,需要注意的是这两个端口不能相同。这两个端口,详情如下:

  1. httpPort:
    web 端口,需要是一个有效的端口,即取值范围 1024 到 49151,没有默认值,所以必须配置
  2. opioPort:
    数据传输协议 (opio 协议) 端口,需要是一个有效的端口,即取值范围 1024 到 49151,没有默认值,所以必须配置

storageRoot:

数据存储路径,默认值:"./data"

innerRoot:

内部数据存储路径,内部数据包括表结构、用户信息、系统监控信息等,默认值: "./inner_data"

realtime:

实时表相关配置,实时表的表名为普通数据表的表名加_rt 构成,实时表的结构和对应的普通数据表结构相同,只存储是一个 key 的最新一条记录,它有 1 个子字段,分别是:

  1. enable:
    是否开启实时表功能,默认值:false

plugins:

用户自定义插件

示例

一个完整用户配置文件内容如下:

yaml
listen:
  httpPort: 19503
  opioPort: 19504

storageRoot: "./data" 
innerRoot: "./inner_data"

realtime:
  enable: true
  
# 用户自定义插件
plugins:
  # - path: "/path/to/plugin"
  #   type: "goPlugin" # 可选值: goPlugin, wasm, wasi
  #   funcs:
  #     - name: "plus" # 函数名
  #       argsCount: [1,2,3] # 参数个数
  #       returnType: "VtInt64" # 返回值类型