yao-app-ts-types/json-schemas/0.10.4/connector.json

typescript types for yao application

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$ref": "#/definitions/YaoConnector.ConnectorDSL",
  "definitions": {
    "YaoConnector.ConnectorDSL": {
      "type": "object",
      "properties": {
        "lang": {
          "type": "string",
          "description": "语言"
        },
        "version": {
          "type": "string",
          "description": "版本【管理字段】"
        },
        "decription": {
          "type": "string",
          "description": "描述【管理字段】"
        },
        "comment": {
          "type": "string",
          "description": "备注【管理字段】"
        },
        "type": {
          "$ref": "#/definitions/YaoConnector.ConnectorEnum",
          "description": "连接器类型, 当前支持 `mysql`, `sqlite3`, `mongo` 和 `redis`"
        },
        "name": {
          "type": "string",
          "description": "连接器名称"
        },
        "label": {
          "type": "string",
          "description": "标签显示"
        },
        "options": {
          "anyOf": [
            {
              "$ref": "#/definitions/YaoConnector.XunOption"
            },
            {
              "$ref": "#/definitions/YaoConnector.RedisOption"
            },
            {
              "$ref": "#/definitions/YaoConnector.Sqlite3Option"
            },
            {
              "$ref": "#/definitions/YaoConnector.MongoDBOption"
            },
            {
              "$ref": "#/definitions/YaoConnector.OpenAIOption"
            }
          ],
          "description": "连接器配置项"
        },
        "$schema": {
          "type": "string"
        }
      },
      "required": [
        "type"
      ],
      "additionalProperties": false
    },
    "YaoConnector.ConnectorEnum": {
      "type": "string",
      "enum": [
        "mysql",
        "sqlite",
        "sqlite3",
        "postgres",
        "redis",
        "mongo",
        "openai",
        "hdb"
      ]
    },
    "YaoConnector.XunOption": {
      "type": "object",
      "properties": {
        "db": {
          "type": "string",
          "description": "数据库名称, 支持使用`$EVN.变量名` 读取环境变量"
        },
        "prefix": {
          "type": "string",
          "description": "表前缀"
        },
        "charset": {
          "type": "string",
          "description": "MySQL charset"
        },
        "collation": {
          "type": "string",
          "description": "MySQL collation"
        },
        "parseTime": {
          "type": "boolean",
          "description": "解析时间"
        },
        "timeout": {
          "type": "boolean",
          "description": "连接超时"
        },
        "file": {
          "type": "string",
          "description": "sqlite3数据库文件地址, 支持使用`$EVN.变量名` 读取环境变量"
        },
        "params": {
          "type": "object",
          "description": "其它参数"
        },
        "hosts": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/YaoConnector.XunDBHost"
          },
          "description": "服务器列表"
        }
      },
      "additionalProperties": false
    },
    "YaoConnector.XunDBHost": {
      "type": "object",
      "properties": {
        "host": {
          "type": "string",
          "description": "MySQL Host, 支持使用`$EVN.变量名` 读取环境变量"
        },
        "port": {
          "type": "string",
          "description": "MySQL Port, 支持使用`$EVN.变量名` 读取环境变量"
        },
        "user": {
          "type": "string",
          "description": "MySQL User name, 支持使用`$EVN.变量名` 读取环境变量"
        },
        "pass": {
          "type": "string",
          "description": "MySQL Password, 支持使用`$EVN.变量名` 读取环境变量"
        },
        "primary": {
          "type": "boolean",
          "description": "`true` 为主库, `false`为从库"
        }
      },
      "additionalProperties": false,
      "description": "服务器列表"
    },
    "YaoConnector.RedisOption": {
      "type": "object",
      "properties": {
        "host": {
          "type": "string",
          "description": "Redis Host, 支持使用`$EVN.变量名` 读取环境变量"
        },
        "port": {
          "type": "string",
          "description": "Redis Port, 支持使用`$EVN.变量名` 读取环境变量"
        },
        "user": {
          "type": "string",
          "description": "Redis User name, 支持使用`$EVN.变量名` 读取环境变量"
        },
        "pass": {
          "type": "string",
          "description": "Redis Password, 支持使用`$EVN.变量名` 读取环境变量"
        },
        "db": {
          "type": "string",
          "description": "Redis DB, 支持使用`$EVN.变量名` 读取环境变量"
        }
      },
      "additionalProperties": false
    },
    "YaoConnector.Sqlite3Option": {
      "type": "object",
      "properties": {
        "file": {
          "type": "string",
          "description": "数据库文件地址, 支持使用`$EVN.变量名` 读取环境变量"
        }
      },
      "additionalProperties": false
    },
    "YaoConnector.MongoDBOption": {
      "type": "object",
      "properties": {
        "db": {
          "type": "string",
          "description": "数据库名称, 支持使用`$EVN.变量名` 读取环境变量"
        },
        "timeout": {
          "type": "boolean",
          "description": "连接超时"
        },
        "hosts": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/YaoConnector.MongoHost"
          },
          "description": "服务器列表"
        },
        "params": {
          "type": "object",
          "description": "连接参数"
        }
      },
      "additionalProperties": false
    },
    "YaoConnector.MongoHost": {
      "type": "object",
      "properties": {
        "host": {
          "type": "string",
          "description": "MySQL Host, 支持使用`$EVN.变量名` 读取环境变量"
        },
        "port": {
          "type": "string",
          "description": "MySQL Port, 支持使用`$EVN.变量名` 读取环境变量"
        },
        "user": {
          "type": "string",
          "description": "MySQL User name, 支持使用`$EVN.变量名` 读取环境变量"
        },
        "pass": {
          "type": "string",
          "description": "MySQL Password, 支持使用`$EVN.变量名` 读取环境变量"
        }
      },
      "additionalProperties": false,
      "description": "服务器列表"
    },
    "YaoConnector.OpenAIOption": {
      "type": "object",
      "properties": {
        "proxy": {
          "type": "string",
          "description": "api.openai.com对应的代理网站"
        },
        "model": {
          "type": "string",
          "description": "open ai模型"
        },
        "key": {
          "type": "string",
          "description": "openai 接口调用token key"
        }
      },
      "additionalProperties": false
    }
  }
}