接口说明

对于某个自定义SQL表，进行初始化建立抽取表，并执行抽取

基本信息

名称 参数
API /api/dash/tableCron/add
请求方法 SOCKET

请求参数

字段名称 参数类型 参数说明
token String 鉴权token
projectId Number 项目ID
dataConnectionId Number 数据连接ID
database Optional\ 数据库名
tableName Optional\ 表名
tableExprId Optional\ 自定义SQL表ID
status String 抽取方式; 全量: whole; 增量: increment
setting Setting 抽取方式配置, 具体参数见Setting对象
partitionConfig Optional\ 抽取分区配置, 具体参数见PartitionConfig对象
engineType Optional\ 抽取引擎类型, 普通抽取: 0; 高性能抽取: 1
engineConfig Optional\ 抽取引擎配置, 包含分片字段
relyStatus Optional\ 是否开启外部依赖检查, 0: 否; 1: 是
relyMode Optional\ 依赖模式, or, and
rerunStatus Optional\ 是否开启自动失败重跑
rerunSetting Optional\ 重跑配置, 具体参数见RerunSetting对象

对象 PartitionConfig 结构如下:

{
        storage,                                 // String, 行存储(row), 列存储(col)
        partitionField,                    // Optional<String>, 分区字段
        partitionSetting {            // 分区配置
      startTime                            // Optional<String> 开始时间
          endTime                                // Optional<String> 结束时间
          minPeriod                            // Optional<Number> 最小范围
          maxPeriod                            // Optional<String> 最大范围
          interval                            // Number 间隔
          unit                                    // 单元, day, week, month, year
          defaultPartition            // Bool
          dataType                            // String, 'Whole', 'Decimal', 'DateTime', 'String', 'Date', 'Time', 'Boolean'
    }
}

对象RerunSetting结构如下:

{
    retryTime,                                // Number, 重跑次数
  gap                                                // Number, 时间间隔
}

对象 Setting 结构如下:

// 当status为whole时
{
    appendData,                    // Optional<Bool> 是否追加, 默认值为false
}
// 当status为increment时
{
  extractField {            // 依据该字段进行增量抽取
      field,                        // String, 字段名
      dataType,                    // String, 字段类型
      scroll,                        // Optional<Bool>, 是否滚动覆盖, 默认值为false
      mode                          // 分区周期
    }
}

示例: 给某个自定义SQL新建抽取表, 并执行抽取

{
  "status": "whole",
  "setting": { "appendData": false },
  "projectId": 1,
  "dataConnectionId": 70001,
  "relyStatus": 0,
  "relyMode": "and",
  "rerunStatus": 0,
  "executeExtract": 1,
  "tableExtractCrons": [],
  "tableExprId": 1,
  "engineType": 0,
}

成功返回

{
    "code": 200,
    "result": {
        "dataConnectionId": 70001,
        "tableExprId": 1,
        "setting": {                                        // 抽取方式设置
            "appendData": false
        },
        "tableExtractId": 2501,                    // 抽取表的唯一标示
        "status": "whole"                                // 抽取方式
    },
}