/sqlflow/graph/table_level_lineage

generate sqlflow table level lineage graph

post

generate sqlflow table level lineage graph

Query parameters

dbvendorstring · enumRequired

database vendor

Default: dbvoraclePossible values:

ignoreSelfLineagebooleanOptional

whether ignore self lineage

Default: true

jobIdstringOptional

give the job Id if need to use the job settings and display the job graph

normalizeIdentifierbooleanOptional

whether normalize the Identifier

Default: true

sqltextstringOptional

sql text from which to generate the sqlflow model

tokenstringRequired

The token is generated from userid and usersecret. It is used in every Api invocation.

userIdstringRequired

user id

Body

sqlfilestring · binaryOptional

sql file from which to generate the sqlflow model

Responses

200

application/json;charset=utf-8

ResponsestringExample:

{"code":200,"data":{"mode":"global","summary":{"schema":0,"process":0,"database":0,"view":0,"mostRelationTables":[],"column":4,"relationship":0,"table":3},"sqlflow":{"dbvendor":"dbvoracle","dbobjs":[{"id":"4","name":"EMP","type":"table","columns":[{"id":"5","name":"DEPTID","coordinates":[{"x":1,"y":35,"hashCode":"0"},{"x":1,"y":45,"hashCode":"0"}]},{"id":"17","name":"ENAME","coordinates":[{"x":1,"y":8,"hashCode":"0"},{"x":1,"y":13,"hashCode":"0"}]}],"coordinates":[{"x":1,"y":19,"hashCode":"0"},{"x":1,"y":22,"hashCode":"0"}]},{"id":"9","name":"DEPT","type":"table","columns":[{"id":"10","name":"ID","coordinates":[{"x":1,"y":48,"hashCode":"0"},{"x":1,"y":55,"hashCode":"0"}]}],"coordinates":[{"x":1,"y":24,"hashCode":"0"},{"x":1,"y":28,"hashCode":"0"}]},{"id":"15","name":"PSEUDO_TABLE_INCLUDE_ORPHAN_COLUMN","type":"pseudoTable","columns":[{"id":"16","name":"ENAME","coordinates":[{"x":1,"y":8,"hashCode":"0"},{"x":1,"y":13,"hashCode":"0"}]}],"coordinates":[{"x":1,"y":1,"hashCode":"0"},{"x":1,"y":35,"hashCode":"0"}]}],"relationships":[],"errors":[{"errorMessage":"find orphan column(10500) near: ename(1,8)","errorType":"SyntaxHint","coordinates":[{"x":1,"y":8,"hashCode":"0"},{"x":1,"y":13,"hashCode":"0"}]},{"errorMessage":"Link orphan column [ename] to the first table [emp]","errorType":"LinkOrphanColumn","coordinates":[{"x":1,"y":8,"hashCode":"0"},{"x":1,"y":13,"hashCode":"0"}]}]},"graph":{"relationshipIdMap":{},"elements":{"tables":[],"edges":[]},"tooltip":{},"listIdMap":{}}},"sessionId":"1491a5d5071c220ab993aa4d8a2e0e477d83abe4dd976a0c5c56c69e886a9481_1667481872808"}

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

POST /api/gspLive_backend/sqlflow/generation/sqlflow/graph/table_level_lineage HTTP/1.1
Host: api.gudusoft.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 20

{
  "sqlfile": "binary"
}

{
  "code": 200,
  "data": {
    "mode": "global",
    "summary": {
      "schema": 0,
      "process": 0,
      "database": 0,
      "view": 0,
      "mostRelationTables": [],
      "column": 4,
      "relationship": 0,
      "table": 3
    },
    "sqlflow": {
      "dbvendor": "dbvoracle",
      "dbobjs": [
        {
          "id": "4",
          "name": "EMP",
          "type": "table",
          "columns": [
            {
              "id": "5",
              "name": "DEPTID",
              "coordinates": [
                {
                  "x": 1,
                  "y": 35,
                  "hashCode": "0"
                },
                {
                  "x": 1,
                  "y": 45,
                  "hashCode": "0"
                }
              ]
            },
            {
              "id": "17",
              "name": "ENAME",
              "coordinates": [
                {
                  "x": 1,
                  "y": 8,
                  "hashCode": "0"
                },
                {
                  "x": 1,
                  "y": 13,
                  "hashCode": "0"
                }
              ]
            }
          ],
          "coordinates": [
            {
              "x": 1,
              "y": 19,
              "hashCode": "0"
            },
            {
              "x": 1,
              "y": 22,
              "hashCode": "0"
            }
          ]
        },
        {
          "id": "9",
          "name": "DEPT",
          "type": "table",
          "columns": [
            {
              "id": "10",
              "name": "ID",
              "coordinates": [
                {
                  "x": 1,
                  "y": 48,
                  "hashCode": "0"
                },
                {
                  "x": 1,
                  "y": 55,
                  "hashCode": "0"
                }
              ]
            }
          ],
          "coordinates": [
            {
              "x": 1,
              "y": 24,
              "hashCode": "0"
            },
            {
              "x": 1,
              "y": 28,
              "hashCode": "0"
            }
          ]
        },
        {
          "id": "15",
          "name": "PSEUDO_TABLE_INCLUDE_ORPHAN_COLUMN",
          "type": "pseudoTable",
          "columns": [
            {
              "id": "16",
              "name": "ENAME",
              "coordinates": [
                {
                  "x": 1,
                  "y": 8,
                  "hashCode": "0"
                },
                {
                  "x": 1,
                  "y": 13,
                  "hashCode": "0"
                }
              ]
            }
          ],
          "coordinates": [
            {
              "x": 1,
              "y": 1,
              "hashCode": "0"
            },
            {
              "x": 1,
              "y": 35,
              "hashCode": "0"
            }
          ]
        }
      ],
      "relationships": [],
      "errors": [
        {
          "errorMessage": "find orphan column(10500) near: ename(1,8)",
          "errorType": "SyntaxHint",
          "coordinates": [
            {
              "x": 1,
              "y": 8,
              "hashCode": "0"
            },
            {
              "x": 1,
              "y": 13,
              "hashCode": "0"
            }
          ]
        },
        {
          "errorMessage": "Link orphan column [ename] to the first table [emp]",
          "errorType": "LinkOrphanColumn",
          "coordinates": [
            {
              "x": 1,
              "y": 8,
              "hashCode": "0"
            },
            {
              "x": 1,
              "y": 13,
              "hashCode": "0"
            }
          ]
        }
      ]
    },
    "graph": {
      "relationshipIdMap": {},
      "elements": {
        "tables": [],
        "edges": []
      },
      "tooltip": {},
      "listIdMap": {}
    }
  },
  "sessionId": "1491a5d5071c220ab993aa4d8a2e0e477d83abe4dd976a0c5c56c69e886a9481_1667481872808"
}

{
  "code": 200,
  "data": {
    "mode": "global",
    "summary": {
      "schema": 0,
      "process": 0,
      "database": 0,
      "view": 0,
      "mostRelationTables": [],
      "column": 4,
      "relationship": 0,
      "table": 3
    },
    "sqlflow": {
      "dbvendor": "dbvoracle",
      "dbobjs": [
        {
          "id": "4",
          "name": "EMP",
          "type": "table",
          "columns": [
            {
              "id": "5",
              "name": "DEPTID",
              "coordinates": [
                {
                  "x": 1,
                  "y": 35,
                  "hashCode": "0"
                },
                {
                  "x": 1,
                  "y": 45,
                  "hashCode": "0"
                }
              ]
            },
            {
              "id": "17",
              "name": "ENAME",
              "coordinates": [
                {
                  "x": 1,
                  "y": 8,
                  "hashCode": "0"
                },
                {
                  "x": 1,
                  "y": 13,
                  "hashCode": "0"
                }
              ]
            }
          ],
          "coordinates": [
            {
              "x": 1,
              "y": 19,
              "hashCode": "0"
            },
            {
              "x": 1,
              "y": 22,
              "hashCode": "0"
            }
          ]
        },
        {
          "id": "9",
          "name": "DEPT",
          "type": "table",
          "columns": [
            {
              "id": "10",
              "name": "ID",
              "coordinates": [
                {
                  "x": 1,
                  "y": 48,
                  "hashCode": "0"
                },
                {
                  "x": 1,
                  "y": 55,
                  "hashCode": "0"
                }
              ]
            }
          ],
          "coordinates": [
            {
              "x": 1,
              "y": 24,
              "hashCode": "0"
            },
            {
              "x": 1,
              "y": 28,
              "hashCode": "0"
            }
          ]
        },
        {
          "id": "15",
          "name": "PSEUDO_TABLE_INCLUDE_ORPHAN_COLUMN",
          "type": "pseudoTable",
          "columns": [
            {
              "id": "16",
              "name": "ENAME",
              "coordinates": [
                {
                  "x": 1,
                  "y": 8,
                  "hashCode": "0"
                },
                {
                  "x": 1,
                  "y": 13,
                  "hashCode": "0"
                }
              ]
            }
          ],
          "coordinates": [
            {
              "x": 1,
              "y": 1,
              "hashCode": "0"
            },
            {
              "x": 1,
              "y": 35,
              "hashCode": "0"
            }
          ]
        }
      ],
      "relationships": [],
      "errors": [
        {
          "errorMessage": "find orphan column(10500) near: ename(1,8)",
          "errorType": "SyntaxHint",
          "coordinates": [
            {
              "x": 1,
              "y": 8,
              "hashCode": "0"
            },
            {
              "x": 1,
              "y": 13,
              "hashCode": "0"
            }
          ]
        },
        {
          "errorMessage": "Link orphan column [ename] to the first table [emp]",
          "errorType": "LinkOrphanColumn",
          "coordinates": [
            {
              "x": 1,
              "y": 8,
              "hashCode": "0"
            },
            {
              "x": 1,
              "y": 13,
              "hashCode": "0"
            }
          ]
        }
      ]
    },
    "graph": {
      "relationshipIdMap": {},
      "elements": {
        "tables": [],
        "edges": []
      },
      "tooltip": {},
      "listIdMap": {}
    }
  },
  "sessionId": "1491a5d5071c220ab993aa4d8a2e0e477d83abe4dd976a0c5c56c69e886a9481_1667481872808"
}

Previous/sqlflow/graph Next/sqlflow/graph/image

Last updated 2 years ago