TK.MongoDB.Repository 2.1.0

TK.MongoDB.Repository

Repository pattern implementation (using linq) of MongoDB in .NET Framework with optional Dependency Tracking implementation.

Usage

Settings

1. Default ConnectionStringSettingName is set to "MongoDocConnection", but you can configure this by calling a static method as below:

   Settings.ConnectionStringSettingName = "MongoDocConnection";
   

2. You can configure ExpiryAfterSeconds index for a specific collection by calling a static method as below:

   Settings.Configure<Activity>(2592000);
   

3. If you intend to use Dependency Tracking, you can specify commands to <u>not</u> track by setting the NotTrackedCommands IEnumerable<string>:

   Settings.NotTrackedCommands = new List<string>() { "isMaster", "buildInfo", "getLastError", "saslStart", "saslContinue" };
   

4. Example:

   public class RepoUnitTest
   {
       public RepoUnitTest()
       {
           Settings.ConnectionStringSettingName = "MongoDocConnection";
           Settings.Configure<Activity>(2592000);
       }
   
       //.... other methods and properties
   }
   

Models

Create a document model implementing $BaseEntity$ to use in repository. The name of this model will be used as collection name in MongoDB.

public class Activity : BaseFile
{
    public string Name { get; set; }
}

Repository methods

1. Find asynchronous (using Linq Expression.)

   Activity result = ActivityRepository.FindAsync(x => x.Id == new ObjectId("5e36997898d2c15a400f8968")).Result;
   

2. Get asynchronous (by Id)

   Activity result = ActivityRepository.GetAsync(new ObjectId("5e36997898d2c15a400f8968")).Result;
   

3. Get asynchronous (using Linq Expression.)

   Has paged records in a Tuple<IEnumerable<T>, long> of records and total count.

   var result = ActivityRepository.GetAsync(1, 10, x => x.Name.Contains("abc") && x.Deleted == false).Result;
   Console.WriteLine($"Output:\nTotal: {result.Item2}\n{JToken.Parse(JsonConvert.SerializeObject(result.Item1)).ToString(Formatting.Indented)}");
   

4. Get synchronous (using Linq Expression.)

   Has nonpaged records.

   var result = ActivityRepository.Get(x => x.Name.Contains("abc") && x.Deleted == false);
   

5. In synchronous (Get by IN filter. Nonpaged records)

   List<string> names = new List<string> { "abc", "def", "ghi" };
   var result = ActivityRepository.In(x => x.Name, names);
   

6. Insert asynchronous

   Activity activity = new Activity()
   {
       Name = "abc"
   };
   
   Activity result = ActivityRepository.InsertAsync(activity).Result;
   

7. Update asynchronous

   Activity activity = new Activity()
   {
    Id = new ObjectId("5e36998998d2c1540ca23894"),
    Name = "abc3"
   };
   
   bool result = ActivityRepository.UpdateAsync(activity).Result;
   

8. Delete asynchronous (by Id)

   bool result = ActivityRepository.DeleteAsync(new ObjectId("5e36998998d2c1540ca23894")).Result;
   

9. Count asynchronous

   long result = ActivityRepository.CountAsync().Result;
   

10. Exists asynchronous (using Linq Expression)

bool result = ActivityRepository.ExistsAsync(x => x.Name == "abc").Result;

Dependency Tracking

To use dependency tracking implement the IDependencyTracker interface as below:

public class DependencyTracker : IDependencyTracker
{
	public void Dependency(string name, string description, bool success, TimeSpan duration)
    {
    	Console.WriteLine($"{name}-{description}-{success}-{duration}");
    }
}

Tests

Refer to TK.MongoDB.Test project for all Unit Tests.