DelegateDecompiler.EntityFramework 0.34.0

dotnet add package DelegateDecompiler.EntityFramework --version 0.34.0                
NuGet\Install-Package DelegateDecompiler.EntityFramework -Version 0.34.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="DelegateDecompiler.EntityFramework" Version="0.34.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add DelegateDecompiler.EntityFramework --version 0.34.0                
#r "nuget: DelegateDecompiler.EntityFramework, 0.34.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 DelegateDecompiler.EntityFramework as a Cake Addin
#addin nuget:?package=DelegateDecompiler.EntityFramework&version=0.34.0

// Install DelegateDecompiler.EntityFramework as a Cake Tool
#tool nuget:?package=DelegateDecompiler.EntityFramework&version=0.34.0                

DelegateDecompiler

https://ci.appveyor.com/project/hazzik/delegatedecompiler/branch/main https://nuget.org/packages/DelegateDecompiler

A library that is able to decompile a delegate or a method body to their lambda representation

Sponsorship

If you like the library please consider supporting my work.

Examples

Using computed properties in linq.

Asume we have a class with a computed property

class Employee
{
    [Computed]
    public string FullName => FirstName + " " + LastName;
    public string LastName { get; set; }
    public string FirstName { get; set; }
}

And you are going to query employees by their full names

var employees = (from employee in db.Employees
                 where employee.FullName == "Test User"
                 select employee).Decompile().ToList();

When you call .Decompile method it decompiles your computed properties to their underlying representation and the query will become simmilar to the following query

var employees = (from employee in db.Employees
                 where (employee.FirstName + " " + employee.LastName)  == "Test User"
                 select employee).ToList();

If your class doesn't have a [Computed] attribute, you can use the .Computed() extension method..

var employees = (from employee in db.Employees
                 where employee.FullName.Computed() == "Test User"
                 select employee).ToList();

Also, you can call methods that return a single item (Any, Count, First, Single, etc) as well as other methods in identical way like this:

bool exists = db.Employees.Decompile().Any(employee => employee.FullName == "Test User");

Again, the FullName property will be decompiled:

bool exists = db.Employees.Any(employee => (employee.FirstName + " " + employee.LastName) == "Test User");

Limitations

Not every compiled code can be represented as a lambda expression. Some cases are explicitly not supported, other can break and produce unexpected results.

Some of the known cases listed below

Loops

Loops often cannot be represented as an expression tree.

So, the following imperative code would probably throw a StackOverflowException:

var total = 0;
foreach (var item in this.Items) { total += item.TotalPrice; }
return total;

Instead, write it as a declarative Linq expression, which would be supported.

return this.Items.Sum(i => i.TotalPrice);

Recursion and self-referencing

Recursion and self-referencing of computed properties cannot be represented as an Expression tree, and would probably throw StackOverflowException similarly to loops.

Using with EntityFramework and other ORMs

If you are using ORM specific features, like EF's Include, AsNoTracking or NH's Fetch then Decompile method should be called after all ORM specific methods, otherwise it may not work. Ideally use Decompile extension method just before materialization methods such as ToList, ToArray, First, FirstOrDefault, Count, Any, and etc.

Async Support with EntityFramework 6

The DelegateDecompiler.EntityFramework package provides DecompileAsync extension method which adds support for EF's Async operations.

Async Support with EntityFramework Core 5.0 and later

The DelegateDecompiler.EntityFrameworkCore5 package provides DecompileAsync extension method which adds support for EF's Async operations.

Automatic decompilation

You can configure DelegateDecompiler to automatically decompile all EF Core queries:

public class YourDbContext : DbContext
{
    protected override void OnConfiguring(DbContextOptionsBuilder options) {
        options.AddDelegateDecompiler();
        // Other configuration
    }
}

With this approach you would not need to call Decompile or DecompileAsync methods on queries.

Installation

Available on NuGet

License

MIT license - http://opensource.org/licenses/mit

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  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. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
.NET Framework net45 is compatible.  net451 was computed.  net452 was computed.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (9)

Showing the top 5 NuGet packages that depend on DelegateDecompiler.EntityFramework:

Package Downloads
AutoMapper.EF6

Extensions to make AutoMapper easier to work with Entity Framework. Project to collections and items, decompiling calculated properties along the way

iRely.Common

iRely.Common

TouchConvert.Tenant.Api.V1.Dtos

Data transfer objects for TouchConvert version one APIs.

TouchConvert.Tenant.Api.V2.Dtos

Data transfer objects for TouchConvert version two APIs.

GenericServices

Generic Services is a .NET class library to help build a service layer, i.e. a layer that acts as a facard/adapter between your data layers containing an Entity Framework database and your User Interface or HTTP service.

GitHub repositories (3)

Showing the top 3 popular GitHub repositories that depend on DelegateDecompiler.EntityFramework:

Repository Stars
whywhy898/DDit-Rapid-Development-Framework
帮助企业快速开发的.net项目框架 Help companies develop the.net project framework
JonPSmith/GenericServices
GenericServices helps with building a service/application layer in a .NET based application using EF6.x
AutoMapper/AutoMapper.EF6
Extensions for AutoMapper and EF6
Version Downloads Last updated
0.34.0 2,055 5/27/2024
0.33.1 2,027 5/3/2024
0.33.0 64 5/3/2024
0.32.0 239,958 10/20/2022
0.31.0 1,716 10/17/2022
0.30.0 147,164 12/14/2021
0.29.1 88,680 2/4/2021
0.29.0 993 2/4/2021
0.28.3 10,434 1/9/2021
0.28.2 14,260 11/12/2020
0.28.1 967 11/12/2020
0.28.0 698,022 10/31/2019
0.27.0 41,925 9/30/2019
0.26.1 1,394 9/30/2019
0.25.0 212,170 1/2/2019
0.24.0 443,586 4/28/2018
0.23.0 923,283 3/13/2017
0.22.0 38,524 1/10/2017
0.21.0 6,542 12/25/2016
0.20.0 451,836 10/5/2016
0.19.0 10,025 9/7/2016
0.18.1 1,223,095 1/4/2016
0.18.0 13,034 12/29/2015
0.17.0 159,501 7/30/2015
0.16.0 51,405 5/25/2015
0.15.1 3,406 4/16/2015
0.15.0 4,269 1/14/2015
0.14.1 1,801 1/13/2015
0.13.1 1,699 1/12/2015
0.13.0 12,607 12/14/2014
0.12.1 2,016 12/12/2014