Ling.EntityFrameworkCore.Audit 1.1.0

.NET 6.0

dotnet add package Ling.EntityFrameworkCore.Audit --version 1.1.0

NuGet\Install-Package Ling.EntityFrameworkCore.Audit -Version 1.1.0

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="Ling.EntityFrameworkCore.Audit" Version="1.1.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add Ling.EntityFrameworkCore.Audit --version 1.1.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Ling.EntityFrameworkCore.Audit, 1.1.0"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

// Install Ling.EntityFrameworkCore.Audit as a Cake Addin
#addin nuget:?package=Ling.EntityFrameworkCore.Audit&version=1.1.0

// Install Ling.EntityFrameworkCore.Audit as a Cake Tool
#tool nuget:?package=Ling.EntityFrameworkCore.Audit&version=1.1.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Introduction

Ling.EntityFrameworkCore.Audit is an extension library that can automatically record entity changes of Microsoft.EntityFrameworkCore.

Installation

Package Manager

PM> Install-Package Ling.Audit
PM> Install-Package Ling.EntityFrameworkCore.Audit

.NET CLI

dotnet add package Ling.Audit
dotnet add package Ling.EntityFrameworkCore.Audit

Usage

Add UseAudit() in your DbContext service registration code.

// in Program.cs
builder.Services.Addxxx<xxDbContext>(
    connectionString,
    optionsAction: options => options.UseAudit());

// in Startup.cs
services.Addxxx<xxDbContext>(
    connectionString,
    optionsAction: options => options.UseAudit());

Configure audit entity by attribute or fluent api

Use AuditIncludeAttribute to enable auditing for entity, all properties in entity will record changes by default. Use AuditIgnoreAttribute on property to disable property auditing.

[AuditInclude]
public class Post
{
    public int Id { get; set; }
    public string Title { get; set; } = null!;
    [AuditIgnore]
    public DateTimeOffset CreationTime { get; set; } = null!;
}

You can also use fluent api in OnModelCreating

builder.Entity<Post>(b =>
{
    b.IsAuditable();
    b.Property(e => e.CreationTime).IsAuditable(false);
});

Confuguration

A switch to enable/disable auditing globally.

AppContext.SetSwitch(AuditDefaults.DisabledSwitchKey, false); // disable
AppContext.SetSwitch(AuditDefaults.DisabledSwitchKey, true); // enable

note: you may want to disable auditing when applying seed data.

Configure audit record table names.

AuditDefaults.EntityChangeAuditLogTableName = "AuditEntityLog"; // for entity
AuditDefaults.EntityFieldChangeAuditLogTableName = "AuditFieldLog"; // for entity's field

warn: change table names needs to create a new migration.

Product	Compatible and additional computed target framework versions.
.NET	net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed.

Product

.NET