SqlJournal Class

SqlJournal Class

TBD

Inheritance Hierarchy

SystemObject
  Akka.ActorActorBase
    Akka.Persistence.JournalWriteJournalBase
      Akka.Persistence.JournalAsyncWriteJournal
        Akka.Persistence.Sql.Common.JournalSqlJournal
          Akka.Persistence.Sqlite.JournalSqliteJournal

Namespace: Akka.Persistence.Sql.Common.Journal
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 SqlJournal : AsyncWriteJournal, 
	IWithUnboundedStash, IActorStash, IRequiresMessageQueue<IUnboundedDequeBasedMessageQueueSemantics>

[<AbstractClassAttribute>]
type SqlJournal =  
    class
        inherit AsyncWriteJournal
        interface IWithUnboundedStash
        interface IActorStash
        interface IRequiresMessageQueue<IUnboundedDequeBasedMessageQueueSemantics>
    end

The SqlJournal type exposes the following members.

Constructors

	Name	Description
	SqlJournal	TBD

Top

Properties

	Name	Description
	AllPersistenceIds	TBD
	HasAllPersistenceIdSubscribers	TBD
	HasPersistenceIdSubscribers	TBD
	HasTagSubscribers	TBD
	JournalConfigPath	Returns a HOCON config path to associated journal.
	Log	System logger.
	QueryExecutor	Used for generating SQL commands for journal-related database operations.
	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
	AdaptFromJournal	TBD (Inherited from WriteJournalBase.)
	AdaptToJournal	TBD (Inherited from WriteJournalBase.)
	AddAllPersistenceIdSubscriber	TBD
	AddPersistenceIdSubscriber	TBD
	AddTagSubscriber	TBD
	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	TBD
	CreateDbConnection(String)	Initializes a database connection.
	DeleteMessagesToAsync	Asynchronously deletes all persisted messages identified by provided persistenceId up to provided message sequence number (inclusive). (Overrides AsyncWriteJournalDeleteMessagesToAsync(String, Int64).)
	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	Returns connection string from either HOCON configuration or <connectionStrings> section of app.config.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetTimestampProvider	TBD
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	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.)
	PreparePersistentBatch	TBD (Inherited from WriteJournalBase.)
	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.)
	ReadHighestSequenceNrAsync	Asynchronously reads a highest sequence number of the event stream related with provided persistenceId. (Overrides AsyncWriteJournalReadHighestSequenceNrAsync(String, Int64).)
	Receive	Processor for user defined messages. (Inherited from AsyncWriteJournal.)
	ReceivePluginInternal	TBD (Overrides AsyncWriteJournalReceivePluginInternal(Object).)
	ReceiveWriteJournal	TBD (Inherited from AsyncWriteJournal.)
	RemoveSubscriber	TBD
	ReplayMessagesAsync	TBD (Overrides AsyncWriteJournalReplayMessagesAsync(IActorContext, String, Int64, Int64, Int64, ActionIPersistentRepresentation).)
	ReplayTaggedMessagesAsync	Replays all events with given tag withing provided boundaries from current database.
	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.)
	TryUnwrapException	TBD (Inherited from AsyncWriteJournal.)
	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.)
	WaitingForInitialization	TBD
	WriteMessagesAsync	Asynchronously writes all persistent messages inside SQL Server database. Specific table used for message persistence may be defined through configuration within 'akka.persistence.journal.sql-server' scope with 'schema-name' and 'table-name' keys. (Overrides AsyncWriteJournalWriteMessagesAsync(IEnumerableAtomicWrite).)

Top

Fields

	Name	Description
	CanPublish	(Inherited from AsyncWriteJournal.)

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.Journal Namespace