SqlSnapshotStore Class

Abstract snapshot store implementation, customized to work with SQL-based persistence providers.

Inheritance Hierarchy

SystemObject
  Akka.ActorActorBase
    Akka.Persistence.SnapshotSnapshotStore
      Akka.Persistence.Sql.Common.SnapshotSqlSnapshotStore
        Akka.Persistence.Sqlite.SnapshotSqliteSnapshotStore

Namespace: Akka.Persistence.Sql.Common.Snapshot
Assembly: Akka.Persistence.Sql.Common (in Akka.Persistence.Sql.Common.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

Copy

public abstract class SqlSnapshotStore : SnapshotStore, 
	IWithUnboundedStash, IActorStash, IRequiresMessageQueue<IUnboundedDequeBasedMessageQueueSemantics>

[<AbstractClassAttribute>]
type SqlSnapshotStore =  
    class
        inherit SnapshotStore
        interface IWithUnboundedStash
        interface IActorStash
        interface IRequiresMessageQueue<IUnboundedDequeBasedMessageQueueSemantics>
    end

The SqlSnapshotStore type exposes the following members.

Constructors

	Name	Description
	SqlSnapshotStore	Initializes a new instance of the SqlSnapshotStore class.

Top

Properties

	Name	Description
	Log	TBD
	QueryExecutor	Query executor used to convert snapshot store related operations into corresponding SQL queries.
	Self	Gets the self ActorRef (Inherited from ActorBase.)
	Sender	Gets the sending ActorRef of the current message (Inherited from ActorBase.)
	Stash	TBD

Top

Methods

	Name	Description
	AroundPostRestart	Can be overridden to intercept calls to `PostRestart`. Calls `PostRestart` by default. (Inherited from ActorBase.)
	AroundPostStop	Can be overridden to intercept calls to `PostStop`. Calls `PostStop` by default.. (Inherited from ActorBase.)
	AroundPreRestart	Can be overridden to intercept calls to `PreRestart`. Calls `PreRestart` by default. (Inherited from ActorBase.)
	AroundPreStart	Can be overridden to intercept calls to `PreStart`. Calls `PreStart` by default. (Inherited from ActorBase.)
	AroundReceive	TBD (Inherited from ActorBase.)
	Become	Changes the actor's command behavior and replaces the current receive handler with the specified handler. (Inherited from ActorBase.)
	BecomeStacked	Changes the actor's behavior and replaces the current receive handler with the specified handler. The current handler is stored on a stack, and you can revert to it by calling UnbecomeStacked Remarks Please note, that in order to not leak memory, make sure every call to BecomeStacked(Receive) is matched with a call to UnbecomeStacked. (Inherited from ActorBase.)
	CreateDbConnection	Returns a new instance of database connection.
	CreateDbConnection(String)	Returns a new instance of database connection.
	DeleteAsync(SnapshotMetadata)	TBD (Overrides SnapshotStoreDeleteAsync(SnapshotMetadata).)
	DeleteAsync(String, SnapshotSelectionCriteria)	TBD (Overrides SnapshotStoreDeleteAsync(String, SnapshotSelectionCriteria).)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetConnectionString	TBD
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	LoadAsync	Asynchronously loads snapshot with the highest sequence number for a persistent actor/view matching specified criteria. (Overrides SnapshotStoreLoadAsync(String, SnapshotSelectionCriteria).)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	PostRestart	User overridable callback: By default it calls `PreStart()`. Is called right AFTER restart on the newly created Actor to allow reinitialization after an Actor crash. (Inherited from ActorBase.)
	PostStop	TBD (Overrides ActorBasePostStop.)
	PreRestart	User overridable callback: '''By default it disposes of all children and then calls `postStop()`.''' Is called on a crashed Actor right BEFORE it is restarted to allow clean up of resources before Actor is terminated. (Inherited from ActorBase.)
	PreStart	TBD (Overrides ActorBasePreStart.)
	Receive	TBD (Inherited from SnapshotStore.)
	ReceivePluginInternal	Allows plugin implementers to use PipeToT(TaskT, ICanTell, IActorRef, FuncT, Object, FuncException, Object)Self and handle additional messages for implementing advanced features (Inherited from SnapshotStore.)
	SaveAsync	Asynchronously stores a snapshot with metadata as record in SQL table. (Overrides SnapshotStoreSaveAsync(SnapshotMetadata, Object).)
	SetReceiveTimeout	Defines the inactivity timeout after which the sending of a ReceiveTimeout message is triggered. When specified, the receive function should be able to handle a ReceiveTimeout message. Please note that the receive timeout might fire and enqueue the ReceiveTimeout message right after another message was enqueued; hence it is not guaranteed that upon reception of the receive timeout there must have been an idle period beforehand as configured via this method. Once set, the receive timeout stays in effect (i.e. continues firing repeatedly after inactivity periods). Pass in null to switch off this feature. (Inherited from ActorBase.)
	SupervisorStrategy	TBD (Inherited from ActorBase.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UnbecomeStacked	Reverts the Actor behavior to the previous one on the behavior stack. (Inherited from ActorBase.)
	Unhandled	Is called when a message isn't handled by the current behavior of the actor by default it fails with either a DeathPactException (in case of an unhandled Terminated message) or publishes an UnhandledMessage to the actor's system's EventStream (Inherited from ActorBase.)

Top

Extension Methods

	Name	Description
	AsInstanceOfT	TBD (Defined by Extensions.)
	Match	Overloaded. Matches the specified target. (Defined by PatternMatch.)
	MatchT	Overloaded. Matches the specified target and return a result of target processing. (Defined by PatternMatch.)

Top

Reference

Akka.Persistence.Sql.Common.Snapshot Namespace