Packages

final class PersistenceTestKitReadJournal extends ReadJournal with EventsByPersistenceIdQuery with EventsByPersistenceIdTypedQuery with CurrentEventsByPersistenceIdQuery with CurrentEventsByPersistenceIdTypedQuery with CurrentEventsByTagQuery with CurrentEventsBySliceQuery with PagedPersistenceIdsQuery

Source
PersistenceTestKitReadJournal.scala
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PersistenceTestKitReadJournal
  2. PagedPersistenceIdsQuery
  3. CurrentEventsBySliceQuery
  4. CurrentEventsByTagQuery
  5. CurrentEventsByPersistenceIdTypedQuery
  6. CurrentEventsByPersistenceIdQuery
  7. EventsByPersistenceIdTypedQuery
  8. EventsByPersistenceIdQuery
  9. ReadJournal
  10. AnyRef
  11. 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

Instance Constructors

  1. new PersistenceTestKitReadJournal(system: ExtendedActorSystem, config: Config, configPath: String)

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 PersistenceTestKitReadJournal toany2stringadd[PersistenceTestKitReadJournal] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (PersistenceTestKitReadJournal, B)
    Implicit
    This member is added by an implicit conversion from PersistenceTestKitReadJournal toArrowAssoc[PersistenceTestKitReadJournal] 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]) @native() @HotSpotIntrinsicCandidate()
  8. def currentEventsByPersistenceId(persistenceId: String, fromSequenceNr: Long = 0, toSequenceNr: Long = Long.MaxValue): Source[EventEnvelope, NotUsed]

    Same type of query as EventsByPersistenceIdQuery#eventsByPersistenceId but the event stream is completed immediately when it reaches the end of the "result set".

    Same type of query as EventsByPersistenceIdQuery#eventsByPersistenceId but the event stream is completed immediately when it reaches the end of the "result set". Events that are stored after the query is completed are not included in the event stream.

    Definition Classes
    PersistenceTestKitReadJournalCurrentEventsByPersistenceIdQuery
  9. def currentEventsByPersistenceIdTyped[Event](persistenceId: String, fromSequenceNr: Long, toSequenceNr: Long): Source[EventEnvelope[Event], NotUsed]

    Same type of query as EventsByPersistenceIdTypedQuery#eventsByPersistenceIdTyped but the event stream is completed immediately when it reaches the end of the "result set".

    Same type of query as EventsByPersistenceIdTypedQuery#eventsByPersistenceIdTyped but the event stream is completed immediately when it reaches the end of the "result set". Events that are stored after the query is completed are not included in the event stream.

    This is a new version of the akka.persistence.query.scaladsl.EventsByPersistenceIdQuery#currentEventsByPersistenceId using a new envelope type akka.persistence.query.typed.EventEnvelope.

    Event

    the type of the event payload

    Definition Classes
    PersistenceTestKitReadJournalCurrentEventsByPersistenceIdTypedQuery
  10. def currentEventsBySlices[Event](entityType: String, minSlice: Int, maxSlice: Int, offset: Offset): Source[EventEnvelope[Event], NotUsed]

    Same type of query as EventsBySliceQuery.eventsBySlices but the event stream is completed immediately when it reaches the end of the "result set".

    Same type of query as EventsBySliceQuery.eventsBySlices but the event stream is completed immediately when it reaches the end of the "result set". Depending on journal implementation, this may mean all events up to when the query is started, or it may include events that are persisted while the query is still streaming results. For eventually consistent stores, it may only include all events up to some point before the query is started.

    Definition Classes
    PersistenceTestKitReadJournalCurrentEventsBySliceQuery
  11. def currentEventsByTag(tag: String, offset: Offset = NoOffset): Source[EventEnvelope, NotUsed]

    Same type of query as EventsByTagQuery#eventsByTag but the event stream is completed immediately when it reaches the end of the "result set".

    Same type of query as EventsByTagQuery#eventsByTag but the event stream is completed immediately when it reaches the end of the "result set". Depending on journal implementation, this may mean all events up to when the query is started, or it may include events that are persisted while the query is still streaming results. For eventually consistent stores, it may only include all events up to some point before the query is started.

    Definition Classes
    PersistenceTestKitReadJournalCurrentEventsByTagQuery
  12. def currentPersistenceIds(afterId: Option[String], limit: Long): Source[String, NotUsed]

    Get the current persistence ids.

    Get the current persistence ids.

    Not all plugins may support in database paging, and may simply use drop/take Akka streams operators to manipulate the result set according to the paging parameters.

    afterId

    The ID to start returning results from, or None to return all ids. This should be an id returned from a previous invocation of this command. Callers should not assume that ids are returned in sorted order.

    limit

    The maximum results to return. Use Long.MaxValue to return all results. Must be greater than zero.

    returns

    A source containing all the persistence ids, limited as specified.

    Definition Classes
    PersistenceTestKitReadJournalPagedPersistenceIdsQuery
  13. def ensuring(cond: (PersistenceTestKitReadJournal) => Boolean, msg: => Any): PersistenceTestKitReadJournal
    Implicit
    This member is added by an implicit conversion from PersistenceTestKitReadJournal toEnsuring[PersistenceTestKitReadJournal] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: (PersistenceTestKitReadJournal) => Boolean): PersistenceTestKitReadJournal
    Implicit
    This member is added by an implicit conversion from PersistenceTestKitReadJournal toEnsuring[PersistenceTestKitReadJournal] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean, msg: => Any): PersistenceTestKitReadJournal
    Implicit
    This member is added by an implicit conversion from PersistenceTestKitReadJournal toEnsuring[PersistenceTestKitReadJournal] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean): PersistenceTestKitReadJournal
    Implicit
    This member is added by an implicit conversion from PersistenceTestKitReadJournal toEnsuring[PersistenceTestKitReadJournal] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  19. def eventsByPersistenceId(persistenceId: String, fromSequenceNr: Long = 0, toSequenceNr: Long = Long.MaxValue): Source[EventEnvelope, NotUsed]

    Query events for a specific PersistentActor identified by persistenceId.

    Query events for a specific PersistentActor identified by persistenceId.

    You can retrieve a subset of all events by specifying fromSequenceNr and toSequenceNr or use 0L and Long.MaxValue respectively to retrieve all events. The query will return all the events inclusive of the fromSequenceNr and toSequenceNr values.

    The returned event stream should be ordered by sequence number.

    The stream is not completed when it reaches the end of the currently stored events, but it continues to push new events when new events are persisted. Corresponding query that is completed when it reaches the end of the currently stored events is provided by CurrentEventsByPersistenceIdQuery#currentEventsByPersistenceId.

    Definition Classes
    PersistenceTestKitReadJournalEventsByPersistenceIdQuery
  20. def eventsByPersistenceIdTyped[Event](persistenceId: String, fromSequenceNr: Long, toSequenceNr: Long): Source[EventEnvelope[Event], NotUsed]

    Query events for a specific PersistentActor identified by persistenceId.

    Query events for a specific PersistentActor identified by persistenceId.

    You can retrieve a subset of all events by specifying fromSequenceNr and toSequenceNr or use 0L and Long.MaxValue respectively to retrieve all events. The query will return all the events inclusive of the fromSequenceNr and toSequenceNr values.

    The returned event stream should be ordered by sequence number.

    The stream is not completed when it reaches the end of the currently stored events, but it continues to push new events when new events are persisted. Corresponding query that is completed when it reaches the end of the currently stored events is provided by CurrentEventsByPersistenceIdTypedQuery#currentEventsByPersistenceIdTyped.

    This is a new version of the akka.persistence.query.scaladsl.CurrentEventsByPersistenceIdQuery#currentEventsByPersistenceId using a new envelope type akka.persistence.query.typed.EventEnvelope.

    Event

    the type of the event payload

    Definition Classes
    PersistenceTestKitReadJournalEventsByPersistenceIdTypedQuery
  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. def sliceForPersistenceId(persistenceId: String): Int
  28. def sliceRanges(numberOfRanges: Int): Seq[Range]
  29. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  30. def toString(): String
    Definition Classes
    AnyRef → Any
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  33. 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
    Deprecated
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from PersistenceTestKitReadJournal toStringFormat[PersistenceTestKitReadJournal] 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): (PersistenceTestKitReadJournal, B)
    Implicit
    This member is added by an implicit conversion from PersistenceTestKitReadJournal toArrowAssoc[PersistenceTestKitReadJournal] 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 ReadJournal

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromPersistenceTestKitReadJournal to any2stringadd[PersistenceTestKitReadJournal]

Inherited by implicit conversion StringFormat fromPersistenceTestKitReadJournal to StringFormat[PersistenceTestKitReadJournal]

Inherited by implicit conversion Ensuring fromPersistenceTestKitReadJournal to Ensuring[PersistenceTestKitReadJournal]

Inherited by implicit conversion ArrowAssoc fromPersistenceTestKitReadJournal to ArrowAssoc[PersistenceTestKitReadJournal]

Ungrouped