/sqlflow/upstreamGraph

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

Get upstream data lineage in Json

/sqlflow/generation/sqlflow/upstreamGraph

Get upstream data lineage image

/sqlflow/generation/sqlflow/upstreamGraph/image

Sample:

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

Previous/sqlflow/downstreamGraph Next/sqlflow/erdiagramSelectGraph

Last updated 1 year ago

generate upstream Graph

post

/sqlflow/generation/sqlflow/upstreamGraph

Query parameters

dbvendorstring

dbvendor

distanceinteger · int32

distance

hideColumnboolean

hideColumn

ignoreFunctionboolean

ignoreFunction

ignoreRecordSetboolean

ignoreRecordSet

isReturnModelboolean · default: true

isReturnModel

jobIdstring

jobId

normalizeIdentifierboolean · default: true

normalizeIdentifier

sessionIdstring

sessionId

showConstantTableboolean

showConstantTable

showLinkOnlyboolean · default: true

showLinkOnly

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

showTransform

simpleOutputboolean

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

tableColumnstring

target table column

tableNamePatternstring · default: .*

target table name, supports regex expression

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

userIdstring

userId

Responses

application/json;charset=utf-8

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.gudusoft.com/api/gspLive_backend/sqlflow/generation/sqlflow/upstreamGraph?token=text'

200

201

401

403

404

text

generate upstream Graph image