/sqlflow/downstreamGraph

Retrieve the upstream data lineage for data elements in regular Job. This API corresponds to the downstream/upstream feature in SQLFlow UI.

Get downstream data lineage in Json

/sqlflow/generation/sqlflow/downstreamGraph

generate downstream Graph

post

generate downstream Graph

Query parameters

dbvendorstringOptional

dbvendor

distanceinteger · int32Optional

distance

hideColumnbooleanOptional

hideColumn

Default: false

ignoreFunctionbooleanOptional

ignoreFunction

Default: false

ignoreRecordSetbooleanOptional

ignoreRecordSet

Default: false

isReturnModelbooleanOptional

isReturnModel

Default: true

jobIdstringOptional

jobId

normalizeIdentifierbooleanOptional

normalizeIdentifier

Default: true

sessionIdstringOptional

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

target table name, supports regex expression

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

userIdstringOptional

userId

Responses

Responsestring

post

HTTPcURLJavaScriptPython

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

text

Get downstream data lineage image

/sqlflow/generation/sqlflow/downstreamGraph/image

generate downstream Graph image

post

generate downstream Graph image

Authorizations

Query parameters

dbvendorstringOptional

dbvendor

distanceinteger · int32Optional

distance

hideColumnbooleanOptional

hideColumn

Default: false

ignoreFunctionbooleanOptional

ignoreFunction

Default: false

ignoreRecordSetbooleanOptional

ignoreRecordSet

Default: false

isReturnModelbooleanOptional

isReturnModel

Default: true

jobIdstringOptional

jobId

normalizeIdentifierbooleanOptional

whether normalize Identifier

Default: true

sessionIdstringOptional

sessionId

showConstantTablebooleanOptional

showConstantTable

Default: false

showLinkOnlybooleanOptional

showLinkOnly

Default: true

showRelationTypestringOptional

showRelationType

Default: fdd

showTransformbooleanOptional

showTransform

Default: false

simpleOutputbooleanOptional

simpleOutput

Default: false

stopatstringOptional

stopat

tableColumnstringOptional

target table column

tableNamePatternstringOptional

target table name, supports regex expression

Default: .*

tokenstringRequired

token

treatArgumentsInCountFunctionAsDirectDataflowbooleanOptional

treatArgumentsInCountFunctionAsDirectDataflow

Default: false

userIdstringOptional

userId

Responses

image/pngimage/jpegimage/gif

Responsestring · byte

Sample:

curl --location 'https://<SQLFlow URL>/gspLive_backend/sqlflow/generation/sqlflow/downstreamGraph/image' \
--header 'accept: image/*' \
--form 'userId="gudu|0123456789"' \
--form 'sessionId="85b5119f83fcfefa93136e79dc05f2f61efe3b75e6a2b733568e0879c24f0c08_1680615728918"' \
--form 'dbvendor="dbvmssql"' \
--form 'jobId="6def00e8796e4c20ba216826c0ab5b73"' \
--form 'tableNamePattern="dwdb.dbo.tbl_headblockersummary"'