Packages

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

Scala API akka.persistence.query.scaladsl.ReadJournal implementation for LevelDB.

It is retrieved with:

val queries = PersistenceQuery(system).readJournalFor[LeveldbReadJournal](LeveldbReadJournal.Identifier)

Corresponding Java API is in akka.persistence.query.journal.leveldb.javadsl.LeveldbReadJournal.

Configuration settings can be defined in the configuration section with the absolute path corresponding to the identifier, which is "akka.persistence.query.journal.leveldb" for the default LeveldbReadJournal#Identifier. See reference.conf.

Annotations
@deprecated
Deprecated

(Since version 2.6.15) Use another journal implementation

Source
LeveldbReadJournal.scala
Linear Supertypes
CurrentEventsByTagQuery, EventsByTagQuery, CurrentEventsByPersistenceIdQuery, EventsByPersistenceIdQuery, CurrentPersistenceIdsQuery, PersistenceIdsQuery, ReadJournal, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LeveldbReadJournal
  2. CurrentEventsByTagQuery
  3. EventsByTagQuery
  4. CurrentEventsByPersistenceIdQuery
  5. EventsByPersistenceIdQuery
  6. CurrentPersistenceIdsQuery
  7. PersistenceIdsQuery
  8. ReadJournal
  9. AnyRef
  10. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new LeveldbReadJournal(system: ExtendedActorSystem, config: Config)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from LeveldbReadJournal toany2stringadd[LeveldbReadJournal] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (LeveldbReadJournal, B)
    Implicit
    This member is added by an implicit conversion from LeveldbReadJournal toArrowAssoc[LeveldbReadJournal] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. def currentEventsByPersistenceId(persistenceId: String, fromSequenceNr: Long = 0L, toSequenceNr: Long = Long.MaxValue): 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
    LeveldbReadJournal → CurrentEventsByPersistenceIdQuery
  9. def currentEventsByTag(tag: String, offset: Offset = Sequence(0L)): 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
    LeveldbReadJournal → CurrentEventsByTagQuery
  10. def currentPersistenceIds(): Source[String, NotUsed]

    Same type of query as #persistenceIds but the stream is completed immediately when it reaches the end of the "result set".

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

    Definition Classes
    LeveldbReadJournal → CurrentPersistenceIdsQuery
  11. def ensuring(cond: (LeveldbReadJournal) => Boolean, msg: => Any): LeveldbReadJournal
    Implicit
    This member is added by an implicit conversion from LeveldbReadJournal toEnsuring[LeveldbReadJournal] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (LeveldbReadJournal) => Boolean): LeveldbReadJournal
    Implicit
    This member is added by an implicit conversion from LeveldbReadJournal toEnsuring[LeveldbReadJournal] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: => Any): LeveldbReadJournal
    Implicit
    This member is added by an implicit conversion from LeveldbReadJournal toEnsuring[LeveldbReadJournal] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): LeveldbReadJournal
    Implicit
    This member is added by an implicit conversion from LeveldbReadJournal toEnsuring[LeveldbReadJournal] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  17. def eventsByPersistenceId(persistenceId: String, fromSequenceNr: Long = 0L, toSequenceNr: Long = Long.MaxValue): Source[EventEnvelope, NotUsed]

    eventsByPersistenceId is used for retrieving events for a specific PersistentActor identified by persistenceId.

    eventsByPersistenceId 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 Long.MaxValue respectively to retrieve all events. Note that the corresponding sequence number of each event is provided in the akka.persistence.query.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.

    The LevelDB 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.

    Definition Classes
    LeveldbReadJournal → EventsByPersistenceIdQuery
  18. def eventsByTag(tag: String, offset: Offset = Sequence(0L)): Source[EventEnvelope, NotUsed]

    eventsByTag is used for retrieving events that were marked with a given tag, e.g.

    eventsByTag 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 akka.persistence.journal.EventAdapter that wraps the events in a akka.persistence.journal.Tagged with the given tags.

    You can use NoOffset to retrieve all events with a given tag or retrieve a subset of all events by specifying a Sequence offset. The offset corresponds to an ordered sequence number for the specific tag. Note that the corresponding offset of each event is provided in the akka.persistence.query.EventEnvelope, which makes it possible to resume the stream at a later point from a given offset.

    The offset is exclusive, i.e. the event with the exact same sequence number will not be included in the returned stream. This means that you can use the offset that is returned in EventEnvelope as the offset parameter in a subsequent query.

    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.

    The LevelDB 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.

    Definition Classes
    LeveldbReadJournal → EventsByTagQuery
  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  25. def persistenceIds(): Source[String, NotUsed]

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

    persistenceIds 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 LevelDB 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.

    Definition Classes
    LeveldbReadJournal → PersistenceIdsQuery
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    AnyRef → Any
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  30. 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)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from LeveldbReadJournal toStringFormat[LeveldbReadJournal] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (LeveldbReadJournal, B)
    Implicit
    This member is added by an implicit conversion from LeveldbReadJournal toArrowAssoc[LeveldbReadJournal] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from CurrentEventsByTagQuery

Inherited from EventsByTagQuery

Inherited from CurrentEventsByPersistenceIdQuery

Inherited from EventsByPersistenceIdQuery

Inherited from CurrentPersistenceIdsQuery

Inherited from PersistenceIdsQuery

Inherited from ReadJournal

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromLeveldbReadJournal to any2stringadd[LeveldbReadJournal]

Inherited by implicit conversion StringFormat fromLeveldbReadJournal to StringFormat[LeveldbReadJournal]

Inherited by implicit conversion Ensuring fromLeveldbReadJournal to Ensuring[LeveldbReadJournal]

Inherited by implicit conversion ArrowAssoc fromLeveldbReadJournal to ArrowAssoc[LeveldbReadJournal]

Ungrouped