BonsaiDb Client

BonsaiDb's offline database implementation.

This crate exposes BonsaiDb's local database implementation. The Storage type provides its most common functionality by implementing the StorageConnection.

Minimum Supported Rust Version (MSRV)

While this project is alpha, we are actively adopting the current version of Rust. The current minimum version is 1.58, and we plan on updating the MSRV to implement namespaced Features as soon as the feature is released.

Feature Flags

By default, the full feature is enabled. These features are prefixed by local- when being enabled from the omnibus bonsaidb crate.

• full: Enables all the flags below
• async: Enables async-compatible types
• cli: Enables the clap structures for embedding database management commands into your own command-line interface.
• encryption: Enables at-rest encryption.
• instrument: Enables instrumenting with tracing.
• multiuser: Enables multi-user support.
• password-hashing: Enables the ability to use password authentication using Argon2.

Open-source Licenses

This project, like all projects from Khonsu Labs, are open-source. This repository is available under the MIT License or the Apache License 2.0.

To learn more about contributing, please see CONTRIBUTING.md.