python-arango-async 1.2.1__py3-none-any.whl → 1.2.3__py3-none-any.whl

arangoasync/aql.py

@@ -678,6 +678,9 @@ class AQL:
     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 @@ class AQL:
     ) -> 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 @@ class AQL:
     ) -> 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

arangoasync/cluster.py

@@ -64,6 +64,10 @@ class Cluster:
     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.
 

arangoasync/collection.py

@@ -397,7 +397,7 @@ class Collection(Generic[T, U, V]):
 
         Args:
             type (str): Type attribute (ex. "persistent", "inverted", "ttl", "mdi",
-                "geo").
+                "geo", "vector").
             fields (dict | list): Fields to index.
             options (dict | None): Additional index options.
 

arangoasync/database.py

@@ -234,6 +234,9 @@ class Database:
     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 @@ class Database:
     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 @@ class Database:
     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 @@ class Database:
     ) -> 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 @@ class Database:
     ) -> 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 @@ class Database:
     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 @@ class Database:
     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 @@ class Database:
     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.
 
@@ -3004,7 +3028,7 @@ class Database:
             ServerMetricsError: If the operation fails.
 
         References:
-            - `metrics-api-v2 <https://docs.arango.ai/arangodb/stable/develop/http-api/monitoring/metrics/#metrics-api-v2>`__
+            - `metrics-api <https://docs.arango.ai/arangodb/stable/develop/http-api/monitoring/metrics/#metrics-api>`__
         """  # noqa: E501
         params: Params = {}
         if server_id is not None:
@@ -3012,7 +3036,7 @@ class Database:
 
         request = Request(
             method=Method.GET,
-            endpoint="/_admin/metrics/v2",
+            endpoint="/_admin/metrics",
             params=params,
         )
 

arangoasync/foxx.py

@@ -34,7 +34,11 @@ from arangoasync.typings import Json, Jsons, Params, RequestHeaders
 
 
 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

arangoasync/typings.py

@@ -12,6 +12,7 @@ from typing import (
     TypeAlias,
     cast,
 )
+from warnings import warn
 
 from multidict import CIMultiDictProxy, MultiDict
 
@@ -564,7 +565,7 @@ class DatabaseProperties(JsonWrapper):
 
     @property
     def path(self) -> Optional[str]:
-        """The filesystem path of the current database."""
+        """The filesystem path of the current database. Removed in ArangoDB 4.0."""
         return self._data.get("path")
 
     @property
@@ -677,6 +678,8 @@ class CollectionProperties(JsonWrapper):
 
     @property
     def status_string(self) -> Optional[str]:
+        m = "statusString attribute has been removed in ArangoDB 4.0"
+        warn(m, DeprecationWarning, stacklevel=2)
         return self._data.get("statusString")
 
     @property
@@ -701,6 +704,8 @@ class CollectionProperties(JsonWrapper):
 
     @property
     def status(self) -> CollectionStatus:
+        m = "status attribute has been removed in ArangoDB 4.0"
+        warn(m, DeprecationWarning, stacklevel=2)
         return CollectionStatus.from_int(self._data["status"])
 
     @property
@@ -727,6 +732,10 @@ class CollectionProperties(JsonWrapper):
     def computed_values(self) -> Optional[Json]:
         return self._data.get("computedValues")
 
+    @property
+    def supportsRBAC(self) -> Optional[bool]:
+        return self._data.get("supportsRBAC")
+
     @property
     def object_id(self) -> str:
         return self._data["objectId"]  # type: ignore[no-any-return]
@@ -808,6 +817,8 @@ class CollectionProperties(JsonWrapper):
             result["computedValues"] = data["computedValues"]
         if "internalValidatorType" in data:
             result["internal_validator_type"] = data["internalValidatorType"]
+        if "supportsRBAC" in data:
+            result["supportsRBAC"] = data["supportsRBAC"]
         return result
 
     def format(self, formatter: Optional[Formatter] = None) -> Json:
@@ -1121,6 +1132,14 @@ class IndexProperties(JsonWrapper):
     def features(self) -> Optional[List[str]]:
         return self._data.get("features")
 
+    @property
+    def error_message(self) -> Optional[str]:
+        return self._data.get("errorMessage")
+
+    @property
+    def training_state(self) -> Optional[str]:
+        return self._data.get("trainingState")
+
     @staticmethod
     def compatibility_formatter(data: Json) -> Json:
         """python-arango compatibility formatter."""
@@ -1179,6 +1198,10 @@ class IndexProperties(JsonWrapper):
             result["writebuffer_max_size"] = data["writebufferSizeMax"]
         if "optimizeTopK" in data:
             result["optimizeTopK"] = data["optimizeTopK"]
+        if "errorMessage" in data:
+            result["error_message"] = data["errorMessage"]
+        if "trainingState" in data:
+            result["training_state"] = data["trainingState"]
         return result
 
     def format(self, formatter: Optional[Formatter] = None) -> Json:

arangoasync/version.py

@@ -1 +1 @@
-__version__ = "1.2.1"
+__version__ = "1.2.3"

{python_arango_async-1.2.1.dist-info → python_arango_async-1.2.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-arango-async
-Version: 1.2.1
+Version: 1.2.3
 Summary: Async Python Driver for ArangoDB
 Author-email: Alexandru Petenchea <alexandru.petenchea@arangodb.com>, Anthony Mahanna <anthony.mahanna@arangodb.com>
 Maintainer-email: Alexandru Petenchea <alexandru.petenchea@arangodb.com>, Anthony Mahanna <anthony.mahanna@arangodb.com>
@@ -26,7 +26,7 @@ Requires-Dist: multidict>=6.0
 Requires-Dist: pyjwt>=2.10.0
 Provides-Extra: dev
 Requires-Dist: aiofiles>=24.1.0; extra == "dev"
-Requires-Dist: black==26.1.0; extra == "dev"
+Requires-Dist: black==26.3.1; extra == "dev"
 Requires-Dist: flake8==7.3.0; extra == "dev"
 Requires-Dist: isort>=5.10.1; extra == "dev"
 Requires-Dist: mypy==1.15.0; extra == "dev"
@@ -169,7 +169,7 @@ async def main():
         # Traverse the graph in outbound direction, breath-first.
         query = """
             FOR v, e, p IN 1..3 OUTBOUND 'students/01' GRAPH 'school'
-            OPTIONS { bfs: true, uniqueVertices: 'global' }
+            OPTIONS { order: 'bfs', uniqueVertices: 'global' }
             RETURN {vertex: v, edge: e, path: p}
             """
 

{python_arango_async-1.2.1.dist-info → python_arango_async-1.2.3.dist-info}/RECORD

@@ -1,18 +1,18 @@
 arangoasync/__init__.py,sha256=HEJ7_q_pRcS9Gco3poa89jLQr_zDrDrHAXCEJMgjUFI,196
-arangoasync/aql.py,sha256=RKH0VAWs4zxm3sGvgzTO_GF6-F1gsZubvt7FHf_mV70,30271
+arangoasync/aql.py,sha256=wUB6K2if5IGk6ucIVa5mxjWjQGG7l6p7xdtj39b6yn8,30541
 arangoasync/auth.py,sha256=16apz1_IvAB_ZSyenoPha6F_JkbHokmOWFHxPL_swxQ,3025
 arangoasync/backup.py,sha256=6ZUDjP44bilv056K2fo8l7BnmoeksJ9G9keMVP7i9FI,10577
 arangoasync/client.py,sha256=MKLYXPdDhBezFIKX1H5e7-dKzYnIHwbfN0CO8AEsAzs,10054
-arangoasync/cluster.py,sha256=t-65G17__SLLSBgigoJN5YDKwEAzS3t5vc2CGvrzWTo,17097
-arangoasync/collection.py,sha256=DdY5dbGPeFngxmf9fpSWD2C8FbB6QBs7lc-spsVtpkc,122447
+arangoasync/cluster.py,sha256=64GYlpz07wBczeNTrPpxnUd17tFocrhGijGHF_dqdoo,17260
+arangoasync/collection.py,sha256=BpyoYSgSIJ3PfPkqh6PwT7HLg66QLGkNA4eqx6xkYaM,122457
 arangoasync/compression.py,sha256=vMhcg5nQPkbgplk48vxARUnJ6YeIwrCLC6pDCVJSwo0,3804
 arangoasync/connection.py,sha256=f6HQOZHayluNVyH-j-sujlE_dvQrVxC1lPWnzrfQLqY,17459
 arangoasync/cursor.py,sha256=RQJOtNpxEx5n3eKx7UYPl1N8gzWYQESjufvakr18azk,8464
-arangoasync/database.py,sha256=p7EkDYEqWPGkl3xuMlaF_3O1kTBZ8mR8n65Pwqr1LS4,138824
+arangoasync/database.py,sha256=tjdxJBJ5q6X8Q5qIVTLKPb6-tEPnNKV9EUIa-k1_K9Q,139492
 arangoasync/errno.py,sha256=4oKY9IyyzjOitbywhjH8S214qeNtpDlQg7JsHENJNoU,25245
 arangoasync/exceptions.py,sha256=lyb5iWMj71nNli32t23AWXKyOldQEJRuKoChtf0uBss,20000
 arangoasync/executor.py,sha256=eRUfWQc4eHgJr15nPnDju8oSK0408x6yB8XEGk7YhPY,4740
-arangoasync/foxx.py,sha256=uoIPbK3WRqR9_tcR0n6GzN7oFGTb_0MkmZ1wWqd92tI,28829
+arangoasync/foxx.py,sha256=qksGB7Y65_J4f6uThQzBHvmIOzjomslV4pIqohtBS54,28924
 arangoasync/graph.py,sha256=G-todTf-ldTQtS2uhCsiigdPL4WABbbfTrLKlIPFkhA,40953
 arangoasync/http.py,sha256=xkxnLMbqFBEngmqGCuBOgRuXgQSBUk9-dzYXB1yrL98,6154
 arangoasync/job.py,sha256=B9cPDzxaYflWDj95j941wrcCj4w5j-gnmSzs3TdNdfw,7471
@@ -23,10 +23,10 @@ arangoasync/resolver.py,sha256=icsmQIkklrvq-a88vIR8C-M3rcv5BJxhDE2PK8LenG0,3409
 arangoasync/response.py,sha256=VMnoWgtyrh1JGK7mEgRNsUtSawxWMgFjHT-Cff4d8zc,2132
 arangoasync/result.py,sha256=NVwFxpYUDujHNRCqCZIBOlGLzB7XsiSmjWPFhUgRS6k,233
 arangoasync/serialization.py,sha256=ExRqrEpbk11Hb3AfFUJGqPlGBD3dbvwQg_xsZUsrm6I,2910
-arangoasync/typings.py,sha256=xTAdATHRvV2g8_eld-v80UhjoY3f_TJ8ZkJy3U6ZqNc,69243
-arangoasync/version.py,sha256=Mlm4Gvmb_6yQxwUbv2Ksc-BJFXLPg9H1Vt2iV7wXrA4,22
-python_arango_async-1.2.1.dist-info/licenses/LICENSE,sha256=6zoGhJon2tcnvzmycirNjLNBZ6rlLJtYDdVGO76RXVM,1065
-python_arango_async-1.2.1.dist-info/METADATA,sha256=TOqI9x4YT2xMJEcct7QSUU3-BZ8jTG8AwptblLh1zIo,7940
-python_arango_async-1.2.1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-python_arango_async-1.2.1.dist-info/top_level.txt,sha256=uabwJ6t-MiIaZQXGUvYikeSbZDcF0RK37GzikBnDz5k,12
-python_arango_async-1.2.1.dist-info/RECORD,,
+arangoasync/typings.py,sha256=xT6Dm63aTOWnLiiN0Gkxqm0jED4A43IyP_5p9haZKy4,70135
+arangoasync/version.py,sha256=C-D_WWrVkBDmQmApLcm0sWNh2CgIrwWfc8_sB5vvU-Q,22
+python_arango_async-1.2.3.dist-info/licenses/LICENSE,sha256=6zoGhJon2tcnvzmycirNjLNBZ6rlLJtYDdVGO76RXVM,1065
+python_arango_async-1.2.3.dist-info/METADATA,sha256=PBU14KUEYj8BqIOS5UjNIOu_ooOUJBrQaZMXjcJ46lo,7943
+python_arango_async-1.2.3.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+python_arango_async-1.2.3.dist-info/top_level.txt,sha256=uabwJ6t-MiIaZQXGUvYikeSbZDcF0RK37GzikBnDz5k,12
+python_arango_async-1.2.3.dist-info/RECORD,,