typesense 0.4.0

Client for typesense
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

//! Provides access to the collection and alias-related API endpoints.
//!
//! A `Collections` instance is created via the main `client.collections()` method.

use crate::{Client, Error, execute_wrapper};
use typesense_codegen::{
    apis::collections_api::{self, GetCollectionsParams},
    models::{self, GetCollectionsParameters},
};

/// Provides methods for interacting with Typesense collections and aliases.
///
/// This struct is created by calling `client.collections()`.
pub struct Collections<'c> {
    pub(super) client: &'c Client,
}

impl<'c> Collections<'c> {
    /// Creates a new `Collection` instance
    #[inline]
    pub(super) fn new(client: &'c Client) -> Self {
        Self { client }
    }

    /// Creates a new collection with the given schema.
    ///
    /// # Arguments
    /// * `schema` - A `CollectionSchema` object describing the collection to be created.
    pub async fn create(
        &self,
        schema: models::CollectionSchema<'_>,
    ) -> Result<models::CollectionResponse, Error<collections_api::CreateCollectionError>> {
        let params = collections_api::CreateCollectionParams {
            collection_schema: schema,
        };
        execute_wrapper!(self, collections_api::create_collection, params)
    }

    /// List the existing Typesense collections.
    pub async fn retrieve(
        &self,
        params: GetCollectionsParameters<'_>,
    ) -> Result<Vec<models::CollectionResponse>, Error<collections_api::GetCollectionsError>> {
        let params = GetCollectionsParams {
            exclude_fields: params.exclude_fields,
            limit: params.limit,
            offset: params.offset,
        };
        execute_wrapper!(self, collections_api::get_collections, params)
    }
}