/sqlflow/leftMostSourceTableGraph

This API returns the left most result for the data element. Corresponds to this feature in SQLFlow UI.

Get the left-most lineage in Json

/sqlflow/generation/sqlflow/leftMostSourceTableGraph

generate left-most source table graph

post

generate left-most source table graph

Query parameters

columnLevelstringOptional

columnLevel

dbvendorstringRequired

dbvendor

hideColumnbooleanOptional

hideColumn

Default: false

ignoreFunctionbooleanOptional

ignoreFunction

Default: false

ignoreRecordSetbooleanOptional

ignoreRecordSet

Default: false

isReturnModelbooleanOptional

isReturnModel

Default: true

jobIdstringOptional

jobId

normalizeIdentifierbooleanOptional

normalizeIdentifier

Default: true

sessionIdstringRequired

sessionId

showConstantTablebooleanOptional

showConstantTable

Default: false

showLinkOnlybooleanOptional

showLinkOnly

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

showTransform

Default: false

simpleOutputbooleanOptional

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

Default: false

tableColumnstringOptional

target table column

tableNamePatternstringOptional

tableNatarget table name, supports regex expressionmePattern

Default: .*

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

userId

Responses

200

OK

application/json;charset=utf-8

Responsestring

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST /api/gspLive_backend/sqlflow/generation/sqlflow/leftMostSourceTableGraph HTTP/1.1
Host: api.gudusoft.com
Accept: */*

text

Sample:

curl --location 'https://<SQLFLOW URL>/gspLive_backend/sqlflow/generation/sqlflow/leftMostSourceTableGraph' \
--header 'accept: application/json' \
--form 'userId="gudu|0123456789"' \
--form 'sessionId="85b5119f83fcfefa93136e79dc05f2f61efe3b75e6a2b733568e0879c24f0c08_1680615728918"' \
--form 'dbvendor="dbvmssql"' \
--form 'jobId="6def00e8796e4c20ba216826c0ab5b73"' \
--form 'tableNamePattern="msdb.@event_data.nodes"'

Retrieve the left-most lineage image

/sqlflow/generation/sqlflow/leftMostSourceTableGraph/image

generate left-most source table graph image

post

generate left-most source table graph image

Authorizations

Query parameters

columnLevelstringOptional

columnLevel

dbvendorstringRequired

dbvendor

hideColumnbooleanOptional

hideColumn

Default: false

ignoreFunctionbooleanOptional

ignoreFunction

Default: false

ignoreRecordSetbooleanOptional

ignoreRecordSet

Default: false

isReturnModelbooleanOptional

isReturnModel

Default: true

jobIdstringOptional

jobId

normalizeIdentifierbooleanOptional

normalizeIdentifier

Default: true

sessionIdstringRequired

sessionId

sharebooleanOptional

whether generate the sharable URL for the result

Default: false

showConstantTablebooleanOptional

showConstantTable

Default: false

showLinkOnlybooleanOptional

showLinkOnly

Default: true

showRelationTypestringOptional

showRelationType

Default: fdd

showTransformbooleanOptional

showTransform

Default: false

simpleOutputbooleanOptional

simpleOutput

Default: false

tableColumnstringOptional

target table column

tableNamePatternstringOptional

target table name, supports regex expression

Default: .*

tokenstringRequired

token

treatArgumentsInCountFunctionAsDirectDataflowbooleanOptional

treatArgumentsInCountFunctionAsDirectDataflow

Default: false

userIdstringRequired

userId

Responses

200

OK

image/pngimage/jpegimage/gif

Responsestring · byte

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST /api/gspLive_backend/sqlflow/generation/sqlflow/leftMostSourceTableGraph/image HTTP/1.1
Host: api.gudusoft.com
Authorization: YOUR_API_KEY
Accept: */*

Ynl0ZXM=

Sample:

curl --location 'https://<SQLFLOW URL>/gspLive_backend/sqlflow/generation/sqlflow/leftMostSourceTableGraph/image' \
--header 'accept: image/*' \
--form 'userId="gudu|0123456789"' \
--form 'sessionId="85b5119f83fcfefa93136e79dc05f2f61efe3b75e6a2b733568e0879c24f0c08_1680615728918"' \
--form 'dbvendor="dbvmssql"' \
--form 'jobId="6def00e8796e4c20ba216826c0ab5b73"' \
--form 'tableNamePattern="msdb.@event_data.nodes"'