Gudu SQLFlow Product Docs
  • 1. Introduction
    • What is Gudu SQLFlow?
      • What SQLFlow can do
      • Architecture Overview
    • Getting Started
      • Sign up a new account
        • Team Management
        • Delete My Account
        • Activate by entering a coupon
      • How to use SQLFlow
      • Different modes in Gudu SQLFlow
        • Query mode
        • Job mode
      • Basic Usage
      • Convert SQL to E-R Diagram
      • Colors in SQLFlow Diagram
      • Show call relationship
    • Installation
      • Version and Users
        • Cloud and On-Premise version
        • SQLFlow before Version 6
          • For older version SQLFlow under Linux
          • For older version SQLFlow under MacOS
          • For older version SQLFlow under Windows
      • Linux
      • MacOS
      • Windows
      • Docker
      • Clickhouse Installation
        • Clickhouse For CentOs
        • Clickhouse For Ubuntu/Debian/RHEL
      • Troubleshooting
      • Upgrade
      • Third Party Components
      • Renew License File
    • UI
      • SQLText Editor
      • Schema Explorer
      • Diagram Panel
      • Settings
      • Job Management
        • Job Sources
    • Dlineage Tool
      • Overview
      • Usage
        • Analyze data linege from SQL files
        • Analyze data linege from a database
        • Resolve the ambiguous columns in SQL query
        • Map the DataFlowAnalyzer and the settings on SQLFlow UI
        • Settings
      • Dataflow.xml structure
      • FAQ
  • 2. CONCEPTS
    • Data Lineage Basics
      • Dataflow
        • Relations generated by SQLFlow
      • Direct Dataflow
      • Indirect Dataflow
      • Aggregate function and Dataflow
      • Dataflow chain
    • Data Lineage Format Reference
  • 3. API Docs
    • Prerequisites
    • Using the Rest API
    • SQLFlow Rest API reference
      • User Interface
      • Generation Interface
        • /sqlflow
        • /sqlflow/selectedgraph/table_level_lineage
        • /sqlflow/selectedgraph/image
        • /sqlflow/graph
        • /sqlflow/graph/table_level_lineage
        • /sqlflow/graph/image
        • /sqlflow/downstreamGraph
        • /sqlflow/upstreamGraph
        • /sqlflow/erdiagramSelectGraph
        • /sqlflow/leftMostSourceTableGraph
      • Job Interface
        • /submitUserJob
        • /displayUserJobSummary
        • /displayUserJobsSummary
        • /exportLineageAsJson
        • /exportFullLineageAsJson
        • /exportLineageAsGraphml
        • /submitPersistJob
        • /displayUserLatestJobTableLevelLineage
      • Export Image
      • Export CSV
        • /sqlflow/exportFullLineageAsCsv
        • /job/exportFullLineageAsCsv
    • Swagger UI
    • Export the data lineage result
    • Python
      • Basic Usage
      • Advanced Usage
    • SQL Parser API
      • checkSyntax
  • 4. SQLFlow Widget
    • Widget Get started
    • Usages
    • Widget API Reference
  • 5. Databases
    • Database Objects
      • Azure
      • DB2
  • 6. SQLFlow-ingester
    • Introduction
      • SQLFlow-Exporter
      • SQLFlow-Extractor
      • SQLFlow-Submitter
    • Get Started
      • SQL Server
    • SQLFlow-Ingester Java API Usage
    • Understand the format of exported data
      • Oracle
      • Microsoft SQL Server
      • MySQL
      • PostgreSQL
    • List of Supported dbVendors
    • Git Repo
    • Third Party Components
  • 7. Reference
    • Lineage Model
      • Json Format Lineage Model
      • XML Format Lineage Model
      • Data Lineage Elements
    • Database Model
  • 8. other
    • FAQ
      • Handling Internal Database
      • Delete Your Account
      • Table Form Data Without Intermediates
      • Not all schema exported from Oracle
      • Lineage Customization
    • Roadmap
    • SQL Samples
      • Exchange table partition
      • Generate relationship for renamed table
      • Snowflake table function lineage detection
    • Change Logs
    • SQLFlow with Oracle XML functions
    • Major Organizations Utilizing SQLFlow
Powered by GitBook
On this page
  1. 3. API Docs
  2. SQLFlow Rest API reference
  3. Generation Interface

/sqlflow/downstreamGraph

Previous/sqlflow/graph/imageNext/sqlflow/upstreamGraph

Last updated 1 year ago

Retrieve the upstream data lineage for data elements in . This API corresponds to in SQLFlow UI.

Get downstream data lineage in Json

/sqlflow/generation/sqlflow/downstreamGraph

Get downstream data lineage image

/sqlflow/generation/sqlflow/downstreamGraph/image

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"'
the downstream/upstream feature

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
200
OK
Responsestring · byte
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
POST /api/gspLive_backend/sqlflow/generation/sqlflow/downstreamGraph/image HTTP/1.1
Host: api.gudusoft.com
Authorization: YOUR_API_KEY
Accept: */*

Ynl0ZXM=
  • Get downstream data lineage in Json
  • POSTgenerate downstream Graph
  • Get downstream data lineage image
  • POSTgenerate downstream Graph image

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
200
OK
application/json;charset=utf-8
Responsestring
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
POST /api/gspLive_backend/sqlflow/generation/sqlflow/downstreamGraph HTTP/1.1
Host: api.gudusoft.com
Accept: */*

text
regular Job