VersaTul.Data.MongoDB 1.0.24

VersaTul Data MongoDB

VersaTul Data MongoDB is a C# library that provides functionality for working with Mongo Databases. The library uses the repository design pattern to provide the functionality to Fetch, Add, Update, or Delete data.

Features

• Generic interface for supporting common CRUD operations
• Generic interface for fetching configuration settings
• Generic interface for creating BsonClassMaps for entities
• Default implementation of the data configuration interface
• Abstract class providing common functionality for a MongoDB Database
• Default implementation of the entity map interface
• Helper class for generating search conditional expressions
• Abstract entity used for all Business Entities

Installation

You can install the library from NuGet using the following command:

dotnet add package VersaTul.Data.MongoDB

Usage

To use VersaTul Data MongoDB, you need to do the following steps:

• Create your entity classes by inheriting from the Entity abstract class
• Create your entity maps by inheriting from the BaseMap<TEntity> class and implementing the IEntityMap<TEntity> interface
• Create your repository classes by inheriting from the BaseRepository<TEntity, TMap, TKey> class and implementing the IRepository<TEntity, TKey> interface
• Configure your container using AutoFac Module and register your configurations, repositories, and entity maps
• Inject your repositories into your controllers or services and use the methods provided by the IRepository<TEntity, TKey> interface

For example, to create a repository for a Car entity, you can do the following:

// Car entity class
public class Car : Entity<string>
{
    public string Make { get; set; }
    public string Model { get; set; }
    public int Year { get; set; }
}

// Car entity map class
public class CarMap : BaseMap<Car>
{
    public override void Configure()
    {
        BsonClassMap.RegisterClassMap<Car>(cm =>
        {
            cm.AutoMap();
            cm.MapIdMember(c => c.Id);
            cm.SetIgnoreExtraElements(true);
        });
    }
}

// Car repository class
public class CarRepository : BaseRepository<Car, CarMap, string>, ICarRepository
{
    public CarRepository(IDataConfiguration<string> dataConfiguration) : base(dataConfiguration)
    {
    }
}

// Car repository interface
public interface ICarRepository : IRepository<Car, string>
{
}

// Configure the container using AutoFac Module
public class AppModule : Module
{
    protected override void Load(ContainerBuilder builder)
    {
        //Configs
        var configSettings = new Builder()
            .AddOrReplace("MongoDb", "mongodb://root:password123@localhost:27017/DemoDB")
            .BuildConfig();
        builder.RegisterInstance(configSettings);

        //Singletons
        builder.RegisterGeneric(typeof(DataConfiguration<>)).As(typeof(IDataConfiguration<>)).SingleInstance();
        builder.RegisterType<CarRepository>().As<ICarRepository>().SingleInstance();
        builder.RegisterType<CarMap>().As<IEntityMap<Car>>().SingleInstance();

        //Per Dependency
    }
}

// Repository usage in a controller
[Route("api/cars")]
public class CarController : Controller
{
    private readonly ICarRepository carRepository;

    public CarController(ICarRepository carRepository)
    {
        this.carRepository = carRepository;
    }

    // Get
    [HttpGet]
    public IActionResult GetCars()
    {
        var cars = carRepository.ToList();
        return OK(cars);
    }
}

Documentation

For more information on how to use VersaTul Data MongoDB, please refer to the official documentation.

License

VersaTul Data MongoDB is licensed under the MIT License.