VaLog

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

English | 简体中文

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 ValuePointers 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

  [dependencies]
  valog = "0.2"

• no_std full in-memory mode

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

Example

Please see examples.

License

valog is under the terms of both the MIT license and the Apache License (Version 2.0).

See LICENSE-APACHE, LICENSE-MIT for details.

Copyright (c) 2024 Al Liu.