core_api/
lib.rs

1pub mod algo;
2mod db;
3pub mod history;
4mod ingest;
5pub mod mask;
6pub mod reader;
7pub mod roles;
8pub mod schema;
9mod shared;
10pub mod subscription;
11
12pub use algo::{
13    AlgoDir, DegreeConfig, DegreeReport, PageRankConfig, PageRankReport, WccConfig, WccReport,
14};
15pub use core_query::{CmpOp, Dir, Filter, ResultSet};
16pub use core_rules::suggest::DEFAULT_SEED as SUGGEST_DEFAULT_SEED;
17pub use core_rules::{
18    default_max_edges, is_keymatch_rooted, AggFn, Predicate, RuleDef, RuleSuggestion,
19    SuggestConfig, SuggestReport, ViewDef, ViewSource, ViewStore, DEFAULT_KEYMATCH_TOP_K,
20    DEFAULT_SCORED_TOP_K,
21};
22pub use core_storage::{Direction, GraphError, Result, Value};
23pub use db::{
24    snapshot_version_at, write_snapshot_bak, BackupReport, BatchBuilder, BatchOp, DeleteReport,
25    EdgeInfo, Explanation, ExportEdge, FsyncPolicy, GraphDb, MaskedEdge, MaskedNodeResult,
26    MutationEvent, NodeInfo, NodeRef, OpenOptions, Precondition, PredicateSummary, RuleStats,
27    SnapshotOptions, Stats, WriteAuthz,
28};
29
30/// Current on-disk snapshot format version written by this build.
31///
32/// Exposed so CLI and tooling can print `V<SNAPSHOT_VERSION>` without depending
33/// directly on `core-storage`.
34pub const SNAPSHOT_VERSION: u16 = core_storage::snapshot::VERSION;
35pub use history::{EdgeEvent, EdgeHistoryEvent, HistoryChange, HistoryEntry, HistoryResult};
36pub use ingest::{
37    json_to_rows, json_to_value, AutoFk, FkSkip, IngestOptions, IngestReport, JsonRows,
38};
39pub use mask::{MaskMode, NodeMask};
40pub use reader::{CommitDelta, FrozenOverlay, ReaderSnapshot, FOLD_EVERY_K};
41pub use roles::{RoleDef, WriteScope};
42pub use schema::{Schema, SchemaDiff};
43pub use shared::SharedDb;
44pub use subscription::{DbEvent, Subscription, DEFAULT_SUB_CAPACITY};
45
46/// One verification entry per section: `(section_id, section_name, bytes_checked, result)`.
47///
48/// Returned by [`verify_snapshot`].
49pub type SectionVerifyResult = (u8, &'static str, usize, std::result::Result<(), String>);
50
51/// Validate the CRC32 integrity of every section in the V8 snapshot at `dir`.
52///
53/// Returns one entry per section directory entry (see [`SectionVerifyResult`]).
54///
55/// Large sections (TOPOLOGY, COLUMNS, EDGE_PROPS, HNSW, PROVENANCE, IVF_STATE)
56/// skip CRC on the normal hot query path; this function always checks them.
57/// Use it to implement `mushroomdb verify` without depending on `core-storage`
58/// directly.
59pub fn verify_snapshot(dir: &std::path::Path) -> crate::Result<Vec<SectionVerifyResult>> {
60    let snap_path = dir.join("snapshot.bin");
61    let mapped = core_storage::v8::MappedBase::map(&snap_path)?;
62    // Bounds first, then per-section CRC32, then a structural (rkyv bytecheck)
63    // pass over the sections the hot path reads unchecked. The structural pass
64    // rejects a maliciously crafted snapshot whose relative pointers would
65    // otherwise trigger UB on open — a threat CRC32 alone can't catch (an
66    // attacker can recompute the CRC). Fail loud on structural corruption.
67    mapped.validate_section_bounds()?;
68    let results = mapped.verify_integrity();
69    mapped.validate_hot_sections()?;
70    Ok(results)
71}
72
73/// Return `true` if `cypher` is a write statement (CREATE / MERGE / MATCH…SET /
74/// MATCH…DELETE).  Returns `Err` only when the string fails to lex.
75///
76/// Used by the HTTP server to dispatch to the write lock without a full parse.
77pub fn is_write_query(cypher: &str) -> std::result::Result<bool, String> {
78    let toks = core_query::cypher::lex(cypher).map_err(|e| format!("lex: {e}"))?;
79    Ok(core_query::cypher::is_write_tokens(&toks))
80}
81
82/// Return the number of valid WAL commits in the database at `dir`.
83///
84/// Useful for displaying "as-of commit N of M" in CLIs without opening the
85/// full database.  Returns 0 if the WAL file does not exist (e.g., after
86/// `snapshot()` which truncates it to empty).
87pub fn wal_commit_count_at(dir: &std::path::Path) -> crate::Result<u64> {
88    let wal_path = dir.join("wal.bin");
89    let bytes = match std::fs::read(&wal_path) {
90        Ok(b) => b,
91        Err(e) if e.kind() == std::io::ErrorKind::NotFound => Vec::new(),
92        Err(e) => return Err(core_storage::GraphError::Io(e)),
93    };
94    Ok(core_storage::wal::wal_commits(&bytes))
95}
core_api/lib.rs

core_api/
lib.rs
