AnointedAutomation.Repository.Mongo 1.1.2

AnointedAutomation.Repository.Mongo

A thin, testable wrapper over the official MongoDB .NET driver. IMongoHelper gives you collection name based CRUD, paging, projection, aggregation and index management; MongoRepository<TDoc> is a base class for per collection repositories; and the BSON helpers register class maps and casing conventions for the AnointedAutomation.Objects models.

Installation

dotnet add package AnointedAutomation.Repository.Mongo

• Target framework: net10.0
• Dependencies:
  • AnointedAutomation.Logging
  • AnointedAutomation.Objects
  • MongoDB.Driver 3.11.2
  • MongoDB.Bson 3.11.2
  • MongoDB.Libmongocrypt 1.12.0
  • Newtonsoft.Json 13.0.4

Quick start

A document type, a repository and DI registration (the IServiceCollection extension assumes an ASP.NET Core or Generic Host app):

using System;
using System.Threading.Tasks;
using AnointedAutomation.Repository.Mongo;
using Microsoft.Extensions.DependencyInjection;

public class Product : MongoDocument
{
    public string Name { get; set; }
    public decimal Price { get; set; }
}

public class ProductRepository : MongoRepository<Product>
{
    public ProductRepository(IMongoHelper mongo) : base(mongo, "products") { }

    public Task<Product> GetByNameAsync(string name) => GetSingleAsync(p => p.Name == name);
}

public static class MongoSetup
{
    public static IServiceCollection AddMongo(this IServiceCollection services, string connectionString)
    {
        // Once, at startup, before any Mongo call.
        BsonClassMapRegistrar.RegisterClassMaps();

        services.AddSingleton<IMongoHelperFactory, MongoHelperFactory>();
        services.AddSingleton<IMongoHelper>(sp =>
            sp.GetRequiredService<IMongoHelperFactory>().Create("shop", connectionString));
        services.AddSingleton<ProductRepository>();
        return services;
    }
}

API overview

All types are in the AnointedAutomation.Repository.Mongo namespace.

Connecting

IMongoHelper operations

Every method takes the collection name as its first argument.

• Filters are FilterDefinition<T>. GetSingleAsync, GetFilteredDocumentsAsync, DeleteDocumentAsync, CountAsync and ExistsAsync also accept an Expression<Func<T, bool>>.
• The ...ByIdAsync methods treat a 24 character hex id as an ObjectId and any other string as a plain string _id.
• GetAllDocumentsAsync loads the whole collection; prefer GetPagedAsync, CountAsync or AggregateAsync for large collections.

Repository base

Indexes

BSON and serialization

Casing conventions

Both conventions are opt in, so installing or upgrading the package changes nothing on its own. Register one once at startup, before RegisterClassMaps() and before any Mongo call, and only after your stored data uses the matching key casing:

using AnointedAutomation.Repository.Mongo;

BsonClassMapRegistrar.RegisterHybridCasingConvention("MyCompany.MyApi");
BsonClassMapRegistrar.RegisterClassMaps();

An explicit [BsonElement("...")] always wins over a convention. Names that are not just a casing variant of the member name (_id, snake_case external fields, deliberate renames) are left alone.

Indexes example

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using AnointedAutomation.Repository.Mongo;

public static class Indexes
{
    public static Task EnsureAsync(IMongoHelper mongo) =>
        mongo.EnsureIndexesAsync("sessions", new List<MongoIndexSpec>
        {
            new MongoIndexSpec("Email", unique: true),
            new MongoIndexSpec("createdAt", expireAfter: TimeSpan.FromDays(1)),
            new MongoIndexSpec(new List<MongoIndexKey>
            {
                new MongoIndexKey("UserId"),
                new MongoIndexKey("createdAt", descending: true)
            })
        });
}

Logging

MongoHelper keeps a static buffer of LogMessage entries (for example connection failures):

using System;
using AnointedAutomation.Optimization.Logging;
using AnointedAutomation.Repository.Mongo;

MongoHelper.LogAdded += (sender, e) => Console.WriteLine(e.log.message);

foreach (LogMessage log in MongoHelper.GetLogs())
{
    Console.WriteLine($"[{log.messageType}] {log.message}");
}

MongoHelper.ClearLogs(); // raises LogCleared

Related packages

• AnointedAutomation.Objects: the models BsonClassMapRegistrar maps.
• AnointedAutomation.Logging: the LogMessage type used for the log buffer.
• AnointedAutomation.Objects.API: the matching JSON casing convention.
• AnointedAutomation.Repository.MySql: the same repository style for MySQL.

License

MIT. See LICENSE.

Support This Project

This library is free and open source. The best way to support the work is to shop with us:

• Christian items: https://store.anointed.company
• Everything else: https://www.mart.club

Found a bug or have a request? Open an issue at https://github.com/AnointedAutomation/AnointedAutomation/issues.