Merge #885

885: implemented createSnapshot method and created entry with create_snaps… r=sanders41 a=pbelokon

# Pull Request

## Related issue
Fixes #884 

## What does this PR do?
This pr  Implements the new createSnapshot method in the meilisearch\client.py, also creates a new entry with the key "create_snapshot_1:"  in the .code-samples.meilisearch.yml

## 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?

Co-authored-by: Pavel Belokon <[email protected]>
Co-authored-by: Pavel Belokon <[email protected]>
Co-authored-by: Paul Sanders <[email protected]>

Author: 4 people

.code-samples.meilisearch.yaml

@@ -216,7 +216,7 @@ getting_started_typo_tolerance: |-
       'oneTypo': 4
     }
   })
-get_typo_tolerance_1:
+get_typo_tolerance_1: |-
   client.index('books').get_typo_tolerance()
 update_typo_tolerance_1: |-
   client.index('books').update_typo_tolerance({
@@ -701,3 +701,5 @@ update_dictionary_1: |-
   client.index('books').update_dictionary(["J. R. R.", "W. E. B."])
 reset_dictionary_1: |-
   client.index('books').reset_dictionary()
+create_snapshot_1: |-
+  client.create_snapshot()

meilisearch/client.py

@@ -457,6 +457,24 @@ def create_dump(self) -> TaskInfo:
 
         return TaskInfo(**task)
 
+    def create_snapshot(self) -> TaskInfo:
+        """Trigger the creation of a Meilisearch snapshot.
+
+        Returns
+        -------
+        task_info:
+            TaskInfo instance containing information about a task to track the progress of an asynchronous process.
+            https://www.meilisearch.com/docs/reference/api/tasks#get-one-task
+
+        Raises
+        ------
+        MeilisearchApiError
+            An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://www.meilisearch.com/docs/reference/errors/error_codes#meilisearch-errors
+        """
+        task = self.http.post(self.config.paths.snapshots)
+
+        return TaskInfo(**task)
+
     def swap_indexes(self, parameters: List[Mapping[str, List[str]]]) -> TaskInfo:
         """Swap two indexes.
 

meilisearch/config.py

@@ -31,6 +31,7 @@ class Paths:
         sortable_attributes = "sortable-attributes"
         typo_tolerance = "typo-tolerance"
         dumps = "dumps"
+        snapshots = "snapshots"
         pagination = "pagination"
         faceting = "faceting"
         dictionary = "dictionary"

tests/client/test_clinet_snapshots.py

@@ -0,0 +1,11 @@
+# pylint: disable=invalid-name
+
+
+def test_snapshot_creation(client, index_with_documents):
+    """Tests the creation of a Meilisearch snapshot."""
+    index_with_documents("indexUID-snapshot-creation")
+    snapshot = client.create_snapshot()
+    client.wait_for_task(snapshot.task_uid)
+    snapshot_status = client.get_task(snapshot.task_uid)
+    assert snapshot_status.status == "succeeded"
+    assert snapshot_status.type == "snapshotCreation"