Document CRUD operations (#41)

* Document update

* Document replace

* Adding delete and has, plus updating get method.

* Adding get_many method

* Adjusting typing information - The Json serializer must be able to deal with sequences

* Adding truncate and count operations

* Adding find method

* Adding insert_many method

* Adding update_many method

* Adding update_many method

* Adding delete_many method

* Adding update_match

* Adding replace_match

* Adding delete_match

Author: apetenchea

arangoasync/aql.py

@@ -327,7 +327,7 @@ def response_handler(resp: Response) -> Cursor:
             if not resp.is_success:
                 raise AQLQueryExecuteError(resp, request)
             if self._executor.context == "async":
-                # We cannot have a cursor getting back async jobs
+                # We cannot have a cursor giving back async jobs
                 executor: NonAsyncExecutor = DefaultApiExecutor(
                     self._executor.connection
                 )

arangoasync/collection.py

@@ -187,6 +187,10 @@ class ClientConnectionError(ArangoClientError):
     """The request was unable to reach the server."""
 
 
+class CollectionTruncateError(ArangoServerError):
+    """Failed to truncate collection."""
+
+
 class CursorCloseError(ArangoServerError):
     """Failed to delete the cursor result from server."""
 
@@ -227,6 +231,14 @@ class DeserializationError(ArangoClientError):
     """Failed to deserialize the server response."""
 
 
+class DocumentCountError(ArangoServerError):
+    """Failed to retrieve document count."""
+
+
+class DocumentDeleteError(ArangoServerError):
+    """Failed to delete document."""
+
+
 class DocumentGetError(ArangoServerError):
     """Failed to retrieve document."""
 
@@ -239,10 +251,18 @@ class DocumentParseError(ArangoClientError):
     """Failed to parse document input."""
 
 
+class DocumentReplaceError(ArangoServerError):
+    """Failed to replace document."""
+
+
 class DocumentRevisionError(ArangoServerError):
     """The expected and actual document revisions mismatched."""
 
 
+class DocumentUpdateError(ArangoServerError):
+    """Failed to update document."""
+
+
 class IndexCreateError(ArangoServerError):
     """Failed to create collection index."""
 
@@ -307,6 +327,10 @@ class ServerVersionError(ArangoServerError):
     """Failed to retrieve server version."""
 
 
+class SortValidationError(ArangoClientError):
+    """Invalid sort parameters."""
+
+
 class TransactionAbortError(ArangoServerError):
     """Failed to abort transaction."""
 

arangoasync/exceptions.py

@@ -9,7 +9,7 @@
 
 import json
 from abc import ABC, abstractmethod
-from typing import Generic, TypeVar
+from typing import Generic, Sequence, TypeVar
 
 from arangoasync.exceptions import DeserializationError, SerializationError
 from arangoasync.typings import Json, Jsons
@@ -26,7 +26,7 @@ class Serializer(ABC, Generic[T]):  # pragma: no cover
     """
 
     @abstractmethod
-    def dumps(self, data: T) -> str:
+    def dumps(self, data: T | Sequence[T | str]) -> str:
         """Serialize any generic data.
 
         Args:
@@ -87,7 +87,7 @@ def loads_many(self, data: bytes) -> U:
 class JsonSerializer(Serializer[Json]):
     """JSON serializer."""
 
-    def dumps(self, data: T) -> str:
+    def dumps(self, data: Json | Sequence[str | Json]) -> str:
         try:
             return json.dumps(data, separators=(",", ":"))
         except Exception as e:
@@ -104,10 +104,7 @@ def loads(self, data: bytes) -> Json:
             raise DeserializationError("Failed to deserialize data from JSON.") from e
 
     def loads_many(self, data: bytes) -> Jsons:
-        try:
-            return json.loads(data)  # type: ignore[no-any-return]
-        except Exception as e:
-            raise DeserializationError("Failed to deserialize data from JSON.") from e
+        return self.loads(data)  # type: ignore[return-value]
 
 
 DefaultSerializer = JsonSerializer

arangoasync/serialization.py

@@ -5,6 +5,8 @@
 from arangoasync.errno import DATA_SOURCE_NOT_FOUND, INDEX_NOT_FOUND
 from arangoasync.exceptions import (
     CollectionPropertiesError,
+    CollectionTruncateError,
+    DocumentCountError,
     IndexCreateError,
     IndexDeleteError,
     IndexGetError,
@@ -157,3 +159,26 @@ async def test_collection_index(doc_col, bad_col, cluster):
         await doc_col.delete_index(idx1.id)
     assert err.value.error_code == INDEX_NOT_FOUND
     assert await doc_col.delete_index(idx2.id, ignore_missing=True) is False
+
+
+@pytest.mark.asyncio
+async def test_collection_truncate_count(docs, doc_col, bad_col):
+    # Test errors
+    with pytest.raises(CollectionTruncateError):
+        await bad_col.truncate()
+    with pytest.raises(DocumentCountError):
+        await bad_col.count()
+
+    # Test regular operations
+    await asyncio.gather(*[doc_col.insert(doc) for doc in docs])
+    cnt = await doc_col.count()
+    assert cnt == len(docs)
+
+    await doc_col.truncate()
+    cnt = await doc_col.count()
+    assert cnt == 0
+
+    await asyncio.gather(*[doc_col.insert(doc) for doc in docs])
+    await doc_col.truncate(wait_for_sync=True, compact=True)
+    cnt = await doc_col.count()
+    assert cnt == 0