π Documentation: AddSignInDateColumnsToAuditTable Migration
Table of Contents
- Overview & Purpose
- Dependencies & Technologies
- Key Functional Areas
- 3.1 Migration Class Definition
- 3.2 Up Method
- 3.3 Down Method
- Schema Changes Summary
- Sample Usage & Code Snippets
- UML Class Diagram
- Conclusion
1. Overview & Purpose
π Purpose
This Entity Framework Core migration adds two new nullable DateTime columns to the existing AuditDetail table in the irby schema:
- LastSignInDateTime
- LastNonInteractiveSignInDateTime
These columns enable the application to track and audit both interactive and non-interactive user sign-in events, enhancing compliance, reporting, and security monitoring capabilities.
2. Dependencies & Technologies
| Technology / Package | Role |
|---|---|
| .NET 6+ / .NET Core | Target runtime |
| Microsoft.EntityFrameworkCore | ORM framework |
| Microsoft.EntityFrameworkCore.Migrations | Migration scaffolding & database updates |
| C# (.NET) | Programming language |
using System;
using Microsoft.EntityFrameworkCore.Migrations;
#nullable disable
Microsoft.EntityFrameworkCore.Migrations: Provides the baseMigrationclass andMigrationBuilderAPI.System: Core .NET library for primitive types (DateTimeetc.).
3. Key Functional Areas
3.1 Migration Class Definition
namespace IrbyImaging.DbContext.Migrations
{
/// <inheritdoc />
public partial class AddSignInDateColumnsToAuditTable : Migration
{
// Up() and Down() methods below...
}
}
- Namespace:
IrbyImaging.DbContext.Migrations - Class:
AddSignInDateColumnsToAuditTable - Base Class:
Migration(from EF Core)
π‘ Note: The class is marked partial to allow EF Core tooling to generate additional code if needed.
3.2 Up Method
protected override void Up(MigrationBuilder migrationBuilder)
{
migrationBuilder.AddColumn<DateTime>(
name: "LastNonInteractiveSignInDateTime",
schema: "irby",
table: "AuditDetail",
type: "datetime2",
nullable: true);
migrationBuilder.AddColumn<DateTime>(
name: "LastSignInDateTime",
schema: "irby",
table: "AuditDetail",
type: "datetime2",
nullable: true);
}
- Role: Applies schema changes when the migration is executed.
- Operations:
- Adds
LastNonInteractiveSignInDateTime - Adds
LastSignInDateTime
- Adds
nullable: true: Columns allowNULLby default so existing records are not impacted.
3.3 Down Method
protected override void Down(MigrationBuilder migrationBuilder)
{
migrationBuilder.DropColumn(
name: "LastNonInteractiveSignInDateTime",
schema: "irby",
table: "AuditDetail");
migrationBuilder.DropColumn(
name: "LastSignInDateTime",
schema: "irby",
table: "AuditDetail");
}
- Role: Rolls back (reverts) the schema changes if the migration is undone.
- Ensures the database can be cleanly returned to its original state.
4. Schema Changes Summary
| Column Name | Data Type | Nullable | Description |
|---|---|---|---|
| LastSignInDateTime | datetime2 | Yes | Timestamp of the last interactive user sign-in |
| LastNonInteractiveSignInDateTime | datetime2 | Yes | Timestamp of the last non-interactive sign-in event |
π Tip: After running the migration, update your EF Core
AuditDetailentity class:public class AuditDetail { // Existing properties... public DateTime? LastSignInDateTime { get; set; } public DateTime? LastNonInteractiveSignInDateTime { get; set; } }
5. Sample Usage & Code Snippets
Applying the Migration
# Using Package Manager Console
Add-Migration AddSignInDateColumnsToAuditTable -Context YourDbContext
Update-Database -Context YourDbContext
# Using .NET CLI
dotnet ef migrations add AddSignInDateColumnsToAuditTable --context YourDbContext
dotnet ef database update --context YourDbContext
Querying the New Columns
using (var context = new YourDbContext())
{
var auditRecord = context.AuditDetails
.FirstOrDefault(a => a.UserId == someUserId);
Console.WriteLine($"Interactive SignIn: {auditRecord.LastSignInDateTime}");
Console.WriteLine($"Non-Interactive SignIn: {auditRecord.LastNonInteractiveSignInDateTime}");
}
6. UML Class Diagram
ββββββββββββββββββββββββββββββββββββββββββββββ
β Microsoft.EntityFrameworkCore β
β .Migration β
βββββββββββββββββ²βββββββββββββββββββββββββββββ
β Inherits
βββββββββββββββββ΄βββββββββββββββββββββββββββββ
β AddSignInDateColumnsToAuditTable (partial)β
ββββββββββββββββββββββββββββββββββββββββββββββ
β + Up(migrationBuilder: MigrationBuilder) β
β + Down(migrationBuilder: MigrationBuilder)β
ββββββββββββββββββββββββββββββββββββββββββββββ
π Legend
β’+Public methods
β’ β² Inheritance arrow
7. Conclusion
π― Summary
The AddSignInDateColumnsToAuditTable migration enhances your auditing capabilities by adding two new timestamp columns. These fields help distinguish between interactive and background (non-interactive) sign-in eventsβcritical for advanced analytics, security monitoring, and compliance reporting.
π Next Steps
- Run the migration in your development and staging environments.
- Update your service logic to populate these fields during authentication flows.
- Build new reports or triggers based on the enriched audit data.
Thank you for reviewing this documentation! Feel free to integrate, extend, and customize as needed. π
Generated by Your Dev Team Documentation Assistant