Enum bonsaidb_core::networking::DatabaseRequest

pub enum DatabaseRequest {
    Get {
        collection: CollectionName,
        id: DocumentId,
    },
    GetMultiple {
        collection: CollectionName,
        ids: Vec<DocumentId>,
    },
    List {
        collection: CollectionName,
        ids: Range<DocumentId>,
        order: Sort,
        limit: Option<usize>,
    },
    Query {
        view: ViewName,
        key: Option<QueryKey<Bytes>>,
        order: Sort,
        limit: Option<usize>,
        access_policy: AccessPolicy,
        with_docs: bool,
    },
    Reduce {
        view: ViewName,
        key: Option<QueryKey<Bytes>>,
        access_policy: AccessPolicy,
        grouped: bool,
    },
    DeleteDocs {
        view: ViewName,
        key: Option<QueryKey<Bytes>>,
        access_policy: AccessPolicy,
    },
    ApplyTransaction {
        transaction: Transaction,
    },
    ListExecutedTransactions {
        starting_id: Option<u64>,
        result_limit: Option<usize>,
    },
    LastTransactionId,
    CreateSubscriber,
    Publish {
        topic: String,
        payload: Bytes,
    },
    PublishToAll {
        topics: Vec<String>,
        payload: Bytes,
    },
    SubscribeTo {
        subscriber_id: u64,
        topic: String,
    },
    UnsubscribeFrom {
        subscriber_id: u64,
        topic: String,
    },
    UnregisterSubscriber {
        subscriber_id: u64,
    },
    ExecuteKeyOperation(KeyOperation),
    CompactCollection {
        name: CollectionName,
    },
    CompactKeyValueStore,
    Compact,
}

A database-related request.

Variants

Get

Fields

collection: CollectionName

The collection of the document.

id: DocumentId

The id of the document.

Retrieve a single document.

GetMultiple

Fields

collection: CollectionName

The collection of the documents.

ids: Vec<DocumentId>

The ids of the documents.

Retrieve multiple documents.

List

Fields

collection: CollectionName

The collection of the documents.

ids: Range<DocumentId>

The range of ids to list.

order: Sort

The order for the query into the collection.

limit: Option<usize>

The maximum number of results to return.

Retrieve multiple documents.

Query

Fields

view: ViewName

The name of the view.

key: Option<QueryKey<Bytes>>

The filter for the view.

order: Sort

The order for the query into the view.

limit: Option<usize>

The maximum number of results to return.

access_policy: AccessPolicy

The access policy for the query.

with_docs: bool

If true, DatabaseResponse::ViewMappingsWithDocs will be returned. If false, DatabaseResponse::ViewMappings will be returned.

Queries a view.

Reduce

Fields

view: ViewName

The name of the view.

key: Option<QueryKey<Bytes>>

The filter for the view.

access_policy: AccessPolicy

The access policy for the query.

grouped: bool

Whether to return a single value or values grouped by unique key. If true, DatabaseResponse::ViewGroupedReduction will be returned. If false, DatabaseResponse::ViewReduction is returned.

Reduces a view.

DeleteDocs

Fields

view: ViewName

The name of the view.

key: Option<QueryKey<Bytes>>

The filter for the view.

access_policy: AccessPolicy

The access policy for the query.

Deletes the associated documents resulting from the view query.

ApplyTransaction

Fields

transaction: Transaction

The trasnaction to apply.

Applies a transaction.

ListExecutedTransactions

Fields

starting_id: Option<u64>

The starting transaction id.

result_limit: Option<usize>

The maximum number of results.

Lists executed transactions.

LastTransactionId

Queries the last transaction id.

CreateSubscriber

Creates a PubSub Subscriber

Publish

Fields

topic: String

The topics to publish to.

payload: Bytes

The payload to publish.

Publishes payload to all subscribers of topic.

PublishToAll

Fields

topics: Vec<String>

The topics to publish to.

payload: Bytes

The payload to publish.

Publishes payload to all subscribers of all topics.

SubscribeTo

Fields

subscriber_id: u64

The id of the Subscriber.

topic: String

The topic to subscribe to.

Subscribes subscriber_id to messages for topic.

UnsubscribeFrom

Fields

subscriber_id: u64

The id of the Subscriber.

topic: String

The topic to unsubscribe from.

Unsubscribes subscriber_id from messages for topic.

UnregisterSubscriber

Fields

subscriber_id: u64

The id of the Subscriber.

Unregisters the subscriber.

ExecuteKeyOperation(KeyOperation)

Excutes a key-value store operation.

CompactCollection

Fields

name: CollectionName

The name of the collection to compact.

Compacts the collection.

CompactKeyValueStore

Compacts the key-value store.

Compact

Compacts the entire database.

Trait Implementations

impl Clone for DatabaseRequest

fn clone(&self) -> DatabaseRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DatabaseRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DatabaseRequest

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

Deserialize this value from the given Serde deserializer.

impl Serialize for DatabaseRequest

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

Serialize this value into the given Serde serializer.