Class EntityQuery

Namespace

Arbiter.CommandQuery.Queries

Assembly

Arbiter.CommandQuery.dll

Represents a query for selecting entities with filtering, sorting, and pagination capabilities.

public class EntityQuery : EntitySelect

Inheritance

object

EntitySelect

EntityQuery

Inherited Members

EntitySelect.Query

EntitySelect.Sort

EntitySelect.Filter

object.Equals(object)

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Examples

The following example demonstrates how to use the EntityQuery class:

var filter = new EntityFilter
{
    Name = "Status",
    Operator = "eq",
    Value = "Active"
};

var sort = new EntitySort
{
    Name = "Name",
    Direction = "asc"
};

var query = new EntityQuery(filter, sort, page: 1, pageSize: 20);
Console.WriteLine($"Page: {query.Page}, PageSize: {query.PageSize}");

Remarks

This class is typically used to define the criteria for querying entities, including filters, sorting, and pagination options.

Constructors

EntityQuery()

Initializes a new instance of the EntityQuery class with default pagination settings.

[JsonConstructor]
public EntityQuery()

EntityQuery(EntityFilter?, EntitySort?, int, int)

Initializes a new instance of the EntityQuery class with a filter, a single sort expression, and pagination settings.

public EntityQuery(EntityFilter? filter, EntitySort? sort, int page = 1, int pageSize = 20)

Parameters

filter EntityFilter

The filter to apply to the query.

sort EntitySort

The sort expression for the query.

page int

The page number for the query. The default page is 1.

pageSize int

The size of the page for the query. The default page size is 20.

EntityQuery(EntityFilter?, IEnumerable<EntitySort>?, int, int)

Initializes a new instance of the EntityQuery class with a filter, multiple sort expressions, and pagination settings.

public EntityQuery(EntityFilter? filter, IEnumerable<EntitySort>? sort, int page = 1, int pageSize = 20)

Parameters

filter EntityFilter

The filter to apply to the query.

sort IEnumerable<EntitySort>

The list of sort expressions for the query.

page int

The page number for the query. The default page is 1.

pageSize int

The size of the page for the query. The default page size is 20.

EntityQuery(EntityFilter?, int, int)

Initializes a new instance of the EntityQuery class with a filter and pagination settings.

public EntityQuery(EntityFilter? filter, int page = 1, int pageSize = 20)

Parameters

filter EntityFilter

The filter to apply to the query.

page int

The page number for the query. The default page is 1.

pageSize int

The size of the page for the query. The default page size is 20.

EntityQuery(string?, int, int, string?)

Initializes a new instance of the EntityQuery class with a raw query expression and pagination settings.

public EntityQuery(string? query, int page, int pageSize, string? sort)

Parameters

query string

The raw query expression.

page int

The page number for the query.

pageSize int

The size of the page for the query.

sort string

The sort expression for the query.

Properties

Page

Gets or sets the page number for the query.

[JsonPropertyName("page")]
public int Page { get; set; }

Property Value

int

The page number for the query. The default value is 1.

PageSize

Gets or sets the size of the page for the query.

[JsonPropertyName("pageSize")]
public int PageSize { get; set; }

Property Value

int

The size of the page for the query. The default value is 20.

Methods

GetHashCode()

Computes the hash code for the current EntityQuery instance.

public override int GetHashCode()

Returns

int

A hash code for the current EntityQuery instance.