Enum bonsaidb::core::transaction::Command

pub enum Command {
    Insert {
        id: Option<DocumentId>,
        contents: Bytes,
    },
    Update {
        header: Header,
        contents: Bytes,
    },
    Overwrite {
        id: DocumentId,
        contents: Bytes,
    },
    Delete {
        header: Header,
    },
    Check {
        id: DocumentId,
        revision: Option<Revision>,
    },
}

A command to execute within a Collection.

Variants

Insert

Fields

id: Option<DocumentId>

An optional id for the document. If this is None, a unique id will be generated. If this is Some() and a document already exists with that id, a conflict error will be returned.

contents: Bytes

The initial contents of the document.

Inserts a new document containing contents.

Update

Fields

header: Header

The header of the Document. The revision must match the current document.

contents: Bytes

The new contents to store within the Document.

Update an existing Document identified by header. header.revision must match the currently stored revision on the Document. If it does not, the command fill fail with a DocumentConflict error.

Overwrite

Fields

id: DocumentId

The id of the document to overwrite.

contents: Bytes

The new contents to store within the Document.

Overwrite an existing Document identified by id. The revision will not be checked before the document is updated. If the document does not exist, it will be created.

Delete

Fields

header: Header

The current header of the Document.

Delete an existing Document identified by id. revision must match the currently stored revision on the Document. If it does not, the command fill fail with a DocumentConflict error.

Check

Fields

id: DocumentId

The id of the document to check.

revision: Option<Revision>

The revision of the document to check.

Checks whether a document exists, and optionally whether its revision is still current. If the document is not found, a DocumentNotFound error will be returned. If the document revision is provided and does not match, a DocumentConflict error will be returned.

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Command

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Command

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Command

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

where __S: Serializer,

Serialize this value into the given Serde serializer.