Value Members

1.  final def !=(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

2.  final def ##: Int

   Definition Classes

   AnyRef → Any

3.  final def ==(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

4.  final def asInstanceOf[T0]: T0

   Definition Classes

   Any

5.  def clone(): AnyRef

   Attributes

   protected[lang]

   Definition Classes

   AnyRef

   Annotations

   @throws(classOf[java.lang.CloneNotSupportedException]) @native()

6.  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".

   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.

   Definition Classes

   JdbcReadJournal → CurrentEventsByPersistenceIdQuery

7.  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".

   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.

   Definition Classes

   JdbcReadJournal → CurrentEventsByTagQuery

8.  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".

   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.

   Definition Classes

   JdbcReadJournal → CurrentPersistenceIdsQuery

9.  final def eq(arg0: AnyRef): Boolean

   Definition Classes

   AnyRef

10.  def equals(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef → Any

11.  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.

    Definition Classes

    JdbcReadJournal → EventsByPersistenceIdQuery

12.  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.

    Definition Classes

    JdbcReadJournal → EventsByTagQuery

13.  def finalize(): Unit

    Attributes

    protected[lang]

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.Throwable])

14.  final def getClass(): Class[_ <: AnyRef]

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

15.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

16.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

17.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

18.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

19.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

20.  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.

    Definition Classes

    JdbcReadJournal → PersistenceIdsQuery

21.  final def synchronized[T0](arg0: => T0): T0

    Definition Classes

    AnyRef

22.  def toString(): String

    Definition Classes

    AnyRef → Any

23.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException])

24.  final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException])

25.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException]) @native()