python-arango 8.0.0__tar.gz → 8.1.1__tar.gz

{python_arango-8.0.0 → python_arango-8.1.1}/.github/workflows/docs.yaml

@@ -98,5 +98,6 @@ jobs:
       - name: Run Sphinx doctest
         run: python -m sphinx -b doctest docs docs/_build
 
-      - name: Generate Sphinx HTML
-        run: python -m sphinx -b html -W docs docs/_build
+      # No longer needed as this is handled by Read the Docs
+      #- name: Generate Sphinx HTML
+      #  run: python -m sphinx -b html -W docs docs/_build

{python_arango-8.0.0 → python_arango-8.1.1}/.readthedocs.yaml

@@ -15,6 +15,7 @@ sphinx:
   configuration: docs/conf.py
   # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
   # builder: "dirhtml"
+  builder: html
   # Fail on all warnings to avoid broken references
   fail_on_warning: true
 

{python_arango-8.0.0 → python_arango-8.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-arango
-Version: 8.0.0
+Version: 8.1.1
 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>
@@ -61,7 +61,6 @@ Requires-Dist: pytest>=7.1.1; extra == "dev"
 Requires-Dist: pytest-cov>=3.0.0; extra == "dev"
 Requires-Dist: sphinx; extra == "dev"
 Requires-Dist: sphinx_rtd_theme; extra == "dev"
-Requires-Dist: types-pkg_resources; extra == "dev"
 Requires-Dist: types-requests; extra == "dev"
 Requires-Dist: types-setuptools; extra == "dev"
 

{python_arango-8.0.0 → python_arango-8.1.1}/arango/cluster.py

@@ -15,6 +15,7 @@ from arango.exceptions import (
     ClusterServerRoleError,
     ClusterServerStatisticsError,
     ClusterServerVersionError,
+    ClusterVpackSortMigrationError,
 )
 from arango.formatter import format_body
 from arango.request import Request
@@ -444,3 +445,57 @@ class Cluster(ApiGroup):  # pragma: no cover
             return result
 
         return self._execute(request, response_handler)
+
+    def vpack_sort_migration_status(self) -> Result[Json]:
+        """Query the status of the vpack sorting migration.
+
+        :return: Status of the VPack sort migration.
+        :rtype: dict
+        """
+        request = Request(
+            method="get", endpoint="/_admin/cluster/vpackSortMigration/status"
+        )
+
+        def response_handler(resp: Response) -> Json:
+            if not resp.is_success:
+                raise ClusterVpackSortMigrationError(resp, request)
+            result: Json = resp.body["result"]
+            return result
+
+        return self._execute(request, response_handler)
+
+    def vpack_sort_migration_index_check(self) -> Result[Json]:
+        """Check for indexes impacted by the sorting behavior before 3.12.2.
+
+        :return: Status of indexes.
+        :rtype: dict
+        """
+        request = Request(
+            method="get", endpoint="/_admin/cluster/vpackSortMigration/check"
+        )
+
+        def response_handler(resp: Response) -> Json:
+            if not resp.is_success:
+                raise ClusterVpackSortMigrationError(resp, request)
+            result: Json = resp.body["result"]
+            return result
+
+        return self._execute(request, response_handler)
+
+    def migrate_vpack_sorting(self) -> Result[Json]:
+        """Migrate instances to the new VPack sorting behavior.
+
+        :return: Status of the VPack sort migration.
+        :rtype: dict
+        """
+        request = Request(
+            method="put", endpoint="/_admin/cluster/vpackSortMigration/migrate"
+        )
+
+        def response_handler(resp: Response) -> Json:
+            if not resp.is_success:
+                raise ClusterVpackSortMigrationError(resp, request)
+            result: Json = resp.body["result"]
+            return result
+
+        return self._execute(request, response_handler)

{python_arango-8.0.0 → python_arango-8.1.1}/arango/collection.py

@@ -630,20 +630,20 @@ class Collection(ApiGroup):
             headers["x-arango-allow-dirty-read"] = "true"
 
         request = Request(
-            method="get",
+            method="head",
             endpoint=f"/_api/document/{handle}",
             headers=headers,
             read=self.name,
         )
 
         def response_handler(resp: Response) -> bool:
-            if resp.error_code == 1202:
-                return False
             if resp.status_code == 412:
                 raise DocumentRevisionError(resp, request)
+            if resp.status_code == 404:
+                return False
             if not resp.is_success:
                 raise DocumentInError(resp, request)
-            return bool(resp.body)
+            return True
 
         return self._execute(request, response_handler)
 

{python_arango-8.0.0 → python_arango-8.1.1}/arango/database.py

@@ -52,6 +52,7 @@ from arango.exceptions import (
     ServerLicenseGetError,
     ServerLicenseSetError,
     ServerLogLevelError,
+    ServerLogLevelResetError,
     ServerLogLevelSetError,
     ServerLogSettingError,
     ServerLogSettingSetError,
@@ -934,7 +935,9 @@ class Database(ApiGroup):
 
         return self._execute(request, response_handler)
 
-    def log_levels(self, server_id: Optional[str] = None) -> Result[Json]:
+    def log_levels(
+        self, server_id: Optional[str] = None, with_appenders: Optional[bool] = None
+    ) -> Result[Json]:
         """Return current logging levels.
 
         :param server_id: Forward log level to a specific server. This makes it
@@ -942,12 +945,16 @@ class Database(ApiGroup):
             JWT authentication whereas Coordinators also support authentication
             using usernames and passwords.
         :type server_id: str
+        :param with_appenders: Include appenders in the response.
+        :type with_appenders: bool
         :return: Current logging levels.
         :rtype: dict
         """
         params: Params = {}
         if server_id is not None:
             params["serverId"] = server_id
+        if with_appenders is not None:
+            params["withAppenders"] = with_appenders
 
         request = Request(method="get", endpoint="/_admin/log/level", params=params)
 
@@ -960,7 +967,10 @@ class Database(ApiGroup):
         return self._execute(request, response_handler)
 
     def set_log_levels(
-        self, server_id: Optional[str] = None, **kwargs: Dict[str, Any]
+        self,
+        server_id: Optional[str] = None,
+        with_appenders: Optional[bool] = None,
+        **kwargs: Dict[str, Any],
     ) -> Result[Json]:
         """Set the logging levels.
 
@@ -982,6 +992,8 @@ class Database(ApiGroup):
             JWT authentication whereas Coordinators also support authentication
             using usernames and passwords.
         :type server_id: str | None
+        :param with_appenders: Include appenders in the request.
+        :type with_appenders: bool | None
         :param kwargs: Logging levels.
         :type kwargs: Dict[str, Any]
         :return: New logging levels.
@@ -990,6 +1002,8 @@ class Database(ApiGroup):
         params: Params = {}
         if server_id is not None:
             params["serverId"] = server_id
+        if with_appenders is not None:
+            params["withAppenders"] = with_appenders
 
         request = Request(
             method="put", endpoint="/_admin/log/level", params=params, data=kwargs
@@ -1003,6 +1017,35 @@ class Database(ApiGroup):
 
         return self._execute(request, response_handler)
 
+    def reset_log_levels(self, server_id: Optional[str] = None) -> Result[Json]:
+        """Reset the logging levels.
+
+        Revert the server’s log level settings to the values they had at startup,
+        as determined by the startup options specified on the command-line,
+        a configuration file, and the factory defaults.
+
+        :param server_id: Forward log level to a specific server. This makes it
+            easier to adjust the log levels in clusters because DB-Servers require
+            JWT authentication whereas Coordinators also support authentication
+            using usernames and passwords.
+        :type server_id: str | None
+        :return: New logging levels.
+        :rtype: dict
+        """
+        params: Params = {}
+        if server_id is not None:
+            params["serverId"] = server_id
+
+        request = Request(method="delete", endpoint="/_admin/log/level", params=params)
+
+        def response_handler(resp: Response) -> Json:
+            if not resp.is_success:
+                raise ServerLogLevelResetError(resp, request)
+            result: Json = resp.body
+            return result
+
+        return self._execute(request, response_handler)
+
     def reload_routing(self) -> Result[bool]:
         """Reload the routing information.
 
@@ -3020,6 +3063,7 @@ class StandardDatabase(Database):
         allow_implicit: Optional[bool] = None,
         lock_timeout: Optional[int] = None,
         max_size: Optional[int] = None,
+        skip_fast_lock_round: Optional[bool] = None,
     ) -> "TransactionDatabase":
         """Begin a transaction.
 
@@ -3043,6 +3087,9 @@ class StandardDatabase(Database):
         :type lock_timeout: int | None
         :param max_size: Max transaction size in bytes.
         :type max_size: int | None
+        :param skip_fast_lock_round: Whether to disable fast locking for write
+            operations.
+        :type skip_fast_lock_round: bool | None
         :return: Database API wrapper object specifically for transactions.
         :rtype: arango.database.TransactionDatabase
         """
@@ -3055,6 +3102,7 @@ class StandardDatabase(Database):
             allow_implicit=allow_implicit,
             lock_timeout=lock_timeout,
             max_size=max_size,
+            skip_fast_lock_round=skip_fast_lock_round,
         )
 
     def begin_controlled_execution(
@@ -3191,6 +3239,8 @@ class TransactionDatabase(Database):
     :param transaction_id: Initialize using an existing transaction instead of creating
         a new transaction.
     :type transaction_id: str | None
+    :param skip_fast_lock_round: Whether to disable fast locking for write operations.
+    :type skip_fast_lock_round: bool | None
     """
 
     def __init__(
@@ -3204,6 +3254,7 @@ class TransactionDatabase(Database):
         lock_timeout: Optional[int] = None,
         max_size: Optional[int] = None,
         transaction_id: Optional[str] = None,
+        skip_fast_lock_round: Optional[bool] = None,
     ) -> None:
         self._executor: TransactionApiExecutor
         super().__init__(
@@ -3218,6 +3269,7 @@ class TransactionDatabase(Database):
                 lock_timeout=lock_timeout,
                 max_size=max_size,
                 transaction_id=transaction_id,
+                skip_fast_lock_round=skip_fast_lock_round,
             ),
         )
 

{python_arango-8.0.0 → python_arango-8.1.1}/arango/exceptions.py

@@ -674,6 +674,10 @@ class ServerLogLevelError(ArangoServerError):
     """Failed to retrieve server log levels."""
 
 
+class ServerLogLevelResetError(ArangoServerError):
+    """Failed to reset server log levels."""
+
+
 class ServerLogSettingError(ArangoServerError):
     """Failed to retrieve server log settings."""
 
@@ -1043,6 +1047,10 @@ class ClusterRebalanceError(ArangoServerError):
     """Failed to execute cluster re-balancing operation (load/set)."""
 
 
+class ClusterVpackSortMigrationError(ArangoServerError):
+    """Failed to execute vpack sort migration request."""
+
+
 ##################
 # JWT Exceptions #
 ##################

{python_arango-8.0.0 → python_arango-8.1.1}/arango/executor.py

@@ -245,6 +245,8 @@ class TransactionApiExecutor:
     :param transaction_id: Initialize using an existing transaction instead of starting
         a new transaction.
     :type transaction_id: str | None
+    :param skip_fast_lock_round: Whether to disable fast locking for write operations.
+    :type skip_fast_lock_round: bool | None
     """
 
     def __init__(
@@ -259,6 +261,7 @@ class TransactionApiExecutor:
         max_size: Optional[int] = None,
         allow_dirty_read: bool = False,
         transaction_id: Optional[str] = None,
+        skip_fast_lock_round: Optional[bool] = None,
     ) -> None:
         self._conn = connection
 
@@ -279,6 +282,8 @@ class TransactionApiExecutor:
             data["lockTimeout"] = lock_timeout
         if max_size is not None:
             data["maxTransactionSize"] = max_size
+        if skip_fast_lock_round is not None:
+            data["skipFastLockRound"] = skip_fast_lock_round
 
         if transaction_id is None:
             request = Request(

{python_arango-8.0.0 → python_arango-8.1.1}/arango/formatter.py

@@ -365,6 +365,12 @@ def format_aql_query(body: Json) -> Json:
     # New in 3.11
     if "peakMemoryUsage" in body:
         result["peak_memory_usage"] = body["peakMemoryUsage"]
+
+    # New in 3.12.2
+    if "modificationQuery" in body:
+        result["modification_query"] = body["modificationQuery"]
+    if "warnings" in body:
+        result["warnings"] = body["warnings"]
     return verify_format(body, result)
 
 

{python_arango-8.0.0 → python_arango-8.1.1}/arango/request.py

@@ -12,7 +12,7 @@ def normalize_headers(
     if driver_flags is not None:
         for flag in driver_flags:
             flags = flags + flag + ";"
-    driver_version = "7.7.0"
+    driver_version = "8.1.1"
     driver_header = "python-arango/" + driver_version + " (" + flags + ")"
     normalized_headers: Headers = {
         "charset": "utf-8",

{python_arango-8.0.0 → python_arango-8.1.1}/docs/admin.rst

@@ -60,7 +60,7 @@ database.
     # Set the log .
     sys_db.set_log_levels(
         agency='DEBUG',
-        collector='INFO',
+        deprecation='INFO',
         threads='WARNING'
     )
 

{python_arango-8.0.0 → python_arango-8.1.1}/docs/conf.py

@@ -17,6 +17,9 @@ html_static_path = ["static"]
 html_theme = "sphinx_rtd_theme"
 master_doc = "index"
 
+# Set canonical URL from the Read the Docs Domain
+html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "docs.python-arango.com")
+
 autodoc_member_order = "bysource"
 
 doctest_global_setup = """

{python_arango-8.0.0 → python_arango-8.1.1}/pyproject.toml

@@ -57,7 +57,6 @@ dev = [
     "pytest-cov>=3.0.0",
     "sphinx",
     "sphinx_rtd_theme",
-    "types-pkg_resources",
     "types-requests",
     "types-setuptools",
 ]

{python_arango-8.0.0 → python_arango-8.1.1}/python_arango.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-arango
-Version: 8.0.0
+Version: 8.1.1
 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>
@@ -61,7 +61,6 @@ Requires-Dist: pytest>=7.1.1; extra == "dev"
 Requires-Dist: pytest-cov>=3.0.0; extra == "dev"
 Requires-Dist: sphinx; extra == "dev"
 Requires-Dist: sphinx_rtd_theme; extra == "dev"
-Requires-Dist: types-pkg_resources; extra == "dev"
 Requires-Dist: types-requests; extra == "dev"
 Requires-Dist: types-setuptools; extra == "dev"
 

{python_arango-8.0.0 → python_arango-8.1.1}/python_arango.egg-info/requires.txt

@@ -17,6 +17,5 @@ pytest>=7.1.1
 pytest-cov>=3.0.0
 sphinx
 sphinx_rtd_theme
-types-pkg_resources
 types-requests
 types-setuptools

{python_arango-8.0.0 → python_arango-8.1.1}/starter.sh

@@ -6,7 +6,7 @@
 # Usage:
 #   ./starter.sh [single|cluster] [community|enterprise] [version]
 # Example:
-#   ./starter.sh cluster enterprise 3.11.4
+#   ./starter.sh cluster enterprise 3.12.1
 
 setup="${1:-single}"
 license="${2:-community}"