feat: Adding support for index renaming.

Author: awais786

meilisearch/client.py

@@ -531,6 +531,30 @@ def create_snapshot(self) -> TaskInfo:
 
         return TaskInfo(**task)
 
+    def swap_indexes(self, parameters: List[Mapping[str, List[str]]]) -> TaskInfo:
+        """Swap two indexes.
+
+        Parameters
+        ----------
+        indexes:
+            List of indexes to swap ex:
+             [{"indexes": ["indexA", "indexB"]})  # default rename to false
+            {"indexes": ["indexA", "indexB"], "rename": false}
+            {"indexes": ["indexA", "indexB"], "rename": true}
+
+        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
+        """
+        return TaskInfo(**self.http.post(self.config.paths.swap, parameters))
+
     def get_tasks(self, parameters: Optional[MutableMapping[str, Any]] = None) -> TaskResults:
         """Get all tasks.
 

meilisearch/index.py

@@ -104,13 +104,15 @@ def delete(self) -> TaskInfo:
 
         return TaskInfo(**task)
 
-    def update(self, primary_key: str) -> TaskInfo:
+    def update(self, primary_key: Optional[str] = None, new_uid: Optional[str] = None) -> TaskInfo:
         """Update the index primary-key.
 
         Parameters
         ----------
         primary_key:
             The primary key to use for the index.
+        new_uid : str, optional
+            The new UID to rename the index.
 
         Returns
         -------
@@ -123,7 +125,13 @@ def update(self, primary_key: str) -> TaskInfo:
         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
         """
-        payload = {"primaryKey": primary_key}
+        payload = {}
+        if primary_key is not None:
+            payload["primaryKey"] = primary_key
+
+        if new_uid is not None:
+            payload["uid"] = new_uid  # This enables renaming
+
         task = self.http.patch(f"{self.config.paths.index}/{self.uid}", payload)
 
         return TaskInfo(**task)
@@ -2348,18 +2356,3 @@ def compact(self) -> TaskInfo:
         task = self.http.post(path)
         return TaskInfo(**task)
 
-    def rename_index(self, new_name: str) -> TaskInfo:
-        """
-        Rename the current Meilisearch index.
-
-        :param new_name: The new UID for the index.
-        :return: TaskInfo with information about the rename operation.
-        """
-        payload = {"uid": new_name}
-
-        task = self.http.patch(
-            f"{self.config.paths.index}/{self.uid}",
-            payload,
-        )
-
-        return TaskInfo(**task)

tests/index/test_index.py

@@ -234,3 +234,42 @@ def test_index_compact(client):
 
     assert stats_before.number_of_documents == stats_after.number_of_documents
     assert stats_after.is_indexing is False
+
+
+@pytest.mark.usefixtures("indexes_sample")
+def test_rename_index(client):
+    """Test renaming an existing index."""
+    original_uid = common.INDEX_UID
+    new_uid = f"{original_uid}_renamed"
+    index = client.index(original_uid)
+
+    # Perform the rename
+    task_info = index.update(new_uid=new_uid)
+    client.wait_for_task(task_info.task_uid)
+
+    # Verify the index now exists with the new UID
+    renamed_index = client.index(new_uid)
+    info = renamed_index.fetch_info()
+    assert info.uid == new_uid
+
+    # # Verify the old UID no longer exists
+    with pytest.raises(MeilisearchApiError):
+        client.index(original_uid).fetch_info()  # Assert old UID is gone
+
+
+@pytest.mark.usefixtures("indexes_sample")
+def test_index_update_and_rename(client):
+    """Test updating primary key and renaming an index together."""
+    original_uid = common.INDEX_UID
+    new_uid = f"{original_uid}_renamed"
+    index = client.index(original_uid)
+
+    # 1. Update the primary key
+    task_info = index.update(primary_key="objectID", new_uid=new_uid)
+    client.wait_for_task(task_info.task_uid)
+
+    # Verify the index now exists with the new UID
+    renamed_index = client.index(new_uid)
+    info = renamed_index.fetch_info()
+    assert info.uid == new_uid
+    assert renamed_index.get_primary_key() == "objectID"