Module bonsaidb_core::connection
source · Expand description
Types for interacting with BonsaiDb.
Structs
Interacts with a collection over a
Connection
.Retrieves a list of documents from a collection, when awaited. This
structure also offers functions to customize the options for the operation.
Parameters to query a
schema::View
.Interacts with a collection over a
Connection
.A database stored in BonsaiDb.
Retrieves a list of documents from a collection. This structure also offers
functions to customize the options for the operation.
A range type that can represent all
std
range types and be serialized.A plain-text password. This struct automatically overwrites the password
with zeroes when dropped.
The authentication state for a
StorageConnection
.A unique session ID.
Parameters to query a
schema::View
.Enums
Changes how the view’s outdated data will be treated.
User authentication methods.
A range bound that can be serialized.
An identity from the connected BonsaiDb instance.
A reference to an identity.
A sort order.
Traits
A connection to a database’s
Schema
, giving access to
Collection
s and
Views
s. All functions on this trait are safe to use
in an asynchronous context.The low-level interface to a database’s
schema::Schema
, giving access to
Collection
s and
Views
s. This trait is for use within async
contexts. For access outside of async contexts, use LowLevelConnection
.Functions for interacting with a multi-database BonsaiDb instance.
A connection to a database’s
Schema
, giving access to
Collection
s and
Views
s. This trait is not safe to use within async
contexts and will block the current thread. For async access, use
AsyncConnection
.Functions to access information about the current session (authentication).
The low-level interface to a database’s
schema::Schema
, giving access to
Collection
s and
Views
s. This trait is not safe to use within async
contexts and will block the current thread. For async access, use
AsyncLowLevelConnection
.Functions for interacting with a multi-database BonsaiDb instance.
Type Definitions
This type is the result of
reduce_grouped()
. It is a list of all matching
keys and the reduced value of all mapped entries for that key.This type is the result of
query()
. It is a list of mappings, which
contains: