Skip to content

Commit 7059163

Browse files
committed
feat: initial release
Rust library, CLI, and Python bindings for extracting table-level and column-level data lineage from SQL statements. Supports SELECT, INSERT, CREATE TABLE AS, UPDATE, DELETE, MERGE, CTEs (including WITH RECURSIVE), UNION, subqueries, window functions, and optional CatalogProvider for SELECT * expansion.
0 parents  commit 7059163

40 files changed

Lines changed: 4325 additions & 0 deletions

.envrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
use flake

.gitignore

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
/target
2+
Cargo.lock
3+
4+
# Python
5+
__pycache__/
6+
*.pyc
7+
*.pyo
8+
*.egg-info/
9+
dist/
10+
.venv/
11+
*.so
12+
*.dylib
13+
*.dll
14+
15+
# Nix / direnv
16+
.direnv/
17+
18+
# IDE
19+
.idea/
20+
.vscode/
21+
*.swp
22+
.DS_Store

ARCHITECTURE.md

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
# Architecture
2+
3+
This document describes how sqllineage is structured and how to navigate
4+
the codebase. It is intended for contributors and anyone reading the source.
5+
6+
## Overview
7+
8+
sqllineage takes a SQL string and produces, for each statement, a list of
9+
input/output tables and a mapping from each output column to the source
10+
columns it derives from. The analysis is purely syntactic — it does not
11+
execute SQL or connect to a database. An optional `CatalogProvider` can be
12+
supplied to resolve `SELECT *` and disambiguate unqualified columns.
13+
14+
The work happens in two phases:
15+
16+
1. **Build** (`build/`) — walk the AST produced by `sqlparser` and construct
17+
a dependency graph (`RawGraph`).
18+
2. **Resolve** (`resolve/`) — traverse the graph, resolve column references
19+
through scope chains, and produce the final `AnalyzeResult`.
20+
21+
Each statement is processed independently with its own graph and scope tree.
22+
23+
## Build phase
24+
25+
`build/statement.rs` is the entry point. It pattern-matches on the sqlparser
26+
`Statement` enum to identify the output table and delegate to the appropriate
27+
handler. INSERT, CTAS, UPDATE, DELETE, and MERGE each have specific logic for
28+
extracting column-level assignments.
29+
30+
`build/query.rs` handles `Query` — first processing any CTEs (each gets its
31+
own scope with bindings registered in the parent), then the query body. UNION
32+
is handled by giving each side its own scope and merging output columns
33+
positionally. `SetExpr::Update` / `SetExpr::Insert` (for CTE-wrapped DML
34+
like `WITH ... UPDATE`) delegates back to statement dispatch.
35+
36+
`build/select.rs` processes a `SELECT`: FROM first (registering bindings),
37+
then projection (creating Output nodes). When a FROM item is a CTE reference,
38+
the existing CTE binding is reused instead of creating a new Table binding.
39+
Anonymous (alias-less) derived tables are tracked on the scope separately.
40+
41+
`build/expr.rs` recursively walks expressions to collect leaf column
42+
references. Window function PARTITION BY / ORDER BY clauses are included
43+
as ancestors.
44+
45+
### Graph and scope structures
46+
47+
`graph/node.rs` defines four node types: Output (projection result), Ref
48+
(qualified column like `t.col`), Unqualified (bare column name), and Star
49+
(`SELECT *`).
50+
51+
`graph/scope.rs` models SQL name resolution. Each scope holds a map of
52+
bindings (Table, Cte, or DerivedTable) and a list of output columns. Lookup
53+
walks the parent chain with nearest-scope-wins shadowing. CTE body scopes
54+
are separated from CTE registration scopes to prevent false ambiguity.
55+
56+
## Resolve phase
57+
58+
`resolve/mod.rs` iterates the root scope's output columns and resolves each
59+
one. Named columns resolve through scope lookup: Table bindings produce
60+
`Concrete` origins, CTE/DerivedTable bindings follow through `output_columns`
61+
to the base table recursively. Star nodes go through the same chain via
62+
`expand_star()`.
63+
64+
Every resolve path must handle all three binding types (Table, Cte,
65+
DerivedTable) uniformly. This is the most important invariant in the
66+
codebase — past bugs came from paths that only handled `Binding::Table`.
67+
68+
`resolve/topo.rs` validates that the graph is a DAG after removing recursive
69+
CTE back-edges. `resolve/catalog.rs` applies the optional `CatalogProvider`
70+
as a post-processing step.
71+
72+
## Upgrading sqlparser
73+
74+
When sqlparser adds new `Statement` or `Expr` variants, the build layer
75+
may need updating:
76+
77+
- New `Statement` variant → add a match arm in `statement.rs` (or let
78+
it fall through to `StatementType::Other` if it carries no lineage).
79+
- New `Expr` variant → add a match arm in `expr.rs` (the catch-all
80+
emits `WarningKind::UnhandledExpression`).
81+
- Renamed/restructured fields → follow compiler errors.
82+
83+
If sqlparser already parses a construct, sqllineage generally handles it
84+
automatically through the existing AST traversal. Changes to sqllineage
85+
itself should only be needed when sqlparser's representation changes.
86+
87+
## Module map
88+
89+
| Path | Responsibility |
90+
|------|---------------|
91+
| `lib.rs` | `pub fn analyze()` — parses SQL, runs build+resolve per statement |
92+
| `types.rs` | All public types: `AnalyzeResult`, `TableRef`, `ColumnMapping`, etc. |
93+
| `dialect.rs` | Maps `Dialect` enum to sqlparser dialect implementations |
94+
| `build/statement.rs` | Statement-level dispatch and column mapping for DML |
95+
| `build/query.rs` | CTE registration, UNION merge, CTE-wrapped DML |
96+
| `build/select.rs` | FROM binding registration, projection processing |
97+
| `build/expr.rs` | Recursive expression traversal for ancestor collection |
98+
| `graph/node.rs` | `RawNode` enum (Output, Ref, Unqualified, Star) |
99+
| `graph/edge.rs` | `RawEdge` with `EdgeKind` (Direct, ViaExpression, etc.) |
100+
| `graph/scope.rs` | `ScopeTree` with bindings, output columns, parent chain |
101+
| `resolve/mod.rs` | Scope-chain resolution, Star expansion, `ColumnMapping` assembly |
102+
| `resolve/topo.rs` | Kahn's algorithm for DAG validation |
103+
| `resolve/catalog.rs` | `CatalogProvider` application (Wildcard/Ambiguous refinement) |

Cargo.toml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[workspace]
2+
resolver = "3"
3+
members = ["sqllineage", "sqllineage-python"]
4+
default-members = ["sqllineage"]
5+

LICENSE-APACHE

Lines changed: 190 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to the Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by the Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding any notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
Copyright 2026 funcpp
179+
180+
Licensed under the Apache License, Version 2.0 (the "License");
181+
you may not use this file except in compliance with the License.
182+
You may obtain a copy of the License at
183+
184+
http://www.apache.org/licenses/LICENSE-2.0
185+
186+
Unless required by applicable law or agreed to in writing, software
187+
distributed under the License is distributed on an "AS IS" BASIS,
188+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189+
See the License for the specific language governing permissions and
190+
limitations under the License.

LICENSE-MIT

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 funcpp
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)