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. Export CSV

/sqlflow/exportFullLineageAsCsv

PreviousExport CSVNext/job/exportFullLineageAsCsv

Last updated 1 year ago

Export full lineage as CSV

Export the full lineage as CSV, this api is for query mode

Sample response:

A CSV file

source_db,source_schema,source_table,source_column,target_db,target_schema,target_table,target_column,relation_type,effect_type
DEFAULT,SCOTT,EMP,SAL,DEFAULT,DEFAULT,VSAL,Salary,fdd,create_view
DEFAULT,DEFAULT,ORDERS,ORDER_ID,DEFAULT,DEFAULT,SMALL_ORDERS,OID,fdd,insert
DEFAULT,DEFAULT,ORDERS,CUSTOMER_ID,DEFAULT,DEFAULT,SMALL_ORDERS,CID,fdd,insert
DEFAULT,DEFAULT,ORDERS,ORDER_TOTAL,DEFAULT,DEFAULT,SMALL_ORDERS,OTTL,fdd,insert
DEFAULT,DEFAULT,ORDERS,SALES_REP_ID,DEFAULT,DEFAULT,SMALL_ORDERS,SID,fdd,insert
DEFAULT,DEFAULT,CUSTOMERS,CREDIT_LIMIT,DEFAULT,DEFAULT,SMALL_ORDERS,CL,fdd,insert
DEFAULT,DEFAULT,CUSTOMERS,CUST_EMAIL,DEFAULT,DEFAULT,SMALL_ORDERS,CEM,fdd,insert
DEFAULT,DEFAULT,ORDERS,ORDER_ID,DEFAULT,DEFAULT,MEDIUM_ORDERS,OID,fdd,insert
DEFAULT,DEFAULT,ORDERS,CUSTOMER_ID,DEFAULT,DEFAULT,MEDIUM_ORDERS,CID,fdd,insert
DEFAULT,DEFAULT,ORDERS,ORDER_TOTAL,DEFAULT,DEFAULT,MEDIUM_ORDERS,OTTL,fdd,insert
DEFAULT,DEFAULT,ORDERS,SALES_REP_ID,DEFAULT,DEFAULT,MEDIUM_ORDERS,SID,fdd,insert
DEFAULT,DEFAULT,CUSTOMERS,CREDIT_LIMIT,DEFAULT,DEFAULT,MEDIUM_ORDERS,CL,fdd,insert
DEFAULT,DEFAULT,CUSTOMERS,CUST_EMAIL,DEFAULT,DEFAULT,MEDIUM_ORDERS,CEM,fdd,insert
DEFAULT,DEFAULT,ORDERS,ORDER_ID,DEFAULT,DEFAULT,LARGE_ORDERS,OID,fdd,insert
DEFAULT,DEFAULT,ORDERS,CUSTOMER_ID,DEFAULT,DEFAULT,LARGE_ORDERS,CID,fdd,insert
DEFAULT,DEFAULT,ORDERS,ORDER_TOTAL,DEFAULT,DEFAULT,LARGE_ORDERS,OTTL,fdd,insert
DEFAULT,DEFAULT,ORDERS,SALES_REP_ID,DEFAULT,DEFAULT,LARGE_ORDERS,SID,fdd,insert
DEFAULT,DEFAULT,CUSTOMERS,CREDIT_LIMIT,DEFAULT,DEFAULT,LARGE_ORDERS,CL,fdd,insert
DEFAULT,DEFAULT,CUSTOMERS,CUST_EMAIL,DEFAULT,DEFAULT,LARGE_ORDERS,CEM,fdd,insert
DEFAULT,DEFAULT,ORDERS,ORDER_ID,DEFAULT,DEFAULT,SPECIAL_ORDERS,OID,fdd,insert
DEFAULT,DEFAULT,ORDERS,CUSTOMER_ID,DEFAULT,DEFAULT,SPECIAL_ORDERS,CID,fdd,insert
DEFAULT,DEFAULT,ORDERS,ORDER_TOTAL,DEFAULT,DEFAULT,SPECIAL_ORDERS,OTTL,fdd,insert
DEFAULT,DEFAULT,ORDERS,SALES_REP_ID,DEFAULT,DEFAULT,SPECIAL_ORDERS,SID,fdd,insert
DEFAULT,DEFAULT,CUSTOMERS,CREDIT_LIMIT,DEFAULT,DEFAULT,SPECIAL_ORDERS,CL,fdd,insert
DEFAULT,DEFAULT,CUSTOMERS,CUST_EMAIL,DEFAULT,DEFAULT,SPECIAL_ORDERS,CEM,fdd,insert
DEFAULT,SCOTT,EMP,DEPTNO,DEFAULT,DEFAULT,VSAL,Department,fdd,create_view

Try it out!

export sqlflow full lineage as csv format

post

export sqlflow full lineage as csv format

Authorizations
Query parameters
dbvendorstring · enumRequired

db vendor

Default: dbvoraclePossible values:
delimiterstringOptional

delimiter of the values in CSV, default would be ','

Default: ,
export_include_tablestringOptional

export_include_table

sessionIdstringOptional

sessionId

showConstantTablebooleanOptional

showConstantTable

Default: false
sqltextstringOptional

sql text

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

user id

Body
sqlfilestring · binaryOptional

sqlfile

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/exportFullLineageAsCsv HTTP/1.1
Host: api.gudusoft.com
Authorization: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 20

{
  "sqlfile": "binary"
}
text