FlexQuery.NET.EntityFrameworkCore 4.0.0-rc.2

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher.
This is a prerelease version of FlexQuery.NET.EntityFrameworkCore.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package FlexQuery.NET.EntityFrameworkCore --version 4.0.0-rc.2
                    


                    

                
NuGet\Install-Package FlexQuery.NET.EntityFrameworkCore -Version 4.0.0-rc.2
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="FlexQuery.NET.EntityFrameworkCore" Version="4.0.0-rc.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="FlexQuery.NET.EntityFrameworkCore" Version="4.0.0-rc.2" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="FlexQuery.NET.EntityFrameworkCore" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add FlexQuery.NET.EntityFrameworkCore --version 4.0.0-rc.2
                    


                    

                
#r "nuget: FlexQuery.NET.EntityFrameworkCore, 4.0.0-rc.2"
#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. 
#:package FlexQuery.NET.EntityFrameworkCore@4.0.0-rc.2
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=FlexQuery.NET.EntityFrameworkCore&version=4.0.0-rc.2&prerelease
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=FlexQuery.NET.EntityFrameworkCore&version=4.0.0-rc.2&prerelease
                    


                            Install as a Cake Tool

FlexQuery.NET.EntityFrameworkCore

NuGet Version

Async execution, filtered includes, and typed DTO projection for EF Core.

When to Use This Package

Install this package when your data access layer uses Entity Framework Core's DbContext. It enables the FlexQueryAsync extension methods that execute the full query pipeline — parse, validate, filter, sort, page, project — in a single async call against your DbSet<T>.

Installation

dotnet add package FlexQuery.NET.EntityFrameworkCore

Registration

Call once at startup, before any query executes:

using FlexQuery.NET.EntityFrameworkCore;

FlexQueryEFCore.Setup();   // registers EF Core-specific operators

// Optional: global EF Core defaults (immutable after the first call)
FlexQueryEFCore.Configure(options =>
{
    options.UseNoTracking = true;
});

Quick Start

using FlexQuery.NET.Models;

[HttpGet("users")]
public async Task<IActionResult> GetUsers(
    [FromQuery] FlexQueryParameters parameters,
    CancellationToken cancellationToken)
{
    var result = await _context.Users.FlexQueryAsync(parameters, options =>
    {
        options.AllowedFields = new HashSet<string> { "Id", "Name", "Email", "Status" };
        options.StrictFieldValidation = true;
    }, cancellationToken: cancellationToken);

    return Ok(result);
}

Features

  • FlexQueryAsync — Unified parse-validate-execute pipeline with configurable EfCoreQueryOptions
  • Typed DTO Projection — FlexQueryAsync<TEntity, TResponse> returns strongly-typed results, with convention-based mapping (CreateMap, ForMember, ForNavigation)
  • Includes - Translate the QueryOptions.Includes relationship tree into EF Core Include/ThenInclude chains, each optionally filtered by an inline Where clause, via ApplyIncludes<T>()
  • Projection — Nested, Flat, and FlatMixed projection modes
  • Execution Options — UseNoTracking for read-only queries (enabled by default)
  • SQL Preview — ToSqlPreview() to inspect the generated SQL without executing
  • Diagnostics — Pass an IFlexQueryExecutionListener via the options to observe pipeline stages
  • EF Core Operators — UseEfCoreOperators() to register the LIKE operator handler for EF Core translation

Documentation

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 is compatible.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.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
4.0.0 123 9/23/2026
4.0.0-rc.3 57 9/22/2026
4.0.0-rc.2 71 9/17/2026
4.0.0-rc.1 63 9/10/2026
4.0.0-preview.3 78 7/18/2026
4.0.0-preview.2 72 7/14/2026
4.0.0-preview.1 77 7/12/2026
4.0.0-beta1.0 68 9/8/2026
3.1.1 1,167 7/4/2026
3.1.0 154 6/26/2026
3.0.6 152 6/24/2026
3.0.5 157 6/24/2026
3.0.4 151 6/23/2026
3.0.3 154 6/23/2026
3.0.2 159 6/22/2026
3.0.1 158 6/22/2026

- docs(changelog): add the v4.0.0 release notes
- docs(readme): describe include relationship query blocks
- feat(samples): demo include relationship blocks in the sample playground
- chore(docs-v4): publish the legacy VitePress v3 site under /v3
- docs(v4-site): rewrite the expand guide as include relationship query blocks
- test(providers): align EF Core and Dapper suites with include blocks
- docs(openapi): document include relationship blocks
- refactor(dapper): generate include-block SQL from the unified include tree
- refactor(efcore): build include chains from the unified include tree
- refactor(parsers): parse include relationship blocks in FQL and reject expand
- refactor(core): unify relationship inclusion under the include tree