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

sqlglot_rust/
lib.rs
