Package org.apache.pekko.persistence.query.javadsl

Interface EventsByPersistenceIdQuery

All Superinterfaces:

ReadJournal

All Known Implementing Classes:

LeveldbReadJournal, PersistenceTestKitReadJournal

public interface EventsByPersistenceIdQuery
extends ReadJournal

A plugin may optionally support this query by implementing this interface.

Method Summary

Modifier and Type	Method	Description
Source<EventEnvelope,NotUsed>	eventsByPersistenceId(String persistenceId, long fromSequenceNr, long toSequenceNr)	Query events for a specific PersistentActor identified by persistenceId.

Method Details

eventsByPersistenceId

Source<EventEnvelope,NotUsed> eventsByPersistenceId(String persistenceId,
 long fromSequenceNr,
 long toSequenceNr)

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.MAX_VALUE 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 pekko.persistence.query.javadsl.CurrentEventsByPersistenceIdQuery#currentEventsByPersistenceId.