minigraf/src/lib.rs at v2.0.2 · project-minigraf/minigraf

Repository navigation

History

100

101

102

103

104

105

106

107

#![forbid(unsafe_code)]

#![warn(missing_docs)]

#![cfg_attr(

test,

allow(

clippy::unwrap_used,

clippy::expect_used,

clippy::panic,

clippy::indexing_slicing,

clippy::cast_possible_truncation,

clippy::cast_possible_wrap,

clippy::cast_sign_loss,

)

)]

#![cfg_attr(docsrs, feature(doc_cfg))]

//! Zero-config, single-file, embedded graph database with bi-temporal Datalog queries.

//!

//! Minigraf is the SQLite of graph databases: embedded, no server, no configuration,

//! a single portable `.graph` file. It stores data as Entity-Attribute-Value facts,

//! queries them with [Datalog](https://en.wikipedia.org/wiki/Datalog), and tracks every

//! change with full bi-temporal history (transaction time + valid time).

//!

//! # Installation

//!

//! ```toml

//! [dependencies]

//! minigraf = "0.21"

//! ```

//!

//! # Quick Start

//!

//! ```

//! use minigraf::{Minigraf, BindValue};

//!

//! // Open (or create) a database

//! let db = Minigraf::in_memory().unwrap();

//!

//! // Assert facts

//! db.execute(r#"(transact [[:alice :person/name "Alice"]

//! [:alice :person/age 30]

//! [:alice :friend :bob]

//! [:bob :person/name "Bob"]])"#).unwrap();

//!

//! // Query with Datalog

//! let results = db.execute(r#"

//! (query [:find ?friend-name

//! :where [:alice :friend ?friend]

//! [?friend :person/name ?friend-name]])

//! "#).unwrap();

//!

//! // Explicit transaction — all-or-nothing

//! let mut tx = db.begin_write().unwrap();

//! tx.execute(r#"(transact [[:alice :person/age 31]])"#).unwrap();

//! tx.commit().unwrap();

//!

//! // Time travel — query the state as of transaction 1

//! db.execute("(query [:find ?age :as-of 1 :where [:alice :person/age ?age]])").unwrap();

//! ```

//!

//! # Feature Flags

//!

//! | Feature | Target | Description |

//! |---------|--------|-------------|

//! | *(default)* | native / WASI | File-backed and in-memory databases; full Datalog engine |

//! | `browser` | `wasm32-unknown-unknown` | Enables the `browser` module (`BrowserDb`), backed by IndexedDB for use inside a web browser via `wasm-pack` |

//!

//! The `browser` feature is only meaningful on the `wasm32-unknown-unknown` target.

//! When browsing docs on [docs.rs](https://docs.rs/minigraf), switch the target to

//! `wasm32-unknown-unknown` (top-right target selector) to see the full browser API.

//!

//! ## WebAssembly targets

//!

//! - **Browser** (`wasm32-unknown-unknown` + `browser` feature) — `wasm-pack build --target web --features browser`

//! - **WASI / server-side** (`wasm32-wasip1`) — `cargo build --target wasm32-wasip1 --release --bin minigraf`

pub mod db;

pub mod error;

pub(crate) mod graph;

pub(crate) mod query;

/// Interactive REPL for exploring a [`Minigraf`] database from the command line.

pub mod repl;

pub(crate) mod storage;

pub(crate) mod temporal;

pub(crate) mod wal;

#[cfg(all(target_arch = "wasm32", feature = "browser"))]

#[cfg_attr(docsrs, doc(cfg(all(target_arch = "wasm32", feature = "browser"))))]

pub mod browser;

#[cfg(not(target_arch = "wasm32"))]

pub use db::OpenOptionsWithPath;

pub use db::{Minigraf, OpenOptions, SyncMode, WriteTransaction};

pub use error::{ErrorCategory, MinigrafError};

pub use repl::Repl;

// EAV value types — users construct and match on these

pub use graph::types::{EntityId, Value};

// Query result type

pub use query::datalog::executor::QueryResult;

// Bi-temporal query types

pub use query::datalog::types::{AsOf, ValidAt};

// Prepared statements

pub use query::datalog::prepared::{BindValue, PreparedQuery};

FilesExpand file tree

lib.rs

Latest commit

History

lib.rs

File metadata and controls