Enum pliantdb_core::networking::DatabaseRequest

pub enum DatabaseRequest {
    Get {
        collection: CollectionName,
        id: u64,
    },
    GetMultiple {
        collection: CollectionName,
        ids: Vec<u64>,
    },
    Query {
        view: ViewName,
        key: Option<QueryKey<Vec<u8>>>,
        access_policy: AccessPolicy,
        with_docs: bool,
    },
    Reduce {
        view: ViewName,
        key: Option<QueryKey<Vec<u8>>>,
        access_policy: AccessPolicy,
        grouped: bool,
    },
    ApplyTransaction {
        transaction: Transaction<'static>,
    },
    ListExecutedTransactions {
        starting_id: Option<u64>,
        result_limit: Option<usize>,
    },
    LastTransactionId,
    CreateSubscriber,
    Publish {
        topic: String,
        payload: Vec<u8>,
    },
    PublishToAll {
        topics: Vec<String>,
        payload: Vec<u8>,
    },
    SubscribeTo {
        subscriber_id: u64,
        topic: String,
    },
    UnsubscribeFrom {
        subscriber_id: u64,
        topic: String,
    },
    UnregisterSubscriber {
        subscriber_id: u64,
    },
    ExecuteKeyOperation(KeyOperation),
}

A database-related request.

Variants

Get

Retrieve a single document.

Fields of Get

collection: CollectionName

The collection of the document.

id: u64

The id of the document.

GetMultiple

Retrieve multiple documents.

Fields of GetMultiple

collection: CollectionName

The collection of the documents.

ids: Vec<u64>

The ids of the documents.

Query

Queries a view.

Fields of Query

view: ViewName

The name of the view.

key: Option<QueryKey<Vec<u8>>>

The filter for the view.

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.

Reduce

Reduces a view.

Fields of Reduce

view: ViewName

The name of the view.

key: Option<QueryKey<Vec<u8>>>

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.

ApplyTransaction

Applies a transaction.

Fields of ApplyTransaction

transaction: Transaction<'static>

The trasnaction to apply.

ListExecutedTransactions

Lists executed transactions.

Fields of ListExecutedTransactions

starting_id: Option<u64>

The starting transaction id.

result_limit: Option<usize>

The maximum number of results.

LastTransactionId

Queries the last transaction id.

CreateSubscriber

Creates a PubSub Subscriber

Publish

Publishes payload to all subscribers of topic.

Fields of Publish

topic: String

The topics to publish to.

payload: Vec<u8>

The payload to publish.

PublishToAll

Publishes payload to all subscribers of all topics.

Fields of PublishToAll

topics: Vec<String>

The topics to publish to.

payload: Vec<u8>

The payload to publish.

SubscribeTo

Subscribes subscriber_id to messages for topic.

Fields of SubscribeTo

subscriber_id: u64

The id of the Subscriber.

topic: String

The topic to subscribe to.

UnsubscribeFrom

Unsubscribes subscriber_id from messages for topic.

Fields of UnsubscribeFrom

subscriber_id: u64

The id of the Subscriber.

topic: String

The topic to unsubscribe from.

UnregisterSubscriber

Unregisters the subscriber.

Fields of UnregisterSubscriber

subscriber_id: u64

The id of the Subscriber.

ExecuteKeyOperation(KeyOperation)

Excutes a key-value store operation.

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.