https://github.com/rajguptah/stellarpageable
The StellarPageable library is a C# library designed to simplify data pagination and filtering for applications leveraging Entity Framework Core. It provides a reusable, generic solution for implementing paginated and filtered queryable objects.
https://github.com/rajguptah/stellarpageable
efcore entity-framework-core pageable pagination stellarpageable
Last synced: 3 months ago
JSON representation
The StellarPageable library is a C# library designed to simplify data pagination and filtering for applications leveraging Entity Framework Core. It provides a reusable, generic solution for implementing paginated and filtered queryable objects.
- Host: GitHub
- URL: https://github.com/rajguptah/stellarpageable
- Owner: rajguptaH
- Created: 2025-01-25T12:14:28.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-01-25T19:58:57.000Z (5 months ago)
- Last Synced: 2025-03-08T23:04:21.361Z (3 months ago)
- Topics: efcore, entity-framework-core, pageable, pagination, stellarpageable
- Language: C#
- Homepage:
- Size: 46.9 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# StellarPageable
**StellarPageable** is a lightweight C# library designed to simplify filtering, ordering, and paginating data from an `IQueryable` source. This library is ideal for use with Entity Framework Core and provides an efficient way to handle paginated API responses.
---
## Features
- **Dynamic Filtering**: Apply multiple filters with simple syntax.
- **Dynamic Ordering**: Easily sort data by any property.
- **Pagination**: Effortlessly paginate large datasets with customizable page size and number.
- **Asynchronous Execution**: Optimized for scalability with async methods.
- **Error Handling**: Descriptive error messages for invalid inputs.
---
## Installation
1. Clone or download the repository.
2. Add the project reference to your solution.
3. Alternatively, you can compile it into a DLL and include it in your project.
_Note: NuGet package support coming soon!_
---
## Usage
### 1. Basic Setup
Add the following model classes to your project if they are not already included:
```csharp
public class PaginatedRequest
{
public int PageNumber { get; set; } = 1;
public int PageSize { get; set; } = 10;
public string? Filter { get; set; } // Example: "Name eq 'John'; Age gt 25"
public string? OrderBy { get; set; } // Example: "Name desc"
}
public class PaginatedResponse
{
public List Data { get; set; }
public int TotalRecords { get; set; }
public int TotalPages { get; set; }
public int PageNumber { get; set; }
public int PageSize { get; set; }
}
```
### 2. Queryable Extension
Use the extension method to retrieve paginated data from your `IQueryable` source:
```csharp
var paginatedResult = await dbContext.YourEntity
.GetPaginatedAsync(new PaginatedRequest
{
PageNumber = 1,
PageSize = 10,
OrderBy = "Name desc",
Filter = "Age gt 30; Name eq 'John'"
});
```
### 3. Response
The `GetPaginatedAsync` method will return a `PaginatedResponse` with the following fields:
- **Data**: The list of items for the current page.
- **TotalRecords**: Total number of records in the dataset.
- **TotalPages**: Total number of pages available.
- **PageNumber**: Current page number.
- **PageSize**: Number of items per page.
---
## Example Usage
Here's a simple example to integrate **StellarPageable** with an API endpoint:
```csharp
[HttpGet]
public async Task GetUsers([FromQuery] PaginatedRequest request)
{
var paginatedUsers = await _dbContext.Users.GetPaginatedAsync(request);
return Ok(paginatedUsers);
}
```
---
## Roadmap
- NuGet package support.
- Support for Dapper and other ORMs.
- Additional filtering options for advanced scenarios.
---
## Contact
For questions or feedback, feel free to reach out:
- **Email**: [[email protected]](mailto:[email protected])
- **Instagram**: [@raj__rr](https://instagram.com/raj__rr)
---
## License
This project is licensed under the MIT License. See the `LICENSE` file for details.