Packages

class JdbcReadJournal extends ReadJournal with CurrentPersistenceIdsQuery with PersistenceIdsQuery with CurrentEventsByPersistenceIdQuery with EventsByPersistenceIdQuery with CurrentEventsByTagQuery with EventsByTagQuery

Source
JdbcReadJournal.scala
Linear Supertypes
EventsByTagQuery, CurrentEventsByTagQuery, EventsByPersistenceIdQuery, CurrentEventsByPersistenceIdQuery, PersistenceIdsQuery, CurrentPersistenceIdsQuery, ReadJournal, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JdbcReadJournal
  2. EventsByTagQuery
  3. CurrentEventsByTagQuery
  4. EventsByPersistenceIdQuery
  5. CurrentEventsByPersistenceIdQuery
  6. PersistenceIdsQuery
  7. CurrentPersistenceIdsQuery
  8. ReadJournal
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new JdbcReadJournal(config: Config, configPath: String)(implicit system: ExtendedActorSystem)

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]) @HotSpotIntrinsicCandidate() @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: Long): Source[EventEnvelope, NotUsed]
  8. 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
  9. 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
  10. implicit val ec: ExecutionContext
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. 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 akka.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
  14. def eventsByTag(tag: String, offset: Long): Source[EventEnvelope, NotUsed]
  15. 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 akka-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 akka.persistence.query.Sequence with the ordering as the offset value.

    The returned event stream is ordered by 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 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
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. implicit val mat: Materializer
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  23. 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
  24. val readJournalConfig: ReadJournalConfig
  25. val readJournalDao: ReadJournalDao
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. implicit val system: ExtendedActorSystem
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from EventsByTagQuery

Inherited from CurrentEventsByTagQuery

Inherited from EventsByPersistenceIdQuery

Inherited from CurrentEventsByPersistenceIdQuery

Inherited from PersistenceIdsQuery

Inherited from CurrentPersistenceIdsQuery

Inherited from ReadJournal

Inherited from AnyRef

Inherited from Any

Ungrouped