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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

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

mod document;
mod documents;

use crate::{Client, Error, execute_wrapper};
use ::std::borrow::Cow;
use serde::{Serialize, de::DeserializeOwned};
use typesense_codegen::{apis::collections_api, models};

/// Provides methods for interacting with a Typesense collection.
///
/// This struct is created by calling `client.collection()`.
pub struct Collection<'c, D = serde_json::Value>
where
    D: DeserializeOwned + Serialize,
{
    client: &'c Client,
    collection_name: Cow<'c, str>,
    _phantom: core::marker::PhantomData<D>,
}

impl<'c, D> Collection<'c, D>
where
    D: DeserializeOwned + Serialize,
{
    /// Creates a new `Collection` instance.
    #[inline]
    pub(super) fn new(client: &'c Client, collection_name: impl Into<Cow<'c, str>>) -> Self {
        Self {
            client,
            collection_name: collection_name.into(),
            _phantom: core::marker::PhantomData,
        }
    }

    /// Provides access to the document-related API endpoints for a specific collection.
    #[inline]
    pub fn documents<'d>(&'d self) -> documents::Documents<'d, D> {
        documents::Documents::new(self.client, &self.collection_name)
    }

    /// Provides access to the API endpoints for a single document within a Typesense collection.
    #[inline]
    pub fn document<'d>(
        &'d self,
        document_id: impl Into<Cow<'d, str>>,
    ) -> document::Document<'d, D> {
        document::Document::new(self.client, &self.collection_name, document_id)
    }

    /// Retrieves the details of a collection, given its name.
    #[inline]
    pub async fn retrieve(
        &self,
    ) -> Result<models::CollectionResponse, Error<collections_api::GetCollectionError>> {
        let params = collections_api::GetCollectionParams {
            collection_name: self.collection_name.as_ref().into(),
        };
        execute_wrapper!(self, collections_api::get_collection, params)
    }

    /// Permanently drops a collection.
    #[inline]
    pub async fn delete(
        &self,
    ) -> Result<models::CollectionResponse, Error<collections_api::DeleteCollectionError>> {
        let params = collections_api::DeleteCollectionParams {
            collection_name: self.collection_name.as_ref().into(),
        };
        execute_wrapper!(self, collections_api::delete_collection, params)
    }

    /// Updates a collection's schema to modify the fields and their types.
    ///
    /// # Arguments
    /// * `update_schema` - A `CollectionUpdateSchema` object describing the fields to update.
    #[inline]
    pub async fn update(
        &self,
        update_schema: models::CollectionUpdateSchema,
    ) -> Result<models::CollectionUpdateSchema, Error<collections_api::UpdateCollectionError>> {
        let params = collections_api::UpdateCollectionParams {
            collection_name: self.collection_name.as_ref().into(),
            collection_update_schema: update_schema,
        };
        execute_wrapper!(self, collections_api::update_collection, params)
    }
}