SharpJuice.ClickHouse 1.0.6

There is a newer version of this package available.
See the version list below for details.
dotnet add package SharpJuice.ClickHouse --version 1.0.6                
NuGet\Install-Package SharpJuice.ClickHouse -Version 1.0.6                
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="SharpJuice.ClickHouse" Version="1.0.6" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add SharpJuice.ClickHouse --version 1.0.6                
#r "nuget: SharpJuice.ClickHouse, 1.0.6"                
#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.
// Install SharpJuice.ClickHouse as a Cake Addin
#addin nuget:?package=SharpJuice.ClickHouse&version=1.0.6

// Install SharpJuice.ClickHouse as a Cake Tool
#tool nuget:?package=SharpJuice.ClickHouse&version=1.0.6                

Writing .Net objects to ClickHouse

NuGet

Octonica.ClickHouseClient extension for easily writing objects to ClickHouse using bulk insert and ArrayPool for high performance and low memory allocation.

Registration

    ClickHouseConnectionSettings connectionSettings = ...;

    services.AddSingleton<IClickHouseConnectionFactory>(new ClickHouseConnectionFactory(connectionSettings));
    services.AddSingleton<ITableWriterBuilder, TableWriterBuilder>();	
    services.AddSingleton<ClickHouseRepository>();	

Flat object

    public sealed class ClickHouseRepository 
    {
        private readonly ITableWriter<Order> _tableWriter;
        
        public ClickHouseRepository(ITableWriterBuilder tableWriterBuilder)
        {
            _tableWriter = tableWriterBuilder
                .For<Order>("table_name")
                .AddColumn("order_id", a => a.OrderId)
                .AddColumn("user_id", a => a.UserId)
                .AddColumn("created_at", a => a.CreatedAt)                
		    .Build();
        }

        public async Task Add(IReadOnlyCollection<Order> orders, CancellationToken token)
        {
	    ...
            await _tableWriter.Insert(orders, token);
	    ...
        }
    }

Nested objects

    public sealed class ClickHouseRepository 
    {
        private readonly ITableWriter<Order> _tableWriter;
        
        public ClickHouseRepository(ITableWriterBuilder tableWriterBuilder)
        {
            _tableWriter = tableWriterBuilder
                .For<Order>("table_name")
                .AddColumn("order_id", a => a.OrderId)
                .AddColumn("date", a => a.Date)
                .AddNestedColumn("item", x => x.Items, c => c
                    .AddColumn("id", x => x.Id)
                    .AddColumn("quantity", x => x.Quantity)
                    .AddColumn("name", x => x.Name)
                    .AddColumn("price", x => x.Price))
                .AddNestedColumn(x => x.Discounts, c => c
                    .AddColumn("discount.id", x => x.Id)
                    .AddColumn("discount.name", x => x.Name)
                    .AddColumn("discount.value", x => x.Value))                
                .Build();          
        }

        public async Task Add(IReadOnlyCollection<Order> orders, CancellationToken token)
        {
	    ...
            await _tableWriter.Insert(orders, token);
	    ...
        }
    }

Array join (only one ArrayJoin per writer)

    public sealed class ClickHouseRepository 
    {
        private readonly ITableWriter<Order> _tableWriter;
        
        public ClickHouseRepository(ITableWriterBuilder tableWriterBuilder)
        {
            _tableWriter = tableWriterBuilder
                .For<Order>("table_name")
                .AddColumn("order_id", a => a.OrderId)
                .AddColumn("date", a => a.Date)
                .ArrayJoin(a => a.Items, c => c
                    .AddColumn("item_id", x => x.Id)
                    .AddColumn("item_quantity", x => x.Quantity)
                    .AddColumn("item_name", x => x.Name)
                    .AddColumn("item_price", x => x.Price))
		    .Build();
        }

        public async Task Add(IReadOnlyCollection<Order> orders, CancellationToken token)
        {
	    ...
            await _tableWriter.Insert(orders, token);
	    ...
        }
    }

Performance and memory allocation benchmark (.net 8)

Benchmark source code

Method ObjectsCount Mean Error StdDev Gen0 Gen1 Gen2 Allocated
NestedObject_Writer 1000 71.87 ms 1.425 ms 2.176 ms - - - 1148.29 KB
FlatObject_Writer 1000 73.33 ms 1.159 ms 1.028 ms 375.0000 250.0000 - 2837.81 KB
ClickhouseClient_ColumnWriter 1000 78.63 ms 1.631 ms 4.731 ms 428.5714 142.8571 - 2948.86 KB
NestedObject_Writer 100 101.91 ms 1.629 ms 1.523 ms - - - 205 KB
ClickhouseClient_ColumnWriter 100 102.99 ms 2.008 ms 2.749 ms - - - 368.33 KB
FlatObject_Writer 100 103.24 ms 2.025 ms 2.633 ms - - - 358.71 KB
NestedObject_Writer 10000 281.58 ms 10.143 ms 29.102 ms 1000.0000 - - 9140.61 KB
ClickhouseClient_ColumnWriter 10000 284.90 ms 9.745 ms 27.325 ms 4000.0000 1000.0000 - 27643.59 KB
FlatObject_Writer 10000 302.62 ms 13.242 ms 38.836 ms 4000.0000 1000.0000 - 26020.02 KB
NestedObject_Writer 30000 712.17 ms 23.182 ms 67.622 ms 2000.0000 1000.0000 - 14370.6 KB
ClickhouseClient_ColumnWriter 30000 775.75 ms 22.886 ms 66.396 ms 11000.0000 5000.0000 2000.0000 69326.91 KB
FlatObject_Writer 30000 781.20 ms 24.974 ms 72.057 ms 10000.0000 3000.0000 - 65002.87 KB

Thanks to @deniskuzmin and @LegaNoga

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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
1.0.7 126 5/10/2024
1.0.6 122 3/21/2024
1.0.5 118 3/12/2024
1.0.4 130 2/14/2024
1.0.3 120 2/11/2024
1.0.2 99 2/9/2024
1.0.1 112 2/7/2024
1.0.0 129 1/25/2024