CodedThought.Core.Data.MongoDb 1.0.0-alpha.1

CodedThought.Core.Data.MongoDb

A .NET Core Data Entity Provider for MongoDB.

Requirements

MongoDb requires CodedThought.Core.Configuration and CodedThought.Core. These can be found in NuGet.

• CodedThought.Core.Configuration
• CodedThought.Core
• MongoDB.Driver 3.10.0

Usage

1. Install required packages. See requirements above.

2. Add the Database Connection settings in the appSetting.json or a custom .json file. The MongoDB connection string must include a database name, because the provider resolves the target database from the connection string.

   {
     "ConnectionString": "mongodb://localhost:27017/PeopleDb",
     "DatabaseType": "MongoDb"
   }
   

   Note: See CodedThought.Core.Configuration for JSON configuration specifications.

3. Add a new class and inherit from CodedThought.Core.Data.GenericDataStoreController. Below is a sample class file.

using CodedThought.Core;
using CodedThought.Core.Data;

public class DataController : GenericDataStoreController {

    public DataController(IMemoryCache cache, CodedThought.Core.Configuration.ConnectionSetting connectionSetting) {
        DataStore = new GenericDataStore(cache, connectionSetting, string.Empty);
    }

    public Person GetPerson(string email) {
        ParameterCollection param = DataStore.CreateParameterCollection();
        param.AddStringParameter("EmailAddress", email);
        return DataStore.Get<Person>(param);
    }

    public List<Person> GetPeople() => DataStore.GetMultiple<Person>(null);
}

using System.Data;
using CodedThought.Core;
using CodedThought.Core.Data;

/// <summary>
/// Person class used by the framework to locate the right collection and fields with class and property annotations.
/// </summary>
[DataTable("People")]
public class Person {
    public Person() { }

    [DataColumn("_id", DbType.String, DataColumnOptions.PrimaryKey)]
    public string Id { get; set; }

    [DataColumn("EmailAddress", DbType.String)]
    public string EmailAddress { get; set; }

    [DataColumn("FirstName", DbType.String)]
    public string FirstName { get; set; }

    [DataColumn("LastName", DbType.String)]
    public string LastName { get; set; }
}

Note: MongoDB generates an ObjectId for _id. Map it to a string property, as shown above. The provider writes the generated identifier back onto the entity after Add.

Behavior and Limitations

Release Notes

1.0.0-alpha.1

Upgrade Notes

• Update and Remove calls that previously passed no filter parameters, and therefore affected the whole collection, now throw. Supply at least one filter parameter.
• Applications that relied on transactions being silently ignored on a standalone MongoDB deployment will now see an exception from BeginTransaction. Use a replica set or remove the transaction.
• Long running applications should call MongoDbConnection.ReleaseCachedClients() during shutdown to dispose the cached clients.