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
  • Sample
  • Sample Indication
  • Get More Details
  1. 6. SQLFlow-ingester
  2. Understand the format of exported data

MySQL

metadata.json exported by ingester has the same structure as the dbobjs.servers part of the Dlineage tool result

This page gives a sample metadata for MySQL.

Sample

{
    "createTime": "2022-11-16 21:01:50",
    "createdBy": "sqlflow-ingester v1.1.7",
    "physicalInstance": "115.159.xx.xx",
    "servers": [
        {
            "databases": [
                {
                    "name": "SQLFlowDB1",
                    "tables": [
                        {
                            "columns": [
                                {
                                    "comment": "",
                                    "dataType": "int",
                                    "name": "ID"
                                }
                            ],
                            "databaseName": "`SQLFlowDB1`",
                            "name": "ABC",
                            "schemaName": "",
                            "type": "table"
                        },
                        {
                            "columns": [
                                {
                                    "comment": "",
                                    "dataType": "int",
                                    "name": "ID"
                                }
                            ],
                            "databaseName": "`SQLFlowDB1`",
                            "name": "BCD",
                            "schemaName": "",
                            "type": "table"
                        },
                        {
                            "columns": [
                                {
                                    "comment": "",
                                    "dataType": "int",
                                    "name": "ID"
                                },
                                {
                                    "comment": "",
                                    "dataType": "varchar",
                                    "name": "NAME"
                                },
                                {
                                    "comment": "",
                                    "dataType": "varchar",
                                    "name": "COMMITSTR"
                                }
                            ],
                            "databaseName": "`SQLFlowDB1`",
                            "name": "TABLEA",
                            "schemaName": "",
                            "type": "table"
                        },
                        {
                            "columns": [
                                {
                                    "comment": "",
                                    "dataType": "int",
                                    "name": "ID"
                                },
                                {
                                    "comment": "",
                                    "dataType": "varchar",
                                    "name": "NAME"
                                },
                                {
                                    "comment": "",
                                    "dataType": "varchar",
                                    "name": "COMMITSTR"
                                }
                            ],
                            "databaseName": "`SQLFlowDB1`",
                            "name": "TABLEB",
                            "schemaName": "",
                            "type": "table"
                        }
                    ]
                }
            ],
            "dbLinks": [],
            "dbVendor": "dbvmysql",
            "name": "115.159.xx.xx",
            "queries": [
                {
                    "database": "employees",
                    "groupName": "",
                    "name": "DEPT_EMP_LATEST_DATE",
                    "sourceCode": "CREATE ALGORITHM=UNDEFINED DEFINER=`root`@`58.56.46.106` SQL SECURITY DEFINER VIEW `dept_emp_latest_date` AS select `dept_emp`.`emp_no` AS `emp_no`,max(`dept_emp`.`from_date`) AS `from_date`,max(`dept_emp`.`to_date`) AS `to_date` from `dept_emp` group by `dept_emp`.`emp_no`",
                    "type": "view"
                }
            ],
            "supportsCatalogs": true,
            "supportsSchemas": false
        }
    ]
}

Sample Indication

{
    "createTime":"", //export time
    "createdBy":"sqlflow-exporter",//name of the export tool
    "physicalInstance":"",//server address
    "servers":[
        {
            "name":"",//server name
            "dbVendor":"",//database type,possible values are: dbvathena,dbvazuresql,dbvbigquery,dbvcouchbase,dbvdb2,dbvgreenplum,dbvhana,dbvhive,dbvimpala,dbvinformix,dbvmdx,dbvmysqldbvnetezza,dbvopenedge,dbvoracle,dbvpostgresql,dbvpresto,dbvredshift,dbvsnowflake,dbvsparksql,dbvmssql,dbvsybase,dbvteradata,dbvvertica
            "supportsCatalogs":true,//there's a database layer
            "supportsSchemas":false,//there's no schema layer
            "databases":[
                {
                    "name":"",//database name
    
                    "synonyms":[//synonym list when there's no schema object, same structure as the above servers.databases.schemas.synonyms
  
                    ],
                    "sequences":[//sequence list when there's no schema object, same structure as the above servers.databases.schemas.sequences 
  
                    ],
                    "tables":[//table list when there's no schema object, same structure as the above servers.databases.schemas.tables 
  
  
                    ],
                    "views":[//view list when there's no schema object, same structure as the above servers.databases.schemas.views 
  
                    ],
                    "others":[//others when there's no schema object, including resultset, variable, path etc. same structure as the above servers.databases.schemas.others 
  
                    ],
                    "packages":[//package list when there's no schema object, same structure as the above servers.databases.schemas.packages 
  
                    ],
                    "procedures":[//procedure list when there's no schema object, same structure as the above servers.databases.schemas.procedures 
  
                    ],
                    "functions":[//function list when there's no schema object, same structure as the above servers.databases.schemas.functions 
  
                    ],
                    "triggers":[//trigger list when there's no schema object, same structure as the above servers.databases.schemas.triggers 
  
                    ]
                }
            ],
            "dbLinks":[
                {
                    "owner":"",
                    "name":"",
                    "userName":"",
                    "host":""
                }
            ],
            "queries":[//DDL scripts in database
                {
                    "database":"",
                    "schema":"",
                    "name":"",
                    "type":"",
                    "sourceCode":"",
                    "groupName":""
                }
            ]
        }
    ],
    "errorMessages":[//errors during the exporting 
        {
            "errorMessage":"",
            "errorType":"",
            "file":""
        }
    ]
  }

Get More Details

PreviousMicrosoft SQL ServerNextPostgreSQL

Last updated 2 years ago

You can refer to to understand more about what does each field mean.

this section