SoftwareDriven.Persistence.EF.SQLite 3.1.0

SoftwareDriven.Persistence.EF.SQLite

Entity Framework Core / SQLite provider for SoftwareDriven.Persistence. Bundles the EF Core base provider. Targets net10.0.

Installation

dotnet add package SoftwareDriven.Persistence.EF.SQLite

Setup

// Register EF manager and providers
services.AddEntityFramework<SQLiteManager>();
services.AddEFProviderScoped<MyModel>((modelBuilder, entityBuilder) =>
{
    entityBuilder.HasMany(x => x.Children).WithOne().OnDelete(DeleteBehavior.Cascade);
});

// Connect
var manager = serviceProvider.GetRequiredService<EFManager>() as SQLiteManager;
await manager!.Connect("data/mydb.db");

With DbContext options

await manager.Connect("data/mydb.db", options =>
{
    options.EnableSensitiveDataLogging();
});

Provider Registration

// Scoped (recommended for web apps)
services.AddEFProviderScoped<MyModel>(map, registerBaseInterface: true);

// Singleton
services.AddEFProviderSingleton<MyModel>(map, registerBaseInterface: true);

// Without mapping
services.AddEFProviderScoped<SimpleModel>();

The registerBaseInterface parameter controls whether IBasicPersistenceProvider<T> is registered in DI (default: true). Set to false when resolving the concrete EFRepositoryProvider<T> directly.

Entity Mapping

services.AddEFProviderScoped<Order>((modelBuilder, entityBuilder) =>
{
    // Complex types
    modelBuilder.Entity<Address>().ComplexProperty(x => x.Location);

    // Relationships
    entityBuilder.HasMany(x => x.Items).WithOne().OnDelete(DeleteBehavior.Cascade);
});

Usage

var provider = serviceProvider.GetRequiredService<EFRepositoryProvider<MyModel>>();

await provider.CreateOrUpdate(new MyModel { Title = "Hello" });
var results = await provider.FindByExpression(x => x.Title == "Hello");

Maintenance

var statistics = await manager.GetStatistics();
// TotalBytes:       database file plus write-ahead log
// ReclaimableBytes: freelist_count * page_size, i.e. the pages deleting released for reuse only

var result = await manager.Compact();
// BytesBefore / BytesAfter tell what the compaction achieved

Compact() runs VACUUM followed by PRAGMA wal_checkpoint(TRUNCATE). The checkpoint is not optional: in WAL mode VACUUM writes the compacted pages into the write-ahead log and the database file keeps its size until a checkpoint runs.

Note:

• VACUUM rewrites the whole database and therefore needs the double amount of storage while it runs.
• It needs exclusive access; other connections with running statements let it fail.
• Microsoft.Data.Sqlite has no asynchronous path, so Compact() runs synchronously on the calling thread despite its Task based signature. Move it off the UI thread yourself if the database is large.

Features

• SupportsTotalCount: true
• SupportsPagingState: false (offset-based pagination)
• DefaultIdSource: GuidSource
• SupportsMaintenance: true (VACUUM plus WAL checkpoint)
• Implements IBasicPersistenceProvider<T> (not the extended IPersistenceProvider<T>)

License

MIT