Packages

package query

Content Hierarchy
Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Package Members

  1. package internal
  2. package javadsl
  3. package journal
  4. package scaladsl
  5. package typed

Type Members

  1. final class DeletedDurableState[A] extends DurableStateChange[A]

    A

    the type of the value

  2. sealed trait DurableStateChange[A] extends AnyRef

    The DurableStateStoreQuery stream elements for DurableStateStoreQuery.

    The DurableStateStoreQuery stream elements for DurableStateStoreQuery.

    The implementation can be a UpdatedDurableState or a DeletedDurableState.

    Not for user extension

    A

    the type of the value

    Annotations
    @DoNotInherit()
  3. final class EventEnvelope extends Product4[Offset, String, Long, Any] with Serializable

    Event wrapper adding meta data for the events in the result stream of pekko.persistence.query.scaladsl.EventsByTagQuery query, or similar queries.

    Event wrapper adding meta data for the events in the result stream of pekko.persistence.query.scaladsl.EventsByTagQuery query, or similar queries.

    The timestamp is the time the event was stored, in milliseconds since midnight, January 1, 1970 UTC (same as System.currentTimeMillis).

  4. abstract class Offset extends AnyRef
  5. class PersistenceQuery extends PersistencePlugin[ReadJournal, ReadJournal, ReadJournalProvider] with Extension
  6. trait ReadJournalProvider extends AnyRef

    A query plugin must implement a class that implements this trait.

    A query plugin must implement a class that implements this trait. It provides the concrete implementations for the Java and Scala APIs.

    A read journal plugin must provide implementations for both org.apache.pekko.persistence.query.scaladsl.ReadJournal and org.apache.pekko.persistence.query.javadsl.ReadJournal. The plugin must implement both the scaladsl and the javadsl traits because the org.apache.pekko.stream.scaladsl.Source and org.apache.pekko.stream.javadsl.Source are different types and even though those types can easily be converted to each other it is most convenient for the end user to get access to the Java or Scala Source directly. One of the implementations can delegate to the other.

  7. final case class Sequence(value: Long) extends Offset with Ordered[Sequence] with Product with Serializable

    Corresponds to an ordered sequence number for the events.

    Corresponds to an ordered sequence number for the events. Note that the corresponding offset of each event is provided in the pekko.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.

  8. final case class TimeBasedUUID(value: UUID) extends Offset with Ordered[TimeBasedUUID] with Product with Serializable

    Corresponds to an ordered unique identifier of the events.

    Corresponds to an ordered unique identifier of the events. Note that the corresponding offset of each event is provided in the pekko.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.

  9. final case class TimestampOffset(timestamp: Instant, readTimestamp: Instant, seen: Map[String, Long]) extends Offset with Product with Serializable

    Timestamp based offset.

    Timestamp based offset. Since there can be several events for the same timestamp it keeps track of what sequence nrs for every persistence id that have been seen at this specific timestamp.

    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.

    API May Change

    timestamp

    time when the event was stored, microsecond granularity database timestamp

    readTimestamp

    time when the event was read, microsecond granularity database timestamp

    seen

    List of sequence nrs for every persistence id seen at this timestamp

    Annotations
    @ApiMayChange()
  10. final class UpdatedDurableState[A] extends DurableStateChange[A]

    A

    the type of the value

Value Members

  1. object DeletedDurableState
  2. object EventEnvelope extends AbstractFunction4[Offset, String, Long, Any, EventEnvelope] with Serializable
  3. case object NoOffset extends Offset with Product with Serializable

    Used when retrieving all events.

  4. object Offset
  5. object PersistenceQuery extends ExtensionId[PersistenceQuery] with ExtensionIdProvider

    Persistence extension for queries.

  6. object TimestampOffset extends Serializable
  7. object UpdatedDurableState

Ungrouped