SwitchSoftware.Repositories.MongoDb 8.0.3

SwitchSoftware.Repositories.MongoDb

SwitchSoftware.Repositories.MongoDb provides a MongoDB implementation of the SwitchSoftware.Repositories repository pattern.

It helps you work with MongoDB collections through a consistent repository abstraction, with support for CRUD operations, filtering, pagination, transactions, counting, and index creation.

Features

• MongoDB repository implementation for entities derived from EntityBase<TId>
• Create, retrieve, update, and delete operations
• Query support using expressions or MongoDB filter definitions
• Paginated queries with sorting
• Document counting
• Transaction execution helpers
• Collection index creation support

Installation

Package Manager:

Install-Package SwitchSoftware.Repositories.MongoDb

.NET CLI:

dotnet add package SwitchSoftware.Repositories.MongoDb

Requirements

• .NET Standard 2.1 compatible application
• A MongoDB instance accessible through a connection string
• MongoDB.Driver 3.x (transitive dependency � included automatically)
• The base abstractions from SwitchSoftware.Repositories

Quick Start

using System;
using Microsoft.Extensions.Logging.Abstractions;
using SwitchSoftware.Repositories.MongoDb;

public class Product : EntityBase<Guid>
{
    public string Name { get; set; }
    public decimal Price { get; set; }
}

var repository = new MongoDbRepository<Product, Guid>(
    connectionString: "mongodb://localhost:27017",
    databaseName: "catalog",
    collectionName: "products",
    logger: NullLogger<MongoDbRepository<Product, Guid>>.Instance);
// guidRepresentation defaults to GuidRepresentation.Standard (UUID)

var id = Guid.NewGuid();

await repository.Create(new Product
{
    Id = id,
    Name = "Mechanical Keyboard",
    Price = 129.99m
}, id);

var product = await repository.Retrieve(id);

Common Operations

Create

var id = Guid.NewGuid();

await repository.Create(new Product
{
    Id = id,
    Name = "Wireless Mouse",
    Price = 49.99m
}, id);

Retrieve by Id

var product = await repository.Retrieve(id);

Update

product.Price = 44.99m;
await repository.Update(product);

Delete

await repository.Delete(id);

Get All

var products = await repository.Get();

Filtered Queries

Using a LINQ expression:

var activeProducts = await repository.Get(p => p.Price > 0);

Using a MongoDB filter definition:

using MongoDB.Driver;

var filter = Builders<Product>.Filter.Gt(p => p.Price, 100);
var premiumProducts = await repository.Get(filter);

Pagination

The orderByFields parameter uses the format Field:a|OtherField:d, where:

• a = ascending
• d = descending

using MongoDB.Driver;

var filter = Builders<Product>.Filter.Empty;
var page = await repository.GetPaginated(filter, "Name:a", 20, 0);

Count Documents

using MongoDB.Driver;

var count = await repository.CountItems(Builders<Product>.Filter.Gt(p => p.Price, 100));

Transactions

You can execute repository operations inside a MongoDB transaction using WithTransaction.

var result = await repository.WithTransaction(() =>
{
    var id = Guid.NewGuid();

    repository.Create(new Product
    {
        Id = id,
        Name = "Transactional Item",
        Price = 10m
    }, id).GetAwaiter().GetResult();

    var saved = repository.Retrieve(id).GetAwaiter().GetResult();
    return saved.Name;
});

Index Creation

Use AddIndexes to create one or more indexes on the collection.

using MongoDB.Driver;

var indexes = new[]
{
    new CreateIndexModel<Product>(
        Builders<Product>.IndexKeys.Ascending(p => p.Name))
};

repository.AddIndexes(indexes);

Guid Serialization Important Note

By default the repository registers GuidRepresentation.Standard (UUID format), which is the recommended format for new applications using MongoDB.Driver 3.x.

If you are working with an existing database that stored Guid values using MongoDB.Driver 2.x (which defaulted to CSharpLegacy), pass the matching representation to the constructor to maintain read/write compatibility:

using MongoDB.Bson;
using Microsoft.Extensions.Logging.Abstractions;
using SwitchSoftware.Repositories.MongoDb;

var repository = new MongoDbRepository<Product, Guid>(
    connectionString: "mongodb://localhost:27017",
    databaseName: "catalog",
    collectionName: "products",
    logger: NullLogger<MongoDbRepository<Product, Guid>>.Instance,
    guidRepresentation: GuidRepresentation.CSharpLegacy);

Available values are any member of MongoDB.Bson.GuidRepresentation: Standard, CSharpLegacy, JavaLegacy, PythonLegacy, and Unspecified.

When to Use This Package

This package is a good fit when you want to:

• Keep a repository abstraction in applications that use MongoDB
• Reuse patterns from SwitchSoftware.Repositories
• Centralize MongoDB collection access behind strongly typed repositories
• Add pagination, filtering, and index management without repeating infrastructure code

Package Summary

SwitchSoftware.Repositories.MongoDb is a lightweight repository implementation for MongoDB focused on practical application use cases and consistent data-access patterns.

Upgrade Notes

8.0.3

• Upgraded MongoDB.Driver dependency from 2.28.0 to 3.8.1.
• GuidRepresentation breaking change: MongoDB.Driver 3.x removed the global GuidRepresentation setting. This library now defaults to GuidRepresentation.Standard (UUID). If your application has existing data stored with a MongoDB.Driver 2.x installation, Guid fields were written using CSharpLegacy format by default and will not be read correctly without migration or configuration. To maintain compatibility, pass guidRepresentation: GuidRepresentation.CSharpLegacy to the constructor. See the Guid Serialization section for details.
• Since IMongoDbRepository exposes FilterDefinition<TEntity> and CreateIndexModel<TEntity>, consuming projects must now reference MongoDB.Driver 3.x.

8.0.2

• Added AddIndexes method.

8.0.1

• Upgraded MongoDB.Driver to 2.28.0.