diff --git a/arangoasync/aql.py b/arangoasync/aql.py index 14bbd44..0d1c059 100644 --- a/arangoasync/aql.py +++ b/arangoasync/aql.py @@ -678,6 +678,9 @@ def response_handler(resp: Response) -> Jsons: async def functions(self, namespace: Optional[str] = None) -> Result[Jsons]: """List the registered used-defined AQL functions. + Warning: + AQL User Functions are no longer available in ArangoDB 4.0. + Args: namespace (str | None): Returns all registered AQL user functions from the specified namespace. @@ -718,6 +721,9 @@ async def create_function( ) -> Result[Json]: """Registers a user-defined AQL function (UDF) written in JavaScript. + Warning: + AQL User Functions are no longer available in ArangoDB 4.0. + Args: name (str): Name of the function. code (str): JavaScript code of the function. @@ -756,6 +762,9 @@ async def delete_function( ) -> Result[Json]: """Remove a user-defined AQL function. + Warning: + AQL User Functions are no longer available in ArangoDB 4.0. + Args: name (str): Name of the function. group (bool | None): If set to `True`, the function name is treated diff --git a/arangoasync/cluster.py b/arangoasync/cluster.py index fa42ea3..a776b15 100644 --- a/arangoasync/cluster.py +++ b/arangoasync/cluster.py @@ -64,6 +64,10 @@ def response_handler(resp: Response) -> Json: async def statistics(self, db_server: str) -> Result[Json]: """Queries the statistics of the given DB-Server. + Warning: + DB-Server statistics are no longer available in ArangoDB 4.0. + Use :meth:`arangoasync.database.Database.metrics` instead. + Args: db_server (str): The ID of the DB-Server. diff --git a/arangoasync/database.py b/arangoasync/database.py index c00a584..24796be 100644 --- a/arangoasync/database.py +++ b/arangoasync/database.py @@ -234,6 +234,9 @@ def cluster(self) -> Cluster: def foxx(self) -> Foxx: """Return Foxx API wrapper. + Warning: + Foxx microservice features are no longer available in ArangoDB 4.0. + Returns: arangoasync.foxx.Foxx: Foxx API wrapper. """ @@ -2429,6 +2432,9 @@ def response_handler(resp: Response) -> Json: async def tasks(self) -> Result[Jsons]: """Fetches all existing tasks from the server. + Warning: + Tasks are no longer available in ArangoDB 4.0. + Returns: list: List of currently active server tasks. @@ -2451,6 +2457,9 @@ def response_handler(resp: Response) -> Jsons: async def task(self, task_id: str) -> Result[Json]: """Return the details of an active server task. + Warning: + Tasks are no longer available in ArangoDB 4.0. + Args: task_id (str) -> Server task ID. @@ -2484,6 +2493,9 @@ async def create_task( ) -> Result[Json]: """Create a new task. + Warning: + Tasks are no longer available in ArangoDB 4.0. + Args: command (str): The JavaScript code to be executed. task_id (str | None): Optional task ID. If not provided, the server will @@ -2542,6 +2554,9 @@ async def delete_task( ) -> Result[bool]: """Delete a server task. + Warning: + Tasks are no longer available in ArangoDB 4.0. + Args: task_id (str): Task ID. ignore_missing (bool): If `True`, do not raise an exception if the @@ -2909,6 +2924,9 @@ def response_handler(resp: Response) -> None: async def reload_routing(self) -> None: """Reload the routing information. + Warning: + Route reloading is no longer available in ArangoDB 4.0. + Raises: ServerReloadRoutingError: If the operation fails. @@ -2926,6 +2944,9 @@ def response_handler(resp: Response) -> None: async def echo(self, body: Optional[Json] = None) -> Result[Json]: """Return an object with the servers request information. + Warning: + Request echoing is no longer available in ArangoDB 4.0. + Args: body (dict | None): Optional body of the request. @@ -2952,6 +2973,9 @@ def response_handler(resp: Response) -> Json: async def execute(self, command: str) -> Result[Any]: """Execute raw Javascript command on the server. + Warning: + Javascript command execution is no longer available in ArangoDB 4.0. + Args: command (str): Javascript command to execute. diff --git a/arangoasync/foxx.py b/arangoasync/foxx.py index 0b068da..6432626 100644 --- a/arangoasync/foxx.py +++ b/arangoasync/foxx.py @@ -34,7 +34,11 @@ class Foxx: - """Foxx API wrapper.""" + """Foxx API wrapper. + + Warning: + Foxx microservice features are no longer available in ArangoDB 4.0. + """ def __init__(self, executor: ApiExecutor) -> None: self._executor = executor diff --git a/docs/aql.rst b/docs/aql.rst index 97d4f6c..5b29f4f 100644 --- a/docs/aql.rst +++ b/docs/aql.rst @@ -90,6 +90,10 @@ See :class:`arangoasync.aql.AQL` for API specification. AQL User Functions ================== +.. warning:: + AQL User Functions are no longer available in ArangoDB 4.0. + + **AQL User Functions** are custom functions you define in Javascript to extend AQL functionality. They are somewhat similar to SQL procedures. diff --git a/docs/cluster.rst b/docs/cluster.rst index d5c4908..108c8a6 100644 --- a/docs/cluster.rst +++ b/docs/cluster.rst @@ -24,10 +24,6 @@ and architecture, refer to `ArangoDB Manual`_. # Cluster health health = await cluster.health() - # DB-Server statistics - db_server = "PRMR-2716c9d0-4b22-4c66-ba3d-f9cd3143e52b" - stats = await cluster.statistics(db_server) - # Cluster endpoints endpoints = await cluster.endpoints() diff --git a/docs/foxx.rst b/docs/foxx.rst index 91e3423..4ce4a4e 100644 --- a/docs/foxx.rst +++ b/docs/foxx.rst @@ -1,6 +1,10 @@ Foxx ---- +.. warning:: + Foxx microservice features are no longer available in ArangoDB 4.0. + + **Foxx** is a microservice framework which lets you define custom HTTP endpoints that extend ArangoDB's REST API. For more information, refer to `ArangoDB Manual`_. diff --git a/docs/task.rst b/docs/task.rst index 2490507..41c1c7d 100644 --- a/docs/task.rst +++ b/docs/task.rst @@ -1,6 +1,10 @@ Tasks ----- +.. warning:: + Tasks are no longer available in ArangoDB 4.0. + + ArangoDB can schedule user-defined Javascript snippets as one-time or periodic (re-scheduled after each execution) tasks. Tasks are executed in the context of the database they are defined in.