Devorion.MongoDB.SchemaManager 1.0.0-beta.2

Devorion.MongoDB.SchemaManager

A lightweight MongoDB library for .NET with automatic schema validation, index management, and migrations.

Installation

dotnet add package Devorion.MongoDB.SchemaManager

Quick Start

services.AddMongoSchemaSetup("mongodb://localhost:27017", "MyDatabase");

Setup with Options

services.AddMongoSchemaSetup(
    connectionString: "mongodb://localhost:27017",
    databaseName: "MyDatabase",
    registerEntities: async schema =>
    {
        schema.RegisterEntityForValidation<MyEntity>();
        schema.RegisterEntityForIndex<MyEntity, MyEntityIndexFactory>();
    },
    configureOptions: options =>
    {
        options.DefaultReadPreference = ReadPreference.SecondaryPreferred;
    }
);

Entity Definition

public class MyEntity : IMongoEntity
{
    public static string CollectionName => "my_entities";

    [BsonId]
    [BsonRepresentation(BsonType.ObjectId)]
    public string Id { get; set; } = null!;

    [BsonElement("name")]
    public string Name { get; set; } = null!;

    [BsonElement("createdAt")]
    public DateTime CreatedAt { get; set; } = DateTime.UtcNow;

    [NotRequired]
    [BsonElement("description")]
    public string? Description { get; set; }
}

Index Factory

public class MyEntityIndexFactory : IIndexModelsFactory<MyEntity>
{
    public static List<CreateIndexModel<MyEntity>> ConfigureIndexModels()
    {
        return new List<CreateIndexModel<MyEntity>>
        {
            new(Builders<MyEntity>.IndexKeys.Ascending(e => e.Name),
                new CreateIndexOptions { Name = "name_index" })
        };
    }
}

Usage

public class EntityService
{
    private readonly IMongoCollection<MyEntity> _collection;
    private readonly MongoDbStore _store;

    public EntityService(MongoDbStore store)
    {
        _store = store;
        _collection = store.GetCollection<MyEntity>();
    }

    // Get all
    public async Task<List<MyEntity>> GetAllAsync()
        => await _collection.All().ToListAsync();

    // Type-safe search
    public async Task<List<MyEntity>> SearchAsync(string term)
        => await _collection.Search(term, e => e.Name, e => e.Description).ToListAsync();

    // Type-safe sorting
    public async Task<List<MyEntity>> GetSortedAsync()
        => await _collection.All().ApplySorting(e => e.CreatedAt, SortDirection.Descending).ToListAsync();

    // Transaction
    public async Task AddAsync(MyEntity entity)
        => await _store.WithSessionAsync(async session =>
            await _collection.InsertOneAsync(session, entity));
}

Migrations

public class AddNameIndexMigration : IMongoMigration
{
    public string Id => "20260119_001_AddNameIndex";

    public async Task Up(IMongoDatabase db)
    {
        var collection = db.GetCollection<MyEntity>("my_entities");
        var model = new CreateIndexModel<MyEntity>(
            Builders<MyEntity>.IndexKeys.Ascending(e => e.Name),
            new CreateIndexOptions { Name = "name_index" });
        await collection.Indexes.CreateOneAsync(model);
    }
}

Migrations are auto-discovered and tracked in the _migrations collection.