laminar_sql/
lib.rs

1//! LaminarDB SQL parser, planner, and DataFusion integration.
2
3#![deny(missing_docs)]
4#![warn(clippy::all, clippy::pedantic)]
5#![allow(clippy::duration_suboptimal_units)] // MSRV 1.85; from_mins/from_hours are 1.91+
6#![allow(clippy::module_name_repetitions)]
7#![allow(clippy::disallowed_types)] // cold path: SQL parsing and query planning only
8#![allow(clippy::doc_markdown)]
9#![allow(clippy::uninlined_format_args)]
10
11pub mod datafusion;
12pub mod error;
13pub mod parser;
14pub mod planner;
15pub mod translator;
16
17// Re-export key types
18pub use parser::{parse_streaming_sql, StreamingStatement};
19pub use planner::streaming_optimizer::{StreamingPhysicalValidator, StreamingValidatorMode};
20pub use planner::StreamingPlanner;
21pub use translator::{OrderOperatorConfig, WindowOperatorConfig, WindowType};
22
23// Re-export types
24pub use datafusion::execute::execute_streaming_sql;
25pub use datafusion::{
26    base_session_config, create_session_context, create_streaming_context_with_validator,
27    register_streaming_functions, register_streaming_functions_with_watermark, DdlResult,
28    QueryResult, StreamingSqlResult,
29};
30
31/// Result type for SQL operations
32pub type Result<T> = std::result::Result<T, Error>;
33
34/// SQL-specific errors
35#[derive(Debug, thiserror::Error)]
36pub enum Error {
37    /// SQL parsing error
38    ParseError(#[from] parser::ParseError),
39
40    /// Planning error
41    PlanningError(#[from] planner::PlanningError),
42
43    /// `DataFusion` error (translated to user-friendly messages on display)
44    DataFusionError(#[from] datafusion_common::DataFusionError),
45
46    /// Unsupported SQL feature
47    UnsupportedFeature(String),
48}
49
50impl std::fmt::Display for Error {
51    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
52        match self {
53            Self::ParseError(e) => write!(f, "SQL parse error: {e}"),
54            Self::PlanningError(e) => write!(f, "Planning error: {e}"),
55            Self::DataFusionError(e) => {
56                let translated = error::translate_datafusion_error(&e.to_string());
57                write!(f, "{translated}")
58            }
59            Self::UnsupportedFeature(msg) => {
60                write!(f, "Unsupported feature: {msg}")
61            }
62        }
63    }
64}
laminar_sql/lib.rs

laminar_sql/
lib.rs
