JdbcReadJournal

org.apache.pekko.persistence.jdbc.query.javadsl.JdbcReadJournal
See theJdbcReadJournal companion object
class JdbcReadJournal(journal: JdbcReadJournal) extends ReadJournal, CurrentPersistenceIdsQuery, PersistenceIdsQuery, CurrentEventsByPersistenceIdQuery, EventsByPersistenceIdQuery, CurrentEventsByTagQuery, EventsByTagQuery

Attributes

Companion
object
Source
JdbcReadJournal.scala
Graph
Supertypes
trait EventsByTagQuery
trait CurrentEventsByTagQuery
trait EventsByPersistenceIdQuery
trait CurrentEventsByPersistenceIdQuery
trait PersistenceIdsQuery
trait CurrentPersistenceIdsQuery
trait ReadJournal
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

override def currentEventsByPersistenceId(persistenceId: String, fromSequenceNr: Long, toSequenceNr: Long): Source[EventEnvelope, NotUsed]

Same type of query as eventsByPersistenceId 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.

Same type of query as eventsByPersistenceId 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.

Attributes

Definition Classes
CurrentEventsByPersistenceIdQuery
Source
JdbcReadJournal.scala
override def currentEventsByTag(tag: String, offset: Offset): Source[EventEnvelope, NotUsed]

Same type of query as eventsByTag 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.

Same type of query as eventsByTag 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.

Attributes

Definition Classes
CurrentEventsByTagQuery
Source
JdbcReadJournal.scala
def currentLastSequenceNumberByPersistenceId(persistenceId: String): CompletionStage[Optional[Long]]

Returns the last known sequence number for the given persistenceId. Empty if the persistenceId is unknown.

Returns the last known sequence number for the given persistenceId. Empty if the persistenceId is unknown.

Value parameters

persistenceId

The persistenceId for which the last known sequence number should be returned.

Attributes

Returns

Some sequence number or None if the persistenceId is unknown.

Source
JdbcReadJournal.scala
override def currentPersistenceIds(): Source[String, NotUsed]

Same type of query as persistenceIds 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.

Same type of query as persistenceIds 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.

Attributes

Definition Classes
CurrentPersistenceIdsQuery
Source
JdbcReadJournal.scala
override def eventsByPersistenceId(persistenceId: String, fromSequenceNr: Long, toSequenceNr: Long): Source[EventEnvelope, NotUsed]

eventsByPersistenceId is used to retrieve a stream of events for a particular persistenceId.

eventsByPersistenceId is used to retrieve a stream of events for a particular persistenceId.

The EventEnvelope contains the event and 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.

fromSequenceNr and toSequenceNr can be specified to limit the set of returned events. The fromSequenceNr and toSequenceNr are inclusive.

The EventEnvelope also provides the offset that corresponds to the ordering column in the Journal table. The ordering is a sequential id number that uniquely identifies the position of each event, also across different persistenceId. The Offset type is org.apache.pekko.persistence.query.Sequence with the ordering as the offset value. This is the same ordering number as is used in the offset of the eventsByTag query.

The returned event stream is ordered by sequenceNr.

Causality is guaranteed (sequenceNrs of events for a particular persistenceId are always ordered in a sequence monotonically increasing by one). Multiple executions of the same bounded stream are guaranteed to emit exactly the same stream of events.

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.

Attributes

Definition Classes
EventsByPersistenceIdQuery
Source
JdbcReadJournal.scala
override def eventsByTag(tag: String, offset: Offset): Source[EventEnvelope, NotUsed]

Query events that have a specific tag.

Query events that have a specific tag.

The consumer can keep track of its current position in the event stream by storing the offset and restart the query from a given offset after a crash/restart. The offset is exclusive, i.e. the event corresponding to the given offset parameter is not included in the stream.

For pekko-persistence-jdbc the offset corresponds to the ordering column in the Journal table. The ordering is a sequential id number that uniquely identifies the position of each event within the event stream. The Offset type is org.apache.pekko.persistence.query.Sequence with the ordering as the offset value.

The returned event stream is ordered by offset.

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 CurrentEventsByTagQuery#currentEventsByTag.

Attributes

Definition Classes
EventsByTagQuery
Source
JdbcReadJournal.scala
override def persistenceIds(): Source[String, NotUsed]

persistenceIds is used to retrieve a stream of all persistenceIds as strings.

persistenceIds is used to retrieve a stream of all persistenceIds as strings.

The stream guarantees that a persistenceId is only emitted once and there are no duplicates. Order is not defined. Multiple executions of the same stream (even bounded) may emit different sequence of persistenceIds.

The stream is not completed when it reaches the end of the currently known persistenceIds, but it continues to push new persistenceIds when new events are persisted. Corresponding query that is completed when it reaches the end of the currently known persistenceIds is provided by currentPersistenceIds.

Attributes

Definition Classes
PersistenceIdsQuery
Source
JdbcReadJournal.scala