ClickHouse.EntityFrameworkCore 0.1.0-preview

This is a prerelease version of ClickHouse.EntityFrameworkCore.

dotnet add package ClickHouse.EntityFrameworkCore --version 0.1.0-preview

NuGet\Install-Package ClickHouse.EntityFrameworkCore -Version 0.1.0-preview

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="ClickHouse.EntityFrameworkCore" Version="0.1.0-preview" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="ClickHouse.EntityFrameworkCore" Version="0.1.0-preview" />
                    

                            Directory.Packages.props

<PackageReference Include="ClickHouse.EntityFrameworkCore" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add ClickHouse.EntityFrameworkCore --version 0.1.0-preview

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: ClickHouse.EntityFrameworkCore, 0.1.0-preview"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#:package ClickHouse.EntityFrameworkCore@0.1.0-preview

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=ClickHouse.EntityFrameworkCore&version=0.1.0-preview&prerelease
                    

                            Install as a Cake Addin

#tool nuget:?package=ClickHouse.EntityFrameworkCore&version=0.1.0-preview&prerelease
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

ClickHouse Entity Framework Core Provider

An Entity Framework Core provider for ClickHouse, built on ClickHouse.Driver.

Getting Started

await using var ctx = new AnalyticsContext();

var topPages = await ctx.PageViews
    .Where(v => v.Date >= new DateOnly(2024, 1, 1))
    .GroupBy(v => v.Path)
    .Select(g => new { Path = g.Key, Views = g.Count() })
    .OrderByDescending(x => x.Views)
    .Take(10)
    .ToListAsync();

public class AnalyticsContext : DbContext
{
    public DbSet<PageView> PageViews { get; set; }

    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
        => optionsBuilder.UseClickHouse("Host=localhost;Port=9000;Database=analytics");
}

public class PageView
{
    public long Id { get; set; }
    public string Path { get; set; }
    public DateOnly Date { get; set; }
    public string UserAgent { get; set; }
}

Supported Types

String, Bool, Int8/Int16/Int32/Int64, UInt8/UInt16/UInt32/UInt64, Float32/Float64, Decimal(P, S), Date/Date32, DateTime, DateTime64(P, 'TZ'), FixedString(N), UUID

Supported LINQ Operations

Where, OrderBy, Take, Skip, Select, First, Single, Any, Count, Sum, Min, Max, Average, Distinct, GroupBy

String methods: Contains, StartsWith, EndsWith, IndexOf, Replace, Substring, Trim, ToLower, ToUpper, Length, and string concatenation.

Documentation

For full documentation, see the GitHub repository.

Product	Compatible and additional computed target framework versions.
.NET	net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net10.0
- ClickHouse.Driver (>= 1.0.0)
- Microsoft.EntityFrameworkCore.Relational (>= 10.0.2)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last Updated
0.1.0-preview	39	3/9/2026

v0.1.0
---
Initial preview release.

* Read-only functionality.
* Limited type support: `String`, `Bool`, `Int8`/`Int16`/`Int32`/`Int64`, `UInt8`/`UInt16`/`UInt32`/`UInt64`, `Float32`/`Float64`, `Decimal(P, S)`, `Date`/`Date32`, `DateTime`, `DateTime64(P, 'TZ')`, `FixedString(N)`, `UUID`.
* Basic aggregations: `Where`, `OrderBy`, `Take`, `Skip`, `Select`, `First`, `Single`, `Any`, `Count`, `Sum`, `Min`, `Max`, `Average`, `Distinct`, `GroupBy`.
* String methods: `Contains`, `StartsWith`, `EndsWith`, `IndexOf`, `Replace`, `Substring`, `Trim`, `ToLower`, `ToUpper`, `Length`.