Metadata-Version: 2.1
Name: sqllineage
Version: 1.2.2
Summary: SQL Lineage Analysis Tool powered by Python
Home-page: https://github.com/reata/sqllineage
Author: Reata
Author-email: reddevil.hjw@gmail.com
License: UNKNOWN
Description: # SQLLineage
        SQL Lineage Analysis Tool powered by Python
        
        [![image](https://img.shields.io/pypi/v/sqllineage.svg)](https://pypi.org/project/sqllineage/)
        [![image](https://img.shields.io/pypi/status/sqllineage.svg)](https://pypi.org/project/sqllineage/)
        [![image](https://img.shields.io/pypi/pyversions/sqllineage.svg)](https://pypi.org/project/sqllineage/)
        [![image](https://img.shields.io/pypi/l/sqllineage.svg)](https://pypi.org/project/sqllineage/)
        [![Build Status](https://github.com/reata/sqllineage/workflows/build/badge.svg)](https://github.com/reata/sqllineage/actions)
        [![Documentation Status](https://readthedocs.org/projects/sqllineage/badge/?version=latest)](https://sqllineage.readthedocs.io/en/latest/?badge=latest)
        [![codecov](https://codecov.io/gh/reata/sqllineage/branch/master/graph/badge.svg)](https://codecov.io/gh/reata/sqllineage)
        [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
        [![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)
        
        Never get the hang of a SQL parser? SQLLineage comes to the rescue. Given a SQL command, SQLLineage will tell you its
        source and target tables, without worrying about Tokens, Keyword, Identifier and all the jagons used by SQL parsers.
        
        Behind the scene, SQLLineage uses the fantastic [`sqlparse`](https://github.com/andialbrecht/sqlparse) library to parse 
        the SQL command, and bring you all the human-readable result with ease.
        
        ## Demo & Documentation
        Talk is cheap, show me a [demo](https://sqllineage.herokuapp.com/).
        
        [Documentation](https://sqllineage.readthedocs.io) is online hosted by readthedocs, and you can check the 
        [release note](https://sqllineage.readthedocs.io/en/latest/release_note/changelog.html) there.
        
        
        ## Quick Start
        Install sqllineage via PyPI:
        ```bash
        $ pip install sqllineage
        ```
        
        Using sqllineage command to parse a quoted-query-string:
        ```
        $ sqllineage -e "insert into db1.table1 select * from db2.table2"
        Statements(#): 1
        Source Tables:
            db2.table2
        Target Tables:
            db1.table1
        ```
        
        Or you can parse a SQL file with -f option:
        ```
        $ sqllineage -f foo.sql
        Statements(#): 1
        Source Tables:
            db1.table_foo
            db1.table_bar
        Target Tables:
            db2.table_baz
        ```
        
        ## Advanced Usage
        
        ### Multiple SQL Statements
        Lineage result combined for multiple SQL statements, with intermediate tables identified:
        ```
        $ sqllineage -e "insert into db1.table1 select * from db2.table2; insert into db3.table3 select * from db1.table1;"
        Statements(#): 2
        Source Tables:
            db2.table2
        Target Tables:
            db3.table3
        Intermediate Tables:
            db1.table1
        ```
        
        ### Verbose Lineage Result
        And if you want to see lineage result for every SQL statement, just toggle verbose option
        ```
        $ sqllineage -v -e "insert into db1.table1 select * from db2.table2; insert into db3.table3 select * from db1.table1;"
        Statement #1: insert into db1.table1 select * from db2.table2;
            table read: [Table: db2.table2]
            table write: [Table: db1.table1]
            table rename: []
            table drop: []
            table intermediate: []
        Statement #2: insert into db3.table3 select * from db1.table1;
            table read: [Table: db1.table1]
            table write: [Table: db3.table3]
            table rename: []
            table drop: []
            table intermediate: []
        ==========
        Summary:
        Statements(#): 2
        Source Tables:
            db2.table2
        Target Tables:
            db3.table3
        Intermediate Tables:
            db1.table1
        ```
        
        ### Lineage Visualization
        One more cool feature, if you want a graph visualization for the lineage result, toggle graph-visualization option
        ```
        sqllineage -g -e "insert into db1.table11 select * from db2.table21 union select * from db2.table22; insert into db3.table3 select * from db1.table11 join db1.table12;"
        ```
        A webserver will be started, showing DAG representation of the lineage result in browser:
        <img src="https://raw.githubusercontent.com/reata/sqllineage/master/docs/_static/Figure_1.png">
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: ci
Provides-Extra: docs
