vectrixdb 2.2.0

Client for VectrixDB: collections, documents, text search, sources.
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

//! A synchronous client, behind the `blocking` feature.

use serde_json::Value;

use crate::error::{Error, Result};
use crate::types::{
    AddOptions, Added, Collection, CreateOptions, Document, Hit, Refreshed, SearchOptions, Source,
    SourceOptions, Text,
};
use crate::Client;

/// The same calls as [`Client`], each one blocking until it is answered.
///
/// It drives the async client on a runtime of its own, so it must not be
/// used from inside another async runtime.
pub struct BlockingClient {
    inner: Client,
    runtime: tokio::runtime::Runtime,
}

impl std::fmt::Debug for BlockingClient {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("BlockingClient")
            .field("url", &self.inner.url())
            .finish()
    }
}

impl BlockingClient {
    pub(crate) fn from_client(inner: Client) -> Result<BlockingClient> {
        let runtime = tokio::runtime::Builder::new_current_thread()
            .enable_all()
            .build()
            .map_err(|e| Error::Transport(format!("could not start a runtime: {e}")))?;
        Ok(BlockingClient { inner, runtime })
    }

    /// The async client underneath.
    pub fn inner(&self) -> &Client {
        &self.inner
    }

    pub fn health(&self) -> Result<bool> {
        self.runtime.block_on(self.inner.health())
    }

    pub fn ready(&self) -> Result<bool> {
        self.runtime.block_on(self.inner.ready())
    }

    pub fn whoami(&self) -> Result<Value> {
        self.runtime.block_on(self.inner.whoami())
    }

    pub fn collections(&self) -> Result<Vec<Collection>> {
        self.runtime.block_on(self.inner.collections())
    }

    pub fn describe(&self, name: &str) -> Result<Collection> {
        self.runtime.block_on(self.inner.describe(name))
    }

    pub fn create_collection(&self, name: &str, options: CreateOptions) -> Result<Collection> {
        self.runtime
            .block_on(self.inner.create_collection(name, options))
    }

    pub fn delete_collection(&self, name: &str) -> Result<()> {
        self.runtime.block_on(self.inner.delete_collection(name))
    }

    pub fn add_document(
        &self,
        collection: &str,
        bytes: impl AsRef<[u8]>,
        filename: &str,
        options: AddOptions,
    ) -> Result<Added> {
        self.runtime.block_on(
            self.inner
                .add_document(collection, bytes, filename, options),
        )
    }

    pub fn add_texts(&self, collection: &str, texts: Vec<Text>) -> Result<u64> {
        self.runtime
            .block_on(self.inner.add_texts(collection, texts))
    }

    pub fn search(
        &self,
        collection: &str,
        query: &str,
        options: SearchOptions,
    ) -> Result<Vec<Hit>> {
        self.runtime
            .block_on(self.inner.search(collection, query, options))
    }

    pub fn documents(&self, collection: &str) -> Result<Vec<Document>> {
        self.runtime.block_on(self.inner.documents(collection))
    }

    pub fn open_document(&self, collection: &str, doc_id: &str) -> Result<String> {
        self.runtime
            .block_on(self.inner.open_document(collection, doc_id))
    }

    pub fn delete_document(&self, collection: &str, doc_id: &str) -> Result<u64> {
        self.runtime
            .block_on(self.inner.delete_document(collection, doc_id))
    }

    pub fn sources(&self, collection: &str) -> Result<Vec<Source>> {
        self.runtime.block_on(self.inner.sources(collection))
    }

    pub fn add_source(
        &self,
        collection: &str,
        address: &str,
        options: SourceOptions,
    ) -> Result<Source> {
        self.runtime
            .block_on(self.inner.add_source(collection, address, options))
    }

    pub fn refresh_sources(&self, collection: &str) -> Result<Refreshed> {
        self.runtime
            .block_on(self.inner.refresh_sources(collection))
    }

    pub fn delete_source(
        &self,
        collection: &str,
        source_id: &str,
        delete_documents: bool,
    ) -> Result<()> {
        self.runtime.block_on(
            self.inner
                .delete_source(collection, source_id, delete_documents),
        )
    }
}