shorterDB 0.2.0

A lightweight embedded key-value store built with SkipLists and LSM architecture
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

# ShorterDB

A high-performance, embedded key-value store for Rust, built with a Log-Structured Merge-Tree (LSM-Tree) architecture.

[![Crates.io](https://img.shields.io/crates/v/shorterdb.svg)](https://crates.io/crates/shorterdb)
[![Documentation](https://docs.rs/shorterdb/badge.svg)](https://docs.rs/shorterdb)
[![License](https://img.shields.io/crates/l/shorterdb.svg)](https://github.com/Hrefto/shorterdb/blob/main/LICENSE)

## Features

- **Embedded**: Runs directly in your application process (no external server required).
- **Persistent**: Data is durably stored using a Write-Ahead Log (WAL) and SSTables.
- **Fast**: In-memory writers using lock-free SkipLists.
- **Simple API**: Minimalistic `get`, `set`, and `delete` interface.
- **Thread-Safe**: Designed for concurrent access.

## Installation

Add this to your `Cargo.toml`:

```toml
[dependencies]
shorterDB = "0.2.0"
```

## Quick Start

```rust
use shorterdb::ShorterDB;
use std::path::Path;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Open the database (creates directory if missing)
    let mut db = ShorterDB::new(Path::new("/tmp/my_db"))?;

    // Store a key-value pair
    db.set(b"username", b"ferris")?;

    // Retrieve the value
    if let Some(value) = db.get(b"username")? {
        println!("Found user: {}", String::from_utf8_lossy(&value));
    }

    // Delete the key
    db.delete(b"username")?;

    Ok(())
}
```

## Architecture

ShorterDB uses a classic LSM-Tree design with a Memtable, Write-Ahead Log, and background Flusher.

For deep technical details on the internal design, file formats, and ACID guarantees, see [ARCHITECTURE.md](ARCHITECTURE.md).

## Examples

The project workspace includes examples you can run locally:

```bash
# Basic embedded usage
cargo run -p examples --bin embedded

# Interactive REPL
cargo run -p examples --bin repl
```

## License

Licensed under either of [Apache License, Version 2.0](https://github.com/Hrefto/shorterdb/blob/main/LICENSE) or [MIT license](https://github.com/Hrefto/shorterdb/blob/main/LICENSE) at your option.