Adding support for /key-generators (#375)

Author: apetenchea

arango/database.py

@@ -27,6 +27,7 @@
     AsyncJobListError,
     CollectionCreateError,
     CollectionDeleteError,
+    CollectionKeyGeneratorsError,
     CollectionListError,
     DatabaseCompactError,
     DatabaseCreateError,
@@ -1623,6 +1624,23 @@ def response_handler(resp: Response) -> bool:
 
         return self._execute(request, response_handler)
 
+    def key_generators(self) -> Result[List[str]]:
+        """Returns the available key generators for collections.
+
+        :return: List of available key generators.
+        :rtype: [str]
+        :raise arango.exceptions.CollectionKeyGeneratorsError: If retrieval fails.
+        """  # noqa: E501
+        request = Request(method="get", endpoint="/_api/key-generators")
+
+        def response_handler(resp: Response) -> List[str]:
+            if not resp.is_success:
+                raise CollectionKeyGeneratorsError(resp, request)
+            result: List[str] = resp.body["keyGenerators"]
+            return result
+
+        return self._execute(request, response_handler)
+
     ####################
     # Graph Management #
     ####################

arango/exceptions.py

@@ -298,6 +298,10 @@ class CollectionTruncateError(ArangoServerError):
     """Failed to truncate collection."""
 
 
+class CollectionKeyGeneratorsError(ArangoServerError):
+    """Failed to retrieve key generators."""
+
+
 class CollectionLoadError(ArangoServerError):
     """Failed to load collection."""
 

tests/test_database.py

@@ -13,6 +13,7 @@
     USE_SYSTEM_DATABASE,
 )
 from arango.exceptions import (
+    CollectionKeyGeneratorsError,
     DatabaseCompactError,
     DatabaseCreateError,
     DatabaseDeleteError,
@@ -348,6 +349,12 @@ def test_database_misc_methods(client, sys_db, db, bad_db, cluster, secret, db_v
     result = db_superuser.compact()
     assert result == {}
 
+    if db_version >= version.parse("3.12.0"):
+        key_generators = db.key_generators()
+        assert isinstance(key_generators, list)
+        with pytest.raises(CollectionKeyGeneratorsError):
+            bad_db.key_generators()
+
 
 def test_database_management(db, sys_db, bad_db):
     # Test list databases