Struct bonsaidb_local::Database

pub struct Database { /* private fields */ }

A local, file-based database.

Using Database to create a single database

Databaseprovides an easy mechanism to open and access a single database:

// `bonsaidb_core` is re-exported to `bonsaidb::core` or `bonsaidb_local::core`.
use bonsaidb_core::schema::Collection;
// `bonsaidb_local` is re-exported to `bonsaidb::local` if using the omnibus crate.
use bonsaidb_local::{
    config::{Builder, StorageConfiguration},
    Database,
};
use serde::{Deserialize, Serialize};

#[derive(Debug, Serialize, Deserialize, Collection)]
#[collection(name = "blog-posts")]
struct BlogPost {
    pub title: String,
    pub contents: String,
}

let db = Database::open::<BlogPost>(StorageConfiguration::new("my-db.bonsaidb")).await?;

Under the hood, this initializes a Storage instance pointing at “./my-db.bonsaidb”. It then returns (or creates) a database named “default” with the schema BlogPost.

In this example, BlogPost implements the Collection trait, and all collections can be used as a Schema.

Implementations

impl Database

pub fn name(&self) -> &str

Returns the name of the database.

pub async fn open<DB: Schema>(
    configuration: StorageConfiguration
) -> Result<Self, Error>

Creates a Storage with a single-database named “default” with its data stored at path.

pub fn storage(&self) -> &Storage

Returns the Storage that this database belongs to.

pub fn schematic(&self) -> &Schematic

Returns the Schematic for the schema for this database.

Trait Implementations

impl Clone for Database

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Connection for Database

fn apply_transaction<'life0, 'async_trait>(
    &'life0 self,
    transaction: Transaction
) -> Pin<Box<dyn Future<Output = Result<Vec<OperationResult>, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Applies a Transaction to the schema::Schema. If any operation in the Transaction fails, none of the operations will be applied to the schema::Schema.

fn get<'life0, 'async_trait, C, PrimaryKey>(
    &'life0 self,
    id: PrimaryKey
) -> Pin<Box<dyn Future<Output = Result<Option<OwnedDocument>, Error>> + Send + 'async_trait>> where
    C: Collection,
    PrimaryKey: Into<AnyDocumentId<C::PrimaryKey>> + Send,
    C: 'async_trait,
    PrimaryKey: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Retrieves a stored document from Collection C identified by id.

fn get_multiple<'life0, 'async_trait, C, PrimaryKey, DocumentIds, I>(
    &'life0 self,
    ids: DocumentIds
) -> Pin<Box<dyn Future<Output = Result<Vec<OwnedDocument>, Error>> + Send + 'async_trait>> where
    C: Collection,
    DocumentIds: IntoIterator<Item = PrimaryKey, IntoIter = I> + Send + Sync,
    I: Iterator<Item = PrimaryKey> + Send + Sync,
    PrimaryKey: Into<AnyDocumentId<C::PrimaryKey>> + Send + Sync,
    C: 'async_trait,
    PrimaryKey: 'async_trait,
    DocumentIds: 'async_trait,
    I: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Retrieves all documents matching ids. Documents that are not found are not returned, but no error will be generated.

fn list<'life0, 'async_trait, C, R, PrimaryKey>(
    &'life0 self,
    ids: R,
    order: Sort,
    limit: Option<usize>
) -> Pin<Box<dyn Future<Output = Result<Vec<OwnedDocument>, Error>> + Send + 'async_trait>> where
    C: Collection,
    R: Into<Range<PrimaryKey>> + Send,
    PrimaryKey: Into<AnyDocumentId<C::PrimaryKey>> + Send,
    C: 'async_trait,
    R: 'async_trait,
    PrimaryKey: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Retrieves all documents within the range of ids. To retrieve all documents, pass in .. for ids.

fn count<'life0, 'async_trait, C, R, PrimaryKey>(
    &'life0 self,
    ids: R
) -> Pin<Box<dyn Future<Output = Result<u64, Error>> + Send + 'async_trait>> where
    C: Collection,
    R: Into<Range<PrimaryKey>> + Send,
    PrimaryKey: Into<AnyDocumentId<C::PrimaryKey>> + Send,
    C: 'async_trait,
    R: 'async_trait,
    PrimaryKey: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Counts the number of documents within the range of ids.

fn list_executed_transactions<'life0, 'async_trait>(
    &'life0 self,
    starting_id: Option<u64>,
    result_limit: Option<usize>
) -> Pin<Box<dyn Future<Output = Result<Vec<Executed>, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Lists executed Transactions from this schema::Schema. By default, a maximum of 1000 entries will be returned, but that limit can be overridden by setting result_limit. A hard limit of 100,000 results will be returned. To begin listing after another known transaction_id, pass transaction_id + 1 into starting_id.

fn query<'life0, 'async_trait, V: SerializedView>(
    &'life0 self,
    key: Option<QueryKey<V::Key>>,
    order: Sort,
    limit: Option<usize>,
    access_policy: AccessPolicy
) -> Pin<Box<dyn Future<Output = Result<Vec<Map<V::Key, V::Value>>, Error>> + Send + 'async_trait>> where
    Self: Sized,
    V: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Queries for view entries matching View.

fn query_with_docs<'life0, 'async_trait, V: SerializedView>(
    &'life0 self,
    key: Option<QueryKey<V::Key>>,
    order: Sort,
    limit: Option<usize>,
    access_policy: AccessPolicy
) -> Pin<Box<dyn Future<Output = Result<MappedDocuments<OwnedDocument, V>, Error>> + Send + 'async_trait>> where
    Self: Sized,
    V: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Queries for view entries matching View with their source documents.

fn reduce<'life0, 'async_trait, V: SerializedView>(
    &'life0 self,
    key: Option<QueryKey<V::Key>>,
    access_policy: AccessPolicy
) -> Pin<Box<dyn Future<Output = Result<V::Value, Error>> + Send + 'async_trait>> where
    Self: Sized,
    V: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Reduces the view entries matching View.

fn reduce_grouped<'life0, 'async_trait, V: SerializedView>(
    &'life0 self,
    key: Option<QueryKey<V::Key>>,
    access_policy: AccessPolicy
) -> Pin<Box<dyn Future<Output = Result<Vec<MappedValue<V::Key, V::Value>>, Error>> + Send + 'async_trait>> where
    Self: Sized,
    V: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Reduces the view entries matching View, reducing the values by each unique key.

fn delete_docs<'life0, 'async_trait, V: SerializedView>(
    &'life0 self,
    key: Option<QueryKey<V::Key>>,
    access_policy: AccessPolicy
) -> Pin<Box<dyn Future<Output = Result<u64, Error>> + Send + 'async_trait>> where
    Self: Sized,
    V: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Deletes all of the documents associated with this view.

fn last_transaction_id<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<Option<u64>, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Fetches the last transaction id that has been committed, if any.

fn compact_collection<'life0, 'async_trait, C: Collection>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>> where
    C: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Compacts the collection to reclaim unused disk space.

fn compact<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Compacts the entire database to reclaim unused disk space.

fn compact_key_value_store<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Compacts the key value store to reclaim unused disk space.

fn collection<C>(&self) -> Collection<'_, Self, C> where
    C: Collection, 

Accesses a collection for the connected schema::Schema.

fn insert<'life0, 'async_trait, C, PrimaryKey, B>(
    &'life0 self,
    id: Option<PrimaryKey>,
    contents: B
) -> Pin<Box<dyn Future<Output = Result<CollectionHeader<<C as Collection>::PrimaryKey>, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    C: Collection + 'async_trait,
    PrimaryKey: Into<AnyDocumentId<<C as Collection>::PrimaryKey>> + Send + 'async_trait,
    B: Into<Bytes> + Send + 'async_trait,
    Self: 'async_trait, 

Inserts a newly created document into the connected schema::Schema for the Collection C. If id is None a unique id will be generated. If an id is provided and a document already exists with that id, a conflict error will be returned.

fn update<'life0, 'life1, 'async_trait, C, D>(
    &'life0 self,
    doc: &'life1 mut D
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    C: Collection + 'async_trait,
    D: Document<C> + Send + Sync + 'async_trait,
    Self: 'async_trait, 

Updates an existing document in the connected schema::Schema for the Collection C. Upon success, doc.revision will be updated with the new revision.

fn overwrite<'a, 'life0, 'async_trait, C, PrimaryKey>(
    &'life0 self,
    id: PrimaryKey,
    contents: Vec<u8, Global>
) -> Pin<Box<dyn Future<Output = Result<CollectionHeader<<C as Collection>::PrimaryKey>, Error>> + Send + 'async_trait, Global>> where
    'a: 'async_trait,
    'life0: 'async_trait,
    C: Collection + 'async_trait,
    PrimaryKey: Into<AnyDocumentId<<C as Collection>::PrimaryKey>> + Send + 'async_trait,
    Self: 'async_trait, 

Overwrites an existing document, or inserts a new document. Upon success, doc.revision will be updated with the new revision information.

fn delete<'life0, 'life1, 'async_trait, C, H>(
    &'life0 self,
    doc: &'life1 H
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    C: Collection + 'async_trait,
    H: HasHeader + Send + Sync + 'async_trait,
    Self: 'async_trait, 

Removes a Document from the database.

fn view<V>(&self) -> View<'_, Self, V> where
    V: SerializedView, 

Initializes View for schema::View V.

fn query_with_collection_docs<'life0, 'async_trait, V>(
    &'life0 self,
    key: Option<QueryKey<<V as View>::Key>>,
    order: Sort,
    limit: Option<usize>,
    access_policy: AccessPolicy
) -> Pin<Box<dyn Future<Output = Result<MappedDocuments<CollectionDocument<<V as View>::Collection>, V>, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    V: SerializedView + 'async_trait,
    Self: 'async_trait,
    <V as View>::Collection: SerializedCollection,
    <<V as View>::Collection as SerializedCollection>::Contents: Debug, 

Queries for view entries matching View with their source documents, deserialized.

impl Debug for Database

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl KeyValue for Database

fn execute_key_operation<'life0, 'async_trait>(
    &'life0 self,
    op: KeyOperation
) -> Pin<Box<dyn Future<Output = Result<Output, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Executes a single KeyOperation.

fn set_key<S, V>(&'a self, key: S, value: &'a V) -> Builder<'a, Self, V> where
    S: Into<String>,
    V: Serialize + Send + Sync, 

Sets key to value. This function returns a builder that is also a Future. Awaiting the builder will execute Command::Set with the options given.

fn set_binary_key<S>(&'a self, key: S, bytes: &'a [u8]) -> Builder<'a, Self, ()> where
    S: Into<String>, 

Sets key to bytes. This function returns a builder that is also a Future. Awaiting the builder will execute Command::Set with the options given.

fn set_numeric_key<S, V>(&self, key: S, value: V) -> Builder<'_, Self, ()> where
    S: Into<String>,
    V: Into<Numeric>, 

Sets key to value. This stores the value as a Numeric, enabling atomic math operations to be performed on this key. This function returns a builder that is also a Future. Awaiting the builder will execute Command::Set with the options given.

fn increment_key_by<S, V>(&self, key: S, value: V) -> Builder<'_, Self, V> where
    S: Into<String> + Send + Sync,
    V: Into<Numeric> + TryFrom<Numeric, Error = IncompatibleTypeError> + Send + Sync, 

Increments key by value. The value stored must be a Numeric, otherwise an error will be returned. The result of the increment will be the value’s type. For example, if the stored value is currently a u64, but value is a f64, the current value will be converted to an f64, and the stored value will be an f64.

fn decrement_key_by<S, V>(&self, key: S, value: V) -> Builder<'_, Self, V> where
    S: Into<String> + Send + Sync,
    V: Into<Numeric> + TryFrom<Numeric, Error = IncompatibleTypeError> + Send + Sync, 

Decrements key by value. The value stored must be a Numeric, otherwise an error will be returned. The result of the decrement will be the value’s type. For example, if the stored value is currently a u64, but value is a f64, the current value will be converted to an f64, and the stored value will be an f64.

fn get_key<S>(&self, key: S) -> Builder<'_, Self> where
    S: Into<String>, 

Gets the value stored at key. This function returns a builder that is also a Future. Awaiting the builder will execute Command::Get with the options given.

fn delete_key<'life0, 'async_trait, S>(
    &'life0 self,
    key: S
) -> Pin<Box<dyn Future<Output = Result<KeyStatus, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    S: Into<String> + Send + 'async_trait,
    Self: 'async_trait, 

Deletes the value stored at key.

fn key_namespace(&self) -> Option<&str>

The current namespace.

fn with_key_namespace(&self, namespace: &str) -> Namespaced<'_, Self>

Access this Key-Value store within a namespace. When using the returned Namespaced instance, all keys specified will be separated into their own storage designated by namespace.

impl PubSub for Database

type Subscriber = Subscriber

The Subscriber type for this PubSub connection.

fn create_subscriber<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<Self::Subscriber, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Create a new Subscriber for this relay.

fn publish<'life0, 'life1, 'async_trait, S: Into<String> + Send, P: Serialize + Sync>(
    &'life0 self,
    topic: S,
    payload: &'life1 P
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>> where
    S: 'async_trait,
    P: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Publishes a payload to all subscribers of topic.

fn publish_to_all<'life0, 'life1, 'async_trait, P: Serialize + Sync>(
    &'life0 self,
    topics: Vec<String>,
    payload: &'life1 P
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>> where
    P: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Publishes a payload to all subscribers of all topics.