Docs/Installation

Installation & Dependency Setup

MagnumDB is published as a Rust crate on crates.io. You can add it directly to your Rust application using Cargo.

1. Cargo CLI Installation

Run the following command inside your Rust project directory:

bash

$ cargo add magnumdb@=0.4.8

2. Manual Cargo.toml Configuration

Alternatively, add magnumdb directly to your Cargo.toml manifest:

Cargo.toml

toml

[dependencies]
magnumdb = "0.4.8"
anyhow = "1.0"

3. Basic Sanity Check

Verify database engine initialization in your src/main.rs:

src/main.rs

rust

1
2
3
4
5
6
7
8
use magnumdb::{Config, Database};

fn main() -> anyhow::Result<()> {
    let config = Config::default().with_path("./test_db");
    let mut db = Database::open(config)?;
    println!("MagnumDB v0.4.8 initialized successfully.");
    Ok(())
}

Overview Quick Start Tutorial