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 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
use crate::{errors::*, indexes::*, request::*, Rc};
use serde_json::{json, Value};
use serde::{Deserialize};
use std::collections::HashMap;
/// The top-level struct of the SDK, representing a client containing [indexes](../indexes/struct.Index.html).
#[derive(Debug)]
pub struct Client {
pub(crate) host: Rc<String>,
pub(crate) api_key: Rc<String>,
}
impl Client {
/// Create a client using the specified server.
/// Don't put a '/' at the end of the host.
/// In production mode, see [the documentation about authentication](https://docs.meilisearch.com/reference/features/authentication.html#authentication).
/// # Example
///
/// ```
/// # use meilisearch_sdk::{client::*, indexes::*};
/// #
/// // create the client
/// let client = Client::new("http://localhost:7700", "masterKey");
/// ```
pub fn new(host: impl Into<String>, api_key: impl Into<String>) -> Client {
Client {
host: Rc::new(host.into()),
api_key: Rc::new(api_key.into())
}
}
/// List all [indexes] and returns values as instances of Index(../indexes/struct.Index.html).
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::{client::*, indexes::*};
/// # futures::executor::block_on(async move {
/// // create the client
/// let client = Client::new("http://localhost:7700", "masterKey");
///
/// let indexes: Vec<Index> = client.list_all_indexes().await.unwrap();
/// println!("{:?}", indexes);
/// # });
/// ```
pub async fn list_all_indexes(&self) -> Result<Vec<Index>, Error> {
match self.list_all_indexes_raw().await{
Ok (json_indexes) => Ok({
let mut indexes = Vec::new();
for json_index in json_indexes {
indexes.push(json_index.into_index(self))
}
indexes
}),
Err(error) => Err(error),
}
}
/// List all [indexes] and returns as Json (../indexes/struct.Index.html).
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::{client::*, indexes::*};
/// # futures::executor::block_on(async move {
/// // create the client
/// let client = Client::new("http://localhost:7700", "masterKey");
///
/// let json_indexes: Vec<JsonIndex> = client.list_all_indexes_raw().await.unwrap();
/// println!("{:?}", json_indexes);
/// # });
/// ```
pub async fn list_all_indexes_raw(&self) -> Result<Vec<JsonIndex>, Error> {
let json_indexes = request::<(), Vec<JsonIndex>>(
&format!("{}/indexes", self.host),
&self.api_key,
Method::Get,
200,
).await?;
Ok(json_indexes)
}
/// Get an [index](../indexes/struct.Index.html).
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::{client::*, indexes::*};
///
/// # futures::executor::block_on(async move {
/// // create the client
/// let client = Client::new("http://localhost:7700", "masterKey");
/// # client.create_index("movies", None).await;
///
/// // get the index named "movies"
/// let movies = client.get_index("movies").await.unwrap();
/// # });
/// ```
pub async fn get_index(&self, uid: impl AsRef<str>) -> Result<Index, Error> {
Ok(request::<(), JsonIndex>(
&format!("{}/indexes/{}", self.host, uid.as_ref()),
&self.api_key,
Method::Get,
200,
).await?
.into_index(self))
}
/// Assume that an [index](../indexes/struct.Index.html) exist and create a corresponding object without any check.
pub fn assume_index(&self, uid: impl Into<String>) -> Index {
Index {
uid: Rc::new(uid.into()),
host: Rc::clone(&self.host),
api_key: Rc::clone(&self.api_key)
}
}
/// Create an [index](../indexes/struct.Index.html).
/// The second parameter will be used as the primary key of the new index. If it is not specified, MeiliSearch will **try** to infer the primary key.
/// # Example
///
/// ```
/// # use meilisearch_sdk::{client::*, indexes::*};
/// #
/// # futures::executor::block_on(async move {
/// // create the client
/// let client = Client::new("http://localhost:7700", "masterKey");
///
/// # if let Ok(mut movies) = client.get_index("movies").await {
/// # movies.delete().await.unwrap();
/// # }
/// // create a new index called movies and access it
/// let movies = client.create_index("movies", None).await;
/// # });
/// ```
pub async fn create_index(
&self,
uid: impl AsRef<str>,
primary_key: Option<&str>,
) -> Result<Index, Error> {
Ok(request::<Value, JsonIndex>(
&format!("{}/indexes", self.host),
&self.api_key,
Method::Post(json!({
"uid": uid.as_ref(),
"primaryKey": primary_key,
})),
201,
).await?
.into_index(self))
}
/// Delete an index from its UID if it exists.
/// To delete an index if it exists from the [`Index`] object, use the [Index::delete_if_exists] method.
pub async fn delete_index_if_exists(&self, uid: &str) -> Result<bool, Error> {
match self.delete_index(uid).await {
Ok (_) => Ok(true),
Err (Error::MeiliSearchError {
message: _,
error_code: ErrorCode::IndexNotFound,
error_type: _,
error_link: _,
}) => Ok(false),
Err(error) => Err(error),
}
}
/// Delete an index from its UID.
/// To delete an index from the [index object](../indexes/struct.Index.html), use [the delete method](../indexes/struct.Index.html#method.delete).
pub async fn delete_index(&self, uid: impl AsRef<str>) -> Result<(), Error> {
Ok(request::<(), ()>(
&format!("{}/indexes/{}", self.host, uid.as_ref()),
&self.api_key,
Method::Delete,
204,
).await?)
}
/// This will try to get an index and create the index if it does not exist.
pub async fn get_or_create(&self, uid: impl AsRef<str>) -> Result<Index, Error> {
if let Ok(index) = self.get_index(uid.as_ref()).await {
Ok(index)
} else {
self.create_index(uid, None).await
}
}
/// Alias for [list_all_indexes](#method.list_all_indexes).
pub async fn get_indexes(&self) -> Result<Vec<Index>, Error> {
self.list_all_indexes().await
}
/// Alias for [list_all_indexes_raw](#method.list_all_indexes_raw).
pub async fn get_indexes_raw(&self) -> Result<Vec<JsonIndex>, Error> {
self.list_all_indexes_raw().await
}
/// Get stats of all indexes.
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::{client::*, indexes::*};
/// #
/// # futures::executor::block_on(async move {
/// let client = Client::new("http://localhost:7700", "masterKey");
/// let stats = client.get_stats().await.unwrap();
/// # });
/// ```
pub async fn get_stats(&self) -> Result<ClientStats, Error> {
request::<serde_json::Value, ClientStats>(
&format!("{}/stats", self.host),
&self.api_key,
Method::Get,
200,
).await
}
/// Get health of MeiliSearch server.
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::{client::*, errors::{Error, ErrorCode}};
/// #
/// # futures::executor::block_on(async move {
/// let client = Client::new("http://localhost:7700", "masterKey");
/// let health = client.health().await.unwrap();
/// # });
/// ```
pub async fn health(&self) -> Result<Health, Error> {
request::<serde_json::Value, Health>(
&format!("{}/health", self.host),
&self.api_key,
Method::Get,
200,
)
.await
}
/// Get health of MeiliSearch server, return true or false.
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::client::*;
/// #
/// # futures::executor::block_on(async move {
/// let client = Client::new("http://localhost:7700", "masterKey");
/// let health = client.is_healthy().await;
/// assert_eq!(health, true);
/// # });
/// ```
pub async fn is_healthy(&self) -> bool {
if let Ok(health) = self.health().await {
health.status.as_str() == "available"
} else {
false
}
}
/// Get the private and public key.
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::{client::*, errors::Error};
/// #
/// # futures::executor::block_on(async move {
/// let client = Client::new("http://localhost:7700", "masterKey");
/// let keys = client.get_keys().await.unwrap();
/// # });
/// ```
pub async fn get_keys(&self) -> Result<Keys, Error> {
request::<(), Keys>(
&format!("{}/keys", self.host),
&self.api_key,
Method::Get,
200,
).await
}
/// Get version of the MeiliSearch server.
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::{client::*, indexes::*, errors::Error};
/// #
/// # futures::executor::block_on(async move {
/// let client = Client::new("http://localhost:7700", "masterKey");
/// let version = client.get_version().await.unwrap();
/// # });
/// ```
pub async fn get_version(&self) -> Result<Version, Error> {
request::<(), Version>(
&format!("{}/version", self.host),
&self.api_key,
Method::Get,
200,
).await
}
}
#[derive(Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ClientStats {
pub database_size: usize,
pub last_update: Option<String>,
pub indexes: HashMap<String, IndexStats>,
}
/// Health of the MeiliSearch server.
///
/// Example:
///
/// ```
/// # use meilisearch_sdk::{client::*, indexes::*, errors::Error};
/// Health {
/// status: "available".to_string(),
/// };
/// ```
#[derive(Deserialize)]
pub struct Health {
pub status: String,
}
#[derive(Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Keys {
pub public: Option<String>,
pub private: Option<String>,
}
/// Version of a MeiliSearch server.
///
/// Example:
///
/// ```
/// # use meilisearch_sdk::{client::*, indexes::*, errors::Error};
/// Version {
/// commit_sha: "b46889b5f0f2f8b91438a08a358ba8f05fc09fc1".to_string(),
/// commit_date: "2019-11-15T09:51:54.278247+00:00".to_string(),
/// pkg_version: "0.1.1".to_string(),
/// };
/// ```
#[derive(Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Version {
pub commit_sha: String,
pub commit_date: String,
pub pkg_version: String,
}
#[cfg(test)]
mod tests {
use crate::{client::*};
use futures_await_test::async_test;
#[async_test]
async fn test_get_keys() {
let client = Client::new("http://localhost:7700", "masterKey");
client.get_keys().await.unwrap();
}
#[async_test]
async fn test_delete_if_exits() {
let client = Client::new("http://localhost:7700", "masterKey");
let index_name = "movies_delete_if_exists";
client.create_index(index_name, None).await.unwrap();
let mut index = client.get_index(index_name).await;
assert!(index.is_ok());
let deleted = client.delete_index_if_exists(index_name).await.unwrap();
assert_eq!(deleted, true);
index = client.get_index(index_name).await;
assert!(index.is_err());
}
#[async_test]
async fn test_list_all_indexes() {
let client = Client::new("http://localhost:7700", "masterKey");
let index_name = "list_all_indexes";
client.create_index(index_name, None).await.unwrap();
let index = client.get_index(index_name).await;
assert!(index.is_ok());
let all_indexes = client.list_all_indexes().await.unwrap();
assert!(all_indexes.len() > 0);
let deleted = client.delete_index_if_exists(index_name).await.unwrap();
assert_eq!(deleted, true);
}
#[async_test]
async fn test_list_all_indexes_raw() {
let client = Client::new("http://localhost:7700", "masterKey");
let index_name = "list_all_indexes_raw";
client.create_index(index_name, None).await.unwrap();
let index = client.get_index(index_name).await;
assert!(index.is_ok());
let all_indexes_raw = client.list_all_indexes_raw().await.unwrap();
assert!(all_indexes_raw.len() > 0);
let deleted = client.delete_index_if_exists(index_name).await.unwrap();
assert_eq!(deleted, true);
}
#[async_test]
async fn test_delete_if_exits_none() {
let client = Client::new("http://localhost:7700", "masterKey");
let deleted = client.delete_index_if_exists("bad").await.unwrap();
assert_eq!(deleted, false);
}
}