Namespace Akka.Persistence.Query
Classes
EventEnvelope
Event wrapper adding meta data for the events in the result stream of IEventsByTagQuery query, or similar queries.
The Timestamp is the time the event was stored, in ticks. The value of this property
represents the number of 100-nanosecond intervals that have elapsed since 12:00:00 midnight, January 1, 0001
in the Gregorian calendar (same as DateTime.Now.Ticks).
NoOffset
Used when retrieving all events.
Offset
Used in IEventsByTagQuery implementations to signal to Akka.Persistence.Query where to begin and end event by tag queries.
For concrete implementations, see Sequence(Int64) and NoOffset().
PersistenceQuery
PersistenceQueryExtensions
PersistenceQueryProvider
Sequence
Corresponds to an ordered sequence number for the events.Note that the corresponding offset of each event is provided in the EventEnvelope, which makes it possible to resume the stream at a later point from a given offset.
The offset is exclusive, i.e.the event with the exact same sequence number will not be included
in the returned stream. This means that you can use the offset that is returned in EventEnvelope
as the offset parameter in a subsequent query.
TimeBasedUuid
Corresponds to an ordered unique identifier of the events. Note that the corresponding offset of each event is provided in the EventEnvelope, which makes it possible to resume the stream at a later point from a given offset.
The offset is exclusive, i.e. the event with the exact same sequence number will not be included
in the returned stream. This means that you can use the offset that is returned in EventEnvelope
as the offset parameter in a subsequent query.
Interfaces
IAllEventsQuery
ICurrentAllEventsQuery
ICurrentEventsByPersistenceIdQuery
A plugin may optionally support this query by implementing this trait.
ICurrentEventsByTagQuery
A plugin may optionally support this query by implementing this trait.
ICurrentPersistenceIdsQuery
A plugin may optionally support this query by implementing this trait.
IEventsByPersistenceIdQuery
A plugin may optionally support this query by implementing this trait.
IEventsByTagQuery
A plugin may optionally support this query by implementing this trait.
IPersistenceIdsQuery
IReadJournal
API for reading persistent events and information derived from stored persistent events.
The purpose of the API is not to enforce compatibility between different journal implementations, because the technical capabilities may be very different. The interface is very open so that different journals may implement specific queries.
There are a few pre-defined queries that a query implementation may implement, such as IEventsByPersistenceIdQuery, IPersistenceIdsQuery and IEventsByTagQuery Implementation of these queries are optional and query (journal) plugins may define their own specialized queries by implementing other methods.IReadJournalProvider
A query plugin must implement a class that implements this interface. A read journal plugin must provide implementations for IReadJournal.