CSharpDB.Client 4.0.2

CSharpDB.Client

CSharpDB.Client is the authoritative database API for CSharpDB.

It owns the public client contract used to talk to a database, while transport and lower-level implementation details stay behind that boundary.

Current Direction

• CSharpDB.Client is now the real implementation layer for database access.
• Direct, Http, and Grpc are implemented transports today.
• NamedPipes remains the only future transport target.

Current Transport Model

Create the client with CSharpDbClientOptions:

var client = CSharpDbClient.Create(new CSharpDbClientOptions
{
    Transport = CSharpDbTransport.Direct,
    DataSource = "csharpdb.db",
    HybridDatabaseOptions = new HybridDatabaseOptions
    {
        PersistenceMode = HybridPersistenceMode.IncrementalDurable,
        HotTableNames = ["users"],
        HotCollectionNames = ["session_cache"]
    },
    DirectDatabaseOptions = new DatabaseOptions()
});

The transport can be selected explicitly with Transport. If it is omitted, the client infers it from Endpoint and otherwise defaults to direct.

Direct resolution currently accepts:

• Endpoint as a file path
• Endpoint as file://...
• DataSource
• ConnectionString containing Data Source=...
• optional HybridDatabaseOptions for the lazy-resident hybrid direct mode
• optional DirectDatabaseOptions for direct transport engine/pager tuning

Resolution rules:

• direct is the default when transport cannot be inferred from a network endpoint
• supplied direct inputs must resolve to the same target
• HybridDatabaseOptions is supported only for direct transport and is rejected for Http, Grpc, and NamedPipes
• DirectDatabaseOptions is supported only for direct transport and is rejected for Http, Grpc, and NamedPipes
• http:// and https:// infer Http unless Transport = CSharpDbTransport.Grpc is set explicitly
• pipe:// and npipe:// infer NamedPipes
• Grpc uses http:// or https:// endpoints and talks to CSharpDB.Daemon
• Http uses http:// or https:// endpoints and talks to CSharpDB.Api
• NamedPipes still validates its endpoint shape and then fails with a not-implemented error
• HttpClient is supported for both Http and Grpc
• ApiKey and ApiKeyHeaderName are supported for both Http and Grpc

Use HybridDatabaseOptions when the direct client should run with a lazy resident page cache while persisting committed state back to the resolved file path. Typical patterns are:

• default IncrementalDurable for durable hybrid direct usage with on-demand page warming
• IncrementalDurable plus HotTableNames / HotCollectionNames when selected read-mostly objects should be preloaded into the hybrid cache at open
• Snapshot plus Dispose when the process wants explicit full-image export behavior on close
• Snapshot plus None when the process will call SaveToFileAsync(...) manually

Hot-set warming is a hybrid-only runtime hint. In v1 it:

• warms SQL table B+trees plus SQL secondary indexes
• warms collection backing tables only
• is supported only for IncrementalDurable
• requires the default unbounded pager cache and is rejected for bounded/custom cache setups

Use DirectDatabaseOptions when the in-process engine should open with explicit storage tuning. Typical patterns are:

• UseDirectLookupOptimizedPreset() for hot local direct workloads
• UseDirectColdFileLookupPreset() for cache-pressured direct file reads
• UseHybridFileCachePreset() only for explicit bounded file-cache experiments

Remote transports do not accept either direct-only property because those settings must be configured on the host process instead.

Example HTTP selection:

var client = CSharpDbClient.Create(new CSharpDbClientOptions
{
    Transport = CSharpDbTransport.Http,
    Endpoint = "http://localhost:61818"
});

This resolves to the dedicated CSharpDB.Api REST host.

Example gRPC selection:

var client = CSharpDbClient.Create(new CSharpDbClientOptions
{
    Transport = CSharpDbTransport.Grpc,
    Endpoint = "https://localhost:5001"
});

This resolves to the dedicated CSharpDB.Daemon gRPC host.

When the remote host is configured with API-key mode, set ApiKey once on the client options. The HTTP transport sends it as a request header, and the gRPC transport sends it as call metadata.

var client = CSharpDbClient.Create(new CSharpDbClientOptions
{
    Transport = CSharpDbTransport.Grpc,
    Endpoint = "https://db-host:5821",
    ApiKey = "replace-with-a-secret",
    ApiKeyHeaderName = "X-CSharpDB-Api-Key"
});

API-key mode is shared-secret authentication only. It does not provide JWT, RBAC, mTLS, or TLS termination.

API-Level Sharding

CSharpDB.Client can route requests across multiple ordinary CSharpDB database files with CSharpDbShardedClient. Sharding is an API/daemon feature: each shard is still a standalone database file with its own WAL and commit path.

V1 uses an explicit route context instead of SQL inference. For an e-commerce order-history workload, the route key could be the order month (yyyy-MM):

CSharpDbClientOptions masterOptions = new()
{
    ConnectionString = "Data Source=master.db",
};

await CSharpDbShardedClient.SeedMasterCatalogAsync(masterOptions, new CSharpDbShardingOptions
{
    Keyspace = "orders_by_month",
    MapVersion = 1,
    VirtualBucketCount = 4096,
    Shards =
    [
        new CSharpDbShardDefinition { ShardId = "s0", DataSource = "orders-s0.db" },
        new CSharpDbShardDefinition { ShardId = "s1", DataSource = "orders-s1.db" },
    ],
    BucketRanges =
    [
        new CSharpDbShardBucketRange { StartBucketInclusive = 0, EndBucketExclusive = 2048, ShardId = "s0" },
        new CSharpDbShardBucketRange { StartBucketInclusive = 2048, EndBucketExclusive = 4096, ShardId = "s1" },
    ],
});

await using CSharpDbShardedClient sharded =
    await CSharpDbShardedClient.TryCreateFromMasterCatalogAsync(masterOptions)
    ?? throw new InvalidOperationException("master.db is not sharded.");

ICSharpDbClient juneOrders = sharded.ForRoute(new CSharpDbRouteContext
{
    Keyspace = "orders_by_month",
    Key = "2026-06",
});

await juneOrders.ExecuteSqlAsync("""
    SELECT order_number, order_date, amount
    FROM orders
    WHERE order_month = '2026-06'
    ORDER BY order_date DESC
    LIMIT 25 OFFSET 0;
    """);

New Sharded Setup Versus Existing Databases

SeedMasterCatalogAsync(...) creates sharding metadata. It does not split an existing monolithic database. Use it when you are creating a new sharded setup or when an external migration has already copied data into the shard DBs.

For a large existing unsharded DB, the data must be split first: choose a route key, create shard DBs, copy schema, backfill rows/documents into the correct shards, verify counts and checksums, fence writes for cutover, copy the final delta, and only then seed the master catalog. See docs/sharding-existing-database-migration.md for the internal migration checklist.

Shard definitions can include Phase 6 replica metadata:

new CSharpDbShardDefinition
{
    ShardId = "s1-replica",
    DataSource = "orders-s1-replica.db",
    Role = CSharpDbShardRoles.Replica,
    PrimaryShardId = "s1",
    PromotionEligible = true,
    ReplicationLagBytes = 256,
    LastReplicatedUtc = DateTimeOffset.UtcNow,
}

This first Phase 6 slice is metadata-only. Map snapshots and shard status expose role, primary shard, promotion eligibility, and operator-reported lag. Bucket ranges and exact route-key pins must still reference primary shards. CSharpDB does not copy data to replicas, promote replicas, or reroute traffic based on health in this slice.

Remote clients pass the same route through headers/metadata by setting CSharpDbClientOptions.RouteContext. REST uses X-CSharpDB-Keyspace and X-CSharpDB-Shard-Key; gRPC sends the same names as lowercase metadata.

The route key gets the request to the right database file. Queries should still filter on the route-key column because several route keys can share one physical shard. If a view spans multiple months, the caller explicitly runs multiple routed requests and combines the results.

For paged history that crosses route keys, fill the page in application code: query the newest route first, append its rows, then continue to older route keys until the requested page size is satisfied. For later pages, skip whole routes by count before applying a route-local OFFSET.

Other application patterns are valid when the UI has a bounded route window. A recent-orders view can query the current and previous month, merge by order_date DESC, id DESC, and take the requested page size even if that reads a few extra rows. A date-range filter can compute the month route keys in the range, query each with the same date predicate, and merge/limit the result. An infinite-scroll API can avoid global counts by returning a continuation token that records the remaining route keys and per-route cursor state.

Phase 2 adds an explicit shard-admin surface for topology and operational views:

await using ICSharpDbShardAdminClient shardAdmin =
    CSharpDbClient.CreateShardAdmin(new CSharpDbClientOptions
    {
        Transport = CSharpDbTransport.Grpc,
        Endpoint = "https://db-host:5821",
    });

CSharpDbShardMapSnapshot map = await shardAdmin.GetShardMapAsync();
CSharpDbShardResolution preview = await shardAdmin.ResolveRouteAsync(new CSharpDbRouteContext
{
    Keyspace = "orders_by_month",
    Key = "2026-06",
});
IReadOnlyList<CSharpDbShardStatus> status = await shardAdmin.GetShardStatusAsync();

The shard-admin surface is separate from normal ICSharpDbClient data operations. It exposes the map snapshot, route simulation, per-shard health, and explicit execute-on-all-shards SQL for schema setup. It does not add automatic cross-shard query planning.

For diagnostics and Admin read screens, use the read-only fan-out helper:

IReadOnlyList<CSharpDbShardSqlExecutionResult> counts =
    await shardAdmin.ExecuteReadOnlySqlOnAllShardsAsync(
        "SELECT COUNT(*) FROM orders;");

ExecuteReadOnlySqlOnAllShardsAsync(...) validates the SQL before fan-out and rejects DDL/DML statements. Results stay grouped by shard so callers can show which shard produced each row set or error. Use ExecuteSqlOnAllShardsAsync(...) only for explicit operator actions such as schema setup.

Operator-managed catalog support stores the active shard map in a CSharpDB master catalog database. Hosts open only the normal master database and call TryCreateFromMasterCatalogAsync(...); when the opened DB contains an active shard map, the sharded client loads that map from the master catalog. Catalog updates are validated and persisted as pending map changes; they do not mutate the live router in-process.

CSharpDbClientOptions masterOptions = new()
{
    ConnectionString = "Data Source=master.db",
};

CSharpDbShardedClient? shardAdmin =
    await CSharpDbShardedClient.TryCreateFromMasterCatalogAsync(masterOptions);
if (shardAdmin is null)
{
    // master.db is currently unsharded.
    return;
}

CSharpDbShardCatalogState catalog = await shardAdmin.GetShardCatalogAsync();

CSharpDbShardCatalogValidationResult validation =
    await shardAdmin.ValidateShardCatalogUpdateAsync(new CSharpDbShardCatalogUpdateRequest
    {
        Options = proposedOptions,
        ExpectedCurrentMapVersion = catalog.ActiveMap.MapVersion,
    });

CSharpDbShardCatalogApplyResult applied =
    await shardAdmin.ApplyShardCatalogUpdateAsync(new CSharpDbShardCatalogUpdateRequest
    {
        Options = proposedOptions,
        ExpectedCurrentMapVersion = catalog.ActiveMap.MapVersion,
        AllowMetadataOnlyOwnershipChange = true,
        Operator = "ops",
        Comment = "data was moved by migration job 2026-06-01",
    });

ApplyShardCatalogUpdateAsync(...) returns RequiresRestart = true when it writes the master catalog. Recreate the sharded client or restart the daemon to activate the new map. Bucket ownership or exact-key pin changes are rejected unless the operator explicitly acknowledges the metadata-only change.

Phase 4 starts controlled resharding with exact route-key migration. The operator supplies a manifest that names the route-owned tables and collections; the client fences writes for that route key, copies matching rows/documents to the destination shard, verifies counts and checksums, then writes a pending exact-key pin to the catalog.

CSharpDbShardMigrationResult migrated =
    await shardAdmin.MigrateExactRouteKeyAsync(new CSharpDbShardExactKeyMigrationRequest
    {
        Keyspace = "orders_by_month",
        RouteKey = "2026-05",
        DestinationShardId = "archive-1",
        ExpectedCurrentMapVersion = catalog.ActiveMap.MapVersion,
        Operator = "ops",
        Manifest = new CSharpDbShardMigrationManifest
        {
            Tables =
            [
                new CSharpDbShardMigrationTableManifest
                {
                    TableName = "orders",
                    RouteKeyColumn = "order_month",
                    PrimaryKeyColumn = "id",
                },
            ],
            Collections =
            [
                new CSharpDbShardMigrationCollectionManifest
                {
                    CollectionName = "order_documents",
                    RouteKeyPropertyName = "orderMonth",
                },
            ],
        },
    });

Exact-key migration requires writable catalog mode. A successful migration returns Status = "PendingActivation" and RequiresRestart = true; the active router is not changed until the sharded client is recreated. If shard-directory entries point at the moved route key, the pending catalog map updates those entries to the destination shard and pending map version. Writable catalog mode also records migration history that can be queried later:

IReadOnlyList<CSharpDbShardMigrationHistoryEntry> history =
    await shardAdmin.GetShardMigrationHistoryAsync();

Failed, verification-failed, and catalog-apply-failed movement outcomes set RequiresOperatorRecovery = true and include a RecoveryAction message. Use those fields to separate a simple rejected request from a recoverable partial movement state that needs cleanup, retry, or metadata-only confirmation.

Bucket-range movement uses the same manifest shape but moves all unpinned route keys whose SHA-256 bucket falls inside the requested range:

CSharpDbShardMigrationResult movedBuckets =
    await shardAdmin.MigrateBucketRangeAsync(new CSharpDbShardBucketRangeMigrationRequest
    {
        Keyspace = "orders_by_month",
        SourceShardId = "hot-1",
        DestinationShardId = "archive-1",
        StartBucketInclusive = 1024,
        EndBucketExclusive = 1536,
        ExpectedCurrentMapVersion = catalog.ActiveMap.MapVersion,
        Operator = "ops",
        Manifest = manifest,
    });

Bucket-range movement requires the requested buckets to be wholly owned by the source shard. Exact route-key pins are left in place and are not moved by bucket ownership changes. A successful move writes a pending bucket map and still requires recreating the sharded client or restarting the daemon.

The controlled movement APIs do not infer ownership from arbitrary SQL predicates.

V1 intentionally supports single-shard operations only. Cross-shard joins, cross-shard transactions, automatic resharding, replication, and failover remain out of scope. Changing bucket ownership requires an operator-controlled data migration before the map is changed.

Supported Surface

The current ICSharpDbClient includes:

• database info and data source metadata
• tables, schemas, row counts, browse, and primary-key lookup
• row insert, update, and delete
• table and column DDL
• indexes, views, and triggers
• saved queries
• procedures and procedure execution
• SQL execution with multi-statement splitting
• client-managed transaction sessions
• document collections
• maintenance: checkpoint, backup/restore, reindex, vacuum, and foreign-key retrofit migration
• storage diagnostics

Foreign-Key Retrofit Migration

Older databases do not automatically gain foreign-key metadata just because they are opened on a newer engine. Use MigrateForeignKeysAsync(...) when you want to validate and then persist FK metadata onto existing tables:

using CSharpDB.Client;
using CSharpDB.Client.Models;

await using var client = CSharpDbClient.Create(new CSharpDbClientOptions
{
    DataSource = "mydata.db"
});

var spec = new[]
{
    new ForeignKeyMigrationConstraintSpec
    {
        TableName = "orders",
        ColumnName = "customer_id",
        ReferencedTableName = "customers",
        ReferencedColumnName = "id",
        OnDelete = ForeignKeyOnDeleteAction.Cascade,
    },
};

var preview = await client.MigrateForeignKeysAsync(new ForeignKeyMigrationRequest
{
    ValidateOnly = true,
    ViolationSampleLimit = 100,
    Constraints = spec,
});

if (preview.Succeeded)
{
    await client.MigrateForeignKeysAsync(new ForeignKeyMigrationRequest
    {
        BackupDestinationPath = "pre-fk.backup.db",
        Constraints = spec,
    });
}

The same request/response contract flows through the direct, HTTP, and gRPC transports.

Implementation Notes

• The direct client depends on CSharpDB.Engine, CSharpDB.ImportExport, CSharpDB.Sql, and CSharpDB.Storage.Diagnostics.
• CSharpDB.Client does not reference CSharpDB.Data.
• The HTTP transport runs against CSharpDB.Api and now covers the same public ICSharpDbClient surface as the direct client.
• The gRPC transport uses generated protobuf RPC methods, not a generic JSON tunnel.
• Dynamic values such as row cells, procedure args, and collection documents are carried through a recursive protobuf value contract that preserves blobs and nested objects.
• The direct transport talks to the engine in-process, the HTTP transport uses JSON endpoints, and the gRPC transport uses the dedicated daemon host.
• Internal tables such as __procedures, __saved_queries, and collection backing tables are hidden from normal table listing.

Dependency Injection

services.AddCSharpDbClient(new CSharpDbClientOptions
{
    DataSource = "csharpdb.db"
});

or

services.AddCSharpDbClient(sp => new CSharpDbClientOptions
{
    ConnectionString = "Data Source=csharpdb.db"
});

Design Rule

New database-facing functionality should be added here first.

Host-specific concerns should not create a second authoritative API beside CSharpDB.Client.