Entity Framework 6
Structr.EntityFramework package provides methods to easily implement auto-auditing in Entity Framework DbContext
, ModelBuilder
extensions which applies the entity type default configuration and IQueryable<T>
extensions to paginate through a list of entities.
Installation
EntityFramework package is available on NuGet.
Usage
EntityFramework package have a reference to Structr.Domain package that provides some abstract classes for entities, value objects and interfaces which are intended to help to implement Domain Model.
Auto-auditing
Auto-auditing - it's entity change auditing for Entity Framework entities. The basic way to add auditing is to override the SaveChanges()
method of the DbContext
and plug in some logic for filling and tracking auditable properties (e.g. DateCreated
or CreatedBy
) automatically.
For example, create some entity that inherits Entity<TEntity,TKey>
class and ICreatable
interface.
Create your own DbContext
class implementation with configure some auditing dependencies (e.g. ITimestampProvider
) and override SaveChanges()
methods.
Now if you add a new instance of Issue
to DbSet<Issue>
and call SaveChanges()
or SaveChangesAsync()
method, the DateCreated
property will be filled in automatically.
Auto-configure entity types
Create your own DbContext
class implementation and override OnModelCreating()
method with calling ApplyEntityConfiguration()
, ApplyValueObjectConfiguration()
and/or ApplyAuditableConfiguration()
methods.
ModelBuilder
extension methods list:
Method name | Description |
---|---|
ApplyEntityConfiguration | Applies the default configuration for all classes inherited from the |
ApplyValueObjectConfiguration | Applies the default configuration for all classes inherited from the |
ApplyAuditableConfiguration | Applies the default configuration for all classes that implement the |
You can configure options when applying entity types default configurations. For example, configure PK column name for all domain entities:
EntityConfigurationOptions
properties:
Property name | Property type | Description |
---|---|---|
Configure |
| Delegate for configuring Entities. Default value is |
Configure name strategy for all properties of value objects:
ValueObjectConfigurationOptions
properties:
Property name | Property type | Description |
---|---|---|
Configure |
| Delegate for configuring Value Objects. Default value is |
Configure signed properties for auditable entities:
AuditableConfigurationOptions
properties:
Property name | Property type | Description |
---|---|---|
SignedColumnMaxLength |
| Defines the maximum size of a signed column ( |
SignedColumnIsRequired |
| Defines if a signed column ( |
SoftDeletableFilterName |
| Defines the name of soft deletable filter. Default value is |
Pagination
Use .ToPagedList()
and .ToPagedListAsync()
extension methods for IQueryable<T>
to paginate result of entities query:
If you call ToPagedList()
method with pageSize
parameter equals -1
that returns all entities from DbContext
without limitation.
Last updated