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 dialects;
35pub mod errors;
36pub mod generator;
37pub mod optimizer;
38pub mod parser;
39pub mod schema;
40pub mod tokens;
41
42pub use ast::{Expr, MergeClauseKind, QuoteStyle, Statement};
43pub use dialects::Dialect;
44pub use errors::SqlglotError;
45pub use generator::{generate, generate_pretty};
46pub use optimizer::annotate_types::{TypeAnnotations, annotate_types};
47pub use optimizer::pushdown_predicates::pushdown_predicates;
48pub use optimizer::scope_analysis::{Scope, ScopeType, build_scope, find_all_in_scope};
49pub use parser::parse;
50
51/// Transpile a SQL string from one dialect to another.
52///
53/// This is the primary high-level API, corresponding to Python sqlglot's
54/// `sqlglot.transpile()`.
55///
56/// # Example
57///
58/// ```rust
59/// use sqlglot_rust::{transpile, Dialect};
60///
61/// let result = transpile(
62///     "SELECT CAST(x AS INT) FROM t",
63///     Dialect::Ansi,
64///     Dialect::Postgres,
65/// ).unwrap();
66/// ```
67///
68/// # Errors
69///
70/// Returns a [`SqlglotError`] if parsing fails.
71pub fn transpile(
72    sql: &str,
73    read_dialect: Dialect,
74    write_dialect: Dialect,
75) -> errors::Result<String> {
76    let ast = parse(sql, read_dialect)?;
77    let transformed = dialects::transform(&ast, read_dialect, write_dialect);
78    Ok(generate(&transformed, write_dialect))
79}
80
81/// Transpile a SQL string, returning multiple statements if the input
82/// contains semicolons.
83///
84/// # Errors
85///
86/// Returns a [`SqlglotError`] if parsing fails.
87pub fn transpile_statements(
88    sql: &str,
89    read_dialect: Dialect,
90    write_dialect: Dialect,
91) -> errors::Result<Vec<String>> {
92    let stmts = parser::parse_statements(sql, read_dialect)?;
93    let mut results = Vec::with_capacity(stmts.len());
94    for stmt in &stmts {
95        let transformed = dialects::transform(stmt, read_dialect, write_dialect);
96        results.push(generate(&transformed, write_dialect));
97    }
98    Ok(results)
99}
sqlglot_rust/lib.rs

sqlglot_rust/
lib.rs
