Cirreum.Runtime.Persistence 1.0.47

Cirreum.Runtime.Persistence

Simplified persistence configuration for Cirreum runtime applications

Overview

Cirreum.Runtime.Persistence provides a unified persistence layer configuration for the Cirreum framework. It simplifies database integration by offering a single extension method that automatically registers and configures multiple persistence providers with built-in health checks.

Installation

dotnet add package Cirreum.Runtime.Persistence

Usage

Add persistence to your application with a single line:

var builder = WebApplication.CreateBuilder(args);

// Add persistence support
builder.AddPersistence();

var app = builder.Build();

This automatically:

• Registers Azure Cosmos DB persistence services
• Registers SQL Server persistence services
• Configures health checks for database connectivity
• Prevents duplicate service registration
• Integrates with the Cirreum service provider infrastructure

Supported Providers

Features

• Simple Integration: One method to configure all persistence needs
• Multi-Provider Support: Built-in support for both NoSQL (Cosmos DB) and relational (SQL Server, SQLite) databases
• Declarative Indexing Policies: Entity attribute-driven Cosmos DB indexing configuration (included/excluded paths, composite indexes, spatial indexes)
• Health Checks: Automatic health check registration for monitoring
• Duplicate Prevention: Smart registration prevents service conflicts
• Extensible Design: Built on the Cirreum service provider pattern for easy extension

Configuration

Configure persistence providers in appsettings.json:

{
  "ServiceProviders": {
    "Persistence": {
      "Azure": {
        "default": {
          "Name": "MyCosmosDb",
          "DatabaseId": "my-database",
          "OptimizeBandwidth": true,
          "IsAutoResourceCreationEnabled": true
        }
      },
      "SqlServer": {
        "default": {
          "Name": "MySqlServer",
          "UseAzureAuthentication": true,
          "CommandTimeoutSeconds": 30,
          "HealthOptions": {
            "Query": "SELECT 1",
            "Timeout": "00:00:05"
          }
        }
      },
      "Sqlite": {
        "default": {
          "Name": "MySqlite",
          "CommandTimeoutSeconds": 30,
          "HealthOptions": {
            "Query": "SELECT 1",
            "Timeout": "00:00:05"
          }
        }
      }
    }
  },
  "ConnectionStrings": {
    "MyCosmosDb": "AccountEndpoint=https://your-account.documents.azure.com:443/;AccountKey=...",
    "MySqlServer": "Server=myserver.database.windows.net;Database=MyDb"
    "MySqlite": "Data Source=mydb.sqlite"
  }
}

The Name property resolves the connection string via Configuration.GetConnectionString(name). For production, store connection strings in Azure Key Vault using the naming convention ConnectionStrings--{Name}.

For detailed configuration options, see the individual provider documentation:

• Cirreum.Persistence.Azure
• Cirreum.Persistence.SqlServer
• Cirreum.Persistence.SQLite

Versioning

Cirreum.Runtime.Persistence follows Semantic Versioning:

• Major - Breaking API changes
• Minor - Truly new features, backward compatible
• Patch - Additional implementations, backward compatible

Given its foundational role, major version bumps are rare and carefully considered.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Cirreum Foundation Framework
Layered simplicity for modern .NET