AuditaX.Dapper 2.4.0

AuditaX.Dapper

Dapper ORM support for AuditaX audit logging library.

Installation

dotnet add package AuditaX
dotnet add package AuditaX.Dapper
dotnet add package AuditaX.SqlServer   # or AuditaX.PostgreSql

Features

• IAuditUnitOfWork interface for repository-level audit logging
• Automatic change detection via reflection
• Works with any DapperContext that has a CreateConnection() method
• Manual control over when audit logs are created

Configuration

appsettings.json

{
  "AuditaX": {
    "TableName": "AuditLog",
    "Schema": "dbo",
    "LogFormat": "Json",
    "AutoCreateTable": true,
    "EnableLogging": true,
    "Entities": {
      "Product": {
        "SourceName": "Product",
        "Key": "ProductId",
        "Properties": [ "Name", "Price", "Stock" ]
      }
    }
  }
}

Service Registration

services.AddAuditaX(configuration)
    .UseDapper<DapperContext>()
    .UseSqlServer()  // or .UsePostgreSql()
    .ValidateOnStartup();

Usage

Inject IAuditUnitOfWork into your repositories:

using AuditaX.Dapper.Interfaces;

public class ProductRepository(DapperContext context, IAuditUnitOfWork audit) : IProductRepository
{
    public async Task<int> CreateAsync(Product product)
    {
        using var connection = context.CreateConnection();
        // ... insert logic ...

        await audit.LogCreateAsync(product);
        return id;
    }

    public async Task<int> UpdateAsync(Product original, Product updated)
    {
        using var connection = context.CreateConnection();
        // ... update logic ...

        if (affected > 0)
        {
            await audit.LogUpdateAsync(original, updated);
        }
        return affected;
    }

    public async Task<bool> DeleteAsync(Product product)
    {
        using var connection = context.CreateConnection();
        // ... delete logic ...

        if (affected > 0)
        {
            await audit.LogDeleteAsync(product);
        }
        return affected > 0;
    }
}

IAuditUnitOfWork Methods

How Change Detection Works

1. LogUpdateAsync receives original and modified entities
2. Uses reflection to compare configured AuditableProperties
3. Uses IChangeLogService.HasChanged() to detect differences
4. Only logs changes when values actually differ
5. Serializes changes to JSON or XML based on configuration

DapperContext Requirements

Your DapperContext must have a public CreateConnection() method:

public class DapperContext(IConfiguration configuration)
{
    private readonly string _connectionString = configuration.GetConnectionString("DefaultConnection")!;

    public IDbConnection CreateConnection() => new SqlConnection(_connectionString);
}

Comparison with Entity Framework

Documentation

For complete documentation, see the main AuditaX repository.

• Dapper + SQL Server + JSON
• Dapper + SQL Server + XML
• Dapper + PostgreSQL + JSON
• Dapper + PostgreSQL + XML