Skip to content

Latest commit

 

History

History

bonsaidb-local

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
src
src
 
 
Cargo.toml
Cargo.toml
 
 
README.md
README.md
 
 
local-feature-flags.md
local-feature-flags.md
 
 

README.md

BonsaiDb Local

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

Feature Flags

By default, the full feature is enabled.

  • 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.
  • token-authentication: Enables the ability to authenticate using authentication tokens, which are similar to API keys.

Open-source Licenses

This project, like all projects from Khonsu Labs, is 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.