Idam.Libs.EF 2.1.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package Idam.Libs.EF --version 2.1.0
NuGet\Install-Package Idam.Libs.EF -Version 2.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="Idam.Libs.EF" Version="2.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Idam.Libs.EF --version 2.1.0
#r "nuget: Idam.Libs.EF, 2.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 Idam.Libs.EF as a Cake Addin
#addin nuget:?package=Idam.Libs.EF&version=2.1.0

// Install Idam.Libs.EF as a Cake Tool
#tool nuget:?package=Idam.Libs.EF&version=2.1.0

Idam.Libs.EF

NuGet .NET

Idam.Libs.EF is .Net Core (C#) for Entity Framework (EF) Utils.

Give a Star! ⭐

If you like or are using this project please give it a star. Thanks!

Features

  • Soft delete (DeletedAt).
  • Timestamps (CreatedAt, UpdatedAt).

Both features support DateTime and Unix Time Milliseconds format.

DateTime using Utc format

Example of Unix Time Milliseconds: currentmillis

Get started

run this command to install

Install-Package Idam.Libs.EF

or

dotnet tool install Idam.Libs.EF

Usage

Using Timestamps

  1. Add AddTimestamps() in your context.

    using Idam.Libs.EF.Extensions;
    
    public class MyDbContext : DbContext
    {
        public override int SaveChanges(bool acceptAllChangesOnSuccess)
        {
            ChangeTracker.AddTimestamps();
            return base.SaveChanges(acceptAllChangesOnSuccess);
        }
    
        public override Task<int> SaveChangesAsync(bool acceptAllChangesOnSuccess, CancellationToken cancellationToken = default)
        {
            ChangeTracker.AddTimestamps();
            return base.SaveChangesAsync(acceptAllChangesOnSuccess, cancellationToken);
        }
    }
    
  2. Implement an Interface (ITimeStamps or ITimeStampsUnix) to your entity.

    using Idam.Libs.EF.Interfaces;
    
    /// Using DateTime Format
    public class Boo : ITimeStamps
    {
        public int Id { get; set; }
        public string Name { get; set; } = default!;
        public string? Description { get; set; }
        public DateTime CreatedAt { get; set; }
        public DateTime UpdatedAt { get; set; }
    }
    
    /// Using Unix Format
    public class Foo : ITimeStampsUnix
    {
        public int Id { get; set; }
        public string Name { get; set; } = default!;
        public string? Description { get; set; }
        public long CreatedAt { get; set; }
        public long UpdatedAt { get; set; }
    }
    

Using SoftDelete

  1. Add AddTimestamps() and AddSoftDeleteFilter() in your context. see below.

    using Idam.Libs.EF.Extensions;
    
    public class MyDbContext : DbContext
    {
        public override int SaveChanges(bool acceptAllChangesOnSuccess)
        {
            ChangeTracker.AddTimestamps();
            return base.SaveChanges(acceptAllChangesOnSuccess);
        }
    
        public override Task<int> SaveChangesAsync(bool acceptAllChangesOnSuccess, CancellationToken cancellationToken = default)
        {
            ChangeTracker.AddTimestamps();
            return base.SaveChangesAsync(acceptAllChangesOnSuccess, cancellationToken);
        }
    
        protected override void OnModelCreating(ModelBuilder modelBuilder)
        {
            modelBuilder.AddSoftDeleteFilter();
    
            base.OnModelCreating(modelBuilder);
        }
    }
    
  2. Implement an Interface (ISoftDelete or ISoftDeleteUnix) to your entity.

    using Idam.Libs.EF.Interfaces;
    
    /// Using DateTime Format
    public class Boo : ISoftDelete
    {
        public int Id { get; set; }
        public string Name { get; set; } = default!;
        public string? Description { get; set; }
        public DateTime? DeletedAt { get; set; }
    }
    
    /// Using Unix Format
    public class Foo : ISoftDeleteUnix
    {
        public int Id { get; set; }
        public string Name { get; set; } = default!;
        public string? Description { get; set; }
        public long? DeletedAt { get; set; }
    }
    

The SoftDelete has a restore function, so you can restore the deleted data, see below.

using Idam.Libs.EF.Extensions;

/// Your context
public class MyDbContext : DbContext
{
    public DbSet<Foo> Foos => Set<Foo>();
}

/// Foo Controller
public class FooController
{
    readonly MyDbContext context;

    public async Task<IActionResult> RestoreAsync(Foo foo)
    {
        Foo restoredFoo = context.Foos.Restore(foo);
        await context.SaveChangesAsync();
        
        return Ok(restoredFoo);
    }
}

Also, you can ignore the global softdelete filter by using IgnoreQueryFilters(). See below.

public class FooController
{
    public async Task<IActionResult> GetAllDeletedAsync()
    {
        var deletedFoos = await context.Foos
            .IgnoreQueryFilters()
            .Where(x => x.DeletedAt != null)
            .ToListAsync();

        return Ok(deletedFoos);
    }
}

You can permanently delete data that has a DeletedAt value.

Using IGuidEntity

An Interface to implement Id as Guid instead of int.

using Idam.Libs.EF.Interfaces;

public class Foo : IGuidEntity
{
    public Guid Id { get; set; }
    public string Name { get; set; } = default!;
    public string? Description { get; set; }
}

Migrating

Migrating from 2.0.1

  1. If you implements ITimeStamps and/or ISoftDelete in your entities before, update your CreatedAt and UpdatedAt to UTC datetime.

  2. Update DbContext

    Inside SaveChanges() and SaveChangesAsync()

    /// before
    ChangeTracker.Entries().AddTimestamps();
    
    /// to
    ChangeTracker.AddTimestamps();
    

    Inside OnModelCreating()

     /// before
     var entityTypes = modelBuilder.Model.GetEntityTypes();
    modelBuilder.AddSoftDeleteFilter(entityTypes);
    
    /// to
    modelBuilder.AddSoftDeleteFilter();
    
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 was computed.  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 was computed.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
7.0.0 118 9/2/2023
2.1.0 144 6/25/2023
2.0.1 112 6/7/2023
2.0.0 162 6/7/2023
1.0.1 118 6/6/2023
1.0.0 133 6/4/2023

- Use UtcNow for DateTime type
- Add Permanent Delete
- Simplify AddTimestamps() in DbContext
- fix softdelete query filter