compact-a-collection

Author: apetenchea

arangoasync/collection.py

@@ -17,6 +17,7 @@
 )
 from arangoasync.exceptions import (
     CollectionChecksumError,
+    CollectionCompactError,
     CollectionConfigureError,
     CollectionPropertiesError,
     CollectionRecalculateCountError,
@@ -48,6 +49,7 @@
 from arangoasync.result import Result
 from arangoasync.serialization import Deserializer, Serializer
 from arangoasync.typings import (
+    CollectionInfo,
     CollectionProperties,
     CollectionStatistics,
     IndexProperties,
@@ -632,6 +634,30 @@ def response_handler(resp: Response) -> None:
 
         await self._executor.execute(request, response_handler)
 
+    async def compact(self) -> Result[CollectionInfo]:
+        """Compact a collection.
+
+        Returns:
+            CollectionInfo: Collection information.
+
+        Raises:
+            CollectionCompactError: If compaction fails.
+
+        References:
+            - `compact-a-collection <https://docs.arangodb.com/stable/develop/http-api/collections/#compact-a-collection>`__
+        """  # noqa: E501
+        request = Request(
+            method=Method.PUT,
+            endpoint=f"/_api/collection/{self.name}/compact",
+        )
+
+        def response_handler(resp: Response) -> CollectionInfo:
+            if not resp.is_success:
+                raise CollectionCompactError(resp, request)
+            return CollectionInfo(self.deserializer.loads(resp.raw_body))
+
+        return await self._executor.execute(request, response_handler)
+
     async def truncate(
         self,
         wait_for_sync: Optional[bool] = None,

arangoasync/exceptions.py

@@ -191,6 +191,10 @@ class CollectionConfigureError(ArangoServerError):
     """Failed to configure collection properties."""
 
 
+class CollectionCompactError(ArangoServerError):
+    """Failed to compact collection."""
+
+
 class CollectionDeleteError(ArangoServerError):
     """Failed to delete collection."""
 

tests/test_collection.py

@@ -5,6 +5,7 @@
 from arangoasync.errno import DATA_SOURCE_NOT_FOUND, INDEX_NOT_FOUND
 from arangoasync.exceptions import (
     CollectionChecksumError,
+    CollectionCompactError,
     CollectionConfigureError,
     CollectionPropertiesError,
     CollectionRecalculateCountError,
@@ -84,6 +85,12 @@ async def test_collection_misc_methods(doc_col, bad_col, docs, cluster):
         await bad_col.recalculate_count()
     await doc_col.recalculate_count()
 
+    # Compact
+    with pytest.raises(CollectionCompactError):
+        await bad_col.compact()
+    res = await doc_col.compact()
+    assert res.name == doc_col.name
+
 
 @pytest.mark.asyncio
 async def test_collection_rename(cluster, db, bad_col, docs):