Merge #728

728: Add support for compacting database indexes r=curquiza a=kumarUjjawal

# Pull Request

## Related issue
Fixes #727 

## What does this PR do?
- I noticed a typo in the `.code-samples.meilisearch.yaml` so fixed that as well.
- 
## PR checklist
Please check if your PR fulfills the following requirements:
- [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
- [x] Have you read the contributing guidelines?
- [x] Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!


<!-- This is an auto-generated comment: release notes by coderabbit.ai -->
## Summary by CodeRabbit

* **New Features**
  * Added ability to trigger index compaction and monitor its completion as an async task.

* **Tests**
  * Added a test to verify index compaction completes successfully.

* **Documentation**
  * Added a compact-index code sample.
  * Fixed typos in field properties guide examples (corrected "overview" in searchable and displayed attributes).

<sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub>
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Co-authored-by: Kumar Ujjawal <[email protected]>

Author: meili-bors[bot]

.code-samples.meilisearch.yaml

@@ -719,10 +719,16 @@ distinct_attribute_guide_1: |-
     .set_distinct_attribute("product_id")
     .await
     .unwrap();
+compact_index_1: |-
+  let task: TaskInfo = client
+    .index("INDEX_UID")
+    .compact()
+    .await
+    .unwrap();
 field_properties_guide_searchable_1: |-
   let searchable_attributes = [
     "title",
-    "overvieww",
+    "overview",
     "genres"
   ];
 
@@ -734,7 +740,7 @@ field_properties_guide_searchable_1: |-
 field_properties_guide_displayed_1: |-
   let displayed_attributes = [
     "title",
-    "overvieww",
+    "overview",
     "genres",
     "release_date"
   ];

src/indexes.rs

@@ -1325,6 +1325,55 @@ impl<Http: HttpClient> Index<Http> {
         Ok(self.primary_key.as_deref())
     }
 
+    /// Compact this index to reduce disk usage.
+    ///
+    /// Triggers a compaction task for the current index. Once completed, the
+    /// index data is compacted on disk.
+    ///
+    /// # Example
+    ///
+    /// ```
+    /// # use meilisearch_sdk::{client::*, indexes::*, tasks::Task};
+    /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
+    /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
+    /// # tokio::runtime::Builder::new_current_thread().enable_all().build().unwrap().block_on(async {
+    /// # let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY)).unwrap();
+    /// # let index = client
+    /// #   .create_index("compact_example", None)
+    /// #   .await
+    /// #   .unwrap()
+    /// #   .wait_for_completion(&client, None, None)
+    /// #   .await
+    /// #   .unwrap()
+    /// #   .try_make_index(&client)
+    /// #   .unwrap();
+    ///
+    /// let task = index
+    ///     .compact()
+    ///     .await
+    ///     .unwrap()
+    ///     .wait_for_completion(&client, None, None)
+    ///     .await
+    ///     .unwrap();
+    ///
+    /// assert!(matches!(task, Task::Succeeded { .. }));
+    /// # index.delete().await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
+    /// # });
+    /// ```
+    pub async fn compact(&self) -> Result<TaskInfo, Error> {
+        self.client
+            .http_client
+            .request::<(), (), TaskInfo>(
+                &format!("{}/indexes/{}/compact", self.client.host, self.uid),
+                Method::Post {
+                    query: (),
+                    body: (),
+                },
+                202,
+            )
+            .await
+    }
+
     /// Get a [Task] from a specific [Index] to keep track of [asynchronous operations](https://www.meilisearch.com/docs/learn/advanced/asynchronous_operations).
     ///
     /// # Example
@@ -2441,4 +2490,16 @@ mod tests {
         }
         Ok(())
     }
+
+    #[meilisearch_test]
+    async fn test_compact_index_succeeds(client: Client, index: Index) -> Result<(), Error> {
+        let task = index
+            .compact()
+            .await?
+            .wait_for_completion(&client, None, None)
+            .await?;
+
+        assert!(task.is_success());
+        Ok(())
+    }
 }

src/tasks.rs

@@ -45,6 +45,9 @@ pub enum TaskType {
     SnapshotCreation {
         details: Option<SnapshotCreation>,
     },
+    IndexCompaction {
+        details: Option<IndexCompaction>,
+    },
 }
 
 #[derive(Debug, Clone, Deserialize)]
@@ -93,6 +96,10 @@ pub struct IndexDeletion {
 #[serde(rename_all = "camelCase")]
 pub struct SnapshotCreation {}
 
+#[derive(Debug, Clone, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct IndexCompaction {}
+
 #[derive(Debug, Clone, Deserialize)]
 #[serde(rename_all = "camelCase")]
 pub struct DumpCreation {