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
use crate::{errors::*, indexes::*, request::*}; use serde_json::{json, Value}; use serde::{Serialize, 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<'a> { pub(crate) host: &'a str, pub(crate) apikey: &'a str, } impl<'a> Client<'a> { /// 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/guides/advanced_guides/authentication.html#authentication). /// # Example /// /// ``` /// # use meilisearch_sdk::{client::*, indexes::*}; /// # /// // create the client /// let client = Client::new("http://localhost:7700", "masterKey"); /// ``` pub const fn new(host: &'a str, apikey: &'a str) -> Client<'a> { Client { host, apikey } } /// List all [indexes](../indexes/struct.Index.html). /// /// # Example /// /// ``` /// # use meilisearch_sdk::{client::*, indexes::*}; /// # #[tokio::main] /// # async fn main() { /// // 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(&'a self) -> Result<Vec<Index<'a>>, Error> { let json_indexes = request::<(), Vec<JsonIndex>>( &format!("{}/indexes", self.host), self.apikey, Method::Get, 200, ).await?; let mut indexes = Vec::new(); for json_index in json_indexes { indexes.push(json_index.into_index(self)) } Ok(indexes) } /// Get an [index](../indexes/struct.Index.html). /// /// # Example /// /// ``` /// # use meilisearch_sdk::{client::*, indexes::*}; /// /// # #[tokio::main] /// # async fn main() { /// // 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(&'a self, uid: &'a str) -> Result<Index<'a>, Error> { Ok(request::<(), JsonIndex>( &format!("{}/indexes/{}", self.host, uid), self.apikey, 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(&'a self, uid: &'a str) -> Index<'a> { Index { client: &self, uid: uid.to_string() } } /// 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::*}; /// # /// # #[tokio::main] /// # async fn main() { /// // 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( &'a self, uid: &'a str, primary_key: Option<&str>, ) -> Result<Index<'a>, Error> { Ok(request::<Value, JsonIndex>( &format!("{}/indexes", self.host), self.apikey, Method::Post(json!({ "uid": uid, "primaryKey": primary_key, })), 201, ).await? .into_index(self)) } /// 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: &str) -> Result<(), Error> { Ok(request::<(), ()>( &format!("{}/indexes/{}", self.host, uid), self.apikey, 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(&'a self, uid: &'a str) -> Result<Index<'a>, Error> { if let Ok(index) = self.get_index(uid).await { Ok(index) } else { self.create_index(uid, None).await } } /// Alias for [list_all_indexes](#method.list_all_indexes). pub async fn get_indexes(&'a self) -> Result<Vec<Index<'a>>, Error> { self.list_all_indexes().await } /// Get stats of all indexes. /// /// # Example /// /// ``` /// # use meilisearch_sdk::{client::*, indexes::*}; /// # /// # #[tokio::main] /// # async fn main() { /// 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.apikey, Method::Get, 200, ).await } /// Get health of MeiliSearch server. /// /// # Example /// /// ``` /// # use meilisearch_sdk::{client::*, indexes::*, errors::{Error, ErrorCode}}; /// # /// # #[tokio::main] /// # async fn main() { /// let client = Client::new("http://localhost:7700", "masterKey"); /// /// match client.get_health().await { /// Ok(()) => println!("server is operational"), /// Err(Error::MeiliSearchError { error_code: ErrorCode::Maintenance, .. }) => { /// eprintln!("server is in maintenance") /// }, /// Err(e) => panic!("should never happen: {}", e), /// } /// # } /// ``` pub async fn get_health(&self) -> Result<(), Error> { let r = request::<(), ()>( &format!("{}/health", self.host), self.apikey, Method::Get, 204, ) .await; match r { // This shouldn't be an error; The status code is 200, but the request // function only supports one successful error code for some reason Err(Error::Empty) => Ok(()), e => e, } } /// Update health of MeiliSearch server. /// /// # Example /// /// ``` /// # use meilisearch_sdk::{client::*, indexes::*}; /// # /// # #[tokio::main] /// # async fn main() { /// let client = Client::new("http://localhost:7700", "masterKey"); /// /// client.set_health(false).await.unwrap(); /// # client.set_health(true).await.unwrap(); /// # } /// ``` pub async fn set_health(&self, health: bool) -> Result<(), Error> { #[derive(Debug, Serialize)] struct HealthBody { health: bool } let r = request::<HealthBody, ()>( &format!("{}/health", self.host), self.apikey, Method::Put(HealthBody { health }), 204, ) .await; match r { // This shouldn't be an error; The status code is 200, but the request // function only supports one successful error code for some reason Err(Error::Empty) => Ok(()), e => e, } } /// Get version of the MeiliSearch server. /// /// # Example /// /// ``` /// # use meilisearch_sdk::{client::*, indexes::*, errors::Error}; /// # /// # #[tokio::main] /// # async fn main() { /// 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.apikey, 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>, } /// Version of a MeiliSearch server. /// Example: /// ```text /// Version { /// commit_sha: "b46889b5f0f2f8b91438a08a358ba8f05fc09fc1".to_string(), /// build_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 build_date: String, pub pkg_version: String, }