alopex_sql/
lib.rs

1//! SQL parser and planning components for the Alopex DB SQL dialect.
2//!
3//! This crate provides:
4//!
5//! - **Parser**: SQL parsing into an AST via the Nim FFI parser
6//! - **Catalog**: Table and index metadata management
7//! - **Planner**: AST to logical plan conversion with type checking
8//!
9//! # Quick Start
10//!
11//! ```
12//! use alopex_sql::{Parser, AlopexDialect};
13//! use alopex_sql::catalog::MemoryCatalog;
14//! use alopex_sql::planner::Planner;
15//!
16//! // Parse SQL using the convenience method
17//! let sql = "CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT)";
18//! let dialect = AlopexDialect::default();
19//! let stmts = Parser::parse_sql(&dialect, sql).unwrap();
20//! let stmt = &stmts[0];
21//!
22//! // Plan with catalog
23//! let catalog = MemoryCatalog::new();
24//! let planner = Planner::new(&catalog);
25//! let plan = planner.plan(stmt).unwrap();
26//! ```
27
28pub mod ast;
29#[cfg(feature = "async")]
30pub mod async_api;
31pub mod catalog;
32pub mod columnar;
33pub mod dialect;
34pub mod error;
35pub mod executor;
36mod nim_bridge;
37mod nim_ffi;
38pub mod parser;
39pub mod planner;
40pub mod scalar;
41pub mod storage;
42#[cfg(all(feature = "tokio", not(target_arch = "wasm32")))]
43pub mod tokio_adapter;
44pub mod unified_error;
45
46// AST types
47pub use ast::{
48    PragmaValue, Statement, StatementKind,
49    ddl::*,
50    dml::*,
51    expr::*,
52    span::{Location, Span, Spanned},
53};
54
55// Dialect and parser types
56pub use dialect::{AlopexDialect, Dialect};
57pub use error::{ParserError, Result};
58pub use parser::Parser;
59pub use unified_error::SqlError;
60
61// Catalog types (re-exported for convenience)
62pub use catalog::persistent::{CatalogOverlay, DataSourceFormat, TableType};
63pub use catalog::{
64    Catalog, ColumnMetadata, Compression, IndexMetadata, MemoryCatalog, RowIdMode, StorageOptions,
65    StorageType, TableMetadata,
66};
67
68// Planner types (re-exported for convenience)
69pub use planner::{
70    LogicalPlan, NameResolver, PlannedStatement, Planner, PlannerError, PlanningDiagnostic,
71    PlanningDiagnosticSeverity, ProjectedColumn, Projection, ResolvedColumn, ResolvedType,
72    RoutingInput, SortExpr, TableReference, TableReferenceAccess, TableReferenceExtractor,
73    TableReferenceSource, TypeChecker, TypedAssignment, TypedExpr, TypedExprKind,
74    plan_sql_for_routing, plan_statement_for_routing,
75};
76
77// Storage types
78#[cfg(feature = "tokio")]
79pub use storage::ErasedAsyncSqlTransaction;
80pub use storage::{
81    IndexScanIterator, IndexStorage, KeyEncoder, RowCodec, SqlTransaction, SqlValue, StorageError,
82    TableScanIterator, TableStorage, TxnBridge, TxnContext,
83};
84
85// Executor types
86#[cfg(feature = "tokio")]
87pub use executor::AsyncExecutor;
88pub use executor::{
89    ColumnInfo, ConstraintViolation, EvaluationError, ExecutionResult, Executor, ExecutorError,
90    QueryResult, Row,
91};
92
93// Async facade types
94#[cfg(feature = "async")]
95pub use async_api::{AsyncResult, AsyncRowStream, AsyncSqlTransaction, AsyncTxnBridge};
96#[cfg(all(feature = "tokio", not(target_arch = "wasm32")))]
97pub use tokio_adapter::{TokioAsyncSqlTransaction, TokioAsyncTxnBridge};
98
99/// `ExecutionResult` の公開 API 名。
100pub type SqlResult = ExecutionResult;
101
102#[cfg(test)]
103mod integration;
alopex_sql/lib.rs

alopex_sql/
lib.rs
