Crate bonsaidb

Expand description

BonsaiDb is a developer-friendly document database for Rust that grows with you. It offers many features out of the box that many developers need:

ACID-compliant, transactional storage of Collections
Atomic Key-Value storage with configurable delayed persistence (similar to Redis)
At-rest Encryption
Backup/Restore
Role-Based Access Control (RBAC)
Local-only access, networked access via QUIC, or networked access via WebSockets
And much more.

⚠️ Status of this project

BonsaiDb is considered alpha software. It is under active development ( GitHub commit activity ). There may still be bugs that result in data loss. All users should regularly back up their data and test that restoring from backup works correctly.

Example

To get an idea of how it works, let’s review the view-examples example. See the examples README for a list of all available examples.

The view-examples example shows how to define a simple schema containing a single collection (Shape), a view to query the Shapes by their number_of_sides (ShapesByNumberOfSides), and demonstrates multiple ways to query that view.

First, here’s how the schema is defined:

#[derive(Debug, Serialize, Deserialize, Collection)]
#[collection(name = "shapes", views = [ShapesByNumberOfSides])]
struct Shape {
    pub sides: u32,
}

#[derive(Debug, Clone, View)]
#[view(collection = Shape, key = u32, value = usize, name = "by-number-of-sides")]
struct ShapesByNumberOfSides;

impl CollectionViewSchema for ShapesByNumberOfSides {
    type View = Self;

    fn map(&self, document: CollectionDocument<Shape>) -> ViewMapResult<Self::View> {
        Ok(document.emit_key_and_value(document.contents.sides, 1))
    }

    fn reduce(
        &self,
        mappings: &[ViewMappedValue<Self>],
        _rereduce: bool,
    ) -> ReduceResult<Self::View> {
        Ok(mappings.iter().map(|m| m.value).sum())
    }
}

After you have your collection(s) and view(s) defined, you can open up a database and insert documents:

let db = Database::open::<Shape>(StorageConfiguration::new("view-examples.bonsaidb")).await?;

// Insert a new document into the Shape collection.
Shape { sides: 3 }.push_into(&db).await?;

And query data using the Map-Reduce-powered view:

let triangles = db
    .view::<ShapesByNumberOfSides>()
    .with_key(3)
    .query()
    .await?;
println!("Number of triangles: {}", triangles.len());

You can review the full example in the repository, or see all available examples in the examples README.

Feature Flags

No feature flags are enabled by default in the bonsaidb crate. This is because in most Rust executables, you will only need a subset of the functionality. If you’d prefer to enable everything, you can use the full feature:

[dependencies]
bonsaidb = { version = "*", default-features = false, features = "full" }

full: Enables local-full, server-full, and client-full.
cli: Enables the bonsaidb executable.
password-hashing: Enables the ability to use password authentication using Argon2 via AnyConnection.

Local databases only

[dependencies]
bonsaidb = { version = "*", default-features = false, features = "local-full" }

local-full: Enables all the flags below
local: Enables the local module, which re-exports the crate bonsaidb-local.
local-cli: Enables the clap structures for embedding database management commands into your own command-line interface.
local-encryption: Enables at-rest encryption.
local-instrument: Enables instrumenting with tracing.
local-multiuser: Enables multi-user support.
local-password-hashing: Enables the ability to use password authentication using Argon2.

BonsaiDb server

[dependencies]
bonsaidb = { version = "*", default-features = false, features = "server-full" }

server-full: Enables all the flags below,
server: Enables the server module, which re-exports the crate bonsaidb-server.
server-acme: Enables automtic certificate acquisition through ACME/LetsEncrypt.
server-cli: Enables the cli module.
server-encryption: Enables at-rest encryption.
server-hyper: Enables convenience functions for upgrading websockets using hyper.
server-instrument: Enables instrumenting with tracing.
server-pem: Enables the ability to install a certificate using the PEM format.
server-websockets: Enables WebSocket support.
server-password-hashing: Enables the ability to use password authentication using Argon2.

Client for accessing a BonsaiDb server

[dependencies]
bonsaidb = { version = "*", default-features = false, features = "client-full" }

client-full: Enables client, client-trusted-dns, client-websockets, and client-password-hashing.
client: Enables the client module, which re-exports the crate bonsaidb-client.
client-trusted-dns: Enables using trust-dns for DNS resolution. If not enabled, all DNS resolution is done with the OS’s default name resolver.
client-websockets: Enables WebSocket support for bonsaidb-client.
client-password-hashing: Enables the ability to use password authentication using Argon2.