Class LocalSnapshotStore

Local file-based SnapshotStore implementation.

Inheritance
Object
ActorBase
SnapshotStore
LocalSnapshotStore
Implements
Inherited Members
Namespace: Akka.Persistence.Snapshot
Assembly: Akka.Persistence.dll
Syntax
public class LocalSnapshotStore : SnapshotStore, IInternalActor
Remarks

This is the default akka.peristence.snapshot-store implementation, when no others are explicitly set via HOCON configuration.

Constructors

| Improve this Doc View Source

LocalSnapshotStore()

Creates a new LocalSnapshotStore instance.

Declaration
public LocalSnapshotStore()

Methods

| Improve this Doc View Source

DeleteAsync(SnapshotMetadata)

Plugin API: Deletes the snapshot identified by metadata.

This call is protected with a circuit-breaker

Declaration
protected override Task DeleteAsync(SnapshotMetadata metadata)
Parameters
Type Name Description
SnapshotMetadata metadata

Snapshot metadata.
Returns
Type Description
Task

TBD
Overrides
| Improve this Doc View Source

DeleteAsync(String, SnapshotSelectionCriteria)

Plugin API: Deletes all snapshots matching provided criteria.

This call is protected with a circuit-breaker

Declaration
protected override async Task DeleteAsync(string persistenceId, SnapshotSelectionCriteria criteria)
Parameters
Type Name Description
String persistenceId

Id of the persistent actor.
SnapshotSelectionCriteria criteria

Selection criteria for deleting.
Returns
Type Description
Task

TBD
Overrides
| Improve this Doc View Source

GetSnapshotFileForWrite(SnapshotMetadata, String)

Declaration
protected FileInfo GetSnapshotFileForWrite(SnapshotMetadata metadata, string extension = "")
Parameters
Type Name Description
SnapshotMetadata metadata
String extension
Returns
Type Description
FileInfo
| Improve this Doc View Source

LoadAsync(String, SnapshotSelectionCriteria)

Plugin API: Asynchronously loads a snapshot.

This call is protected with a circuit-breaker

Declaration
protected override Task<SelectedSnapshot> LoadAsync(string persistenceId, SnapshotSelectionCriteria criteria)
Parameters
Type Name Description
String persistenceId

Id of the persistent actor.
SnapshotSelectionCriteria criteria

Selection criteria for loading.
Returns
Type Description
Task<SelectedSnapshot>

TBD
Overrides
| Improve this Doc View Source

PreStart()

TBD

Declaration
protected override void PreStart()
Overrides
| Improve this Doc View Source

ReceivePluginInternal(Object)

Plugin API: Allows plugin implementers to use f.PipeTo(Self) and handle additional messages for implementing advanced features

Declaration
protected override bool ReceivePluginInternal(object message)
Parameters
Type Name Description
Object message

TBD
Returns
Type Description
Boolean

TBD
Overrides
| Improve this Doc View Source

Save(SnapshotMetadata, Object)

TBD

Declaration
protected virtual void Save(SnapshotMetadata metadata, object snapshot)
Parameters
Type Name Description
SnapshotMetadata metadata

TBD
Object snapshot

TBD
| Improve this Doc View Source

SaveAsync(SnapshotMetadata, Object)

Plugin API: Asynchronously saves a snapshot.

This call is protected with a circuit-breaker

Declaration
protected override Task SaveAsync(SnapshotMetadata metadata, object snapshot)
Parameters
Type Name Description
SnapshotMetadata metadata

Snapshot metadata.
Object snapshot

Snapshot.
Returns
Type Description
Task

TBD
Overrides
| Improve this Doc View Source

Serialize(Stream, Snapshot)

TBD

Declaration
protected void Serialize(Stream stream, Snapshot snapshot)
Parameters
Type Name Description
Stream stream

TBD
Snapshot snapshot

TBD
| Improve this Doc View Source

WithOutputStream(SnapshotMetadata, Action<Stream>)

TBD

Declaration
protected FileInfo WithOutputStream(SnapshotMetadata metadata, Action<Stream> p)
Parameters
Type Name Description
SnapshotMetadata metadata

TBD
Action<Stream> p

TBD
Returns
Type Description
FileInfo

TBD

Implements

Extension Methods