RavenDBClientExtension Methods

Docs/Reference/Search C# APIs/CommunityToolkit.Aspire.RavenDB.Client/RavenDBClientExtension/Methods

Methods

Docs Reference Search C# APIs CommunityToolkit.Aspire.RavenDB.Client RavenDBClientExtension Methods

ClassMethods4 members

Extension methods for connecting RavenDB database.

AddKeyedRavenDBClient(IHostApplicationBuilder, object, string, Action<RavenDBClientSettings>)extension

Registers Documents.IDocumentStore and the associated Session.IDocumentSession and Session.IAsyncDocumentSession instances for connecting to an existing or new RavenDB database with RavenDB.Client, identified by a unique service key.

public static class RavenDBClientExtension
{
    public static void AddKeyedRavenDBClient(
        this IHostApplicationBuilder builder,
        object serviceKey,
        string connectionName,
        Action<RavenDBClientSettings>? configureSettings = null)
    {
        // ...
    }
}

RavenDBClientExtension.cs#L66-L69

Parameters

builderIHostApplicationBuilderThe Hosting.IHostApplicationBuilder used to add services.

serviceKeyobjectA unique key that identifies this instance of the RavenDB client service.

connectionNamestringThe name used to retrieve the connection string from the "ConnectionStrings" configuration section.

configureSettingsAction<RavenDBClientSettings>optionalAn optional delegate that can be used for customizing options. It is invoked after the settings are read from the configuration.

Remarks

Notes:

• Reads the configuration from "Aspire:RavenDB:Client" section.
• The Documents.IDocumentStore is registered as a singleton, meaning a single instance is shared throughout the application's lifetime, while Session.IDocumentSession and Session.IAsyncDocumentSession are registered per request to ensure short-lived session instances for each use.

AddKeyedRavenDBClient(IHostApplicationBuilder, object, RavenDBClientSettings)extension

Registers Documents.IDocumentStore and the associated Session.IDocumentSession and Session.IAsyncDocumentSession instances for connecting to an existing or new RavenDB database with RavenDB.Client, identified by a unique service key.

public static class RavenDBClientExtension
{
    public static void AddKeyedRavenDBClient(
        this IHostApplicationBuilder builder,
        object serviceKey,
        RavenDBClientSettings settings)
    {
        // ...
    }
}

RavenDBClientExtension.cs#L112-L113

Parameters

builderIHostApplicationBuilderThe Hosting.IHostApplicationBuilder used to add services.

serviceKeyobjectA unique key that identifies this instance of the RavenDB client service.

settingsRavenDBClientSettingsThe settings required to configure the Documents.IDocumentStore.

Remarks

Notes:

• If RavenDBClientSettings.DatabaseName is not specified and RavenDBClientSettings.CreateDatabase is set to 'false', Session.IDocumentSession and Session.IAsyncDocumentSession will not be registered.
• The Documents.IDocumentStore is registered as a singleton, meaning a single instance is shared throughout the application's lifetime, while Session.IDocumentSession and Session.IAsyncDocumentSession are registered per request to ensure short-lived session instances for each use.

AddRavenDBClient(IHostApplicationBuilder, string, Action<RavenDBClientSettings>)extension

Registers Documents.IDocumentStore and the associated Session.IDocumentSession and Session.IAsyncDocumentSession instances for connecting to an existing or new RavenDB database with RavenDB.Client.

public static class RavenDBClientExtension
{
    public static void AddRavenDBClient(
        this IHostApplicationBuilder builder,
        string connectionName,
        Action<RavenDBClientSettings>? configureSettings = null)
    {
        // ...
    }
}

RavenDBClientExtension.cs#L40-L43

Parameters

builderIHostApplicationBuilderThe Hosting.IHostApplicationBuilder used to add services.

connectionNamestringThe name used to retrieve the connection string from the "ConnectionStrings" configuration section.

configureSettingsAction<RavenDBClientSettings>optionalAn optional delegate that can be used for customizing options. It is invoked after the settings are read from the configuration.

Remarks

Notes:

• Reads the configuration from "Aspire:RavenDB:Client" section.
• The Documents.IDocumentStore is registered as a singleton, meaning a single instance is shared throughout the application's lifetime, while Session.IDocumentSession and Session.IAsyncDocumentSession are registered per request to ensure short-lived session instances for each use.

AddRavenDBClient(IHostApplicationBuilder, RavenDBClientSettings)extension

Registers Documents.IDocumentStore and the associated Session.IDocumentSession and Session.IAsyncDocumentSession instances for connecting to an existing or new RavenDB database with RavenDB.Client.

public static class RavenDBClientExtension
{
    public static void AddRavenDBClient(
        this IHostApplicationBuilder builder,
        RavenDBClientSettings settings)
    {
        // ...
    }
}

RavenDBClientExtension.cs#L89-L90

Parameters

builderIHostApplicationBuilderThe Hosting.IHostApplicationBuilder used to add services.

settingsRavenDBClientSettingsThe settings required to configure the Documents.IDocumentStore.

Remarks

Notes:

• If RavenDBClientSettings.DatabaseName is not specified and RavenDBClientSettings.CreateDatabase is set to 'false', Session.IDocumentSession and Session.IAsyncDocumentSession will not be registered.
• The Documents.IDocumentStore is registered as a singleton, meaning a single instance is shared throughout the application's lifetime, while Session.IDocumentSession and Session.IAsyncDocumentSession are registered per request to ensure short-lived session instances for each use.