Skip to content

Commit 83b87d7

Browse files
eerhardtkundadebdatta
authored andcommitted
Rename all runtime component APIs to use "Cosmos" instead of "CosmosDB".
1 parent 69431f0 commit 83b87d7

File tree

14 files changed

+72
-72
lines changed

14 files changed

+72
-72
lines changed

src/Components/Aspire.Microsoft.Azure.Cosmos/AspireMicrosoftAzureCosmosDBExtensions.cs src/Components/Aspire.Microsoft.Azure.Cosmos/AspireMicrosoftAzureCosmosExtensions.cs

+11-11
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@
1111
namespace Microsoft.Extensions.Hosting;
1212

1313
/// <summary>
14-
/// Azure CosmosDB extension
14+
/// Azure Cosmos DB extension
1515
/// </summary>
16-
public static class AspireMicrosoftAzureCosmosDBExtensions
16+
public static class AspireMicrosoftAzureCosmosExtensions
1717
{
1818
private const string DefaultConfigSectionName = "Aspire:Microsoft:Azure:Cosmos";
1919

@@ -23,17 +23,17 @@ public static class AspireMicrosoftAzureCosmosDBExtensions
2323
/// </summary>
2424
/// <param name="builder">The <see cref="IHostApplicationBuilder" /> to read config from and add services to.</param>
2525
/// <param name="connectionName">The connection name to use to find a connection string.</param>
26-
/// <param name="configureSettings">An optional method that can be used for customizing the <see cref="MicrosoftAzureCosmosDBSettings"/>. It's invoked after the settings are read from the configuration.</param>
26+
/// <param name="configureSettings">An optional method that can be used for customizing the <see cref="MicrosoftAzureCosmosSettings"/>. It's invoked after the settings are read from the configuration.</param>
2727
/// <param name="configureClientOptions">An optional method that can be used for customizing the <see cref="CosmosClientOptions"/>.</param>
2828
/// <remarks>Reads the configuration from "Aspire:Microsoft:Azure:Cosmos" section.</remarks>
2929
/// <exception cref="InvalidOperationException">If required ConnectionString is not provided in configuration section</exception>
3030
public static void AddAzureCosmosClient(
3131
this IHostApplicationBuilder builder,
3232
string connectionName,
33-
Action<MicrosoftAzureCosmosDBSettings>? configureSettings = null,
33+
Action<MicrosoftAzureCosmosSettings>? configureSettings = null,
3434
Action<CosmosClientOptions>? configureClientOptions = null)
3535
{
36-
AddAzureCosmosDB(builder, DefaultConfigSectionName, configureSettings, configureClientOptions, connectionName, serviceKey: null);
36+
AddAzureCosmosClient(builder, DefaultConfigSectionName, configureSettings, configureClientOptions, connectionName, serviceKey: null);
3737
}
3838

3939
/// <summary>
@@ -42,30 +42,30 @@ public static void AddAzureCosmosClient(
4242
/// </summary>
4343
/// <param name="builder">The <see cref="IHostApplicationBuilder" /> to read config from and add services to.</param>
4444
/// <param name="name">The name of the component, which is used as the <see cref="ServiceDescriptor.ServiceKey"/> of the service and also to retrieve the connection string from the ConnectionStrings configuration section.</param>
45-
/// <param name="configureSettings">An optional method that can be used for customizing the <see cref="MicrosoftAzureCosmosDBSettings"/>. It's invoked after the settings are read from the configuration.</param>
45+
/// <param name="configureSettings">An optional method that can be used for customizing the <see cref="MicrosoftAzureCosmosSettings"/>. It's invoked after the settings are read from the configuration.</param>
4646
/// <param name="configureClientOptions">An optional method that can be used for customizing the <see cref="CosmosClientOptions"/>.</param>
4747
/// <remarks>Reads the configuration from "Aspire:Microsoft:Azure:Cosmos:{name}" section.</remarks>
4848
/// <exception cref="InvalidOperationException">If required ConnectionString is not provided in configuration section</exception>
4949
public static void AddKeyedAzureCosmosClient(
5050
this IHostApplicationBuilder builder,
5151
string name,
52-
Action<MicrosoftAzureCosmosDBSettings>? configureSettings = null,
52+
Action<MicrosoftAzureCosmosSettings>? configureSettings = null,
5353
Action<CosmosClientOptions>? configureClientOptions = null)
5454
{
55-
AddAzureCosmosDB(builder, $"{DefaultConfigSectionName}:{name}", configureSettings, configureClientOptions, connectionName: name, serviceKey: name);
55+
AddAzureCosmosClient(builder, $"{DefaultConfigSectionName}:{name}", configureSettings, configureClientOptions, connectionName: name, serviceKey: name);
5656
}
5757

58-
private static void AddAzureCosmosDB(
58+
private static void AddAzureCosmosClient(
5959
this IHostApplicationBuilder builder,
6060
string configurationSectionName,
61-
Action<MicrosoftAzureCosmosDBSettings>? configureSettings,
61+
Action<MicrosoftAzureCosmosSettings>? configureSettings,
6262
Action<CosmosClientOptions>? configureClientOptions,
6363
string connectionName,
6464
string? serviceKey)
6565
{
6666
ArgumentNullException.ThrowIfNull(builder);
6767

68-
var settings = new MicrosoftAzureCosmosDBSettings();
68+
var settings = new MicrosoftAzureCosmosSettings();
6969
builder.Configuration.GetSection(configurationSectionName).Bind(settings);
7070

7171
if (builder.Configuration.GetConnectionString(connectionName) is string connectionString)

src/Components/Aspire.Microsoft.Azure.Cosmos/AssemblyInfo.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@
44
using Aspire;
55
using Aspire.Microsoft.Azure.Cosmos;
66

7-
[assembly: ConfigurationSchema("Aspire:Microsoft:Azure:Cosmos", typeof(MicrosoftAzureCosmosDBSettings))]
7+
[assembly: ConfigurationSchema("Aspire:Microsoft:Azure:Cosmos", typeof(MicrosoftAzureCosmosSettings))]
88

99
[assembly: LoggingCategories("Azure-Cosmos-Operation-Request-Diagnostics")]

src/Components/Aspire.Microsoft.Azure.Cosmos/MicrosoftAzureCosmosDBSettings.cs src/Components/Aspire.Microsoft.Azure.Cosmos/MicrosoftAzureCosmosSettings.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ namespace Aspire.Microsoft.Azure.Cosmos;
88
/// <summary>
99
/// The settings relevant to accessing Azure Cosmos DB.
1010
/// </summary>
11-
public sealed class MicrosoftAzureCosmosDBSettings
11+
public sealed class MicrosoftAzureCosmosSettings
1212
{
1313
/// <summary>
1414
/// Gets or sets the connection string of the Azure Cosmos database to connect to.
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
#nullable enable
2-
Aspire.Microsoft.Azure.Cosmos.MicrosoftAzureCosmosDBSettings
3-
Aspire.Microsoft.Azure.Cosmos.MicrosoftAzureCosmosDBSettings.AccountEndpoint.get -> System.Uri?
4-
Aspire.Microsoft.Azure.Cosmos.MicrosoftAzureCosmosDBSettings.AccountEndpoint.set -> void
5-
Aspire.Microsoft.Azure.Cosmos.MicrosoftAzureCosmosDBSettings.ConnectionString.get -> string?
6-
Aspire.Microsoft.Azure.Cosmos.MicrosoftAzureCosmosDBSettings.ConnectionString.set -> void
7-
Aspire.Microsoft.Azure.Cosmos.MicrosoftAzureCosmosDBSettings.Credential.get -> Azure.Core.TokenCredential?
8-
Aspire.Microsoft.Azure.Cosmos.MicrosoftAzureCosmosDBSettings.Credential.set -> void
9-
Aspire.Microsoft.Azure.Cosmos.MicrosoftAzureCosmosDBSettings.DisableTracing.get -> bool
10-
Aspire.Microsoft.Azure.Cosmos.MicrosoftAzureCosmosDBSettings.DisableTracing.set -> void
11-
Aspire.Microsoft.Azure.Cosmos.MicrosoftAzureCosmosDBSettings.MicrosoftAzureCosmosDBSettings() -> void
12-
Microsoft.Extensions.Hosting.AspireMicrosoftAzureCosmosDBExtensions
13-
static Microsoft.Extensions.Hosting.AspireMicrosoftAzureCosmosDBExtensions.AddAzureCosmosClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder! builder, string! connectionName, System.Action<Aspire.Microsoft.Azure.Cosmos.MicrosoftAzureCosmosDBSettings!>? configureSettings = null, System.Action<Microsoft.Azure.Cosmos.CosmosClientOptions!>? configureClientOptions = null) -> void
14-
static Microsoft.Extensions.Hosting.AspireMicrosoftAzureCosmosDBExtensions.AddKeyedAzureCosmosClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder! builder, string! name, System.Action<Aspire.Microsoft.Azure.Cosmos.MicrosoftAzureCosmosDBSettings!>? configureSettings = null, System.Action<Microsoft.Azure.Cosmos.CosmosClientOptions!>? configureClientOptions = null) -> void
2+
Aspire.Microsoft.Azure.Cosmos.MicrosoftAzureCosmosSettings
3+
Aspire.Microsoft.Azure.Cosmos.MicrosoftAzureCosmosSettings.AccountEndpoint.get -> System.Uri?
4+
Aspire.Microsoft.Azure.Cosmos.MicrosoftAzureCosmosSettings.AccountEndpoint.set -> void
5+
Aspire.Microsoft.Azure.Cosmos.MicrosoftAzureCosmosSettings.ConnectionString.get -> string?
6+
Aspire.Microsoft.Azure.Cosmos.MicrosoftAzureCosmosSettings.ConnectionString.set -> void
7+
Aspire.Microsoft.Azure.Cosmos.MicrosoftAzureCosmosSettings.Credential.get -> Azure.Core.TokenCredential?
8+
Aspire.Microsoft.Azure.Cosmos.MicrosoftAzureCosmosSettings.Credential.set -> void
9+
Aspire.Microsoft.Azure.Cosmos.MicrosoftAzureCosmosSettings.DisableTracing.get -> bool
10+
Aspire.Microsoft.Azure.Cosmos.MicrosoftAzureCosmosSettings.DisableTracing.set -> void
11+
Aspire.Microsoft.Azure.Cosmos.MicrosoftAzureCosmosSettings.MicrosoftAzureCosmosSettings() -> void
12+
Microsoft.Extensions.Hosting.AspireMicrosoftAzureCosmosExtensions
13+
static Microsoft.Extensions.Hosting.AspireMicrosoftAzureCosmosExtensions.AddAzureCosmosClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder! builder, string! connectionName, System.Action<Aspire.Microsoft.Azure.Cosmos.MicrosoftAzureCosmosSettings!>? configureSettings = null, System.Action<Microsoft.Azure.Cosmos.CosmosClientOptions!>? configureClientOptions = null) -> void
14+
static Microsoft.Extensions.Hosting.AspireMicrosoftAzureCosmosExtensions.AddKeyedAzureCosmosClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder! builder, string! name, System.Action<Aspire.Microsoft.Azure.Cosmos.MicrosoftAzureCosmosSettings!>? configureSettings = null, System.Action<Microsoft.Azure.Cosmos.CosmosClientOptions!>? configureClientOptions = null) -> void

src/Components/Aspire.Microsoft.Azure.Cosmos/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ And then the connection string will be retrieved from the `ConnectionStrings` co
5454

5555
#### Account Endpoint
5656

57-
The recommended approach is to use an AccountEndpoint, which works with the `MicrosoftAzureCosmosDBSettings.Credential` property to establish a connection. If no credential is configured, the [DefaultAzureCredential](https://learn.microsoft.com/dotnet/api/azure.identity.defaultazurecredential) is used.
57+
The recommended approach is to use an AccountEndpoint, which works with the `MicrosoftAzureCosmosSettings.Credential` property to establish a connection. If no credential is configured, the [DefaultAzureCredential](https://learn.microsoft.com/dotnet/api/azure.identity.defaultazurecredential) is used.
5858

5959
```json
6060
{
@@ -78,7 +78,7 @@ Alternatively, an [Azure Cosmos DB connection string](https://learn.microsoft.co
7878

7979
### Use configuration providers
8080

81-
The .NET Aspire Microsoft Azure Cosmos DB library supports [Microsoft.Extensions.Configuration](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration). It loads the `MicrosoftAzureCosmosDBSettings` and `QueueClientOptions` from configuration by using the `Aspire:Microsoft:Azure:Cosmos` key. Example `appsettings.json` that configures some of the options:
81+
The .NET Aspire Microsoft Azure Cosmos DB library supports [Microsoft.Extensions.Configuration](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration). It loads the `MicrosoftAzureCosmosSettings` and `QueueClientOptions` from configuration by using the `Aspire:Microsoft:Azure:Cosmos` key. Example `appsettings.json` that configures some of the options:
8282

8383
```json
8484
{
@@ -96,7 +96,7 @@ The .NET Aspire Microsoft Azure Cosmos DB library supports [Microsoft.Extensions
9696

9797
### Use inline delegates
9898

99-
You can also pass the `Action<MicrosoftAzureCosmosDBSettings> configureSettings` delegate to set up some or all the options inline, for example to disable tracing from code:
99+
You can also pass the `Action<MicrosoftAzureCosmosSettings> configureSettings` delegate to set up some or all the options inline, for example to disable tracing from code:
100100

101101
```csharp
102102
builder.AddAzureCosmosClient("cosmosConnectionName", settings => settings.DisableTracing = true);

src/Components/Aspire.Microsoft.EntityFrameworkCore.Cosmos/AspireAzureEFCoreCosmosDBExtensions.cs src/Components/Aspire.Microsoft.EntityFrameworkCore.Cosmos/AspireAzureEFCoreCosmosExtensions.cs

+8-8
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ namespace Microsoft.Extensions.Hosting;
1818
/// <summary>
1919
/// Extension methods for configuring EntityFrameworkCore DbContext to Azure Cosmos DB
2020
/// </summary>
21-
public static class AspireAzureEFCoreCosmosDBExtensions
21+
public static class AspireAzureEFCoreCosmosExtensions
2222
{
2323
private const string DefaultConfigSectionName = "Aspire:Microsoft:EntityFrameworkCore:Cosmos";
2424
private const DynamicallyAccessedMemberTypes RequiredByEF = DynamicallyAccessedMemberTypes.PublicConstructors | DynamicallyAccessedMemberTypes.NonPublicConstructors | DynamicallyAccessedMemberTypes.PublicProperties;
@@ -34,19 +34,19 @@ public static class AspireAzureEFCoreCosmosDBExtensions
3434
/// <param name="configureSettings">An optional delegate that can be used for customizing settings. It's invoked after the settings are read from the configuration.</param>
3535
/// <param name="configureDbContextOptions">An optional delegate to configure the <see cref="DbContextOptions"/> for the context.</param>
3636
/// <exception cref="ArgumentNullException">Thrown if mandatory <paramref name="builder"/> is null.</exception>
37-
/// <exception cref="InvalidOperationException">Thrown when mandatory <see cref="EntityFrameworkCoreCosmosDBSettings.ConnectionString"/> is not provided.</exception>
37+
/// <exception cref="InvalidOperationException">Thrown when mandatory <see cref="EntityFrameworkCoreCosmosSettings.ConnectionString"/> is not provided.</exception>
3838
public static void AddCosmosDbContext<[DynamicallyAccessedMembers(RequiredByEF)] TContext>(
3939
this IHostApplicationBuilder builder,
4040
string connectionName,
4141
string databaseName,
42-
Action<EntityFrameworkCoreCosmosDBSettings>? configureSettings = null,
42+
Action<EntityFrameworkCoreCosmosSettings>? configureSettings = null,
4343
Action<DbContextOptionsBuilder>? configureDbContextOptions = null) where TContext : DbContext
4444
{
4545
ArgumentNullException.ThrowIfNull(builder);
4646

4747
builder.EnsureDbContextNotRegistered<TContext>();
4848

49-
var settings = builder.GetDbContextSettings<TContext, EntityFrameworkCoreCosmosDBSettings>(
49+
var settings = builder.GetDbContextSettings<TContext, EntityFrameworkCoreCosmosSettings>(
5050
DefaultConfigSectionName,
5151
(settings, section) => section.Bind(settings)
5252
);
@@ -120,11 +120,11 @@ void UseCosmosBody(CosmosDbContextOptionsBuilder builder)
120120
/// <exception cref="InvalidOperationException">Thrown when mandatory <see cref="DbContext"/> is not registered in DI.</exception>
121121
public static void EnrichCosmosDbContext<[DynamicallyAccessedMembers(RequiredByEF)] TContext>(
122122
this IHostApplicationBuilder builder,
123-
Action<EntityFrameworkCoreCosmosDBSettings>? configureSettings = null) where TContext : DbContext
123+
Action<EntityFrameworkCoreCosmosSettings>? configureSettings = null) where TContext : DbContext
124124
{
125125
ArgumentNullException.ThrowIfNull(builder);
126126

127-
var settings = builder.GetDbContextSettings<TContext, EntityFrameworkCoreCosmosDBSettings>(
127+
var settings = builder.GetDbContextSettings<TContext, EntityFrameworkCoreCosmosSettings>(
128128
DefaultConfigSectionName,
129129
(settings, section) => section.Bind(settings)
130130
);
@@ -142,7 +142,7 @@ void UseCosmosBody(CosmosDbContextOptionsBuilder builder)
142142
extension.RequestTimeout.HasValue &&
143143
extension.RequestTimeout != settings.RequestTimeout)
144144
{
145-
throw new InvalidOperationException($"Conflicting values for 'RequestTimeout' were found in {nameof(EntityFrameworkCoreCosmosDBSettings)} and set in DbContextOptions<{typeof(TContext).Name}>.");
145+
throw new InvalidOperationException($"Conflicting values for 'RequestTimeout' were found in {nameof(EntityFrameworkCoreCosmosSettings)} and set in DbContextOptions<{typeof(TContext).Name}>.");
146146
}
147147

148148
extension?.WithRequestTimeout(settings.RequestTimeout);
@@ -157,7 +157,7 @@ void UseCosmosBody(CosmosDbContextOptionsBuilder builder)
157157
ConfigureInstrumentation<TContext>(builder, settings);
158158
}
159159

160-
private static void ConfigureInstrumentation<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors | DynamicallyAccessedMemberTypes.NonPublicConstructors | DynamicallyAccessedMemberTypes.PublicProperties)] TContext>(IHostApplicationBuilder builder, EntityFrameworkCoreCosmosDBSettings settings) where TContext : DbContext
160+
private static void ConfigureInstrumentation<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors | DynamicallyAccessedMemberTypes.NonPublicConstructors | DynamicallyAccessedMemberTypes.PublicProperties)] TContext>(IHostApplicationBuilder builder, EntityFrameworkCoreCosmosSettings settings) where TContext : DbContext
161161
{
162162
if (!settings.DisableTracing)
163163
{

src/Components/Aspire.Microsoft.EntityFrameworkCore.Cosmos/AssemblyInfo.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
using Aspire;
55
using Aspire.Microsoft.EntityFrameworkCore.Cosmos;
66

7-
[assembly: ConfigurationSchema("Aspire:Microsoft:EntityFrameworkCore:Cosmos", typeof(EntityFrameworkCoreCosmosDBSettings))]
7+
[assembly: ConfigurationSchema("Aspire:Microsoft:EntityFrameworkCore:Cosmos", typeof(EntityFrameworkCoreCosmosSettings))]
88

99
[assembly: LoggingCategories(
1010
"Azure-Cosmos-Operation-Request-Diagnostics",

src/Components/Aspire.Microsoft.EntityFrameworkCore.Cosmos/EntityFrameworkCoreCosmosDBSettings.cs src/Components/Aspire.Microsoft.EntityFrameworkCore.Cosmos/EntityFrameworkCoreCosmosSettings.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ namespace Aspire.Microsoft.EntityFrameworkCore.Cosmos;
88
/// <summary>
99
/// The settings relevant to accessing Azure Cosmos DB database using EntityFrameworkCore.
1010
/// </summary>
11-
public sealed class EntityFrameworkCoreCosmosDBSettings
11+
public sealed class EntityFrameworkCoreCosmosSettings
1212
{
1313
/// <summary>
1414
/// The connection string of the Azure Cosmos DB server database to connect to.

0 commit comments

Comments
 (0)