simpledb 0.1.5

NoSQL embedded database on top of RocksDB
Documentation

simpledb

Rust API Minimum rustc version

NoSQL embedded database on top of RocksDB.

Documents: https://docs.rs/simpledb

Usage

Add this to your Cargo.toml:

[dependencies]
simpledb = "0.1"

Example:

use simpledb::Database;

fn main() {
    // open a database
    let db = Database::open("./target/path/to/database").unwrap();
    // left push a value to a list
    db.list_left_push("key", "value".as_bytes()).unwrap();
}

Supported Data Type

  • map: Store field/value pairs, includes the following operations with map_ prefix: get, put, delete, count, for_each, items.
  • set: Store unique values, includes the following operations with set_ prefix: add, is_member, delete, count, for_each, items.
  • list: Store ordered values, includes the following operations with list_ prefix: left_push, left_pop, right_push, right_pop, count, for_each, items.
  • sorted list: Store sorted score/value pairs, includes the following operations with sorted_list_ prefix: add, left_pop, right_pop, count, for_each, items.
  • sorted set: store sorted score/value pairs, includes the following operations with sorted_set_ prefix: add, is_member, delete, left, right, for_each, items.
  • Notes: the difference between sorted list and sorted set is list allow the same members, set does not allow the same members.

Benchmark

Example codes from benchmark directory.

  • rustc 1.51.0-nightly (44e3daf5e 2020-12-31)
  • macOS Big Sur 11.1
  • Intel(R) Core(TM) i7-6820HQ CPU @ 2.70GHz, MacBook Pro (15-inch, 2016)
method write op/s
map_get 355,871
map_count 735,294
map_put yes 62,539
map_delete yes 62,656
set_count 813,008
set_is_member 380,228
set_add yes 64,724
set_delete yes 61,349
list_count 666,666
list_left_push yes 68,775
list_left_pop yes 60,277
list_right_push yes 64,641
list_right_pop yes 56,433
sorted_list_count 588,235
sorted_list_add yes 68,493
sorted_list_left_pop yes 14,880
sorted_list_right_pop yes 7,923
sorted_set_is_member 285,714
sorted_set_count 500,000
sorted_set_add yes 47,393
sorted_set_left yes 16,181
sorted_set_right yes 9,082
sorted_set_delete yes 19,920

Changelog

v0.1.5

  • fix: Allow Database to be shared across threads;

v0.1.4

  • fix(encoding): to_bytes() method not found in &[u8];
  • update dependencies rand to v0.8, bytes to v1.0;

v0.1.3

  • feat: add sorted set data type.

v0.1.2

  • feat: add for_each_key_with_prefix & keys & keys_with_prefix operations.

v0.1.1:

  • feat: add map_for_each_with_prefix & map_items_with_prefix operations.

License

MIT License

Copyright (c) 2020 Zongmin Lei <leizongmin@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.