Skip to main content

reddb_server/storage/query/
mod.rs

1//! Query Engine for RedDB
2//!
3//! Provides query execution, filtering, sorting, and similarity search
4//! capabilities for the RedDB storage engine.
5//!
6//! # Components
7//!
8//! - **filter**: Filter predicates (Eq, Lt, Gt, Between, Like, etc.)
9//! - **sort**: Sorting and ordering operations
10//! - **executor**: Query plan execution
11//! - **similarity**: Vector similarity search integration
12//! - **modes**: Multi-mode query parsing (SQL, Gremlin, Cypher, SPARQL, Natural Language)
13//!
14//! # Multi-Mode Parsing
15//!
16//! The query engine supports multiple query languages with automatic mode detection:
17//!
18//! ```ignore
19//! use reddb::storage::query::modes::{parse_multi, detect_mode, QueryMode};
20//!
21//! // Gremlin
22//! let gremlin = parse_multi("g.V().hasLabel('host').out('connects')").unwrap();
23//!
24//! // SPARQL
25//! let sparql = parse_multi("SELECT ?host WHERE { ?host :hasIP ?ip }").unwrap();
26//!
27//! // Natural language
28//! let natural = parse_multi("find all hosts with ssh open").unwrap();
29//! ```
30//!
31//! # Example
32//!
33//! ```ignore
34//! use reddb::storage::query::{Query, Filter, OrderBy, Direction};
35//!
36//! let query = Query::select("users")
37//!     .filter(Filter::eq("status", "active"))
38//!     .filter(Filter::gt("age", 18))
39//!     .order_by("created_at", Direction::Desc)
40//!     .limit(10);
41//!
42//! let results = executor.execute(&query)?;
43//! ```
44
45pub mod analyze_cmd;
46pub mod analyzer;
47pub mod ast;
48pub mod batch;
49pub mod binary;
50pub mod engine;
51pub mod evaluator;
52pub mod executor;
53pub mod executors;
54pub mod expr_typing;
55pub mod filter;
56pub mod filter_compiled;
57pub mod filter_optimizer;
58pub mod lexer;
59pub mod modes;
60pub mod optimizer;
61pub mod parser;
62pub mod planner;
63pub mod rag;
64pub mod renderer;
65pub mod similarity;
66pub mod sort;
67pub mod sql;
68pub mod sql_lowering;
69pub mod step;
70#[cfg(test)]
71pub(crate) mod test_support;
72pub mod unified;
73pub(crate) mod value_compare;
74
75// Re-export common types
76pub use crate::storage::schema::{SqlTypeName, TypeModifier};
77pub use analyzer::{
78    analyze_create_table, resolve_declared_data_type, resolve_sql_type_name, AnalysisError,
79    AnalyzedColumnDef, AnalyzedCreateTableQuery,
80};
81pub use ast::{
82    AlterOperation, AlterQueueQuery, AlterTableQuery, AlterUserAttribute, AlterUserStmt, CompareOp,
83    CreateColumnDef, CreateQueueQuery, CreateTableQuery, CreateTimeSeriesQuery, CreateTreeQuery,
84    CteDefinition, CteQueryBuilder, DeleteQuery, DropCollectionQuery, DropDocumentQuery,
85    DropGraphQuery, DropKvQuery, DropQueueQuery, DropTableQuery, DropTimeSeriesQuery,
86    DropTreeQuery, DropVectorQuery, EdgeDirection, EdgePattern, FieldRef, Filter as AstFilter,
87    GrantObject, GrantObjectKind, GrantPrincipalRef, GrantStmt, GraphCommand, GraphPattern,
88    GraphQuery, InsertEntityType, InsertQuery, JoinCondition, JoinQuery, JoinType, NodePattern,
89    NodeSelector, OrderByClause, PathQuery, PolicyPrincipalRef, PolicyResourceRef, PolicyUserRef,
90    Projection, QueryExpr, QueryWithCte, RevokeStmt, SearchCommand, SelectItem, TableQuery,
91    TreeCommand, TreeNodeSpec, TreePosition, UpdateQuery, WithClause,
92};
93pub use engine::{
94    Binding, BindingBuilder, BindingIterator, Op, OpBGP, OpDisjunction, OpDistinct, OpExtend,
95    OpFilter, OpGroup, OpJoin, OpLeftJoin, OpMinus, OpNull, OpOrder, OpProject, OpReduced,
96    OpSequence, OpSlice, OpTable, OpTransform, OpTriple, OpUnion, OpVisitor, Pattern, QueryEngine,
97    QueryEngineFactory, QueryEngineRegistry, QueryIter, QueryIterBase, QueryIterFilter,
98    QueryIterJoin, QueryIterProject, QueryIterSlice, QueryIterSort, QueryIterUnion, TransformCopy,
99    TransformPushFilter, Triple, Var,
100};
101pub use executor::{QueryExecutor, QueryPlan, QueryResult};
102pub use executors::{
103    CteContext, CteExecutor, CteStats, ExecuteResult, GremlinExecutor, MultiModeExecutor,
104    NaturalExecutor, SparqlExecutor,
105};
106pub use filter::{Filter, FilterOp, Predicate};
107pub use lexer::{Lexer, LexerError, Position, Spanned, Token};
108pub use optimizer::{
109    ColumnStats, FilterRanker, RankedFilter, RankingConfig, StatsCollector, TableStats,
110};
111pub use parser::{parse, ParseError, Parser};
112pub use planner::{
113    CacheStats, CachedPlan, CardinalityEstimate, CostEstimator, OptimizationPass, PlanCache,
114    PlanCost, QueryOptimizer, QueryPlan as PlannerQueryPlan, QueryPlanner, QueryRewriter,
115    RewriteContext, RewriteRule,
116};
117pub use rag::{
118    ChunkSource, ContextChunk, EntityType, MultiSourceRetriever, QueryAnalysis, QueryIntent,
119    RagConfig, RagEngine, RetrievalContext, RetrievalStrategy, SimilarEntity,
120};
121pub use similarity::{SimilarityQuery, SimilarityResult};
122pub use sort::{Direction, NullsOrder, OrderBy, QueryLimits, SortKey};
123pub use sql::{parse_frontend, FrontendStatement, SqlCommand, SqlStatement};
124pub use step::{
125    AggregateStep, BarrierStep, BasicTraversal, BranchStep, ChooseStep, CollectingBarrierStep,
126    DedupStep, Direction as TraversalDirection, EdgeSourceStep, EdgeStep, ExecutionMode,
127    FilterStep, FlatMapStep, FoldStep, GroupStep, HasStep, IdStep, LimitStep, LoopState, MapStep,
128    OptionalStep, OrderStep, Path, PathStep, Predicate as StepPredicate, ProjectStep, PropertyStep,
129    RangeStep, ReducingBarrierStep, RepeatStep, SelectStep, SideEffectStep, SourceStep, Step,
130    StepPosition, StepResult, StoreStep, Traversal, TraversalParent, Traverser, TraverserGenerator,
131    TraverserRequirement, TraverserValue, UnionStep, ValueMapStep, VertexSourceStep, VertexStep,
132    WhereStep,
133};
134pub use unified::{
135    ExecutionError, GraphPath, MatchedEdge, MatchedNode, QueryStats, UnifiedExecutor,
136    UnifiedRecord, UnifiedResult,
137};
138
139/// Returns true when the table source should be interpreted as the universal entity
140/// space (table, document, graph, vector mixed mode).
141pub fn is_universal_entity_source(table: &str) -> bool {
142    table.eq_ignore_ascii_case("any")
143        || table.eq_ignore_ascii_case("_any")
144        || table.eq_ignore_ascii_case("all")
145        || table.eq_ignore_ascii_case("entity")
146        || table.eq_ignore_ascii_case("universal")
147        || table.eq_ignore_ascii_case("mixed")
148        || table == "*"
149}