OData.Query

Members

---

<inner> When we prepare to {word} entity {word}

Description

Prepares internal structure to perform the specified operation on the target entity

Parameters

Name	Type	Description
operation	word	name of the CRUD operation, currently supported: 'read'
entity	word	target entity

Examples

When we prepare to read entity Books

---

<inner> When we prepare to {word} this {word}

Description

Prepares internal structure to perform the specified operation on the previously mentioned entity

Parameters

Name	Type	Description
operation	word	name of the CRUD operation, currently supported: 'read'
_	word	placeholder for increased readability

Examples

When we prepare to read this Book

---

<inner> When field {word} equals {int}

Description

Extends the current query speficying a WHERE clause requiring the specified field to be equal to the specified value

Parameters

Name	Type	Description
field	word	name of the field to check
value	int	name of the integer vlaue perform the equation operator with

Examples

And field Count equals 100

---

<inner> When select its {word}

Description

MArks the specified field as requested in the current query

Parameters

Name	Type	Description
field	word	name of the field to include in the result

Examples

And select its Title

---

<inner> When select the count of records

Description

Requests the current query to return the count of selected records

Examples

And select the count of records

---

<inner> When aggregate {word} using {}

Description

Specifies the current query should perform aggregation operation using the specified function

Parameters

Name	Type	Description
field	word	name of hte target field to perform the operation on
func		name of the function to use when performing the aggregation

Examples

And aggregate Price using max

---

<inner> When aggregate {word} into {word} using {}

Description

Specifies the current query should perform aggregation operation using the specified function and provides an alias for the resulting value

Parameters

Name	Type	Description
field	word	name of the field to use while performing the aggregation
alias	word	name of the alias
func		name of the function to use when performing the aggregation

Examples

And aggregate Price into Total using sum

---

<inner> When order by {word}

Description

Requires the current query to order the result using the specified field

Parameters

Name	Type	Description
field	word	name of the field to use while ordering the records

Examples

And order by Price

---

<inner> When order descending by {word}

Description

Requires the current query to order the result in descending order using the specified field

Parameters

Name	Type	Description
field	word	name of the field to use while ordering the records

Examples

And order descending by Price

---

<inner> When expand field {word} by selecting its {word}

Description

Requires the current query to expand the specified association and return the requested field being part of the associated entity

Parameters

Name	Type	Description
associationName	word	name of the association to expand
field	word	name of the field of the associated record to return

Examples

And expand field Name by selecting its author

---

<inner> When expand field {word}

Description

Requires the current query to expand the specified association

Parameters

Name	Type	Description
associationName	word	name of the association to expand

Examples

And expand field author

---

<inner> When group by {word}

Description

Requires the current query to group the result by the specified field

Parameters

Name	Type	Description
field	word	name of the field to group by

Examples

And group by category

---

<inner> When limit to {int} records

Description

Requires the current query to limit the count of records returned as a result of the operation

Parameters

Name	Type	Description
limit	int	requested number of records

Examples

And limit to 5 records

---

<inner> When skip first {int} records

Description

Requires the current query to skip the first N records returned as a result of the operation

Parameters

Name	Type	Description
offset	int	cound of records to skip

Examples

And skip first 5 records

---

<inner> When do perform the {word}

Description

Performs the already prepared query

Parameters

Name	Type	Description
operation	word	name of the operation that should be the same as the one used in the already prepared query

Examples

And do perform the read