using MongoDB.Driver;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using System.Linq.Expressions;
using MongoDbGenericRepository.Models;
using System.Linq;
namespace MongoDbGenericRepository
{
///
/// The IBaseMongoRepository exposes the functionality of the BaseMongoRepository.
///
public interface IBaseMongoRepository
{
///
/// The connection string.
///
string ConnectionString { get; set; }
///
/// The database name.
///
string DatabaseName { get; set; }
#region Create
///
/// Asynchronously adds a document to the collection.
///
/// The type representing a Document.
/// The document you want to add.
Task AddOneAsync(TDocument document) where TDocument : IDocument;
///
/// Asynchronously adds a document to the collection.
/// Populates the Id and AddedAtUtc fields if necessary.
///
/// The type representing a Document.
/// The type of the primary key for a Document.
/// The document you want to add.
Task AddOneAsync(TDocument document)
where TDocument : IDocument
where TKey : IEquatable;
///
/// Adds a document to the collection.
/// Populates the Id and AddedAtUtc fields if necessary.
///
/// The type representing a Document.
/// The document you want to add.
void AddOne(TDocument document) where TDocument : IDocument;
///
/// Adds a document to the collection.
/// Populates the Id and AddedAtUtc fields if necessary.
///
/// The type representing a Document.
/// The type of the primary key for a Document.
/// The document you want to add.
void AddOne(TDocument document)
where TDocument : IDocument
where TKey : IEquatable;
///
/// Asynchronously adds a list of documents to the collection.
/// Populates the Id and AddedAtUtc fields if necessary.
///
/// The type representing a Document.
/// The document you want to add.
Task AddManyAsync(IEnumerable documents) where TDocument : IDocument;
///
/// Adds a list of documents to the collection.
/// Populates the Id and AddedAtUtc fields if necessary.
///
/// The type representing a Document.
/// The document you want to add.
void AddMany(IEnumerable documents) where TDocument : IDocument;
#endregion
#region Read
///
/// Asynchronously returns one document given its id.
///
/// The type representing a Document.
/// The Id of the document you want to get.
/// An optional partition key.
Task GetByIdAsync(Guid id, string partitionKey = null) where TDocument : IDocument;
///
/// Returns one document given its id.
///
/// The type representing a Document.
/// The Id of the document you want to get.
/// An optional partition key.
TDocument GetById(Guid id, string partitionKey = null) where TDocument : IDocument;
///
/// Asynchronously returns one document given an expression filter.
///
/// The type representing a Document.
/// A LINQ expression filter.
/// An optional partition key.
Task GetOneAsync(Expression> filter, string partitionKey = null) where TDocument : IDocument;
///
/// Returns one document given an expression filter.
///
/// The type representing a Document.
/// A LINQ expression filter.
/// An optional partition key.
TDocument GetOne(Expression> filter, string partitionKey = null) where TDocument : IDocument;
///
/// Returns a collection cursor.
///
/// The type representing a Document.
/// A LINQ expression filter.
/// An optional partition key.
IFindFluent GetCursor(Expression> filter, string partitionKey = null) where TDocument : IDocument;
///
/// Asynchronously returns true if any of the document of the collection matches the filter condition.
///
/// The type representing a Document.
/// A LINQ expression filter.
/// An optional partition key.
Task AnyAsync(Expression> filter, string partitionKey = null) where TDocument : IDocument;
///
/// Returns true if any of the document of the collection matches the filter condition.
///
/// The type representing a Document.
/// A LINQ expression filter.
/// An optional partition key.
bool Any(Expression> filter, string partitionKey = null) where TDocument : IDocument;
///
/// Asynchronously returns a list of the documents matching the filter condition.
///
/// The type representing a Document.
/// A LINQ expression filter.
/// An optional partition key.
Task> GetAllAsync(Expression> filter, string partitionKey = null) where TDocument : IDocument;
///
/// Returns a list of the documents matching the filter condition.
///
/// The type representing a Document.
/// A LINQ expression filter.
/// An optional partition key.
List GetAll(Expression> filter, string partitionKey = null) where TDocument : IDocument;
///
/// Asynchronously counts how many documents match the filter condition.
///
/// The type representing a Document.
/// A LINQ expression filter.
/// An optional partition key.
Task CountAsync(Expression> filter, string partitionKey = null) where TDocument : IDocument;
///
/// Counts how many documents match the filter condition.
///
/// The type representing a Document.
/// A LINQ expression filter.
/// An optional partition key.
long Count(Expression> filter, string partitionKey = null) where TDocument : IDocument;
#endregion
#region Update
///
/// Asynchronously Updates a document.
///
/// The type representing a Document.
/// The document with the modifications you want to persist.
Task UpdateOneAsync(TDocument modifiedDocument) where TDocument : IDocument;
///
/// Updates a document.
///
/// The type representing a Document.
/// The document with the modifications you want to persist.
bool UpdateOne(TDocument modifiedDocument) where TDocument : IDocument;
#endregion
#region Delete
///
/// Asynchronously deletes a document.
///
/// The type representing a Document.
/// The document you want to delete.
/// The number of documents deleted.
Task DeleteOneAsync(TDocument document) where TDocument : IDocument;
///
/// Asynchronously deletes a document matching the condition of the LINQ expression filter.
///
/// The type representing a Document.
/// A LINQ expression filter.
/// An optional partition key.
/// The number of documents deleted.
Task DeleteOneAsync(Expression> filter, string partitionKey = null) where TDocument : IDocument;
///
/// Deletes a document.
///
/// The type representing a Document.
/// The document you want to delete.
/// The number of documents deleted.
long DeleteOne(TDocument document) where TDocument : IDocument;
///
/// Deletes a document matching the condition of the LINQ expression filter.
///
/// The type representing a Document.
/// A LINQ expression filter.
/// An optional partition key.
/// The number of documents deleted.
long DeleteOne(Expression> filter, string partitionKey = null) where TDocument : IDocument;
///
/// Asynchronously deletes the documents matching the condition of the LINQ expression filter.
///
/// The type representing a Document.
/// A LINQ expression filter.
/// An optional partition key.
/// The number of documents deleted.
Task DeleteManyAsync(Expression> filter, string partitionKey = null) where TDocument : IDocument;
///
/// Asynchronously deletes a list of documents.
///
/// The type representing a Document.
/// The list of documents to delete.
/// The number of documents deleted.
Task DeleteManyAsync(IEnumerable documents) where TDocument : IDocument;
///
/// Deletes a list of documents.
///
/// The type representing a Document.
/// The list of documents to delete.
/// The number of documents deleted.
long DeleteMany(IEnumerable documents) where TDocument : IDocument;
///
/// Deletes the documents matching the condition of the LINQ expression filter.
///
/// The type representing a Document.
/// A LINQ expression filter.
/// An optional partition key.
/// The number of documents deleted.
long DeleteMany(Expression> filter, string partitionKey = null) where TDocument : IDocument;
///
/// Deletes the documents matching the condition of the LINQ expression filter.
///
/// The type representing a Document.
/// The type of the primary key for a Document.
/// A LINQ expression filter.
/// An optional partition key.
/// The number of documents deleted.
long DeleteMany(Expression> filter, string partitionKey = null)
where TDocument : IDocument
where TKey : IEquatable;
#endregion
#region Project
///
/// Asynchronously returns a projected document matching the filter condition.
///
/// The type representing a Document.
/// The type representing the model you want to project to.
///
/// The projection expression.
/// An optional partition key.
Task ProjectOneAsync(Expression> filter, Expression> projection, string partitionKey = null)
where TDocument : IDocument
where TProjection : class;
///
/// Asynchronously returns a projected document matching the filter condition.
///
/// The type representing a Document.
/// The type of the primary key for a Document.
/// The type representing the model you want to project to.
///
/// The projection expression.
/// An optional partition key.
Task ProjectOneAsync(Expression> filter, Expression> projection, string partitionKey = null)
where TDocument : IDocument
where TKey : IEquatable
where TProjection : class;
///
/// Returns a projected document matching the filter condition.
///
/// The type representing a Document.
/// The type representing the model you want to project to.
///
/// The projection expression.
/// An optional partition key.
TProjection ProjectOne(Expression> filter, Expression> projection, string partitionKey = null)
where TDocument : IDocument
where TProjection : class;
///
/// Returns a projected document matching the filter condition.
///
/// The type representing a Document.
/// The type of the primary key for a Document.
/// The type representing the model you want to project to.
///
/// The projection expression.
/// An optional partition key.
TProjection ProjectOne(Expression> filter, Expression> projection, string partitionKey = null)
where TDocument : IDocument
where TKey : IEquatable
where TProjection : class;
///
/// Asynchronously returns a list of projected documents matching the filter condition.
///
/// The type representing a Document.
/// The type representing the model you want to project to.
///
/// The projection expression.
/// An optional partition key.
Task> ProjectManyAsync(Expression> filter, Expression> projection, string partitionKey = null)
where TDocument : IDocument
where TProjection : class;
///
/// Asynchronously returns a list of projected documents matching the filter condition.
///
/// The type representing a Document.
/// The type of the primary key for a Document.
/// The type representing the model you want to project to.
///
/// The projection expression.
/// An optional partition key.
Task> ProjectManyAsync(Expression> filter, Expression> projection, string partitionKey = null)
where TDocument : IDocument
where TKey : IEquatable
where TProjection : class;
///
/// Asynchronously returns a list of projected documents matching the filter condition.
///
/// The type representing a Document.
/// The type representing the model you want to project to.
///
/// The projection expression.
/// An optional partition key.
List ProjectMany(Expression> filter, Expression> projection, string partitionKey = null)
where TDocument : IDocument
where TProjection : class;
///
/// Asynchronously returns a list of projected documents matching the filter condition.
///
/// The type representing a Document.
/// The type of the primary key for a Document.
/// The type representing the model you want to project to.
///
/// The projection expression.
/// An optional partition key.
List ProjectMany(Expression> filter, Expression> projection, string partitionKey = null)
where TDocument : IDocument
where TKey : IEquatable
where TProjection : class;
#endregion
///
/// Asynchronously returns a paginated list of the documents matching the filter condition.
///
/// The type representing a Document.
///
/// The number of documents you want to skip. Default value is 0.
/// The number of documents you want to take. Default value is 50.
/// An optional partition key.
Task> GetPaginatedAsync(Expression> filter, int skipNumber = 0, int takeNumber = 50, string partitionKey = null)
where TDocument : IDocument;
///
/// Asynchronously returns a paginated list of the documents matching the filter condition.
///
/// The type representing a Document.
/// The type of the primary key for a Document.
///
/// The number of documents you want to skip. Default value is 0.
/// The number of documents you want to take. Default value is 50.
/// An optional partition key.
Task> GetPaginatedAsync(Expression> filter, int skipNumber = 0, int takeNumber = 50, string partitionKey = null)
where TDocument : IDocument
where TKey : IEquatable;
///
/// GetAndUpdateOne with filter
///
/// The type representing a Document.
///
///
///
///
Task GetAndUpdateOne(FilterDefinition filter, UpdateDefinition update, FindOneAndUpdateOptions options)
where TDocument : IDocument;
///
/// GetAndUpdateOne with filter
///
/// The type representing a Document.
/// The type of the primary key for a Document.
///
///
///
///
Task GetAndUpdateOne(FilterDefinition filter, UpdateDefinition update, FindOneAndUpdateOptions options)
where TDocument : IDocument
where TKey : IEquatable;
}
///
/// The base Repository, it is meant to be inherited from by your custom custom MongoRepository implementation.
/// Its constructor must be given a connection string and a database name.
///
public abstract class BaseMongoRepository : IBaseMongoRepository
{
///
/// The connection string.
///
public string ConnectionString { get; set; }
///
/// The database name.
///
public string DatabaseName { get; set; }
///
/// The constructor taking a connection string and a database name.
///
/// The connection string of the MongoDb server.
/// The name of the database against which you want to perform operations.
protected BaseMongoRepository(string connectionString, string databaseName)
{
MongoDbContext = new MongoDbContext(connectionString, databaseName);
}
///
/// The contructor taking a .
///
/// A mongodb context implementing
protected BaseMongoRepository(IMongoDbContext mongoDbContext)
{
MongoDbContext = mongoDbContext;
}
///
/// The MongoDbContext
///
protected IMongoDbContext MongoDbContext = null;
#region Create
///
/// Asynchronously adds a document to the collection.
/// Populates the Id and AddedAtUtc fields if necessary.
///
/// The type representing a Document.
/// The document you want to add.
public async Task AddOneAsync(TDocument document) where TDocument : IDocument
{
FormatDocument(document);
await HandlePartitioned(document).InsertOneAsync(document);
}
///
/// Asynchronously adds a document to the collection.
/// Populates the Id and AddedAtUtc fields if necessary.
///
/// The type representing a Document.
/// The type of the primary key for a Document.
/// The document you want to add.
public async Task AddOneAsync(TDocument document)
where TDocument : IDocument
where TKey : IEquatable
{
FormatDocument(document);
await HandlePartitioned(document).InsertOneAsync(document);
}
///
/// Adds a document to the collection.
/// Populates the Id and AddedAtUtc fields if necessary.
///
/// The type representing a Document.
/// The document you want to add.
public void AddOne(TDocument document) where TDocument : IDocument
{
FormatDocument(document);
HandlePartitioned(document).InsertOne(document);
}
///
/// Adds a document to the collection.
/// Populates the Id and AddedAtUtc fields if necessary.
///
/// The type representing a Document.
/// The type of the primary key for a Document.
/// The document you want to add.
public void AddOne(TDocument document)
where TDocument : IDocument
where TKey : IEquatable
{
FormatDocument(document);
HandlePartitioned(document).InsertOne(document);
}
///
/// Asynchronously adds a list of documents to the collection.
/// Populates the Id and AddedAtUtc fields if necessary.
///
/// The type representing a Document.
/// The documents you want to add.
public async Task AddManyAsync(IEnumerable documents) where TDocument : IDocument
{
if (!documents.Any())
{
return;
}
foreach (var doc in documents)
{
FormatDocument(doc);
}
await HandlePartitioned(documents.FirstOrDefault()).InsertManyAsync(documents);
}
///
/// Asynchronously adds a list of documents to the collection.
/// Populates the Id and AddedAtUtc fields if necessary.
///
/// The type representing a Document.
/// The type of the primary key for a Document.
/// The documents you want to add.
public async Task AddManyAsync(IEnumerable documents)
where TDocument : IDocument
where TKey : IEquatable
{
if (!documents.Any())
{
return;
}
foreach (var doc in documents)
{
FormatDocument(doc);
}
await HandlePartitioned(documents.FirstOrDefault()).InsertManyAsync(documents);
}
///
/// Adds a list of documents to the collection.
/// Populates the Id and AddedAtUtc fields if necessary.
///
/// The type representing a Document.
/// The documents you want to add.
public void AddMany(IEnumerable documents) where TDocument : IDocument
{
if (!documents.Any())
{
return;
}
foreach (var document in documents)
{
FormatDocument(document);
}
HandlePartitioned(documents.FirstOrDefault()).InsertMany(documents.ToList());
}
#endregion Create
#region Read
///
/// Asynchronously returns one document given its id.
///
/// The type representing a Document.
/// The Id of the document you want to get.
/// An optional partition key.
public async Task GetByIdAsync(Guid id, string partitionKey = null) where TDocument : IDocument
{
var filter = Builders.Filter.Eq("Id", id);
return await HandlePartitioned(partitionKey).Find(filter).FirstOrDefaultAsync();
}
///
/// Returns one document given its id.
///
/// The type representing a Document.
/// The Id of the document you want to get.
/// An optional partition key.
public TDocument GetById(Guid id, string partitionKey = null) where TDocument : IDocument
{
var filter = Builders.Filter.Eq("Id", id);
return HandlePartitioned(partitionKey).Find(filter).FirstOrDefault();
}
///
/// Asynchronously returns one document given an expression filter.
///
/// The type representing a Document.
/// A LINQ expression filter.
/// An optional partition key.
public async Task GetOneAsync(Expression> filter, string partitionKey = null) where TDocument : IDocument
{
return await HandlePartitioned(partitionKey).Find(filter).FirstOrDefaultAsync();
}
///
/// Returns one document given an expression filter.
///
/// The type representing a Document.
/// A LINQ expression filter.
/// An optional partition key.
public TDocument GetOne(Expression> filter, string partitionKey = null) where TDocument : IDocument
{
return HandlePartitioned(partitionKey).Find(filter).FirstOrDefault();
}
///
/// Returns a collection cursor.
///
/// The type representing a Document.
/// A LINQ expression filter.
/// An optional partition key.
public IFindFluent GetCursor(Expression> filter, string partitionKey = null) where TDocument : IDocument
{
return HandlePartitioned(partitionKey).Find(filter);
}
///
/// Returns true if any of the document of the collection matches the filter condition.
///
/// The type representing a Document.
/// A LINQ expression filter.
/// An optional partition key.
public async Task AnyAsync(Expression> filter, string partitionKey = null) where TDocument : IDocument
{
var count = await HandlePartitioned(partitionKey).CountAsync(filter);
return (count > 0);
}
///
/// Returns true if any of the document of the collection matches the filter condition.
///
/// The type representing a Document.
/// A LINQ expression filter.
/// An optional partition key.
public bool Any(Expression> filter, string partitionKey = null) where TDocument : IDocument
{
var count = HandlePartitioned(partitionKey).Count(filter);
return (count > 0);
}
///
/// Asynchronously returns a list of the documents matching the filter condition.
///
/// The type representing a Document.
/// A LINQ expression filter.
/// An optional partition key.
public async Task> GetAllAsync(Expression> filter, string partitionKey = null) where TDocument : IDocument
{
return await HandlePartitioned(partitionKey).Find(filter).ToListAsync();
}
///
/// Returns a list of the documents matching the filter condition.
///
/// The type representing a Document.
/// A LINQ expression filter.
/// An optional partition key.
public List GetAll(Expression> filter, string partitionKey = null) where TDocument : IDocument
{
return HandlePartitioned(partitionKey).Find(filter).ToList();
}
///
/// Asynchronously counts how many documents match the filter condition.
///
/// The type representing a Document.
/// A LINQ expression filter.
/// An optional partitionKey
public async Task CountAsync(Expression> filter, string partitionKey = null) where TDocument : IDocument
{
return await HandlePartitioned(partitionKey).CountAsync(filter);
}
///
/// Counts how many documents match the filter condition.
///
/// The type representing a Document.
/// A LINQ expression filter.
/// An optional partitionKey
public long Count(Expression> filter, string partitionKey = null) where TDocument : IDocument
{
return HandlePartitioned(partitionKey).Find(filter).Count();
}
#endregion
#region Read TKey
///
/// Asynchronously returns one document given its id.
///
/// The type representing a Document.
/// The type of the primary key for a Document.
/// The Id of the document you want to get.
/// An optional partition key.
public async Task GetByIdAsync(Guid id, string partitionKey = null)
where TDocument : IDocument
where TKey : IEquatable
{
var filter = Builders.Filter.Eq("Id", id);
return await HandlePartitioned(partitionKey).Find(filter).FirstOrDefaultAsync();
}
///
/// Returns one document given its id.
///
/// The type representing a Document.
/// The type of the primary key for a Document.
/// The Id of the document you want to get.
/// An optional partition key.
public TDocument GetById(Guid id, string partitionKey = null)
where TDocument : IDocument
where TKey : IEquatable
{
var filter = Builders.Filter.Eq("Id", id);
return HandlePartitioned(partitionKey).Find(filter).FirstOrDefault();
}
///
/// Asynchronously returns one document given an expression filter.
///
/// The type representing a Document.
/// The type of the primary key for a Document.
/// A LINQ expression filter.
/// An optional partition key.
public async Task GetOneAsync(Expression> filter, string partitionKey = null)
where TDocument : IDocument
where TKey : IEquatable
{
return await HandlePartitioned(partitionKey).Find(filter).FirstOrDefaultAsync();
}
///
/// Returns one document given an expression filter.
///
/// The type representing a Document.
/// The type of the primary key for a Document.
/// A LINQ expression filter.
/// An optional partition key.
public TDocument GetOne(Expression> filter, string partitionKey = null)
where TDocument : IDocument
where TKey : IEquatable
{
return HandlePartitioned(partitionKey).Find(filter).FirstOrDefault();
}
///
/// Returns a collection cursor.
///
/// The type representing a Document.
/// The type of the primary key for a Document.
/// A LINQ expression filter.
/// An optional partition key.
public IFindFluent GetCursor(Expression> filter, string partitionKey = null)
where TDocument : IDocument
where TKey : IEquatable
{
return HandlePartitioned(partitionKey).Find(filter);
}
///
/// Returns true if any of the document of the collection matches the filter condition.
///
/// The type representing a Document.
/// The type of the primary key for a Document.
/// A LINQ expression filter.
/// An optional partition key.
public async Task AnyAsync(Expression> filter, string partitionKey = null)
where TDocument : IDocument
where TKey : IEquatable
{
var count = await HandlePartitioned(partitionKey).CountAsync(filter);
return (count > 0);
}
///
/// Returns true if any of the document of the collection matches the filter condition.
///
/// The type representing a Document.
/// The type of the primary key for a Document.
/// A LINQ expression filter.
/// An optional partition key.
public bool Any(Expression> filter, string partitionKey = null)
where TDocument : IDocument
where TKey : IEquatable
{
var count = HandlePartitioned(partitionKey).Count(filter);
return (count > 0);
}
///
/// Asynchronously returns a list of the documents matching the filter condition.
///
/// The type representing a Document.
/// The type of the primary key for a Document.
/// A LINQ expression filter.
/// An optional partition key.
public async Task> GetAllAsync(Expression> filter, string partitionKey = null)
where TDocument : IDocument
where TKey : IEquatable
{
return await HandlePartitioned(partitionKey).Find(filter).ToListAsync();
}
///
/// Returns a list of the documents matching the filter condition.
///
/// The type representing a Document.
/// The type of the primary key for a Document.
/// A LINQ expression filter.
/// An optional partition key.
public List GetAll(Expression> filter, string partitionKey = null)
where TDocument : IDocument
where TKey : IEquatable
{
return HandlePartitioned(partitionKey).Find(filter).ToList();
}
///
/// Asynchronously counts how many documents match the filter condition.
///
/// The type representing a Document.
/// The type of the primary key for a Document.
/// A LINQ expression filter.
/// An optional partitionKey
public async Task CountAsync(Expression> filter, string partitionKey = null)
where TDocument : IDocument
where TKey : IEquatable
{
return await HandlePartitioned(partitionKey).CountAsync(filter);
}
///
/// Counts how many documents match the filter condition.
///
/// The type representing a Document.
/// The type of the primary key for a Document.
/// A LINQ expression filter.
/// An optional partitionKey
public long Count(Expression> filter, string partitionKey = null)
where TDocument : IDocument
where TKey : IEquatable
{
return HandlePartitioned(partitionKey).Find(filter).Count();
}
#endregion
#region Update
///
/// Asynchronously Updates a document.
///
/// The type representing a Document.
/// The document with the modifications you want to persist.
public async Task UpdateOneAsync(TDocument modifiedDocument) where TDocument : IDocument
{
var updateRes = await HandlePartitioned(modifiedDocument).ReplaceOneAsync(x => x.Id == modifiedDocument.Id, modifiedDocument);
return updateRes.ModifiedCount == 1;
}
///
/// Updates a document.
///
/// The type representing a Document.
/// The document with the modifications you want to persist.
public bool UpdateOne(TDocument modifiedDocument) where TDocument : IDocument
{
var updateRes = HandlePartitioned(modifiedDocument).ReplaceOne(x => x.Id == modifiedDocument.Id, modifiedDocument);
return updateRes.ModifiedCount == 1;
}
#endregion Update
#region Update TKey
///
/// Asynchronously Updates a document.
///
/// The type representing a Document.
/// The type of the primary key for a Document.
/// The document with the modifications you want to persist.
public async Task UpdateOneAsync(TDocument modifiedDocument)
where TDocument : IDocument
where TKey : IEquatable
{
var filter = Builders.Filter.Eq("Id", modifiedDocument.Id);
var updateRes = await HandlePartitioned