DKNet.EfCore.Abstractions 10.1.16

DKNet.EfCore.Abstractions

Persistence-technology-agnostic base classes, interfaces, and attributes shared by every DKNet EF Core package — entity identity, audit tracking, domain events, concurrency, and cross-cutting attributes for audit-log and sequence behavior. It has no dependency on Microsoft.EntityFrameworkCore itself, so domain projects can model entities without pulling in the full EF Core runtime.

Install

dotnet add package DKNet.EfCore.Abstractions

Features

• IEntity<TKey> / Entity<TKey> / Entity — entity identity base classes (Guid-keyed Entity by default)
• IEventEntity — per-entity domain event queue (AddEvent, AddEvent<TEvent>(), GetEvents, ClearEvents), implemented by Entity<TKey>
• [RaisesEvent] / EventOperations — declare events raised automatically on Created/Updated/Deleted, with optional property narrowing
• IAuditedProperties / IAuditedEntity<TKey> / AuditedEntity<TKey> / AuditedEntity — creation/modification tracking with SetCreatedBy/SetUpdatedBy
• IConcurrencyEntity<TType> — optimistic concurrency via a RowVersion token
• ISoftDeletableEntity — soft-delete contract (IsDeleted, DeletedOn, DeletedBy, Delete(...))
• [Sequence] / [SqlSequence] — database-generated sequential values for fields and enum-backed SQL sequences
• [AuditLog] / [IgnoreAuditLog] / [SensitiveDataAttribute] — audit-log opt-in and redaction markers (consumed by DKNet.EfCore.AuditLogs)
• [IgnoreEntity] — marker to exclude a class from automatic entity mapping
• IEventPublisher / DefaultEventPublisher / IEventItem / EventItem — the event-publishing contract consumed by DKNet.EfCore.Events

Quick start

using DKNet.EfCore.Abstractions.Entities;

public class Order : AuditedEntity // Guid-keyed, audit-tracked, event-capable
{
    private Order() { }

    public static Order Create(string createdBy)
    {
        var order = new Order();
        order.SetCreatedBy(createdBy);
        order.AddEvent(new OrderCreatedEvent(order.Id));
        return order;
    }

    public string Status { get; private set; } = "Pending";
}

public record OrderCreatedEvent(Guid OrderId);

Customisation reference

No options object and no DI registration — the customisation surface is the attributes and the interfaces.

[RaisesEvent] (AttributeTargets.Class, repeatable, not inherited) — three constructor forms: (Type eventType, EventOperations operations, params string[] properties), (string label, EventOperations operations, params string[] properties), and (EventOperations operations, params string[] properties).

Convention-form names are composed in a fixed order: entity name, label (when given), narrowing properties (de-duplicated, ordinal-sorted), operations in the order Created, Updated, Deleted, then the suffix Event.

[Sequence] (AttributeTargets.Field — on an enum member):

[SqlSequence] (AttributeTargets.Enum): Schema (ctor arg) — string, default "seq".

Marker attributes with no properties: [AuditLog] (class or property), [IgnoreAuditLog] (class or property), [SensitiveData] (property), [IgnoreEntity] (class).

CRUD vertical-slice markers, consumed by DKNet.SlimBus.Generators: [CrudCreate] and [CrudUpdate] each expose Name (string?, default null); [CrudAction] adds route (ctor arg, string?, default null → the kebab-cased method name) and Verb (CrudActionVerb, default Post; Post/Put/Patch, no Delete).

Full feature walkthrough, configuration defaults, and how this package composes with DKNet.EfCore.Events/Hooks/AuditLogs/DataAuthorization/Encryption/DtoGenerator: docs/EfCore/DKNet.EfCore.Abstractions.md