EF.CH 10.1.0

EF.CH

Entity Framework Core provider for ClickHouse

EF.CH brings ClickHouse into the Entity Framework Core ecosystem. Define your models in C#, write LINQ queries, and run migrations -- all against ClickHouse's columnar analytics engine.

Quick Start

dotnet add package EF.CH

using Microsoft.EntityFrameworkCore;
using EF.CH.Extensions;

public class Event
{
    public Guid Id { get; set; }
    public DateTime Timestamp { get; set; }
    public string EventType { get; set; } = string.Empty;
    public decimal Amount { get; set; }
}

public class AppDbContext : DbContext
{
    public DbSet<Event> Events => Set<Event>();

    protected override void OnConfiguring(DbContextOptionsBuilder options)
        => options.UseClickHouse("Host=localhost;Port=8123;Database=default");

    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        modelBuilder.Entity<Event>(entity =>
        {
            entity.HasKey(e => e.Id);
            entity.UseMergeTree(e => new { e.Timestamp, e.EventType })
                .HasPartitionBy(e => e.Timestamp, PartitionGranularity.Month);
        });
    }
}

// Insert
await using var db = new AppDbContext();
await db.Database.EnsureCreatedAsync();

db.Events.Add(new Event
{
    Id = Guid.NewGuid(),
    Timestamp = DateTime.UtcNow,
    EventType = "purchase",
    Amount = 99.95m
});
await db.SaveChangesAsync();

// Query
var summary = await db.Events
    .GroupBy(e => e.EventType)
    .Select(g => new { Type = g.Key, Total = g.Sum(e => e.Amount) })
    .ToListAsync();

Feature Highlights

ClickHouse for EF Core Developers

If you are coming from SQL Server or PostgreSQL, ClickHouse works differently in several fundamental ways. EF.CH bridges these gaps where possible and surfaces the differences clearly where it cannot.

See ClickHouse for EF Developers for the full guide.

Requirements

Runtime dependencies: ClickHouse.Driver 0.9.0, Microsoft.EntityFrameworkCore.Relational 8.0.13.

Documentation

Samples

All samples are standalone projects in the samples/ directory. Build individually:

dotnet build samples/QuickStartSample/

Getting Started

Core Features

Advanced

Real-World Patterns

License

MIT. See LICENSE for details.

Acknowledgments

Built by Daniel Bunting. Powered by ClickHouse.Driver and Microsoft.EntityFrameworkCore.