RsqlParserNet.EntityFrameworkCore 1.0.3

RsqlParserNet.EntityFrameworkCore

EF Core async paging helpers that count, page, and materialize an already-composed IQueryable<T> into a framework-neutral RsqlPagedResult<T> with items and pagination metadata.

Part of the RsqlParserNet family. It builds on RsqlParserNet.Linq (allowlisted filtering, sorting, and the pagination models) and complements RsqlParserNet.AspNetCore, which owns request-string binding. This package only removes repeated endpoint code for asynchronous counting, paging, and materialization; it does not replace explicit allowlisted profiles.

Installation

dotnet add package RsqlParserNet.EntityFrameworkCore

Requires Microsoft.EntityFrameworkCore 10.0.0 (targets net10.0).

Quick start

Compose filtering and sorting through your allowlisted RsqlParserNet.Linq profile, then page and materialize asynchronously:

using RsqlParserNet;
using RsqlParserNet.Linq;
using RsqlParserNet.EntityFrameworkCore;

var query = db.Products
    .ApplyRsql("status==active", ProductRsqlProfile.Instance)
    .ApplySort(RsqlSortRequest.Parse("-createdAt"), ProductRsqlProfile.Instance);

var result = await query.ToRsqlPageAsync(
    new RsqlPageRequest(page: 1, pageSize: 25),
    cancellationToken);

result is an RsqlPagedResult<Product>:

{
  "items": [],
  "pagination": {
    "page": 1,
    "pageSize": 25,
    "totalItems": 42,
    "totalPages": 2,
    "hasPreviousPage": false,
    "hasNextPage": true
  }
}

Overloads can also apply the query and sort for you in one call:

var parsed = RsqlParser.Parse("status==active");

var result = await db.Products.ToRsqlPageAsync(
    parsed,
    RsqlSortRequest.Parse("-createdAt"),
    ProductRsqlProfile.Instance,
    new RsqlPageRequest(page: 1, pageSize: 25),
    cancellationToken);

DateTimeOffset literals are normalized to UTC by the LINQ adapter before constants are built, which keeps EF Core/Npgsql comparisons compatible with PostgreSQL timestamp with time zone parameters.

Helpers

All helpers are extension methods on IQueryable<T> in RsqlEntityFrameworkQueryableExtensions and return Task<RsqlPagedResult<T>>.

The string-expression overloads throw on invalid syntax. For API endpoints, prefer parsing with RsqlParser.TryParse or RsqlQueryFilter first so syntax diagnostics can be returned as validation errors.

Documentation

• EF Core helpers: docs/entity-framework-core.md
• Main repository: RsqlParserNet