Merge #654

654: added updateDocumentsCsv(string docs, string primaryKey) r=alallema a=sajdakabir

# Pull Request

## Related issue
Fixes #347 

## What does this PR do?
- Adds handles for updating with CSV string.

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


Co-authored-by: Sajda Kabir <[email protected]>
Co-authored-by: sajda <[email protected]>

Author: 3 people

meilisearch/index.py

@@ -592,6 +592,33 @@ def update_documents_json(
         """
         return self.update_documents_raw(str_documents, primary_key, "application/json")
 
+    def update_documents_csv(
+        self,
+        str_documents: str,
+        primary_key: Optional[str] = None,
+    ) -> TaskInfo:
+        """Update documents as a csv string in the index.
+
+        Parameters
+        ----------
+        str_documents:
+            String of document from a CSV file.
+        primary_key (optional):
+            The primary-key used in index. Ignored if already set up
+
+        Returns
+        -------
+        task_info:
+            TaskInfo instance containing information about a task to track the progress of an asynchronous process.
+            https://docs.meilisearch.com/reference/api/tasks.html#get-one-task
+
+        Raises
+        ------
+        MeiliSearchApiError
+            An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
+        """
+        return self.update_documents_raw(str_documents, primary_key, "text/csv")
+
     def update_documents_raw(
         self,
         str_documents: str,

tests/index/test_index_document_meilisearch.py

@@ -197,6 +197,17 @@ def test_add_documents_csv(empty_index, songs_csv):
     assert index.get_primary_key() == "id"
 
 
+def test_update_documents_csv(index_with_documents, songs_csv):
+    """Tests updating a single document with csv string."""
+    index = index_with_documents()
+    response = index.update_documents_csv(songs_csv)
+    assert isinstance(response, TaskInfo)
+    assert response.task_uid is not None
+    task = index.wait_for_task(response.task_uid)
+    assert task.status == "succeeded"
+    assert index.get_primary_key() == "id"
+
+
 def test_add_documents_json(empty_index, small_movies_json_file):
     """Tests adding new documents to a clean index."""
     index = empty_index()