Merge pull request #28062 from chbatey/clarify-snapshot-every
Clarify snapshop every n events
This commit is contained in:
commit
c74e9720f3
3 changed files with 7 additions and 0 deletions
|
|
@ -531,5 +531,6 @@ private[akka] object Running {
|
||||||
@unused event: PersistentRepr): Unit = ()
|
@unused event: PersistentRepr): Unit = ()
|
||||||
@InternalStableApi
|
@InternalStableApi
|
||||||
private[akka] def onWriteSuccess(@unused ctx: ActorContext[_], @unused event: PersistentRepr): Unit = ()
|
private[akka] def onWriteSuccess(@unused ctx: ActorContext[_], @unused event: PersistentRepr): Unit = ()
|
||||||
|
@InternalStableApi
|
||||||
private[akka] def onWriteDone(@unused ctx: ActorContext[_], @unused event: PersistentRepr): Unit = ()
|
private[akka] def onWriteDone(@unused ctx: ActorContext[_], @unused event: PersistentRepr): Unit = ()
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -32,6 +32,9 @@ object RetentionCriteria {
|
||||||
*
|
*
|
||||||
* Use [[SnapshotCountRetentionCriteria.withDeleteEventsOnSnapshot]] to
|
* Use [[SnapshotCountRetentionCriteria.withDeleteEventsOnSnapshot]] to
|
||||||
* delete old events. Events are not deleted by default.
|
* delete old events. Events are not deleted by default.
|
||||||
|
*
|
||||||
|
* If multiple events are persisted with a single Effect, the snapshot will happen after
|
||||||
|
* all of the events are persisted rather than precisely every `numberOfEvents`.
|
||||||
*/
|
*/
|
||||||
def snapshotEvery(numberOfEvents: Int, keepNSnapshots: Int): SnapshotCountRetentionCriteria =
|
def snapshotEvery(numberOfEvents: Int, keepNSnapshots: Int): SnapshotCountRetentionCriteria =
|
||||||
SnapshotCountRetentionCriteriaImpl(numberOfEvents, keepNSnapshots, deleteEventsOnSnapshot = false)
|
SnapshotCountRetentionCriteriaImpl(numberOfEvents, keepNSnapshots, deleteEventsOnSnapshot = false)
|
||||||
|
|
|
||||||
|
|
@ -32,6 +32,9 @@ object RetentionCriteria {
|
||||||
*
|
*
|
||||||
* Use [[SnapshotCountRetentionCriteria.withDeleteEventsOnSnapshot]] to
|
* Use [[SnapshotCountRetentionCriteria.withDeleteEventsOnSnapshot]] to
|
||||||
* delete old events. Events are not deleted by default.
|
* delete old events. Events are not deleted by default.
|
||||||
|
*
|
||||||
|
* If multiple events are persisted with a single Effect the snapshot will happen after
|
||||||
|
* all of the events are persisted rather than precisely every `numberOfEvents`.
|
||||||
*/
|
*/
|
||||||
def snapshotEvery(numberOfEvents: Int, keepNSnapshots: Int): SnapshotCountRetentionCriteria =
|
def snapshotEvery(numberOfEvents: Int, keepNSnapshots: Int): SnapshotCountRetentionCriteria =
|
||||||
SnapshotCountRetentionCriteriaImpl(numberOfEvents, keepNSnapshots, deleteEventsOnSnapshot = false)
|
SnapshotCountRetentionCriteriaImpl(numberOfEvents, keepNSnapshots, deleteEventsOnSnapshot = false)
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue