Skip to main content Crate core_api Copy item path Source pub use algo::AlgoDir ;pub use algo::DegreeConfig ;pub use algo::DegreeReport ;pub use algo::LouvainConfig ;pub use algo::WccConfig ;pub use algo::WccReport ;pub use history::EdgeEvent ;pub use history::EdgeHistoryEvent ;pub use history::HistoryChange ;pub use history::HistoryEntry ;pub use history::HistoryResult ;pub use mask::MaskMode ;pub use mask::NodeMask ;pub use mask::RoleMaskCache ;pub use reader::CommitDelta ;pub use reader::FrozenOverlay ;pub use reader::ReaderSnapshot ;pub use reader::FOLD_EVERY_K ;pub use roles::PropPredicate ;pub use roles::RoleDef ;pub use roles::WriteScope ;pub use schema::Schema ;pub use schema::SchemaDiff ;pub use subscription::DbEvent ;pub use subscription::Subscription ;pub use subscription::DEFAULT_SUB_CAPACITY ;algo Graph algorithms: PageRank, weakly-connected components, degree centrality. history mask reader Lock-free MVCC epoch readers. repograph Reading a code graph back as answers. roles RBAC role definitions and sidecar I/O. schema Declarative schema-as-code for mushroomdb. subscription Post-commit subscription API. BackupReport Report returned by GraphDb::backup_to BatchBuilder Collects mutations and commits them as one WAL Batch frame. BuildProgress How far a rule’s vector index has got, for a rule whose build did not fit
in one commit. DeleteReport Counts returned by GraphDb::delete_node EdgeAt One directed edge incident on a node at a point in WAL history, with the
rule that derived it when it is rule-owned. EdgeInfo One directed edge incident on a node, with provenance membership. Explanation One rule-owned edge between two nodes, with the rule name, edge type,
direction (src_key → dst_key), and weight if the rule stores one. ExportEdge One directed edge in export form, with optional rule attribution for derived edges. FkSkip One auto-FK field that was not turned into a rule. GraphDb IngestOptions Options for GraphDb::ingest IngestReport Outcome of one GraphDb::ingestErr means nothing was applied. JsonRows Parsed JSON rows ready for crate::GraphDb::ingest MaskedEdge An edge with mask-aware endpoint visibility. NamespaceStats Live node count for one namespace; one entry of Stats::namespaces NodeInfo Snapshot of a live node’s key, label, and columnar properties. NodeRef OpenOptions Options for GraphDb::open_with_options PredicateSummary Wire summary of a PredicateExplanation is never
bincode-persisted (WAL/snapshots store RuleDef bytes, not this type). RealFs ResultSet RuleDef RuleStats One rule’s provenance size, trip latch, and fire counter. RuleSuggestion One suggested rule with estimated edge count, example pairs, and rationale. SharedDb Shared handle to an on-disk GraphDbClone SlowQueryEntry One entry in the slow-query ring buffer. SlowQuerySnapshot Snapshot of the slow-query log returned by GraphDb::slow_query_snapshot SnapshotOptions Options for GraphDb::snapshot_with Stats Database-wide counters plus per-rule budget/fire stats. SuggestConfig Tuning parameters for suggest_rules SuggestReport Result of suggest_rules ViewDef ViewStore WhatIf The derived edges a hypothetical property change would retract and derive. WriteAuthz Authorization context carried by write_batch_authz / query_write_authz. WriteGuard Compound write guard returned by SharedDb::write AggFn AsOfScope How an as-of read is restricted — the argument to
GraphDb::query_at_scoped AutoFk Zero-config FK inference: declare a KeyMatch rule per *_id field, or skip. BatchOp Queued mutation for a BatchBuilderGraphDb::commit_group CmpOp Dir Direction Filter FsyncPolicy When GraphDbFs::sync after a WAL append. GraphError MaskedNodeResult Result of a mask-aware node lookup via GraphDb::node_info_masked MutationEvent A post-commit mutation notification. Precondition A precondition for a compare-and-set batch write. Predicate Score-combination conventions for composed predicates: Value ViewSource DEFAULT_KEYMATCH_TOP_K Per-source top-k when a KeyMatch-rooted rule omits max_edges. DEFAULT_SCORED_TOP_K Per-source top-k when a scored (non-KeyMatch-rooted) rule omits max_edges. HNSW_BUILD_BATCH Vectors inserted into one rule’s HNSW graph per build slice. create_rule
does one slice inline; pump_index_build does one slice per pending rule
per call. A corpus at or below this size is built in a single commit and
behaves exactly as it did before 0.6.6. MAX_CHAIN_DEPTH How many chained levels a single write may cascade through. NS_DEFAULT The namespace a node with no NS_PROP NS_MAX_LEN Longest accepted namespace name, in characters. NS_PROP The reserved property that names a node’s namespace. SNAPSHOT_VERSION Current on-disk snapshot format version written by this build. SUGGEST_DEFAULT_SEED Default seed for seeded sampling (hex encoding of “Mushroom”). WRITE_LOCK_WAIT How long a writer polls for the cross-process write lock before giving up
with GraphError::Busy default_max_edges Default RuleDef.max_edges for suggest, auto-FK, demo, and HTTP omit. is_keymatch_rooted KeyMatch itself, or All whose first element is KeyMatch-rooted.
Any is never KeyMatch-rooted — the FK fast-path does not apply to OR. is_write_query Return true if cypher is a write statement (CREATE / MERGE / MATCH…SET /
MATCH…DELETE). Returns Err only when the string fails to lex. json_to_rows Convert a parsed JSON value (must be an array of objects) into ingest rows. json_to_value Convert a JSON value to a stored Value snapshot_version_at Return the on-disk snapshot format version without decoding the full snapshot. valid_namespace A valid namespace name: 1–NS_MAX_LEN[A-Za-z0-9_.-]. verify_snapshot Validate the CRC32 integrity of every section in the V8 snapshot at dir. wal_commit_count_at Return the number of valid WAL commits in the database at dir. write_snapshot_bak Write bytes to snapshot.bin.bak atomically with full fsync. Result SectionVerifyResult One verification entry per section: (section_id, section_name, bytes_checked, result).