Recovery

org.apache.pekko.persistence.Recovery
See theRecovery companion object
final case class Recovery(fromSnapshot: SnapshotSelectionCriteria, toSequenceNr: Long, replayMax: Long)

Recovery mode configuration object to be returned in PersistentActor#recovery.

By default recovers from latest snapshot replays through to the last available event (last sequenceId).

Recovery will start from a snapshot if the persistent actor has previously saved one or more snapshots and at least one of these snapshots matches the specified fromSnapshot criteria. Otherwise, recovery will start from scratch by replaying all stored events.

If recovery starts from a snapshot, the persistent actor is offered that snapshot with a SnapshotOffer message, followed by replayed messages, if any, that are younger than the snapshot, up to the specified upper sequence number bound (toSequenceNr).

Value parameters

fromSnapshot

criteria for selecting a saved snapshot from which recovery should start. Default is latest (= youngest) snapshot.

replayMax

maximum number of messages to replay. Default is no limit.

toSequenceNr

upper sequence number bound (inclusive) for recovery. Default is no upper bound.

Attributes

Companion
object
Source
PersistentActor.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Inherited methods

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product