core_api/
lib.rs

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

core_api/
lib.rs
