python_arango_ogm.db.pao_db_base

  1from abc import ABC, abstractmethod
  2from typing import Any, Dict, Sequence
  3
  4
  5class PAODBBase(ABC):
  6    @abstractmethod
  7    def setup_app_database(self, delete_db):
  8        """
  9        Setup app databases; deleting if specified by delete_db
 10        This is called by constructor, but since this based on a
 11        Singleton metaclass, it might neccesary to call it manually
 12        after migrations have been appplied and whatnot.
 13        """
 14        pass
 15
 16    def get_related_edges(self, collection_name: str, association_collection_name: str, lookup_key_dict: Dict):
 17        """
 18        Gets `association_collection_name` edges of `collection_name`;
 19        looking up by the keys and values in `lookup_key_dict`:
 20        """
 21        pass
 22
 23    @abstractmethod
 24    def get_related_vertices(self, collection_name: str, association_collection_name: str, lookup_key_dict: Dict):
 25        """
 26        Lookup associated vertices (`association_collection_name`) through edges,
 27        from given collection_name, using keys and values in lookup_key_dict:
 28        """
 29        pass
 30
 31    @abstractmethod
 32    def inject_into_models(self):
 33        """ Inject database into models, as PAODatabase is where the functionality is implemented."""
 34        pass
 35
 36    @abstractmethod
 37    def get_db(self):
 38        """ Return underlying python-arango database"""
 39        pass
 40
 41    @abstractmethod
 42    def find_by_key(self, collection_name: str, key: Any):
 43        """
 44          Find document on collection by given key value:
 45        """
 46        pass
 47
 48    @abstractmethod
 49    def find_by_attributes(self, collection_name: str, lookup_key_dict: Dict = None):
 50        """
 51          Find a single document by given collection_name,
 52          looking up by the keys and values in lookup_key_dict:
 53        """
 54        pass
 55
 56    @abstractmethod
 57    def remove_by_key(self, collection_name: str, key: str):
 58        """ Remove a document identified by `key` from collection """
 59        pass
 60
 61    @abstractmethod
 62    def get_by_attributes(
 63            self,
 64            collection_name: str,
 65            lookup_key_dict: Dict = None,
 66            sort_key_dict: Dict[str, str] = None
 67    ):
 68        """
 69          Gets documents from given collection_name, looking up by the keys and values
 70          in lookup_key_dict, sorting by keys and direction
 71
 72          :param collection_name: Name of collection in Graph DB.
 73          :param lookup_key_dict: A dictionary of keys and corresponding values used to query this collection
 74          values (ASC, DESC):
 75          :param sort_key_dict: A dictionary of keys by which to sort documents.  Values specify direction (ASC, DESC, '')
 76        """
 77        pass
 78
 79    @abstractmethod
 80    def insert_edge(self, collection_name: str, association_collection_name: str, from_key, to_key):
 81        """
 82          Insert edge document using keys (_from and _to are generated using collection name).
 83          Collection inferred from collection_name and association_collection_name.
 84        """
 85        pass
 86
 87    @abstractmethod
 88    def insert_doc(self, collection_name: str, doc: Dict):
 89        """
 90          Insert a new doc in collection:
 91        """
 92        pass
 93
 94    @abstractmethod
 95    def insert_docs(self, collection_name: str, docs: Sequence[dict[str, Any]]):
 96        """ Insert given documents into collection with a single query"""
 97        pass
 98
 99    @abstractmethod
100    def upsert_doc(
101            self,
102            collection_name: str,
103            doc: Dict,
104            lookup_keys: Sequence[str] = None,
105            insert_dict=None,
106            update_dict=None
107    ):
108        """
109          Upsert a doc in collection using given lookup_keys
110          collection_name: Name of DB collection
111          doc:Dict: Document containing keys and values to insert and update
112          lookup_keys: Sequence of keys to lookup document to update
113          insert_dict: Dictionary of values to insert only
114          update_dict: Dictionary of values to update only
115        """
116        pass