Generation Interface

https://github.com/sqlparser/sqlflow_public/tree/master/api

• Generate sqlflow model

  • /sqlflow/generation/sqlflow

• Export lineage as CSV

  • /sqlflow/generation/sqlflow/exportLineageAsCsv

Generate the data lineage

Send the SQL query and get the data lineage result.

/gspLive_backend/sqlflow/generation/sqlflow

generate sqlflow

generate sqlflow model

POSThttps://api.gudusoft.com/api/gspLive_backend/sqlflow/generation/sqlflow

Query parameters

Body

multipart/form-data

sqlfilestring (binary)

sql file from which to generate the sqlflow model

Response

200201401403404

OK

Body

application/json;charset=utf-8

string

Request

JavaScriptCurl

const response = await fetch('https://api.gudusoft.com/api/gspLive_backend/sqlflow/generation/sqlflow', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "code": 200,
  "data": {
    "dbvendor": "dbvoracle",
    "dbobjs": [
      {
        "id": "8",
        "name": "QUERY INSERT-1",
        "type": "process",
        "coordinates": [
          {
            "x": 1,
            "y": 1,
            "hashCode": "0"
          },
          {
            "x": 1,
            "y": 73,
            "hashCode": "0"
          }
        ],
        "queryHashId": "04ebc5aec1a07e1db80b0bc798742875"
      },
      {
        "id": "4",
        "name": "RAW_CUSTOMERS",
        "type": "table",
        "columns": [
          {
            "id": "5",
            "name": "ID",
            "coordinates": [
              {
                "x": 1,
                "y": 28,
                "hashCode": "0"
              },
              {
                "x": 1,
                "y": 30,
                "hashCode": "0"
              }
            ]
          },
          {
            "id": "6",
            "name": "FIRST_NAME",
            "coordinates": [
              {
                "x": 1,
                "y": 32,
                "hashCode": "0"
              },
              {
                "x": 1,
                "y": 42,
                "hashCode": "0"
              }
            ]
          },
          {
            "id": "7",
            "name": "LAST_NAME",
            "coordinates": [
              {
                "x": 1,
                "y": 44,
                "hashCode": "0"
              },
              {
                "x": 1,
                "y": 53,
                "hashCode": "0"
              }
            ]
          }
        ],
        "coordinates": [
          {
            "x": 1,
            "y": 13,
            "hashCode": "0"
          },
          {
            "x": 1,
            "y": 26,
            "hashCode": "0"
          }
        ]
      }
    ],
    "relationships": []
  },
  "sessionId": "527f2887da8bd7f5952840aa14cb05f357943aff3f5f02a6f1d7f914bca12971_1664807322126"
}

• SQLFlow Cloud Server

curl -X POST "https://api.gudusoft.com/gspLive_backend/sqlflow/generation/sqlflow?showRelationType=fdd" -H  "Request-Origion:testClientDemo" -H  "accept:application/json;charset=utf-8" -H  "Content-Type:multipart/form-data" -F "sqlfile=" -F "dbvendor=dbvoracle" -F "ignoreRecordSet=false" -F "simpleOutput=false" -F "sqltext=CREATE VIEW vsal  as select * from emp" -F "userId=YOUR USER ID HERE"  -F "token=YOUR TOKEN HERE"

• SQLFlow on-premise version

curl -X POST "http://127.0.0.1:8081/gspLive_backend/sqlflow/generation/sqlflow?showRelationType=fdd"    -H  "Request-Origion:testClientDemo" -H  "accept:application/json;charset=utf-8" -H  "Content-Type:multipart/form-data" -F "sqlfile=" -F "dbvendor=dbvoracle" -F "ignoreRecordSet=false" -F "simpleOutput=false" -F "sqltext=CREATE VIEW vsal  as select * from emp" -F "userId=gudu|0123456789" 

Export the data lineage in csv format

Send the SQL file and get the csv result which includes the data lineage.

/gspLive_backend/sqlflow/generation/sqlflow/exportFullLineageAsCsv

export sqlflow full lineage as csv format

export sqlflow full lineage as csv format

POSThttps://api.gudusoft.com/api/gspLive_backend/sqlflow/generation/sqlflow/exportFullLineageAsCsv

Authorization

Authorization

Query parameters

Body

multipart/form-data

sqlfilestring (binary)

sqlfile

Response

200201401403404

OK

Body

application/json;charset=utf-8

string

Request

JavaScriptCurl

const response = await fetch('https://api.gudusoft.com/api/gspLive_backend/sqlflow/generation/sqlflow/exportFullLineageAsCsv', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

"text"

curl -X POST "https://api.gudusoft.com/gspLive_backend/sqlflow/generation/sqlflow/exportFullLineageAsCsv" -H  "accept:application/json;charset=utf-8" -H  "Content-Type:multipart/form-data" -F "userId=YOUR USER ID HERE" -F "token=YOUR TOKEN HERE" -F "dbvendor=dbvoracle" -F "showRelationType=fdd" -F "sqlfile=@YOUR UPLOAD FILE PATH HERE" --output YOUR DOWNLOAD FILE PATH HERE

Sample:

curl -X POST "https://api.gudusoft.com/gspLive_backend/sqlflow/generation/sqlflow/exportFullLineageAsCsv" -H  "accept:application/json;charset=utf-8" -H  "Content-Type:multipart/form-data" -F "userId=auth0|5fc8e95991a780006f180d4d" -F "token=YOUR TOKEN HERE" -F "dbvendor=dbvoracle" -F "showRelationType=fdd" -F "sqlfile=@c:\prg\tmp\demo.sql" --output c:\prg\tmp\demo.csv

Note:

• -H "Content-Type:multipart/form-data" is required.

• Add @ before the upload file path

• --output is required.

• Optional, if you just want to fetch table to table relations, please add -F "tableToTable=true"

Generate the data lineage image

Send the SQL file and get the image result of the data lineage.

/sqlflow/generation/sqlflow/graph/image

generate sqlflow graph image

generate sqlflow graph image

POSThttps://api.gudusoft.com/api/gspLive_backend/sqlflow/generation/sqlflow/graph/image

Query parameters

Body

multipart/form-data

sqlfilestring (binary)

sqlfile

Response

200201401403404

OK

Body

image/*

string (binary)

Request

JavaScriptCurl

const response = await fetch('https://api.gudusoft.com/api/gspLive_backend/sqlflow/generation/sqlflow/graph/image', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

"binary"

curl --location --request POST 'https://api.gudusoft.com/gspLive_backend/sqlflow/generation/sqlflow/graph/image' \
    --header 'accept: image/*' \
    --form 'sqlfile=@"/home/test.sql"' \
    --form 'dbvendor="dbvoracle"' \
    --form 'userId="gudu|0123456789"'

Sample result: