DynamicQueryable.Extensions 2.0.0

🚀 DynamicQueryable

DynamicQueryable is a lightweight, extensible .NET 8 library that enables dynamic filtering, sorting, pagination, and projection for IQueryable.

It supports multiple query formats (Generic, JSON, Syncfusion, Laravel Spatie) and is designed to integrate seamlessly with Entity Framework Core or any LINQ provider.

• ✅ Dynamic filtering (OData-lite style)
• ✅ Sorting (multi-field)
• ✅ Pagination (skip/take)
• ✅ Projection (select with nested properties)
• ✅ Include support (nested property projection)
• ✅ Query parameter parser
  • Generic format
  • JSON format
  • Syncfusion
  • Laravel Spatie
• ✅ Fully testable and extensible

📦 Installation

dotnet add package DynamicQueryable.Extensions

⚡ Quick Start

1. Parse Query Options

Use the QueryOptionsParser to convert your query string parameters into a QueryOptions object.

using DynamicQueryable.Parsers;

// In a controller or minimal API:
var options = QueryOptionsParser.Parse(Request.Query);

2. Apply to IQueryable

Use the extension methods provided in DynamicQueryable.Extensions.

using DynamicQueryable.Extensions;

[HttpGet]
public async Task<IActionResult> Get()
{
    var options = QueryOptionsParser.Parse(Request.Query);
    
    // Simple usage (returns paged data)
    var users = await _context.Users
        .ApplyQueryOptions(options)
        .ToListAsync();

    // Or use ToQueryResult for metadata (TotalCount, Page, etc.)
    var result = _context.Users.ToQueryResult(options);
    
    return Ok(result);
}

🔍 Query Examples

✅ Filtering

?filter[0].field=Name
&filter[0].operator=contains
&filter[0].value=john

✅ Sorting

?sort[0].field=Age
&sort[0].desc=true

✅ Pagination

?page=1&pageSize=10

✅ Projection

?select=Id,Name,Email

✅ Nested Projection

?select=Id,Name,Profile.Name,Orders.Total

✅ Include + Select

?include=Profile,Orders
&select=Id,Name,Profile.Name,Orders.Total

🔧 Supported Operators

🔍 Operator Examples

Basic

?filter[0].field=Name
&filter[0].operator=eq
&filter[0].value=John

Contains

?filter[0].field=Name
&filter[0].operator=contains
&filter[0].value=jo

Range

?filter[0].field=Age
&filter[0].operator=gte
&filter[0].value=18
&filter[1].field=Age
&filter[1].operator=lte
&filter[1].value=60

IN

?filter[0].field=Status
&filter[0].operator=in
&filter[0].value=Active,Pending

NULL

?filter[0].field=DeletedAt
&filter[0].operator=isnull
&filter[0].value=true

🔄 Supported Query Formats

🔹 Generic

?filter[0].field=Name
&filter[0].operator=contains
&filter[0].value=john

🔹 JSON

?filter={
  "logic":"and",
  "filters":[
    {"field":"Name","operator":"contains","value":"john"}
  ]
}

🔹 Syncfusion

?where[0][field]=Name
&where[0][operator]=contains
&where[0][value]=john
&sorted[0][name]=Age
&sorted[0][direction]=descending
&skip=0
&take=10

🔹 Laravel Spatie

?filter[name]=john
&filter[age]=25
&sort=-created_at
&include=roles,permissions
&fields[users]=name,email

🧩 Projection System

Supports:

• Root fields
• Nested objects
• Collections

Example:

?select=Id,Name,Profile.Name,Orders.Total

⚙️ Usage Details

Manual Construction

You can also build QueryOptions manually in code:

var options = new QueryOptions
{
    Filter = new FilterGroup
    {
        Filters = [new FilterCondition { Field = "Age", Operator = "gt", Value = "18" }]
    },
    Sort = [new SortOption { Field = "Name", Descending = false }],
    Paging = new PagingOptions { Page = 1, PageSize = 10 }
};

var query = _context.Users.ApplyQueryOptions(options);

🔌 ASP.NET Core Integration

Since the parser is static, you can easily wrap it in a custom ModelBinder or just call it directly in your base controller.

public abstract class BaseController : ControllerBase
{
    protected QueryOptions QueryOptions => QueryOptionsParser.Parse(Request.Query);
}

🧪 Testing

Run tests:

dotnet test

Includes:

• Filtering
• Sorting
• Paging
• Projection
• Parser

🧱 Architecture

DynamicQueryable.Extensions
│
├── Models      (FilterCondition, SortOption, etc.)
├── Builders    (ExpressionBuilder, ProjectionBuilder)
├── Extensions  (QueryableExtensions)
├── Helpers     (SelectTreeBuilder)
└── Parsers     (QueryOptionsParser)

🔗 Integration with BaseRepository

public async Task<QueryResult<T>> GetPagedAsync(QueryOptions options)
{
    return _dbSet.AsQueryable().ToQueryResult(options);
}

🚀 Roadmap

• Redis caching implementation
• Expression caching (performance)
• Field-level authorization
• GraphQL-style query support

🤝 Contributing

Contributions, issues, and feature requests are welcome.

📄 License

MIT License