a user-friendly wrapper for sanakirja database
sanakirja a key can have multiple values , this is different from the other k-v databases .
sanakirja author is Pierre-Étienne Meunier .
see Sanakirja 1.0 (pure Rust transactional on-disk key-value store) released!
Sanakirja is at least 10 times faster than Sled in my (sequential) benchmarks, and even 20%-50% faster than LMDB (the fastest C equivalent) in the same benchmarks. Also, I started it when there was no real alternative (Sled didn't exist at the time).
I wrapper it for easy use .
First step : static define db , see tests/db.rs
I use static_init = {git="https://gitlab.com/vkahl/static_init.git"}
for static init ( use git version because of bug ) . You can use lazy_static instead .
```rust use desse::{Desse, DesseSized}; use sdb::{desse, Db, DbEv, DbU, Encode, Sdb, Storable, Tx, UnsizedStorable}; use static_init::dynamic; use std::env; use std::path::Path;
pub static DIR: String = env::currentexe() .unwrap() .parent() .unwrap() .parent() .unwrap() .display() .tostring();
pub static TX: Tx = { let dir = Path::new(&*DIR).join("db");
println!("DATABASE DIR {}", dir.display().to_string());
//use sdb::SdbArgs::{InitSize, MaxTx, Filename};
Tx::new( &dir, &[ //MaxTx(3), //Filename("sdb"), //InitSize(1<<21), ], ) };
pub static DB0: Db<'static, u64, u64> = TX.db(0);
pub struct Hash(pub [u8; 2]);
pub static DB1: Db<'static, u64, Hash> = TX.db(1);
pub static DB2: DbU<'static, u64, [u8]> = TX.db(2);
pub static DB3: DbU<'static, [u8], [u8]> = TX.db(3);
pub struct Data { pub hash: [u8; 3], pub id: u64, }
pub static DB4: Db<'static, u64, Data> = TX.db(4);
pub struct Data2 { pub hash: [u8; 3], pub id: u64, }
desse!(Data2, Data2Desse); // the same as below
/*
Default, Eq, PartialEq, PartialOrd, Ord, Hash, Clone, Copy, Debug, DesseSized, Desse, )] pub struct Data2Desse([u8; Data2::SIZE]);
use sdb::directrepr; directrepr!(Data2Desse);
pub static DB5: DbEv<'static, u64, Data2Desse, Data2> = TX.db(5);
impl Encode
impl From<&Data2Desse> for Data2 { fn from(v: &Data2Desse) -> Self { Data2::deserialize_from(&v.0) } } */
pub static DB5: DbEv<'static, u64, Data2Desse, Data2> = TX.db(5);
```
Second step : use it , see tests/main.rs
```rust mod db; use anyhow::Result; use db::{Data, Data2, Hash, DB0, DB1, DB2, DB3, DB4, DB5, TX}; use sdb::UnsizedStorable;
fn main() -> Result<()> { println!("direct put"); DB0.put(&0, &0)?; DB0.put(&0, &1)?; DB0.put(&6, &1)?; DB0.put(&6, &2)?; DB0.put(&6, &3)?; println!("- print val where key = 6"); for entry in DB0.key_iter(&6)? { let (k, v) = entry?; println!("> {:?} {:?}", k, v) } DB0.rm1(&6, None)?;
{ println!("# write transaction"); let tx = TX.w()?; let mut db0 = tx.db(&DB0);
db0.put(&1, &5)?;
db0.put(&1, &3)?;
db0.put(&2, &2)?;
db0.put(&2, &1)?;
db0.put(&3, &7)?;
db0.put(&3, &9)?;
db0.put(&5, &1)?;
db0.put(&5, &9)?;
println!("- print all key db0");
for entry in db0.iter(None, None)? {
let (k, v) = entry?;
println!("> {:?} {:?}", k, v)
}
println!("- print db1 where key is 2");
for entry in db0.key_iter(&4)? {
let (k, v) = entry?;
println!("> {:?} {:?}", k, v)
}
println!("- delete key 2 the first value : {}", db0.rm1(&2, None)?);
println!("- delete key=2 and value=5 : {}", db0.rm1(&2, &5)?);
println!("- delete key 3 all value : delete number = {}", db0.rm(&3)?);
println!("- delete key 5 the first value : {}", db0.rm1(&5, None)?);
println!("- print all key");
for entry in db0.iter(None, None)? {
let (k, v) = entry?;
println!("> {:?} {:?}", k, v)
}
let mut db1 = tx.db(&DB1);
db1.put(&1, &Hash([1, 2]))?;
println!("- print all key db1");
for entry in db1.iter(None, None)? {
let (k, v) = entry?;
println!("> {:?} {:?}", k, v)
}
let mut db2 = tx.db(&DB2);
db2.put(&1, &[1, 2, 3][..])?;
db2.put(&2, &[4, 6][..])?;
println!("- print all key db2");
for entry in db2.iter(None, None)? {
let (k, v) = entry?;
println!("> {:?} {:?}", k, v)
}
let mut db3 = tx.db(&DB3);
db3.put(&[1, 2][..], &[1, 2, 3][..])?;
println!("- print all key db3");
for entry in db3.iter(None, None)? {
let (k, v) = entry?;
println!("> {:?} {:?}", k, v)
}
let mut db4 = tx.db(&DB4);
let data = Data {
id: 1234,
hash: [3, 2, 1],
};
println!("data size : {}", data.size());
db4.put(&1, &data)?;
println!("- print all key db4");
for entry in db4.iter(None, None)? {
let (k, v) = entry?;
println!("> {:?} {:?}", k, v)
}
let mut db5 = tx.db(&DB5);
let data = Data2 {
id: 1234,
hash: [3, 2, 1],
};
db5.put(&1, &data)?;
println!("- print all key db5");
for entry in db5.iter(None, None)? {
let (k, v) = entry?;
println!("> {:?} {:?}", k, Data2::from(v))
}
//write tx will auto commit when drop
}
{ println!("# read transaction");
let tx = TX.r()?; //
let db0 = tx.db(&DB0);
dbg!(db0.exist(&2, &1)?);
for i in [1, 2, 5] {
dbg!(i, db0.one(&i)?);
}
println!("- print all key");
for entry in db0.iter(None, None)? {
let (k, v) = entry?;
println!("> {:?} {:?}", k, v)
}
println!("- print key greater or equal 2");
for entry in db0.iter(&2, None)? {
let (k, v) = entry?;
println!("> {:?} {:?}", k, v)
}
println!("- print key greater or equal 2 and value greater or equal 1");
for entry in db0.iter(&2, &1)? {
let (k, v) = entry?;
println!("> {:?} {:?}", k, v)
}
println!("- print key greater or equal 2 and value greater or equal 1");
for entry in db0.iter(&2, &1)? {
let (k, v) = entry?;
println!("> {:?} {:?}", k, v)
}
println!("- print key in revese order");
for entry in db0.riter(None, None)? {
let (k, v) = entry?;
println!("> {:?} {:?}", k, v);
}
let db4 = tx.db(&DB4);
println!("- db4 : print key in revese order");
for entry in db4.riter(None, None)? {
let (k, v) = entry?;
println!("> {:?} {:?}", k, v);
}
}
Ok(()) }
```
db method you can see src/dbpage.rs
```rust use crate::tx::{Tx, TxnEnv}; pub use sanakirja::btree::page::Page; use sanakirja::btree::{BTreeMutPage, BTreePage, Iter, RevIter}; use sanakirja::{Error, LoadPage, Storable}; use std::marker::PhantomData;
macrorules! dbpage_r { ($self:ident, $db:ident, $fn:expr) => {{ let tx = $self.tx.r()?; let $db = tx.db($self); $fn }}; }
macrorules! dbpage_w { ($self:ident, $db:ident, $fn:expr) => {{ let tx = $self.tx.w()?; let mut $db = tx.db($self); $fn }}; }
impl<
'a,
K: ?Sized + Storable + PartialEq,
V: ?Sized + Storable + PartialEq,
P: BTreeMutPage
DbPage<'a, K, V, P, RK, RV> { pub fn put(&self, k: &RK, v: &RV) -> Result
{ dbpagew!(self, db, db.put(k, v)) }
pub fn rm(&self, k: &RK) -> Result
pub fn one(&self, k: &'a RK) -> Result
pub fn exist(&self, k: &RK, v: &RV) -> Result
pub fn rm1
pub fn key_iter(
&self,
k: &'a RK,
) -> Result<
Box
{ dbpager!(self, db, db.key_iter(k)) }
pub fn iter
pub fn riter
pub struct DbPage<
'a,
K: ?Sized + Storable + PartialEq,
V: ?Sized + Storable + PartialEq,
P: BTreeMutPage
{ pub(crate) tx: &'a Tx, pub id: usize, pub(crate) _kvp: PhantomData<(&'a K, &'a V, &'a P, &'a RK, &'a RV)>, }
pub trait Encode
macro_rules! encode {
($cls:ty, $t:ty) => {
impl $crate::Encode<$t> for $cls {
#[inline]
fn encode
macrorules! encodeli { ( $( $x:ty ),* ) => { $(encode!($x);)* }; }
encode_li!( [u8], bool, i8, u8, i16, u16, i32, u32, i64, u64, i128, u128, isize, usize, f32, f64 );
```
Copy-on-write datastructures, storable on disk (or elsewhere) with a stable format.