Click or drag to resize
Akka.NETAkka.Persistence.Query Namespace
TBD
Classes
  ClassDescription
Public classEventEnvelope
Event wrapper adding meta data for the events in the result stream of IEventsByTagQuery query, or similar queries.
Public classPersistenceQuery
Public classPersistenceQueryExtensions
Public classPersistenceQueryProvider
Interfaces
  InterfaceDescription
Public interfaceIAllPersistenceIdsQuery
Public interfaceICurrentEventsByPersistenceIdQuery
A plugin may optionally support this query by implementing this trait.
Public interfaceICurrentEventsByTagQuery
A plugin may optionally support this query by implementing this trait.
Public interfaceICurrentPersistenceIdsQuery
A plugin may optionally support this query by implementing this trait.
Public interfaceIEventsByPersistenceIdQuery
A plugin may optionally support this query by implementing this trait.
Public interfaceIEventsByTagQuery
A plugin may optionally support this query by implementing this trait.
Public interfaceCode exampleIReadJournal
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, IAllPersistenceIdsQuery and IEventsByTagQuery Implementation of these queries are optional and query (journal) plugins may define their own specialized queries by implementing other methods.
Examples
var journal = PersistenceQuery.Get(system).ReadJournalFor<SomeCoolReadJournal>(queryPluginConfigPath) var events = journal.Query(new EventsByTag("mytag", 0L))
Public interfaceIReadJournalProvider
A query plugin must implement a class that implements this interface. A read journal plugin must provide implementations for IReadJournal.