Adding renaming method

Author: apetenchea

arangoasync/collection.py

@@ -19,6 +19,7 @@
     CollectionChecksumError,
     CollectionConfigureError,
     CollectionPropertiesError,
+    CollectionRenameError,
     CollectionResponsibleShardError,
     CollectionRevisionError,
     CollectionShardsError,
@@ -576,6 +577,44 @@ def response_handler(resp: Response) -> CollectionProperties:
 
         return await self._executor.execute(request, response_handler)
 
+    async def rename(self, new_name: str) -> Result[bool]:
+        """Rename the collection.
+
+        Renames may not be reflected immediately in async execution, batch
+        execution or transactions. It is recommended to initialize new API
+        wrappers after a rename.
+
+        Note:
+            Renaming collections is not supported in cluster deployments.
+
+        Args:
+            new_name (str): New collection name.
+
+        Returns:
+            bool: `True` if the collection was renamed successfully.
+
+        Raises:
+            CollectionRenameError: If rename fails.
+
+        References:
+            - `rename-a-collection <https://docs.arangodb.com/stable/develop/http-api/collections/#rename-a-collection>`__
+        """  # noqa: E501
+        data: Json = {"name": new_name}
+        request = Request(
+            method=Method.PUT,
+            endpoint=f"/_api/collection/{self.name}/rename",
+            data=self.serializer.dumps(data),
+        )
+
+        def response_handler(resp: Response) -> bool:
+            if not resp.is_success:
+                raise CollectionRenameError(resp, request)
+            self._name = new_name
+            self._id_prefix = f"{new_name}/"
+            return True
+
+        return await self._executor.execute(request, response_handler)
+
     async def truncate(
         self,
         wait_for_sync: Optional[bool] = None,

arangoasync/exceptions.py

@@ -207,6 +207,10 @@ class CollectionPropertiesError(ArangoServerError):
     """Failed to retrieve collection properties."""
 
 
+class CollectionRenameError(ArangoServerError):
+    """Failed to rename collection."""
+
+
 class CollectionResponsibleShardError(ArangoServerError):
     """Failed to retrieve responsible shard."""
 

tests/test_collection.py

@@ -7,6 +7,7 @@
     CollectionChecksumError,
     CollectionConfigureError,
     CollectionPropertiesError,
+    CollectionRenameError,
     CollectionResponsibleShardError,
     CollectionRevisionError,
     CollectionShardsError,
@@ -19,6 +20,7 @@
     IndexListError,
     IndexLoadError,
 )
+from tests.helpers import generate_col_name
 
 
 def test_collection_attributes(db, doc_col):
@@ -77,6 +79,27 @@ async def test_collection_misc_methods(doc_col, bad_col, docs, cluster):
         await bad_col.checksum()
 
 
+@pytest.mark.asyncio
+async def test_collection_rename(cluster, db, bad_col, docs):
+    if cluster:
+        pytest.skip("Renaming collections is not supported in cluster deployments.")
+
+    with pytest.raises(CollectionRenameError):
+        await bad_col.rename("new_name")
+
+    col_name = generate_col_name()
+    new_name = generate_col_name()
+    try:
+        await db.create_collection(col_name)
+        col = db.collection(col_name)
+        await col.rename(new_name)
+        assert col.name == new_name
+        doc = await col.insert(docs[0])
+        assert col.get_col_name(doc) == new_name
+    finally:
+        db.delete_collection(new_name, ignore_missing=True)
+
+
 @pytest.mark.asyncio
 async def test_collection_index(doc_col, bad_col, cluster):
     # Create indexes