Class PersistenceTestKitReadJournal
- java.lang.Object
-
- akka.persistence.testkit.query.scaladsl.PersistenceTestKitReadJournal
-
- All Implemented Interfaces:
CurrentEventsByPersistenceIdQuery
,CurrentEventsByTagQuery
,EventsByPersistenceIdQuery
,PagedPersistenceIdsQuery
,ReadJournal
,CurrentEventsByPersistenceIdTypedQuery
,CurrentEventsBySliceQuery
,EventsByPersistenceIdTypedQuery
public final class PersistenceTestKitReadJournal extends java.lang.Object implements ReadJournal, EventsByPersistenceIdQuery, EventsByPersistenceIdTypedQuery, CurrentEventsByPersistenceIdQuery, CurrentEventsByPersistenceIdTypedQuery, CurrentEventsByTagQuery, CurrentEventsBySliceQuery, PagedPersistenceIdsQuery
-
-
Constructor Summary
Constructors Constructor Description PersistenceTestKitReadJournal(ExtendedActorSystem system, com.typesafe.config.Config config, java.lang.String configPath)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Source<EventEnvelope,NotUsed>
currentEventsByPersistenceId(java.lang.String persistenceId, long fromSequenceNr, long toSequenceNr)
Same type of query asEventsByPersistenceIdQuery.eventsByPersistenceId(java.lang.String, long, long)
but the event stream is completed immediately when it reaches the end of the "result set".long
currentEventsByPersistenceId$default$2()
long
currentEventsByPersistenceId$default$3()
<Event> Source<EventEnvelope<Event>,NotUsed>
currentEventsByPersistenceIdTyped(java.lang.String persistenceId, long fromSequenceNr, long toSequenceNr)
Same type of query asEventsByPersistenceIdTypedQuery.eventsByPersistenceIdTyped(java.lang.String, long, long)
but the event stream is completed immediately when it reaches the end of the "result set".<Event> Source<EventEnvelope<Event>,NotUsed>
currentEventsBySlices(java.lang.String entityType, int minSlice, int maxSlice, Offset offset)
Same type of query asEventsBySliceQuery.eventsBySlices
but the event stream is completed immediately when it reaches the end of the "result set".Source<EventEnvelope,NotUsed>
currentEventsByTag(java.lang.String tag, Offset offset)
Same type of query asEventsByTagQuery.eventsByTag(java.lang.String, akka.persistence.query.Offset)
but the event stream is completed immediately when it reaches the end of the "result set".Offset
currentEventsByTag$default$2()
Source<java.lang.String,NotUsed>
currentPersistenceIds(scala.Option<java.lang.String> afterId, long limit)
Get the current persistence ids.Source<EventEnvelope,NotUsed>
eventsByPersistenceId(java.lang.String persistenceId, long fromSequenceNr, long toSequenceNr)
Query events for a specificPersistentActor
identified bypersistenceId
.long
eventsByPersistenceId$default$2()
long
eventsByPersistenceId$default$3()
<Event> Source<EventEnvelope<Event>,NotUsed>
eventsByPersistenceIdTyped(java.lang.String persistenceId, long fromSequenceNr, long toSequenceNr)
Query events for a specificPersistentActor
identified bypersistenceId
.static java.lang.String
Identifier()
int
sliceForPersistenceId(java.lang.String persistenceId)
scala.collection.immutable.Seq<scala.collection.immutable.Range>
sliceRanges(int numberOfRanges)
-
-
-
Constructor Detail
-
PersistenceTestKitReadJournal
public PersistenceTestKitReadJournal(ExtendedActorSystem system, com.typesafe.config.Config config, java.lang.String configPath)
-
-
Method Detail
-
Identifier
public static java.lang.String Identifier()
-
eventsByPersistenceId
public Source<EventEnvelope,NotUsed> eventsByPersistenceId(java.lang.String persistenceId, long fromSequenceNr, long toSequenceNr)
Description copied from interface:EventsByPersistenceIdQuery
Query events for a specificPersistentActor
identified bypersistenceId
.You can retrieve a subset of all events by specifying
fromSequenceNr
andtoSequenceNr
or use0L
andLong.MaxValue
respectively to retrieve all events. The query will return all the events inclusive of thefromSequenceNr
andtoSequenceNr
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(java.lang.String, long, long)
.- Specified by:
eventsByPersistenceId
in interfaceEventsByPersistenceIdQuery
-
eventsByPersistenceId$default$2
public long eventsByPersistenceId$default$2()
-
eventsByPersistenceId$default$3
public long eventsByPersistenceId$default$3()
-
eventsByPersistenceIdTyped
public <Event> Source<EventEnvelope<Event>,NotUsed> eventsByPersistenceIdTyped(java.lang.String persistenceId, long fromSequenceNr, long toSequenceNr)
Description copied from interface:EventsByPersistenceIdTypedQuery
Query events for a specificPersistentActor
identified bypersistenceId
.You can retrieve a subset of all events by specifying
fromSequenceNr
andtoSequenceNr
or use0L
andLong.MaxValue
respectively to retrieve all events. The query will return all the events inclusive of thefromSequenceNr
andtoSequenceNr
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(java.lang.String, long, long)
.This is a new version of the
CurrentEventsByPersistenceIdQuery.currentEventsByPersistenceId(java.lang.String, long, long)
using a new envelope typeEventEnvelope
.- Specified by:
eventsByPersistenceIdTyped
in interfaceEventsByPersistenceIdTypedQuery
-
currentEventsByPersistenceId
public Source<EventEnvelope,NotUsed> currentEventsByPersistenceId(java.lang.String persistenceId, long fromSequenceNr, long toSequenceNr)
Description copied from interface:CurrentEventsByPersistenceIdQuery
Same type of query asEventsByPersistenceIdQuery.eventsByPersistenceId(java.lang.String, long, long)
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.- Specified by:
currentEventsByPersistenceId
in interfaceCurrentEventsByPersistenceIdQuery
-
currentEventsByPersistenceId$default$2
public long currentEventsByPersistenceId$default$2()
-
currentEventsByPersistenceId$default$3
public long currentEventsByPersistenceId$default$3()
-
currentEventsByPersistenceIdTyped
public <Event> Source<EventEnvelope<Event>,NotUsed> currentEventsByPersistenceIdTyped(java.lang.String persistenceId, long fromSequenceNr, long toSequenceNr)
Description copied from interface:CurrentEventsByPersistenceIdTypedQuery
Same type of query asEventsByPersistenceIdTypedQuery.eventsByPersistenceIdTyped(java.lang.String, long, long)
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 typeEventEnvelope
.- Specified by:
currentEventsByPersistenceIdTyped
in interfaceCurrentEventsByPersistenceIdTypedQuery
-
currentEventsByTag
public Source<EventEnvelope,NotUsed> currentEventsByTag(java.lang.String tag, Offset offset)
Description copied from interface:CurrentEventsByTagQuery
Same type of query asEventsByTagQuery.eventsByTag(java.lang.String, akka.persistence.query.Offset)
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.- Specified by:
currentEventsByTag
in interfaceCurrentEventsByTagQuery
-
currentEventsByTag$default$2
public Offset currentEventsByTag$default$2()
-
currentEventsBySlices
public <Event> Source<EventEnvelope<Event>,NotUsed> currentEventsBySlices(java.lang.String entityType, int minSlice, int maxSlice, Offset offset)
Description copied from interface:CurrentEventsBySliceQuery
Same type of query asEventsBySliceQuery.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.- Specified by:
currentEventsBySlices
in interfaceCurrentEventsBySliceQuery
-
sliceForPersistenceId
public int sliceForPersistenceId(java.lang.String persistenceId)
- Specified by:
sliceForPersistenceId
in interfaceCurrentEventsBySliceQuery
-
sliceRanges
public scala.collection.immutable.Seq<scala.collection.immutable.Range> sliceRanges(int numberOfRanges)
- Specified by:
sliceRanges
in interfaceCurrentEventsBySliceQuery
-
currentPersistenceIds
public Source<java.lang.String,NotUsed> currentPersistenceIds(scala.Option<java.lang.String> afterId, long limit)
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.
- Specified by:
currentPersistenceIds
in interfacePagedPersistenceIdsQuery
- Parameters:
afterId
- The ID to start returning results from, orNone
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.
-
-