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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
use crate::error::Error;
use crate::models::context::SolrServerContext;
use crate::models::response::SolrResponse;
use crate::queries::alias::{alias_exists, create_alias, delete_alias, get_aliases};
use crate::queries::collection::{
collection_exists, create_collection, delete_collection, get_collections,
};
use crate::queries::config::{config_exists, delete_config, get_configs, upload_config};
use crate::queries::index::{DeleteQuery, UpdateQuery};
use crate::queries::select::SelectQuery;
use crate::SelectDestination;
use serde::Serialize;
use serde_json::Value;
use std::collections::HashMap;
use std::path::Path;
/// Async client for SolrCloud
/// # Examples
/// ```rust
/// use solrstice::{AsyncSolrCloudClient, SolrServerContextBuilder, SolrSingleServerHost};
/// let context = SolrServerContextBuilder::new(SolrSingleServerHost::new("http://localhost:8983")).build();
/// let client = AsyncSolrCloudClient::new(context);
/// ```
#[derive(Clone)]
pub struct AsyncSolrCloudClient {
/// The solr server context used to specify how to connect to Solr
pub context: SolrServerContext,
}
impl AsyncSolrCloudClient {
/// Create a new instance of AsyncSolrCloudClient
/// # Examples
/// ```rust
/// use solrstice::{AsyncSolrCloudClient, SolrServerContextBuilder, SolrSingleServerHost};
/// let context = SolrServerContextBuilder::new(SolrSingleServerHost::new("http://localhost:8983")).build();
/// let client = AsyncSolrCloudClient::new(context);
/// ```
pub fn new<C: Into<SolrServerContext>>(context: C) -> AsyncSolrCloudClient {
AsyncSolrCloudClient {
context: context.into(),
}
}
/// Upload a config to SolrCloud
/// # Examples
/// ```no_run
/// # use std::path::Path;
/// # use solrstice::{AsyncSolrCloudClient, SolrServerContextBuilder, SolrSingleServerHost};
/// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
/// let context = SolrServerContextBuilder::new(SolrSingleServerHost::new("http://localhost:8983")).build();
/// let client = AsyncSolrCloudClient::new(context);
/// client.upload_config("config_name", Path::new("/path/to/config")).await?;
/// # Ok(())
/// # }
/// ```
pub async fn upload_config<N: AsRef<str>, P: AsRef<Path>>(
&self,
name: N,
path: P,
) -> Result<(), Error> {
upload_config(&self.context, name, path).await
}
/// Get the configs existing in SolrCloud
/// # Examples
/// ```no_run
/// # use std::path::Path;
/// # use solrstice::AsyncSolrCloudClient;
/// # use solrstice::SolrSingleServerHost;
/// # use solrstice::SolrServerContextBuilder;
/// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
/// let context = SolrServerContextBuilder::new(SolrSingleServerHost::new("http://localhost:8983")).build();
/// let client = AsyncSolrCloudClient::new(context);
/// let configs: Vec<String> = client.get_configs().await?;
/// # Ok(())
/// # }
/// ```
pub async fn get_configs(&self) -> Result<Vec<String>, Error> {
get_configs(&self.context).await
}
/// Check if a config exists in SolrCloud
/// # Examples
/// ```no_run
/// # use std::path::Path;
/// # use solrstice::AsyncSolrCloudClient;
/// # use solrstice::SolrSingleServerHost;
/// # use solrstice::SolrServerContextBuilder;
/// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
/// let context = SolrServerContextBuilder::new(SolrSingleServerHost::new("http://localhost:8983")).build();
/// let client = AsyncSolrCloudClient::new(context);
/// let exists: bool = client.config_exists("config_name").await?;
/// # Ok(())
/// # }
/// ```
pub async fn config_exists<S: AsRef<str>>(&self, name: S) -> Result<bool, Error> {
config_exists(&self.context, name).await
}
/// Delete a config from SolrCloud
/// # Examples
/// ```no_run
/// # use std::path::Path;
/// # use solrstice::AsyncSolrCloudClient;
/// # use solrstice::SolrSingleServerHost;
/// # use solrstice::SolrServerContextBuilder;
/// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
/// let context = SolrServerContextBuilder::new(SolrSingleServerHost::new("http://localhost:8983")).build();
/// let client = AsyncSolrCloudClient::new(context);
/// client.delete_config("config_name").await?;
/// # Ok(())
/// # }
/// ```
pub async fn delete_config<N: AsRef<str>>(&self, name: N) -> Result<(), Error> {
delete_config(&self.context, name).await
}
/// Create a collection in SolrCloud
/// # Examples
/// ```no_run
/// # use solrstice::AsyncSolrCloudClient;
/// # use solrstice::SolrSingleServerHost;
/// # use solrstice::SolrServerContextBuilder;
/// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
/// let context = SolrServerContextBuilder::new(SolrSingleServerHost::new("http://localhost:8983")).build();
/// let client = AsyncSolrCloudClient::new(context);
/// client.create_collection("collection_name", "config_name", 1, 1).await?;
/// # Ok(())
/// # }
/// ```
pub async fn create_collection<S: AsRef<str>>(
&self,
name: S,
config: S,
shards: usize,
replication_factor: usize,
) -> Result<(), Error> {
create_collection(&self.context, name, config, shards, replication_factor).await
}
/// Get collections from SolrCloud
/// # Examples
/// ```no_run
/// # use solrstice::AsyncSolrCloudClient;
/// # use solrstice::SolrSingleServerHost;
/// # use solrstice::SolrServerContextBuilder;
/// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
/// let context = SolrServerContextBuilder::new(SolrSingleServerHost::new("http://localhost:8983")).build();
/// let client = AsyncSolrCloudClient::new(context);
/// let collections: Vec<String> = client.get_collections().await?;
/// # Ok(())
/// # }
/// ```
pub async fn get_collections(&self) -> Result<Vec<String>, Error> {
get_collections(&self.context).await
}
/// Check if a collection exists in SolrCloud
/// # Examples
/// ```no_run
/// # use solrstice::AsyncSolrCloudClient;
/// # use solrstice::SolrSingleServerHost;
/// # use solrstice::SolrServerContextBuilder;
/// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
/// let context = SolrServerContextBuilder::new(SolrSingleServerHost::new("http://localhost:8983")).build();
/// let client = AsyncSolrCloudClient::new(context);
/// let exists: bool = client.collection_exists("collection_name").await?;
/// # Ok(())
/// # }
/// ```
pub async fn collection_exists<S: AsRef<str>>(&self, name: S) -> Result<bool, Error> {
collection_exists(&self.context, name).await
}
/// Delete a collection from SolrCloud
/// # Examples
/// ```no_run
/// # use solrstice::AsyncSolrCloudClient;
/// # use solrstice::SolrSingleServerHost;
/// # use solrstice::SolrServerContextBuilder;
/// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
/// let context = SolrServerContextBuilder::new(SolrSingleServerHost::new("http://localhost:8983")).build();
/// let client = AsyncSolrCloudClient::new(context);
/// client.delete_collection("collection_name").await?;
/// # Ok(())
/// # }
/// ```
pub async fn delete_collection<N: AsRef<str>>(&self, name: N) -> Result<(), Error> {
delete_collection(&self.context, name).await
}
/// Create an alias in SolrCloud
/// # Examples
/// ```no_run
/// # use solrstice::AsyncSolrCloudClient;
/// # use solrstice::SolrSingleServerHost;
/// # use solrstice::SolrServerContextBuilder;
/// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
/// let context = SolrServerContextBuilder::new(SolrSingleServerHost::new("http://localhost:8983")).build();
/// let client = AsyncSolrCloudClient::new(context);
/// client.create_alias("alias_name", &["collection1", "collection2"]).await?;
/// # Ok(())
/// # }
/// ```
pub async fn create_alias<S: AsRef<str>>(
&self,
alias: S,
collections: &[S],
) -> Result<(), Error> {
create_alias(&self.context, alias, collections).await
}
/// Get aliases from SolrCloud
/// # Examples
/// ```no_run
/// # use std::collections::HashMap;
/// # use solrstice::AsyncSolrCloudClient;
/// # use solrstice::SolrSingleServerHost;
/// # use solrstice::SolrServerContextBuilder;
/// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
/// let context = SolrServerContextBuilder::new(SolrSingleServerHost::new("http://localhost:8983")).build();
/// let client = AsyncSolrCloudClient::new(context);
/// let aliases: HashMap<String, Vec<String>> = client.get_aliases().await?;
/// # Ok(())
/// # }
/// ```
pub async fn get_aliases(&self) -> Result<HashMap<String, Vec<String>>, Error> {
get_aliases(&self.context).await
}
/// Check if an alias exists in SolrCloud
/// # Examples
/// ```no_run
/// # use solrstice::AsyncSolrCloudClient;
/// # use solrstice::SolrSingleServerHost;
/// # use solrstice::SolrServerContextBuilder;
/// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
/// let context = SolrServerContextBuilder::new(SolrSingleServerHost::new("http://localhost:8983")).build();
/// let client = AsyncSolrCloudClient::new(context);
/// let exists: bool = client.alias_exists("alias_name").await?;
/// # Ok(())
/// # }
/// ```
pub async fn alias_exists<N: AsRef<str>>(&self, name: N) -> Result<bool, Error> {
alias_exists(&self.context, name).await
}
/// Delete an alias from SolrCloud
/// # Examples
/// ```no_run
/// # use solrstice::AsyncSolrCloudClient;
/// # use solrstice::SolrSingleServerHost;
/// # use solrstice::SolrServerContextBuilder;
/// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
/// let context = SolrServerContextBuilder::new(SolrSingleServerHost::new("http://localhost:8983")).build();
/// let client = AsyncSolrCloudClient::new(context);
/// client.delete_alias("alias_name").await?;
/// # Ok(())
/// # }
/// ```
pub async fn delete_alias<S: AsRef<str>>(&self, name: S) -> Result<(), Error> {
delete_alias(&self.context, name).await
}
/// Index some data into SolrCloud
/// # Examples
/// ```no_run
/// # use solrstice::AsyncSolrCloudClient;
/// # use solrstice::SolrSingleServerHost;
/// # use solrstice::SolrServerContextBuilder;
/// # use solrstice::UpdateQuery;
/// # use serde::Serialize;
/// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
/// #[derive(Serialize)]
/// struct Data {id: String}
///
/// let context = SolrServerContextBuilder::new(SolrSingleServerHost::new("http://localhost:8983")).build();
/// let client = AsyncSolrCloudClient::new(context);
/// let response = client.index(&UpdateQuery::new(), "collection_name", &[Data {id: "test".to_string()}]).await?;
/// # Ok(())
/// # }
/// ```
pub async fn index<T: Serialize, B: AsRef<UpdateQuery>, C: AsRef<str>>(
&self,
builder: B,
collection: C,
data: &[T],
) -> Result<SolrResponse, Error> {
builder
.as_ref()
.execute(&self.context, collection, data)
.await
}
/// Select some data from SolrCloud
/// # Examples
/// ```no_run
/// # use solrstice::AsyncSolrCloudClient;
/// # use solrstice::SolrSingleServerHost;
/// # use solrstice::SolrServerContextBuilder;
/// # use solrstice::SelectQuery;
/// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
/// let context = SolrServerContextBuilder::new(SolrSingleServerHost::new("http://localhost:8983")).build();
/// let client = AsyncSolrCloudClient::new(context);
/// let response = client.select(&SelectQuery::new().fq(["age:[* TO *]"]), "collection_name").await?;
/// # Ok(())
/// # }
/// ```
pub async fn select<B: AsRef<SelectQuery>, D: Into<SelectDestination>>(
&self,
builder: B,
destination: D,
) -> Result<SolrResponse, Error> {
builder
.as_ref()
.execute(&self.context, destination.into())
.await
}
/// Select some data from SolrCloud. Return the response directly
/// # Examples
/// ```no_run
/// # use std::collections::HashMap;
/// # use solrstice::AsyncSolrCloudClient;
/// # use solrstice::SolrSingleServerHost;
/// # use solrstice::SolrServerContextBuilder;
/// # use solrstice::SelectQuery;
/// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
/// let context = SolrServerContextBuilder::new(SolrSingleServerHost::new("http://localhost:8983")).build();
/// let client = AsyncSolrCloudClient::new(context);
/// let response: HashMap<String, serde_json::Value> = client.select_raw(&SelectQuery::new().fq(["age:[* TO *]"]), "collection_name").await?;
/// # Ok(())
/// # }
/// ```
pub async fn select_raw<B: AsRef<SelectQuery>, D: Into<SelectDestination>>(
&self,
builder: B,
destination: D,
) -> Result<HashMap<String, Value>, Error> {
builder
.as_ref()
.execute_raw(&self.context, destination.into())
.await
}
/// Delete some data from SolrCloud
/// # Examples
/// ```no_run
/// # use solrstice::AsyncSolrCloudClient;
/// # use solrstice::SolrSingleServerHost;
/// # use solrstice::SolrServerContextBuilder;
/// # use solrstice::DeleteQuery;
/// # use solrstice::SelectQuery;
/// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
/// let context = SolrServerContextBuilder::new(SolrSingleServerHost::new("http://localhost:8983")).build();
/// let client = AsyncSolrCloudClient::new(context);
/// let response = client.delete(&DeleteQuery::new().ids(["document1"]).queries(["age:[* TO *]"]), "collection_name").await?;
/// # Ok(())
/// # }
/// ```
pub async fn delete<B: AsRef<DeleteQuery>, C: AsRef<str>>(
&self,
builder: B,
collection: C,
) -> Result<SolrResponse, Error> {
builder.as_ref().execute(&self.context, collection).await
}
}