Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

From crates.io (once published)

cargo add opendb

From source

  1. Clone the repository:
git clone https://github.com/muhammad-fiaz/OpenDB.git
cd OpenDB
  1. Build the project:
cargo build --release
  1. Run tests:
cargo test
  1. Run examples:
cargo run --example quickstart
cargo run --example memory_agent
cargo run --example graph_relations

Requirements

  • Rust: 1.70.0 or higher (Rust 2021 edition)
  • Operating System: Linux, macOS, or Windows
  • Dependencies: All dependencies are managed by Cargo

System Dependencies

OpenDB uses RocksDB as its storage backend, which requires:

  • Linux: gcc, g++, make, libsnappy-dev, zlib1g-dev, libbz2-dev, liblz4-dev
  • macOS: Xcode command line tools
  • Windows: Visual Studio Build Tools

Linux Setup

# Ubuntu/Debian
sudo apt-get install -y gcc g++ make libsnappy-dev zlib1g-dev libbz2-dev liblz4-dev

# Fedora/RHEL
sudo dnf install -y gcc gcc-c++ make snappy-devel zlib-devel bzip2-devel lz4-devel

macOS Setup

xcode-select --install

Windows Setup

Install Visual Studio Build Tools

Verifying Installation

cargo test --all

All tests should pass. If you encounter issues, please check:

  1. Rust version: rustc --version
  2. Build dependencies are installed
  3. Open an issue if problems persist