nextorm.clickhouse 1.0.9

Nextorm — ClickHouse provider

nextorm.clickhouse adds ClickHouse support to Nextorm — a zero-SQL object-relational mapper for .NET that turns typed C# queries into SQL and materializes rows without change tracking. The package supplies the ClickHouse dialect, ClickHouse-only fluent members and the UseClickHouse builder extension over the official ClickHouse.Driver.

Installation

All current nextorm releases are prereleases, so --prerelease is required:

dotnet add package nextorm --prerelease
dotnet add package nextorm.clickhouse --prerelease

Package Manager Console: Install-Package nextorm -Prerelease and Install-Package nextorm.clickhouse -Prerelease.

Usage

using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;
using NextORM.Core;
using NextORM.ClickHouse;

var builder = new DataContextBuilder()
    .UseClickHouse("Host=localhost;Port=8123;Database=app;Username=default;Password=secret");
using var dataContext = builder.CreateDataContext();

await foreach (var row in dataContext.From<IOrder>()
                                     .Where(order => order.Total > 100)
                                     .Select(order => new { order.Id, order.Total })
                                     .ToAsyncEnumerable())
{
    Console.WriteLine($"{row.Id}: {row.Total}");
}

[SqlTable("orders")]
public interface IOrder
{
    [Key]
    [Column("id")]
    int Id { get; set; }

    [Column("total")]
    decimal Total { get; set; }
}

Values are bound as @name parameters, which the driver rewrites to ClickHouse's native {name:Type} form; identifiers are backtick-quoted. UseClickHouse also accepts an open DbConnection.

Good to know

• The ClickHouse-only fluent members — Final, PreWhere, Settings, Sample, LimitBy, WithTotals, ArrayJoin/LeftArrayJoin, the semi/anti/paste joins and j => j.Global() — ship in this package as extension methods: add using NextORM.ClickHouse;.
• There are no transactions, no statement batches and no stored procedures; ClickHouse rejects them.
• SelectWhereMax/SelectWhereMin map to native argMin/argMax, and bulk insert uses the portable INSERT … VALUES path.

Documentation

• Connecting a provider: ClickHouse
• Quickstart
• Query reuse: plan cache vs Prepare()
• Comparisons and benchmarks

Status

Beta: every release so far is a prerelease, the public API still changes between them, and backward compatibility is not preserved yet. Release notes are on GitHub Releases.

License

MIT