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
  • Target Fields Data
  • Source Fields Data
  • Transform Fields Data
  • Table Structure
  • Column Structure
  • OraclePackage Structure
  • Procedure Structure
  • Argument Structure
  • Process Structure
  1. 7. Reference
  2. Lineage Model

Data Lineage Elements

Target Fields Data

  • id

    id of the target column

  • name

    name of the target column. the name would be the caller if the Relationship type is call

  • column

    column name

  • function

    fucntion name if the relationship is from a function

  • target_id

    target id if the target is not on column level

  • target_name

    target name if the target is not on column level

  • parent_id

    parent id of the target's parent node

  • parent_name

    parent name of the target's parent node

  • parent_alias

    parent alias of the target's parent node

  • coordinate

  • source

    will be filtered out on UI if the source is from system

  • type

    type of the storage process if the Relationship type is call. could be: procedure, function, trigger, macro

Source Fields Data

  • id

    source column Id

  • name

    caller name if the Relationship type is call

  • column

    • source column name

  • source_id

    source id when the source is not on column level

  • source_name

    source name when the source is not on column level

  • column_type

    column type

  • parent_id

    source parent node id

  • parent_name

    source parent node name

  • parent_alias

    source parent node alias

  • coordinate

  • clauseType

    source clause type

  • source

    will be filtered out on UI if the source is from system

  • type

    type of the storage process if the Relationship type is call. could be: procedure, function, trigger, macro

subnode in the SourceColumn

  • transforms

    Belongs to the Transform Structure

Transform Fields Data

Describe how the Relationship is generated

  • type

    type, could be: simple, function, expression, constant, case or subquery

  • coordinate

  • code

    code expression

Table Structure

  • id

    table id

  • server

    db server to which the table belongs

  • database

    database to which the table belongs

  • schema

    • table schema

  • name

    table name, database.schema.table for example. if there's no database the name would be schema.table. If there's no schema the name will be database.table

  • alias

    alias name

  • uri

    mapped url when table type is file, path, stage or stream

  • type

    table type

  • subType

    subtype of the type

  • processIds

    linked process Ids

  • fileType

    mapped file type if the table type is stage

  • fileFormat

    mapped file format if table type is ``` _file, path, stage_ or _stream`_

  • location

    location url if the table type is stage or datasource

  • isTarget

    if display in UI

  • coordinate

    element coordinate

  • parent

    storage process of the table

  • more

    if collaspe in the UI

Subnode in Table structure:

  • column

    Belongs to the Column Structure

Column Structure

  • id

    • column id

  • name

    • column name

  • coordinate

    • column coordinate

  • source

    column source. will not be dispalyed If source is system

  • qualifiedTable

    • Field which is used to distinguish the column when there are columns under the same name such as: table1.a, table2.a

OraclePackage Structure

  • id

    package id

  • server

    db server to which the package belongs

  • database

    database to which the package belongs

  • schema

    schema to which the package belongs

  • name

    package name: database.schema.package The name would be : schema.package If there's no database . The name would be database.package if there 's no schema.

  • type

    package type

  • coordinate

    package coordinate

Subnode in OraclePackage structure:

  • procedure

    Belongs to the Procedure Structure

Procedure Structure

  • id

    procedure id

  • server

    db server to which the procedure belongs

  • database

    database to which the procedure belongs

  • schema

    schema to which the procedure belongs

  • name

    procedure name: database.schema.procedure The name would be : schema.procedure If there's no database . The name would be database.procedure if there 's no schema

    if the procedure belongs to package, full name will also contain package segment

  • type

    procedure type, could be procedure, function, trigger

  • coordinate

    procedure coordinate

Subnode in procedure structure:

  • argument

    Belongs to the Argument Structure

Argument Structure

Argument is to describe the parameters during the storage process

  • id

    argument id

  • name

    argument name

  • coordinate

    argument coordinate

  • datatype

    argument data type

  • inout

    in or out type

Process Structure

Process will be generated when data flow moves from one table to another

  • id

    • process id

  • server

    db server to which the process belongs

  • database

    database to which the process belongs

  • schema

    schema to which the process belongs

  • name

    process name, different process can have the same name

  • procedureName

    procedure to which the process belongs

  • procedureId

    procedure id to which the process belongs

  • queryHashId

    statement hashcode to which the process belongs

  • type

    process type

  • coordinate

    process coordinate

PreviousXML Format Lineage ModelNextDatabase Model

Last updated 2 years ago