TCIS.Persistence.Abstractions 1.0.0-rc.33

TCIS.Persistence.Abstractions

📖 Overview

TCIS.Persistence.Abstractions provides standard interfaces and configuration classes (Options) for the Persistence layer (Data access and storage) in the TCIS Framework. This library helps decouple business logic from specific ORM technologies (such as EF Core or Dapper).

✨ Features

• IDbConnectionFactory: Encapsulates the initialization and opening of Database Connections (TenantAware).
• IDapperContext: Supports data querying through Dapper.
• PersistenceOptions: Standard mapping for database configurations.
• IDbConnectionFactory<TContext> / IDapperContext<TContext>: the same two contracts, keyed by a data-context type — for a modular monolith where each module owns its database.
• PersistenceOptionsName: the single place that derives the named-options name from a context type. Registration and lookup both go through it, so the two can never drift apart.

Why the generic pair exists

PersistenceOptions in its bare form is bound to the fixed ConfigurationStore section, and there is exactly one unnamed instance per process. Two modules registering their own data layer therefore share one connection string — each overwriting the other's, silently. The generic contracts carry the module identity in the type, and the options behind them are named after that type.

Registration lives in TCIS.Persistence.EntityFrameworkCore (AddTModulePersistence<TDbContext>).

📦 Installation

dotnet add package TCIS.Persistence.Abstractions

⚙️ Configuration (appsettings.json)

{
  "ConfigurationStore": {
    "ConnectionString": "Server=myServerAddress;Database=myDataBase;User Id=myUsername;Password=myPassword;",
    "ReadConnectionString": "Server=myReplicaAddress;Database=myDataBase;User Id=myUsername;Password=myPassword;"
  }
}

🚀 Usage

Use PersistenceOptions alongside the IOptions pattern or pass it directly into the underlying Factory classes.

using Microsoft.Extensions.Options;
using TCIS.Persistence.Data;

public class MyDatabaseService
{
    private readonly PersistenceOptions _options;
    
    public MyDatabaseService(IOptions<PersistenceOptions> options)
    {
        _options = options.Value;
    }
    
    public void DisplayConfig()
    {
        Console.WriteLine($"Primary DB: {_options.ConnectionString}");
        Console.WriteLine($"Replica DB: {_options.ReadConnectionString ?? _options.ConnectionString}");
    }
}