Aspire.Hosting.ClickHouse 13.4.6

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package Aspire.Hosting.ClickHouse --version 13.4.6
                    


                    

                
NuGet\Install-Package Aspire.Hosting.ClickHouse -Version 13.4.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="Aspire.Hosting.ClickHouse" Version="13.4.6" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Aspire.Hosting.ClickHouse" Version="13.4.6" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Aspire.Hosting.ClickHouse" />
                    


                            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 Aspire.Hosting.ClickHouse --version 13.4.6
                    


                    

                
#r "nuget: Aspire.Hosting.ClickHouse, 13.4.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. 
#:package Aspire.Hosting.ClickHouse@13.4.6
#: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=Aspire.Hosting.ClickHouse&version=13.4.6
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Aspire.Hosting.ClickHouse&version=13.4.6
                    


                            Install as a Cake Tool

Aspire.Hosting.ClickHouse

ClickHouse hosting integration for Aspire. Adds ClickHouse container resources, databases, data volumes, and health checks to the Aspire app model.

Usage

In your AppHost project, add a ClickHouse server and database:

var builder = DistributedApplication.CreateBuilder(args);

var clickhouse = builder.AddClickHouse("clickhouse")
                        .WithDataVolume();

var db = clickhouse.AddDatabase("clickhousedb");

builder.AddProject<Projects.MyApi>("api")
       .WithReference(db)
       .WaitFor(db);

builder.Build().Run();

Features

  • Runs clickhouse/clickhouse-server as a container resource
  • Automatic secure password generation
  • Automatic database creation on startup via AddDatabase()
  • Health checks via the ClickHouse HTTP /ping endpoint
  • Data persistence with WithDataVolume() and WithDataBindMount()
  • Custom credentials via Aspire parameters

Configuration

Pass custom credentials:

var password = builder.AddParameter("clickhouse-pass", secret: true);
var clickhouse = builder.AddClickHouse("clickhouse", password: password);

Use Aspire.ClickHouse.Driver in your service projects to register ClickHouseDataSource with health checks, tracing, and configuration binding.

More information

Product Compatible and additional computed target framework versions.
.NET 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.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  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.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Aspire.Hosting.ClickHouse:

Package Downloads
Flare.Hosting.Aspire

.NET Aspire hosting integration for Flare, a self-hosted OpenTelemetry-native log dashboard. Adds the whole Flare stack (ClickHouse, Redis, OTLP ingest, query API, dashboard) to your AppHost with builder.AddFlare("flare"), wrapping Flare's published Docker Hub images.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
13.4.6 3,726 7/8/2026
13.3.5 10,209 5/25/2026
13.1.2 2,724 3/2/2026
0.0.1-test 127 2/27/2026