How to use SQLFlow

https://github.com/sqlparser/sqlflow_public#how-to-use-sqlflow

• Open the official website of the SQLFlow and paste your SQL script or metadata to get a nice clean lineage diagram.

• Call the Restful API of the SQLFlow in your own code to get data lineage metadata decoded by the SQLFlow from the SQL script.

• The on-premise version of SQLflow enables you to use it on your own server to keep the data safer.

Online Web UI

Visit SQLFlow Cloud.

You may paste your SQL script into the SQLFlow web page or upload the SQL file to the site. Select the correct database and then click the visualize button.

UI

Restful APIs

SQLFlow provides RESTful API, so your program can transfer data with the SQLFlow backend directly. Sending the SQL to SQLFlow backend and receive a JSON response including the data lineage and diagram model for further processing in your program.

You will need to setup the SQLFlow on-premise version on your server to use the API or you can connect to the SQLFlow Cloud to use the RESTFul API.

Using the Rest API

On-premise Server installation

Install SQLFlow frontend and backend on your own application/server (SQLFlow on-premise version)

To setup SQLFlow on your server, purchase and obtain a commercial license to get all those distribution files of the SQLFlow on-premise version.

Installation

SDK

Integrate the frontend and backend to your data platform

Check our widget tool to onboard the sqlflow on your front application.

For the backend part, you can check the our Dlineage tool.

Widget Get startedDlineage Tool

Roadmap and FAQ

RoadmapFAQ