Tools.Net.Mongo.Core 3.3.0

Tools .NET Mongo Core

Overview

A core library for managing MongoDB databases from a .NET application

Getting Started

To get started create a context class that inherits from the MongoDbContext base class. A context class is used to manage the appication's interactions with MongoDB collections by using class Properties.

MongoDbContext is an abstract class that establishes a connection to new or existing databases. The context class inhereting from MongoDbContext needs to contain properties of type IMongoCollection<TDocument> to map to the corresponding MongoDB Collection. The class used for TDocument defines the document structure for the given MongoDB collection. The data model should use MongoDB Serialization Attributes to define the behavior and data type of each property.

By default, the MongoDB collection names will be the camel cased name of the given IMongoCollection property in the context class. To override the default naming, use the CollectionName attribute.

Example

public class Pet
{
    [BsonId]
    [BsonRepresentation(BsonType.ObjectId)]
    public string Id { get; set; }
    
    [BsonIgnoreIfDefault]
    public string Type { get; set; }
    
    [BsonIgnoreIfDefault]
    public string Breed { get; set; }
    
    [BsonRequired]
    public string Name { get; set; }
    
    [BsonRepresentation(BsonType.Int32)]
    public int Age { get; set; }
}

public class VeterinaryDbContext : MongoDbContext
{
    public IMongoCollection<Pet> Pets { get; set; }

    public VeterinaryDbContext(IMongoDbContext context) : base(connectionString)
    {
    }
}

A MongoDB context class represents the connection to a single MongoDB database. To establish a connection to the MongoDB database just pass the connection string into the constructor.

var vetContext = new VeterinaryDbContext("mongodb://localhost:27017/petDatabase");

Once the connection is established, any of the MongoDB operation can be called from any IMongoCollection property.

var insertResult = vetContext.Pets.InsertOne(pet);

For direct IMongoDatabase access, use the MongoDbContext.Db property.