CatConsult.PaginationHelper 2.1.1

• Pagination Helper
• Features
• Getting Started
• Quick Example
• Documentation
  • Query Parameters
  • Filters
  • Property Types
  • PaginateOptionsBuilder
  • ToPaginatedAsync
  • IPaginateResult
• Local Development

Pagination Helper

A .NET Entity Framework extension class to dynamically perform server-side data processing (paging, sorting, searching, and filtering). This extension method is built on top of EntityFramework's IQueryable type. Try it out if you're tired of duplicating server-side processing boilerplate code!

Features

• Dynamically paginate, sort, filter, and search data
• Easy to use on top of existing EF code
• Flexible: Lots of built-in options to perform general filters
• Fast: No in-memory operation, everything is translated into SQL
• Secure: Built with Dynamic LinQ, protecting against SQL Injection

Getting Started

1. Install NuGet Package:

   > dotnet add package CatConsult.PaginationHelper
   

2. Import Package:

   using CatConsult.PaginationHelper;
   

3. Use ToPaginatedAsync:

   DbContext.FooEntities.ToPaginatedAsync(paginateOptionsBuilder)
   

Quick Example

For more examples, check out the integration tests class.

ASP.Net API Project

...

// Example entity
public class FooEntity
{
    public string StrCol { get; set; }
    public string OtherCol { get; set; }
    public DateTimeOffset DateCol { get; set; }
}

...
using CatConsult.PaginationHelper;
...

// A random controller method
public async Task<IPaginateResult<FooDto>> GetPaginatedData([FromQuery] PaginateOptionsBuilder paginateOptionsBuilder)
{
    return await _db.FooEntities
        .Where(...) // Pre-filter data if needed
        .Select(...) // Recommend projecting into a DTO first, better for performance
        .ToPaginatedAsync(paginateOptionsBuilder);
}
...

Returned Data Type (IPaginateResult)

{
  data: any[]; // List of paginated data
  count: number; // Total matched records in the database
  currentPage: number;
  rowsPerPage: number;
  totalPages: number;
  previousPage: number | null; // Null if no previous page
  nextPage: number | null; // Null if no next page
}

Example HTTP Requests

HTTP GET /paginated?order=dateCol&orderDirection=desc&strCol__eq=hello

The above example request will return all rows where StrCol equals "hello", ordered by DateCol in descending order.

HTTP GET /paginated?page=1&rowsPerPage=10&strCol=filter me&dateCol__gte=2000-1-1

The above example request will return the second page, with 10 rows per page, where rows contain "filter me" in StrCol and DateCol is greater than or equal to 2000-1-1.

Documentation

Query Parameters

Filters

Built-in filter keywords provide more flexible filtering. Filter keywords can be appended to any filter key and are case-insensitive. All filter keywords start with __XX. For example, to filter for any strCol starting with "A", use strCol__start=A instead of strCol=A.

All filter keys accept multiple values.

• Range keywords (gt, gte, lt, and lte) join using && operation.
• All other keywords join using || operation.

For example, str=A&str=B&num_gte=1&num_lt=10 translates into (str == A || str == B) && (num >= 1 && num < 10).

Property Types

Filtering behavior differs based on the item property type.

• String and List types use Contains filter by default. For example, str=A translates into str contains 'A'.
• Other types use Equal filter by default. For example, number=1 translates into number equals 1.

When performing a search, all types use their default filter type.

PaginateOptionsBuilder

A helper class to build paginate options. The class can be used to bind query params in the controller.

PaginateOptionsBuilder builder = new PaginateOptionsBuilder();

// To add new keys
builder
    .Add("orderBy", "date")
    .Add("orderDirection", "desc")
    .Add("strCol", "A", "B", "C")

// To exclude some columns from search or filter
builder.ExcludeColumns("strCol", "fooCol")

// To only include defined columns for search or filter
builder.IncludeColumns("strCol", "fooCol")

// Override default filters by type
builder.OverrideDefaultFilterType(FilterPropertyType.String, FilterPropertyType.StartWith);

ToPaginatedAsync

Extension method of IQueryable<T>. Returns IPaginateResult<T>.

// First parameter takes PaginateOptionsBuilder
// Optional second parameter to transform IQueryable after applying filter, paginate, and sort
DbContext.Entities.ToPaginated(paginateOptionsBuilder, paginatedQuery => paginatedQuery.Where(c => c.FooBool))

IPaginateResult

public interface IPaginateResult<T>
{
    IEnumerable<T> Data { get; set; } // Paginated and filtered item list
    int Count { get; set; } // Total matched records in the database
    int CurrentPage { get; set; }
    int RowsPerPage { get; set; }
    int TotalPages { get; }
    int? PreviousPage { get; }
    int? NextPage { get; }
}

Local Development

Prerequisites

• Windows or macOS
• .NET >6
• Docker Desktop
• Editor/IDE that supports C#

Running the Tests

Use the dotnet test command in the project directory. The tests will run against a real PostgreSQL database using Docker Fixture.