Merge pull request #372 from minos-framework/issue-371-add-database-operation

#371 - Add `DatabaseOperation`

Author: Sergio García Prado

packages/core/minos-microservice-aggregate/minos/aggregate/__init__.py

@@ -29,14 +29,16 @@
     RootEntity,
 )
 from .events import (
+    AiopgEventDatabaseOperationFactory,
+    DatabaseEventRepository,
     Event,
+    EventDatabaseOperationFactory,
     EventEntry,
     EventRepository,
     FieldDiff,
     FieldDiffContainer,
     IncrementalFieldDiff,
     InMemoryEventRepository,
-    PostgreSqlEventRepository,
 )
 from .exceptions import (
     AggregateException,
@@ -57,20 +59,24 @@
     Ordering,
 )
 from .snapshots import (
+    AiopgSnapshotDatabaseOperationFactory,
+    AiopgSnapshotQueryDatabaseOperationBuilder,
+    DatabaseSnapshotReader,
+    DatabaseSnapshotRepository,
+    DatabaseSnapshotSetup,
+    DatabaseSnapshotWriter,
     InMemorySnapshotRepository,
-    PostgreSqlSnapshotQueryBuilder,
-    PostgreSqlSnapshotReader,
-    PostgreSqlSnapshotRepository,
-    PostgreSqlSnapshotSetup,
-    PostgreSqlSnapshotWriter,
+    SnapshotDatabaseOperationFactory,
     SnapshotEntry,
     SnapshotRepository,
     SnapshotService,
 )
 from .transactions import (
     TRANSACTION_CONTEXT_VAR,
+    AiopgTransactionDatabaseOperationFactory,
+    DatabaseTransactionRepository,
     InMemoryTransactionRepository,
-    PostgreSqlTransactionRepository,
+    TransactionDatabaseOperationFactory,
     TransactionEntry,
     TransactionRepository,
     TransactionService,

packages/core/minos-microservice-aggregate/minos/aggregate/events/__init__.py

@@ -10,7 +10,9 @@
     Event,
 )
 from .repositories import (
+    AiopgEventDatabaseOperationFactory,
+    DatabaseEventRepository,
+    EventDatabaseOperationFactory,
     EventRepository,
     InMemoryEventRepository,
-    PostgreSqlEventRepository,
 )

packages/core/minos-microservice-aggregate/minos/aggregate/events/repositories/__init__.py

@@ -1,9 +1,11 @@
 from .abc import (
     EventRepository,
 )
+from .database import (
+    AiopgEventDatabaseOperationFactory,
+    DatabaseEventRepository,
+    EventDatabaseOperationFactory,
+)
 from .memory import (
     InMemoryEventRepository,
 )
-from .pg import (
-    PostgreSqlEventRepository,
-)

packages/core/minos-microservice-aggregate/minos/aggregate/events/repositories/database/__init__.py

@@ -0,0 +1,7 @@
+from .factories import (
+    AiopgEventDatabaseOperationFactory,
+    EventDatabaseOperationFactory,
+)
+from .impl import (
+    DatabaseEventRepository,
+)

packages/core/minos-microservice-aggregate/minos/aggregate/events/repositories/database/factories/__init__.py

@@ -0,0 +1,6 @@
+from .abc import (
+    EventDatabaseOperationFactory,
+)
+from .aiopg import (
+    AiopgEventDatabaseOperationFactory,
+)

packages/core/minos-microservice-aggregate/minos/aggregate/events/repositories/database/factories/abc.py

@@ -0,0 +1,111 @@
+from abc import (
+    ABC,
+    abstractmethod,
+)
+from datetime import (
+    datetime,
+)
+from typing import (
+    Optional,
+)
+from uuid import (
+    UUID,
+)
+
+from minos.common import (
+    DatabaseOperation,
+    DatabaseOperationFactory,
+)
+
+from .....actions import (
+    Action,
+)
+
+
+class EventDatabaseOperationFactory(DatabaseOperationFactory, ABC):
+    """Event Database Operation Factory base class."""
+
+    @abstractmethod
+    def build_create_table(self) -> DatabaseOperation:
+        """Build the database operation to create the event table.
+
+        :return: A ``DatabaseOperation`` instance.s
+        """
+
+    @abstractmethod
+    def build_submit_row(
+        self,
+        transaction_uuids: tuple[UUID],
+        uuid: UUID,
+        action: Action,
+        name: str,
+        version: int,
+        data: bytes,
+        created_at: datetime,
+        transaction_uuid: UUID,
+        lock: Optional[int],
+        **kwargs,
+    ) -> DatabaseOperation:
+        """Build the database operation to submit a row into the event table.
+
+        :param transaction_uuids: The sequence of nested transaction in on top of the current event's transaction.
+        :param uuid: The identifier of the entity.
+        :param action: The action of the event.
+        :param name: The name of the entity.
+        :param version: The version of the entity
+        :param data: The data of the event.
+        :param created_at: The creation datetime.
+        :param transaction_uuid: The identifier of the transaction.
+        :param lock: The lock identifier.
+        :param kwargs: Additional named arguments.
+        :return: A ``DatabaseOperation`` instance.
+        """
+
+    # noinspection PyShadowingBuiltins
+    @abstractmethod
+    def build_select_rows(
+        self,
+        uuid: Optional[UUID] = None,
+        name: Optional[str] = None,
+        version: Optional[int] = None,
+        version_lt: Optional[int] = None,
+        version_gt: Optional[int] = None,
+        version_le: Optional[int] = None,
+        version_ge: Optional[int] = None,
+        id: Optional[int] = None,
+        id_lt: Optional[int] = None,
+        id_gt: Optional[int] = None,
+        id_le: Optional[int] = None,
+        id_ge: Optional[int] = None,
+        transaction_uuid: Optional[UUID] = None,
+        transaction_uuid_ne: Optional[UUID] = None,
+        transaction_uuid_in: Optional[tuple[UUID, ...]] = None,
+        **kwargs,
+    ) -> DatabaseOperation:
+        """Build the database operation to select rows.
+
+        :param uuid: The identifier must be equal to the given value.
+        :param name: The classname must be equal to the given value.
+        :param version: The version must be equal to the given value.
+        :param version_lt: The version must be lower than the given value.
+        :param version_gt: The version must be greater than the given value.
+        :param version_le: The version must be lower or equal to the given value.
+        :param version_ge: The version must be greater or equal to the given value.
+        :param id: The entry identifier must be equal to the given value.
+        :param id_lt: The entry identifier must be lower than the given value.
+        :param id_gt: The entry identifier must be greater than the given value.
+        :param id_le: The entry identifier must be lower or equal to the given value.
+        :param id_ge: The entry identifier must be greater or equal to the given value.
+        :param transaction_uuid: The transaction identifier must be equal to the given value.
+        :param transaction_uuid_ne: The transaction identifier must be distinct of the given value.
+        :param transaction_uuid_in: The destination transaction identifier must be equal to one of the given values.
+
+        :return: A ``DatabaseOperation`` instance.
+        """
+
+    @abstractmethod
+    def build_select_max_id(self) -> DatabaseOperation:
+        """Build the database operation to get the maximum identifier.
+
+        :return: A ``DatabaseOperation`` instance.
+        """