Added support for /key-generators

Author: apetenchea

arangoasync/database.py

@@ -22,6 +22,7 @@
     AsyncJobListError,
     CollectionCreateError,
     CollectionDeleteError,
+    CollectionKeyGeneratorsError,
     CollectionListError,
     DatabaseCreateError,
     DatabaseDeleteError,
@@ -695,6 +696,29 @@ def response_handler(resp: Response) -> bool:
 
         return await self._executor.execute(request, response_handler)
 
+    async def key_generators(self) -> Result[List[str]]:
+        """Returns the available key generators for collections.
+
+        Returns:
+            list: List of available key generators.
+
+        Raises:
+            CollectionKeyGeneratorsError: If retrieval fails.
+
+        References:
+            - `get-the-available-key-generators <https://docs.arangodb.com/stable/develop/http-api/collections/#get-the-available-key-generators>`__
+        """  # noqa: E501
+        request = Request(method=Method.GET, endpoint="/_api/key-generators")
+
+        def response_handler(resp: Response) -> List[str]:
+            if not resp.is_success:
+                raise CollectionKeyGeneratorsError(resp, request)
+            return cast(
+                List[str], self.deserializer.loads(resp.raw_body)["keyGenerators"]
+            )
+
+        return await self._executor.execute(request, response_handler)
+
     async def has_document(
         self,
         document: str | Json,

arangoasync/exceptions.py

@@ -191,6 +191,10 @@ class CollectionDeleteError(ArangoServerError):
     """Failed to delete collection."""
 
 
+class CollectionKeyGeneratorsError(ArangoServerError):
+    """Failed to retrieve key generators."""
+
+
 class CollectionListError(ArangoServerError):
     """Failed to retrieve collections."""
 

tests/test_database.py

@@ -6,6 +6,7 @@
 from arangoasync.exceptions import (
     CollectionCreateError,
     CollectionDeleteError,
+    CollectionKeyGeneratorsError,
     CollectionListError,
     DatabaseCreateError,
     DatabaseDeleteError,
@@ -55,6 +56,12 @@ async def test_database_misc_methods(sys_db, db, bad_db, cluster):
     with pytest.raises(ServerVersionError):
         await bad_db.version()
 
+    # key generators
+    key_generators = await db.key_generators()
+    assert isinstance(key_generators, list)
+    with pytest.raises(CollectionKeyGeneratorsError):
+        await bad_db.key_generators()
+
 
 @pytest.mark.asyncio
 async def test_create_drop_database(