surrealkv

Crates.iosurrealkv
lib.rssurrealkv
version0.3.0
sourcesrc
created_at2024-02-08 13:00:15.865719
updated_at2024-07-04 11:56:04.030275
descriptionA low-level, versioned, embedded, ACID-compliant, key-value database for Rust
homepagehttps://github.com/surrealdb/surrealkv
repositoryhttps://github.com/surrealdb/surrealkv
max_upload_size
id1132066
size504,218
Tobie Morgan Hitchcock (tobiemh)

documentation

https://docs.rs/surrealkv/

README

surrealkv

surrealkv is a versioned, low-level, persistent, embedded key-value database implemented in Rust. This ACID-compliant database offers the following features:

  • Transaction Support: SurrealKV supports rich transactions, allowing multiple items to be inserted, updated, or deleted simultaneously. These transactions are applied atomically, ensuring atomicity and consistency in line with ACID principles. This makes updates invisible until they are committed.

  • Isolation: SurrealKV provides two levels of isolation - Snapshot Isolation and Serializable Snapshot Isolation - to prevent concurrent transactions from interfering with each other.

  • Durability: SurrealKV ensures durability by persisting data on disk, protecting against data loss in the event of a system failure.

  • Multi-Version Concurrency Control (MVCC): SurrealKV employs immutable versioned adaptive radix tries via vart. This allows for any number of concurrent readers and writers to operate without blocking each other.

For more information on the underlying immutable versioned adaptive radix tries used, visit vart.

License

Features

  • In-memory Index

  • Embeddable

  • ACID Semantics

  • Transaction Support:

  • Built-in Item Versioning API

  • Multi-Version Concurrency Control (MVCC) support

  • Multiple Concurrent Readers and Writers

  • Persistence through an append-only File

  • Compaction

Important Notice

This project is actively evolving, and as such, there might be changes to the file format, APIs, and feature set in future releases until reaching stability. Developers are encouraged to stay informed about updates and review future release notes for any breaking changes.

Feel free to contribute, provide feedback, or report issues to help shape the future of surrealkv. Thank you for your interest and involvement in this project!

Commit count: 31

cargo fmt