Add built-in support for CockroachDB in Aspire CommunityToolkit

[max2020204]

Related to an existing integration?

Yes

Existing integration

PostgreSQL (Aspire.Hosting.PostgreSQL)

Overview

Aspire currently supports PostgreSQL with a rich container resource builder (AddPostgres(), AddDatabase(), health checks, etc). It would be very beneficial to support CockroachDB as well, since it’s PostgreSQL-wire compatible, resilient, and designed for distributed workloads.

CockroachDB is often used in scalable microservice environments and cloud-native platforms. Adding a first-class integration in the CommunityToolkit would empower users to adopt Aspire in more distributed and elastic workloads.

Usage example

var cockroach = builder.AddCockroachDB("crdb")
.WithDataVolume()
.WithHostPort(26257);

builder.AddProject<Projects.Api>("api")
.WithReference(cockroach)
.WaitFor(cockroach);

Breaking change?

No

Alternatives

Today, users can manually use .AddContainer("cockroachdb") with a custom port and args, but this loses health checks, parameter binding, and resource modeling available in the PostgreSQL integration.

Additional context

CockroachDB works out-of-the-box with most PostgreSQL drivers (e.g., Npgsql), and supports SQL with some limitations (e.g., serial vs GENERATED). Providing official support would help standardize its usage across Aspire-based projects.

Help us help you

Yes, but only if others can assist