grafeo_engine/
lib.rs

1//! # grafeo-engine
2//!
3//! The engine behind Grafeo. You'll find everything here for creating databases,
4//! running queries, and managing transactions.
5//!
6//! Most users should start with the main `grafeo` crate, which re-exports the
7//! key types. If you're here directly, [`GrafeoDB`] is your entry point.
8//!
9//! ## Modules
10//!
11//! - [`database`] - Create and manage databases with [`GrafeoDB`]
12//! - [`session`] - Lightweight handles for concurrent access
13//! - [`config`] - Tune memory, threads, and durability settings
14//! - [`transaction`] - MVCC transaction management (snapshot isolation)
15//! - [`query`] - The full query pipeline: parsing, planning, optimization, execution
16//! - [`catalog`] - Schema metadata: labels, property keys, indexes
17//! - [`admin`] - Admin API types for inspection, backup, and maintenance
18
19#![deny(unsafe_code)]
20
21/// The version of the grafeo-engine crate (from Cargo.toml).
22pub const VERSION: &str = env!("CARGO_PKG_VERSION");
23
24pub mod admin;
25pub mod catalog;
26#[cfg(feature = "cdc")]
27pub mod cdc;
28pub mod config;
29pub mod database;
30#[cfg(feature = "embed")]
31pub mod embedding;
32pub mod execution;
33pub mod export;
34pub mod memory_usage;
35#[cfg(feature = "metrics")]
36pub mod metrics;
37#[cfg(feature = "algos")]
38pub mod procedures;
39pub mod query;
40pub mod session;
41pub mod transaction;
42
43pub use admin::{
44    AdminService, CompactionStats, DatabaseInfo, DatabaseMode, DatabaseStats, DumpFormat,
45    DumpMetadata, IndexInfo, LpgSchemaInfo, RdfSchemaInfo, SchemaInfo, ValidationError,
46    ValidationResult, ValidationWarning, WalStatus,
47};
48pub use catalog::{Catalog, CatalogError, IndexDefinition, IndexType};
49pub use config::{AccessMode, Config, ConfigError, DurabilityMode, GraphModel};
50pub use database::GrafeoDB;
51pub use grafeo_core::graph::{GraphStore, GraphStoreMut};
52pub use memory_usage::MemoryUsage;
53#[cfg(feature = "metrics")]
54pub use metrics::{MetricsRegistry, MetricsSnapshot};
55pub use session::Session;
56#[cfg(feature = "lpg")]
57pub use transaction::{CommitInfo, PreparedCommit};
grafeo_engine/lib.rs

grafeo_engine/
lib.rs
