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

post

/sqlflow/generation/sqlflow

Query parameters

dbvendorstring · enum · default: dbvoraclerequired

database vendor

Options: dbvazuresql, dbvbigquery, dbvcouchbase, dbvdb2, dbvgreenplum, dbvhana, dbvhive, dbvimpala, dbvinformix, dbvmdx, dbvmysql, dbvnetezza, dbvopenedge, dbvoracle, dbvpostgresql, dbvredshift, dbvsnowflake, dbvmssql, dbvsparksql, dbvsybase, dbvteradata, dbvvertica

simpleOutputboolean

simple output, ignore the intermediate results, defualt is false.

Example: false

ignoreRecordSetboolean

same as simpleOutput, but will keep output of the top level select list, default is false.

Example: false

jobIdstring

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

normalizeIdentifierboolean · default: true

whether normalize the Identifier

returnFullRelationshipboolean

whether return full data relationship. will return only summary info if set to false in case of exceeding the relation limit.

showConstantTableboolean

whether show constant table

showRelationTypestring · default: fdd

show relation type, required false, default value is 'fdd', multiple values seperated by comma like fdd,frd,fdr,join. Availables are 'fdd' value of target column from source column, 'frd' the recordset count of target column which is affected by value of source column, 'fdr' value of target column which is affected by the recordset count of source column, 'join' combines rows from two or more tables, based on a related column between them

showTransformboolean

whether show transform

sqltextstring

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.

treatArgumentsInCountFunctionAsDirectDataflowboolean

Whether treat the arguments in COUNT function as direct Dataflow

userIdstringrequired

the user id of sqlflow web or client

Body

sqlfilestring · binary

sql file from which to generate the sqlflow model

Responses

application/json;charset=utf-8

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.gudusoft.com/api/gspLive_backend/sqlflow/generation/sqlflow?dbvendor=dbvoracle&token=text&userId=text' \
  --header 'Content-Type: multipart/form-data'

200

201

401

403

404

200

{
  "code": 200,
  "sessionId": "527f2887da8bd7f5952840aa14cb05f357943aff3f5f02a6f1d7f914bca12971_1664807322126",
  "data": {
    "dbvendor": "dbvoracle",
    "relationships": [],
    "dbobjs": [
      {
        "id": "8",
        "name": "QUERY INSERT-1",
        "type": "process",
        "queryHashId": "04ebc5aec1a07e1db80b0bc798742875",
        "coordinates": [
          {
            "x": 1,
            "y": 1,
            "hashCode": "0"
          },
          {
            "x": 1,
            "y": 73,
            "hashCode": "0"
          }
        ]
      },
      {
        "id": "4",
        "name": "RAW_CUSTOMERS",
        "type": "table",
        "coordinates": [
          {
            "x": 1,
            "y": 13,
            "hashCode": "0"
          },
          {
            "x": 1,
            "y": 26,
            "hashCode": "0"
          }
        ],
        "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"
              }
            ]
          }
        ]
      }
    ]
  }
}

OK

• 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

post

/sqlflow/generation/sqlflow/exportFullLineageAsCsv

Authorizations

Query parameters

dbvendorstring · enum · default: dbvoraclerequired

db vendor

Options: dbvazuresql, dbvbigquery, dbvcouchbase, dbvdb2, dbvgreenplum, dbvhana, dbvhive, dbvimpala, dbvinformix, dbvmdx, dbvmysql, dbvnetezza, dbvopenedge, dbvoracle, dbvpostgresql, dbvredshift, dbvsnowflake, dbvmssql, dbvsparksql, dbvsybase, dbvteradata, dbvvertica

delimiterstring · default: ,

delimiter of the values in CSV, default would be ','

export_include_tablestring

export_include_table

sessionIdstring

sessionId

showConstantTableboolean

showConstantTable

sqltextstring

sql text

tokenstringrequired

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

treatArgumentsInCountFunctionAsDirectDataflowboolean

Whether treat the arguments in COUNT function as direct Dataflow

userIdstringrequired

user id

Body

sqlfilestring · binary

sqlfile

Responses

application/json;charset=utf-8

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.gudusoft.com/api/gspLive_backend/sqlflow/generation/sqlflow/exportFullLineageAsCsv?dbvendor=dbvoracle&token=text&userId=text' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: multipart/form-data'

200

201

401

403

404

200

text

OK

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

post

/sqlflow/generation/sqlflow/graph/image

Query parameters

columnLevelstring

columnLevel

dbvendorstring · enum · default: dbvoraclerequired

database vendor

Options: dbvazuresql, dbvbigquery, dbvcouchbase, dbvdb2, dbvgreenplum, dbvhana, dbvhive, dbvimpala, dbvinformix, dbvmdx, dbvmysql, dbvnetezza, dbvopenedge, dbvoracle, dbvpostgresql, dbvredshift, dbvsnowflake, dbvmssql, dbvsparksql, dbvsybase, dbvteradata, dbvvertica

hideColumnboolean

whether hide column

Example: false

ignoreFunctionboolean

ignore function

Example: false

simpleOutputboolean

simple output, ignore the intermediate results, defualt is false.

Example: false

ignoreRecordSetboolean

same as simpleOutput, but will keep output of the top level select list, default is false.

Example: false

jobIdstring

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

normalizeIdentifierboolean · default: true

whether normalize the Identifier

showConstantTableboolean

whether show constant table

showLinkOnlyboolean · default: true

whether show link only

showRelationTypestring · default: fdd

show relation type, required false, default value is 'fdd', multiple values seperated by comma like fdd,frd,fdr,join. Availables are 'fdd' value of target column from source column, 'frd' the recordset count of target column which is affected by value of source column, 'fdr' value of target column which is affected by the recordset count of source column, 'join' combines rows from two or more tables, based on a related column between them

showTransformboolean

whether show transform

sqltextstring

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.

treatArgumentsInCountFunctionAsDirectDataflowboolean

Whether treat the arguments in COUNT function as direct Dataflow

userIdstringrequired

the user id of sqlflow web or client

Body

sqlfilestring · binary

sqlfile

Responses

image/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.gudusoft.com/api/gspLive_backend/sqlflow/generation/sqlflow/graph/image?dbvendor=dbvoracle&token=text&userId=text' \
  --header 'Content-Type: multipart/form-data'

200

201

401

403

404

200

text

OK

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: