QueryAPI

Value Members

1. final def !=(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

4. val acc: (K) ⇒ (Snapshot[S, V], Event[KK, S, E]) ⇒ Snapshot[S, V]

   

5. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

6. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

7. final def eq(arg0: AnyRef): Boolean

   

   Definition Classes

   AnyRef

8. val eventStore: EventStorage[F, KK, S, E]

   

9. def finalize(): Unit

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( classOf[java.lang.Throwable] )

10. def forceRefreshPersistedSnapshot(key: K, forceStartAt: S)(implicit F: Monad[F], FC: Catchable[F]): F[\/[Error, Snapshot[S, V]]]

    

    Explicitly refresh persisted snapshot with events starting at forceStartAt.

    Explicitly refresh persisted snapshot with events starting at forceStartAt. Normally to refresh a snapshot, your implementation of QueryAPI can do so asynchronously via a custom onGenerateLatestSnapshot function.

    WARNING - Use this only if you know that events prior to forceStartAt can be safely ignored. Typically this is when a single event stream contains events for multiple entities, so obviously when you create a new entity, you can ignore all events prior to that creation event.

    key

    The key

    forceStartAt

    Generate a snapshot starting from events at the specified sequence number. This should only be used when it is known that preceding events can be ignored. For example when new entities are added, there are no views of those entities before the events that add them!

    returns

    Error when saving snapshot or the snapshot that was saved.

11. def generateLatestSnapshot(key: K)(implicit F: Monad[F], FC: Catchable[F]): F[LatestSnapshotResult[S, V]]

    

    Generates the latest snapshot by retrieving the last persisted snapshot and then replaying events on top of that.

12. def get(key: K, consistency: QueryConsistency)(implicit F: Monad[F], FC: Catchable[F]): F[Option[V]]

    

    Return the current view of the data for key 'key'

13. def getAt(key: K, time: DateTime)(implicit F: Monad[F], FC: Catchable[F]): F[Option[V]]

    

    Return the view of the data for the key 'key' at the specified timestamp.

    Return the view of the data for the key 'key' at the specified timestamp.

    key

    The key

    time

    The timestamp at which we want to see the view of the data

    returns

    view of the data with events up to the given time stamp.

14. def getAt(key: K, seq: S)(implicit F: Monad[F], FC: Catchable[F], S: Sequence[S]): F[Option[V]]

    

    Return the view of the data for the key 'key' at the specified sequence number.

    Return the view of the data for the key 'key' at the specified sequence number.

    key

    the key

    seq

    the sequence number of the event at which we want the see the view of the data.

    returns

    view of the data at event with sequence 'seq'

15. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

16. def getHistory(key: K, from: Option[S])(implicit F: Monad[F], FC: Catchable[F], S: Sequence[S]): F[Process[F, Snapshot[S, V]]]

    

    Get a stream of Snapshots starting from sequence number 'from' (if defined).

    Get a stream of Snapshots starting from sequence number 'from' (if defined).

    key

    The key

    from

    Starting sequence number. None to get from the beginning of the stream.

    returns

    a stream of Snapshots starting from sequence number 'from' (if defined).

17. def getSnapshot(key: K, consistency: QueryConsistency)(implicit F: Monad[F], FC: Catchable[F]): F[Snapshot[S, V]]

    
    returns

    the current view wrapped in Snapshot of the data for key 'key'

18. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

19. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

20. final def notify(): Unit

    

    Definition Classes

    AnyRef

21. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

22. def persistSnapshot(key: K, snapshot: Snapshot[S, V], previousSnapshot: Option[Snapshot[S, V]])(implicit F: Applicative[F]): F[\/[Error, Snapshot[S, V]]]

    

    Save the given snapshot if it is at a different sequence number to previousSnapshot.

    Save the given snapshot if it is at a different sequence number to previousSnapshot. Set previousSnapshot to None to force a save.

23. val snapshotStore: SnapshotStorage[F, K, S, V]

    

24. final def synchronized[T0](arg0: ⇒ T0): T0

    

    Definition Classes

    AnyRef

25. val toStreamKey: (K) ⇒ KK

    

26. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

27. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

28. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )