Packages

final class DurableStateCleanup extends AnyRef

Scala API: Tool for deleting durable state for a given list of persistenceIds without using DurableStateBehavior actors. It's important that the actors with corresponding persistenceId are not running at the same time as using the tool.

If resetRevisionNumber is true then the creating entity with the same persistenceId will start from 0. Otherwise it will continue from the latest highest used revision number.

WARNING: reusing the same persistenceId after resetting the revision number should be avoided, since it might be confusing to reuse the same revision numbers for new state changes.

When a list of persistenceIds are given they are deleted sequentially in the order of the list. It's possible to parallelize the deletes by running several cleanup operations at the same time operating on different sets of persistenceIds.

Annotations
@ApiMayChange()
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DurableStateCleanup
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new DurableStateCleanup(systemProvider: ClassicActorSystemProvider)
  2. new DurableStateCleanup(systemProvider: ClassicActorSystemProvider, configPath: String)

Value Members

  1. def deleteState(persistenceId: String, resetRevisionNumber: Boolean): Future[Done]

    Delete the state related to one single persistenceId.

  2. def deleteStates(persistenceIds: Seq[String], resetRevisionNumber: Boolean): Future[Done]

    Delete all states related to the given list of persistenceIds.