衡石产品手册--数据集如何配置对接和开发

最新推荐文章于 2024-10-01 17:17:19 发布
最新推荐文章于 2024-10-01 17:17:19 发布
阅读量1k 收藏 14
点赞数 21
分类专栏： 衡石BI技术文档 文章标签： 前端 BI 数据集 api 衡石科技
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/zandy1011/article/details/141722956
版权

此开发文档相关引用在此处：数据集

数据集​

数据集说明​

数据集定义​

数据集是结构化的数据的集合，对外展示的形式是一张数据表。根据数据集数据的来源，数据集可以分成数据连接，SQL查询，多表联合，数据聚合，数据合并等种类。其中，数据连接 类型的数据集的数据来自某个数据源中的某张数据表；SQL查询类型的数据集的数据来自某个数据源中的SQL语句查询生成的结果；多表联合类型的数据集的数据来自已经存在的两个或两个以上的数据集通过字段连接（join）生成的结果；数据聚合 类型的数据集的数据来自已经存在的一个数据集通过字段分组聚合生成的结果；数据合并类型的数据集的数据来自已经存在的两个或两个以上的数据集通过字段对齐后的行合并（union）生成的结果；

数据集结构说明​
字段类型描述
appIdLONG数据集所属的应用的 id
idLONG数据集的 id
titleSTRING数据集的标题
createdAtDATETIME数据集创建的时间
createdByINTEGER数据集创建用户的 id
updatedAtDATETIME数据集最后更新的时间
updatedByINTEGER数据集最后修改用户的 id
statusINTEGER数据集的状态，见状态说明
importTypeINTEGER数据集是否导入引擎，0 为不导入，1 为导入
importMsgSTRING数据集无法导入引擎时的具体原因
importStatusINTEGER数据集导入引擎状态，见导入引擎状态
importOptionsOBJECT数据集导入设置，见数据集更新方法结构说明
optionsOBJECT数据集配置信息
options.typeSTRING数据集类型，数据集类型有： connection，fusion，union，aggregate，reference,pivot,unpivot
options.heOBJECT根据数据集类型定义的HE表达式，目前暂时只有pivot和unpivot是这样做的，其他类型的保留旧格式
options.storageTypeSTRING数据集执行计算的数据源的类型
options.storageConnectionIdINTEGER数据集执行计算的数据源的"数据连接id"
options.appendDatasetsINTEGER 数组追加到该数据集的数据集列表
options.schemaOBJECT 数组数据集中各字段元信息
options.schema[].fieldNameSTRING字段名
options.schema[].typeSTRING字段类型，字段类型包含： number，date，string，bool，json，unknown 6种
options.schema[].nativeTypeSTRING字段数据源内部类型，和具体数据源相关，比如BIGINT，VARCHAR等
options.schema[].originTypeSTRING字段原始类型，字段类型包含： number，date，string，bool，json，unknown 6种
options.schema[].suggestedTypesSTRING 数组字段允许选择的类型，类型包含： number，date，string，bool，json，unknown 6种
options.schema[].visibleBOOL字段是否隐藏，包括 true 和 false
options.schema[].labelSTRING字段的别名
options.schema[].dbFieldNameSTRING字段对应的数据库中的字段名，只有在 fieldName 和数据库里的字段名不一致的情况下需要设值，目前只用于替换数据集的时候
hsVersionINTEGER可选，本次编辑的版本号，从0开始，修改前先GET待修改资源获取当前版本号，修改时带上刚刚获取的版本号，服务端会检查并发冲突。不带版本号不检查并发冲突。
entityGroupSTRING数据集的执行计划类别，用于管理执行计划，固定为DATASET
entityKeySTRING数据集的执行计划关键字，用于管理执行计划，数据集的格式为{appId}-{datasetId}
execDetailOBJECT创建执行计划需要用到的任务描述信息，详见执行计划
updateMethodSwitchableBOOL本数据集是否支持设置增量更新
extraOptionsOBJECT数据集的扩展配置信息
数据集状态说明​
状态值意义
0NONE， 默认值
1PENDING，创建后等待异步计算
2RUNNING，创建后异步计算中
3SUCCESS，成功
4FAIL， 创建后计算失败
5PENDING_REFRESH， 刷新后等待异步计算
6REFRESHING， 刷新后异步计算中
7REFRESH_FAIL， 刷新后计算失败
8PENDING_EDIT， 编辑后等待异步计算
9EDITING， 编辑后异步计算中
10EDIT_FAIL，编辑后计算失败
11EMPTY， 从应用模板导入的数据集，数据集数据为空
12IMPORT_JSON，含有json拆分列的导入引擎数据集，正在做列拆分列持久化
数据集导入引擎状态说明​
状态值意义
0NONE，默认值
1SUCCESS，导入引擎成功
2FAILED，导入引擎失败
3WAITING，等待导入引擎
4RUNNING，正在导入引擎
数据集数据datasetResultDto说明​
字段类型描述
schemaOBJECT数组每一个元素表示一个数据集字段的属性，与数据集的 options.schema 相同
dataOBJECT数组每一个元素是一行数据,一行中每个值与schema元素一一对应
gcExcelJsonSTRING葡萄城模板用数据渲染后的excel转成json字符串
gcExcelCellErrorsOBJECT预览复杂表格具体cell报错信息，key是单元格下标，比如A2，全局错误key为default，value是具体错误消息
  • 例子:

json

{
  "schema": [
    {
      fieldName: "id",
      hsVersion: 2,
      type: "number",
      config: {
        dialectName: "PostgresqlDialect"
      }
      …
    },
    {
      fieldName: "zh_name",
      hsVersion: 2,
      type: "string",
      config: {},
      label: "zh_name"
      …
    },
    {
      fieldName: "prime_genre",
      hsVersion: 2,
      type: "string",
      config: {},
      label: "prime_genre"
      …
    }
  ],
  "data": [
    [
      1,
      "星际穿越",
      "剧情"
    ],
    [
      2,
      "辛德勒的名单",
      "剧情"
    ],
    [
      3,
      "唐伯虎点秋香",
      "喜剧"
    ]
  ]
}

数据集结构补充说明​

除了数据集结构说明中的字段，还有一些字段是api经过处理返回的数据，表达一些业务含义。这些字段不会存在于 request payload 中。

字段类型描述
functionsOBJECT数据集所支持的函数列表
importSwitchableBOOLEAN数据集是否支持导入引擎
hideBOOLEAN数据集是否隐藏
数据集更新方法结构说明​
字段类型描述
updateMethodSTRING更新方法，ALL表示全量，INCREMENTAL表示增量
incrementalFieldSTRING 数组增量更新的字段名称列表
batchFetchSizeinteger某些不支持游标读取的数据源比如hologres，每次查询数据的量，按这个量分批读取
keyFieldsSTRING 数组导入引擎的表的键字段，用作表的分布键
createTablePropertiesSTRING导入引擎的表的建表属性

接口说明​

创建数据集​

支持创建五种类型的数据集：数据连接，SQL查询，多表联合，数据聚合，数据合并, 引用。每种数据集的共同结构见数据集结构说明。除此之外，每种数据集特有的结构，详见下文的样例。

请求URL​

http

POST /api/apps/${appId}/datasets HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
URL 参数​
字段类型是否必须说明
appIdINTEGER是指定在appId对应的应用中创建数据集
Request Body 参数​

每种数据集的共同结构见数据集结构说明。除此之外，每种数据集特有的结构，详见下文的样例。

返回对象的格式说明​
字段类型说明
versionSTRING当前系统版本哈希值
dataOBJECT每种数据集的共同结构见数据集结构说明。除此之外，每种数据集特有的结构，详见下文的样例。
接口示例1: 创建“数据连接”数据集​

数据连接数据集特有结构

字段类型描述
options.typeSTRING数据集类型，数据连接数据集的 type 为 connection
options.originSTRING数据集创建的数据来源，有：postgresql，mysql，sqlserver，oracle，hive等
options.connectionIdINTEGER表的来源数据库"数据连接id"
options.pathSTRING 数组数据库的名字空间路径，跟数据源相关，比如 mysql 是数据库，postgresql 是 schema ，sqlserver 是数据库和 schema
options.tableSTRING用于生成数据集，原始数据库中的表名字
options.whereHE 数组衡石表达式数组，用于过滤 table 中的数据
options.refreshHoursINTEGER 数组每天哪些小时需要刷新数据集，合法值为 0-23 为空表示不刷新
options.refreshMinuteSTRING刷新在哪分钟执行，合法值为0-59

RequestResponse

http

POST /api/apps/1/datasets HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

// Request Body:
{
  "importType": 0,
  "options": {
    "connectionId": 4,
    "origin": "postgresql",
    "path": [
      "public"
    ],
    "schema": [
      {
        "basicType": "integer",
        "config": {
          "dialectName": "PostgresqlDialect"
        },
        "defaultAggrType": "sum",
        "detectedType": "integer",
        "distinct": false,
        "fieldName": "f1",
        "label": "f1",
        "nativeType": "int4",
        "originType": "integer",
        "suggestedTypes": [
          "number",
          "string"
        ],
        "type": "number",
        "visible": true
      }
    ],
    "table": "t11",
    "type": "connection"
  },
  "title": "t11"
}

接口示例2：创建“SQL查询”数据集​

和数据连接数据集基本一样，除了table字段去掉，使用customSql字段。 SQL查询数据集特有结构

字段类型描述
options.typeSTRING数据集类型，SQL查询数据集的 type 为 connection
options.customSqlSTRING用于生成数据集，原始数据库中的一个查询语句

RequestResponse

http

POST /api/apps/1/datasets HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

// Request Body:
{
  "importType": 0,
  "options": {
    "connectionId": 4,
    "customSql": "select * from t11",
    "origin": "postgresql",
    "path": [
      "public"
    ],
    "schema": [
      {
        "basicType": "integer",
        "config": {
          "dialectName": "PostgresqlDialect"
        },
        "defaultAggrType": "sum",
        "detectedType": "integer",
        "distinct": false,
        "fieldName": "f1",
        "label": "f1",
        "nativeType": "int4",
        "originType": "integer",
        "suggestedTypes": [
          "number",
          "string"
        ],
        "type": "number",
        "visible": true
      }
    ],
    "type": "connection"
  },
  "title": "sql"
}

接口示例3：创建“多表联合”数据集​

多表联合数据集特有结构

字段类型描述
options.typeSTRING数据集类型，多表联合数据集的 type 为 fusion
options.rootDatasetIdINTEGER关联的基础数据集 id
options.rootDatasetNameSTRING关联的基础数据集在关系中的名字，如果为空，显示数据集原来的名字
options.uidSTRING关联的基础数据集在关联关系中的uid
options.joinOptsOBJECT 数组关联的条件 ，每增加一个数据，增加一个条件
options.joinOpts[].joinTypeSTRING关联的方式，关联方式有以下 4 种：left join，right join，full join，inner join
options.joinOpts[].joinDatasetIdINTEGER关联的数据集 id
options.joinOpts[].joinDatasetNameSTRING关联的数据集在关系中的名字，如果为空，显示数据集原来的名字
options.joinOpts[].datasetIndexINTEGER关联的数据集重复拉入关系的次数，为0或者空表示第一个
options.joinOpts[].uidSTRING数据集在关联关系中的uid
options.joinOpts[].joinOnOBJECT 数组的数组参与关联的字段，内层数组只有两个成员，第一个成员和第二个成员在关联的时候相等，外层数组之间是 AND 的逻辑关系
options.joinOpts[].joinOn[][0].fieldSTRING参与关联的字段
options.joinOpts[].joinOn[][0].typeSTRING关联的字段类型，包含： number，date，string，bool，json，unknown 6种
options.joinOpts[].joinOn[][0].datasetIdINTEGER关联字段所属的数据集 id
options.joinOpts[].joinOn[][0].uidSTRING关联字段所属的数据集的uid
options.whereHE 数组衡石表达式数组，用于过滤数据

RequestResponse

http

POST /api/apps/1/datasets HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

// Request Body:
{
  "options": {
    "cache": false,
    "joinOpts": [
      {
        "joinDatasetId": 18,
        "joinOn": [
          [
            {
              "datasetId": 17,
              "field": "f1",
              "type": "number"
            },
            {
              "datasetId": 18,
              "field": "f1",
              "type": "number"
            }
          ]
        ],
        "joinType": "left join"
      }
    ],
    "rootDatasetId": 17,
    "schema": [
      {
        "basicType": "number",
        "config": {
          "dialectName": "PostgresqlDialect"
        },
        "defaultAggrType": "sum",
        "detectedType": "integer",
        "distinct": false,
        "fieldName": "f1_17",
        "label": "f1",
        "nativeType": "int4",
        "oriLabel": "f1",
        "oriName": "f1",
        "originType": "integer",
        "suggestedTypes": [
          "number",
          "string"
        ],
        "type": "number",
        "visible": true
      },
      {
        "basicType": "number",
        "config": {
          "dialectName": "PostgresqlDialect"
        },
        "defaultAggrType": "sum",
        "detectedType": "integer",
        "distinct": false,
        "fieldName": "f1_18",
        "label": "sql f1",
        "nativeType": "int4",
        "oriLabel": "f1",
        "oriName": "f1",
        "originType": "integer",
        "suggestedTypes": [
          "number",
          "string"
        ],
        "type": "number",
        "visible": true
      }
    ],
    "type": "fusion"
  },
  "title": "Fusion"
}

接口示例4：创建“数据聚合”数据集​

数据聚合数据集特有结构

字段类型描述
options.typeSTRING数据集类型，数据聚合数据集的 type 为 aggregate
options.rootDatasetIdINTEGER数据聚合的基础数据集 id
options.aggregateOptionsOBJECT聚合方式描述，具体结构参考“图表”的options
options.whereHE 数组衡石表达式数组，用于过滤数据

RequestResponse

http

POST /api/apps/1/datasets HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

// Request Body:
{
  "options": {
    "aggregateOptions": {
      "axes": [
        {
          "args": [
            {
              "dataset": 21,
              "kind": "field",
              "op": "f1_17"
            }
          ],
          "axisName": "group",
          "datasetId": 21,
          "fieldName": "f1_17",
          "fieldType": "number",
          "keyChain": [
            "group",
            "none"
          ],
          "kind": "function",
          "labelOrigin": "f1",
          "noFormatter": true,
          "op": "group",
          "parentUid": null,
          "scaleRange": {
            "max": 0,
            "maxAuto": true,
            "min": 0,
            "minAuto": true
          },
          "uid": "u_5bc7bb2c59f6703e_0"
        },
        {
          "args": [
            {
              "dataset": 21,
              "kind": "field",
              "op": "f1_18"
            }
          ],
          "axisName": "size",
          "datasetId": 21,
          "fieldName": "f1_18",
          "fieldType": "number",
          "keyChain": [
            "sum",
            "none"
          ],
          "kind": "function",
          "labelOrigin": "sql f1",
          "noFormatter": true,
          "op": "sum",
          "parentUid": null,
          "scaleRange": {
            "max": 0,
            "maxAuto": true,
            "min": 0,
            "minAuto": true
          },
          "uid": "u_8e5a3c02fe95743f_1"
        }
      ],
      "having": [],
      "limit": -1,
      "sort": [],
      "timebar": {
        "current": "dateExp",
        "dateExp": "All Avaliable Date",
        "dateRange": [],
        "show": false
      },
      "where": []
    },
    "rootDatasetId": 21,
    "schema": [
      {
        "basicType": "integer",
        "config": {
          "dialectName": "PostgresqlDialect"
        },
        "defaultAggrType": "sum",
        "detectedType": "integer",
        "fieldName": "u_5bc7bb2c59f6703e_0",
        "label": "f1",
        "nativeType": "int4",
        "originType": "integer",
        "suggestedTypes": [
          "number",
          "string"
        ],
        "type": "number",
        "visible": true
      },
      {
        "basicType": "number",
        "config": {
          "dialectName": "PostgresqlDialect"
        },
        "defaultAggrType": "sum",
        "detectedType": "number",
        "fieldName": "u_8e5a3c02fe95743f_1",
        "label": "sql f1",
        "nativeType": "numeric",
        "originType": "number",
        "suggestedTypes": [
          "number",
          "string"
        ],
        "type": "number",
        "visible": true
      }
    ],
    "type": "aggregate"
  },
  "title": "aggregate"
}

接口示例5：创建“数据合并”数据集​

“数据合并”数据集仅当来源数据集的 storageType 为 engine （数据在引擎中）的时候才能创建。 数据合并数据集特有结构

字段类型描述
options.typeSTRING数据集类型，数据合并数据集的 type 为 union
options.unionOptionsOBJECT描述数据合并（union）的方式
options.unionOptions.unionSchemaOBJECT 数组合并后数据集的 schema 信息
options.unionOptions.unionSchema[].labelSTRING合并后数据集字段别名
options.unionOptions.unionSchema[].typeSTRING合并后数据集字段的类型，包含： number，date，string，bool，json，unknown 6种
options.unionOptions.fieldsMappingOBJECT 数组描述来源数据集字段对齐的方式
options.unionOptions.fieldsMapping[].datasetIdINTEGER来源数据集的 id
options.unionOptions.fieldsMapping[].fieldNamesSTRING 数组来源数据集的字段名称，约定按数组下标对齐
options.unionOptions.fieldsMapping[].whereHE 数组衡石表达式数组，用于过滤来源数据集中的数据

RequestResponse

http

POST /api/apps/1/datasets HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

// Request Body:
{
  "options": {
    "schema": [
      {
        "basicType": "number",
        "config": {
          "dialectName": "EngineDialect"
        },
        "defaultAggrType": "sum",
        "detectedType": "integer",
        "fieldName": "union_0",
        "label": "f1",
        "nativeType": "int4",
        "originType": "integer",
        "suggestedTypes": [
          "number",
          "string"
        ],
        "type": "number",
        "visible": true
      }
    ],
    "type": "union",
    "unionOptions": {
      "append": false,
      "fieldsMapping": [
        {
          "datasetId": 20,
          "fieldNames": [
            "f1"
          ],
          "where": []
        },
        {
          "datasetId": 23,
          "datasetTitle": "t11 (1)",
          "fieldNames": [
            "f1"
          ],
          "where": []
        }
      ],
      "unionSchema": [
        {
          "fieldName": "f1",
          "label": "f1",
          "type": "number"
        }
      ]
    }
  },
  "title": "t12 union"
}

接口示例6：创建“引用”数据集​

引用数据集自身没有独立的字段信息，来源数据集字段修改，引用数据集中会跟着修改。

引用数据集特有结构

字段类型描述
options.typeSTRING数据集类型，引用数据集的 type 为 reference
options.referenceOptionsOBJECT描述引用（reference）的源数据集
options.referenceOptions.sourceAppIdINTEGER引用的来源数据集所在应用的 id
options.referenceOptions.sourceDatasetIdINTEGER引用的来源数据集的 id

RequestResponse

http

POST /api/apps/1/datasets HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

// Request Body:
{
  "options": {
    "type": "reference",
    "referenceOptions": {
      "sourceAppId": 154,
      "sourceDatasetId": 1
    }
  },
  "title": "demo"
}

接口示例7：创建“行转列”数据集​

行转列数据集特有结构

字段类型描述
options.typeSTRING数据集类型，数据聚合数据集的 type 为 pivot
options.heOBJECT行转列的HE表达式

RequestResponse

http

POST /api/apps/123/datasets HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

// Request Body:
{
  "options": {
    "he": {
      "kind": "function",
      "op": "pivot",
      "args": [
        {
          "kind": "function",
          "op": "app_dataset",
          "args": [
            123,                     // 应用id
            1                        // 数据集id
          ]
        },
        [{"kind": "field", "op": "year"}],   // 分组列列表
        {                                                 // 聚合列
          "kind": "function",
          "op": "sum",
          "args": [
            {
              "kind": "field",
              "op": "val"
            }
          ]
        },
        {"kind": "field", "op": "month"},                 // 转置列
        [                                                 // 转置列列值对应的列名
          {"kind": "constant", "op": "一月", "uid": "Jan"},
          {"kind": "constant", "op": "二月", "uid": "Feb"}
        ]
      ]
    },
    "schema": [
      {
        "basicType": "integer",
        "config": {
          "dialectName": "PostgresqlDialect"
        },
        "defaultAggrType": "sum",
        "detectedType": "integer",
        "fieldName": "year",
        "label": "year",
        "nativeType": "int4",
        "originType": "integer",
        "suggestedTypes": [
          "number",
          "string"
        ],
        "type": "number",
        "visible": true
      },
      {
        "basicType": "number",
        "config": {
          "dialectName": "PostgresqlDialect"
        },
        "defaultAggrType": "sum",
        "detectedType": "number",
        "fieldName": "val",
        "label": "val",
        "nativeType": "numeric",
        "originType": "number",
        "suggestedTypes": [
          "number",
          "string"
        ],
        "type": "number",
        "visible": true
      },
      {
        "basicType": "string",
        "config": {
          "dialectName": "PostgresqlDialect"
        },
        "defaultAggrType": "count",
        "detectedType": "string",
        "fieldName": "Jan",
        "label": "Jan",
        "nativeType": "varchar",
        "originType": "string",
        "suggestedTypes": [
          "string"
        ],
        "type": "string",
        "visible": true
      },
      {
        "basicType": "string",
        "config": {
          "dialectName": "PostgresqlDialect"
        },
        "defaultAggrType": "count",
        "detectedType": "string",
        "fieldName": "Feb",
        "label": "Feb",
        "nativeType": "varchar",
        "originType": "string",
        "suggestedTypes": [
          "string"
        ],
        "type": "string",
        "visible": true
      },
    ],
    "type": "pivot"
  },
  "title": "pivot-title"
}

接口示例8：创建“列转行”数据集​

行转列数据集特有结构

字段类型描述
options.typeSTRING数据集类型，数据聚合数据集的 type 为 unpivot
options.heOBJECT行转列的HE表达式

RequestResponse

http

POST /api/apps/123/datasets HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

// Request Body:
{
  "options": {
    "he": {
      "kind":"function",
      "op":"unpivot",
      "args": [
        {
          "kind": "function",
          "op": "app_dataset",
          "args": [
            123,                     // 应用id
            1                        // 数据集id
          ]
        },
        {"kind": "field", "op": "month", "type": "string"},              // 存放列转行的key列，需要明确的 type
        {"kind": "field", "op": "val"},                                  // 存放列转行的 value 列
        [
          {"kind": "field", "op": "Jan", "value": "一月"},                    // 待转的列， value 表示转换后的key值
          {"kind": "field", "op": "Feb", "value": "二月"}
        ]
      ]
    }
    "schema": [
      {
        "basicType": "integer",
        "config": {
          "dialectName": "PostgresqlDialect"
        },
        "defaultAggrType": "sum",
        "detectedType": "integer",
        "fieldName": "year",
        "label": "year",
        "nativeType": "int4",
        "originType": "integer",
        "suggestedTypes": [
          "number",
          "string"
        ],
        "type": "number",
        "visible": true
      },
      {
        "basicType": "number",
        "config": {
          "dialectName": "PostgresqlDialect"
        },
        "defaultAggrType": "sum",
        "detectedType": "number",
        "fieldName": "val",
        "label": "val",
        "nativeType": "numeric",
        "originType": "number",
        "suggestedTypes": [
          "number",
          "string"
        ],
        "type": "number",
        "visible": true
      },
      {
        "basicType": "string",
        "config": {
          "dialectName": "PostgresqlDialect"
        },
        "defaultAggrType": "count",
        "detectedType": "string",
        "fieldName": "month",
        "label": "month",
        "nativeType": "varchar",
        "originType": "string",
        "suggestedTypes": [
          "string"
        ],
        "type": "string",
        "visible": true
      }
    ],
    "type": "unpivot"
  },
  "title": "unpivot-title"
}

通过 ID 查询数据集信息​

请求URL​

http

GET /api/apps/${appId}/datasets/${datasetId} HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
URL 参数​
字段类型是否必须说明
appIdINTEGER是应用的 id
datasetIdINTEGER是数据集的 id
返回对象的格式说明​
字段类型说明
versionSTRING当前系统版本哈希值
dataOBJECT数据集结构说明, 参照各种数据集的特殊结构说明
参考示例1​

普通查询

RequestResponse

http

GET /api/apps/1/datasets/1 HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

参考示例2​

查询的数据集不可导入引擎时

http

GET /api/apps/1/datasets/1 HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

  1. 返回 返回值中包含了数据集的基本信息、创建者信息、编辑者信息、支持的函数列表和无法导入的原因说明。

json

{
  "version": "version@9a5e106#6730f0d",
  "code": 0,
  "msg": "success",
  "data": {
    "id": 4,
    "title": "有参1",
    "createdBy": 2,
    "createdAt": "2021-08-02 18:21:47",
    "updatedBy": 2,
    "updatedAt": "2021-08-02 18:21:47",
    "visible": true,
    "isDelete": false,
    "appId": 24,
    "options": {
      "cache": false,
      "type": "connection",
      "totalSize": 284,
      "rowCount": 1,
      "rowCountValid": true,
      "connectionTitle": "PG",
      "refreshHours": [],
      "refreshMinute": 0,
      "connectionId": 4,
      "connectionCategory": "Database",
      "origin": "postgresql",
      "table": "A_IVT_MOVIE",
      "where": [
        {
          "op": "and",
          "args": [
            {
              "op": "=",
              "args": [
                {
                  "op": "id",
                  "kind": "field",
                  "type": "number"
                },
                {
                  "op": "n",
                  "kind": "param",
                  "type": "number"
                }
              ],
              "kind": "function"
            }
          ],
          "kind": "function"
        }
      ],
      "path": [
        "public"
      ],
      "transpose": false,
      "header": 0,
      "padHeader": false,
      "storageType": "postgresql",
      "dialectOptions": {
        "dialectName": "PostgresqlDialect",
        "majorVersion": 10,
        "minorVersion": 4
      },
      "storageConnectionId": 4,
      "storageConnectionTitle": "PG",
      "metrics": [],
      "schema": [
        {
          "datasetId": 4,
          "fieldName": "id",
          "type": "number",
          "label": "id",
          "config": {
            "dialectName": "PostgresqlDialect"
          },
          "visible": true,
          "nativeType": "bigserial",
          "suggestedTypes": [
            "number",
            "string"
          ],
          "detectedType": "integer",
          "comment": "",
          "originType": "integer",
          "defaultAggrType": "sum",
          "basicType": "number"
        },
        {
          "datasetId": 4,
          "fieldName": "zh_name",
          "type": "string",
          "label": "zh_name",
          "config": {},
          "visible": true,
          "nativeType": "bpchar",
          "suggestedTypes": [
            "string"
          ],
          "detectedType": "string",
          "comment": "",
          "originType": "string",
          "defaultAggrType": "count",
          "basicType": "string"
        }
      ]
    },
    "importType": 0,
    "importStatus": 0,
    "importOptions": {},
    "status": 3,
    "refreshStats": {
      "refreshAt": "2021-08-02 18:21:47",
      "executeRefreshAt": "2021-08-02 18:21:47",
      "executeRefreshRowCountAt": 1627899707234
    },
    "datasetAcl": {
      "level": "FULLACCESS",
      "dataFilters": []
    },
    "fieldGroups": [],
    "metricGroups": [],
    "includeInAppScope": false,
    "creator": {
      "id": 2,
      "name": "test",
      "email": "anonymous@hengshi.com"
    },
    "updater": {
      "id": 2,
      "name": "test",
      "email": "anonymous@hengshi.com"
    },
    "functions": [
      "abs",
      "acos"
    ],
    "importSwitchable": false,
    "updateMethodSwitchable": false,
    "importMsg": "数据集使用了用户属性/应用参数过滤时无法导入引擎",
    "entityKey": "24-4",
    "entityGroup": "DATASET",
    "execDetail": {
      "jobClass": "com.hengshi.nangaparbat.schedulejob.DatasetJob",
      "jobParams": {
        "app": 24,
        "dataset": 4
      },
      "retryTimes": 1
    },
    "type": "connection",
    "public": true,
    "emptyDataset": false,
    "origin": "postgresql",
    "refreshSchema": false
  }
}

分页查询数据集​

请求URL​

http

GET /api/apps/${appId}/datasets HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
URL 参数​
字段类型是否必须说明
appIdINTEGER是应用的 id
orderByString否排序字段名，比如 id，title，createdAt， updatedAt 等
orderTypeString否排序规则，asc 或者 desc
metaBOOLEAN否是否只需要dataset的基本信息，true 表示只需要meta信息，默认是false
joinExceptSTRING否排除不需要的信息，可选值为 schema，metrics，connection，user，也可以是它们的任意组合，用逗号分隔，比如 schema,measure。
functionsBOOLEAN否是否需要数据集所支持的函数信息
createdByCurrentBOOLEAN否是否只需要列出当前用户创建的数据集
excludeOptionsTypeSTRING否排除 options.type 是所选值的数据集，可选值为 connection，fusion，union，aggregate
importStatusINTEGER否导入引擎的状态过滤，可选值按照 导入引擎状态
showHideBOOLEAN否是否显示隐藏数据集
offsetINTERGER否偏移的值
limitINTERGER否查询的最大个数
supportUnionBOOLEAN否是否支持作为数据合并选择的第一个数据集，目前仅支持存储类型是MySQL，Postgresql，GreenplumDB，Oracle，DB2，Sqlserver，Vertica，ClickHouse，DaMeng，Tidb，SapHana，Hive，SparkSQL，Impala，Presto，Amazon Redshift，Amazon Athena，Maxcompute，hologres
storageConnectionIdINTERGER否存储类型连接id，当有此参数时，列表只返回存储类型是该连接的数据集
excludeEmptyBOOLEAN否是否排除状态为EMPTY的数据集(刚从应用模板导入的数据集)
joinExcept的选项说明​
值说明
schema不需要数据集的字段信息
metrics不需要数据集的指标信息
connection不需要数据集所用的数据连接名
user不需要数据集的创建者和更新者的用户相信信息
返回对象的格式说明​
字段类型说明
versionSTRING当前系统版本哈希值
dataOBJECT数据集结构说明, 参照各种数据集的特殊结构说明
参考示例1​

列出应用 1 下的数据集列表。用 updatedAt 字段降序排序，不是只要数据集基本信息，不需要字段、指标、连接信息，偏移15个，取接下来的20个值

RequestResponse

http

GET /api/apps/1/datasets?offset=15&limit=20&orderBy=updatedAt&orderType=desc&meta=false&joinExcept=schema%2Cmetrics%2Cconnection HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

分页查询数据集和分组信息​

请求URL​

http

GET /api/apps/${appId}/datasets/datasets-groups HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
URL 参数​
字段类型是否必须说明
appIdINTEGER是应用的 id
orderByString否排序字段名，比如 id，title，createdAt， updatedAt 等
orderTypeString否排序规则，asc 或者 desc
metaBOOLEAN否是否只需要dataset的基本信息，true 表示只需要meta信息，默认是false
joinExceptSTRING否排除不需要的信息，可选值为 schema，metrics，connection，user，也可以是它们的任意组合，用逗号分隔，比如 schema,measure。
functionsBOOLEAN否是否需要数据集所支持的函数信息
createdByCurrentBOOLEAN否是否只需要列出当前用户创建的数据集
excludeOptionsTypeSTRING否排除 options.type 是所选值的数据集，可选值为 connection，fusion，union，aggregate
importStatusINTEGER否导入引擎的状态过滤，可选值按照 导入引擎状态
showHideBOOLEAN否是否显示隐藏数据集
offsetINTERGER否偏移的值
limitINTERGER否查询的最大个数
joinExcept的选项说明​
值说明
schema不需要数据集的字段信息
metrics不需要数据集的指标信息
connection不需要数据集所用的数据连接名
user不需要数据集的创建者和更新者的用户相信信息
返回对象的格式说明​
字段类型说明
versionSTRING当前系统版本哈希值
dataOBJECT数据集的列表和分组信息
data.datasetsOBJECT 数组数据集列表，数组的成员见 数据集结构说明, 参照各种数据集的特殊结构说明
data.datasetGroupsOBJECT 数组数据集分组信息列表, 请求参数中的 functions 为 true 时，返回结果才有此信息
data.datasetGroups.functionsOBJECT 数组数据集支持的函数列表
data.datasetGroups.datasetIdsNUMBER 数组支持这些函数的数据集 id 数组
参考示例1​

列出应用 1 下的数据集列表和分组信息。

RequestResponse

http

GET /api/apps/1/datasets/datasets-groups?offset=15&limit=20&orderBy=updatedAt&orderType=desc&meta=false&joinExcept=metrics%2Cconnection HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

通过 PUT 方法修改一个数据集的标题​

请求URL​

http

PUT /api/apps/${appId}/datasets/${datasetId} HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
URL 参数​
字段类型是否必须说明
appIdINTEGER是应用的 id
datasetIdINTEGER是数据集的 id
request body 请求参数​

数据集结构说明, title 是必须的

返回对象的格式说明​
字段类型说明
versionSTRING当前系统版本哈希值
dataOBJECT数据集结构说明, 参照各种数据集的特殊结构说明
参考示例​

RequestResponse

http

PUT /api/apps/1/datasets/1 HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

// Request Body:
{
  "title": "china_map_province2",
  "hsVersion": 6
}

通过 ID 删除数据集​

请求URL​

http

DELETE /api/apps/${appId}/datasets/${datasetId} HTTP/1.1

请求参数​
URL 参数​
字段类型是否必须说明
appIdINTEGER是应用的 id
datasetIdINTEGER是数据集的 id
返回对象的格式说明​
字段类型说明
versionSTRING当前系统版本哈希值
msgSTRING成功返回 success

下载数据集数据​

请求URL​

http

GET /api/apps/${appId}/datasets/${datasetId}/download HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
URL 参数​
字段类型是否必须说明
appIdINTEGER是应用的 id
datasetIdINTEGER是数据集的 id
返回对象的格式说明​

Excel文件，后缀是 xlsx。

下载有过滤条件的数据集数据​

请求URL​

http

POST /api/apps/${appId}/datasets/${datasetId}/download HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
URL 参数​
字段类型是否必须说明
appIdINTEGER是应用的 id
datasetIdINTEGER是数据集的 id
Request Body 参数​

HE 表达式，详情参照HE 的数据集函数

返回对象的格式说明​

Excel文件，后缀是 xlsx。

参考示例​

http

POST /api/apps/1/datasets/1/download HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

// Request Body:
{
  "kind": "formula",
  "op": "summarize(dataset(1), {type}, {votes})"
}

获取数据集支持的函数列表​

请求URL​

http

GET /api/apps/${appId}/datasets/${datasetId}/functions HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
URL 参数​
字段类型是否必须说明
appIdINTEGER是应用的 id
datasetIdINTEGER是数据集的 id
返回对象的格式说明​

参照数据集结构补充说明

参考示例​

RequestResponse

http

GET /api/apps/1/datasets/1/functions HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

预览关联模型数据​

请求URL​

http

GET /api/apps/${appId}/datasets/${datasetId}/preview-relation HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
URL 参数​
字段类型是否必须说明
appIdINTEGER是应用的 id
datasetIdINTEGER是数据集的 id
返回对象的格式说明​

参照数据集数据 datasetResultDto 说明

参考示例​

RequestResponse

http

GET /api/apps/1/datasets/1/preview-relation HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

刷新数据集​

所有数据集都能刷新，依赖它的其他数据集会自动跟着刷新

请求URL​

http

POST /api/apps/${appId}/datasets/${datasetId}/refresh HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
URL 参数​
字段类型是否必须说明
appIdINTEGER是应用的 id
datasetIdINTEGER是数据集的 id
Request Body 参数​
返回对象的格式说明​
字段类型说明
versionSTRING当前系统版本哈希值
msgSTRING成功返回 success
参考示例​

RequestResponse

http

POST /api/apps/1/datasets/1/refresh HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

刷新数据集schema​

所有数据集都能刷新schema，依赖它的其他数据集会自动跟着刷新

请求URL​

http

POST /api/apps/${appId}/datasets/${datasetId}/refresh-schema HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
URL 参数​
字段类型是否必须说明
appIdINTEGER是应用的 id
datasetIdINTEGER是数据集的 id
Request Body 参数​
返回对象的格式说明​
字段类型说明
versionSTRING当前系统版本哈希值
msgSTRING成功返回 success
参考示例​

RequestResponse

http

POST /api/apps/1/datasets/1/refresh-schema HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

修改数据集刷新计划(已废弃)​

请求URL​

http

PUT /api/apps/${appId}/datasets/${datasetId}/refresh-schedule HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
URL 参数​
字段类型是否必须说明
appIdINTEGER是应用的 id
datasetIdINTEGER是数据集的 id
Request Body 参数​
字段类型说明
refreshMinuteINTEGER执行刷新的具体分钟
refreshHoursINTEGER 数组每天24小时中哪个小时执行刷新
返回对象的格式说明​
字段类型说明
versionSTRING当前系统版本哈希值
dataOBJECT当前数据集的更新计划配置
data.refreshMinuteINTEGER执行刷新的具体分钟
data.refreshHoursINTEGER每天24小时中哪个小时执行刷新
参考示例​

RequestResponse

http

PUT /api/apps/1/datasets/1/refresh-schedule HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

// Request Body:
{
  "refreshMinute": 3,
  "refreshHours": [
    0,
    1,
    2,
    3,
    9,
    8,
    7,
    15
  ]
}

获取数据集刷新计划 （已废弃）​

请求URL​

http

GET /api/apps/${appId}/datasets/${datasetId}/refresh-schedule HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
URL 参数​
字段类型是否必须说明
appIdINTEGER是应用的 id
datasetIdINTEGER是数据集的 id
Request Body 参数​
返回对象的格式说明​
字段类型说明
versionSTRING当前系统版本哈希值
dataOBJECT当前数据集的更新计划配置
data.refreshMinuteINTEGER执行刷新的具体分钟
data.refreshHoursINTEGER每天24小时中哪个小时执行刷新
参考示例​

RequestResponse

http

GET /api/apps/1/datasets/1/refresh-schedule HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

其他接口（TODO）

替换数据集​

替换数据集只用于替换基础数据集，包括文件数据集、数据连接数据集、SQL 查询数据集。

请求URL​

http

POST /api/apps/${appId}/datasets/${datasetId}/replace HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
URL 参数​
字段类型是否必须说明
appIdINTEGER是应用的 id
datasetIdINTEGER是数据集的 id
Request Body 参数​

数据集的共同结构见数据集结构说明。用文件数据集去替换，参照新建文件数据集的 request body 参数。用数据连接数据集去替换，参照新建数据连接数据集的 request body 参数。用 SQL 查询数据集去替换，参照 SQL 查询数据集的 request body 参数。

当原数据集中的字段被引用后，字段名就不能改变了。如果新的替换表中字段名和原字段名不一致，那需要把新的字段名存到 options.schema[].dbfieldName 里面。

获取数据集中哪些字段被引用了，参照获取数据集所有字段，注意把 url 参数中的 inUseOnly 设置为 true。

接口示例1：用SQL 查询数据集替换数据集​

RequestResponse

http

POST api/apps/1482/datasets/21901/replace HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

// Request Body:
{
  "options": {
    "type": "connection",
    "origin": "postgresql",
    "connectionId": 334,
    "schema": [
      {
        "datasetId": 21901,
        "fieldName": "region_id",
        "label": "region_id",
        "type": "number",
        "visible": true,
        "dbFieldName": "region_id"
      },
      {
        "originType": "string",
        "fieldName": "country_id",
        "nativeType": "bpchar",
        "visible": true,
        "type": "string",
        "label": "country_id"
      }
    ],
    "customSql": "select \"country_id\", \"region_id\" from public.\"a_ivt_countries\"",
    "path": [
      "public"
    ]
  }
}

获取数据集的更新方法​

请求URL​

http

GET /api/apps/${appId}/datasets/${datasetId}/update-method HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
URL 参数​
字段类型是否必须说明
appIdINTEGER是应用id
datasetIdINTEGER是数据集id
Request Body 参数​
返回对象的格式说明​
字段类型说明
versionSTRING当前系统版本哈希值
dataOBJECT见数据集更新方法结构说明
接口示例:​

RequestResponse

http

GET /api/apps/1/datasets/1/update-method HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

更新数据集的更新方法​

请求URL​

http

PUT /api/apps/${appId}/datasets/${datasetId}/update-method HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
URL 参数​
字段类型是否必须说明
appIdINTEGER是应用id
datasetIdINTEGER是数据集id
Request Body 参数​

见数据集更新方法结构说明

返回对象的格式说明​
字段类型说明
versionSTRING当前系统版本哈希值
dataOBJECT见数据集更新方法结构说明
接口示例:​

RequestResponse

http

PUT /api/apps/1/datasets/1/update-method HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

// Request Body:
{
  "updateMethod": "INCREMENTAL",
  "incrementalField": ["updatedAt"]
}

返回对象的格式说明​

Excel文件，后缀是 xlsx。

开启/关闭引擎​

手动开启/关闭指定的数据集引擎

请求URL​

http

POST /api/apps/{appId}/datasets/{datasetId}/import/switch HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
URL 参数​
字段类型是否必须说明
appIdINTEGER是应用的 id
datasetIdINTEGER是数据集的 id
forceBOOL否是否强制开启引擎
Request Body 参数​

true:开启引擎 false:关闭引擎

接口示例1：开启引擎​

RequestResponse

http

POST /api/apps/35/datasets/14/import/switch HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

// Request Body:
true


 

说明​
  1. 普通数据集(直连，SQL)如果在过滤条件或SQL语句或使用的数据连接中使用了用户属性/应用参数，则该数据集不能导入引擎。
  2. 复杂数据集(fusion，aggregate，union)数据集,如果与它存在血缘关系的数据集中使用了用户属性/应用参数做过滤，或这些血缘数据集使用的数据连接使用了用户属性配置，则该复杂数据集不能导入引擎

获取数据集详情 （TODO）​

预览连接中的一个 table 的 schema 信息 （TODO）​

通过 schema 信息创建一个数据集 （TODO）​

通过数据集 id 获取到已创建的数据集的信息 （TODO）​

获取数据集的SQL​

获取数据集的SQL

请求URL​

http

GET /api/apps/{appId}/datasets/{datasetId}/sql-debug HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
URL 参数​
字段类型说明
appIdINTEGER数据集所在应用 Id
datasetIdINTEGER数据集 Id
vendorDescSTRING指定的sql数据源描述，格式为<类型><大版本号><小版本号>_<商业版本号>，其中 类型 是必填的。比如：mysql_8_10_analyticdb
接口示例1:​

RequestResponse

http

GET /api/apps/15/datasets/1/sql-debug HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

接口示例2:​

RequestResponse

http

GET /api/apps/15/datasets/1/sql-debug?vendorDesc=postgres HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

获取数据集SQL执行计划​

获取数据集SQL执行计划

请求URL​

http

GET /api/apps/{appId}/datasets/{datasetId}/sql-explain HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
URL 参数​
字段类型说明
appIdINTEGER数据集所在应用 Id
datasetIdINTEGER数据集 Id
接口示例1:​

RequestResponse

http

GET /api/apps/15/datasets/1/sql-explain HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

获取数据集的状态​

请求URL​

http

GET /api/apps/{appId}/datasets/{datasetId}/status HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
URL 参数​
字段类型说明
appIdINTEGER数据集所在应用 Id
datasetIdINTEGER数据集 Id
Request Body 参数​
返回对象的格式说明​
字段类型说明
versionSTRING当前系统版本哈希值
dataOBJECT数据集状态信息
data.statusINTEGER数据集状态信息，见数据集状态说明
data.refreshAtSTRING刷新数据成功时间，ISO格式
data.executeRefreshAtSTRING开始执行刷新数据时间，ISO格式
data.refreshSchemaAtSTRING刷新schema成功时间，ISO格式
data.executeRefreshSchemaAtSTRING开始执行刷新schema时间，ISO格式
data.currentTimeSTRING当前服务器时间，ISO格式
接口示例1:​

RequestResponse

http

GET /api/apps/15/datasets/1/status HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

获取数据集数据​

请求URL​

http

GET /api/apps/{appId}/datasets/{datasetId}/data HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
URL 参数​
字段类型说明
appIdINTEGER数据集所在应用 Id
datasetIdINTEGER数据集 Id
orderBystring排序字段
orderTypestring排序类型，正序（asc）或倒序（desc）
Request Body 参数​
返回对象的格式说明​
字段类型说明
versionSTRING当前系统版本哈希值
dataOBJECT数据集的数据
data.dataOBJECT数据集数据，默认只取1000行，结构参考数据集数据datasetResultDto说明 中的data
data.schemaOBJECT数据集schema,结构参考数据集数据datasetResultDto说明 中的schema
data.pagableBOOL是否支持分页
data.importSwitchableBOOL是否支持开启引擎
接口示例1:​

RequestResponse

http

GET /api/apps/15/datasets/1/data HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

1
2
3

设置数据集为默认​

设置数据集为默认

请求URL​

http

POST /api/apps/{appId}/datasets/{datasetId}/default/switch HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
URL 参数​
字段类型说明
appIdINTEGER数据集所在应用 Id
datasetIdINTEGER数据集 Id
Request Body 参数​

true 或者 false

true： 表示设置默认 false： 表示取消默认

接口示例1:​

RequestResponse

http

POST /api/apps/499/datasets/1/default/switch HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

// Request Body:
true

根据当前设置获取导入引擎表的建表属性模板​

请求URL​

http

POST /api/apps/${appId}/datasets/${datasetId}/create-table-props-template HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
URL 参数​
字段类型是否必须说明
appIdINTEGER是应用id
datasetIdINTEGER是数据集id
Request Body 参数​

见数据集更新方法结构说明

返回对象的格式说明​
字段类型说明
versionSTRING当前系统版本哈希值
dataSTRING根据当前输出的数据源类型和字段生成的建表属性模板
接口示例:​

RequestResponse

http

POST /api/apps/1/datasets/1/create-table-props-template HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

// Request Body:
{
  "updateMethod": "ALL",
  "createTableProperties": "",
  ...
}

根据当前建表属性等设置测试建表​

请求URL​

http

POST /api/apps/${appId}/datasets/${datasetId}/test-create HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数​
URL 参数​
字段类型是否必须说明
appIdINTEGER是应用id
datasetIdINTEGER是数据集id
Request Body 参数​

见数据集更新方法结构说明

返回对象的格式说明​
字段类型说明
versionSTRING当前系统版本哈希值
msgSTRINGhttp code不是200的话，返回具体的错误信息
接口示例:​

RequestResponse

http

POST /api/apps/1/datasets/1/test-create HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

// Request Body:
{
  "updateMethod": "ALL",
  "createTableProperties": "distributed by (f3) partition by list(f2) (DEFAULT PARTITION pd,partition p1 values(1),partition p2 values (2),partition p3 values (3))",
  ...
}
zandy1011
关注
专栏目录
电子/硬件工程师手册
weixin_43839976的博客
01-17 8901
硬件工程师手册 目 录 第一章 概述 3 第一节 硬件开发过程简介 3 §1.1.1 硬件开发的基本过程 4 §1.1.2 硬件开发的规范化 4 第二节 硬件工程师职责与基本技能 4 §1.2.1 硬件工程师职责 4 §1.2.1 硬件工程师基本素质与技术 5 第二章 硬件开发规范化管理 5 第一节 硬件开发流程 5 §3.1.1 硬件开发流程文件介绍 5 §3.2.2 硬...
机器学习项目简历收集册-----机器学习（仅供参考）
大大枫free
08-16 2万+
图像识别 项目一：齿轮表面粗糙度自动检测 开发应用：python3+sklearn+opencv 项目描述：1）使用CCD相机获取齿轮表面图像 2）图片预处理，使用中值滤波，去除图片椒盐噪声，使用直方图均衡化进行图像增强 3) 使用小波变换提取零件的纹理特征 4）进行pca主成分分析进行降维获取特征 5）使用支持向量机分类器进行分类 项目二：验证码识别 开发应用：python+tensorflow 项目描述：1）通过公司提供的数据集对数据进行编码 2）搭建cnn神经网络 3）对模型进行训练，提高验证码的识别
这一年，这些书：2022年读书笔记
Heartsuit的博客
12-31 3万+
Note: 以下 `markdown` 格式文本由 `json2md` 自动转换生成，可参考[JSON转Markdown：我把阅读数据从MongoDB中导出转换为.md了](https://blog.csdn.net/u013810234/article/details/113360229)了解具体的转换过程。2022年读书笔记
ARM汇编学习笔记
liyun422828的专栏
10-01 1401
标签：IT/科技 http://blog.ednchina.com/kgq398/257658/Message.aspx     这两天参加了一个编写操作系统的项目，因为要做很多底层的东西，而且这个操作系统是嵌入式的，所以开始学习ARM汇编，发现ARM汇编和一般PC平台上的
ARM汇编指令汇总
Stay Hungry, Stay Stupid
05-08 3万+
1、ARM汇编的格式：     在ARM汇编里，有些字符是用来标记行号的，这些字符要求顶格写；有些伪码是需要成对出现的，例如ENTRY和END，就需要对齐出现，也就是说他们要么都顶格，要么都空相等的空，否则编译器将报错。常量定义需要顶格书写，不然，编译器同样会报错。     2、字符串变量的值是一系列的字符，并且使用双引号作为分界符，如果要在字符串中使用双引号，则必须连续使用两个双引号。
CSDN博客专家证书发放名单（已暂停）
热门推荐
CSDN 官方博客
07-12 5万+
博客专家专属奖励。
汇编指令大全
banbenggang9818的博客
01-11 1933
SUB影响全部的条件标志：1.减法的CF反应的是无符号数运算中的借位情况：当减数>被减数是CF=1,否则CF=02.OF：如果两个数的符号相反而结果的符号与减数相同，则OF=1，否则OF=0;3.SF（运算结果<0为1否则为0）、ZF（零标志）、AF（辅助进位标志）、PF（奇偶标志）根据其含义设置刚刚看到了cmp指令，一开始有点晕。后来上网找了些资料，终于看明白了，为了方便...
《虚拟仿真实验教学解决方案(BJBR)》（Yanlz+Unity+SteamVR+VR+AR+MR+HR+??BR??+??CR??+??DR??+??ER??+虚拟仿真+人机交互+立钻哥哥+==）
VRunSoftYanlz的博客
08-19 4万+
《虚拟仿真实验教学解决方案(BJBR)》 《虚拟仿真实验教学解决方案(BJBR)》 版本 作者 参与者 完成日期 备注 YanlzVR_BJBR_V01_1.0 严立钻 2019.07.19 ...
《BJBR虚拟仿真解决方案(描述精选)》（Yanlz+SteamVR+5G+AI+VR+AR+MR+HR+BR+CR+DR+ER+FR+GR+人工智能+人机交互+立钻哥哥+==）
VRunSoftYanlz的博客
08-20 3万+
《BJBR虚拟仿真解决方案(描述精选)》 《BJBR虚拟仿真解决方案(描述精选)》 版本 作者 参与者 完成日期 备注 YanlzVR_BJBR_VIP_V01_1.0 严立钻 2019.08...
Grafana基础使用手册-v1.pdf
11-21
Grafana是一个开源指标分析和可视化套件。...我们以前使用开源监控系统zabbix，但后来发现，如果要把监控数据和日志分析系统统一进行 展示和分析时，就需要开发一套系统来对接。现在有了grafana过后变的相当Easy!
【IoT】物联网NB-IoT之电信物联网开放平台对接流程浅析
产品线负责人
09-14 4万+
电信物联网开放平台对接流程如下图所示： 1、创建 APP 应用 登录中国电信物联网开放平台对接测试环境SP Portal（https://180.101.147.135:8843），初次登录需要修改初始密码。 选择【应用管理】-&gt;【应用】点击右上角“+创建应用”。 典型的 NB-IoT 应用的参数设置可参考如下设置： 所属行业： 公用事业(NB-IoT) 关联API包： ...
数据对接 - 大屏云极简使用手册
shulinwu的博客
03-18 1万+
💡 大屏云(www.dapingyun.com)是一款制作可视化数据大屏的在线搭建工具服务，组件丰富，开箱即用，无需编码及导入数据，极大程度满足用户会议展览、业务监控等需求。 👉 本文以快速精简的方式对大屏云的使用进行说明。 线上demo地址：https://demo.dapingyun.com 数据是大屏项目的业务核心。大屏组件通过对业务数据的渲染，达到对系统的监控功能需求。 👉 本文以快速精简的方式对大屏云数据对接的使用进行说明。 1、数据的接入类型 我们将数据分为如下三种类型，这三种数据的
使用创思通信4G Cat1 DTU基于TencentOS-tiny对接腾讯云物联网开发平台
Mculover666的博客（嵌入式）
08-31 6909
一、简介 本文档主要讲述如何使用创思通信4G Cat1 DTU开发板，基于TencentOS-tiny对接腾讯云物联网开发平台IoT Explorer，演示温度数据上报平台、平台下发控制指令控制继电器、以及如何使用“腾讯连连”小程序。 1. 4G Cat1 DTU开发板 创思通信4G Cat1 DTU开发板资源丰富，板载一颗STM32F103RET6作为主控芯片，板载EC200S 4G Cat1 通信模组，板载一颗DS18B20温度传感器，板载一个继电器模块，如图： 2. TencentOS-tiny物
前端的全栈混合之路Meteor篇：3.0新版本介绍
最新发布
分享有趣的、贴近生活的CS知识
10-01 1089
Meteor全栈框架3.0版本终于稳定下来了，它的效果约等于webpack+vue+express+socket.io+mongodb+npm+uniapp，学一个搞定全套，值得学习了解下，最后找到适合于自己的技术栈。
登录功能开发 P167重点
2303_81204446的博客
09-30 393
前端无法识别controller方法，因此存在Dispa什么的。Claims：jwt中的第二部分。
Vue实战教程：如何用JS封装一个可复用的Loading组件
Jiaberrr的博客
09-28 637
通过以上步骤，我们成功在Vue项目中封装了一个可复用的Loading组件。在实际开发中，我们可以根据项目需求对Loading组件进行样式和功能的扩展，使其更加完善。封装组件是提高代码复用性和维护性的有效手段，希望本文能对你有所帮助。
Web认识 -- 第一课
ZxVSaccount的博客
09-30 1200
这里是我们进入前端学习的开端,在本次更新之后我会陆续上传html,css,javaScript等相关语言的教程,有感兴趣的小伙伴们点点关注,未来我们一起学习!IE、火狐和谷歌是目前互联网上的三大浏览器，其他常用的浏览器还有苹果的Safari浏览器和欧朋浏览器等。对于一般的网站，只要兼容IE浏览器、火狐浏览器和谷歌浏览器，就能满足绝大多数用户的需求。本节主要简单介绍了一下关于HTML、CSS、JavaScript的一些基本概念,有感兴趣的朋友,点点关注我们一起学习,博主持续更新中!
Webpack 打包后文件过大，如何优化？
官方推荐
09-30 5898
Webpack 打包后文件过大，如何优化？
Aruba网状网路由器WEB配置手册-混合开发对接
"该文档是关于Aruba网状网路由器的WEB界面配置手册，主要针对IT和网络管理员，介绍如何通过WEB界面进行配置和维护。手册涵盖了内容范围、适用对象和相关文档，详细阐述了从登录WEB管理界面开始，到基本配置、有线...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值