AuditaX.SqlServer 1.0.2

AuditaX.SqlServer

SQL Server database provider for AuditaX audit logging library.

Installation

dotnet add package AuditaX
dotnet add package AuditaX.SqlServer
dotnet add package AuditaX.Dapper             # OR AuditaX.EntityFramework

Features

• SQL Server-specific SQL query generation
• Support for NVARCHAR(MAX) for change log storage
• DATETIME2 for timestamps
• IDENTITY columns for auto-increment
• Compatible with SQL Server 2016+

Configuration

Service Registration

services.AddAuditaX(configuration)
    .UseDapper<DapperContext>()       // OR .UseEntityFramework<AppDbContext>()
    .UseSqlServer()                   // Add SQL Server provider
    .ValidateOnStartup();

Connection String

{
  "ConnectionStrings": {
    "DefaultConnection": "Data Source=localhost;Initial Catalog=MyDatabase;User ID=sa;Password=YourPassword;TrustServerCertificate=True"
  }
}

Recommended Configuration for SQL Server

{
  "AuditaX": {
    "TableName": "AuditLog",
    "Schema": "dbo",
    "LogFormat": "Json",
    "AutoCreateTable": true,
    "EnableLogging": true
  }
}

Generated Table Schema

CREATE TABLE [dbo].[AuditLog] (
    [LogId] UNIQUEIDENTIFIER NOT NULL DEFAULT NEWSEQUENTIALID(),
    [SourceName] NVARCHAR(50) NOT NULL,
    [SourceKey] NVARCHAR(900) NOT NULL,
    [AuditLog] NVARCHAR(MAX) NOT NULL,  -- Use XML type for XML format
    CONSTRAINT [PK_AuditLog] PRIMARY KEY CLUSTERED ([LogId]),
    CONSTRAINT [UQ_AuditLog_Source] UNIQUE ([SourceName], [SourceKey])
);

CREATE INDEX IX_AuditLog_SourceName ON [dbo].[AuditLog] ([SourceName]) INCLUDE ([SourceKey]);
CREATE INDEX IX_AuditLog_SourceKey ON [dbo].[AuditLog] ([SourceKey]) INCLUDE ([SourceName]);

Querying Audit Logs

Basic Query

SELECT * FROM AuditLog
WHERE SourceName = 'Product';

Query JSON Changes

SELECT
    LogId,
    SourceName,
    SourceKey,
    JSON_VALUE(e.value, '$.action') AS EntryAction,
    JSON_VALUE(e.value, '$.user') AS EntryUser,
    JSON_VALUE(e.value, '$.timestamp') AS EntryTimestamp,
    JSON_VALUE(f.value, '$.name') AS FieldName,
    JSON_VALUE(f.value, '$.before') AS OldValue,
    JSON_VALUE(f.value, '$.after') AS NewValue
FROM AuditLog
CROSS APPLY OPENJSON(AuditLog, '$.auditLog') AS e
CROSS APPLY OPENJSON(e.value, '$.fields') AS f
WHERE JSON_VALUE(e.value, '$.action') = 'Updated';

Query XML Changes

SELECT
    LogId,
    SourceName,
    SourceKey,
    e.value('@Action', 'NVARCHAR(16)') AS EntryAction,
    e.value('@User', 'NVARCHAR(128)') AS EntryUser,
    e.value('@Timestamp', 'NVARCHAR(50)') AS EntryTimestamp,
    f.value('@Name', 'NVARCHAR(128)') AS FieldName,
    f.value('@Before', 'NVARCHAR(MAX)') AS OldValue,
    f.value('@After', 'NVARCHAR(MAX)') AS NewValue
FROM AuditLog
CROSS APPLY AuditLog.nodes('/AuditLog/Entry') AS t(e)
CROSS APPLY e.nodes('Field') AS u(f)
WHERE e.value('@Action', 'NVARCHAR(16)') = 'Updated';

DapperContext for SQL Server

using System.Data;
using Microsoft.Data.SqlClient;

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

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

Requirements

• SQL Server 2016 or later
• Microsoft.Data.SqlClient package (included as dependency)

Documentation

For complete documentation, see the main AuditaX repository.

• Dapper + SQL Server + JSON
• Dapper + SQL Server + XML
• EF Core + SQL Server + JSON
• EF Core + SQL Server + XML