Click or drag to resize
Akka.NETSqlReadJournal Methods

The SqlReadJournal type exposes the following members.

Methods
  NameDescription
Public methodAllPersistenceIds

AllPersistenceIds is used for retrieving all `persistenceIds` of all persistent actors.

The returned event stream is unordered and you can expect different order for multiple executions of the query.

The stream is not completed when it reaches the end of the currently used `persistenceIds`, but it continues to push new `persistenceIds` when new persistent actors are created. Corresponding query that is completed when it reaches the end of the currently currently used `persistenceIds` is provided by CurrentPersistenceIds.

The SQL write journal is notifying the query side as soon as new `persistenceIds` are created and there is no periodic polling or batching involved in this query.

The stream is completed with failure if there is a failure in executing the query in the backend journal.

Public methodCurrentEventsByPersistenceId
Same type of query as EventsByPersistenceId(String, Int64, Int64) 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.
Public methodCurrentEventsByTag
Same type of query as EventsByTag(String, Int64) 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.
Public methodCurrentPersistenceIds
Same type of query as AllPersistenceIds but the stream is completed immediately when it reaches the end of the "result set". Persistent actors that are created after the query is completed are not included in the stream.
Public methodStatic memberDefaultConfiguration
Returns a default query configuration for akka persistence SQLite-based journals and snapshot stores.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodEventsByPersistenceId
EventsByPersistenceId(String, Int64, Int64) is used for retrieving 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 MaxValue respectively to retrieve all events. Note that the corresponding sequence number of each event is provided in the EventEnvelope, which makes it possible to resume the stream at a later point from a given sequence number.

The returned event stream is ordered by sequence number, i.e. the same order as the PersistentActor persisted the events. The same prefix of stream elements (in same order) are returned for multiple executions of the query, except for when events have been deleted.

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 CurrentEventsByPersistenceId(String, Int64, Int64).

The SQLite write journal is notifying the query side as soon as events are persisted, but for efficiency reasons the query side retrieves the events in batches that sometimes can be delayed up to the configured `refresh-interval`.

The stream is completed with failure if there is a failure in executing the query in the backend journal.

Public methodEventsByTag
EventsByTag(String, Int64) is used for retrieving events that were marked with a given tag, e.g. all events of an Aggregate Root type.

To tag events you create an IEventAdapter that wraps the events in a Tagged with the given `tags`.

You can retrieve a subset of all events by specifying offset, or use `0L` to retrieve all events with a given tag. The offset corresponds to an ordered sequence number for the specific tag. 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.

In addition to the offset the EventEnvelope also provides `persistenceId` and `sequenceNr` for each event. The `sequenceNr` is the sequence number for the persistent actor with the `persistenceId` that persisted the event. The `persistenceId` + `sequenceNr` is an unique identifier for the event.

The returned event stream is ordered by the offset (tag sequence number), which corresponds to the same order as the write journal stored the events. The same stream elements (in same order) are returned for multiple executions of the query. Deleted events are not deleted from the tagged event stream.

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 CurrentEventsByTag(String, Int64).

The SQL write journal is notifying the query side as soon as tagged events are persisted, but for efficiency reasons the query side retrieves the events in batches that sometimes can be delayed up to the configured `refresh-interval`.

The stream is completed with failure if there is a failure in executing the query in the backend journal.

Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Extension Methods
See Also