CSharpDB.Service 1.7.0

CSharpDB.Service

Compatibility facade for hosting CSharpDB in ASP.NET Core, Blazor, or MCP server applications.

Overview

CSharpDB.Service now delegates to CSharpDB.Client.

Its purpose is transition compatibility for existing in-process hosts that still inject CSharpDbService. The authoritative database API lives in CSharpDB.Client; this package preserves the old DI shape, events, and model surface while the repo retires direct service usage.

Features

• Compatibility layer: Existing hosts can keep injecting CSharpDbService
• Thread-safe wrapper: Calls are serialized via SemaphoreSlim
• DI-ready: Constructor still reads the "CSharpDB" connection string from IConfiguration
• Event bridge: Preserves TablesChanged, SchemaChanged, and ProceduresChanged
• Delegates to client: Schema, CRUD, SQL, procedures, saved queries, and diagnostics now flow through CSharpDB.Client

Usage

ASP.NET Core Registration

// appsettings.json
{
    "ConnectionStrings": {
        "CSharpDB": "Data Source=myapp.db"
    }
}

// Program.cs
builder.Services.AddSingleton<CSharpDbService>();

Service API

using CSharpDB.Service;

public class MyController(CSharpDbService db)
{
    // Browse a table with pagination
    public async Task<TableBrowseResult> GetUsers(int page = 1)
        => await db.BrowseTableAsync("users", page, pageSize: 25);

    // Get a single row by primary key
    public async Task<Dictionary<string, object?>> GetUser(string pk)
        => await db.GetRowByPkAsync("users", pk);

    // Insert a row
    public async Task CreateUser(Dictionary<string, string?> values)
        => await db.InsertRowAsync("users", values);

    // Execute arbitrary SQL
    public async Task<SqlExecutionResult> RunSql(string sql)
        => await db.ExecuteSqlAsync(sql);

    // Schema introspection
    public async Task<List<string>> GetTables()
        => await db.GetTableNamesAsync();

    // Storage diagnostics
    public async Task<object> InspectDatabase()
        => await db.InspectStorageAsync();
}

Schema Management

// DDL operations
await db.CreateIndexAsync("users", "idx_email", "email", isUnique: true);
await db.CreateViewAsync("active_users", "SELECT * FROM users WHERE active = 1");
await db.RenameTableAsync("users", "app_users");
await db.AddColumnAsync("app_users", "created_at", "TEXT");
await db.DropColumnAsync("app_users", "legacy_field");

Storage Diagnostics

// Inspect the database file
var report = await db.InspectStorageAsync();

// Check WAL integrity
var walReport = await db.CheckWalAsync();

// Inspect a specific page
var pageInfo = await db.InspectPageAsync(pageId: 5);

// Verify all indexes
var indexReport = await db.CheckIndexesAsync();

Procedure Catalog

using CSharpDB.Core;
using CSharpDB.Service.Models;

await db.CreateProcedureAsync(new ProcedureDefinition
{
    Name = "GetUserById",
    BodySql = "SELECT * FROM users WHERE id = @id;",
    Parameters =
    [
        new ProcedureParameterDefinition
        {
            Name = "id",
            Type = DbType.Integer,
            Required = true,
        }
    ],
    IsEnabled = true,
    CreatedUtc = DateTime.UtcNow,
    UpdatedUtc = DateTime.UtcNow,
});

var execution = await db.ExecuteProcedureAsync("GetUserById", new Dictionary<string, object?>
{
    ["id"] = 1L,
});

Result Models

Installation

dotnet add package CSharpDB.Service

For the recommended all-in-one package:

dotnet add package CSharpDB

Dependencies

• CSharpDB.Client - authoritative database API
• CSharpDB.Sql - SQL splitting for compatibility event notifications
• Microsoft.Extensions.Configuration.Abstractions - configuration binding

Related Packages

License

MIT - see LICENSE for details.