Getting started on administration API

Author: apetenchea

arangoasync/database.py

@@ -40,6 +40,7 @@
     PermissionResetError,
     PermissionUpdateError,
     ServerEncryptionError,
+    ServerEngineError,
     ServerStatusError,
     ServerTLSError,
     ServerTLSReloadError,
@@ -2437,6 +2438,28 @@ def response_handler(resp: Response) -> bool:
 
         return await self._executor.execute(request, response_handler)
 
+    async def engine(self) -> Result[Json]:
+        """Returns the storage engine the server is configured to use.
+
+        Returns:
+            dict: Database engine details.
+
+        Raises:
+            ServerEngineError: If the operation fails.
+
+        References:
+            - `get-the-storage-engine-type <https://docs.arangodb.com/stable/develop/http-api/administration/#get-the-storage-engine-type>`__
+        """  # noqa: E501
+        request = Request(method=Method.GET, endpoint="/_api/engine")
+
+        def response_handler(resp: Response) -> Json:
+            if not resp.is_success:
+                raise ServerEngineError(resp, request)
+            result: Json = self.deserializer.loads(resp.raw_body)
+            return result
+
+        return await self._executor.execute(request, response_handler)
+
 
 class StandardDatabase(Database):
     """Standard database API wrapper.

arangoasync/exceptions.py

@@ -547,12 +547,16 @@ class SerializationError(ArangoClientError):
     """Failed to serialize the request."""
 
 
+class ServerConnectionError(ArangoServerError):
+    """Failed to connect to ArangoDB server."""
+
+
 class ServerEncryptionError(ArangoServerError):
     """Failed to reload user-defined encryption keys."""
 
 
-class ServerConnectionError(ArangoServerError):
-    """Failed to connect to ArangoDB server."""
+class ServerEngineError(ArangoServerError):
+    """Failed to retrieve database engine."""
 
 
 class ServerStatusError(ArangoServerError):

docs/admin.rst

@@ -0,0 +1,23 @@
+Server Administration
+---------------------
+
+ArangoDB provides operations for server administration and monitoring.
+Most of these operations can only be performed by admin users via the
+``_system`` database.
+
+**Example:**
+
+.. code-block:: python
+
+    from arangoasync import ArangoClient
+    from arangoasync.auth import Auth
+
+    # Initialize the client for ArangoDB.
+    async with ArangoClient(hosts="http://localhost:8529") as client:
+        auth = Auth(username="root", password="passwd")
+
+        # Connect to "_system" database as root user.
+        sys_db = await client.db("_system", auth=auth)
+
+        # Retrieve the database engine.
+        await sys_db.engine()

tests/test_database.py

@@ -64,6 +64,10 @@ async def test_database_misc_methods(sys_db, db, bad_db, cluster, db_version):
         with pytest.raises(CollectionKeyGeneratorsError):
             await bad_db.key_generators()
 
+    # Administration
+    result = await db.engine()
+    assert isinstance(result, dict)
+
 
 @pytest.mark.asyncio
 async def test_create_drop_database(