/sqlflow/graph/image

Return the data lineage image file for the given SQL file.

generate sqlflow graph image

post

generate sqlflow graph image

Query parameters

columnLevelstringOptional

columnLevel

dbvendorstring · enumRequired

database vendor

Default: dbvoraclePossible values:

hideColumnbooleanOptional

whether hide column

Default: falseExample: false

ignoreFunctionbooleanOptional

ignore function

Default: falseExample: false

simpleOutputbooleanOptional

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

Default: falseExample: false

ignoreRecordSetbooleanOptional

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

Default: falseExample: false

jobIdstringOptional

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

normalizeIdentifierbooleanOptional

whether normalize the Identifier

Default: true

showConstantTablebooleanOptional

whether show constant table

Default: false

showLinkOnlybooleanOptional

whether show link only

Default: true

showRelationTypestringOptional

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

Default: fdd

showTransformbooleanOptional

whether show transform

Default: false

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.

treatArgumentsInCountFunctionAsDirectDataflowbooleanOptional

Whether treat the arguments in COUNT function as direct Dataflow

Default: false

userIdstringRequired

the user id of sqlflow web or client

Body

sqlfilestring · binaryOptional

sqlfile

Responses

200

OK

image/*

Responsestring · binary

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

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

{
  "sqlfile": "binary"
}

binary

Sample response:

Check our blog https://www.dpriver.com/blog/2023/03/23/visualize-your-data-with-sqlflow-rest-api/ for more details about this endpoint.