Search Results for

    Show / Hide Table of Contents

    Class BatchingSqlJournalSetup

    All settings that can be used by implementations of BatchingSqlJournal<TConnection, TCommand>.

    Inheritance
    Object
    BatchingSqlJournalSetup
    BatchingSqliteJournalSetup
    Inherited Members
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Object.ReferenceEquals(Object, Object)
    Object.ToString()
    Namespace: Akka.Persistence.Sql.Common.Journal
    Assembly: Akka.Persistence.Sqlite.dll
    Syntax
    [Obsolete("Getting removed in v1.6")]
    public abstract class BatchingSqlJournalSetup

    Constructors

    | Improve this Doc View Source

    BatchingSqlJournalSetup(Config, QueryConfiguration)

    Initializes a new instance of the BatchingSqlJournalSetup class.

    Declaration
    protected BatchingSqlJournalSetup(Config config, QueryConfiguration namingConventions)
    Parameters
    Type Name Description
    Config config

    The configuration used to configure the journal.

    QueryConfiguration namingConventions

    The naming conventions used by the database to construct valid SQL statements.

    Exceptions
    Type Condition
    ConfigurationException

    This exception is thrown for a couple of reasons.

    • A connection string for the SQL event journal was not specified.
    • An unknown isolation-level value was specified. Acceptable isolation-level values include: chaos | read-committed | read-uncommitted | repeatable-read | serializable | snapshot | unspecified

    ArgumentNullException

    This exception is thrown when the specified config is undefined.

    | Improve this Doc View Source

    BatchingSqlJournalSetup(String, Int32, Int32, Int32, Boolean, TimeSpan, IsolationLevel, CircuitBreakerSettings, ReplayFilterSettings, QueryConfiguration, String)

    Initializes a new instance of the BatchingSqlJournalSetup class.

    Declaration
    [Obsolete("Use constructor with separate read and write isolation level instead. (since v1.5.2)")]
    protected BatchingSqlJournalSetup(string connectionString, int maxConcurrentOperations, int maxBatchSize, int maxBufferSize, bool autoInitialize, TimeSpan connectionTimeout, IsolationLevel isolationLevel, CircuitBreakerSettings circuitBreakerSettings, ReplayFilterSettings replayFilterSettings, QueryConfiguration namingConventions, string defaultSerializer)
    Parameters
    Type Name Description
    String connectionString

    The connection string used to connect to the database.

    Int32 maxConcurrentOperations

    The maximum number of batch operations allowed to be executed at the same time.

    Int32 maxBatchSize

    The maximum size of single batch of operations to be executed over a single DbConnection.

    Int32 maxBufferSize

    The maximum size of requests stored in journal buffer.

    Boolean autoInitialize

    If set to true, the journal executes all SQL scripts stored under the Initializers collection prior to starting executing any requests.

    TimeSpan connectionTimeout

    The maximum time given for executed DbCommand to complete.

    IsolationLevel isolationLevel

    The isolation level of transactions used during query execution.

    CircuitBreakerSettings circuitBreakerSettings

    The settings used by the CircuitBreaker when for executing request batches.

    ReplayFilterSettings replayFilterSettings

    The settings used when replaying events from database back to the persistent actors.

    QueryConfiguration namingConventions

    The naming conventions used by the database to construct valid SQL statements.

    String defaultSerializer

    The serializer used when no specific type matching can be found.

    | Improve this Doc View Source

    BatchingSqlJournalSetup(String, Int32, Int32, Int32, Boolean, TimeSpan, IsolationLevel, IsolationLevel, CircuitBreakerSettings, ReplayFilterSettings, QueryConfiguration, String)

    Initializes a new instance of the BatchingSqlJournalSetup class.

    Declaration
    protected BatchingSqlJournalSetup(string connectionString, int maxConcurrentOperations, int maxBatchSize, int maxBufferSize, bool autoInitialize, TimeSpan connectionTimeout, IsolationLevel readIsolationLevel, IsolationLevel writeIsolationLevel, CircuitBreakerSettings circuitBreakerSettings, ReplayFilterSettings replayFilterSettings, QueryConfiguration namingConventions, string defaultSerializer)
    Parameters
    Type Name Description
    String connectionString

    The connection string used to connect to the database.

    Int32 maxConcurrentOperations

    The maximum number of batch operations allowed to be executed at the same time.

    Int32 maxBatchSize

    The maximum size of single batch of operations to be executed over a single DbConnection.

    Int32 maxBufferSize

    The maximum size of requests stored in journal buffer.

    Boolean autoInitialize

    If set to true, the journal executes all SQL scripts stored under the Initializers collection prior to starting executing any requests.

    TimeSpan connectionTimeout

    The maximum time given for executed DbCommand to complete.

    IsolationLevel readIsolationLevel

    The isolation level of transactions used during read query execution.

    IsolationLevel writeIsolationLevel

    The isolation level of transactions used during write query execution.

    CircuitBreakerSettings circuitBreakerSettings

    The settings used by the CircuitBreaker when for executing request batches.

    ReplayFilterSettings replayFilterSettings

    The settings used when replaying events from database back to the persistent actors.

    QueryConfiguration namingConventions

    The naming conventions used by the database to construct valid SQL statements.

    String defaultSerializer

    The serializer used when no specific type matching can be found.

    Properties

    | Improve this Doc View Source

    AutoInitialize

    If true, once created, journal will run all SQL scripts stored under Initializers collection prior to starting executing any requests. In most implementation this is used to initialize necessary tables.

    Declaration
    public bool AutoInitialize { get; }
    Property Value
    Type Description
    Boolean
    | Improve this Doc View Source

    CircuitBreakerSettings

    Settings specific to CircuitBreaker, which is used internally for executing request batches.

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

    ConnectionString

    Connection string to a SQL database.

    Declaration
    public string ConnectionString { get; }
    Property Value
    Type Description
    String
    | Improve this Doc View Source

    ConnectionTimeout

    Maximum time given for executed DbCommand to complete.

    Declaration
    public TimeSpan ConnectionTimeout { get; }
    Property Value
    Type Description
    TimeSpan
    | Improve this Doc View Source

    DefaultSerializer

    The default serializer used when not type override matching is found

    Declaration
    [Obsolete("This property should never be used for writes, use the default `System.Object` serializer instead")]
    public string DefaultSerializer { get; }
    Property Value
    Type Description
    String
    | Improve this Doc View Source

    IsolationLevel

    Isolation level of transactions used during write query execution.

    Declaration
    [Obsolete("Use WriteIsolationLevel property instead")]
    public IsolationLevel IsolationLevel { get; }
    Property Value
    Type Description
    IsolationLevel
    | Improve this Doc View Source

    MaxBatchSize

    Maximum size of single batch of operations to be executed over a single DbConnection.

    Declaration
    public int MaxBatchSize { get; }
    Property Value
    Type Description
    Int32
    | Improve this Doc View Source

    MaxBufferSize

    Maximum size of requests stored in journal buffer. Once buffer will be surpassed, it will start to apply OnBufferOverflow(IJournalMessage) method to incoming requests.

    Declaration
    public int MaxBufferSize { get; }
    Property Value
    Type Description
    Int32
    | Improve this Doc View Source

    MaxConcurrentOperations

    Maximum number of batch operations allowed to be executed at the same time. Each batch operation must acquire a DbConnection, so this setting can be effectively used to limit the usage of ADO.NET connection pool by current journal.

    Declaration
    public int MaxConcurrentOperations { get; }
    Property Value
    Type Description
    Int32
    | Improve this Doc View Source

    NamingConventions

    Database specific naming conventions (table and column names) used to construct valid SQL statements.

    Declaration
    public QueryConfiguration NamingConventions { get; }
    Property Value
    Type Description
    QueryConfiguration
    | Improve this Doc View Source

    ReadIsolationLevel

    Isolation level of transactions used during read query execution.

    Declaration
    public IsolationLevel ReadIsolationLevel { get; }
    Property Value
    Type Description
    IsolationLevel
    | Improve this Doc View Source

    ReplayFilterSettings

    Settings specific to replay filter rules used when replaying events from database back to the persistent actors.

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

    TimestampProviderTypeName

    The fully qualified name of the type that should be used as timestamp provider.

    Declaration
    public string TimestampProviderTypeName { get; }
    Property Value
    Type Description
    String
    | Improve this Doc View Source

    WriteIsolationLevel

    Isolation level of transactions used during write query execution.

    Declaration
    public IsolationLevel WriteIsolationLevel { get; }
    Property Value
    Type Description
    IsolationLevel

    Extension Methods

    ObjectExtensions.IsDefaultForType<T>(T)
    ObjectExtensions.AsOption<T>(T)
    Extensions.AsInstanceOf<T>(Object)
    In This Article
    • githubImprove this Doc
    • View Source
    Back to top
    Contribute
    • Project Chat
    • Discussion Forum
    • Source Code
    Support
    • Akka.NET Support Plans
    • Akka.NET Observability Tools
    • Akka.NET Training & Consulting
    Maintained By
    • Petabridge - The Akka.NET Company
    • Learn Akka.NET