final class DynamoDBReadJournal extends ReadJournal with CurrentEventsBySliceQuery with EventsBySliceQuery with CurrentEventsBySliceStartingFromSnapshotsQuery with EventsBySliceStartingFromSnapshotsQuery with EventTimestampQuery with LoadEventQuery
- Alphabetic
- By Inheritance
- DynamoDBReadJournal
- LoadEventQuery
- EventTimestampQuery
- EventsBySliceStartingFromSnapshotsQuery
- CurrentEventsBySliceStartingFromSnapshotsQuery
- EventsBySliceQuery
- CurrentEventsBySliceQuery
- ReadJournal
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new DynamoDBReadJournal(system: ExtendedActorSystem, config: Config, cfgPath: String)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def createEventEnvelopeHeartbeat[Event](entityType: String, slice: Int, timestamp: Instant): EventEnvelope[Event]
- def currentEventsBySlices[Event](entityType: String, minSlice: Int, maxSlice: Int, offset: Offset): Source[EventEnvelope[Event], NotUsed]
- Definition Classes
- DynamoDBReadJournal → CurrentEventsBySliceQuery
- def currentEventsBySlicesStartingFromSnapshots[Snapshot, Event](entityType: String, minSlice: Int, maxSlice: Int, offset: Offset, transformSnapshot: (Snapshot) => Event): Source[EventEnvelope[Event], NotUsed]
Same as
currentEventsBySlices
but with the purpose to use snapshots as starting points and thereby reducing the number of events that have to be loaded.Same as
currentEventsBySlices
but with the purpose to use snapshots as starting points and thereby reducing the number of events that have to be loaded. This can be useful if the consumer starts from zero without any previously processed offset or if it has been disconnected for a long while and its offset is far behind.First it loads all snapshots with timestamps greater than or equal to the offset timestamp. There is at most one snapshot per persistenceId. The snapshots are transformed to events with the given
transformSnapshot
function.After emitting the snapshot events the ordinary events with sequence numbers after the snapshots are emitted.
To use
currentEventsBySlicesStartingFromSnapshots
you must enable configurationakka.persistence.dynamodb.query.start-from-snapshot.enabled
.- Definition Classes
- DynamoDBReadJournal → CurrentEventsBySliceStartingFromSnapshotsQuery
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def eventsBySlices[Event](entityType: String, minSlice: Int, maxSlice: Int, offset: Offset): Source[EventEnvelope[Event], NotUsed]
Query events for given slices.
Query events for given slices. A slice is deterministically defined based on the persistence id. The purpose is to evenly distribute all persistence ids over the slices.
The consumer can keep track of its current position in the event stream by storing the
offset
and restart the query from a givenoffset
after a crash/restart.The supported offsets are akka.persistence.query.TimestampOffset and akka.persistence.query.NoOffset.
The timestamp is based on the client wall clock and the events are read from a DynamoDB global secondary index, which is eventually consistent. This means that a "later" event may be visible first and when retrieving events after the previously seen timestamp we may miss some events. For that reason it will perform additional backtracking queries to catch missed events. Events from backtracking will typically be duplicates of previously emitted events. It's the responsibility of the consumer to filter duplicates and make sure that events are processed in exact sequence number order for each persistence id. Such deduplication is provided by the DynamoDB Projection.
Events emitted by the backtracking don't contain the event payload (
EventBySliceEnvelope.event
is None) and the consumer can load the fullEventBySliceEnvelope
with DynamoDBReadJournal.loadEnvelope.The events will be emitted in the timestamp order with the caveat of duplicate events as described above.
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 DynamoDBReadJournal.currentEventsBySlices.
- Definition Classes
- DynamoDBReadJournal → EventsBySliceQuery
- def eventsBySlicesStartingFromSnapshots[Snapshot, Event](entityType: String, minSlice: Int, maxSlice: Int, offset: Offset, transformSnapshot: (Snapshot) => Event): Source[EventEnvelope[Event], NotUsed]
Same as
eventsBySlices
but with the purpose to use snapshots as starting points and thereby reducing the number of events that have to be loaded.Same as
eventsBySlices
but with the purpose to use snapshots as starting points and thereby reducing the number of events that have to be loaded. This can be useful if the consumer starts from zero without any previously processed offset or if it has been disconnected for a long while and its offset is far behind.First it loads all snapshots with timestamps greater than or equal to the offset timestamp. There is at most one snapshot per persistenceId. The snapshots are transformed to events with the given
transformSnapshot
function.After emitting the snapshot events the ordinary events with sequence numbers after the snapshots are emitted.
To use
eventsBySlicesStartingFromSnapshots
you must enable configurationakka.persistence.dynamodb.query.start-from-snapshot.enabled
.- Definition Classes
- DynamoDBReadJournal → EventsBySliceStartingFromSnapshotsQuery
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def loadEnvelope[Event](persistenceId: String, sequenceNr: Long): Future[EventEnvelope[Event]]
- Definition Classes
- DynamoDBReadJournal → LoadEventQuery
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def sliceForPersistenceId(persistenceId: String): Int
- Definition Classes
- DynamoDBReadJournal → EventsBySliceStartingFromSnapshotsQuery → CurrentEventsBySliceStartingFromSnapshotsQuery → EventsBySliceQuery → CurrentEventsBySliceQuery
- def sliceRanges(numberOfRanges: Int): Seq[Range]
- Definition Classes
- DynamoDBReadJournal → EventsBySliceStartingFromSnapshotsQuery → CurrentEventsBySliceStartingFromSnapshotsQuery → EventsBySliceQuery → CurrentEventsBySliceQuery
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def timestampOf(persistenceId: String, sequenceNr: Long): Future[Option[Instant]]
- Definition Classes
- DynamoDBReadJournal → EventTimestampQuery
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()