MongoDB.Abstracts

Overview

The MongoDB Abstracts library defines abstract base classes for repository pattern.

Download

The MongoDB.Abstracts library is available on nuget.org via package name MongoDB.Abstracts.

To install MongoDB.Abstracts, run the following command in the Package Manager Console

PM> Install-Package MongoDB.Abstracts

More information about NuGet package available at https://nuget.org/packages/MongoDB.Abstracts

Features

• interface for generic MongoDB queries; IMongoQuery<TEntity, TKey>
• interface for generic MongoDB repository; IMongoRepository<TEntity, TKey>
• base class for generic MongoDB queries; MongoQuery<TEntity, TKey>
• base class for generic MongoDB repository; MongoRepository<TEntity, TKey>
• interface for generic MongoDB entity; IMongoEntity
• base class for generic MongoDB entity; MongoEntity
• interface for generic MongoDB entity repository; IMongoEntityRepository<TEntity>
• base class for generic MongoDB entity repository; MongoEntityRepostiory<TEntity>

Configuration

Register with dependency injection

services.AddMongoRepository("mongodb://localhost:27017/UnitTesting");

Register using a connection name from the appsettings.json

services.AddMongoRepository("UnitTesting");

{
  "ConnectionStrings": {
    "UnitTesting": "mongodb://localhost:27017/UnitTesting"
  }
}

Discriminators

Register with discriminator type for support for multiple connections. This is a similar concept to dependency injection with keyed services.

Simple types used to discriminate connections

public readonly struct ProductsConnection;
public readonly struct InventoryConnection;

Register the MongoDB connections using the discriminators

services.AddMongoRepository<ProductsConnection>("ProductsConnection");
services.AddMongoRepository<InventoryConnection>("InventoryConnection");

Connection string in appsettings.json

{
  "ConnectionStrings": {
    "ProductsConnection": "mongodb://localhost:27017/Products",
    "InventoryConnection": "mongodb://localhost:27017/Inventory"
  }
}

Inject into constructor

public class ProductService
{
    private readonly IMongoEntityRepository<ProductsConnection, Product> _repository;

    public ProductService(IMongoEntityRepository<ProductsConnection, Product> repository)
    {
        _repository = repository;
    }
}

public class InventoryService
{
    private readonly IMongoEntityRepository<InventoryConnection, Inventory> _repository;

    public InventoryService(IMongoEntityRepository<InventoryConnection, Inventory> repository)
    {
        _repository = repository;
    }
}

Usage

Find an entity by key

// dependency inject
var roleRepo = Services.GetRequiredService<IMongoEntityRepository<Role>>();

// find by key
var role = await roleRepo.FindAsync("67a0dc52fa5ebe49f293a374");

Find one entity with query

// dependency inject
var roleRepo = Services.GetRequiredService<IMongoEntityRepository<Role>>();

// find one by query expression
var role = await roleRepo.FindOneAsync(r => r.Name.StartsWith("Admin"))

Find many with query

// dependency inject
var roleRepo = Services.GetRequiredService<IMongoEntityRepository<Role>>();

// find one by query expression
var roles = await roleRepo.FindAllAsync(r => r.Name.StartsWith("Admin"))

Use IQueryable

// dependency inject
var roleRepo = Services.GetRequiredService<IMongoEntityRepository<Role>>();

// Use IQueryable
var roles = roleRepo.All()
    .Where(r => r.IsActive)
    .ToList();

Insert entity

// dependency inject
var roleRepo = Services.GetRequiredService<IMongoEntityRepository<Role>>();

var role = new Role { Name = "CreateReadRole" };

var createdRole = await roleRepo.InsertAsync(role);

Update entity

// dependency inject
var roleRepo = Services.GetRequiredService<IMongoEntityRepository<Role>>();

// find by key
var role = await roleRepo.FindAsync("67a0dc52fa5ebe49f293a374");

// make changes
role.Name = "UpdateRole";

var updateRole = await roleRepo.UpdateAsync(role);

Delete entity by key

// dependency inject
var roleRepo = Services.GetRequiredService<IMongoEntityRepository<Role>>();

// items deleted
var count = await roleRepo.DeleteAsync("67a0dc52fa5ebe49f293a374");

Overrides

Create a custom repository

public class UserRepository : MongoEntityRepository<Models.User>
{
    public UserRepository(IMongoDatabase mongoDatabase) : base(mongoDatabase)
    {
    }

    protected override void BeforeInsert(Models.User entity)
    {
        base.BeforeInsert(entity);

        entity.EmailLower = entity.Email?.ToLowerInvariant();
    }

    protected override void BeforeUpdate(Models.User entity)
    {
        base.BeforeUpdate(entity);

        entity.EmailLower = entity.Email?.ToLowerInvariant();
    }

    protected override void EnsureIndexes(IMongoCollection<Models.User> mongoCollection)
    {
        base.EnsureIndexes(mongoCollection);

        mongoCollection.Indexes.CreateOne(
            new CreateIndexModel<Models.User>(
                Builders<Models.User>.IndexKeys.Ascending(s => s.EmailLower),
                new CreateIndexOptions { Unique = true }
            )
        );
    }

}