Packages

class LeveldbReadJournal extends ReadJournal with AllPersistenceIdsQuery with CurrentPersistenceIdsQuery with EventsByPersistenceIdQuery with CurrentEventsByPersistenceIdQuery with EventsByTagQuery with EventsByTagQuery2 with CurrentEventsByTagQuery with CurrentEventsByTagQuery2

Java API: akka.persistence.query.javadsl.ReadJournal implementation for LevelDB.

It is retrieved with:

LeveldbReadJournal queries =
  PersistenceQuery.get(system).getReadJournalFor(LeveldbReadJournal.class, LeveldbReadJournal.Identifier());

Corresponding Scala 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.

Source
LeveldbReadJournal.scala
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LeveldbReadJournal
  2. CurrentEventsByTagQuery2
  3. CurrentEventsByTagQuery
  4. EventsByTagQuery2
  5. EventsByTagQuery
  6. CurrentEventsByPersistenceIdQuery
  7. EventsByPersistenceIdQuery
  8. CurrentPersistenceIdsQuery
  9. AllPersistenceIdsQuery
  10. ReadJournal
  11. AnyRef
  12. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new LeveldbReadJournal(scaladslReadJournal: scaladsl.LeveldbReadJournal)

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 to any2stringadd[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 to ArrowAssoc[LeveldbReadJournal] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def allPersistenceIds(): Source[String, NotUsed]

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

    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 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
    LeveldbReadJournalAllPersistenceIdsQuery
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. 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
    LeveldbReadJournalCurrentEventsByPersistenceIdQuery
  10. def currentEventsByTag(tag: String, offset: Long): Source[EventEnvelope, NotUsed]

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

    Same type of query as EventsByTagQuery#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
    LeveldbReadJournalCurrentEventsByTagQuery
  11. def currentEventsByTag(tag: String, offset: Offset): Source[EventEnvelope2, 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
    LeveldbReadJournalCurrentEventsByTagQuery2
  12. def currentPersistenceIds(): Source[String, NotUsed]

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

    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.

    Definition Classes
    LeveldbReadJournalCurrentPersistenceIdsQuery
  13. def ensuring(cond: (LeveldbReadJournal) ⇒ Boolean, msg: ⇒ Any): LeveldbReadJournal
    Implicit
    This member is added by an implicit conversion from LeveldbReadJournal to Ensuring[LeveldbReadJournal] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: (LeveldbReadJournal) ⇒ Boolean): LeveldbReadJournal
    Implicit
    This member is added by an implicit conversion from LeveldbReadJournal to Ensuring[LeveldbReadJournal] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean, msg: ⇒ Any): LeveldbReadJournal
    Implicit
    This member is added by an implicit conversion from LeveldbReadJournal to Ensuring[LeveldbReadJournal] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean): LeveldbReadJournal
    Implicit
    This member is added by an implicit conversion from LeveldbReadJournal to Ensuring[LeveldbReadJournal] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  19. def eventsByPersistenceId(persistenceId: String, fromSequenceNr: Long, toSequenceNr: Long): 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
    LeveldbReadJournalEventsByPersistenceIdQuery
  20. def eventsByTag(tag: String, offset: Long): Source[EventEnvelope, NotUsed]

    Query events that have a specific tag.

    Query events that have a specific tag. A tag can for example correspond to an aggregate root type (in DDD terminology).

    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 exact meaning of the offset depends on the journal and must be documented by the read journal plugin. It may be a sequential id number that uniquely identifies the position of each event within the event stream. Distributed data stores cannot easily support those semantics and they may use a weaker meaning. For example it may be a timestamp (taken when the event was created or stored). Timestamps are not unique and not strictly ordered, since clocks on different machines may not be synchronized.

    The returned event stream should be ordered by offset if possible, but this can also be difficult to fulfill for a distributed data store. The order must be documented by the read journal plugin.

    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
    LeveldbReadJournalEventsByTagQuery
  21. def eventsByTag(tag: String, offset: Offset): Source[EventEnvelope2, 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 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 akka.persistence.query.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.

    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
    LeveldbReadJournalEventsByTagQuery2
  22. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from LeveldbReadJournal to StringFormat[LeveldbReadJournal] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  24. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  25. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. final def notify(): Unit
    Definition Classes
    AnyRef
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  30. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. def [B](y: B): (LeveldbReadJournal, B)
    Implicit
    This member is added by an implicit conversion from LeveldbReadJournal to ArrowAssoc[LeveldbReadJournal] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from CurrentEventsByTagQuery2

Inherited from CurrentEventsByTagQuery

Inherited from EventsByTagQuery2

Inherited from EventsByTagQuery

Inherited from AllPersistenceIdsQuery

Inherited from ReadJournal

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from LeveldbReadJournal to any2stringadd[LeveldbReadJournal]

Inherited by implicit conversion StringFormat from LeveldbReadJournal to StringFormat[LeveldbReadJournal]

Inherited by implicit conversion Ensuring from LeveldbReadJournal to Ensuring[LeveldbReadJournal]

Inherited by implicit conversion ArrowAssoc from LeveldbReadJournal to ArrowAssoc[LeveldbReadJournal]

Ungrouped