python-arango 8.3.2__py3-none-any.whl → 8.3.4__py3-none-any.whl

arango/aql.py

@@ -654,6 +654,8 @@ class AQL(ApiGroup):
     def functions(self) -> Result[Jsons]:
         """List the AQL functions defined in the database.
 
+        .. warning:: AQL User Functions are no longer available in ArangoDB 4.0.
+
         :return: AQL functions.
         :rtype: [dict]
         :raise arango.exceptions.AQLFunctionListError: If retrieval fails.
@@ -676,6 +678,8 @@ class AQL(ApiGroup):
     def create_function(self, name: str, code: str) -> Result[Json]:
         """Create a new AQL function.
 
+        .. warning:: AQL User Functions are no longer available in ArangoDB 4.0.
+
         :param name: AQL function name.
         :type name: str
         :param code: Function definition in Javascript.
@@ -703,6 +707,8 @@ class AQL(ApiGroup):
     ) -> Result[Union[bool, Json]]:
         """Delete an AQL function.
 
+        .. warning:: AQL User Functions are no longer available in ArangoDB 4.0.
+
         :param name: AQL function name.
         :type name: str
         :param group: If set to True, value of parameter **name** is treated

arango/cluster.py

@@ -144,6 +144,11 @@ class Cluster(ApiGroup):  # pragma: no cover
     def server_statistics(self, server_id: str) -> Result[Json]:
         """Return the statistics for the given server.
 
+        .. warning::
+            DB Server Statistics are no longer available in ArangoDB 4.0.
+            Use :meth:`Database.metrics <arango.database.StandardDatabase.metrics>`
+            instead.
+
         :param server_id: Server ID.
         :type server_id: str
         :return: Statistics for the given server.

arango/collection.py

@@ -542,7 +542,7 @@ class Collection(ApiGroup):
         .. note::
             The load function is deprecated from version 3.8.0 onwards and is a
             no-op from version 3.9.0 onwards. It should no longer be used, as it
-            may be removed in a future version of ArangoDB.
+            is removed from ArangoDB 4.0.
 
         :return: True if collection was loaded successfully.
         :rtype: bool
@@ -566,7 +566,7 @@ class Collection(ApiGroup):
         .. note::
             The unload function is deprecated from version 3.8.0 onwards and is a
             no-op from version 3.9.0 onwards. It should no longer be used, as it
-            may be removed in a future version of ArangoDB.
+            is removed from ArangoDB 4.0.
 
         :return: True if collection was unloaded successfully.
         :rtype: bool
@@ -816,14 +816,20 @@ class Collection(ApiGroup):
 
         skip_val = skip if skip is not None else 0
         limit_val = limit if limit is not None else "null"
+        filter_conditions, filter_bind_vars = build_filter_conditions(filters)
+        sort_expression, sort_bind_vars = build_sort_expression(sort)
         query = f"""
             FOR doc IN @@collection
-                {build_filter_conditions(filters)}
+                {filter_conditions}
                 LIMIT {skip_val}, {limit_val}
-                {build_sort_expression(sort)}
+                {sort_expression}
                 RETURN doc
         """
-        bind_vars = {"@collection": self.name}
+        bind_vars = {
+            "@collection": self.name,
+            **filter_bind_vars,
+            **sort_bind_vars,
+        }
 
         request = Request(
             method="post",
@@ -849,6 +855,8 @@ class Collection(ApiGroup):
     ) -> Result[Cursor]:
         """Return documents near a given coordinate.
 
+        .. warning:: This functionality is deprecated in ArangoDB 4.0.
+
         Documents returned are sorted according to distance, with the nearest
         document being the first. If there are documents of equal distance,
         they are randomly chosen from the set until the limit is reached. A geo
@@ -866,6 +874,9 @@ class Collection(ApiGroup):
         :rtype: arango.cursor.Cursor
         :raises arango.exceptions.DocumentGetError: If retrieval fails.
         """
+        m = "find_near is deprecated in ArangoDB 4.0"
+        warn(m, DeprecationWarning, stacklevel=2)
+
         assert isinstance(latitude, Number), "latitude must be a number"
         assert isinstance(longitude, Number), "longitude must be a number"
         assert is_none_or_int(limit), "limit must be a non-negative int"
@@ -971,6 +982,8 @@ class Collection(ApiGroup):
     ) -> Result[Cursor]:
         """Return documents within a given radius around a coordinate.
 
+        .. warning:: This functionality is deprecated in ArangoDB 4.0.
+
         A geo index must be defined in the collection to use this method.
 
         :param latitude: Latitude.
@@ -988,6 +1001,9 @@ class Collection(ApiGroup):
         :rtype: arango.cursor.Cursor
         :raises arango.exceptions.DocumentGetError: If retrieval fails.
         """
+        m = "find_in_radius is deprecated in ArangoDB 4.0"
+        warn(m, DeprecationWarning, stacklevel=2)
+
         assert isinstance(latitude, Number), "latitude must be a number"
         assert isinstance(longitude, Number), "longitude must be a number"
         assert isinstance(radius, Number), "radius must be a number"
@@ -1141,6 +1157,11 @@ class Collection(ApiGroup):
     ) -> Result[Cursor]:
         """Return documents that match the given fulltext query.
 
+        .. warning::
+
+            Fulltext indexes are no longer supported and have been replaced
+            by ArangoSearch (inverted indexes).
+
         :param field: Document field with fulltext index.
         :type field: str
         :param query: Fulltext query.
@@ -1335,112 +1356,6 @@ class Collection(ApiGroup):
 
         return self._execute(request, response_handler)
 
-    def add_hash_index(
-        self,
-        fields: Sequence[str],
-        unique: Optional[bool] = None,
-        sparse: Optional[bool] = None,
-        deduplicate: Optional[bool] = None,
-        name: Optional[str] = None,
-        in_background: Optional[bool] = None,
-    ) -> Result[Json]:
-        """Create a new hash index.
-
-        .. warning::
-
-            The index types `hash` and `skiplist` are aliases for the persistent
-            index type and should no longer be used to create new indexes. The
-            aliases will be removed in a future version.
-
-        :param fields: Document fields to index.
-        :type fields: [str]
-        :param unique: Whether the index is unique.
-        :type unique: bool | None
-        :param sparse: If set to True, documents with None in the field
-            are also indexed. If set to False, they are skipped.
-        :type sparse: bool | None
-        :param deduplicate: If set to True, inserting duplicate index values
-            from the same document triggers unique constraint errors.
-        :type deduplicate: bool | None
-        :param name: Optional name for the index.
-        :type name: str | None
-        :param in_background: Do not hold the collection lock.
-        :type in_background: bool | None
-        :return: New index details.
-        :rtype: dict
-        :raise arango.exceptions.IndexCreateError: If create fails.
-        """
-        m = "add_hash_index is deprecated. Using add_index with {'type': 'hash'} instead."  # noqa: E501
-        warn(m, DeprecationWarning, stacklevel=2)
-
-        data: Json = {"type": "hash", "fields": fields}
-
-        if unique is not None:
-            data["unique"] = unique
-        if sparse is not None:
-            data["sparse"] = sparse
-        if deduplicate is not None:
-            data["deduplicate"] = deduplicate
-        if name is not None:
-            data["name"] = name
-        if in_background is not None:
-            data["inBackground"] = in_background
-
-        return self.add_index(data, formatter=True)
-
-    def add_skiplist_index(
-        self,
-        fields: Sequence[str],
-        unique: Optional[bool] = None,
-        sparse: Optional[bool] = None,
-        deduplicate: Optional[bool] = None,
-        name: Optional[str] = None,
-        in_background: Optional[bool] = None,
-    ) -> Result[Json]:
-        """Create a new skiplist index.
-
-        .. warning::
-
-            The index types `hash` and `skiplist` are aliases for the persistent
-            index type and should no longer be used to create new indexes. The
-            aliases will be removed in a future version.
-
-        :param fields: Document fields to index.
-        :type fields: [str]
-        :param unique: Whether the index is unique.
-        :type unique: bool | None
-        :param sparse: If set to True, documents with None in the field
-            are also indexed. If set to False, they are skipped.
-        :type sparse: bool | None
-        :param deduplicate: If set to True, inserting duplicate index values
-            from the same document triggers unique constraint errors.
-        :type deduplicate: bool | None
-        :param name: Optional name for the index.
-        :type name: str | None
-        :param in_background: Do not hold the collection lock.
-        :type in_background: bool | None
-        :return: New index details.
-        :rtype: dict
-        :raise arango.exceptions.IndexCreateError: If create fails.
-        """
-        m = "add_skiplist_index is deprecated. Using add_index with {'type': 'skiplist'} instead."  # noqa: E501
-        warn(m, DeprecationWarning, stacklevel=2)
-
-        data: Json = {"type": "skiplist", "fields": fields}
-
-        if unique is not None:
-            data["unique"] = unique
-        if sparse is not None:
-            data["sparse"] = sparse
-        if deduplicate is not None:
-            data["deduplicate"] = deduplicate
-        if name is not None:
-            data["name"] = name
-        if in_background is not None:
-            data["inBackground"] = in_background
-
-        return self.add_index(data, formatter=True)
-
     def add_geo_index(
         self,
         fields: Fields,
@@ -1487,45 +1402,6 @@ class Collection(ApiGroup):
 
         return self.add_index(data, formatter=True)
 
-    def add_fulltext_index(
-        self,
-        fields: Sequence[str],
-        min_length: Optional[int] = None,
-        name: Optional[str] = None,
-        in_background: Optional[bool] = None,
-    ) -> Result[Json]:
-        """Create a new fulltext index.
-
-        .. warning::
-            This method is deprecated since ArangoDB 3.10 and will be removed
-            in a future version of the driver.
-
-        :param fields: Document fields to index.
-        :type fields: [str]
-        :param min_length: Minimum number of characters to index.
-        :type min_length: int | None
-        :param name: Optional name for the index.
-        :type name: str | None
-        :param in_background: Do not hold the collection lock.
-        :type in_background: bool | None
-        :return: New index details.
-        :rtype: dict
-        :raise arango.exceptions.IndexCreateError: If create fails.
-        """
-        m = "add_fulltext_index is deprecated. Using add_index with {'type': 'fulltext'} instead."  # noqa: E501
-        warn(m, DeprecationWarning, stacklevel=2)
-
-        data: Json = {"type": "fulltext", "fields": fields}
-
-        if min_length is not None:
-            data["minLength"] = min_length
-        if name is not None:
-            data["name"] = name
-        if in_background is not None:
-            data["inBackground"] = in_background
-
-        return self.add_index(data, formatter=True)
-
     def add_persistent_index(
         self,
         fields: Sequence[str],
@@ -1790,7 +1666,8 @@ class Collection(ApiGroup):
             can be used to save resources.
         :type silent: bool
         :param overwrite: If set to True, operation does not fail on duplicate
-            keys and the existing documents are replaced.
+            keys and the existing documents are replaced. **Removed** in ArangoDB
+            v4.0.0. Use overwrite_mode instead.
         :type overwrite: bool
         :param return_old: Include body of the old documents if replaced.
             Applies only when value of **overwrite** is set to True.
@@ -2049,9 +1926,10 @@ class Collection(ApiGroup):
         # then the collection’s default waitForSync behavior is applied.
         sync_val = f", waitForSync: {sync}" if sync is not None else ""
 
+        filter_conditions, filter_bind_vars = build_filter_conditions(filters)
         query = f"""
             FOR doc IN @@collection
-                {build_filter_conditions(filters)}
+                {filter_conditions}
                 {f"LIMIT {limit}" if limit is not None else ""}
                 UPDATE doc WITH @body IN @@collection
                 OPTIONS {{ keepNull: @keep_none, mergeObjects: @merge {sync_val} }}
@@ -2062,6 +1940,7 @@ class Collection(ApiGroup):
             "body": body,
             "keep_none": keep_none,
             "merge": merge,
+            **filter_bind_vars,
         }
 
         request = Request(
@@ -2218,15 +2097,20 @@ class Collection(ApiGroup):
         # then the collection’s default waitForSync behavior is applied.
         sync_val = f"waitForSync: {sync}" if sync is not None else ""
 
+        filter_conditions, filter_bind_vars = build_filter_conditions(filters)
         query = f"""
             FOR doc IN @@collection
-                {build_filter_conditions(filters)}
+                {filter_conditions}
                 {f"LIMIT {limit}" if limit is not None else ""}
                 REPLACE doc WITH @body IN @@collection
                 {f"OPTIONS {{ {sync_val} }}" if sync_val else ""}
         """  # noqa: E201 E202
 
-        bind_vars = {"@collection": self.name, "body": body}
+        bind_vars = {
+            "@collection": self.name,
+            "body": body,
+            **filter_bind_vars,
+        }
 
         request = Request(
             method="post",
@@ -2377,15 +2261,16 @@ class Collection(ApiGroup):
         # then the collection’s default waitForSync behavior is applied.
         sync_val = f"waitForSync: {sync}" if sync is not None else ""
 
+        filter_conditions, filter_bind_vars = build_filter_conditions(filters)
         query = f"""
             FOR doc IN @@collection
-                {build_filter_conditions(filters)}
+                {filter_conditions}
                 {f"LIMIT {limit}" if limit is not None else ""}
                 REMOVE doc IN @@collection
                 {f"OPTIONS {{ {sync_val} }}" if sync_val else ""}
         """  # noqa: E201 E202
 
-        bind_vars = {"@collection": self.name}
+        bind_vars = {"@collection": self.name, **filter_bind_vars}
 
         request = Request(
             method="post",
@@ -2611,7 +2496,8 @@ class StandardCollection(Collection):
             can be used to save resources.
         :type silent: bool
         :param overwrite: If set to True, operation does not fail on duplicate
-            key and existing document is overwritten (replace-insert).
+            key and existing document is overwritten (replace-insert). **Removed**
+            in ArangoDB v4.0.0. Use overwrite_mode instead.
         :type overwrite: bool
         :param return_old: Include body of the old document if overwritten.
             Ignored if parameter **silent** is set to True.

arango/database.py

@@ -181,6 +181,8 @@ class Database(ApiGroup):
     def foxx(self) -> Foxx:
         """Return Foxx API wrapper.
 
+        .. warning:: Foxx microservice features are no longer available in ArangoDB 4.0.
+
         :return: Foxx API wrapper.
         :rtype: arango.foxx.Foxx
         """
@@ -244,6 +246,10 @@ class Database(ApiGroup):
     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.
+
         Executes the JavaScript code in the body on the server as
         the body of a function with no arguments. If you have a
         return statement then the return value you produce will be returned
@@ -569,10 +575,15 @@ class Database(ApiGroup):
     def required_db_version(self) -> Result[str]:
         """Return required version of target database.
 
+        .. warning:: Required version endpoint is no longer available in ArangoDB 4.0.
+
         :return: Required version of target database.
         :rtype: str
         :raise arango.exceptions.ServerRequiredDBVersionError: If retrieval fails.
         """
+        m = "target-version is removed in ArangoDB 4.0"
+        warn(m, DeprecationWarning, stacklevel=2)
+
         request = Request(method="get", endpoint="/_admin/database/target-version")
 
         def response_handler(resp: Response) -> str:
@@ -601,6 +612,11 @@ class Database(ApiGroup):
     def statistics(self, description: bool = False) -> Result[Json]:
         """Return server statistics.
 
+        .. warning::
+            Server Statistics are no longer available in ArangoDB 4.0.
+            Use :meth:`Database.metrics <arango.database.StandardDatabase.metrics>`
+            instead.
+
         :return: Server statistics.
         :rtype: dict
         :raise arango.exceptions.ServerStatisticsError: If retrieval fails.
@@ -707,6 +723,8 @@ class Database(ApiGroup):
         """Return details of the last request (e.g. headers, payload),
         or echo the given request body.
 
+        .. warning:: Request echoing is no longer available in ArangoDB 4.0.
+
         :param body: The body of the request. Can be of any type
             and is simply forwarded. If not set, the details of the last
             request are returned.
@@ -1095,6 +1113,8 @@ class Database(ApiGroup):
     def reload_routing(self) -> Result[bool]:
         """Reload the routing information.
 
+        .. warning:: Route reloading is no longer available in ArangoDB 4.0.
+
         :return: True if routing was reloaded successfully.
         :rtype: bool
         :raise arango.exceptions.ServerReloadRoutingError: If reload fails.
@@ -1108,6 +1128,20 @@ class Database(ApiGroup):
 
         return self._execute(request, response_handler)
 
+    def request(self, request: Request) -> Result[Response]:
+        """Execute a custom request.
+
+        :param request: Request object to be executed.
+        :type request: Request
+        :return: Response object containing the result of the request.
+        :rtype: Response
+        """
+
+        def response_handler(resp: Response) -> Response:
+            return resp
+
+        return self._executor.execute(request, response_handler)
+
     def metrics(self) -> Result[str]:
         """Return server metrics in Prometheus format.
 
@@ -1115,7 +1149,7 @@ class Database(ApiGroup):
         :rtype: str
         :raise arango.exceptions.ServerMetricsError: If operation fails.
         """
-        request = Request(method="get", endpoint="/_admin/metrics/v2")
+        request = Request(method="get", endpoint="/_admin/metrics")
 
         def response_handler(resp: Response) -> str:
             if resp.is_success:
@@ -1554,7 +1588,6 @@ class Database(ApiGroup):
                     "name": col["name"],
                     "system": col["isSystem"],
                     "type": StandardCollection.types[col["type"]],
-                    "status": StandardCollection.statuses[col["status"]],
                 }
                 for col in resp.body["result"]
             ]
@@ -2269,6 +2302,8 @@ class Database(ApiGroup):
     def tasks(self) -> Result[Jsons]:
         """Return all currently active server tasks.
 
+        .. warning:: Tasks are no longer available in ArangoDB 4.0.
+
         :return: Currently active server tasks.
         :rtype: [dict]
         :raise arango.exceptions.TaskListError: If retrieval fails.
@@ -2286,6 +2321,8 @@ class Database(ApiGroup):
     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.
+
         :param task_id: Server task ID.
         :type task_id: str
         :return: Server task details.
@@ -2312,6 +2349,8 @@ class Database(ApiGroup):
     ) -> Result[Json]:
         """Create a new server task.
 
+        .. warning:: Tasks are no longer available in ArangoDB 4.0.
+
         :param name: Name of the server task.
         :type name: str
         :param command: Javascript command to execute.
@@ -2355,6 +2394,8 @@ class Database(ApiGroup):
     def delete_task(self, task_id: str, ignore_missing: bool = False) -> Result[bool]:
         """Delete a server task.
 
+        .. warning:: Tasks are no longer available in ArangoDB 4.0.
+
         :param task_id: Server task ID.
         :type task_id: str
         :param ignore_missing: Do not raise an exception on missing task.

arango/foxx.py

@@ -37,7 +37,10 @@ from arango.typings import Json, Jsons, Params
 
 
 class Foxx(ApiGroup):
-    """Foxx API wrapper."""
+    """Foxx API wrapper.
+
+    .. warning:: Foxx microservice features are no longer available in ArangoDB 4.0.
+    """
 
     def __repr__(self) -> str:
         return f"<Foxx in {self._conn.db_name}>"

arango/replication.py

@@ -1,6 +1,7 @@
 __all__ = ["Replication"]
 
 from typing import Optional, Sequence
+from warnings import warn
 
 from arango.api import ApiGroup
 from arango.exceptions import (
@@ -17,7 +18,6 @@ from arango.exceptions import (
     ReplicationInventoryError,
     ReplicationLoggerFirstTickError,
     ReplicationLoggerStateError,
-    ReplicationMakeSlaveError,
     ReplicationServerIDError,
     ReplicationSyncError,
 )
@@ -208,7 +208,9 @@ class Replication(ApiGroup):
         restrict_collections: Optional[Sequence[str]] = None,
         initial_sync_wait_time: Optional[int] = None,
     ) -> Result[Json]:  # pragma: no cover
-        """Synchronize data from a remote endpoint.
+        """**Removed** in ArangoDB v3.12.10.
+
+        Synchronize data from a remote endpoint.
 
         :param endpoint: Master endpoint (e.g. "tcp://192.168.173.13:8529").
         :type endpoint: str
@@ -246,6 +248,9 @@ class Replication(ApiGroup):
         :rtype: dict
         :raise arango.exceptions.ReplicationSyncError: If sync fails.
         """
+        m = "/_api/replication/sync was removed in ArangoDB v3.12.10."
+        warn(m, DeprecationWarning, stacklevel=2)
+
         data: Json = {"endpoint": endpoint}
 
         if database is not None:
@@ -319,12 +324,20 @@ class Replication(ApiGroup):
         return self._execute(request, response_handler)
 
     def logger_first_tick(self) -> Result[str]:
-        """Return the first available tick value from the server.
+        """**Removed** in ArangoDB v3.12.10.
+
+        Return the first available tick value from the server.
 
         :return: First tick value.
         :rtype: str
         :raise arango.exceptions.ReplicationLoggerFirstTickError: If retrieval fails.
         """
+        m = (
+            "/_api/replication/logger-first-tick endpoint is removed in "
+            "ArangoDB v3.12.10."
+        )
+        warn(m, DeprecationWarning, stacklevel=2)
+
         request = Request(
             method="get",
             endpoint="/_api/replication/logger-first-tick",
@@ -338,12 +351,17 @@ class Replication(ApiGroup):
         return self._execute(request, response_handler)
 
     def applier_config(self) -> Result[Json]:
-        """Return the configuration of the replication applier.
+        """**Removed** in ArangoDB v3.12.10.
+
+        Return the configuration of the replication applier.
 
         :return: Configuration of the replication applier.
         :rtype: dict
         :raise arango.exceptions.ReplicationApplierConfigError: If retrieval fails.
         """
+        m = "/_api/replication/applier-config was removed in ArangoDB v3.12.10."
+        warn(m, DeprecationWarning, stacklevel=2)
+
         request = Request(
             method="get",
             endpoint="/_api/replication/applier-config",
@@ -380,7 +398,9 @@ class Replication(ApiGroup):
         restrict_type: Optional[str] = None,
         restrict_collections: Optional[Sequence[str]] = None,
     ) -> Result[Json]:
-        """Set configuration values of the replication applier.
+        """**Removed** in ArangoDB v3.12.10.
+
+        Set configuration values of the replication applier.
 
         :param endpoint: Server endpoint (e.g. "tcp://192.168.173.13:8529").
         :type endpoint: str
@@ -473,6 +493,9 @@ class Replication(ApiGroup):
         :rtype: dict
         :raise arango.exceptions.ReplicationApplierConfigSetError: If update fails.
         """
+        m = "/_api/replication/applier-config was removed in ArangoDB v3.12.10."
+        warn(m, DeprecationWarning, stacklevel=2)
+
         data: Json = {"endpoint": endpoint}
 
         if database is not None:
@@ -528,12 +551,17 @@ class Replication(ApiGroup):
         return self._execute(request, response_handler)
 
     def applier_state(self) -> Result[Json]:
-        """Return the state of the replication applier
+        """**Removed** in ArangoDB v3.12.10.
+
+        Return the state of the replication applier
 
         :return: Applier state and details.
         :rtype: dict
         :raise arango.exceptions.ReplicationApplierStateError: If retrieval fails.
         """
+        m = "/_api/replication/applier-state was removed in ArangoDB v3.12.10."
+        warn(m, DeprecationWarning, stacklevel=2)
+
         request = Request(
             method="get",
             endpoint="/_api/replication/applier-state",
@@ -547,7 +575,9 @@ class Replication(ApiGroup):
         return self._execute(request, response_handler)
 
     def start_applier(self, last_tick: Optional[str] = None) -> Result[Json]:
-        """Start the replication applier.
+        """**Removed** in ArangoDB v3.12.10.
+
+        Start the replication applier.
 
         :param last_tick: The remote last log tick value from which to start
             applying replication. If not specified, the last saved tick from
@@ -559,6 +589,9 @@ class Replication(ApiGroup):
         :rtype: dict
         :raise arango.exceptions.ReplicationApplierStartError: If operation fails.
         """
+        m = "/_api/replication/applier-start was removed in ArangoDB v3.12.10."
+        warn(m, DeprecationWarning, stacklevel=2)
+
         request = Request(
             method="put",
             endpoint="/_api/replication/applier-start",
@@ -573,12 +606,15 @@ class Replication(ApiGroup):
         return self._execute(request, response_handler)
 
     def stop_applier(self) -> Result[Json]:
-        """Stop the replication applier.
+        """**Removed** in ArangoDB v3.12.10.
 
         :return: Applier state and details.
         :rtype: dict
         :raise arango.exceptions.ReplicationApplierStopError: If operation fails.
         """
+        m = "/_api/replication/applier-stop was removed in ArangoDB v3.12.10."
+        warn(m, DeprecationWarning, stacklevel=2)
+
         request = Request(
             method="put",
             endpoint="/_api/replication/applier-stop",
@@ -591,178 +627,18 @@ class Replication(ApiGroup):
 
         return self._execute(request, response_handler)
 
-    def make_slave(
-        self,
-        endpoint: str,
-        database: Optional[str] = None,
-        username: Optional[str] = None,
-        password: Optional[str] = None,
-        restrict_type: Optional[str] = None,
-        restrict_collections: Optional[Sequence[str]] = None,
-        include_system: Optional[bool] = None,
-        max_connect_retries: Optional[int] = None,
-        connect_timeout: Optional[int] = None,
-        request_timeout: Optional[int] = None,
-        chunk_size: Optional[int] = None,
-        adaptive_polling: Optional[bool] = None,
-        auto_resync: Optional[bool] = None,
-        auto_resync_retries: Optional[int] = None,
-        initial_sync_max_wait_time: Optional[int] = None,
-        connection_retry_wait_time: Optional[int] = None,
-        idle_min_wait_time: Optional[int] = None,
-        idle_max_wait_time: Optional[int] = None,
-        require_from_present: Optional[bool] = None,
-        verbose: Optional[bool] = None,
-    ) -> Result[Json]:  # pragma: no cover
-        """Change the server role to slave.
-
-        :param endpoint: Master endpoint (e.g. "tcp://192.168.173.13:8529").
-        :type endpoint: str
-        :param database: Database name.
-        :type database: str | None
-        :param username: Username.
-        :type username: str | None
-        :param password: Password.
-        :type password: str | None
-        :param restrict_type: Optional string value for collection filtering.
-            Allowed values are "include" or "exclude".
-        :type restrict_type: str | None
-        :param restrict_collections: Optional list of collections for use with
-            argument **restrict_type**. If **restrict_type** set to "include",
-            only the specified collections are included. Otherwise, only the
-            specified collections are excluded.
-        :type restrict_collections: [str] | None
-        :param include_system: Whether system collection operations are
-            applied.
-        :type include_system: bool | None
-        :param max_connect_retries: Maximum number of connection attempts the
-            applier makes in a row before stopping itself.
-        :type max_connect_retries: int | None
-        :param connect_timeout: Timeout in seconds when attempting to connect
-            to the endpoint. This value is used for each connection attempt.
-        :type connect_timeout: int | None
-        :param request_timeout: Timeout in seconds for individual requests to
-            the endpoint.
-        :type request_timeout: int | None
-        :param chunk_size: Requested maximum size in bytes for log transfer
-            packets when the endpoint is contacted.
-        :type chunk_size: int | None
-        :param adaptive_polling: If set to True, replication applier sleeps
-            for an increasingly long period in case the logger server at the
-            endpoint has no replication events to apply. Using adaptive polling
-            reduces the amount of work done by both the applier and the logger
-            server when there are infrequent changes. The downside is that it
-            might take longer for the replication applier to detect new events.
-        :type adaptive_polling: bool | None
-        :param auto_resync: Whether the slave should perform a full automatic
-            resynchronization with the master in case the master cannot serve
-            log data requested by the slave, or when the replication is started
-            and no tick value can be found.
-        :type auto_resync: bool | None
-        :param auto_resync_retries: Max number of resynchronization retries.
-            Setting this to 0 disables it.
-        :type auto_resync_retries: int | None
-        :param initial_sync_max_wait_time: Max wait time in seconds the initial
-            synchronization waits for master on collection data. This value
-            is relevant even for continuous replication when **auto_resync** is
-            set to True because this may restart the initial synchronization
-            when master cannot provide log data slave requires. This value is
-            ignored if set to 0.
-        :type initial_sync_max_wait_time: int | None
-        :param connection_retry_wait_time: Time in seconds the applier idles
-            before trying to connect to master in case of connection problems.
-            This value is ignored if set to 0.
-        :type connection_retry_wait_time: int | None
-        :param idle_min_wait_time: Minimum wait time in seconds the applier
-            idles before fetching more log data from the master in case the
-            master has already sent all its log data. This wait time can be
-            used to control the frequency with which the replication applier
-            sends HTTP log fetch requests to the master in case there is no
-            write activity on the master. This value is ignored if set to 0.
-        :type idle_min_wait_time: int | None
-        :param idle_max_wait_time: Maximum wait time in seconds the applier
-            idles before fetching more log data from the master in case the
-            master has already sent all its log data. This wait time can be
-            used to control the maximum frequency with which the replication
-            applier sends HTTP log fetch requests to the master in case there
-            is no write activity on the master. Applies only when argument
-            **adaptive_polling** is set to True. This value is ignored if set
-            to 0.
-        :type idle_max_wait_time: int | None
-        :param require_from_present: If set to True, replication applier checks
-            at start whether the start tick from which it starts or resumes
-            replication is still present on the master. If not, then there
-            would be data loss. If set to True, the replication applier aborts
-            with an appropriate error message. If set to False, the applier
-            still starts and ignores the data loss.
-        :type require_from_present: bool | None
-        :param verbose: If set to True, a log line is emitted for all
-            operations performed by the replication applier. This should be
-            used for debugging replication problems only.
-        :type verbose: bool | None
-        :return: Replication details.
-        :rtype: dict
-        :raise arango.exceptions.ReplicationApplierStopError: If operation fails.
-        """
-        data: Json = {"endpoint": endpoint}
-
-        if database is not None:
-            data["database"] = database
-        if username is not None:
-            data["username"] = username
-        if password is not None:
-            data["password"] = password
-        if restrict_type is not None:
-            data["restrictType"] = restrict_type
-        if restrict_collections is not None:
-            data["restrictCollections"] = restrict_collections
-        if include_system is not None:
-            data["includeSystem"] = include_system
-        if max_connect_retries is not None:
-            data["maxConnectRetries"] = max_connect_retries
-        if connect_timeout is not None:
-            data["connectTimeout"] = connect_timeout
-        if request_timeout is not None:
-            data["requestTimeout"] = request_timeout
-        if chunk_size is not None:
-            data["chunkSize"] = chunk_size
-        if adaptive_polling is not None:
-            data["adaptivePolling"] = adaptive_polling
-        if auto_resync is not None:
-            data["autoResync"] = auto_resync
-        if auto_resync_retries is not None:
-            data["autoResyncRetries"] = auto_resync_retries
-        if initial_sync_max_wait_time is not None:
-            data["initialSyncMaxWaitTime"] = initial_sync_max_wait_time
-        if connection_retry_wait_time is not None:
-            data["connectionRetryWaitTime"] = connection_retry_wait_time
-        if idle_min_wait_time is not None:
-            data["idleMinWaitTime"] = idle_min_wait_time
-        if idle_max_wait_time is not None:
-            data["idleMaxWaitTime"] = idle_max_wait_time
-        if require_from_present is not None:
-            data["requireFromPresent"] = require_from_present
-        if verbose is not None:
-            data["verbose"] = verbose
-
-        request = Request(
-            method="put", endpoint="/_api/replication/make-slave", data=data
-        )
-
-        def response_handler(resp: Response) -> Json:
-            if resp.is_success:
-                return format_replication_applier_state(resp.body)
-            raise ReplicationMakeSlaveError(resp, request)
-
-        return self._execute(request, response_handler)
-
     def server_id(self) -> Result[str]:
-        """Return this server's ID.
+        """**Removed** in ArangoDB v3.12.10.
+
+        Return this server's ID.
 
         :return: Server ID.
         :rtype: str
         :raise arango.exceptions.ReplicationServerIDError: If retrieval fails.
         """
+        m = "/_api/replication/server-id was removed in ArangoDB v3.12.10."
+        warn(m, DeprecationWarning, stacklevel=2)
+
         request = Request(
             method="get",
             endpoint="/_api/replication/server-id",

arango/utils.py

@@ -6,10 +6,9 @@ __all__ = [
     "is_none_or_str",
 ]
 
-import json
 import logging
 from contextlib import contextmanager
-from typing import Any, Iterator, Optional, Sequence, Union
+from typing import Any, Iterator, Optional, Sequence, Tuple, Union
 
 from arango.exceptions import DocumentParseError, SortValidationError
 from arango.typings import Json, Jsons
@@ -109,23 +108,48 @@ def get_batches(elements: Sequence[Json], batch_size: int) -> Iterator[Sequence[
         yield elements[index : index + batch_size]
 
 
-def build_filter_conditions(filters: Json) -> str:
+def _build_attribute_expression(field: str, prefix: str, bind_vars: Json) -> str:
+    """Build a bind-safe AQL document attribute expression."""
+    bind_vars[prefix] = field
+    field_access = f"doc[@{prefix}]"
+
+    if "." not in field:
+        return field_access
+
+    nested_access = "doc"
+    for field_index, field_part in enumerate(field.split(".")):
+        field_var = f"{prefix}_{field_index}"
+        bind_vars[field_var] = field_part
+        nested_access += f"[@{field_var}]"
+
+    return f"(HAS(doc, @{prefix}) ? {field_access} : {nested_access})"
+
+
+def build_filter_conditions(filters: Json) -> Tuple[str, Json]:
     """Build a filter condition for an AQL query.
 
     :param filters: Document filters.
     :type filters: Dict[str, Any]
-    :return: The complete AQL filter condition.
-    :rtype: str
+    :return: The complete AQL filter condition and its bind variables.
+    :rtype: tuple[str, dict]
     """
     if not filters:
-        return ""
+        return "", {}
 
     conditions = []
-    for k, v in filters.items():
-        field = k if "." in k else f"`{k}`"
-        conditions.append(f"doc.{field} == {json.dumps(v)}")
+    bind_vars: Json = {}
+    for filter_index, (field, value) in enumerate(filters.items()):
+        field_access = _build_attribute_expression(
+            field,
+            f"filter_field_{filter_index}",
+            bind_vars,
+        )
 
-    return "FILTER " + " AND ".join(conditions)
+        value_var = f"filter_value_{filter_index}"
+        bind_vars[value_var] = value
+        conditions.append(f"{field_access} == @{value_var}")
+
+    return "FILTER " + " AND ".join(conditions), bind_vars
 
 
 def validate_sort_parameters(sort: Jsons) -> bool:
@@ -148,20 +172,26 @@ def validate_sort_parameters(sort: Jsons) -> bool:
     return True
 
 
-def build_sort_expression(sort: Optional[Jsons]) -> str:
+def build_sort_expression(sort: Optional[Jsons]) -> Tuple[str, Json]:
     """Build a sort condition for an AQL query.
 
     :param sort: Document sort parameters.
     :type sort: Jsons | None
-    :return: The complete AQL sort condition.
-    :rtype: str
+    :return: The complete AQL sort condition and its bind variables.
+    :rtype: tuple[str, dict]
     """
     if not sort:
-        return ""
+        return "", {}
 
     sort_chunks = []
-    for sort_param in sort:
-        chunk = f"doc.{sort_param['sort_by']} {sort_param['sort_order']}"
+    bind_vars: Json = {}
+    for sort_index, sort_param in enumerate(sort):
+        field_access = _build_attribute_expression(
+            sort_param["sort_by"],
+            f"sort_field_{sort_index}",
+            bind_vars,
+        )
+        chunk = f"{field_access} {sort_param['sort_order'].upper()}"
         sort_chunks.append(chunk)
 
-    return "SORT " + ", ".join(sort_chunks)
+    return "SORT " + ", ".join(sort_chunks), bind_vars

arango/version.py

@@ -1 +1 @@
-__version__ = "8.3.2"
+__version__ = "8.3.4"

arango/wal.py

@@ -1,6 +1,7 @@
 __all__ = ["WAL"]
 
 from typing import Optional
+from warnings import warn
 
 from arango.api import ApiGroup
 from arango.exceptions import (
@@ -28,12 +29,15 @@ class WAL(ApiGroup):  # pragma: no cover
     """WAL (Write-Ahead Log) API wrapper."""
 
     def properties(self) -> Result[Json]:
-        """Return WAL properties.
+        """Return WAL properties. **Removed** in ArangoDB v4.0.0.
 
         :return: WAL properties.
         :rtype: dict
         :raise arango.exceptions.WALPropertiesError: If retrieval fails.
         """
+        m = "/_admin/wal/properties was removed in ArangoDB v4.0.0."
+        warn(m, DeprecationWarning, stacklevel=2)
+
         request = Request(method="get", endpoint="/_admin/wal/properties")
 
         def response_handler(resp: Response) -> Json:
@@ -52,7 +56,7 @@ class WAL(ApiGroup):  # pragma: no cover
         throttle_wait: Optional[int] = None,
         throttle_limit: Optional[int] = None,
     ) -> Result[Json]:
-        """Configure WAL properties.
+        """Configure WAL properties. **Removed in ArangoDB v4.0.0.**
 
         :param oversized_ops: If set to True, operations bigger than a single
             log file are allowed to be executed and stored.
@@ -74,6 +78,9 @@ class WAL(ApiGroup):  # pragma: no cover
         :rtype: dict
         :raise arango.exceptions.WALConfigureError: If operation fails.
         """
+        m = "/_admin/wal/properties was removed in ArangoDB v4.0.0."
+        warn(m, DeprecationWarning, stacklevel=2)
+
         data: Json = {}
         if oversized_ops is not None:
             data["allowOversizeEntries"] = oversized_ops
@@ -98,7 +105,9 @@ class WAL(ApiGroup):  # pragma: no cover
         return self._execute(request, response_handler)
 
     def transactions(self) -> Result[Json]:
-        """Return details on currently running WAL transactions.
+        """**Removed** in ArangoDB v4.0.0.
+
+        Return details on currently running WAL transactions.
 
         Fields in the returned details are as follows:
 
@@ -118,6 +127,9 @@ class WAL(ApiGroup):  # pragma: no cover
         :rtype: dict
         :raise arango.exceptions.WALTransactionListError: If retrieval fails.
         """
+        m = "/_admin/wal/transactions was removed in ArangoDB v4.0.0."
+        warn(m, DeprecationWarning, stacklevel=2)
+
         request = Request(method="get", endpoint="/_admin/wal/transactions")
 
         def response_handler(resp: Response) -> Json:

{python_arango-8.3.2.dist-info → python_arango-8.3.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-arango
-Version: 8.3.2
+Version: 8.3.4
 Summary: Python Driver for ArangoDB
 Author-email: Joohwan Oh <joohwan.oh@outlook.com>
 Maintainer-email: Joohwan Oh <joohwan.oh@outlook.com>, Alexandru Petenchea <alex.petenchea@gmail.com>, Anthony Mahanna <anthony.mahanna@arangodb.com>
@@ -183,7 +183,7 @@ edges.insert({"_from": "students/03", "_to": "lectures/CSC101"})
 # 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}
     """
 cursor = db.aql.execute(query)

{python_arango-8.3.2.dist-info → python_arango-8.3.4.dist-info}/RECORD

@@ -1,34 +1,34 @@
 arango/__init__.py,sha256=SFKHBP0iYw1c4mJbLn6pxiGIKVUpsS_nQcZ0aEptrZw,192
 arango/api.py,sha256=OzN3d4p1fagRG_BXnjgrp0TeE__hQmm9WDEkjefa6UA,1956
-arango/aql.py,sha256=WH1kuXkVHCNjPGrBbQaGFb21fjRbzC867vNSuPDVG-k,31174
+arango/aql.py,sha256=HaoEx1CWvEtKTkbocEtS-73MyAAhuTxJnenqDg41voM,31420
 arango/backup.py,sha256=lK7ihCRPrsBlQ35KtyYplhX6Lw0GzqCbGTLPbPTBh20,8651
 arango/client.py,sha256=t-mJZ9I7ZJebILW6zm4qAhgExEEzvwTVNdkHp7DP2iU,11787
-arango/cluster.py,sha256=PBixBJnAWsC2oApZnXUGbA-EjxbIqGKrUUtZJrqqQT4,18454
-arango/collection.py,sha256=nv9ps1RdH0Ha8H-GIFwfg8bCWF_J-61qWPVk1Xm7zYA,140350
+arango/cluster.py,sha256=4EAMftT_Zm2kBVtvWF9RSy-EYdsGgKujE6mI52HtV8Q,18655
+arango/collection.py,sha256=FdjDzfqAY333MA6frrfMU0-ZuTmnDwEZlF1c0HEbuwA,135955
 arango/connection.py,sha256=euqleZQOBkZ06zkY1uztGWeDeZLEYnekvHs2WK_K1Gk,18919
 arango/cursor.py,sha256=4iIhYXWwzHnxKKk0oNk-ynNeQ1BWJDS4gy1ApzYtNl8,11156
-arango/database.py,sha256=bTsaCtk3mTC6StO_Qy91TFvFJQaSVngY4A2bIHS72rI,133143
+arango/database.py,sha256=wAGxx3fhDL1vzWMQZVZQ39ID3iggJ6jxHmmL-JCZYTs,134528
 arango/errno.py,sha256=4oKY9IyyzjOitbywhjH8S214qeNtpDlQg7JsHENJNoU,25245
 arango/exceptions.py,sha256=N2sUD6_aJQqsrXXluDrQkXo143d8M07ziqZQK5VN_rk,26225
 arango/executor.py,sha256=ahez3ar-FLZLWv4pu1IYhAi_EdhbwsME82N_hkB1PSw,16000
 arango/formatter.py,sha256=v_q93uvmUsYVsvxoHb2fAskqGxi3zRT88IUQCZgc9z4,42861
-arango/foxx.py,sha256=JJrsfgWzGMqEobi3f_VGLYXEQrk2vsGJwfQeWTM6SGA,32737
+arango/foxx.py,sha256=Ni5AnmuTq2ghD_yXHZkDkH45gj5J6lqEWYScp-9aGC0,32828
 arango/graph.py,sha256=UPxiN0JgyzZGYc1aZZ1tiiOsz9fStInEGS6SySDaFW0,36282
 arango/http.py,sha256=36Us7VBcOcHH2kdWg8ZpPkD-4Po8U5ScQvR1MATGVr0,10215
 arango/job.py,sha256=yLjlMVuSK5ibcyf3zAHozMzMXPSYk769A-VUfyNrY9c,7054
 arango/pregel.py,sha256=AqL8o8YaPYN_LkJiGhQTfXN_AzjGGoAr4nl-e5jus4A,5749
 arango/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-arango/replication.py,sha256=r8kZJuJ186spTdU2x20P4ctoDELzMcexN5KuPTflNrg,33924
+arango/replication.py,sha256=atvbGMMdEfIjwBKkzWJ453YjXdQMKorNwKEeM-Og_zg,26681
 arango/request.py,sha256=dmx_fFg5kHq82fA-dhFStJERYtipuZSTW1lwXrbQqOo,4167
 arango/resolver.py,sha256=hhTJHzNKrg3KpzmKIa-eZSogUBwQuWAID5yfHJ9RYH8,4215
 arango/response.py,sha256=n55yXyrsUldOQV8FYUgX9PiVvTW-R9nVOyDUTcnsN1o,2164
 arango/result.py,sha256=nILp1HZCl06awosbDi1AL_LCDDXV0DEi1KBkywG6uoI,168
 arango/typings.py,sha256=G8BKOORxaVKSS3kaxHjVaXD0TIJkd1Cs8j2nuKwSKlQ,779
-arango/utils.py,sha256=PGUH06T4NXnr5-wGa13s4hAOpj_JcPwlFfbGiywueIY,4694
-arango/version.py,sha256=vTLGTBVTHGQLpfevg3lOhj8f5ns-dUKSgLvAWYnkLwU,22
-arango/wal.py,sha256=aqt0ET7mP2FH9x4KHw15B4ZiEa0jYTyUdUs2rD2Zwmo,11207
-python_arango-8.3.2.dist-info/licenses/LICENSE,sha256=e86a4kkFfMBuoffCn4RLmQGC2LUqNs78i5npEsJ1b5I,1072
-python_arango-8.3.2.dist-info/METADATA,sha256=X-ZJEgY6q5zDQejkdnfhUb3gOQxEYibspnzt0Frz6c0,8353
-python_arango-8.3.2.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-python_arango-8.3.2.dist-info/top_level.txt,sha256=F8H1mznbOGduHSsSET9uiPd72kJ1fGbejiuzYMm9XqA,7
-python_arango-8.3.2.dist-info/RECORD,,
+arango/utils.py,sha256=E2AsqCLknKpv-5EEpoT7oGsZGNBnPG3g1uuS51wdvDU,5835
+arango/version.py,sha256=L6FFKJ9jr3FOrnDCDKrFA8EDeYijiBWwZ9MHgZ122DM,22
+arango/wal.py,sha256=ubZvztThBrmPDBYkpUtnz8XDLICRTfaMeXSfqQwMauw,11700
+python_arango-8.3.4.dist-info/licenses/LICENSE,sha256=e86a4kkFfMBuoffCn4RLmQGC2LUqNs78i5npEsJ1b5I,1072
+python_arango-8.3.4.dist-info/METADATA,sha256=WqV_akKoCfPMA7oCcrGkgomOuWRfk49giB7DwKKdy14,8356
+python_arango-8.3.4.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+python_arango-8.3.4.dist-info/top_level.txt,sha256=F8H1mznbOGduHSsSET9uiPd72kJ1fGbejiuzYMm9XqA,7
+python_arango-8.3.4.dist-info/RECORD,,

{python_arango-8.3.2.dist-info → python_arango-8.3.4.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (82.0.1)
+Generator: setuptools (84.0.0)
 Root-Is-Purelib: true
 Tag: py3-none-any