MongoZen 0.12.3
See the version list below for details.
dotnet add package MongoZen --version 0.12.3
NuGet\Install-Package MongoZen -Version 0.12.3
<PackageReference Include="MongoZen" Version="0.12.3" />
<PackageVersion Include="MongoZen" Version="0.12.3" />
<PackageReference Include="MongoZen" />
paket add MongoZen --version 0.12.3
#r "nuget: MongoZen, 0.12.3"
#:package MongoZen@0.12.3
#addin nuget:?package=MongoZen&version=0.12.3
#tool nuget:?package=MongoZen&version=0.12.3
MongoZen
MongoDB is nice and all, but the driver experience in C# usually sucks. You either end up with reflection-heavy "automagical" repositories, or you're writing manual BsonDocument boilerplate for aggregation pipelines like it's 2011.
Now, the idea behind MongoZen is to take a Mongo driver then add "Unit of Work" and "Identity Map" patterns from EF Core or RavenDB. But I wanted them to actually be fast and as MongoDB-native as possible.
So, why should you care?
- No Reflection on the Hot Path: Instead, there are Roslyn Source Generators to wire up your
DbSetand sessions at compile-time. If it's slow, it's not because of us. - Identity Map: If you load the same document twice in one session, you get the same instance.
- Automatic Change Tracking: Modify POCOs directly. When you call
SaveChangesAsync(), we figure out what changed and flush it in a single bulk write operation per collection. Or a transaction if supported. - RavenDB-inspired API:
Store,Delete,LoadAsync. It's a clean API that doesn't get in your way. - In-Memory Provider: Write tests that run fast without spinning up a Docker "testcontainer" container every time.
Quick Start
1. Define your Context
You need a partial class so the generator can do its thing.
public partial class MyDbContext : MongoZen.DbContext
{
// These properties are automatically initialized
public IDbSet<Person> People { get; set; } = null!;
public MyDbContext(DbContextOptions options) : base(options) { }
}
2. Use it
Everything happens inside a session.
var options = DbContextOptions.CreateForMongo("mongodb://localhost:27017", "MyDatabase");
var db = new MyDbContext(options);
await using var session = db.StartSession();
// Fetch Alice
var alice = await session.LoadAsync<Person>("alice-id");
// Just change the property. No .Update() needed.
alice.Age = 31;
// Load someone else while we're at it
var bob = new Person { Name = "Bob", Age = 25 };
session.Store(bob);
// One network round-trip to commit everything
await session.SaveChangesAsync();
Testing
Just swap the options. It's that simple.
var options = new DbContextOptions(); // Default is In-Memory
var testDb = new MyDbContext(options);
Performance & Benchmarks (WIP)
We compare MongoZen against a hand-optimized raw driver baseline. The goal isn't just to be "as fast as" the driver, but to prove that the architectural overhead of Change Tracking and Identity Maps is negligible (or even beneficial) compared to manual boilerplate.
Results (1,000 & 5,000 Entities)
Test Environment: .NET 10, MongoDB Replica Set in Docker (directConnection=true).
| Method | Category | Count | Mean | Ratio | Allocated | Alloc Ratio |
|---|---|---|---|---|---|---|
| MongoZen_ReadRepeat | IdentityMap | 5000 | 5.0 ms | 0.02 | 33 KB | 0.01 |
| RawDriver_ReadRepeat | IdentityMap | 5000 | 305.9 ms | 1.00 | 3173 KB | 1.00 |
| MongoZen_ReadAndModify | ReadModify | 5000 | 198.7 ms | 0.67 | 30195 KB | 0.93 |
| RawDriver_ReadAndModify | ReadModify | 5000 | 297.3 ms | 1.00 | 32339 KB | 1.00 |
| MongoZen_InsertBatch | Insert | 5000 | 285.7 ms | 1.75 | 19464 KB | 2.35 |
| RawDriver_InsertBatch | Insert | 5000 | 171.0 ms | 1.00 | 8275 KB | 1.00 |
What these numbers mean:
- IdentityMap (Repeated Reads): Serve requests from memory. MongoZen is ~50x - 100x faster because it serves repeated requests for the same ID from the local
ISessionTrackerinstead of hitting the wire. - ReadAndModify (Change Tracking): This is the core "Zen" win. Even with the overhead of diffing, MongoZen is 33% faster and uses less memory than hand-written
BulkWritecode. Why? Our optimized internal engine (using unmanaged Arena memory, HashSets, and zero-allocationDocIdfingerprints) is more efficient at preparing write models than manual C# code. - Insert (The "Tracking Tax"): Overhead has been cut in half (from 3.6x to 1.75x) thanks to the
DocIddiscriminated union and session-level buffer pooling. This is the one-time cost of allocating shadow structs and registering entities in the Identity Map so you can enjoy the performance wins above for the rest of the object lifecycle.
More Info
Check out our Wiki for:
License
MIT. Go build something cool.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
-
net10.0
- MongoDB.Driver (>= 3.3.0)
- SharpArena (>= 0.7.21)
- System.IO.Hashing (>= 10.0.7)
-
net8.0
- MongoDB.Driver (>= 3.3.0)
- SharpArena (>= 0.7.21)
- System.IO.Hashing (>= 10.0.7)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
- Initial work on MongoZen.