Packages

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

Source
PersistenceTestKitReadJournal.scala
Linear Supertypes
PagedPersistenceIdsQuery, CurrentEventsBySliceQuery, CurrentEventsByTagQuery, CurrentEventsByPersistenceIdQuery, EventsByPersistenceIdQuery, ReadJournal, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PersistenceTestKitReadJournal
  2. PagedPersistenceIdsQuery
  3. CurrentEventsBySliceQuery
  4. CurrentEventsByTagQuery
  5. CurrentEventsByPersistenceIdQuery
  6. EventsByPersistenceIdQuery
  7. ReadJournal
  8. AnyRef
  9. 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. 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
  2. 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
  3. 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
  4. 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
  5. 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
    PersistenceTestKitReadJournal → EventsByPersistenceIdQuery
  6. def sliceForPersistenceId(persistenceId: String): Int
    Definition Classes
    PersistenceTestKitReadJournal → CurrentEventsBySliceQuery
  7. def sliceRanges(numberOfRanges: Int): Seq[Range]
    Definition Classes
    PersistenceTestKitReadJournal → CurrentEventsBySliceQuery