Struct bonsaidb_core::connection::View

pub struct View<'a, Cn, V: SerializedView> {
    pub key: Option<QueryKey<V::Key>>,
    pub access_policy: AccessPolicy,
    pub sort: Sort,
    pub limit: Option<usize>,
    /* private fields */
}

Parameters to query a schema::View.

Fields

key: Option<QueryKey<V::Key>>

Key filtering criteria.

access_policy: AccessPolicy

The view’s data access policy. The default value is AccessPolicy::UpdateBefore.

sort: Sort

The sort order of the query.

limit: Option<usize>

The maximum number of results to return.

Implementations

impl<'a, Cn, V> View<'a, Cn, V> where
    V: SerializedView,
    Cn: Connection, 

pub fn with_key(self, key: V::Key) -> Self

Filters for entries in the view with key.

pub fn with_keys<IntoIter: IntoIterator<Item = V::Key>>(
    self,
    keys: IntoIter
) -> Self

Filters for entries in the view with keys.

pub fn with_key_range<R: Into<Range<V::Key>>>(self, range: R) -> Self

Filters for entries in the view with the range keys.

pub fn with_access_policy(self, policy: AccessPolicy) -> Self

Sets the access policy for queries.

pub fn ascending(self) -> Self

Queries the view in ascending order.

pub fn descending(self) -> Self

Queries the view in descending order.

pub fn limit(self, maximum_results: usize) -> Self

Sets the maximum number of results to return.

pub async fn query(self) -> Result<Vec<Map<V::Key, V::Value>>, Error>

Executes the query and retrieves the results.

pub async fn query_with_docs(
    self
) -> Result<MappedDocuments<OwnedDocument, V>, Error>

Executes the query and retrieves the results with the associated Documents.

pub async fn query_with_collection_docs(
    self
) -> Result<MappedDocuments<CollectionDocument<V::Collection>, V>, Error> where
    V::Collection: SerializedCollection,
    <V::Collection as SerializedCollection>::Contents: Debug, 

Executes the query and retrieves the results with the associated CollectionDocuments.

pub async fn reduce(self) -> Result<V::Value, Error>

Executes a reduce over the results of the query

pub async fn reduce_grouped(
    self
) -> Result<Vec<MappedValue<V::Key, V::Value>>, Error>

Executes a reduce over the results of the query

pub async fn delete_docs(self) -> Result<u64, Error>

Deletes all of the associated documents that match this view query.