Skip to content

Foxx API #65

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.

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 3 commits into from
Aug 12, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 10 additions & 0 deletions arangoasync/database.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@
DefaultApiExecutor,
TransactionApiExecutor,
)
from arangoasync.foxx import Foxx
from arangoasync.graph import Graph
from arangoasync.request import Method, Request
from arangoasync.response import Response
Expand Down Expand Up @@ -199,6 +200,15 @@ def cluster(self) -> Cluster:
"""
return Cluster(self._executor)

@property
def foxx(self) -> Foxx:
"""Return Foxx API wrapper.

Returns:
arangoasync.foxx.Foxx: Foxx API wrapper.
"""
return Foxx(self._executor)

async def properties(self) -> Result[DatabaseProperties]:
"""Return database properties.

Expand Down
84 changes: 84 additions & 0 deletions arangoasync/exceptions.py
Original file line number Diff line number Diff line change
Expand Up @@ -395,6 +395,90 @@ class EdgeListError(ArangoServerError):
"""Failed to retrieve edges coming in and out of a vertex."""


class FoxxConfigGetError(ArangoServerError):
"""Failed to retrieve Foxx service configuration."""


class FoxxConfigReplaceError(ArangoServerError):
"""Failed to replace Foxx service configuration."""


class FoxxConfigUpdateError(ArangoServerError):
"""Failed to update Foxx service configuration."""


class FoxxCommitError(ArangoServerError):
"""Failed to commit local Foxx service state."""


class FoxxDependencyGetError(ArangoServerError):
"""Failed to retrieve Foxx service dependencies."""


class FoxxDependencyReplaceError(ArangoServerError):
"""Failed to replace Foxx service dependencies."""


class FoxxDependencyUpdateError(ArangoServerError):
"""Failed to update Foxx service dependencies."""


class FoxxScriptListError(ArangoServerError):
"""Failed to retrieve Foxx service scripts."""


class FoxxDevModeEnableError(ArangoServerError):
"""Failed to enable development mode for Foxx service."""


class FoxxDevModeDisableError(ArangoServerError):
"""Failed to disable development mode for Foxx service."""


class FoxxDownloadError(ArangoServerError):
"""Failed to download Foxx service bundle."""


class FoxxReadmeGetError(ArangoServerError):
"""Failed to retrieve Foxx service readme."""


class FoxxScriptRunError(ArangoServerError):
"""Failed to run Foxx service script."""


class FoxxServiceCreateError(ArangoServerError):
"""Failed to create Foxx service."""


class FoxxServiceDeleteError(ArangoServerError):
"""Failed to delete Foxx services."""


class FoxxServiceGetError(ArangoServerError):
"""Failed to retrieve Foxx service metadata."""


class FoxxServiceListError(ArangoServerError):
"""Failed to retrieve Foxx services."""


class FoxxServiceReplaceError(ArangoServerError):
"""Failed to replace Foxx service."""


class FoxxServiceUpdateError(ArangoServerError):
"""Failed to update Foxx service."""


class FoxxSwaggerGetError(ArangoServerError):
"""Failed to retrieve Foxx service swagger."""


class FoxxTestRunError(ArangoServerError):
"""Failed to run Foxx service tests."""


class GraphCreateError(ArangoServerError):
"""Failed to create the graph."""

Expand Down
Loading
Loading