DurableStateUpdateStore

org.apache.pekko.persistence.state.scaladsl.DurableStateUpdateStore

API for updating durable state objects.

For Java API see pekko.persistence.state.javadsl.DurableStateUpdateStore.

Attributes

Source
DurableStateUpdateStore.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Abstract methods

def deleteObject(persistenceId: String, revision: Long): Future[Done]

Delete the object with the given persistenceId and revision.

Delete the object with the given persistenceId and revision.

Since Pekko v1.1, if the revision does not match the current revision of the object, the delete operation will fail. The returned Future will complete with a failed result wrapping the exception.

Value parameters

persistenceId

the persistenceId of the object to delete

revision

the revision of the object to delete

Attributes

Returns

a Future that completes when the object has been deleted

Source
DurableStateUpdateStore.scala
def upsertObject(persistenceId: String, revision: Long, value: A, tag: String): Future[Done]

Upsert the object with the given persistenceId and revision.

Upsert the object with the given persistenceId and revision.

Value parameters

persistenceId

the persistenceId of the object to upsert

revision

the revision of the object to upsert

tag

a tag to associate with the object

value

the value to upsert

Attributes

Returns

a Future that completes when the object has been upserted

Source
DurableStateUpdateStore.scala

Deprecated methods

def deleteObject(persistenceId: String): Future[Done]

Delete the object with the given persistenceId. This deprecated function ignores whether the object is deleted or not.

Delete the object with the given persistenceId. This deprecated function ignores whether the object is deleted or not.

Value parameters

persistenceId

the persistenceId of the object to delete

revision

the revision of the object to delete

Attributes

Returns

a Future that completes when the object has been deleted

Deprecated
[Since version Akka 2.6.20] Use the deleteObject overload with revision instead.
Source
DurableStateUpdateStore.scala

Inherited methods

def getObject(persistenceId: String): Future[GetObjectResult[A]]

Attributes

Inherited from:
DurableStateStore
Source
DurableStateStore.scala