Struct DB
🔧
🔩
Provides a drop-in, fast, and embedded database solution, focusing on maintaining coherence between Rust types and stored data with minimal boilerplate. It supports multiple indexes, real-time watch with filters, schema migration, enjoy
Features
- Fast as the storage engine you choose (redb, IndexDB planned*).
- Embedded database (Linux, macOS, Windows, Android, iOS, WebBrowser WASM planned*).
- Support multiple indexes (unique secondary keys).
- Compatible with all Rust types (
enum,struct,tupleetc.). - Query data (
get,watch,iteretc.) using explicit type or type inference. - Real-time subscription with filters for
insert,updateanddeleteoperations. - Schema migration using native Rust coercion.
- Fully ACID-compliant transactions.
- Add your own serialization/deserialization logic planned* (e.g: zero-copy).
- Thread-safe.
- Plus, all features depending on the storage engine you choose:
Status
Early development. Not ready for production.
How to use?
See docs.rs.
Example
use serde::{Deserialize, Serialize};
use struct_db::*;
#[derive(Serialize, Deserialize, PartialEq, Debug)]
#[struct_db(
fn_primary_key(p_key), // required
fn_secondary_key(s_key), // optional
// ... other fn_secondary_key ...
)]
struct Data(u32, String);
impl Data {
// Returns primary key as big-endian bytes for consistent lexicographical ordering.
pub fn p_key(&self) -> Vec<u8> {
self.0.to_be_bytes().to_vec()
}
// Generates a secondary key combining the String field and the big-endian bytes of
// the primary key for versatile queries.
pub fn s_key(&self) -> Vec<u8> {
let mut s_key = self.1.as_bytes().to_vec();
s_key.extend_from_slice(&self.p_key().as_slice());
s_key
}
}
fn main() {
let mut db = Db::init_tmp("my_db_example").unwrap();
// Initialize the schema
db.define::<Data>();
// Insert data
let txn = db.transaction().unwrap();
{
let mut tables = txn.tables();
tables.insert(&txn, Data(1,"red".to_string())).unwrap();
tables.insert(&txn, Data(2,"red".to_string())).unwrap();
tables.insert(&txn, Data(3,"blue".to_string())).unwrap();
}
txn.commit().unwrap();
let txn_read = db.read_transaction().unwrap();
let mut tables = txn_read.tables();
// Retrieve data with p_key=3
let retrieve_data: Data = tables.primary_get(&txn_read, &3_u32.to_be_bytes()).unwrap().unwrap();
println!("data p_key='3' : {:?}", retrieve_data);
// Iterate data with s_key="red" String
for item in tables.secondary_iter_start_with::<Data>(&txn_read, DataKey::s_key, "red".as_bytes()).unwrap() {
println!("data s_key='1': {:?}", item);
}
// Remove data
let txn = db.transaction().unwrap();
{
let mut tables = txn.tables();
tables.remove(&txn, retrieve_data).unwrap();
}
txn.commit().unwrap();
}
Roadmap
The following features are planned before the 1.0 release
- Stabilize the wording, if you have any suggestion follow this issue
🙏 . - Add benchmarks tests.
- Add documentation.
- Stable release of redb or implement another stable storage engine(s) for Linux, macOS, Windows, Android, iOS.
- Add support for IndexDB (WebBrowser).
- Add support for custom serialization/deserialization logic.
- Add CI for Linux, macOS, Windows, Android, iOS, WebBrowser.
Contributors
 Akshith Madhur |
11 Dec 15, 2022
5 Jan 9, 2023
6 Jan 29, 2023
9 Mar 25, 2023
7 Mar 4, 2024
38 Jan 2, 2024
4 Nov 29, 2022
2 Oct 1, 2022
12 Jun 15, 2023
81 Dec 27, 2022
116 Dec 27, 2022
2 Jan 6, 2022
3 May 19, 2023
8 May 27, 2023
6 Sep 25, 2023
7 May 5, 2024
101 Nov 12, 2022
2 Mar 9, 2022
11 Dec 10, 2022
5 Jun 20, 2023
3 May 3, 2022
4 Jun 8, 2022
3 Jan 22, 2022
7 Sep 11, 2022
0 Feb 3, 2022
7 Aug 11, 2022
2 Oct 2, 2022