Skip to content

Commit a857420

Browse files
chore: add missing comments for mongo client extensions
1 parent 20f505b commit a857420

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

EntityDb.MongoDb/Extensions/IMongoClientExtensions.cs

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,20 @@
44

55
namespace EntityDb.MongoDb.Extensions
66
{
7+
/// <summary>
8+
/// Extensions for the mongo client.
9+
/// </summary>
710
public static class IMongoClientExtensions
811
{
12+
/// <summary>
13+
/// Provisions the needed collections on the database.
14+
/// </summary>
15+
/// <param name="mongoClient">The mongo client.</param>
16+
/// <param name="entityName">The name of the entity, which is used as the database name.</param>
17+
/// <returns>An asynchronous task that, when complete, signals that the collections have been provisioned.</returns>
18+
/// <remarks>
19+
/// You should ONLY use this in your code for integration testing. Real databases should be provisioned using the dotnet tool EntityDb.MongoDb.Provisioner.
20+
/// </remarks>
921
public static async Task ProvisionCollections(this IMongoClient mongoClient, string entityName)
1022
{
1123
var mongoDatabase = mongoClient.GetDatabase(entityName);

0 commit comments

Comments
 (0)