# 接口设计 - 数据源 ## 新增数据源 ##### 请求路径 `/inputDataConnector` ##### 请求方式 `HTTP - POST` ##### 包类方法 `dispatch(type:'dataSource/remoteAdd')` ##### 请求参数 | 字段名(后端) | 字段名(前端) | 说明 | |---------------- |-------------------- |----------------- | | dataName | model.name | 数据源名称 | | note | model.description | 数据源说明 | | loadObject | model.target | 数据对象 | | dataTag | model.tags | 标签 | | type | model.type | 类型 | | createBy | | 创建者 | | dbConfig | | 数据库设置 | | addrass | model.address | 数据库地址 | | port | model.port | 数据库 | | databaseType | model.dbType | 数据库类型 | | dataName | model.dbName | 数据库名(SID) | | userName | model.userName | 用户名 | | passWord | model.password | 密码 | ##### 请求示例 ##### 返回结果 ##### 详细说明 ___ ## 修改数据源 ##### 请求路径 `/updateData` ##### 请求方式 `HTTP - POST` ##### 包类方法 `dispatch(type:'dataSource/remoteModify')` ##### 请求参数 | 字段名(后端) | 字段名(前端) | 说明 | |---------------- |-------------------- |---------------------------- | | dataId | code | 数据源ID | | dataName | model.name | 数据源名称 | | note | model.description | 数据源说明 | | loadObject | model.target | 数据对象 | | dataTag | model.tags | 数据源标签 | | type | model.type | 数据源类型 | | createBy | | 创建人 | | dbConfig{ | | 数据库配置(为空时不修改) | | addrass | model.address | 数据库地址 | | port | model.port | 数据库端口 | | databaseType | model.dbType | 数据库类型 | | dataName | model.dbName | 数据库名 | | userName | model.userName | 用户名 | | passWord | model.password | 密码 | | columnConfig | | 列配置 | | columnName | c.name | 列名 | | columnLable | c.alias | 别名 | | dataType | c.dataType | 数据类型 | | columnType | c.columnType | 分析类型 | | isGroup | c.groupable | 可分组 | | isSubsection | c.bucketizable | 可分段 | | isOpen | c.using | 启用 | | remarks | c.description | 备注 | | connectorGroup | model.groupCode | 分组代码 | ##### 请求示例 ##### 返回结果 ##### 详细说明 ___ ## 删除数据源 ##### 请求路径 `/delDataConnector` ##### 请求方式 `HTTP - POST` ##### 包类方法 `dispatch(type:'dataSource/remoteDelete')` ##### 请求参数 code 数据源ID ##### 请求示例 ##### 返回结果 ##### 详细说明 ___ ## 获取数据源列表 ##### 请求路径 `/getListDataConnector` ##### 请求方式 `HTTP - POST` ##### 包类方法 `dispatch(type:'dataSource/fetchList')` ##### 请求参数 无 ##### 请求示例 ##### 返回结果 ##### 详细说明 ___ ## 获得单个数据源详细数据 ##### 请求路径 `/getDataConnector` ##### 请求方式 `HTTP - POST` ##### 包类方法 `dispatch(type:'dataSource/remoteDetail')` ##### 请求参数 code ##### 请求示例 ##### 返回结果 ##### 详细说明 ___ ## 根据sql请求列数据信息 ##### 请求路径 `/implementSql` ##### 请求方式 `HTTP - POST` ##### 包类方法 `dispatch(type:'dataSource/importNewModelColumns')` ##### 请求参数 baseName: dataSource.newOne.userName strSql ##### 请求示例 ##### 返回结果 ##### 详细说明 此处业务逻辑并不是很完整和清晰 ___ ## 获得数据源所有分组/子分组 ##### 请求路径 `/getConnectorGroup` ##### 请求方式 `HTTP - POST` ##### 包类方法 `dispatch(type:'dataSource/remoteGroupList')` ##### 请求参数 Code 分组编号 Pcode 父级分组编号 Index 索引 Label 标签 ##### 请求示例 ##### 返回结果 ##### 详细说明 ___ ## 新增数据源分组/子分组 ##### 请求路径 `/setConnectorGroup` ##### 请求方式 `HTTP - POST` ##### 包类方法 `dispatch(type:'dataSource/ remoteAddGroup')` ##### 请求参数 | 字段名(后端) | 字段名(前端) | 说明 | |---------------- |---------------- |------------------- | | fatherId | pgroup.code | 父级分组ID | | groupName | “新子分组”' | 基础配置 – 数据源 | | groupIndex | | 分组索引 | | createBy | | 创建人 | ##### 请求示例 ##### 返回结果 ##### 详细说明 如果是顶级分组(没有父级分组),则父级分组ID设置为-1 ___ ## 修改数据源分组信息 ##### 请求路径 `/updataDataConnectorGroup` ##### 请求方式 `HTTP - POST` ##### 包类方法 `dispatch(type:'dataSource/remoteModifyGroup')` ##### 请求参数 | 字段名(后端) | 字段名(前端) | 说明 | |---------------- |---------------- |------------------- | | Id | Group.code | 分组ID | | fatherId | pgroup.code | 父级分组ID | | groupName | “新子分组”' | 基础配置 – 数据源 | | groupIndex | | 分组索引 | | createBy | | 创建人 | ##### 请求示例 ##### 返回结果 ##### 详细说明 ___ ## 设置数据源所属分组 ##### 请求路径 `/updateConnectConfigGroup` ##### 请求方式 `HTTP - POST` ##### 包类方法 `dispatch(type:'dataSource/remoteSetDataSourceGroup')` ##### 请求参数 | 字段名(后端) | 字段名(前端) | 说明 | |---------------- |---------------- |------------ | | Id | DatasourceCode | 数据源ID | | GroupID | “新子分组”' | 目标分组ID | ##### 请求示例 ##### 返回结果 ##### 详细说明 ___ ## 批量修改数据源分组信息 ##### 请求路径 `/updataConnectorGroup` ##### 请求方式 `HTTP - POST` ##### 包类方法 `dispatch(type:'dataSource/remoteModifyGroups')` ##### 请求参数 | 字段名(后端) | 字段名(前端) | 说明 | |---------------- |---------------- |------------------- | | fatherId | pgroup.code | 父级分组ID | | groupName | “新子分组”' | 基础配置 – 数据源 | | groupIndex | | 分组索引 | | createBy | | 创建人 | ##### 请求示例 ##### 返回结果 ##### 详细说明 此处将整个groups集体上传 集体替换。 此处建议使用batch表达批量修改的概念。 ___ ## 删除数据源分组/子分组 ##### 请求路径 `/delDataConnectorGroup` ##### 请求方式 `HTTP - POST` ##### 包类方法 `dispatch(type:'dataSource/remoteDeleteGroup'')` ##### 请求参数 group.code 分组ID ##### 请求示例 ##### 返回结果 ##### 详细说明