Mindfire.EFRepository 2.0.0-alpha

EFRepository

Use a LINQ-Enabled version of the Repository Pattern for Entity Framework

Interface

/// <summary>
/// Interface for interacting with data storage through the repository pattern
/// </summary>
/// <typeparam name="TEntity"></typeparam>
public interface IRepository<TEntity> : IDisposable where TEntity : class, new()
{
	/// <summary>Queriable Entity</summary>
	IQueryable<TEntity> Entity { get; }

	/// <summary>
	/// Find an entity based on key(s)
	/// </summary>
	/// <param name="keys">The key(s) for the table</param>
	/// <returns>Entity if found, otherwise null</returns>
	TEntity FindOne(params object[] keys);

	/// <summary>
	/// Add or update entities
	/// </summary>
	/// <param name="values">Entities to add</param>
	void AddOrUpdate(params TEntity[] values);

	/// <summary>
	/// Add or update entities
	/// </summary>
	/// <param name="collection">Entities to add</param>
	void AddOrUpdate(IEnumerable<TEntity> collection);

	/// <summary>
	/// Delete a single entity by key(s)
	/// </summary>
	/// <param name="keys">The key(s) for the table</param>
	void DeleteOne(params object[] keys);

	/// <summary>
	/// Delete one or more entities
	/// </summary>
	/// <param name="values">Entities to delete</param>
	void Delete(params TEntity[] values);

	/// <summary>
	/// Delete one or more entities
	/// </summary>
	/// <param name="collection">Entities to delete</param>
	void Delete(IEnumerable<TEntity> collection);

	/// <summary>
	/// Save pending changes for the collection
	/// </summary>
	/// <returns>Number of affected entities</returns>
	int Save();

	/// <summary>
	/// Save pending changes for the collection async
	/// </summary>
	/// <returns>Number of affected entities</returns>
	Task<int> SaveAsync();

	/// <summary>
	/// Save pending changes for the collection async with cancellation
	/// </summary>
	/// <param name="cancellationToken">Cancelation Token</param>
	/// <returns>Number of affected entities</returns>
	Task<int> SaveAsync(CancellationToken cancellationToken);

	/// <summary>Event that fires when an item is added</summary>
	event Action<TEntity> ItemAdded;

	/// <summary>Event that fires when an itemis modified</summary>
	event Action<TEntity> ItemModified;

	/// <summary>Event that fires when an item is deleted</summary>
	event Action<TEntity> ItemDeleted;