CommunityToolkit.Aspire.RavenDB.Client 9.8.0-beta.375

Prefix Reserved
This is a prerelease version of CommunityToolkit.Aspire.RavenDB.Client.
dotnet add package CommunityToolkit.Aspire.RavenDB.Client --version 9.8.0-beta.375
                    
NuGet\Install-Package CommunityToolkit.Aspire.RavenDB.Client -Version 9.8.0-beta.375
                    
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="CommunityToolkit.Aspire.RavenDB.Client" Version="9.8.0-beta.375" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="CommunityToolkit.Aspire.RavenDB.Client" Version="9.8.0-beta.375" />
                    
Directory.Packages.props
<PackageReference Include="CommunityToolkit.Aspire.RavenDB.Client" />
                    
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 CommunityToolkit.Aspire.RavenDB.Client --version 9.8.0-beta.375
                    
#r "nuget: CommunityToolkit.Aspire.RavenDB.Client, 9.8.0-beta.375"
                    
#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 CommunityToolkit.Aspire.RavenDB.Client@9.8.0-beta.375
                    
#: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=CommunityToolkit.Aspire.RavenDB.Client&version=9.8.0-beta.375&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=CommunityToolkit.Aspire.RavenDB.Client&version=9.8.0-beta.375&prerelease
                    
Install as a Cake Tool

CommunityToolkit.Aspire.RavenDB.Client library

Registers IDocumentStore and the associated IDocumentSession and IAsyncDocumentSession instances in the DI container for connecting to a RavenDB database. Additionally, it enables health checks, metrics, logging, and telemetry.

Getting started

Prerequisites

  • RavenDB database and connection string for accessing the database or a running RavenDB server instance with its connection details, such as the server's URL and a valid certificate if required.

Note:
RavenDB allows creating an IDocumentStore without a defined database. In such cases, IDocumentSession and IAsyncDocumentSession will not be available. This library also supports creating a new RavenDB database. However, if you intend to connect to an existing RavenDB database, ensure the database exists and you have its connection details.

Install the package

Install the CommunityToolkit.Aspire.RavenDB.Client library with NuGet:

dotnet add package CommunityToolkit.Aspire.RavenDB.Client

To be added once the package is published.

Usage example

In the Program.cs file of your project, call the AddRavenDBClient extension method to register a IDocumentStore for use via the dependency injection container. The method takes a connection name parameter.

builder.AddRavenDBClient("ravendb");

You can then retrieve a IDocumentStore instance using dependency injection, for example:

public class MyService
{
    private readonly IDocumentStore _documentStore;
    public MyService(IDocumentStore documentStore)
    {
        _documentStore = documentStore;
    }

    // Your logic here
}

Configuration

The .NET Aspire RavenDB Client component provides multiple options to configure the server connection based on the requirements and conventions of your project.

Use a connection string

When using a connection string from the ConnectionStrings configuration section, you can provide the name of the connection string when calling builder.AddRavenDBClient():

builder.AddRavenDBClient("ravendb");

And then the connection string will be retrieved from the ConnectionStrings configuration section:

{
  "ConnectionStrings": {
    "ravendb": "URL=http://localhost:8080;Database=ravenDatabase"
  }
}

Use configuration providers

The .NET Aspire RavenDB Client component supports Microsoft.Extensions.Configuration. It loads the RavenDBClientSettings from configuration by using the Aspire:RavenDB:Client key.

Use inline delegates

Also you can pass the Action<RavenDBClientSettings> configureSettings delegate to set up some or all the options inline, for example to set the database name and certificate from code:

builder.AddRavenDBClient("ravendb", settings => 
{
    settings.DatabaseName = "ravenDatabase"; 
    settings.Certificate = ravenCertificate;
});

Use RavenDBClientSettings Class

The RavenDBClientSettings class simplifies configuration by allowing you to specify:

  • URLs of your RavenDB nodes.
  • Database name to connect to or create.
  • Certificate details (via CertificatePath and CertificatePassword or Certificate).
  • Optional actions to modify the IDocumentStore.

Example for creating a new database on a local unsecured RavenDB server:

var settings = new RavenDBClientSettings(new[] { �http://127.0.0.1:8080� }, �NorthWind�)
{
	CreateDatabase = true;
};
builder.AddRavenDBClient(settings);

You can also configure:

  • DisableHealthChecks to disable health checks.
  • HealthCheckTimeout to set the timeout for health checks.
  • DisableTracing to disable OpenTelemetry tracing.

AppHost extensions

Install the CommunityToolkit.Aspire.Hosting.RavenDB Library

Install the CommunityToolkit.Aspire.Hosting.RavenDB library with NuGet:

dotnet add package CommunityToolkit.Aspire.Hosting.RavenDB

To be added once the package is published.

Usage in AppHost

In your AppHost's Program.cs file, register a RavenDB server resource and consume the connection using the following methods:

var ravendb = builder.AddRavenDB("ravendb");

var myService = builder.AddProject<Projects.MyService>()
                       .WithReference(ravendb);

The WithReference method configures a connection in the MyService project named ravendb. In the Program.cs file of MyService, the RavenDB connection can be consumed using:

builder.AddRavenDBClient("ravendb");

Additional Documentation

Feedback & Contributing

https://github.com/CommunityToolkit/Aspire

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 was computed.  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

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
9.8.0-beta.375 35 9/6/2025
9.8.0-beta.373 109 9/5/2025
9.8.0-beta.372 107 9/4/2025
9.8.0-beta.370 111 9/2/2025
9.8.0-beta.364 115 9/1/2025
9.7.2 242 8/29/2025
9.7.2-beta.362 162 8/29/2025
9.7.2-beta.361 162 8/29/2025
9.7.2-beta.360 159 8/29/2025
9.7.2-beta.359 165 8/28/2025
9.7.2-beta.358 158 8/28/2025
9.7.2-beta.357 159 8/28/2025
9.7.1 202 8/27/2025
9.7.1-beta.355 166 8/27/2025
9.7.1-beta.354 165 8/27/2025
9.7.1-beta.353 165 8/27/2025
9.7.1-beta.352 165 8/27/2025
9.7.1-beta.351 168 8/27/2025
9.7.1-beta.348 127 8/14/2025
9.7.1-beta.344 67 8/10/2025
9.7.1-beta.343 193 8/8/2025
9.7.1-beta.342 198 8/7/2025
9.7.1-beta.341 196 8/6/2025
9.7.1-beta.340 183 8/5/2025
9.7.1-beta.339 184 8/5/2025
9.7.0 1,372 8/1/2025
9.7.0-beta.337 79 8/1/2025
9.7.0-beta.336 92 8/1/2025
9.7.0-beta.335 88 8/1/2025
9.7.0-beta.333 99 7/30/2025
9.6.1-beta.332 95 7/30/2025
9.6.1-beta.331 95 7/30/2025
9.6.1-beta.330 94 7/30/2025
9.6.1-beta.329 99 7/30/2025
9.6.1-beta.328 96 7/29/2025
9.6.1-beta.327 97 7/28/2025
9.6.1-beta.326 97 7/28/2025
9.6.0 404 7/10/2025
9.6.0-beta.324 122 7/10/2025
9.5.1-beta.323 124 7/10/2025
9.5.1-beta.322 120 7/10/2025
9.5.1-beta.321 125 7/10/2025
9.5.1-beta.320 124 7/9/2025
9.5.1-beta.319 122 7/8/2025
9.5.1-beta.318 126 7/2/2025
9.5.1-beta.317 119 6/30/2025
9.5.1-beta.315 125 6/26/2025
9.5.1-beta.314 122 6/23/2025
9.5.1-beta.313 112 6/20/2025
9.5.1-beta.312 115 6/20/2025
9.5.1-beta.311 134 6/18/2025
9.5.1-beta.310 122 6/17/2025
9.5.1-beta.309 127 6/17/2025
9.5.1-beta.308 131 6/17/2025
9.5.1-beta.307 132 6/16/2025
9.5.1-beta.306 277 6/11/2025
9.5.1-beta.305 94 6/7/2025
9.5.1-beta.304 110 6/6/2025
9.5.1-beta.303 123 6/4/2025
9.5.1-beta.302 132 6/4/2025
9.5.1-beta.301 125 6/2/2025
9.5.1-beta.300 139 5/28/2025
9.5.0 1,155 5/27/2025
9.5.0-beta.299 128 5/27/2025
9.5.0-beta.298 130 5/26/2025
9.5.0-beta.297 82 5/24/2025
9.5.0-beta.296 76 5/24/2025
9.5.0-beta.295 53 5/24/2025
9.4.1-beta.291 128 5/19/2025
9.4.1-beta.289 141 5/16/2025
9.4.1-beta.288 193 5/16/2025
9.4.1-beta.287 198 5/16/2025
9.4.1-beta.286 192 5/16/2025
9.4.1-beta.285 215 5/14/2025
9.4.1-beta.284 219 5/13/2025
9.4.1-beta.283 211 5/12/2025
9.4.1-beta.282 132 5/7/2025
9.4.1-beta.280 125 5/2/2025
9.4.1-beta.279 132 5/2/2025
9.4.1-beta.277 141 4/23/2025
9.4.1-beta.276 139 4/23/2025
9.4.1-beta.275 142 4/23/2025
9.4.1-beta.274 145 4/23/2025
9.4.1-beta.273 151 4/23/2025
9.4.1-beta.272 135 4/23/2025
9.4.1-beta.271 144 4/23/2025
9.4.1-beta.270 136 4/20/2025
9.4.0 1,526 4/20/2025
9.4.0-beta.269 148 4/20/2025
9.4.0-beta.268 140 4/20/2025
9.3.1-beta.267 143 4/20/2025
9.3.1-beta.266 68 4/19/2025
9.3.1-beta.265 173 4/15/2025
9.3.1-beta.264 182 4/15/2025
9.3.1-beta.263 173 4/15/2025
9.3.1-beta.262 175 4/15/2025
9.3.1-beta.260 154 4/10/2025
9.3.1-beta.259 142 4/8/2025
9.3.1-beta.258 150 4/8/2025
9.3.1-beta.257 147 4/8/2025
9.3.1-beta.256 136 4/8/2025
9.3.1-beta.255 147 4/8/2025
9.3.1-beta.254 146 4/8/2025
9.3.1-beta.253 161 4/1/2025
9.3.1-beta.252 126 3/27/2025
9.3.1-beta.250 118 3/27/2025
9.3.1-beta.249 121 3/27/2025
9.3.1-beta.248 121 3/27/2025
9.3.1-beta.247 134 3/27/2025
9.3.1-beta.244 481 3/25/2025
9.3.1-beta.242 468 3/24/2025
9.3.1-beta.241 150 3/19/2025
9.3.0 270 3/19/2025
9.3.0-beta.239 136 3/19/2025
9.2.2-beta.237 131 3/19/2025
9.2.2-beta.236 106 3/14/2025
9.2.2-beta.230 144 3/13/2025
9.2.2-beta.229 131 3/13/2025
9.2.2-beta.228 149 3/11/2025
9.2.2-beta.227 140 3/11/2025
9.2.2-beta.226 145 3/11/2025
9.2.2-beta.225 152 3/11/2025
9.2.2-beta.224 146 3/11/2025
9.2.2-beta.223 146 3/10/2025
9.2.2-beta.222 159 3/10/2025
9.2.2-beta.220 160 3/9/2025
9.2.2-beta.218 146 3/9/2025
9.2.2-beta.217 181 3/7/2025
9.2.2-beta.216 192 3/7/2025
9.2.2-beta.215 191 3/7/2025
9.2.2-beta.214 188 3/5/2025
9.2.2-beta.213 172 3/5/2025
9.2.2-beta.212 181 3/5/2025
9.2.2-beta.211 199 3/4/2025
9.2.2-beta.210 196 3/4/2025
9.2.2-beta.208 94 3/3/2025
9.2.1 132 3/3/2025
9.2.1-beta.207 113 3/2/2025
9.2.1-beta.206 71 3/1/2025
9.2.1-beta.205 78 2/27/2025
9.2.1-beta.204 77 2/26/2025
9.2.1-beta.203 81 2/26/2025
9.2.0 127 2/26/2025
9.2.0-beta.202 75 2/26/2025
9.2.0-beta.201 78 2/26/2025
9.2.0-beta.199 75 2/26/2025
9.2.0-beta.198 71 2/26/2025
9.1.1-beta.197 80 2/25/2025
9.1.1-beta.196 89 2/25/2025
9.1.1-beta.195 80 2/25/2025
9.1.1-beta.194 84 2/25/2025
9.1.1-beta.193 65 2/25/2025
9.1.1-beta.192 80 2/24/2025
9.1.1-beta.191 85 2/24/2025
9.1.1-beta.190 89 2/19/2025
9.1.1-beta.189 78 2/19/2025
9.1.1-beta.188 91 2/19/2025
9.1.1-beta.187 90 2/19/2025
9.1.1-beta.183 94 2/18/2025
9.1.1-beta.182 83 2/18/2025
9.1.1-beta.181 96 2/18/2025
9.1.1-beta.180 82 2/17/2025
9.1.1-beta.178 99 2/17/2025
9.1.1-beta.177 88 2/12/2025
9.1.1-beta.176 93 2/11/2025
9.1.1-beta.175 78 2/11/2025
9.1.1-beta.173 98 2/10/2025