Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Adding support for /key-generators #375

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 15, 2025
Merged

Adding support for /key-generators #375

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions arango/database.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
AsyncJobListError,
CollectionCreateError,
CollectionDeleteError,
CollectionKeyGeneratorsError,
CollectionListError,
DatabaseCompactError,
DatabaseCreateError,
Expand Down Expand Up @@ -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 #
####################
Expand Down
4 changes: 4 additions & 0 deletions arango/exceptions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."""

Expand Down
7 changes: 7 additions & 0 deletions tests/test_database.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
USE_SYSTEM_DATABASE,
)
from arango.exceptions import (
CollectionKeyGeneratorsError,
DatabaseCompactError,
DatabaseCreateError,
DatabaseDeleteError,
Expand Down Expand Up @@ -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
Expand Down
Loading