hirn-engine 0.1.0

Engine for the hirn cognitive memory database
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

//! HirnQL — the query language for hirn cognitive memory operations.
//!
//! Provides parsing, semantic analysis, planning, and execution of
//! declarative memory queries.
//!
//! # Compilation Pipeline
//!
//! ```text
//! HirnQL text → Parser → AST → Semantic analysis → Query planner → Physical plan → Execute
//! ```
//!
//! Each stage is independently testable. Plans are cacheable via `PlanCache`.
//!
//! # Example
//! ```ignore
//! // Preferred public entrypoint:
//! let result = db.ql().execute(r#"RECALL episodic ABOUT "test" LIMIT 5"#).await?;
//!
//! // Prepared statements stay on the same execution bridge:
//! let prepared = db.ql().prepare(r#"RECALL episodic ABOUT $1 LIMIT 5"#)?;
//! let result = db.ql().execute_prepared(&prepared, &params).await?;
//! ```

pub use hirn_query::ast;
pub use hirn_query::parser;

pub mod analyzer;
pub mod builder;
pub mod compiler;
pub mod context;
pub(crate) mod direct_support;
pub mod planner;
pub(crate) mod read_support;
pub(crate) mod results;

pub use analyzer::{AnalysisError, AnalysisErrorKind, analyze};
pub use ast::Statement;
pub use compiler::{
    CompileError, CompiledQuery, PlanCache, PreparedStatement, bind, compile, prepare,
};
pub use parser::{ParseError, parse};
pub use planner::{QueryPlan, plan};
pub use results::{
    AggregatedGroup, AggregatedResults, CausalQueryKind, CausalQueryResult, CausalRow,
    ConsolidatedResult, CorrectedResult, CreatedResult, ExplainResult, ForgottenResult,
    HistoryResult, MergedResult, PolicyResult, ProjectedRecord, QueryResult, RecordResults,
    RetractedResult, ScoreBreakdown, ScoredMemory, SemanticHistoryItem, SemanticRevisionEntry,
    SemanticRevisionSummary, SupersededResult, SvoEventResult, SvoEventResults, WatchAckResult,
    revision_query_result_to_json,
};