Merge pull request #1442 from sanders41/rename-index

Add ability to rename indexes

Author: sanders41

meilisearch_python_sdk/_client.py

@@ -812,11 +812,13 @@ async def health(self) -> Health:
 
         return Health(**response.json())
 
-    async def swap_indexes(self, indexes: list[tuple[str, str]]) -> TaskInfo:
+    async def swap_indexes(self, indexes: list[tuple[str, str]], rename: bool = False) -> TaskInfo:
         """Swap two indexes.
 
         Args:
             indexes: A list of tuples, each tuple should contain the indexes to swap.
+            rename: Use rename false if you are swapping two existing indexes. Use rename true if
+                the second index in your array does not exist. Default = False
 
         Returns:
             The details of the task.
@@ -830,7 +832,10 @@ async def swap_indexes(self, indexes: list[tuple[str, str]]) -> TaskInfo:
             >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
             >>>     index = await client.swap_indexes([("index_a", "index_b")])
         """
-        processed_indexes = [{"indexes": x} for x in indexes]
+        if rename:
+            processed_indexes = [{"indexes": x, "rename": True} for x in indexes]
+        else:
+            processed_indexes = [{"indexes": x} for x in indexes]
         response = await self._http_requests.post("swap-indexes", processed_indexes)
 
         return TaskInfo(**response.json())
@@ -1775,11 +1780,13 @@ def health(self) -> Health:
 
         return Health(**response.json())
 
-    def swap_indexes(self, indexes: list[tuple[str, str]]) -> TaskInfo:
+    def swap_indexes(self, indexes: list[tuple[str, str]], rename: bool = False) -> TaskInfo:
         """Swap two indexes.
 
         Args:
             indexes: A list of tuples, each tuple should contain the indexes to swap.
+            rename: Use rename false if you are swapping two existing indexes. Use rename true if
+                the second index in your array does not exist. Default = False
 
         Returns:
             The details of the task.
@@ -1793,7 +1800,10 @@ def swap_indexes(self, indexes: list[tuple[str, str]]) -> TaskInfo:
             >>> client = Client("http://localhost.com", "masterKey")
             >>> index = client.swap_indexes([("index_a", "index_b")])
         """
-        processed_indexes = [{"indexes": x} for x in indexes]
+        if rename:
+            processed_indexes = [{"indexes": x, "rename": True} for x in indexes]
+        else:
+            processed_indexes = [{"indexes": x} for x in indexes]
         response = self._http_requests.post("swap-indexes", processed_indexes)
 
         return TaskInfo(**response.json())

tests/test_async_client.py

@@ -550,6 +550,21 @@ async def test_swap_indexes(async_client, async_empty_index):
     assert task.task_type == "indexSwap"
 
 
+@pytest.mark.no_parallel
+async def test_swap_indexes_rename(async_client, async_empty_index):
+    new_name = str(uuid4())
+    index = await async_empty_index()
+    task = await index.add_documents([{"id": 1, "title": index.uid}])
+    await async_client.wait_for_task(task.task_uid)
+    swapTask = await async_client.swap_indexes([(index.uid, new_name)], rename=True)
+    task = async_client.wait_for_task(swapTask.task_uid)
+
+    indexes = await async_client.get_indexes()
+    uids = [index.uid for index in indexes]
+    assert index.uid not in uids
+    assert new_name in uids
+
+
 @pytest.mark.usefixtures("create_tasks")
 @pytest.mark.no_parallel
 async def test_cancel_task_statuses(async_client):

tests/test_client.py

@@ -547,6 +547,21 @@ def test_swap_indexes(client, empty_index):
     assert task.task_type == "indexSwap"
 
 
+@pytest.mark.no_parallel
+def test_swap_indexes_rename(client, empty_index):
+    new_name = str(uuid4())
+    index = empty_index()
+    task = index.add_documents([{"id": 1, "title": index.uid}])
+    client.wait_for_task(task.task_uid)
+    swapTask = client.swap_indexes([(index.uid, new_name)], rename=True)
+    task = client.wait_for_task(swapTask.task_uid)
+
+    indexes = client.get_indexes()
+    uids = [index.uid for index in indexes]
+    assert index.uid not in uids
+    assert new_name in uids
+
+
 @pytest.mark.usefixtures("create_tasks")
 @pytest.mark.no_parallel
 def test_cancel_statuses(client):