akka.persistence.testkit.query.scaladsl
PersistenceTestKitReadJournal
Companion object PersistenceTestKitReadJournal
final class PersistenceTestKitReadJournal extends ReadJournal with EventsByPersistenceIdQuery with EventsByPersistenceIdTypedQuery with CurrentEventsByPersistenceIdQuery with CurrentEventsByPersistenceIdTypedQuery with CurrentEventsByTagQuery with CurrentEventsBySliceQuery with PagedPersistenceIdsQuery
- Alphabetic
- By Inheritance
- PersistenceTestKitReadJournal
- PagedPersistenceIdsQuery
- CurrentEventsBySliceQuery
- CurrentEventsByTagQuery
- CurrentEventsByPersistenceIdTypedQuery
- CurrentEventsByPersistenceIdQuery
- EventsByPersistenceIdTypedQuery
- EventsByPersistenceIdQuery
- ReadJournal
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new PersistenceTestKitReadJournal(system: ExtendedActorSystem, config: Config, configPath: String)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- 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
- 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()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- 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
- PersistenceTestKitReadJournal → CurrentEventsByPersistenceIdQuery
- 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
- PersistenceTestKitReadJournal → CurrentEventsByPersistenceIdTypedQuery
- 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
- PersistenceTestKitReadJournal → CurrentEventsBySliceQuery
- 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
- PersistenceTestKitReadJournal → CurrentEventsByTagQuery
- 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
- PersistenceTestKitReadJournal → PagedPersistenceIdsQuery
- 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
- 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
- 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
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def eventsByPersistenceId(persistenceId: String, fromSequenceNr: Long = 0, toSequenceNr: Long = Long.MaxValue): Source[EventEnvelope, NotUsed]
Query events for a specific
PersistentActoridentified bypersistenceId.Query events for a specific
PersistentActoridentified bypersistenceId.You can retrieve a subset of all events by specifying
fromSequenceNrandtoSequenceNror use0LandLong.MaxValuerespectively to retrieve all events. The query will return all the events inclusive of thefromSequenceNrandtoSequenceNrvalues.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
- PersistenceTestKitReadJournal → EventsByPersistenceIdQuery
- def eventsByPersistenceIdTyped[Event](persistenceId: String, fromSequenceNr: Long, toSequenceNr: Long): Source[EventEnvelope[Event], NotUsed]
Query events for a specific
PersistentActoridentified bypersistenceId.Query events for a specific
PersistentActoridentified bypersistenceId.You can retrieve a subset of all events by specifying
fromSequenceNrandtoSequenceNror use0LandLong.MaxValuerespectively to retrieve all events. The query will return all the events inclusive of thefromSequenceNrandtoSequenceNrvalues.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
- PersistenceTestKitReadJournal → EventsByPersistenceIdTypedQuery
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def sliceForPersistenceId(persistenceId: String): Int
- Definition Classes
- PersistenceTestKitReadJournal → CurrentEventsBySliceQuery
- def sliceRanges(numberOfRanges: Int): Seq[Range]
- Definition Classes
- PersistenceTestKitReadJournal → CurrentEventsBySliceQuery
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- 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 ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- 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.