siamesedb

The simple local key-value store.

Features

• key-value store.
• in-memory and file store.
• DbMapDbString has keys as utf-8 string.
• DbMapDbInt has keys as u64.
• DbMapDbBytes has keys as Vec.
• The value is any bytes included utf-8 string.
• The file store is implemented the basic B-Tree. (no leaf)
• The file store is included the htx file that is hash cache table for performance.
• Small db file size.
• Separated files. (key file, value file, index file and htx file)
• One database has some db-map-string and some db-map-int and some db-map-bytes.
• Swiss army knife with easy-to-use and good performance
• minimum support rustc 1.56.1 (59eed8a2a 2021-11-01)

Compatibility

• Nothing?

Todo

• [ ] more performance
• [ ] DB lock as support for multi-process-safe

Low priority todo

• [ ] transaction support that handles multiple key-space at a time.
• [ ] thread-safe support
• [ ] non db lock multi-process-safe support

Examples

Example DbMapDbString:

```rust use siamesedb::{DbMapDbString, DbXxx, DbXxxBase, DbXxxObjectSafe};

fn main() -> std::io::Result<()> { let dbname = "target/tmp/doc-test1.siamesedb"; // remove database let _ = std::fs::removedirall(dbname); // create or open database let db = siamesedb::openfile(dbname)?; // create or get db map let mut dbmap = db.dbmapstring("somemap1")?; // let r = dbmap.getstring("key1")?; asserteq!(r, None); dbmap.putstring("key1", "value1")?; let r = dbmap.getstring("key1")?; asserteq!(r, Some("value1".into())); dbmap.syncdata()?; Ok(()) } ```

Example DbMapDbInt:

```rust use siamesedb::{DbMapDbInt, DbXxx, DbXxxBase, DbXxxObjectSafe};

fn main() -> std::io::Result<()> { let dbname = "target/tmp/doc-test2.siamesedb"; // remove database let _ = std::fs::removedirall(dbname); // create or open database let db = siamesedb::openfile(dbname)?; let mut dbmap = db.dbmapint("somelist1")?; let r = dbmap.getstring(&120)?; asserteq!(r, None); dbmap.putstring(&120, "value120")?; let r = dbmap.getstring(&120)?; asserteq!(r, Some("value120".tostring())); dbmap.sync_data()?; Ok(()) } ```

Example Iterator:

```rust use siamesedb::{DbMapDbString, DbMap, DbXxx, DbXxxBase, DbXxxObjectSafe};

fn main() -> std::io::Result<()> { let dbname = "target/tmp/doc-test3.siamesedb"; // remove database let _ = std::fs::removedirall(dbname); // create or open database let db = siamesedb::openfile(dbname)?; // create or get db map let mut dbmap = db.dbmapstring("somemap1")?; // // insert dbmap.putstring("key01", "value1").unwrap(); dbmap.putstring("key02", "value2").unwrap(); dbmap.putstring("key03", "value3").unwrap(); // // iterator let mut iter = dbmap.iter(); asserteq!(iter.next(), Some(("key01".into(), "value1".into()))); asserteq!(iter.next(), Some(("key02".into(), "value2".into()))); asserteq!(iter.next(), Some(("key03".into(), "value3".into()))); asserteq!(iter.next(), None); // dbmap.sync_data()?; Ok(()) } ```

Changelogs

This crate's changelog here.

License

This project is licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or https://opensource.org/licenses/MIT)

at your option.