Struct bonsaidb_core::admin::Database

pub struct Database {
    pub name: String,
    pub schema: SchemaName,
}

A database stored in BonsaiDb.

Fields

name: String

The name of the database.

schema: SchemaName

The schema defining the database.

Trait Implementations

impl Clone for Database

fn clone(&self) -> Database

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Collection for Database

type PrimaryKey = u64

The unique id type. Each document stored in a collection will be uniquely identified by this type.

fn collection_name() -> CollectionName

The unique name of this collection. Each collection must be uniquely named within the Schema it is registered within.

fn define_views(schema: &mut Schematic) -> Result<(), Error>

Defines all Views in this collection in schema.

fn encryption_key() -> Option<KeyId>

If a KeyId is returned, this collection will be stored encrypted at-rest using the key specified.

impl Debug for Database

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

Formats the value using the given formatter.

impl DefaultSerialization for Database

fn natural_id(&self) -> Option<Self::PrimaryKey>

Returns the natural identifier of contents. This is called when pushing values into a collection, before attempting to automatically assign a unique id.

impl<'de> Deserialize<'de> for Database

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl NamedCollection for Database

type ByNameView = ByName

The name view defined for the collection.

fn load<'name, N: Nameable<'name, Self::PrimaryKey> + Send + Sync, C: Connection>(
    id: N,
    connection: &C
) -> Result<Option<CollectionDocument<Self>>, Error>where
    Self: SerializedCollection + Sized + 'static,

Gets a CollectionDocument with id from connection.

fn load_async<'name, 'life0, 'async_trait, N, C>(
    id: N,
    connection: &'life0 C
) -> Pin<Box<dyn Future<Output = Result<Option<CollectionDocument<Self>>, Error>> + Send + 'async_trait>>where
    Self: SerializedCollection + Sized + 'static + Send + 'async_trait,
    N: 'async_trait + Nameable<'name, Self::PrimaryKey> + Send + Sync,
    C: 'async_trait + AsyncConnection,
    'name: 'async_trait,
    'life0: 'async_trait,

Gets a CollectionDocument with id from connection.

fn entry<'connection, 'name, N: Into<NamedReference<'name, Self::PrimaryKey>> + Send + Sync, C: Connection>(
    id: N,
    connection: &'connection C
) -> Entry<'connection, 'name, C, Self, (), ()>where
    Self: SerializedCollection + Sized,

Gets a CollectionDocument with id from connection.

fn entry_async<'connection, 'name, N: Into<NamedReference<'name, Self::PrimaryKey>> + Send + Sync, C: AsyncConnection>(
    id: N,
    connection: &'connection C
) -> AsyncEntry<'connection, 'name, C, Self, (), ()> where
    Self: SerializedCollection + Sized,

Gets a CollectionDocument with id from connection.

fn load_document<'name, N: Nameable<'name, Self::PrimaryKey> + Send + Sync, C: Connection>(
    name: N,
    connection: &C
) -> Result<Option<OwnedDocument>, Error>where
    Self: SerializedCollection + Sized,

Loads a document from this collection by name, if applicable. Return Ok(None) if unsupported.

fn load_document_async<'name, 'life0, 'async_trait, N, C>(
    name: N,
    connection: &'life0 C
) -> Pin<Box<dyn Future<Output = Result<Option<OwnedDocument>, Error>> + Send + 'async_trait>>where
    Self: SerializedCollection + Sized + Send + 'async_trait,
    N: 'async_trait + Nameable<'name, Self::PrimaryKey> + Send + Sync,
    C: 'async_trait + AsyncConnection,
    'name: 'async_trait,
    'life0: 'async_trait,

Loads a document from this collection by name, if applicable. Return Ok(None) if unsupported.

fn delete_by_name<C: Connection>(
    name: &str,
    connection: &C
) -> Result<bool, Error>where
    Self: SerializedCollection + Sized,

Deletes a document by its name. Returns true if a document was deleted.

fn delete_by_name_async<'life0, 'life1, 'async_trait, C>(
    name: &'life0 str,
    connection: &'life1 C
) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'async_trait>>where
    Self: SerializedCollection + Sized + Send + 'async_trait,
    C: 'async_trait + AsyncConnection,
    'life0: 'async_trait,
    'life1: 'async_trait,

Deletes a document by its name. Returns true if a document was deleted.

impl PartialEq<Database> for Database

fn eq(&self, other: &Database) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Database

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Database

impl StructuralEq for Database

impl StructuralPartialEq for Database