A lightweight OData v4 $filter / $orderby / $expand / $select / $top / $skip / $count engine for .NET. No Microsoft.AspNetCore.OData, no EDM model, no MVC formatter — just parses the query string and composes IQueryable<T> transformations you can hand to EF Core or any LINQ provider.
Status:
0.1.0. Parser + expression builder + cache + ASP.NET Core integration shipped. 248 tests, 0 build warnings. Public API may still shift before1.0.0— pin the patch version if you depend on it now.
Microsoft.AspNetCore.OData is ~9 MB of EDM model, MVC formatters, routers, and serializers — overkill when all you want is "accept $filter=... against my IQueryable<T>." OdataQueryLite gives you that without the rest:
- Pure
System.Linq.Expressions, AOT-compatible (<IsAotCompatible>true</IsAotCompatible>). - Provider-agnostic — the engine never enumerates. Hand the result to EF Core, an in-memory list, or any custom
IQueryable<T>provider. - Async-friendly without an EF-Core sub-package: the engine returns
IQueryable, youawait x.LongCountAsync()(or syncLongCount()) on your side.
| Package | Targets | Use when |
|---|---|---|
OdataQueryLite | pure net10.0, no ASP.NET Core dependency | parsing query strings outside a web host (CLI tools, batch jobs, tests) — or you bring your own host glue |
OdataQueryLite.AspNetCore | net10.0, FrameworkReference Microsoft.AspNetCore.App | MVC model binder + Minimal-API parameter wrapper + error-mapping middleware in one line of startup |
// Program.cs — Minimal API + MVC, same setup.varbuilder=WebApplication.CreateBuilder(args);builder.Services.AddControllers().AddOdataQueryLite();// MVC binder (skip this for pure Minimal-API hosts)builder.Services.AddOdataQueryLite();// cache + infrastructurevarapp=builder.Build();app.UseOdataQueryLite();// maps OdataQueryException -> HTTP 400app.MapControllers();// Minimal API: take OdataQueryRequest<T> as a parameter.app.MapGet("/items",async(OdataQueryRequest<Item>q,AppDbContextdb)=>{varresult=q.Options.Apply(db.Items);returnResults.Ok(new{total=q.Options.Count?awaitresult.Unpaged.LongCountAsync():(long?)null,// result.Data is IQueryable — element type is Item when no $select/$expand is// requested, otherwise Dictionary<string, object?>. Cast<object>() lets the JSON// serializer pick up the runtime element type either way.data=awaitresult.Data.Cast<object>().ToListAsync(),});});app.Run();MVC controller version:
[ApiController][Route("api/[controller]")]publicclassItemsController(AppDbContextdb):ControllerBase{[HttpGet]publicasyncTask<IActionResult>Get(OdataQueryOptions<Item>q){varresult=q.Apply(db.Items);returnOk(new{total=q.Count?awaitresult.Unpaged.LongCountAsync():(long?)null,data=awaitresult.Data.Cast<object>().ToListAsync(),});}}Malformed $filter, $apply, negative $top, duplicate $-options, etc. throw OdataQueryException from the binder/BindAsync; the middleware turns them into 400 with { Error, Message, Option } JSON. Controllers see q.Apply(...) succeed or never run.
usingOdataQueryLite;varopts=newOdataQueryOptions<Item>(newOdataQueryParts{Filter="Price gt 25 and Name eq 'Apple'",OrderBy="Price desc",Top=10,Count=true,});varresult=opts.Apply(items.AsQueryable());longtotal=result.Unpaged.LongCount();// No $select/$expand here, so Data's runtime element type is Item.List<Item>page=result.Data.Cast<Item>().ToList();| OData query option | Status |
|---|---|
$filter — eq / ne / gt / ge / lt / le / and / or / not | ✅ parsed + applied |
$filter — contains / startswith / endswith | ✅ |
$filter — string / date / math functions (tolower, year, round, …) | ✅ |
$filter — lambdas Items/any(o: o/Status eq 'X'), Items/all(...) | ✅ |
$filter — collection count Items/$count gt 0 | ✅ |
$orderby — multi-key, desc, nested paths, collection /$count | ✅ |
$expand — nested, slash chains, inner $select/$expand | ✅ parsed + applied (Dictionary<string, object?> projection) |
$select — flat names, nested paths | ✅ parsed + applied (honors [JsonIgnore] from Newtonsoft / STJ + [OdataIgnore]) |
$top / $skip / $count | ✅ applied ($count exposes Unpaged for caller to materialize) |
$apply | ❌ — UnsupportedQueryOptionException at construction |
services.AddOdataQueryLite(opts =>{opts.UseCache=true;// default: process-wide compiled-query cacheopts.MaxCacheEntries=10_000;// default; bump for high-cardinality filter surfaces});Cache is keyed on (entityType, normalized-shape, parameter-types) — ?$filter=Id eq 1 and ?$filter=Id eq 2 share a compiled Func<T, bool>; the literal 1 / 2 flows through a ValueTuple<> rather than re-baked into the expression tree.
- Lexer + filter / orderby / expand / select parsers + AST
- Parameterized literals + shape-based caching
PropertyAccessVisitor+AllowedExpandNode(whitelist + subsumption)FilterExpressionBuilder(AST →Expression<Func<T, bool>>)TypeCoercion(enum / nullable / DateTimeOffset /Edm.Binary)- Compiled-delegate cache (
QueryCompileCache, LRU-style soft cap) OdataQueryOptions<T>orchestrator +OrderByApplier- ASP.NET Core integration package (MVC
IModelBinder, Minimal-APIOdataQueryRequest<T>, error-mapping middleware, idempotentAddOdataQueryLite()split per ASP.NET Core convention) IQueryablereturn-shape redesign (QueryResult.Unpageddeferred enumeration → no EF-Core sub-package needed)$select/$expandprojection applied to the returnedIQueryable(SelectExpandProjector— emitsDictionary<string, object?>projection, EF Core translates to flatSELECT col1, col2; honors[JsonIgnore]from bothNewtonsoft.JsonandSystem.Text.Json.Serializationplus its own[OdataIgnore])
The library is annotated for the trimmer (<IsAotCompatible>true</IsAotCompatible>). Public entry points (OdataQueryOptions<T> ctor, AddOdataQueryLite()) carry [RequiresUnreferencedCode] + [RequiresDynamicCode] because filter expressions are compiled at runtime against T's reflected properties. Hosts targeting Native AOT should mark their [DynamicallyAccessedMembers(PublicProperties)] on the entity types they expose.
Extracted from an internal HCS Platform module that was replacing Microsoft.AspNetCore.OData for performance + dependency-surface reasons. Open-sourced to broaden the review surface and let the wider .NET ecosystem use the parser independently of the original host.
MIT — see LICENSE.