Struct bonsaidb::core::connection::View

pub struct View<'a, Cn, V> where
    V: SerializedView,  {
    pub key: Option<QueryKey<<V as View>::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 as View>::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 as View>::Key) -> View<'a, Cn, V>

Filters for entries in the view with key.

pub fn with_keys<IntoIter>(self, keys: IntoIter) -> View<'a, Cn, V> where
    IntoIter: IntoIterator<Item = <V as View>::Key>, 

Filters for entries in the view with keys.

pub fn with_key_range<R>(self, range: R) -> View<'a, Cn, V> where
    R: Into<Range<<V as View>::Key>>, 

Filters for entries in the view with the range keys.

pub fn with_access_policy(self, policy: AccessPolicy) -> View<'a, Cn, V>

Sets the access policy for queries.

pub fn ascending(self) -> View<'a, Cn, V>

Queries the view in ascending order.

pub fn descending(self) -> View<'a, Cn, V>

Queries the view in descending order.

pub fn limit(self, maximum_results: usize) -> View<'a, Cn, V>

Sets the maximum number of results to return.

pub async fn query(
    self
) -> Result<Vec<Map<<V as View>::Key, <V as View>::Value>, Global>, 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 as View>::Collection>, V>, Error> where
    <V as View>::Collection: SerializedCollection,
    <<V as View>::Collection as SerializedCollection>::Contents: Debug, 

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

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

Executes a reduce over the results of the query

pub async fn reduce_grouped(
    self
) -> Result<Vec<MappedValue<<V as View>::Key, <V as View>::Value>, Global>, 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.