QDev.CSharp.MongoDB.RepositoryPattern 1.0.1

Database Manager MongoDB

A library for implementing generic repositories and unit of work with MongoDB.Driver. This implementation uses a singleton setting instance of the IMongoDbSetting .

Table of Contents

• Installation
• Injecting the RepositoryPattern's Services
  • Creating the Settings
  • Injecting the Services
• Creating the Service
• Unit of Work
  • Functions
  • Properties
• Repository
  • Methods

Installation

Using the NuGet package manager console within Visual Studio run the following command:

Install-Package QDev.CSharp.MongoDB.RepositoryPattern

Or using the .NET Core CLI from a terminal window:

dotnet add package QDev.CSharp.MongoDB.RepositoryPattern

Injecting the RepositoryPattern's Services

Creating the Settings

Initially, it's essential to create a class that implements the IMongoSettings interface. Following that, configure a dedicated section within the appsettings.json file to store the necessary settings for configuring the MongoDB client in your development project.

public class MyMongoSettings : IMongoSettings
{
    public string Server { get; set; }
	public string Database { get; set; }
}

{
	"MongoDB": {
		"Server": "localhost:27017",
		"Database": "test"
	}
}

Injecting the Services

Here is the code snippet to inject the required services for the seamless operation of the repository pattern in your development project:

builder.Services.AddRepositoryPattern<MyMongoSettings>(builder.Configuration, "MongoDB"); 	// Keep in mind that if the 'sectionName' parameter is null, 
																							// it will default to the name of the class that implements 'IMongoSettings' in your development context

Creating the Service

To create a service class it's mandatory use this form Service<TDocument> as shown in the following example.

Example:

public class MyService<MyDocument>
{
    private readonly IUnitOfWork _unitOfWork;

	public MyService(IServiceProvider services) 
	{ 
	    var scoped = provider.CreateScope();
	    _unitOfWork = scoped.ServiceProvider.GetRequiredService<IUnitOfWork>();
	}

	public async Task<MyDocument> CreateMyDocument(MyDocument document, CancellationToken cancellationToke = default) 
	{
		var newDocument await _unitOfWork.Repository<TDocument>().InsertOneAsync(document, cancellationToken);
		await _unitOfWork.SaveAsync(cancellationToken);
		return newDocument;
	}

	// and more methods as needed
}

Unit Of Work

IUnitOfWork represents a unit of work for coordinating and managing database operations using a custom repository pattern. Please note that this interface provides methods and a property to manage transactions and repositories in a custom repository pattern. It allows for both synchronous and asynchronous transaction management.

Functions

Properties

Repository

• IRepository<TDocument> represents a repository for managing documents of type TDocument within a MongoDB context using the MongoDB C# driver.
• TDocument: The type of documents managed by this repository.

Methods

Please note that some functions include optional parameters to configure various options, and there's a description of exception handling for error scenarios.