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

laminar_sql/
lib.rs
