Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/al8n/valog

A lock-free, generic, lightweight value log for WiscKey or Bitcask architecture databases.
https://github.com/al8n/valog

bitcask bitcask-storage-engine lsm rust rust-lang value-log wisckey write-ahead-log

Last synced: 23 days ago
JSON representation

A lock-free, generic, lightweight value log for WiscKey or Bitcask architecture databases.

Host: GitHub
URL: https://github.com/al8n/valog
Owner: al8n
License: apache-2.0
Created: 2024-09-24T19:08:07.000Z (about 2 months ago)
Default Branch: main
Last Pushed: 2024-10-08T07:12:53.000Z (about 1 month ago)
Last Synced: 2024-10-13T14:23:09.515Z (about 1 month ago)
Topics: bitcask, bitcask-storage-engine, lsm, rust, rust-lang, value-log, wisckey, write-ahead-log
Language: Rust
Homepage:
Size: 33.2 KB
Stars: 3
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README-zh_CN.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE-APACHE

Awesome Lists containing this project

README

        


VaLog





A lock-free, generic, lightweight value log for WiscKey architecture databases.

[][Github-url]



[][CI-url]

[][codecov-url]

[][doc-url]

[][crates-url]

[][crates-url]



English | [简体中文][zh-cn-url]



## Introduction

This crate is designed for databases based on the WiscKey architecture, which separates the storage of keys from values. Consequently, this crate focuses exclusively on managing values. Users are responsible for storing the value pointers returned by the `write*` APIs.

### Features

- **Lock-Free and Concurrently Safe:** Engineered for high-performance concurrent access without the use of locks.

- **Generic Data Structure Support:** Provides flexibility to accommodate a variety of data types.

- **In-Place Writing:** Guarantees no additional memory allocation during write operations.

- **Zero-Copy Reads:** Enables efficient reading without unnecessary data duplication.

- **Three Mode Support:**

  - **`Vec`:** Usable in environments without the standard library (`no_std`).

  - **Anonymous Memory Mapping:** Efficiently manages memory through an anonymous memory map.

  - **File-Backed Memory Map:** Functions similarly to an in-memory arena but stores data persistently on disk.

This crate offers a robust solution for managing value storage in WiscKey-based databases, prioritizing both performance and efficiency.

## Installation

- Default

  

  ```toml

  [dependencies]

  valog = "0.2"

  ```

- `no_std` full in-memory mode

  ```toml

  [dependencies]

  valog = { version = "0.2", default-features = false, features = ["alloc"] }

  ```

#### License

`valog` is under the terms of both the MIT license and the

Apache License (Version 2.0).

See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT) for details.

Copyright (c) 2024 Al Liu.

[Github-url]: https://github.com/al8n/valog/

[CI-url]: https://github.com/al8n/valog/actions/workflows/ci.yml

[doc-url]: https://docs.rs/valog

[crates-url]: https://crates.io/crates/valog

[codecov-url]: https://app.codecov.io/gh/al8n/valog/

[zh-cn-url]: https://github.com/al8n/valog/tree/main/README-zh_CN.md