Share via

MongoDBBuilderExtensions.AddDatabase Method

  • Reference

Definition

Namespace:
Aspire.Hosting
Assembly:
Aspire.Hosting.MongoDB.dll
Package:
Aspire.Hosting.MongoDB v8.2.0
Package:
Aspire.Hosting.MongoDB v9.0.0
Source:
MongoDBBuilderExtensions.cs
Source:
MongoDBBuilderExtensions.cs

Adds a MongoDB database to the application model.

public static Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.MongoDBDatabaseResource> AddDatabase (this Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.MongoDBServerResource> builder, string name, string? databaseName = default);
static member AddDatabase : Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.MongoDBServerResource> * string * string -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.MongoDBDatabaseResource>
<Extension()>
Public Function AddDatabase (builder As IResourceBuilder(Of MongoDBServerResource), name As String, Optional databaseName As String = Nothing) As IResourceBuilder(Of MongoDBDatabaseResource)

Parameters

builder
IResourceBuilder<MongoDBServerResource>

The MongoDB server resource builder.

name
String

The name of the resource. This name will be used as the connection string name when referenced in a dependency.

databaseName
String

The name of the database. If not provided, this defaults to the same value as name.

Returns

IResourceBuilder<MongoDBDatabaseResource>

A reference to the IResourceBuilder<T>.

Applies to