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
  • Root elements
  • Table Structure
  • Column Structure
  • OraclePackage Structure
  • Procedure Structure
  • Argument Structure
  • Process Structure
  • Relationship Structure
  • TargetColumn Structure
  • SourceColumn Structure
  • Transform Structure
  • Error Structure
  1. 7. Reference
  2. Lineage Model

XML Format Lineage Model

PreviousJson Format Lineage ModelNextData Lineage Elements

Last updated 2 years ago

This page indends to describe the structure of the dataflow.xml. Dlineage tool generates dataflow.xml if the /json is not set. Response will be in json format if the /json is set. Please refer to for the json response.

Root elements

  • table

    Belongs to the Table Structure

  • view

    Belongs to the Table Structure

  • resultset

    Belongs to the Table Structure

  • package

    Belongs to the oraclePackage Structure

  • procedure

    Includes procedure, function, trigger

    Belongs to the Procedure Structure

  • database

    Belongs to the Table Structure

  • schema

    Belongs to the Table Structure

  • stage

    Belongs to the Table Structure

  • datasource

    Belongs to the Table Structure

  • stream

    Belongs to the Table Structure

  • path

    External file

    Belongs to the Table Structure

  • variable

    Belongs to the Table Structure

  • process

    Data movement process from table A to table B generates process. Process is used to display table level relation on UI.

    Belongs to the Process Structure

  • relationship

    Analysis result

    Belongs to the Relationship Structure

  • error

    Errors during the analysis

    Belongs to the Error Structure

  • orientation

    UI graph orientation.

    Enumeration, types are: LEFT_TO_RIGHT、RIGHT_TO_LEFT、TOP_TO_BOTTOM、BOTTOM_TO_TOP

Table Structure

Subnode in Table structure:

  • column

    Belongs to the Column Structure

Column Structure

OraclePackage Structure

Subnode in OraclePackage structure:

  • procedure

    Belongs to the Procedure Structure

Procedure Structure

Subnode in procedure structure:

  • argument

    Belongs to the Argument Structure

Argument Structure

Process Structure

Relationship Structure

Relationship will tell the data lineage relationship. It can be on table level and column level.

Table level can be: table --> process --> table

Column level can be: column --> column

  • id

    relationship id

  • type

    relationship type: fdd, fdr, join or call

  • function

    function name if the relationship is from a function

  • effectType

    effect type of the relationship

  • clause

    the join condtion clause type when the relationship is from join

  • joinType

    join type

  • processId

    relationship process id, which can be used to calculate table level

  • processType

    process type of the relationship

  • sqlHash

    statement hash of the relationship

  • sqlComment

    statement comment of the relationship, which is used to get extra information

  • condition

    join condtion clause when the relationship type is join

  • timestampMin

    the earliest time when the relationship is generated

  • timestampMax

    the latest time when the relationship is generated

Subnode in the Relationship:

  • target

    Target when the relationship type is fdd, fdr, join

    Belongs to the TargetColumn Structure

  • source

    Source when the relationship type is fdd, fdr, join

    Belongs to the SourceColumn Structure

  • caller

    Caller when the relationship type is call

    Belongs to the TargetColumn Structure

  • callee

    Callee when the relationship type is call

    Belongs to the SourceColumn Structure

TargetColumn Structure

SourceColumn Structure

subnode in the SourceColumn

  • transforms

    Belongs to the Transform Structure

Transform Structure

Error Structure

Errors during the analysis

  • errorMessage

  • errorType

    error type, could be: SyntaxError, SyntaxHint, AnalyzeError, LinkOrphanColumn

  • coordinate

    coordinate where errors happen

  • file

    sql file information of the errors

  • originCoordinate

    original coordinate where errors happen

here
Table Structure
Column Structure
OraclePackage Structure
Procedure Structure
Argument Structure
Process Structure
Target Fields Data
#sourcecolumn-structure
Transform Fields Data