aea.helpers.storage.backends.base
This module contains storage abstract backend class.
AbstractStorageBackend Objects
class AbstractStorageBackend(ABC)
Abstract base class for storage backend.
__
init__
| __init__(uri: str) -> None
Init backend.
connect
| @abstractmethod
| async connect() -> None
Connect to backend.
disconnect
| @abstractmethod
| async disconnect() -> None
Disconnect the backend.
ensure_
collection
| @abstractmethod
| async ensure_collection(collection_name: str) -> None
Create collection if not exits.
Arguments:
collection_name
: str.
Returns:
None
put
| @abstractmethod
| async put(collection_name: str, object_id: str, object_body: JSON_TYPES) -> None
Put object into collection.
Arguments:
collection_name
: str.object_id
: str object idobject_body
: python dict, json compatible.
Returns:
None
get
| @abstractmethod
| async get(collection_name: str, object_id: str) -> Optional[JSON_TYPES]
Get object from the collection.
Arguments:
collection_name
: str.object_id
: str object id
Returns:
dict if object exists in collection otherwise None
remove
| @abstractmethod
| async remove(collection_name: str, object_id: str) -> None
Remove object from the collection.
Arguments:
collection_name
: str.object_id
: str object id
Returns:
None
find
| @abstractmethod
| async find(collection_name: str, field: str, equals: EQUALS_TYPE) -> List[OBJECT_ID_AND_BODY]
Get objects from the collection by filtering by field value.
Arguments:
collection_name
: str.field
: field name to search: example "parent.field"equals
: value field should be equal to
Returns:
list of objects bodies
list
| @abstractmethod
| async list(collection_name: str) -> List[OBJECT_ID_AND_BODY]
List all objects with keys from the collection.
Arguments:
collection_name
: str.
Returns:
Tuple of objects keys, bodies.