README-zh_CN.md

OrderWAL

A generic-purpose, atomic, ordered, zero-copy read, zero-cost (in-place) write, Write-Ahead Log implementation for Rust.

English | 简体中文

Introduction

orderwal is generic-purpose, atomic, ordered, zero-copy read, zero-cost (in-place) write, concurrent-safe, pre-allocate style (memory map) write-ahead-log for developing databases.

orderwal also supports generic structured key and value types, which is not limited to just bytes like other implementations.

Installation

• Default (with on-disk support)

  [dependencies]
  orderwal = "0.5"

• std only (without on-disk support)

  [dependencies]
  orderwal = { version = "0.5", default-features = false, features = ["std"] } 

• no-std (alloc required)

  [dependencies]
  orderwal = { version = "0.5", default-features = false, features = ["alloc"] }

Example

See examples for more information.

Related projects

• aol: Yet another generic purpose, append-only write-ahead log implementation based on std::fs::File.
• skl: A lock-free, ARNEA based skiplist implementation, which supports in-memory and on-disk, suitable for frozen durable data file or memtable for LSM database.
• valog: A lock-free, generic, lightweight value log for WiscKey or Bitcask architecture databases.
• dtlog: A log for tracking discard stats of multi-files databases.

License

orderwal 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.