Class SqlJournal

TBD

Inheritance
Object
ActorBase
WriteJournalBase
AsyncWriteJournal
SqlJournal
SqliteJournal
Implements
Inherited Members
Namespace: Akka.Persistence.Sql.Common.Journal
Assembly: Akka.Persistence.Sql.Common.dll
Syntax
public abstract class SqlJournal : AsyncWriteJournal, IInternalActor, IAsyncRecovery, IWithUnboundedStash, IWithUnrestrictedStash, IActorStash, IRequiresMessageQueue<IUnboundedDequeBasedMessageQueueSemantics>

Constructors

| Improve this Doc View Source

SqlJournal(Config)

TBD

Declaration
protected SqlJournal(Config journalConfig)
Parameters
Type Name Description
Config journalConfig

TBD

Fields

| Improve this Doc View Source

Settings

Declaration
protected readonly JournalSettings Settings
Field Value
Type Description
JournalSettings

Properties

| Improve this Doc View Source

JournalConfigPath

Returns a HOCON config path to associated journal.

Declaration
protected abstract string JournalConfigPath { get; }
Property Value
Type Description
String
| Improve this Doc View Source

Log

System logger.

Declaration
protected ILoggingAdapter Log { get; }
Property Value
Type Description
ILoggingAdapter
| Improve this Doc View Source

QueryExecutor

Used for generating SQL commands for journal-related database operations.

Declaration
public abstract IJournalQueryExecutor QueryExecutor { get; }
Property Value
Type Description
IJournalQueryExecutor
| Improve this Doc View Source

Stash

Declaration
public IStash Stash { get; set; }
Property Value
Type Description
IStash

Methods

| Improve this Doc View Source

CreateDbConnection()

TBD

Declaration
public DbConnection CreateDbConnection()
Returns
Type Description
DbConnection

TBD
| Improve this Doc View Source

CreateDbConnection(String)

Initializes a database connection.

Declaration
protected abstract DbConnection CreateDbConnection(string connectionString)
Parameters
Type Name Description
String connectionString

TBD
Returns
Type Description
DbConnection

TBD
| Improve this Doc View Source

DeleteMessagesToAsync(String, Int64)

Asynchronously deletes all persisted messages identified by provided persistenceId up to provided message sequence number (inclusive).

Declaration
protected override async Task DeleteMessagesToAsync(string persistenceId, long toSequenceNr)
Parameters
Type Name Description
String persistenceId

TBD
Int64 toSequenceNr

TBD
Returns
Type Description
Task

TBD
Overrides
| Improve this Doc View Source

GetConnectionString()

Returns connection string from either HOCON configuration or <connectionStrings> section of app.config.

Declaration
protected virtual string GetConnectionString()
Returns
Type Description
String

TBD
| Improve this Doc View Source

GetTimestampProvider(String)

Declaration
protected ITimestampProvider GetTimestampProvider(string typeName)
Parameters
Type Name Description
String typeName
Returns
Type Description
ITimestampProvider
| Improve this Doc View Source

PostStop()

TBD

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

PreStart()

TBD

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

ReadHighestSequenceNrAsync(String, Int64)

Asynchronously reads a highest sequence number of the event stream related with provided persistenceId.

Declaration
public override async Task<long> ReadHighestSequenceNrAsync(string persistenceId, long fromSequenceNr)
Parameters
Type Name Description
String persistenceId

TBD
Int64 fromSequenceNr

TBD
Returns
Type Description
Task<Int64>

TBD
Overrides
| Improve this Doc View Source

ReceivePluginInternal(Object)

TBD

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

ReplayAllEventsAsync(ReplayAllEvents)

Declaration
protected virtual async Task<long> ReplayAllEventsAsync(ReplayAllEvents replay)
Parameters
Type Name Description
ReplayAllEvents replay
Returns
Type Description
Task<Int64>
| Improve this Doc View Source

ReplayMessagesAsync(IActorContext, String, Int64, Int64, Int64, Action<IPersistentRepresentation>)

TBD

Declaration
public override async Task ReplayMessagesAsync(IActorContext context, string persistenceId, long fromSequenceNr, long toSequenceNr, long max, Action<IPersistentRepresentation> recoveryCallback)
Parameters
Type Name Description
IActorContext context

TBD
String persistenceId

TBD
Int64 fromSequenceNr

TBD
Int64 toSequenceNr

TBD
Int64 max

TBD
Action<IPersistentRepresentation> recoveryCallback

TBD
Returns
Type Description
Task

TBD
Overrides
| Improve this Doc View Source

ReplayTaggedMessagesAsync(ReplayTaggedMessages)

Replays all events with given tag withing provided boundaries from current database.

Declaration
protected virtual async Task<long> ReplayTaggedMessagesAsync(ReplayTaggedMessages replay)
Parameters
Type Name Description
ReplayTaggedMessages replay

TBD
Returns
Type Description
Task<Int64>

TBD
| Improve this Doc View Source

SelectAllPersistenceIdsAsync(Int64)

Declaration
protected virtual async Task<(IEnumerable<string> Ids, long LastOrdering)> SelectAllPersistenceIdsAsync(long offset)
Parameters
Type Name Description
Int64 offset
Returns
Type Description
Task<System.ValueTuple<IEnumerable<String>, Int64>>
| Improve this Doc View Source

WaitingForInitialization(Object)

TBD

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

TBD
Returns
Type Description
Boolean

TBD
| Improve this Doc View Source

WriteMessagesAsync(IEnumerable<AtomicWrite>)

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.

Declaration
protected override async Task<IImmutableList<Exception>> WriteMessagesAsync(IEnumerable<AtomicWrite> messages)
Parameters
Type Name Description
IEnumerable<AtomicWrite> messages

TBD
Returns
Type Description
Task<System.Collections.Immutable.IImmutableList<Exception>>

TBD
Overrides
Exceptions
Type Condition
InvalidOperationException

TBD

Implements

Extension Methods