Skip to content

README.md

Latest commit

 

History

History
40 lines (24 loc) · 1.05 KB

README.md

File metadata and controls

40 lines (24 loc) · 1.05 KB
Raw

CommunityToolkit.Aspire.Hosting.DuckDB library

Provides extension methods and resource definitions for the Aspire AppHost to support creating and running DuckDB databases.

DuckDB is an in-process analytical (OLAP) database, ideal for analytics workloads, Parquet/CSV querying, and data processing.

By default, the DuckDB resource will create a new DuckDB database in a temporary location. You can also specify a path to an existing DuckDB database file.

Getting Started

Install the package

In your AppHost project, install the package using the following command:

dotnet add package CommunityToolkit.Aspire.Hosting.DuckDB

Example usage

Then, in the Program.cs file of AppHost, define a DuckDB resource, then call AddDuckDB:

var duckdb = builder.AddDuckDB("analytics");

To use a read-only database for analytics:

var duckdb = builder.AddDuckDB("warehouse")
    .WithReadOnly();

Additional Information

https://duckdb.org

Feedback & contributing

https://github.com/CommunityToolkit/Aspire