Muslim.GenericRepository.Interface 10.0.1

Muslim.GenericRepository.Interface

The repository interfaces only: IRepository<TEntity> and the interfaces it is built from — reads, writes, soft delete, bulk operations, counts, raw SQL and save. No EF Core implementation.

dotnet add package Muslim.GenericRepository.Interface

Use this package in projects that should depend on the contract only, such as a Domain or Application project. For a working repository, install Muslim.GenericRepository instead — it brings this package with it.

Quick start

In the Application project, declare the repository and use it:

using Muslim.GenericRepository.Interface;

public interface IProductRepository : IRepository<Product> { }

public class ProductService(IProductRepository products)
{
    public Task<List<Product>> GetCheapAsync()
        => products.FindAsync(x => x.Price < 10, isTracking: false);

    public async Task RenameAsync(int id, string name)
    {
        var product = await products.GetByIdAsync(id);
        product.Name = name;
        await products.SaveUpdateAsync(product);
    }
}

In the Data project, which references Muslim.GenericRepository, supply the class:

using Muslim.GenericRepository.Repositories;

internal class ProductRepository : Repository<Product>, IProductRepository { }

The Application project never sees EF Core.

Namespaces

IRepository<T> and the interfaces it is built from are in different namespaces. Import both:

using Muslim.GenericRepository.Interface;  // IRepository<T>
using Muslim.IGenericRepository;           // ICreate<T>, IFind<T>, IDelete<T>, ...

What IRepository includes

IRepository<TEntity> works with any TEntity that inherits Entity from Muslim.EntityAndDto.

Query and QueryAsNoTracking give you the IQueryable for anything else.

Rules every implementation follows

• Create adds the change, SaveCreate adds it and saves. The same goes for update, delete and soft delete. Use the first form when several changes must be saved together.
• The implementation fills the audit columns: CreatedBy and CreatedDate on insert, UpdateBy and UpdateDate on update, IsDeleted, DeletedBy and DeletedDate on soft delete. All dates are UTC.
• Reads that return entities take isTracking, true by default. Reads that return a DTO are never tracked.
• Bulk methods (*WhereAsync, *ByIdsAsync) run one SQL statement and need no Save(). They do not load rows, so the change tracker never sees them.

Every member has XML documentation with an example, so your IDE shows it on hover.

Related packages

License

See LICENSE.txt.