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
  • Configurable parameters when creating jobs or visualizing the SQL in SQL Editor
  • Show function
  • Show transform
  • Export the graph
  1. 1. Introduction
  2. UI

Settings

https://github.com/sqlparser/sqlflow_public/blob/master/sqlflow_guide_cn.md#setting

PreviousDiagram PanelNextJob Management

Last updated 2 years ago

Input different request parameters to the graph API to get different results:

Parameter
Acceptable values

showRelationType

If direct dataflow = true then it is fdd and we will show only direct dataflow. If direct dataflow = true and indirect dataflow=true, then it is fdd,fddi,fdr,frd. We will show both direct dataflow and indrect dataflow.

dataflowOfAggregateFunction

Whether take the parameters in the COUNT function as direct or indirect dataflow

ignoreRecordSet

true or false

ignoreFunction

true or false

showConstantTable

true or false

showTransform

true or false

We can observe the changes on parameters when switching different modes:

Configurable parameters when creating jobs or visualizing the SQL in SQL Editor

You will be able to set the config when creating data lineage with the SQL Edior as well as giving the configurable parameters under the setting section during the job creation.

Customizing parameters when visualizing your SQL:

Giving the configurable parameters under the setting section during the job creation:

Parameter
Possible Values
Description

direct dataflow

On/Off

Whether show direct dataflow or not.

indirect dataflow

On/Off

Whether show indirect dataflow or not.

dataflow of count function

direct/indirect

Whether take the parameters in the COUNT function as direct or indirect dataflow

show intermediate recordset

On/Off

Show intermediate recordset or not.

show function

On/Off

Show function or not

show transform

On/Off

Show transform or not

show constant

On/Off

show constant or not

Take the following sql as example:

SELECT count(sal) totalNum, sum(sal) totalSal 
FROM   scott.emp 

When we set all values as On and direct as the value in dataflow of count function when creating the job/visualizing the SQL, we will get following data lineage:

All direct dataflows and indirect dataflows are present in above data lineage. We show the functions in the sql and intermediate recordSets are shown.

The indirect dataflows will not be present if we turn Off indirect dataflow:

Show function

Show transform

Export the graph

You can read more theory about what is / and why is different.

direct dataflow
indirect dataflow
aggrect function COUNT