cai_query/lib.rs
1//! CAI Query - SQL parser and query engine
2//!
3//! Provides SQL-like query interface for CAI entries with support for:
4//! - SELECT with WHERE, ORDER BY, LIMIT, GROUP BY
5//! - SHOW TABLES - list available tables
6//! - DESCRIBE table_name - show table schema
7//! - Built-in functions: date_format, concat, length, upper, lower, substring, coalesce, now
8//! - Function registry for extensible SQL functions
9//!
10//! # Example
11//!
12//! ```rust,no_run
13//! use cai_query::{QueryEngine, sql};
14//! use cai_storage::MemoryStorage;
15//!
16//! # async fn example() -> Result<(), Box<dyn std::error::Error>> {
17//! let storage = MemoryStorage::new();
18//! let engine = QueryEngine::new(storage);
19//!
20//! // Simple SELECT
21//! let _results = engine.execute("SELECT * FROM entries LIMIT 10").await?;
22//!
23//! // Show tables
24//! let _results = engine.execute("SHOW TABLES").await?;
25//!
26//! // Describe table
27//! let _results = engine.execute("DESCRIBE entries").await?;
28//! # Ok(())
29//! # }
30//! ```
31
32#![warn(missing_docs, unused_crate_dependencies)]
33
34pub use cai_core::Result;
35
36mod error;
37mod eval;
38mod executor;
39mod functions;
40mod parser;
41
42pub use error::{ColumnInfo, QueryError, QueryResult, SchemaInfo, SchemaQueryType};
43pub use executor::{QueryEngine, QueryResultData};
44pub use functions::{FunctionArg, FunctionRegistry};
45pub use parser::{parse, QueryType};
46
47/// Convenience function to execute a SQL query
48///
49/// # Example
50///
51/// ```rust,no_run
52/// use cai_query::sql;
53/// use cai_storage::MemoryStorage;
54///
55/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
56/// let storage = MemoryStorage::new();
57/// let _results = sql("SELECT * FROM entries", storage).await?;
58/// # Ok(())
59/// # }
60/// ```
61pub async fn sql<S>(query: &str, storage: S) -> QueryResult<Vec<cai_core::Entry>>
62where
63 S: cai_storage::Storage + 'static,
64{
65 QueryEngine::new(storage).execute(query).await
66}