Crates.io | velarixdb |
lib.rs | velarixdb |
version | |
source | src |
created_at | 2024-07-14 15:04:16.922335 |
updated_at | 2024-07-15 19:38:04.833393 |
description | An LSM Storage Engine focused on reduced IO amplification |
homepage | https://github.com/Gifted-s/velarixdb/blob/main/README.md |
repository | https://github.com/Gifted-s/velarixdb |
max_upload_size | |
id | 1303064 |
size | 0 |
VelarixDB is an LSM-based storage engine designed to significantly reduce IO amplification, resulting in better performance and durability for storage devices.
VelarixDB: Designed to reduce IO amplification
VelarixDB is an ongoing project (not production ready) designed to optimize data movement during load times and compaction. Inspired by the WiscKey paper, WiscKey: Separating Keys from Values in SSD-conscious Storage, velarixdb aims to significantly enhance performance over traditional key-value stores.
During compaction in LevelDB or RocksDB, thesame key-value pair can be re-read and re-written from Level 1 to Level 6 in the worst case, the goal is to reduce size of data moved around during this process.
We mostly care if the key has been deleted or updated therefore including values in the compaction process (which is often larger than the key) can unneccssarily amplify the data read and written during compaction. We therefore store keys and values separately (we map value offset to the key represented as 32 bit integer), This reduces the amount of data read, written, and moved during compaction, leading to improved performance and reduced wear on storage devices, particularly SSDs.
According to the benchmarks presented in the WiscKey paper, implementations can outperform LevelDB and RocksDB by:
To achieve high concurrency without the overhead of spawning new threads every time, velarixdb utilizes the Tokio runtime. This allows for efficient and scalable asynchronous operations, making the most of modern multi-core processors. Frankly,
most Operating System File System does not provide async API but Tokio uses a thread pool to offload blocking file system operations. When you perform an asynchronous file operation in Tokio, the operation is executed on a dedicated thread from this pool.
This means that even though the file system operations themselves are blocking at the OS level, Tokio can handle them without blocking the main async task executor.
Tokio might also use io_uring in the future
Please note that velarixdb is still under development and is not yet production-ready.
Put()
, Get()
, Delete()
, and Update()
operationsMutex
)cargo add velarixdb
use velarixdb::db::DataStore;
# use tempfile::tempdir;
#[tokio::main]
async fn main() {
let root = tempdir().unwrap();
let path = root.path().join("velarix");
let mut store = DataStore::open("big_tech", path).await.unwrap(); // handle IO error
store.put("apple", "tim cook").await;
store.put("google", "sundar pichai").await;
store.put("nvidia", "jensen huang").await;
store.put("microsoft", "satya nadella").await;
store.put("meta", "mark zuckerberg").await;
store.put("openai", "sam altman").await;
let entry1 = store.get("apple").await.unwrap(); // Handle error
let entry2 = store.get("google").await.unwrap();
let entry3 = store.get("nvidia").await.unwrap();
let entry4 = store.get("microsoft").await.unwrap();
let entry5 = store.get("meta").await.unwrap();
let entry6 = store.get("openai").await.unwrap();
let entry7 = store.get("***not_found_key**").await.unwrap();
assert_eq!(std::str::from_utf8(&entry1.unwrap().val).unwrap(), "tim cook");
assert_eq!(std::str::from_utf8(&entry2.unwrap().val).unwrap(), "sundar pichai");
assert_eq!(std::str::from_utf8(&entry3.unwrap().val).unwrap(), "jensen huang");
assert_eq!(std::str::from_utf8(&entry4.unwrap().val).unwrap(), "satya nadella");
assert_eq!(std::str::from_utf8(&entry5.unwrap().val).unwrap(), "mark zuckerberg");
assert_eq!(std::str::from_utf8(&entry6.unwrap().val).unwrap(), "sam altman");
assert!(entry7.is_none());
// Remove an entry
store.delete("apple").await.unwrap();
// Update an entry
let success = store.update("microsoft", "elon musk").await;
assert!(success.is_ok());
}
use serde::{Deserialize, Serialize};
use serde_json;
use velarixdb::db::DataStore;
# use tempfile::tempdir;
#[tokio::main]
async fn main() {
let root = tempdir().unwrap();
let path = root.path().join("velarix");
let mut store = DataStore::open("big_tech", path).await.unwrap(); // handle IO error
#[derive(Serialize, Deserialize)]
struct BigTech {
name: String,
rank: i32,
}
let new_entry = BigTech {
name: String::from("Google"),
rank: 50,
};
let json_string = serde_json::to_string(&new_entry).unwrap();
let res = store.put("google", json_string).await;
assert!(res.is_ok());
let entry = store.get("google").await.unwrap().unwrap();
let entry_string = std::str::from_utf8(&entry.val).unwrap();
let big_tech: BigTech = serde_json::from_str(&entry_string).unwrap();
assert_eq!(big_tech.name, new_entry.name);
assert_eq!(big_tech.rank, new_entry.rank);
}
See here for practical examples