python-arango 8.3.1__tar.gz → 8.3.3__tar.gz

{python_arango-8.3.1 → python_arango-8.3.3}/.circleci/config.yml

@@ -4,7 +4,7 @@ executors:
   python-container:
     docker:
       - image: cimg/python:3.12
-    resource_class: small
+    resource_class: arangodb/small-amd64
   python-vm:
     machine:
       image: ubuntu-2404:current
@@ -15,18 +15,34 @@ workflows:
     jobs:
       - lint
       - test:
-          name:  Python (<< matrix.python_version >>) - ArangoDB (<< matrix.arangodb_license >>, << matrix.arangodb_version >> << matrix.arangodb_config >>)
+          name: Python (<< matrix.python_version >>) - ArangoDB (enterprise, << matrix.arangodb_version >> << matrix.arangodb_config >>)
           matrix:
             parameters:
-              python_version: ["3.10", "3.11", "3.12"]
+              python_version: ["3.13"]
               arangodb_config: ["single", "cluster"]
               arangodb_license: ["enterprise"]
               arangodb_version: ["3.12"]
+      - test:
+          name: Python (<< matrix.python_version >>) - ArangoDB (enterprise-preview, << matrix.arangodb_version >> << matrix.arangodb_config >>)
+          matrix:
+            parameters:
+              python_version: ["3.13"]
+              arangodb_config: ["single", "cluster"]
+              arangodb_license: ["enterprise-preview"]
+              arangodb_version: ["4.0-nightly"]
+      - test:
+          name: Python (<< matrix.python_version >>) - ArangoDB (enterprise, 3.12 cluster)
+          matrix:
+            parameters:
+              python_version: ["3.10", "3.11", "3.12"]
+              arangodb_config: ["cluster"]
+              arangodb_license: ["enterprise"]
+              arangodb_version: ["3.12"]
 
 jobs:
   lint:
     executor: python-container
-    resource_class: small
+    resource_class: arangodb/small-amd64
     steps:
       - checkout
       - run:
@@ -86,7 +102,7 @@ jobs:
               args+=("--cluster" "--port=8539" "--port=8549")
             fi
 
-            if [ << parameters.arangodb_license >> != "enterprise" ]; then
+            if [ << parameters.arangodb_license >> != "enterprise" ] && [ << parameters.arangodb_license >> != "enterprise-preview" ]; then
               args+=("--skip" "enterprise")
             fi
 

{python_arango-8.3.1 → python_arango-8.3.3}/.github/workflows/pypi.yaml

@@ -43,10 +43,10 @@ jobs:
         env:
           TWINE_USERNAME: __token__
           TWINE_PASSWORD: ${{ secrets.PYPI_TEST_TOKEN }}
-        run: twine upload --repository testpypi dist/*
+        run: twine upload --verbose --repository testpypi dist/*
 
       - name: Publish to PyPI
         env:
           TWINE_USERNAME: __token__
           TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
-        run: twine upload --repository pypi dist/*
+        run: twine upload --verbose --repository pypi dist/*

{python_arango-8.3.1 → python_arango-8.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-arango
-Version: 8.3.1
+Version: 8.3.3
 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.1 → python_arango-8.3.3}/README.md

@@ -118,7 +118,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.1 → python_arango-8.3.3}/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

{python_arango-8.3.1 → python_arango-8.3.3}/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.

{python_arango-8.3.1 → python_arango-8.3.3}/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
@@ -849,6 +849,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 +868,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 +976,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 +995,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 +1151,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 +1350,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 +1396,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 +1660,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.
@@ -2611,7 +2482,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.

{python_arango-8.3.1 → python_arango-8.3.3}/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.
@@ -1115,7 +1135,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 +1574,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 +2288,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 +2307,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 +2335,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 +2380,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.

{python_arango-8.3.1 → python_arango-8.3.3}/arango/formatter.py

@@ -119,6 +119,10 @@ def format_index(body: Json, formatter: bool = True) -> Json:
     # Introduced via Vector Index in 3.12.6
     if "params" in body:
         result["params"] = body["params"]
+    if "errorMessage" in body:
+        result["error_message"] = body["errorMessage"]
+    if "trainingState" in body:
+        result["training_state"] = body["trainingState"]
 
     return verify_format(body, result)
 
@@ -275,6 +279,9 @@ def format_collection(body: Json) -> Json:
     if "internalValidatorType" in body:
         result["internal_validator_type"] = body["internalValidatorType"]
 
+    if "supportsRBAC" in body:
+        result["supportsRBAC"] = body["supportsRBAC"]
+
     return verify_format(body, result)
 
 

{python_arango-8.3.1 → python_arango-8.3.3}/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}>"

{python_arango-8.3.1 → python_arango-8.3.3}/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 (
@@ -325,6 +326,9 @@ class Replication(ApiGroup):
         :rtype: str
         :raise arango.exceptions.ReplicationLoggerFirstTickError: If retrieval fails.
         """
+        m = "/_api/replication/logger-first-tick endpoint is removed in ArangoDB v4.0"
+        warn(m, DeprecationWarning, stacklevel=2)
+
         request = Request(
             method="get",
             endpoint="/_api/replication/logger-first-tick",

python_arango-8.3.3/arango/version.py

@@ -0,0 +1 @@
+__version__ = "8.3.3"

{python_arango-8.3.1 → python_arango-8.3.3}/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.1 → python_arango-8.3.3}/docs/aql.rst

@@ -83,6 +83,10 @@ See :ref:`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.
 

{python_arango-8.3.1 → python_arango-8.3.3}/docs/cluster.rst

@@ -85,7 +85,6 @@ Below is an example on how to manage clusters using python-arango.
     server_id = cluster.server_id()
     cluster.server_engine(server_id)
     cluster.server_version(server_id)
-    cluster.server_statistics(server_id)
     cluster.server_maintenance_mode(server_id)
 
     # Toggle Server maintenance mode (allowed values are "normal" and "maintenance").

{python_arango-8.3.1 → python_arango-8.3.3}/docs/collection.rst

@@ -43,8 +43,6 @@ Here is an example showing how you can manage standard collections:
     students.count()
 
     # Perform various operations.
-    students.load()
-    students.unload()
     students.truncate()
     students.configure()
 

{python_arango-8.3.1 → python_arango-8.3.3}/docs/foxx.rst

@@ -1,6 +1,10 @@
 Foxx
 ----
 
+.. warning::
+    Foxx microservice features are no longer available in ArangoDB 4.0.
+
+
 Python-arango provides support for **Foxx**, a microservice framework which
 lets you define custom HTTP endpoints to extend ArangoDB's REST API. For more
 information, refer to `ArangoDB manual`_.

{python_arango-8.3.1 → python_arango-8.3.3}/docs/graph.rst

@@ -377,7 +377,7 @@ over edges and vertices using various algorithms.
     # AQL to perform a graph traversal
     query = """
     FOR v, e, p IN 1..3 OUTBOUND 'teachers/jon' GRAPH 'school'
-    OPTIONS { bfs: true, uniqueVertices: 'global' }
+    OPTIONS { order: 'bfs', uniqueVertices: 'global' }
     RETURN {vertex: v, edge: e, path: p}
     """
 

{python_arango-8.3.1 → python_arango-8.3.3}/docs/simple.rst

@@ -47,11 +47,8 @@ Here are all simple query (and other utility) methods available:
 
 * :func:`arango.collection.Collection.all`
 * :func:`arango.collection.Collection.find`
-* :func:`arango.collection.Collection.find_near`
 * :func:`arango.collection.Collection.find_in_range`
-* :func:`arango.collection.Collection.find_in_radius`
 * :func:`arango.collection.Collection.find_in_box`
-* :func:`arango.collection.Collection.find_by_text`
 * :func:`arango.collection.Collection.get_many`
 * :func:`arango.collection.Collection.ids`
 * :func:`arango.collection.Collection.keys`

{python_arango-8.3.1 → python_arango-8.3.3}/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.

{python_arango-8.3.1 → python_arango-8.3.3}/python_arango.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-arango
-Version: 8.3.1
+Version: 8.3.3
 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.3/starter.sh

@@ -0,0 +1,84 @@
+#!/bin/bash
+
+# Starts a local ArangoDB server or cluster (community or enterprise).
+# Useful for testing the python-arango driver against a local ArangoDB setup.
+
+# Usage:
+#   ./starter.sh [single|cluster] [community|enterprise|enterprise-preview] [version]
+#   ./starter.sh [single|cluster] [image[:tag]]
+# Example:
+#   ./starter.sh cluster enterprise 3.12.4
+#   ./starter.sh single enterprise-preview 4.0-nightly
+#   ./starter.sh single arangodb/enterprise-preview:4.0-nightly
+
+setup="${1:-single}"
+image="${2:-community}"
+version="${3:-latest}"
+
+extra_ports=""
+if [ "$setup" == "single" ]; then
+    echo ""
+elif [ "$setup" == "cluster" ]; then
+    extra_ports="-p 8539:8539 -p 8549:8549"
+else
+    echo "Invalid argument. Please provide either 'single' or 'cluster'."
+    exit 1
+fi
+
+image_ref=""
+if [[ "$image" == */* ]]; then
+    if [[ "$image" == *:* ]]; then
+        image_ref="$image"
+        if [ "$version" == "latest" ]; then
+            version="${image##*:}"
+        fi
+    else
+        image_ref="$image:$version"
+    fi
+elif [ "$image" == "community" ]; then
+    image_ref="arangodb/arangodb:$version"
+elif [ "$image" == "enterprise" ]; then
+    image_ref="arangodb/enterprise:$version"
+elif [ "$image" == "enterprise-preview" ]; then
+    image_ref="arangodb/enterprise-preview:$version"
+else
+    echo "Invalid argument. Please provide 'community', 'enterprise', 'enterprise-preview', or a full image reference."
+    exit 1
+fi
+
+if [ "$version" == "latest" ]; then
+    conf_file="${setup}-3.12"
+elif [[ "$version" =~ ^([0-9]+\.[0-9]+) ]]; then
+    conf_file="${setup}-${BASH_REMATCH[1]}"
+else
+    conf_file="${setup}-${version}"
+fi
+
+if [ ! -f "tests/static/$conf_file.conf" ]; then
+    echo "Missing configuration file: tests/static/$conf_file.conf"
+    exit 1
+fi
+
+docker run -d \
+  --name arango \
+  -p 8528:8528 \
+  -p 8529:8529 \
+  $extra_ports \
+  -v "$(pwd)/tests/static/":/tests/static \
+  -v /tmp:/tmp \
+  "$image_ref" \
+  /bin/sh -c "arangodb --configuration=/tests/static/$conf_file.conf"
+
+if [ $? -ne 0 ]; then
+    echo "ERROR starter failed to start container"
+    exit 1
+fi
+
+wget --quiet --waitretry=1 --tries=120 -O - http://localhost:8528/version | jq
+if [ $? -eq 0 ]; then
+    echo "OK starter ready"
+    exit 0
+else
+    echo "ERROR starter not ready, giving up"
+    exit 1
+fi

python_arango-8.3.1/arango/version.py

@@ -1 +0,0 @@
-__version__ = "8.3.1"

python_arango-8.3.1/starter.sh

@@ -1,60 +0,0 @@
-#!/bin/bash
-
-# Starts a local ArangoDB server or cluster (community or enterprise).
-# Useful for testing the python-arango driver against a local ArangoDB setup.
-
-# Usage:
-#   ./starter.sh [single|cluster] [community|enterprise] [version]
-# Example:
-#   ./starter.sh cluster enterprise 3.12.5
-
-setup="${1:-cluster}"
-license="${2:-enterprise}"
-version="${3:-latest}"
-
-extra_ports=""
-if [ "$setup" == "single" ]; then
-    echo ""
-elif [ "$setup" == "cluster" ]; then
-    extra_ports="-p 8539:8539 -p 8549:8549"
-else
-    echo "Invalid argument. Please provide either 'single' or 'cluster'."
-    exit 1
-fi
-
-image_name=""
-if [ "$license" == "community" ]; then
-    image_name="arangodb"
-elif [ "$license" == "enterprise" ]; then
-    image_name="enterprise"
-else
-    echo "Invalid argument. Please provide either 'community' or 'enterprise'."
-    exit 1
-fi
-
-if [ "$version" == "latest" ]; then
-    conf_file="${setup}-3.12"
-elif [[ "$version" == *.*.* ]]; then
-    conf_file="${setup}-${version%.*}"
-else
-    conf_file="${setup}-${version}"
-fi
-
-docker run -d \
-  --name arango \
-  -p 8528:8528 \
-  -p 8529:8529 \
-  $extra_ports \
-  -v "$(pwd)/tests/static/":/tests/static \
-  -v /tmp:/tmp \
-  "arangodb/$image_name:$version" \
-  /bin/sh -c "arangodb --configuration=/tests/static/$conf_file.conf"
-
-wget --quiet --waitretry=1 --tries=120 -O - http://localhost:8528/version | jq
-if [ $? -eq 0 ]; then
-    echo "OK starter ready"
-    exit 0
-else
-    echo "ERROR starter not ready, giving up"
-    exit 1
-fi