sqlglot_rust/
lib.rs

1//! # sqlglot-rust
2//!
3//! A SQL parser, optimizer, and transpiler library written in Rust,
4//! inspired by Python's [sqlglot](https://github.com/tobymao/sqlglot).
5//!
6//! ## Features
7//!
8//! - Parse SQL strings into a structured AST
9//! - Generate SQL from AST nodes
10//! - Transpile between SQL dialects (30 dialects including MySQL, PostgreSQL, BigQuery, Snowflake, DuckDB, Hive, Spark, Presto, Trino, T-SQL, Oracle, ClickHouse, Redshift, and more)
11//! - Optimize SQL queries
12//! - CTEs, subqueries, UNION/INTERSECT/EXCEPT
13//! - Window functions, CAST, EXTRACT, EXISTS
14//! - Pretty-print SQL output
15//! - AST traversal (walk, find, transform)
16//!
17//! ## Quick Start
18//!
19//! ```rust
20//! use sqlglot_rust::{parse, generate, transpile, Dialect};
21//!
22//! // Parse a SQL query
23//! let ast = parse("SELECT a, b FROM t WHERE a > 1", Dialect::Ansi).unwrap();
24//!
25//! // Generate SQL for a specific dialect
26//! let sql = generate(&ast, Dialect::Postgres);
27//! assert_eq!(sql, "SELECT a, b FROM t WHERE a > 1");
28//!
29//! // One-step transpile between dialects
30//! let result = transpile("SELECT a, b FROM t", Dialect::Ansi, Dialect::Postgres).unwrap();
31//! ```
32
33pub mod ast;
34pub mod builder;
35pub mod dialects;
36pub mod errors;
37pub mod generator;
38pub mod optimizer;
39pub mod parser;
40pub mod schema;
41pub mod tokens;
42
43pub use ast::{Expr, MergeClauseKind, QuoteStyle, Statement};
44pub use builder::{
45    // Expression factory functions
46    column, table, table_full, literal, string_literal, boolean, null,
47    // Operators and expressions
48    cast, and_all, or_all, not, func, func_distinct,
49    // Comparison helpers
50    eq, neq, lt, lte, gt, gte, is_null, is_not_null, between, in_list, not_in_list, in_subquery, like,
51    // Arithmetic helpers
52    add, sub, mul, div,
53    // Other helpers
54    star, qualified_star, subquery, exists, alias,
55    // Parse helpers
56    parse_expr, parse_expr_dialect, parse_condition, parse_condition_dialect,
57    // Builders
58    condition, condition_dialect, select, select_all, select_distinct,
59    ConditionBuilder, SelectBuilder,
60};
61pub use dialects::Dialect;
62pub use dialects::time::{TimeFormatStyle, format_time, format_time_dialect, format_time_with_warnings, FormatConversionResult, TsqlStyleCode};
63pub use errors::SqlglotError;
64pub use generator::{generate, generate_pretty};
65pub use optimizer::annotate_types::{TypeAnnotations, annotate_types};
66pub use optimizer::lineage::{lineage, lineage_sql, LineageConfig, LineageError, LineageGraph, LineageNode};
67pub use optimizer::pushdown_predicates::pushdown_predicates;
68pub use optimizer::scope_analysis::{Scope, ScopeType, build_scope, find_all_in_scope};
69pub use parser::parse;
70
71/// Transpile a SQL string from one dialect to another.
72///
73/// This is the primary high-level API, corresponding to Python sqlglot's
74/// `sqlglot.transpile()`.
75///
76/// # Example
77///
78/// ```rust
79/// use sqlglot_rust::{transpile, Dialect};
80///
81/// let result = transpile(
82///     "SELECT CAST(x AS INT) FROM t",
83///     Dialect::Ansi,
84///     Dialect::Postgres,
85/// ).unwrap();
86/// ```
87///
88/// # Errors
89///
90/// Returns a [`SqlglotError`] if parsing fails.
91pub fn transpile(
92    sql: &str,
93    read_dialect: Dialect,
94    write_dialect: Dialect,
95) -> errors::Result<String> {
96    let ast = parse(sql, read_dialect)?;
97    let transformed = dialects::transform(&ast, read_dialect, write_dialect);
98    Ok(generate(&transformed, write_dialect))
99}
100
101/// Transpile a SQL string, returning multiple statements if the input
102/// contains semicolons.
103///
104/// # Errors
105///
106/// Returns a [`SqlglotError`] if parsing fails.
107pub fn transpile_statements(
108    sql: &str,
109    read_dialect: Dialect,
110    write_dialect: Dialect,
111) -> errors::Result<Vec<String>> {
112    let stmts = parser::parse_statements(sql, read_dialect)?;
113    let mut results = Vec::with_capacity(stmts.len());
114    for stmt in &stmts {
115        let transformed = dialects::transform(stmt, read_dialect, write_dialect);
116        results.push(generate(&transformed, write_dialect));
117    }
118    Ok(results)
119}
sqlglot_rust/lib.rs

sqlglot_rust/
lib.rs
