AspireKurrentDBExtensions Methods

1. Docs
2. /Reference
3. /Search C# APIs
4. /CommunityToolkit.Aspire.KurrentDB
5. /AspireKurrentDBExtensions
6. /Methods

ClassMethods2 members

Provides extension methods for registering KurrentDB-related services in an Hosting.IHostApplicationBuilder.

AddKeyedKurrentDBClient(IHostApplicationBuilder, string, Action<KurrentDBSettings>)extension

Registers Client.KurrentDBClient as a keyed singleton for the given name in the services provided by the builder.

public static class AspireKurrentDBExtensions
{
    public static void AddKeyedKurrentDBClient(
        this IHostApplicationBuilder builder,
        string name,
        Action<KurrentDBSettings>? configureSettings = null)
    {
        // ...
    }
}

AspireKurrentDBExtensions.cs#L48-L51

Parameters

builderIHostApplicationBuilderThe Hosting.IHostApplicationBuilder to read config from and add services to.

namestringThe connection name to use to find a connection string.

configureSettingsAction<KurrentDBSettings>optionalAn optional method that can be used for customizing the KurrentDBSettings. It's invoked after the settings are read from the configuration.

AddKurrentDBClient(IHostApplicationBuilder, string, Action<KurrentDBSettings>)extension

Registers Client.KurrentDBClient as a singleton in the services provided by the builder.

public static class AspireKurrentDBExtensions
{
    public static void AddKurrentDBClient(
        this IHostApplicationBuilder builder,
        string connectionName,
        Action<KurrentDBSettings>? configureSettings = null)
    {
        // ...
    }
}

AspireKurrentDBExtensions.cs#L32-L35

Parameters

builderIHostApplicationBuilderThe Hosting.IHostApplicationBuilder to read config from and add services to.

connectionNamestringThe connection name to use to find a connection string.

configureSettingsAction<KurrentDBSettings>optionalAn optional method that can be used for customizing the KurrentDBSettings. It's invoked after the settings are read from the configuration.