Skip to content
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
9 changes: 9 additions & 0 deletions arangoasync/aql.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions arangoasync/cluster.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
24 changes: 24 additions & 0 deletions arangoasync/database.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
"""
Expand Down Expand Up @@ -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.

Expand All @@ -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.

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.

Expand All @@ -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.

Expand All @@ -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.

Expand Down
6 changes: 5 additions & 1 deletion arangoasync/foxx.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions docs/aql.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
4 changes: 0 additions & 4 deletions docs/cluster.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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()

Expand Down
4 changes: 4 additions & 0 deletions docs/foxx.rst
Original file line number Diff line number Diff line change
@@ -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`_.

Expand Down
4 changes: 4 additions & 0 deletions docs/task.rst
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Loading