接口介绍

当某个表元信息发生变更或者数据产出后,有数无法主动获取底表最新状态,导致BI界面查看数据具有滞后性,每次需要手动刷新或者设置定时任务才能获取最新数据。

现通过调用/api/dash/tableRely/pushTable接口,可主动告知有数底表数据产出或者元信息变更,触发依赖该表的邮件推送、依赖该表的抽取的自动抽取、依赖该表的自助取数的定时导出、依赖该表的报告自动刷新缓存、模型元信息刷新等,使得BI界面查看数据具有实时性,无需手动触发。

接口信息

API /api/dash/tableRely/pushTable
Method POST

接口参数

字段名称 参数类型 参数说明
token String 鉴权 token,该用户必须是项目管理员
dataConnectionId Int 数据连接 ID
database String 根据数据连接类型不同决定是否可选,表示单表属于哪个 database
tableName String 对应的表名
relyEvents Array 要触发的事件,数组,支持多个事件,'dataModelMetaUpdate' 更新模型元信息,'tableExtract' 触发抽取, 'tableExtractReInit' 触发抽取重新建表并抽取, 'resourceCache' 触发缓存, 'easyFetchExport' 触发取数依赖导出, 'mailSend' 触发邮件依赖推送

参数介绍

token生成可参考token相关

dataConnectionId:选择对应的数据源,url上会带上当前数据源的id信息,cid为数据源id。

relyEvents: 具体需要触发的事件。

  • dataModelMetaUpdate:触发更新模型元信息(表结构发生变更,比如底表新增了字段或删除了字段),可调用该事件触发更新表元信息。与手动刷新模型功能一致。

  • tableExtract:触发依赖抽取。当底表数据产出后,可调用该事件触发自动抽取,抽取最新数据。

  • tableExtractReInit:触发依赖抽取并重新建表。若表结构发生变化(比如字段类型发生变更或者新增了字段),导致抽取失败,可触发该事件重新建表抽取。

  • resourceCache:触发更新缓存(仅限报告和数据表格模块)。可触发该事件提前获取最新缓存,方便业务人员查看实时数据。

  • easyFetchExport:触发自助取数的定时依赖导出。

  • mailSend:触发报告的定时依赖推送。

具体实操

输入用例

{
  "token": "ssjdjsjsjkdjklsdjkl",
  "dataConnectionId": 700310511,
  "database": "dev_netease",
  "tableName": "bigviz_user",
  "relyEvents": ["dataModelMetaUpdate", "tableExtract"]
}

返回结果示例:

{
    "code": 200,
    "result": {

    }
}