Nervestaple.EntityFrameworkCore

This project provides library code to make it easier to code up repositories backed by databases using Microsoft's EntityFrameworkCore library. It's available on NuGet.org, you can follow the directions on that page to add it to your project.

• Nervestaple.EntityFrameworkCore NuGet Package

All of the code needed to handle the icky stuff has already been coded up, all you need to do is write up the "entity" class and extend the provided repositories. You may use the fluent API if you prefer but these examples use annotations.

public class ToDoItem : Entity<long>
{
    public override long? Id { get; set; }
    
    public long? ToDoContextId { get; set; }
    
    [ForeignKey("ToDoContextId")]
    public ToDoContext ToDoContext { get; set; }
    
    ...
}

In this example we extent the provided Entity class and specify the unique identifier column type (long) and then code up the properties, including an example relationship. We also have the concept of an EditModel, this is in place to support situations where you have an entity with many fields but not all of them are editable (i.e. collection properties).

public class ToDoItemEdit : EditModel<ToDoItem, long>
{
    /// <summary>
    /// Unique ID of the instance
    /// </summary>
    public long? Id { get; set; }
    
    /// <summary>
    /// The unique ID of this instance's context
    /// </summary>
    public long? ToDoContextId { get; set; }
    ...
}

You may also code up Criteria and Parameter classes to get searching of entity fields by string, date range, numeric range, etc.

With that out of the way, we can code up our repository. In real-life you'd probably have an interface for your repository as well.

public class ToDoItemRepository : ToDoReadWriteRepository<ToDoItem, long>, IToDoItemRepository
{
    public ToDoItemRepository(ToDoDbContext context) : base(context)
    {
        
    }
}

We extend the provided repository and fill in our context. You get the CRUD methods for free! We have a larger (and runnable) example you can look at to get a better idea how things work for real.

Documentation

This project uses Doxygen for documentation. Doxygen will collect inline comments from your code, along with any accompanying README files, and create a documentation website for the project. If you do not have Doxygen installed, you can download it from their website and place it on your path. To run Doxygen...

$ cd src
$ doxygen

The documentation will be written to the doc/html folder, you can read this documentation with your web browser.

Other Notes

Project Icon made by Freepik from Flaticon under the Creative Commons license.

---