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 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526
use serde::{de::DeserializeOwned, Deserialize, Serialize};
use serde_json::{json, Value};
use std::{collections::HashMap, time::Duration};
use time::OffsetDateTime;
use crate::{
errors::*, indexes::*, request::*, search::*, utils::async_sleep, Key, KeyBuilder, KeyUpdater,
KeysQuery, KeysResults, Task, TaskInfo, TasksCancelQuery, TasksDeleteQuery, TasksResults,
TasksSearchQuery,
};
/// The top-level struct of the SDK, representing a client containing [indexes](../indexes/struct.Index.html).
#[derive(Debug, Clone)]
pub struct Client {
pub(crate) host: String,
pub(crate) api_key: Option<String>,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SwapIndexes {
pub indexes: (String, 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://www.meilisearch.com/docs/learn/security/master_api_keys#authentication).
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::{client::*, indexes::*};
/// #
/// let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
/// let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
///
/// let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));
/// ```
pub fn new(host: impl Into<String>, api_key: Option<impl Into<String>>) -> Client {
Client {
host: host.into(),
api_key: api_key.map(std::convert::Into::into),
}
}
fn parse_indexes_results_from_value(&self, value: &Value) -> Result<IndexesResults, Error> {
let raw_indexes = value["results"].as_array().unwrap();
let indexes_results = IndexesResults {
limit: value["limit"].as_u64().unwrap() as u32,
offset: value["offset"].as_u64().unwrap() as u32,
total: value["total"].as_u64().unwrap() as u32,
results: raw_indexes
.iter()
.map(|raw_index| Index::from_value(raw_index.clone(), self.clone()))
.collect::<Result<_, _>>()?,
};
Ok(indexes_results)
}
pub async fn execute_multi_search_query<T: 'static + DeserializeOwned>(
&self,
body: &MultiSearchQuery<'_, '_>,
) -> Result<MultiSearchResponse<T>, Error> {
request::<(), &MultiSearchQuery, MultiSearchResponse<T>>(
&format!("{}/multi-search", &self.host),
self.get_api_key(),
Method::Post { body, query: () },
200,
)
.await
}
/// Make multiple search requests.
///
/// # Example
///
/// ```
/// # use serde::{Serialize, Deserialize};
/// # use meilisearch_sdk::{client::*, indexes::*, search::*};
/// #
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
/// #
/// #[derive(Serialize, Deserialize, Debug)]
/// struct Movie {
/// name: String,
/// description: String,
/// }
///
/// # futures::executor::block_on(async move {
/// # let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));
/// let mut movies = client.index("search");
/// # // add some documents
/// # movies.add_or_replace(&[Movie{name:String::from("Interstellar"), description:String::from("Interstellar chronicles the adventures of a group of explorers who make use of a newly discovered wormhole to surpass the limitations on human space travel and conquer the vast distances involved in an interstellar voyage.")},Movie{name:String::from("Unknown"), description:String::from("Unknown")}], Some("name")).await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
///
/// let search_query_1 = SearchQuery::new(&movies)
/// .with_query("Interstellar")
/// .build();
/// let search_query_2 = SearchQuery::new(&movies)
/// .with_query("")
/// .build();
///
/// let response = client
/// .multi_search()
/// .with_search_query(search_query_1)
/// .with_search_query(search_query_2)
/// .execute::<Movie>()
/// .await
/// .unwrap();
///
/// assert_eq!(response.results.len(), 2);
/// # movies.delete().await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
/// # });
/// ```
pub fn multi_search(&self) -> MultiSearchQuery {
MultiSearchQuery::new(self)
}
/// Return the host associated with this index.
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::{client::*};
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
/// let client = Client::new("http://doggo.dog", Some(MEILISEARCH_API_KEY));
///
/// assert_eq!(client.get_host(), "http://doggo.dog");
/// ```
pub fn get_host(&self) -> &str {
&self.host
}
/// Return the api key associated with this index.
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::{client::*};
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
/// let client = Client::new(MEILISEARCH_URL, Some("doggo"));
///
/// assert_eq!(client.get_api_key(), Some("doggo"));
/// ```
pub fn get_api_key(&self) -> Option<&str> {
self.api_key.as_deref()
}
/// List all [Indexes](Index) with query parameters and returns values as instances of [Index].
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::{client::*, indexes::*};
/// #
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
/// #
/// # futures::executor::block_on(async move {
/// # let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));
/// let indexes: IndexesResults = client.list_all_indexes().await.unwrap();
///
/// println!("{:?}", indexes);
/// # });
/// ```
pub async fn list_all_indexes(&self) -> Result<IndexesResults, Error> {
let value = self.list_all_indexes_raw().await?;
let indexes_results = self.parse_indexes_results_from_value(&value)?;
Ok(indexes_results)
}
/// List all [Indexes](Index) and returns values as instances of [Index].
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::{client::*, indexes::*};
/// #
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
/// #
/// # futures::executor::block_on(async move {
/// # let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));
/// let mut query = IndexesQuery::new(&client);
/// query.with_limit(1);
///
/// let indexes: IndexesResults = client.list_all_indexes_with(&query).await.unwrap();
///
/// assert_eq!(indexes.limit, 1);
/// # });
/// ```
pub async fn list_all_indexes_with(
&self,
indexes_query: &IndexesQuery<'_>,
) -> Result<IndexesResults, Error> {
let value = self.list_all_indexes_raw_with(indexes_query).await?;
let indexes_results = self.parse_indexes_results_from_value(&value)?;
Ok(indexes_results)
}
/// List all [Indexes](Index) and returns as Json.
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::{client::*, indexes::*};
/// #
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
/// #
/// # futures::executor::block_on(async move {
/// # let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));
/// let json_indexes = client.list_all_indexes_raw().await.unwrap();
///
/// println!("{:?}", json_indexes);
/// # });
/// ```
pub async fn list_all_indexes_raw(&self) -> Result<Value, Error> {
let json_indexes = request::<(), (), Value>(
&format!("{}/indexes", self.host),
self.get_api_key(),
Method::Get { query: () },
200,
)
.await?;
Ok(json_indexes)
}
/// List all [Indexes](Index) with query parameters and returns as Json.
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::{client::*, indexes::*};
/// #
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
/// #
/// # futures::executor::block_on(async move {
/// # let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));
/// let mut query = IndexesQuery::new(&client);
/// query.with_limit(1);
///
/// let json_indexes = client.list_all_indexes_raw_with(&query).await.unwrap();
///
/// println!("{:?}", json_indexes);
/// # });
/// ```
pub async fn list_all_indexes_raw_with(
&self,
indexes_query: &IndexesQuery<'_>,
) -> Result<Value, Error> {
let json_indexes = request::<&IndexesQuery, (), Value>(
&format!("{}/indexes", self.host),
self.get_api_key(),
Method::Get {
query: indexes_query,
},
200,
)
.await?;
Ok(json_indexes)
}
/// Get an [Index], this index should already exist.
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::{client::*, indexes::*};
/// #
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
/// #
/// # futures::executor::block_on(async move {
/// # let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));
/// # let index = client.create_index("get_index", None).await.unwrap().wait_for_completion(&client, None, None).await.unwrap().try_make_index(&client).unwrap();
/// let index = client.get_index("get_index").await.unwrap();
///
/// assert_eq!(index.as_ref(), "get_index");
/// # index.delete().await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
/// # });
/// ```
pub async fn get_index(&self, uid: impl AsRef<str>) -> Result<Index, Error> {
let mut idx = self.index(uid.as_ref());
idx.fetch_info().await?;
Ok(idx)
}
/// Get a raw JSON [Index], this index should already exist.
///
/// If you use it directly from an [Index], you can use the method [`Index::fetch_info`], which is the equivalent method from an index.
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::{client::*, indexes::*};
/// #
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
/// #
/// # futures::executor::block_on(async move {
/// # let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));
/// # let index = client.create_index("get_raw_index", None).await.unwrap().wait_for_completion(&client, None, None).await.unwrap().try_make_index(&client).unwrap();
/// let raw_index = client.get_raw_index("get_raw_index").await.unwrap();
///
/// assert_eq!(raw_index.get("uid").unwrap().as_str().unwrap(), "get_raw_index");
/// # index.delete().await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
/// # });
/// ```
pub async fn get_raw_index(&self, uid: impl AsRef<str>) -> Result<Value, Error> {
request::<(), (), Value>(
&format!("{}/indexes/{}", self.host, uid.as_ref()),
self.get_api_key(),
Method::Get { query: () },
200,
)
.await
}
/// Create a corresponding object of an [Index] without any check or doing an HTTP call.
pub fn index(&self, uid: impl Into<String>) -> Index {
Index::new(uid, self.clone())
}
/// Create an [Index].
///
/// 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::*};
/// #
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
/// #
/// # futures::executor::block_on(async move {
/// # let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));
/// // Create a new index called movies and access it
/// let task = client.create_index("create_index", None).await.unwrap();
///
/// // Wait for the task to complete
/// let task = task.wait_for_completion(&client, None, None).await.unwrap();
///
/// // Try to get the inner index if the task succeeded
/// let index = task.try_make_index(&client).unwrap();
///
/// assert_eq!(index.as_ref(), "create_index");
/// # index.delete().await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
/// # });
/// ```
pub async fn create_index(
&self,
uid: impl AsRef<str>,
primary_key: Option<&str>,
) -> Result<TaskInfo, Error> {
request::<(), Value, TaskInfo>(
&format!("{}/indexes", self.host),
self.get_api_key(),
Method::Post {
query: (),
body: json!({
"uid": uid.as_ref(),
"primaryKey": primary_key,
}),
},
202,
)
.await
}
/// Delete an index from its UID.
///
/// To delete an [Index], use the [`Index::delete`] method.
pub async fn delete_index(&self, uid: impl AsRef<str>) -> Result<TaskInfo, Error> {
request::<(), (), TaskInfo>(
&format!("{}/indexes/{}", self.host, uid.as_ref()),
self.get_api_key(),
Method::Delete { query: () },
202,
)
.await
}
/// Alias for [`Client::list_all_indexes`].
pub async fn get_indexes(&self) -> Result<IndexesResults, Error> {
self.list_all_indexes().await
}
/// Alias for [`Client::list_all_indexes_with`].
pub async fn get_indexes_with(
&self,
indexes_query: &IndexesQuery<'_>,
) -> Result<IndexesResults, Error> {
self.list_all_indexes_with(indexes_query).await
}
/// Alias for [`Client::list_all_indexes_raw`].
pub async fn get_indexes_raw(&self) -> Result<Value, Error> {
self.list_all_indexes_raw().await
}
/// Alias for [`Client::list_all_indexes_raw_with`].
pub async fn get_indexes_raw_with(
&self,
indexes_query: &IndexesQuery<'_>,
) -> Result<Value, Error> {
self.list_all_indexes_raw_with(indexes_query).await
}
/// Swaps a list of two [Indexes](Index).
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::{client::*, indexes::*};
/// #
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
/// #
/// # futures::executor::block_on(async move {
/// # let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));
/// let task_index_1 = client.create_index("swap_index_1", None).await.unwrap();
/// let task_index_2 = client.create_index("swap_index_2", None).await.unwrap();
///
/// // Wait for the task to complete
/// task_index_2.wait_for_completion(&client, None, None).await.unwrap();
///
/// let task = client
/// .swap_indexes([&SwapIndexes {
/// indexes: (
/// "swap_index_1".to_string(),
/// "swap_index_2".to_string(),
/// ),
/// }])
/// .await
/// .unwrap();
///
/// # client.index("swap_index_1").delete().await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
/// # client.index("swap_index_2").delete().await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
/// # });
/// ```
pub async fn swap_indexes(
&self,
indexes: impl IntoIterator<Item = &SwapIndexes>,
) -> Result<TaskInfo, Error> {
request::<(), Vec<&SwapIndexes>, TaskInfo>(
&format!("{}/swap-indexes", self.host),
self.get_api_key(),
Method::Post {
query: (),
body: indexes.into_iter().collect(),
},
202,
)
.await
}
/// Get stats of all [Indexes](Index).
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::{client::*, indexes::*};
/// #
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
/// #
/// # futures::executor::block_on(async move {
/// # let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));
/// let stats = client.get_stats().await.unwrap();
/// # });
/// ```
pub async fn get_stats(&self) -> Result<ClientStats, Error> {
request::<(), (), ClientStats>(
&format!("{}/stats", self.host),
self.get_api_key(),
Method::Get { query: () },
200,
)
.await
}
/// Get health of Meilisearch server.
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::{client::*, Error, ErrorCode};
/// #
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
/// #
/// # futures::executor::block_on(async move {
/// # let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));
/// let health = client.health().await.unwrap();
///
/// assert_eq!(health.status, "available");
/// # });
/// ```
pub async fn health(&self) -> Result<Health, Error> {
request::<(), (), Health>(
&format!("{}/health", self.host),
self.get_api_key(),
Method::Get { query: () },
200,
)
.await
}
/// Get health of Meilisearch server.
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::client::*;
/// #
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
/// #
/// # futures::executor::block_on(async move {
/// # let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));
/// 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 API [Keys](Key) from Meilisearch with parameters.
///
/// See [`Client::create_key`], [`Client::get_key`], and the [meilisearch documentation](https://www.meilisearch.com/docs/reference/api/keys#get-all-keys).
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::{client::*, Error, KeysQuery};
/// #
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
/// #
/// # futures::executor::block_on(async move {
/// # let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));
/// let mut query = KeysQuery::new();
/// query.with_limit(1);
///
/// let keys = client.get_keys_with(&query).await.unwrap();
///
/// assert_eq!(keys.results.len(), 1);
/// # });
/// ```
pub async fn get_keys_with(&self, keys_query: &KeysQuery) -> Result<KeysResults, Error> {
let keys = request::<&KeysQuery, (), KeysResults>(
&format!("{}/keys", self.host),
self.get_api_key(),
Method::Get { query: keys_query },
200,
)
.await?;
Ok(keys)
}
/// Get the API [Keys](Key) from Meilisearch.
///
/// See [`Client::create_key`], [`Client::get_key`], and the [meilisearch documentation](https://www.meilisearch.com/docs/reference/api/keys#get-all-keys).
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::{client::*, Error, KeyBuilder};
/// #
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
/// #
/// # futures::executor::block_on(async move {
/// # let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));
/// let keys = client.get_keys().await.unwrap();
///
/// assert_eq!(keys.limit, 20);
/// # });
/// ```
pub async fn get_keys(&self) -> Result<KeysResults, Error> {
let keys = request::<(), (), KeysResults>(
&format!("{}/keys", self.host),
self.get_api_key(),
Method::Get { query: () },
200,
)
.await?;
Ok(keys)
}
/// Get one API [Key] from Meilisearch.
///
/// See also [`Client::create_key`], [`Client::get_keys`], and the [meilisearch documentation](https://www.meilisearch.com/docs/reference/api/keys#get-one-key).
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::{client::*, Error, KeyBuilder};
/// #
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
/// #
/// # futures::executor::block_on(async move {
/// # let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));
/// # let key = client.get_keys().await.unwrap().results.into_iter()
/// # .find(|k| k.name.as_ref().map_or(false, |name| name.starts_with("Default Search API Key")))
/// # .unwrap();
/// let key = client.get_key(key).await.unwrap();
///
/// assert_eq!(key.name, Some("Default Search API Key".to_string()));
/// # });
/// ```
pub async fn get_key(&self, key: impl AsRef<str>) -> Result<Key, Error> {
request::<(), (), Key>(
&format!("{}/keys/{}", self.host, key.as_ref()),
self.get_api_key(),
Method::Get { query: () },
200,
)
.await
}
/// Delete an API [Key] from Meilisearch.
///
/// See also [`Client::create_key`], [`Client::update_key`], [`Client::get_key`], and the [meilisearch documentation](https://www.meilisearch.com/docs/reference/api/keys#delete-a-key).
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::{client::*, Error, KeyBuilder};
/// #
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
/// #
/// # futures::executor::block_on(async move {
/// # let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));
/// let key = KeyBuilder::new();
/// let key = client.create_key(key).await.unwrap();
/// let inner_key = key.key.clone();
///
/// client.delete_key(key).await.unwrap();
///
/// let keys = client.get_keys().await.unwrap();
///
/// assert!(keys.results.iter().all(|key| key.key != inner_key));
/// # });
/// ```
pub async fn delete_key(&self, key: impl AsRef<str>) -> Result<(), Error> {
request::<(), (), ()>(
&format!("{}/keys/{}", self.host, key.as_ref()),
self.get_api_key(),
Method::Delete { query: () },
204,
)
.await
}
/// Create an API [Key] in Meilisearch.
///
/// See also [`Client::update_key`], [`Client::delete_key`], [`Client::get_key`], and the [meilisearch documentation](https://www.meilisearch.com/docs/reference/api/keys#create-a-key).
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::{client::*, Error, KeyBuilder, Action};
/// #
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
/// #
/// # futures::executor::block_on(async move {
/// # let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));
/// let name = "create_key".to_string();
/// let mut key = KeyBuilder::new();
/// key.with_name(&name);
///
/// let key = client.create_key(key).await.unwrap();
///
/// assert_eq!(key.name, Some(name));
/// # client.delete_key(key).await.unwrap();
/// # });
/// ```
pub async fn create_key(&self, key: impl AsRef<KeyBuilder>) -> Result<Key, Error> {
request::<(), &KeyBuilder, Key>(
&format!("{}/keys", self.host),
self.get_api_key(),
Method::Post {
query: (),
body: key.as_ref(),
},
201,
)
.await
}
/// Update an API [Key] in Meilisearch.
///
/// See also [`Client::create_key`], [`Client::delete_key`], [`Client::get_key`], and the [meilisearch documentation](https://www.meilisearch.com/docs/reference/api/keys#update-a-key).
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::{client::*, Error, KeyBuilder, KeyUpdater};
/// #
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
/// #
/// # futures::executor::block_on(async move {
/// # let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));
/// let new_key = KeyBuilder::new();
/// let mut new_key = client.create_key(new_key).await.unwrap();
/// let mut key_update = KeyUpdater::new(new_key);
///
/// let name = "my name".to_string();
/// key_update.with_name(&name);
///
/// let key = client.update_key(key_update).await.unwrap();
///
/// assert_eq!(key.name, Some(name));
/// # client.delete_key(key).await.unwrap();
/// # });
/// ```
pub async fn update_key(&self, key: impl AsRef<KeyUpdater>) -> Result<Key, Error> {
request::<(), &KeyUpdater, Key>(
&format!("{}/keys/{}", self.host, key.as_ref().key),
self.get_api_key(),
Method::Patch {
body: key.as_ref(),
query: (),
},
200,
)
.await
}
/// Get version of the Meilisearch server.
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::{client::*};
/// #
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
/// #
/// # futures::executor::block_on(async move {
/// # let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));
/// let version = client.get_version().await.unwrap();
/// # });
/// ```
pub async fn get_version(&self) -> Result<Version, Error> {
request::<(), (), Version>(
&format!("{}/version", self.host),
self.get_api_key(),
Method::Get { query: () },
200,
)
.await
}
/// Wait until Meilisearch processes a [Task], and get its status.
///
/// `interval` = The frequency at which the server should be polled. **Default = 50ms**
///
/// `timeout` = The maximum time to wait for processing to complete. **Default = 5000ms**
///
/// If the waited time exceeds `timeout` then an [`Error::Timeout`] will be returned.
///
/// See also [`Index::wait_for_task`, `Task::wait_for_completion`, `TaskInfo::wait_for_completion`].
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::{client::*, indexes::*, Task};
/// # use serde::{Serialize, Deserialize};
/// #
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
/// #
/// #
/// # #[derive(Debug, Serialize, Deserialize, PartialEq)]
/// # struct Document {
/// # id: usize,
/// # value: String,
/// # kind: String,
/// # }
/// #
/// #
/// # futures::executor::block_on(async move {
/// # let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));
/// let movies = client.index("movies_client_wait_for_task");
///
/// let task = movies.add_documents(&[
/// Document { id: 0, kind: "title".into(), value: "The Social Network".to_string() },
/// Document { id: 1, kind: "title".into(), value: "Harry Potter and the Sorcerer's Stone".to_string() },
/// ], None).await.unwrap();
///
/// let status = client.wait_for_task(task, None, None).await.unwrap();
///
/// assert!(matches!(status, Task::Succeeded { .. }));
/// # movies.delete().await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
/// # });
/// ```
pub async fn wait_for_task(
&self,
task_id: impl AsRef<u32>,
interval: Option<Duration>,
timeout: Option<Duration>,
) -> Result<Task, Error> {
let interval = interval.unwrap_or_else(|| Duration::from_millis(50));
let timeout = timeout.unwrap_or_else(|| Duration::from_millis(5000));
let mut elapsed_time = Duration::new(0, 0);
let mut task_result: Result<Task, Error>;
while timeout > elapsed_time {
task_result = self.get_task(&task_id).await;
match task_result {
Ok(status) => match status {
Task::Failed { .. } | Task::Succeeded { .. } => {
return self.get_task(task_id).await;
}
Task::Enqueued { .. } | Task::Processing { .. } => {
elapsed_time += interval;
async_sleep(interval).await;
}
},
Err(error) => return Err(error),
};
}
Err(Error::Timeout)
}
/// Get a task from the server given a task id.
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::*;
/// #
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
/// #
/// # futures::executor::block_on(async move {
/// # let client = client::Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));
/// # let index = client.create_index("movies_get_task", None).await.unwrap().wait_for_completion(&client, None, None).await.unwrap().try_make_index(&client).unwrap();
/// let task = index.delete_all_documents().await.unwrap();
///
/// let task = client.get_task(task).await.unwrap();
/// # index.delete().await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
/// # });
/// ```
pub async fn get_task(&self, task_id: impl AsRef<u32>) -> Result<Task, Error> {
request::<(), (), Task>(
&format!("{}/tasks/{}", self.host, task_id.as_ref()),
self.get_api_key(),
Method::Get { query: () },
200,
)
.await
}
/// Get all tasks with query parameters from the server.
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::*;
/// #
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
/// #
/// # futures::executor::block_on(async move {
/// # let client = client::Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));
/// let mut query = tasks::TasksSearchQuery::new(&client);
/// query.with_index_uids(["get_tasks_with"]);
///
/// let tasks = client.get_tasks_with(&query).await.unwrap();
/// # });
/// ```
pub async fn get_tasks_with(
&self,
tasks_query: &TasksSearchQuery<'_>,
) -> Result<TasksResults, Error> {
let tasks = request::<&TasksSearchQuery, (), TasksResults>(
&format!("{}/tasks", self.host),
self.get_api_key(),
Method::Get { query: tasks_query },
200,
)
.await?;
Ok(tasks)
}
/// Cancel tasks with filters [`TasksCancelQuery`].
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::*;
/// #
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
/// #
/// # futures::executor::block_on(async move {
/// # let client = client::Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));
/// let mut query = tasks::TasksCancelQuery::new(&client);
/// query.with_index_uids(["movies"]);
///
/// let res = client.cancel_tasks_with(&query).await.unwrap();
/// # });
/// ```
pub async fn cancel_tasks_with(
&self,
filters: &TasksCancelQuery<'_>,
) -> Result<TaskInfo, Error> {
let tasks = request::<&TasksCancelQuery, (), TaskInfo>(
&format!("{}/tasks/cancel", self.host),
self.get_api_key(),
Method::Post {
query: filters,
body: (),
},
200,
)
.await?;
Ok(tasks)
}
/// Delete tasks with filters [`TasksDeleteQuery`].
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::*;
/// #
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
/// #
/// # futures::executor::block_on(async move {
/// # let client = client::Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));
/// let mut query = tasks::TasksDeleteQuery::new(&client);
/// query.with_index_uids(["movies"]);
///
/// let res = client.delete_tasks_with(&query).await.unwrap();
/// # });
/// ```
pub async fn delete_tasks_with(
&self,
filters: &TasksDeleteQuery<'_>,
) -> Result<TaskInfo, Error> {
let tasks = request::<&TasksDeleteQuery, (), TaskInfo>(
&format!("{}/tasks", self.host),
self.get_api_key(),
Method::Delete { query: filters },
200,
)
.await?;
Ok(tasks)
}
/// Get all tasks from the server.
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::*;
/// #
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
/// #
/// # futures::executor::block_on(async move {
/// # let client = client::Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));
/// let tasks = client.get_tasks().await.unwrap();
///
/// assert!(tasks.results.len() > 0);
/// # });
/// ```
pub async fn get_tasks(&self) -> Result<TasksResults, Error> {
let tasks = request::<(), (), TasksResults>(
&format!("{}/tasks", self.host),
self.get_api_key(),
Method::Get { query: () },
200,
)
.await?;
Ok(tasks)
}
/// Generates a new tenant token.
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::*;
/// #
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
/// #
/// # futures::executor::block_on(async move {
/// # let client = client::Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));
/// let api_key_uid = "76cf8b87-fd12-4688-ad34-260d930ca4f4".to_string();
/// let token = client.generate_tenant_token(api_key_uid, serde_json::json!(["*"]), None, None).unwrap();
///
/// let client = client::Client::new(MEILISEARCH_URL, Some(token));
/// # });
/// ```
#[cfg(not(target_arch = "wasm32"))]
pub fn generate_tenant_token(
&self,
api_key_uid: String,
search_rules: serde_json::Value,
api_key: Option<&str>,
expires_at: Option<OffsetDateTime>,
) -> Result<String, Error> {
let api_key = match self.get_api_key() {
Some(key) => api_key.unwrap_or(key),
None => {
return Err(Error::CantUseWithoutApiKey(
"generate_tenant_token".to_string(),
))
}
};
crate::tenant_tokens::generate_tenant_token(api_key_uid, search_rules, api_key, expires_at)
}
}
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ClientStats {
pub database_size: usize,
#[serde(with = "time::serde::rfc3339::option")]
pub last_update: Option<OffsetDateTime>,
pub indexes: HashMap<String, IndexStats>,
}
/// Health of the Meilisearch server.
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::{client::*, indexes::*, errors::Error};
/// Health {
/// status: "available".to_string(),
/// };
/// ```
#[derive(Debug, Clone, Deserialize)]
pub struct Health {
pub status: 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(Debug, Clone, 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 big_s::S;
use time::OffsetDateTime;
use meilisearch_test_macro::meilisearch_test;
use crate::{client::*, Action, KeyBuilder, TasksSearchQuery};
#[derive(Debug, Serialize, Deserialize, PartialEq)]
struct Document {
id: String,
}
#[meilisearch_test]
async fn test_swapping_two_indexes(client: Client) {
let index_1 = client.index("test_swapping_two_indexes_1");
let index_2 = client.index("test_swapping_two_indexes_2");
let t0 = index_1
.add_documents(
&[Document {
id: "1".to_string(),
}],
None,
)
.await
.unwrap();
index_2
.add_documents(
&[Document {
id: "2".to_string(),
}],
None,
)
.await
.unwrap();
t0.wait_for_completion(&client, None, None).await.unwrap();
let task = client
.swap_indexes([&SwapIndexes {
indexes: (
"test_swapping_two_indexes_1".to_string(),
"test_swapping_two_indexes_2".to_string(),
),
}])
.await
.unwrap();
task.wait_for_completion(&client, None, None).await.unwrap();
let document = index_1.get_document("2").await.unwrap();
assert_eq!(
Document {
id: "2".to_string()
},
document
);
}
#[meilisearch_test]
async fn test_methods_has_qualified_version_as_header() {
let mut s = mockito::Server::new_async().await;
let mock_server_url = s.url();
let path = "/hello";
let address = &format!("{}{}", mock_server_url, path);
let user_agent = &*qualified_version();
let assertions = vec![
(
s.mock("GET", path)
.match_header("User-Agent", user_agent)
.create_async()
.await,
request::<(), (), ()>(address, None, Method::Get { query: () }, 200),
),
(
s.mock("POST", path)
.match_header("User-Agent", user_agent)
.create_async()
.await,
request::<(), (), ()>(
address,
None,
Method::Post {
query: (),
body: {},
},
200,
),
),
(
s.mock("DELETE", path)
.match_header("User-Agent", user_agent)
.create_async()
.await,
request::<(), (), ()>(address, None, Method::Delete { query: () }, 200),
),
(
s.mock("PUT", path)
.match_header("User-Agent", user_agent)
.create_async()
.await,
request::<(), (), ()>(
address,
None,
Method::Put {
query: (),
body: (),
},
200,
),
),
(
s.mock("PATCH", path)
.match_header("User-Agent", user_agent)
.create_async()
.await,
request::<(), (), ()>(
address,
None,
Method::Patch {
query: (),
body: (),
},
200,
),
),
];
for (m, req) in assertions {
let _ = req.await;
m.assert_async().await;
}
}
#[meilisearch_test]
async fn test_get_tasks(client: Client) {
let tasks = client.get_tasks().await.unwrap();
assert!(tasks.limit == 20);
}
#[meilisearch_test]
async fn test_get_tasks_with_params(client: Client) {
let query = TasksSearchQuery::new(&client);
let tasks = client.get_tasks_with(&query).await.unwrap();
assert!(tasks.limit == 20);
}
#[meilisearch_test]
async fn test_get_keys(client: Client) {
let keys = client.get_keys().await.unwrap();
assert!(keys.results.len() >= 2);
}
#[meilisearch_test]
async fn test_delete_key(client: Client, name: String) {
let mut key = KeyBuilder::new();
key.with_name(&name);
let key = client.create_key(key).await.unwrap();
client.delete_key(&key).await.unwrap();
let keys = KeysQuery::new()
.with_limit(10000)
.execute(&client)
.await
.unwrap();
assert!(keys.results.iter().all(|k| k.key != key.key));
}
#[meilisearch_test]
async fn test_error_delete_key(mut client: Client, name: String) {
// ==> accessing a key that does not exist
let error = client.delete_key("invalid_key").await.unwrap_err();
assert!(matches!(
error,
Error::Meilisearch(MeilisearchError {
error_code: ErrorCode::ApiKeyNotFound,
error_type: ErrorType::InvalidRequest,
..
})
));
// ==> executing the action without enough right
let mut key = KeyBuilder::new();
key.with_name(&name);
let key = client.create_key(key).await.unwrap();
let master_key = client.api_key.clone();
// this key has no right
client.api_key = Some(key.key.clone());
// with a wrong key
let error = client.delete_key("invalid_key").await.unwrap_err();
assert!(matches!(
error,
Error::Meilisearch(MeilisearchError {
error_code: ErrorCode::InvalidApiKey,
error_type: ErrorType::Auth,
..
})
));
// with a good key
let error = client.delete_key(&key.key).await.unwrap_err();
assert!(matches!(
error,
Error::Meilisearch(MeilisearchError {
error_code: ErrorCode::InvalidApiKey,
error_type: ErrorType::Auth,
..
})
));
// cleanup
client.api_key = master_key;
client.delete_key(key).await.unwrap();
}
#[meilisearch_test]
async fn test_create_key(client: Client, name: String) {
let expires_at = OffsetDateTime::now_utc() + time::Duration::HOUR;
let mut key = KeyBuilder::new();
key.with_action(Action::DocumentsAdd)
.with_name(&name)
.with_expires_at(expires_at)
.with_description("a description")
.with_index("*");
let key = client.create_key(key).await.unwrap();
assert_eq!(key.actions, vec![Action::DocumentsAdd]);
assert_eq!(&key.name, &Some(name));
// We can't compare the two timestamp directly because of some nanoseconds imprecision with the floats
assert_eq!(
key.expires_at.unwrap().unix_timestamp(),
expires_at.unix_timestamp()
);
assert_eq!(key.indexes, vec![S("*")]);
client.delete_key(key).await.unwrap();
}
#[meilisearch_test]
async fn test_error_create_key(mut client: Client, name: String) {
// ==> Invalid index name
/* TODO: uncomment once meilisearch fix this bug: https://github.com/meilisearch/meilisearch/issues/2158
let mut key = KeyBuilder::new();
key.with_index("invalid index # / \\name with spaces");
let error = client.create_key(key).await.unwrap_err();
assert!(matches!(
error,
Error::MeilisearchError {
error_code: ErrorCode::InvalidApiKeyIndexes,
error_type: ErrorType::InvalidRequest,
..
}
));
*/
// ==> executing the action without enough right
let mut no_right_key = KeyBuilder::new();
no_right_key.with_name(&format!("{name}_1"));
let no_right_key = client.create_key(no_right_key).await.unwrap();
// backup the master key for cleanup at the end of the test
let master_client = client.clone();
client.api_key = Some(no_right_key.key.clone());
let mut key = KeyBuilder::new();
key.with_name(format!("{name}_2"));
let error = client.create_key(key).await.unwrap_err();
assert!(matches!(
error,
Error::Meilisearch(MeilisearchError {
error_code: ErrorCode::InvalidApiKey,
error_type: ErrorType::Auth,
..
})
));
// cleanup
master_client
.delete_key(client.api_key.unwrap())
.await
.unwrap();
}
#[meilisearch_test]
async fn test_update_key(client: Client, description: String) {
let mut key = KeyBuilder::new();
key.with_name("test_update_key");
let mut key = client.create_key(key).await.unwrap();
let name = S("new name");
key.with_description(&description);
key.with_name(&name);
let key = key.update(&client).await.unwrap();
assert_eq!(key.description, Some(description));
assert_eq!(key.name, Some(name));
client.delete_key(key).await.unwrap();
}
#[meilisearch_test]
async fn test_get_index(client: Client, index_uid: String) -> Result<(), Error> {
let task = client.create_index(&index_uid, None).await?;
let index = client
.wait_for_task(task, None, None)
.await?
.try_make_index(&client)
.unwrap();
assert_eq!(index.uid, index_uid);
index
.delete()
.await?
.wait_for_completion(&client, None, None)
.await?;
Ok(())
}
#[meilisearch_test]
async fn test_error_create_index(client: Client, index: Index) -> Result<(), Error> {
let error = client
.create_index("Wrong index name", None)
.await
.unwrap_err();
assert!(matches!(
error,
Error::Meilisearch(MeilisearchError {
error_code: ErrorCode::InvalidIndexUid,
error_type: ErrorType::InvalidRequest,
..
})
));
// we try to create an index with the same uid of an already existing index
let error = client
.create_index(&*index.uid, None)
.await?
.wait_for_completion(&client, None, None)
.await?
.unwrap_failure();
assert!(matches!(
error,
MeilisearchError {
error_code: ErrorCode::IndexAlreadyExists,
error_type: ErrorType::InvalidRequest,
..
}
));
Ok(())
}
#[meilisearch_test]
async fn test_list_all_indexes(client: Client) {
let all_indexes = client.list_all_indexes().await.unwrap();
assert_eq!(all_indexes.limit, 20);
assert_eq!(all_indexes.offset, 0);
}
#[meilisearch_test]
async fn test_list_all_indexes_with_params(client: Client) {
let mut query = IndexesQuery::new(&client);
query.with_limit(1);
let all_indexes = client.list_all_indexes_with(&query).await.unwrap();
assert_eq!(all_indexes.limit, 1);
assert_eq!(all_indexes.offset, 0);
}
#[meilisearch_test]
async fn test_list_all_indexes_raw(client: Client) {
let all_indexes_raw = client.list_all_indexes_raw().await.unwrap();
assert_eq!(all_indexes_raw["limit"], json!(20));
assert_eq!(all_indexes_raw["offset"], json!(0));
}
#[meilisearch_test]
async fn test_list_all_indexes_raw_with_params(client: Client) {
let mut query = IndexesQuery::new(&client);
query.with_limit(1);
let all_indexes_raw = client.list_all_indexes_raw_with(&query).await.unwrap();
assert_eq!(all_indexes_raw["limit"], json!(1));
assert_eq!(all_indexes_raw["offset"], json!(0));
}
#[meilisearch_test]
async fn test_get_primary_key_is_none(mut index: Index) {
let primary_key = index.get_primary_key().await;
assert!(primary_key.is_ok());
assert!(primary_key.unwrap().is_none());
}
#[meilisearch_test]
async fn test_get_primary_key(client: Client, index_uid: String) -> Result<(), Error> {
let mut index = client
.create_index(index_uid, Some("primary_key"))
.await?
.wait_for_completion(&client, None, None)
.await?
.try_make_index(&client)
.unwrap();
let primary_key = index.get_primary_key().await;
assert!(primary_key.is_ok());
assert_eq!(primary_key?.unwrap(), "primary_key");
index
.delete()
.await?
.wait_for_completion(&client, None, None)
.await?;
Ok(())
}
}