A tool for analyzing SQL files that use Jinja2 {{ ref() }} macros, extracting table dependencies and visualizing them as graphs.
cargo install alisqlOr download a pre-built binary for your platform from Releases.
# Text format (default)
alisql deps ./sql
# JSON format
alisql deps ./sql --format json
# Limit search depth (default: 5)
alisql deps ./sql --max-depth 3Output (text):
[sample]
<- db.users
<- role
[sample2]
<- db.sales
<- db.sale_detail
Output (json):
[
{
"table": "sample",
"depends_on": ["db.users", "role"]
},
{
"table": "sample2",
"depends_on": ["db.sales", "db.sale_detail"]
}
]# Default orientation (top-down: TD)
alisql graph ./sql
# Specify orientation (TB / TD / BT / RL / LR)
alisql graph ./sql --orientation lrOutput:
graph TD;
db.users --> sample;
role --> sample;
db.sales --> sample2;
db.sale_detail --> sample2;
Rendered as a Mermaid diagram:
graph TD;
db.users --> sample;
role --> sample;
db.sales --> sample2;
db.sale_detail --> sample2;
# Cargo.toml
[dependencies]
alisql = "0.2"let tables = alisql::get_dependencies("./sql", 5);
for table in &tables {
println!("{} depends on {:?}", table.table, table.depends_on);
}let graph = alisql::get_mermaid("./sql", "TD", 5);
println!("{}", graph);Reference dependent tables using {{ ref("table") }} or {{ ref("schema", "table") }}.
-- sql/orders.sql
select o.*, u.name
from {{ ref("db", "orders") }} as o
left join {{ ref("users") }} as u on o.user_id = u.idAnalyzing this file reveals that the orders table depends on db.orders and users.