Skip to content

数据集血缘

数据集血缘说明

数据集血缘定义

数据集血缘是数据集与数据集,以及数据集与其他对象(包括图表,仪表盘过滤器,数据集成项目,数据模型)的依赖关系的描述。产品描述参考

数据集血缘结构说明

字段类型描述
lineageGraphOBJECT血缘图,包括本数据集的祖先数据集和子孙数据集,结构见
chartsOBJECT 数组影响的图表和仪表盘过滤器,结构见
datasetsOBJECT 数组影响的数据集,结构见
pipelinesOBJECT 数组影响的数据集成,结构见
extendDatasetsOBJECT 数组影响的数据模型,结构见

血缘图结构说明

字段类型描述
verticesOBJECT 数组图的顶点数组,数组成员参考
edgesOBJECT 数组图的边列表
edges[].leftINTEGER边左侧图内顶点的id
edges[].rightINTEGER边右侧图内顶点的id

血缘图顶点结构说明

字段类型描述
vertexIdINTEGER图内顶点的id
appIdINTEGER顶点表示的数据集的应用id
datasetIdINTEGER顶点表示的数据集的id
titleSTRING顶点表示的数据集的标题
refreshAtSTRING顶点表示的数据集的最新一次刷新时间
typeSTRING顶点表示的数据集的类型,数据集类型有: connection,fusion,union,aggregate 4 种
statusINTEGER顶点表示的数据集的状态,同dataset.status

影响对象结构说明

字段类型描述
titleSTRING对象的标题
typeSTRING对象的类型,参考
createdByNameSTRING对象的创建者
pathSTRING对象在系统中的路径
pipelineIdINTEGER数据集成的id,仅影响对象类型为数据集成的时候有
appIdINTEGER应用id,仅影响对象类型为数据集成的时候没有
datasetIdINTEGER数据集id,影响对象类型为数据集和数据模型有
dashboardIdINTEGER仪表盘id,影响类型为图表和仪表盘过滤器有
chartIdINTEGER图表id,影响类型为图表有
uidSTRING过滤器uid,影响类型为仪表盘过滤器有

影响对象类型说明

状态值意义
CHART图表
DASHBOARD_FILTER仪表盘过滤器
DATASET数据集
PIPELINE数据集成
EXTEND_DATASET数据模型

接口说明

获取数据集血缘关系

请求URL

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

请求参数

URL 参数
字段类型是否必须说明
appIdINTEGER数据集所在的应用 ID
datasetIdINTEGER数据集 ID
Request Body 参数

返回对象的格式说明

字段类型说明
versionSTRING当前系统版本哈希值
dataOBJECT数据集血缘结构说明

接口示例: 获取数据集血缘关系

http
GET /api/apps/2/datasets/2/lineage HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...
http
HTTP/1.1 200 Ok
Content-Type: application/json

{
  "version": "version@9a5e106#6730f0d",
  "code":0,
  "msg":"success",
  "data":{
    "lineageGraph":{
      "vertices":[
        {
          "vertexId":0,
          "appId":2,
          "datasetId":2,
          "title":"china_map_province",
          "refreshAt":"2020-11-09 10:24:48",
          "type":"connection"
        },
        {
          "vertexId":1,
          "appId":2,
          "datasetId":5,
          "title":"Datasets Fusion",
          "refreshAt":"2020-11-09 10:29:19",
          "type":"fusion"
        }
      ],
      "edges":[
        {
          "left":0,
          "right":1
        }
      ]
    },
    "charts":[
      {
        "title":"wss bar chart",
        "type":"CHART",
        "createdByName":"hengshiwss",
        "path":"应用创作/个人空间/新建应用/新建仪表盘",
        "appId":2,
        "dashboardId":1,
        "chartId":1
      },
      {
        "title":"prov过滤器",
        "type":"DASHBOARD_FILTER",
        "createdByName":"hengshiwss",
        "path":"应用创作/个人空间/新建应用/新建仪表盘",
        "appId":2,
        "dashboardId":1,
        "uid":"ca859002-0487-e94a-2f19-4afd82d36b41",
      }
    ],
    "datasets":[
      {
        "title":"Datasets Fusion",
        "type":"DATASET",
        "createdByName":"hengshiwss",
        "path":"应用创作/个人空间/新建应用",
        "appId":2,
        "datasetId":5
      }
    ],
    "pipelines":[],
    "extendDatasets":[
      {
        "title":"date.txt",
        "type":"EXTEND_DATASET",
        "createdByName":"hengshiwss",
        "path":"应用创作/个人空间/新建应用",
        "appId":2,
        "datasetId":1
      }
    ]
  }
}

HENGSHI SENSE API 使用手册