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

core_api/
lib.rs
