Toggly.FeatureManagement.Storage.EntityFramework 3.7.0

Toggly Entity Framework Snapshot Provider

Entity Framework Core snapshot provider for Toggly Feature Management. Stores feature flag snapshots in any database supported by Entity Framework Core (SQL Server, PostgreSQL, MySQL, SQLite, etc.).

Installation

dotnet add package Toggly.FeatureManagement.Storage.EntityFramework

You'll also need to install the appropriate EF Core database provider for your database:

# SQL Server
dotnet add package Microsoft.EntityFrameworkCore.SqlServer

# PostgreSQL
dotnet add package Npgsql.EntityFrameworkCore.PostgreSQL

# MySQL
dotnet add package Pomelo.EntityFrameworkCore.MySql

# SQLite
dotnet add package Microsoft.EntityFrameworkCore.Sqlite

Usage

Basic Setup

using Toggly.FeatureManagement.Storage.EntityFramework.Configuration;

// In Program.cs or Startup.cs
services.AddTogglyEntityFrameworkSnapshotProvider(
    options => options.UseSqlServer(Configuration.GetConnectionString("DefaultConnection"))
);

// Then configure Toggly as usual
services.AddTogglyFeatureManagement(options => {
    options.AppKey = "your-app-key";
    options.Environment = "production";
});

With Custom Settings

services.AddTogglyEntityFrameworkSnapshotProvider(
    options => options.UseSqlServer(Configuration.GetConnectionString("DefaultConnection")),
    settings => {
        settings.DocumentName = "my_features";      // Default: "toggly_features"
        settings.JwkDocumentName = "my_jwks";       // Default: "toggly_jwks"
        settings.AutoCreateTable = true;            // Default: true
    }
);

With Existing DbContext Registration

If you've already registered TogglyEntities in your DI container:

// Register the DbContext separately
services.AddDbContext<TogglyEntities>(options =>
    options.UseNpgsql(Configuration.GetConnectionString("PostgresConnection"))
);

// Then just add the snapshot provider
services.AddTogglyEntityFrameworkSnapshotProvider();

Embedded catalog store

The embedded dashboard stores its editable, authoritative catalog separately from cloud-definition snapshots. Register it with its own database options:

using Toggly.FeatureManagement.Storage.EntityFramework.Configuration;

services.AddTogglyEntityFrameworkCatalogStore(options =>
    options.UseSqlite("Data Source=toggly.db"));

The registration uses IDbContextFactory<TogglyCatalogDbContext> and opens one context per read or write. It never calls EnsureCreated() and never changes TogglySnapshots; create the dedicated TogglyCatalogs table as part of application provisioning.

The package includes creation scripts for SQLite, SQL Server, and PostgreSQL in its schema package folder:

• TogglyCatalogs.sqlite.sql
• TogglyCatalogs.sqlserver.sql
• TogglyCatalogs.postgresql.sql

For the SQLite sample application only, it is acceptable to call EnsureCreatedAsync() on TogglyCatalogDbContext during explicit sample setup. Production applications should apply the matching catalog-only script or an equivalent migration before serving requests.

Each persisted catalog has an application-generated revision token. TryWriteAsync creates only when the expected revision is null; later writes must submit the revision returned by the preceding read or write. Concurrent updates return a conflict and the current stored catalog. The catalog name is retained verbatim, while its SHA-256 digest is used as the table key.

Database Examples

SQL Server

services.AddTogglyEntityFrameworkSnapshotProvider(
    options => options.UseSqlServer("Server=localhost;Database=MyApp;Trusted_Connection=True;")
);

PostgreSQL

services.AddTogglyEntityFrameworkSnapshotProvider(
    options => options.UseNpgsql("Host=localhost;Database=myapp;Username=user;Password=pass")
);

SQLite

services.AddTogglyEntityFrameworkSnapshotProvider(
    options => options.UseSqlite("Data Source=toggly.db")
);

MySQL

services.AddTogglyEntityFrameworkSnapshotProvider(
    options => options.UseMySql(
        "Server=localhost;Database=myapp;User=user;Password=pass;",
        ServerVersion.AutoDetect(connectionString)
    )
);

Table Schema

The provider creates a single table TogglySnapshots with the following schema:

Auto Table Creation

By default, the provider will automatically create the table if it doesn't exist when AutoCreateTable is set to true (default).

If you prefer to manage database schema yourself, set AutoCreateTable = false and run the appropriate migration:

-- SQL Server
CREATE TABLE TogglySnapshots (
    Id NVARCHAR(100) NOT NULL PRIMARY KEY,
    Data NVARCHAR(MAX) NOT NULL,
    Signature NVARCHAR(1000) NULL,
    KeyId NVARCHAR(100) NULL,
    Timestamp BIGINT NULL,
    UpdatedAt DATETIME2 NOT NULL
);

-- PostgreSQL
CREATE TABLE "TogglySnapshots" (
    "Id" VARCHAR(100) NOT NULL PRIMARY KEY,
    "Data" TEXT NOT NULL,
    "Signature" VARCHAR(1000) NULL,
    "KeyId" VARCHAR(100) NULL,
    "Timestamp" BIGINT NULL,
    "UpdatedAt" TIMESTAMP NOT NULL
);

Configuration Options

Related Packages

• Toggly.FeatureManagement - Core feature management library
• Toggly.FeatureManagement.Storage.RavenDB - RavenDB snapshot provider
• Toggly.FeatureManagement.Storage.DistributedCache - Distributed cache snapshot provider

License

MIT License - see LICENSE for details.