DynamoDBReadJournal

Instance Constructors

new DynamoDBReadJournal(config: Config, configPath: String)(implicit system: ExtendedActorSystem)

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
val asyncClient: DynamoDbAsyncClient

Attributes
protected
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @throws( ... )
def currentEventsByPersistenceId(persistenceId: String, fromSequenceNr: Long, toSequenceNr: Long): Source[EventEnvelope, NotUsed]

Definition Classes
DynamoDBReadJournal → CurrentEventsByPersistenceIdQuery
def currentEventsByTag(tag: String, offset: Long): Source[EventEnvelope, NotUsed]
def currentEventsByTag(tag: String, offset: Offset): 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.
akka-persistence-jdbc has implemented this feature by using a LIKE %tag% query on the tags column. A consequence of this is that tag names must be chosen wisely: for example when querying the tag User, events with the tag UserEmail will also be returned (since User is a substring of UserEmail).
The returned event stream is ordered by offset.

Definition Classes
DynamoDBReadJournal → CurrentEventsByTagQuery
def currentPersistenceIds(): Source[String, NotUsed]

Definition Classes
DynamoDBReadJournal → CurrentPersistenceIdsQuery
implicit val ec: ExecutionContext
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def eventsByPersistenceId(persistenceId: String, fromSequenceNr: Long, toSequenceNr: Long): Source[EventEnvelope, NotUsed]

Definition Classes
DynamoDBReadJournal → EventsByPersistenceIdQuery
def eventsByTag(tag: String, offset: Long): Source[EventEnvelope, NotUsed]
def eventsByTag(tag: String, offset: Offset): Source[EventEnvelope, NotUsed]

Query events that have a specific tag.
Query events that have a specific tag.
akka-persistence-jdbc has implemented this feature by using a LIKE %tag% query on the tags column. A consequence of this is that tag names must be chosen wisely: for example when querying the tag User, events with the tag UserEmail will also be returned (since User is a substring of UserEmail).
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.
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 returned event stream is ordered by offset.
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
DynamoDBReadJournal → EventsByTagQuery
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val javaAsyncClient: DynamoDbAsyncClient

Attributes
protected
val journalSequenceRetrievalConfig: JournalSequenceRetrievalConfig

Attributes
protected
implicit val mat: ActorMaterializer
val metricsReporter: MetricsReporter
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
def persistenceIds(): Source[String, NotUsed]

Definition Classes
DynamoDBReadJournal → PersistenceIdsQuery
val pluginConfig: QueryPluginConfig

Attributes
protected
val streamClient: DynamoDbAkkaClient

Attributes
protected
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.

Related Docs: object DynamoDBReadJournal | package scaladsl

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

Instance Constructors

new DynamoDBReadJournal(config: Config, configPath: String)(implicit system: ExtendedActorSystem)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val asyncClient: DynamoDbAsyncClient

def clone(): AnyRef

def currentEventsByPersistenceId(persistenceId: String, fromSequenceNr: Long, toSequenceNr: Long): Source[EventEnvelope, NotUsed]

def currentEventsByTag(tag: String, offset: Long): Source[EventEnvelope, NotUsed]

def currentEventsByTag(tag: String, offset: Offset): Source[EventEnvelope, NotUsed]

def currentPersistenceIds(): Source[String, NotUsed]

implicit val ec: ExecutionContext

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def eventsByPersistenceId(persistenceId: String, fromSequenceNr: Long, toSequenceNr: Long): Source[EventEnvelope, NotUsed]

def eventsByTag(tag: String, offset: Long): Source[EventEnvelope, NotUsed]

def eventsByTag(tag: String, offset: Offset): Source[EventEnvelope, NotUsed]

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

val javaAsyncClient: DynamoDbAsyncClient

val journalSequenceRetrievalConfig: JournalSequenceRetrievalConfig

implicit val mat: ActorMaterializer

val metricsReporter: MetricsReporter

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def persistenceIds(): Source[String, NotUsed]

val pluginConfig: QueryPluginConfig

val streamClient: DynamoDbAkkaClient

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

final def wait(): Unit

Deprecated Value Members

def finalize(): Unit

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