t

akka.persistence.query.scaladsl

DurableStateStoreQuery

trait DurableStateStoreQuery[A] extends DurableStateStore[A]

Query API for reading durable state objects.

For Java API see akka.persistence.query.javadsl.DurableStateStoreQuery.

Source
DurableStateStoreQuery.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DurableStateStoreQuery
  2. DurableStateStore
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def changes(tag: String, offset: Offset): Source[DurableStateChange[A], NotUsed]

    Get a source of the most recent changes made to objects of the given tag since the passed in offset.

    Get a source of the most recent changes made to objects of the given tag since the passed in offset.

    The returned source will never terminate, it effectively watches for changes to the objects and emits changes as they happen.

    Not all changes that occur are guaranteed to be emitted, this call only guarantees that eventually, the most recent change for each object since the offset will be emitted. In particular, multiple updates to a given object in quick succession are likely to be skipped, with only the last update resulting in a change from this source.

    The DurableStateChange elements can be akka.persistence.query.UpdatedDurableState or akka.persistence.query.DeletedDurableState.

    tag

    The tag to get changes for.

    offset

    The offset to get changes since. Must either be akka.persistence.query.NoOffset to get changes since the beginning of time, or an offset that has been previously returned by this query. Any other offsets are invalid.

    returns

    A source of change in state.

  2. abstract def currentChanges(tag: String, offset: Offset): Source[DurableStateChange[A], NotUsed]

    Get a source of the most recent changes made to objects with the given tag since the passed in offset.

    Get a source of the most recent changes made to objects with the given tag since the passed in offset.

    Note that this only returns the most recent change to each object, if an object has been updated multiple times since the offset, only the most recent of those changes will be part of the stream.

    This will return changes that occurred up to when the Source returned by this call is materialized. Changes to objects made since materialization are not guaranteed to be included in the results.

    The DurableStateChange elements can be akka.persistence.query.UpdatedDurableState or akka.persistence.query.DeletedDurableState.

    tag

    The tag to get changes for.

    offset

    The offset to get changes since. Must either be akka.persistence.query.NoOffset to get changes since the beginning of time, or an offset that has been previously returned by this query. Any other offsets are invalid.

    returns

    A source of change in state.

  3. abstract def getObject(persistenceId: String): Future[GetObjectResult[A]]
    Definition Classes
    DurableStateStore

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from DurableStateStoreQuery[A] toany2stringadd[DurableStateStoreQuery[A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (DurableStateStoreQuery[A], B)
    Implicit
    This member is added by an implicit conversion from DurableStateStoreQuery[A] toArrowAssoc[DurableStateStoreQuery[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. def ensuring(cond: (DurableStateStoreQuery[A]) => Boolean, msg: => Any): DurableStateStoreQuery[A]
    Implicit
    This member is added by an implicit conversion from DurableStateStoreQuery[A] toEnsuring[DurableStateStoreQuery[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (DurableStateStoreQuery[A]) => Boolean): DurableStateStoreQuery[A]
    Implicit
    This member is added by an implicit conversion from DurableStateStoreQuery[A] toEnsuring[DurableStateStoreQuery[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): DurableStateStoreQuery[A]
    Implicit
    This member is added by an implicit conversion from DurableStateStoreQuery[A] toEnsuring[DurableStateStoreQuery[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): DurableStateStoreQuery[A]
    Implicit
    This member is added by an implicit conversion from DurableStateStoreQuery[A] toEnsuring[DurableStateStoreQuery[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from DurableStateStoreQuery[A] toStringFormat[DurableStateStoreQuery[A]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def [B](y: B): (DurableStateStoreQuery[A], B)
    Implicit
    This member is added by an implicit conversion from DurableStateStoreQuery[A] toArrowAssoc[DurableStateStoreQuery[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from DurableStateStore[A]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromDurableStateStoreQuery[A] to any2stringadd[DurableStateStoreQuery[A]]

Inherited by implicit conversion StringFormat fromDurableStateStoreQuery[A] to StringFormat[DurableStateStoreQuery[A]]

Inherited by implicit conversion Ensuring fromDurableStateStoreQuery[A] to Ensuring[DurableStateStoreQuery[A]]

Inherited by implicit conversion ArrowAssoc fromDurableStateStoreQuery[A] to ArrowAssoc[DurableStateStoreQuery[A]]

Ungrouped