Luizanac.QueryExtensions 1.1.1

Luizanac.QueryExtensions

Simple and clean LINQ extensions library for .NET that adds sorting, filtering, and pagination functionality to EntityFramework.

You can start just by adding "Luizanac.QueryExtensions". But if you only want EFCore dependencies in projects that access databases, you can use "Luizanac.QueryExtensions.Abstractions" on other projects and everything will be fine 😃 😃

Luizanac.QueryExtensions

Install-Package Luizanac.QueryExtensions

OR

dotnet add package Luizanac.QueryExtensions

Luizanac.QueryExtensions.Abstractions

Install-Package Luizanac.QueryExtensions.Abstractions

OR

dotnet add package Luizanac.QueryExtensions.Abstractions

Examples

All following examples consider a Client class.

public class Client
{
    public Guid Id {get; private set; }
    public string Name { get; private set; }
    public string Email { get; private set; }
    public int Age { get; private set; }
}

OrderBy

To use OrderBy extension, you will need to pass "property, asc/desc" (You can use first level navigation properties to "address.number, asc/desc", this will access Address property on Client and then Number on Address).

var sort = "age,asc";
var clients = await dbContext.Clients.AsNoTracking().OrderBy(sort).ToListAsync();
//this example will return all cleints classified by their ascending age

var sort = "name,desc";
var clients = await dbContext.Clients.AsNoTracking().OrderBy(sort).ToListAsync();
//this example will return all cleints classified by their descending name

Paginate

To use paginate extension, you only need to pass the page and then your page size

var paginatedData = await dbContext.Clients.AsNoTracking().Paginate(1, 3);
//This will return a IPagination<IList<Client>> and in Data property you can access your list of objects.
var clients = paginatedData.Data;

Here you can see IPagination properties 😃

public interface IPagination<T>
{
    /// <summary>
    /// The paginated data
    /// </summary>    
    T Data { get; set; }

    /// <summary>
    /// The total pages
    /// </summary>
    int TotalPages { get; set; }

    /// <summary>
    /// The total data count
    /// </summary>
    int TotalDataCount { get; set; }

    /// <summary>
    /// The current page number
    /// </summary>
    int CurrentPage { get; set; }

    /// <summary>
    /// The number of datas to get
    /// </summary>
    int Size { get; set; }

    /// <summary>
    ///  The previous page number
    /// </summary>
    int PrevPage { get; set; }

    /// <summary>
    /// The next page number
    /// </summary>
    int NextPage { get; set; }
}

Filter by properties

To use filter extension, you will need to pass a string "{property}{operator}{data}" with your conditions separated by commas (Like order by extension, you can use first level navigation properties too).

below you can see all supported operators

and here you can see an using example

var filters = "age>=16,email@=hotmail.com,name_=h";
var clients = await dbContext.Clients.AsNoTracking().Filter(filters).ToListAsync();
//This will filter all clients by age greather than or equal to 16, email contains hotmail.com and name starts with h.

you can use "|" to make OR. "{property}|{property}{operator}{data}" or "{property}{operator}{data}|{data}"

var sort = "age,asc";
var filters = "age>=16,email@=hotmail.com|gmail.com,name|email_=luiz";
var clients = await dbContext.Clients.AsNoTracking().Filter(filters).OrderBy(sort).ToListAsync();
//This will filter all clients by age greather than or equal to 16, email contains hotmail.com and name starts with h.

The previous code will generate this SQL

SELECT [c].[Id], [c].[Age], [c].[Email], [c].[Name]
    FROM [Clients] AS [c]
        WHERE 
            (([c].[Age] >= 16) AND 
            (([c].[Email] LIKE '%hotmail.com%') OR ([c].[Email] LIKE '%gmail.com%'))) AND 
            (([c].[Name] LIKE 'luiz%') OR ([c].[Email] LIKE 'luiz%'))
ORDER BY [c].[Age]

you can use all extensions together

var sort = "age,asc";
var filters = "age>=16,email@=hotmail.com,name_=h";
var paginatedData = await dbContext.Clients.AsNoTracking()
            .Filter(filters)
            .OrderBy(sort)
            .Paginate(1, 3);

Patch notes

• 1.1.0 - Added the capability to use logical operator OR ( | ) and code improvements.

License

Luizanac.QueryExtensions is licensed under Apache 2.0.