crepedb 0.1.4

An versioned and forkable embedded Key-Value database.
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

# CrepeDB

An versioned and forkable embedded Key-Value database. It aims to used as storage of blockchain.

## Supported Features

- Create shopshots based on any snapshot.
- Read data based on any snapshot.
- All snapshots are organized into this tree.
- Table can be Versioned and Basic(No snapshot).
- Versioned and Basic table at one transaction.
- High-performance reads and inserts
- Multi backend support.
- [ ] Provide tools for analyzing databases, migrating, and managing data. (WIP)

## backends

For now, CrepeDB supports these backend:

- [x] redb
- [ ] mdbx
- [ ] sled
- [ ] rocksdb
- [ ] leveldb

## Usage

### Crates

If you want to use this crate, please add `crepedb` and a backend what you want
to use.

```bash
cargo add crepedb 
cargo add crepedb-redb # replace backend crate you want to use.
```

### Usage

```rust
use crepedb::CrepeDB;
use crepedb_redb::RedbDatabase;

let backend = RedbDatabase::memory().unwarp();
let db = CrepeDB::new(backend);
```

### Read snapshot

You can use `crepedb` command line to read database. Reference to [tool](https://github.com/tiannian/crepedb/tree/main/tool).