ColinChang.MongoHelper 1.0.0

A common MongoDB helper based on MongoDB.Driver.

Install-Package ColinChang.MongoHelper -Version 1.0.0
dotnet add package ColinChang.MongoHelper --version 1.0.0
<PackageReference Include="ColinChang.MongoHelper" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ColinChang.MongoHelper --version 1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

This is a MongoDB operation utility based on MongoDB.Driver like the SqlHelper for relation database.It provides the usual CRUD methods.Query for ordered paged and big data are also supported.Index management also included.

Details of how to use it,please check the unit test project.

Serialize & Deserialize

When a Generic method like Task<IEnumerable<T>> QueryAsync<T>() is invoked,MongoDriver will try to deserialize the query result to an object of type provided.When the type of the object is complex,it may result in some unexpected exceptions.

  • Numbers.Use long instead of int.Use double instead of float
  • ObjectId. When the object has an ObjectId type member,a custom ObjectIdConverter is required.You can also use ColinChang.MongoHelper.JsonConvert simply to handle this.
  • Subclass. MongoDriver is not friendly for subclass when deserialize to object.try to use interface rather than BaseClass.
  • Unmapped members.When the type of your object is not complete mapped with the data from mongo.You should map both of them before invoking mongohelper.
var mongo =
    new MongoHelper("mongodb://127.0.0.1","TestDb");
        
BsonClassMap.RegisterClassMap<ImageResult>(map =>
{
    map.AutoMap();
    map.SetIgnoreExtraElements(true);
    map.MapIdField(p => p.Id);
    map.UnmapMember(p=>p.Key);
    
    point.MapProperty(p => ir.UserName).SetElementName("name");
});

check more details here

This is a MongoDB operation utility based on MongoDB.Driver like the SqlHelper for relation database.It provides the usual CRUD methods.Query for ordered paged and big data are also supported.Index management also included.

Details of how to use it,please check the unit test project.

Serialize & Deserialize

When a Generic method like Task<IEnumerable<T>> QueryAsync<T>() is invoked,MongoDriver will try to deserialize the query result to an object of type provided.When the type of the object is complex,it may result in some unexpected exceptions.

  • Numbers.Use long instead of int.Use double instead of float
  • ObjectId. When the object has an ObjectId type member,a custom ObjectIdConverter is required.You can also use ColinChang.MongoHelper.JsonConvert simply to handle this.
  • Subclass. MongoDriver is not friendly for subclass when deserialize to object.try to use interface rather than BaseClass.
  • Unmapped members.When the type of your object is not complete mapped with the data from mongo.You should map both of them before invoking mongohelper.
var mongo =
    new MongoHelper("mongodb://127.0.0.1","TestDb");
        
BsonClassMap.RegisterClassMap<ImageResult>(map =>
{
    map.AutoMap();
    map.SetIgnoreExtraElements(true);
    map.MapIdField(p => p.Id);
    map.UnmapMember(p=>p.Key);
    
    point.MapProperty(p => ir.UserName).SetElementName("name");
});

check more details here

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
1.0.0 242 3/23/2019