搜索

数据表

本文档说明 DataTable 系列组件对外开放的常用接口，适用于通过平台数据表能力完成配置表、日志表、映射表和中间表的读取与写入。

说明：DataTable 系列包含多个后端服务（data-table-gauss-server1-0、data-table-kingbase-server1-0、data-table-clickhouse-server1-0、data-table-deepengine-server1-0 等），但对外接口路径统一。本文档以 data-table-deepmodel-server1-0 为例展示完整 URL。

表数据读取

查询数据表记录

用于按条件读取 DeepModel、MySQL 或 ClickHouse 数据表中的业务数据，适合读取映射表、日志表、配置表和中间结果表。

请求

项目	值
HTTP Method	`POST`
Path	`https://xxxx.com/deepfos-server/data-table-deepmodel-server1-0/datatable-using-view/data`

Request Body 字段

字段名	类型	必填	说明
elementName	String	是	数据表名称
path	String	否	数据表所在路径，与 `folderId` 二选一
folderId	String	否	数据表所在目录 ID，与 `path` 二选一
pageNum	Integer	否	页码
showNum	Integer	否	每页条数
orderColumn	String	否	排序字段
sortDesc	Boolean	否	是否降序

Request Body 示例

Copy

{
  "elementName": "B0305",
  "path": "/Application/00_JJHotel/05_DATA_DeepModel/DM01/",
  "pageNum": 1,
  "showNum": 100,
  "orderColumn": "name",
  "sortDesc": false
}

响应

响应体字段

字段名	类型	说明
elementName	String	数据表名称
count	Integer	总记录数
dataList	Array<Object>	查询结果
columnName	Array<String>	列名列表
description	String	数据表描述
actualTableName	String	实际表名
allowSQLQuery	Boolean	是否允许 SQL 查询

响应示例

Copy

{
  "elementName": "B0305",
  "count": 2,
  "dataList": [
    {
      "name": "E0101",
      "description_zh_cn": "上海主体",
      "is_base": "True"
    },
    {
      "name": "E0102",
      "description_zh_cn": "杭州主体",
      "is_base": "True"
    }
  ],
  "columnName": ["name", "description_zh_cn", "is_base"],
  "description": "实体映射表",
  "actualTableName": "B0305_20250101",
  "allowSQLQuery": true
}

自定义 SQL 查询

用于执行自定义 SQL 查询数据表数据，支持复杂条件过滤和多表联合查询。

请求

项目	值
HTTP Method	`POST`
Path	`https://xxxx.com/deepfos-server/data-table-deepmodel-server1-0/datatable-using-view/customizesql`

Request Body 字段

字段名	类型	必填	说明
elementName	String	是	数据表名称
path	String	否	数据表所在路径，与 `folderId` 二选一
folderId	String	否	数据表所在目录 ID，与 `path` 二选一
sql	String	是	自定义 SQL 语句

Request Body 示例

Copy

{
  "elementName": "B0305",
  "path": "/Application/00_JJHotel/05_DATA_DeepModel/DM01/",
  "sql": "SELECT name, description_zh_cn FROM ${B0305} WHERE is_base = 'True' ORDER BY name"
}

响应

响应体字段

字段名	类型	说明
code	Integer	响应码
message	String	响应消息
data	Object	查询结果
data.dataList	Array<Object>	数据列表
data.columnName	Array<String>	列名列表

响应示例

Copy

{
  "code": 0,
  "message": "操作成功！",
  "data": {
    "dataList": [
      {
        "name": "E0101",
        "description_zh_cn": "上海主体"
      },
      {
        "name": "E0102",
        "description_zh_cn": "杭州主体"
      }
    ],
    "columnName": ["name", "description_zh_cn"]
  }
}

获取数据表元素信息

用于获取数据表的元数据信息，包括表结构、字段列表、索引信息等。

请求

项目	值
HTTP Method	`POST`
Path	`https://xxxx.com/deepfos-server/data-table-deepmodel-server1-0/datatable/table-info-field`

Request Body 字段

请求体为数组，每个元素包含：

字段名	类型	必填	说明
elementName	String	是	数据表名称
elementType	String	否	元素类型
path	String	否	数据表所在路径，与 `folderId` 二选一
folderId	String	否	数据表所在目录 ID，与 `path` 二选一
moduleId	String	否	模块 ID

Request Body 示例

Copy

[
  {
    "elementName": "B0305",
    "elementType": "DAT_DEEPMODEL",
    "path": "/Application/00_JJHotel/05_DATA_DeepModel/DM01/"
  }
]

响应

返回数据表的完整元数据信息，包括表基本信息、字段列表、索引信息等。

表数据写入

批量写入数据表

用于将结构化表数据批量写入数据表，适合接口日志记录、差异数据留痕、映射表补录和中间表落地。

契约核对版本：数据表服务 1.1.9.0.19（源码 tag：V1.1.9.0.19_j21_3.7.48）。使用其他版本时，请核对对应服务的接口定义。

请求

项目	值
HTTP Method	`POST`
Path	`https://xxxx.com/deepfos-server/data-table-deepmodel-server1-0/datatable/insert`

Request Body 字段

字段名	类型	必填	说明
elementName	String	是	数据表名称
path	String	否	数据表所在路径，与 `folderId` 二选一
folderId	String	否	数据表所在目录 ID，与 `path` 二选一
columnList	Array<String>	是	待写入的列名列表，顺序与每行值一一对应
columnValueList	Array<Array<Object>>	是	非空的二维值数组，每个内层数组代表一条待写入记录

每行值的数量须与 columnList 中的列名数量一致，并按相同顺序排列。例如，columnList 为 ["name", "description_zh_cn"] 时，一行值为 ["E0101", "上海主体"]，不能写成 {"name": "E0101", "description_zh_cn": "上海主体"}。

本接口不提供 updatecol、conflictTarget 冲突更新参数。Python SDK 的 insert_df() 参数不能直接作为本接口的 JSON 字段，SDK 用法见数据表与数据库客户端。

Request Body 示例

调用前请将示例中的表名、路径和列名替换为目标环境中已存在的数据表及其字段，并确保值符合字段类型。

Copy

{
  "elementName": "MDM_Update_Entity_T",
  "path": "/Application/98_Interfaces_manage/02_Interface_Tables/MDM_Interface_Data_Table/",
  "columnList": ["name", "description_zh_cn", "parent_name", "ud3", "update_time"],
  "columnValueList": [
    ["E0101", "上海主体", "JJGroup", "", "2026-03-29 10:00:00"],
    ["E0102", "杭州主体", "JJGroup", "", "2026-03-29 10:00:00"]
  ]
}

响应

响应体字段

字段名	类型	说明
code	Integer	响应码
message	String	响应消息，成功时可为 `null`
status	Boolean	操作状态
data	Boolean	成功时为 `true`，不是写入行数

响应示例

Copy

{
  "code": 0,
  "message": null,
  "status": true,
  "data": true
}

表数据更新

更新数据表记录

用于根据条件更新数据表中的记录，适合维护映射表、同步主数据和刷新配置表。

请求

项目	值
HTTP Method	`POST`
Path	`https://xxxx.com/deepfos-server/data-table-deepmodel-server1-0/datatable/update-data`

Request Body 字段

字段名	类型	必填	说明
elementName	String	是	数据表名称
path	String	否	数据表所在路径，与 `folderId` 二选一
folderId	String	否	数据表所在目录 ID，与 `path` 二选一
setList	Array<Object>	是	更新字段列表
whereList	Array<Object>	是	筛选条件列表

Request Body 示例

Copy

{
  "elementName": "B0305",
  "path": "/Application/00_JJHotel/05_DATA_DeepModel/DM01/",
  "setList": [
    {
      "columnName": "description_zh_cn",
      "columnValue": "上海主体（更新）"
    }
  ],
  "whereList": [
    {
      "columnName": "name",
      "columnValue": "E0101"
    }
  ]
}

响应

响应示例

Copy

{
  "code": 0,
  "message": "success",
  "status": true,
  "data": true
}

表数据删除

删除数据表记录

用于根据条件删除数据表中的记录。

请求

项目	值
HTTP Method	`POST`
Path	`https://xxxx.com/deepfos-server/data-table-deepmodel-server1-0/datatable/delete-data`

Request Body 字段

字段名	类型	必填	说明
elementName	String	是	数据表名称
path	String	否	数据表所在路径，与 `folderId` 二选一
folderId	String	否	数据表所在目录 ID，与 `path` 二选一
columnList	Array<Object>	是	删除条件列表

Request Body 示例

Copy

{
  "elementName": "B0305",
  "path": "/Application/00_JJHotel/05_DATA_DeepModel/DM01/",
  "columnList": [
    {
      "columnName": "name",
      "columnValue": "E0101"
    }
  ]
}

响应

响应示例

Copy

{
  "code": 0,
  "message": "success",
  "status": true,
  "data": true
}

自定义 SQL 执行

执行自定义 SQL（后端调用）

用于执行自定义 SQL 语句，支持增删改查和多表联合查询。

请求

项目	值
HTTP Method	`POST`
Path	`https://xxxx.com/deepfos-server/data-table-deepmodel-server1-0/datatable/custom-sql`

Request Body 字段

字段名	类型	必填	说明
sql	String	是	自定义 SQL 语句

Request Body 示例

Copy

{
  "sql": "SELECT name, description_zh_cn FROM B0305_20250101 WHERE is_base = 'True'"
}

响应

响应体字段

字段名	类型	说明
code	Integer	响应码
message	String	响应消息
status	Boolean	操作状态
data	Object	执行结果
data.dataList	Array<Object>	数据列表
data.columnList	Array<String>	列名列表

响应示例

Copy

{
  "code": 0,
  "message": "success",
  "status": true,
  "data": {
    "dataList": [
      {
        "name": "E0101",
        "description_zh_cn": "上海主体"
      }
    ],
    "columnList": ["name", "description_zh_cn"]
  }
}