recalculate-the-document-count-of-a-collection

Author: apetenchea

arangoasync/collection.py

@@ -19,6 +19,7 @@
     CollectionChecksumError,
     CollectionConfigureError,
     CollectionPropertiesError,
+    CollectionRecalculateCountError,
     CollectionRenameError,
     CollectionResponsibleShardError,
     CollectionRevisionError,
@@ -489,6 +490,26 @@ def response_handler(resp: Response) -> bool:
 
         return await self._executor.execute(request, response_handler)
 
+    async def recalculate_count(self) -> None:
+        """Recalculate the document count.
+
+        Raises:
+            CollectionRecalculateCountError: If re-calculation fails.
+
+        References:
+            - `recalculate-the-document-count-of-a-collection <https://docs.arangodb.com/stable/develop/http-api/collections/#recalculate-the-document-count-of-a-collection>`__
+        """  # noqa: E501
+        request = Request(
+            method=Method.PUT,
+            endpoint=f"/_api/collection/{self.name}/recalculateCount",
+        )
+
+        def response_handler(resp: Response) -> None:
+            if not resp.is_success:
+                raise CollectionRecalculateCountError(resp, request)
+
+        await self._executor.execute(request, response_handler)
+
     async def properties(self) -> Result[CollectionProperties]:
         """Return the full properties of the current collection.
 
@@ -577,7 +598,7 @@ def response_handler(resp: Response) -> CollectionProperties:
 
         return await self._executor.execute(request, response_handler)
 
-    async def rename(self, new_name: str) -> Result[bool]:
+    async def rename(self, new_name: str) -> None:
         """Rename the collection.
 
         Renames may not be reflected immediately in async execution, batch
@@ -590,9 +611,6 @@ async def rename(self, new_name: str) -> Result[bool]:
         Args:
             new_name (str): New collection name.
 
-        Returns:
-            bool: `True` if the collection was renamed successfully.
-
         Raises:
             CollectionRenameError: If rename fails.
 
@@ -606,14 +624,13 @@ async def rename(self, new_name: str) -> Result[bool]:
             data=self.serializer.dumps(data),
         )
 
-        def response_handler(resp: Response) -> bool:
+        def response_handler(resp: Response) -> None:
             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)
+        await self._executor.execute(request, response_handler)
 
     async def truncate(
         self,

arangoasync/exceptions.py

@@ -207,6 +207,10 @@ class CollectionPropertiesError(ArangoServerError):
     """Failed to retrieve collection properties."""
 
 
+class CollectionRecalculateCountError(ArangoServerError):
+    """Failed to recalculate document count."""
+
+
 class CollectionRenameError(ArangoServerError):
     """Failed to rename collection."""
 

tests/test_collection.py

@@ -7,6 +7,7 @@
     CollectionChecksumError,
     CollectionConfigureError,
     CollectionPropertiesError,
+    CollectionRecalculateCountError,
     CollectionRenameError,
     CollectionResponsibleShardError,
     CollectionRevisionError,
@@ -78,6 +79,11 @@ async def test_collection_misc_methods(doc_col, bad_col, docs, cluster):
     with pytest.raises(CollectionChecksumError):
         await bad_col.checksum()
 
+    # Recalculate count
+    with pytest.raises(CollectionRecalculateCountError):
+        await bad_col.recalculate_count()
+    await doc_col.recalculate_count()
+
 
 @pytest.mark.asyncio
 async def test_collection_rename(cluster, db, bad_col, docs):