a!query() Function

Creates a Query object for use in the a!queryEntity() function.

Syntax

a!query( selection, aggregation, logicalExpression, filter, pagingInfo )

  • selection (Selection): (Optional) A list of fields that you wish to retrieve, created with a!querySelection().
  • aggregation (Aggregation): (Optional) A list of fields and the operations you wish to perform on them when retrieving the data, created with a!queryAggregation().
  • logicalExpression (LogicalExpression): (Optional) A set of conditions to apply to the queried data before any grouping or aggregation, created with a!queryLogicalExpression().
  • filter (QueryFilter): (Optional) A single condition to apply to the queried data before any grouping or aggregation, created with a!queryFilter().
  • pagingInfo (PagingInfo): The paging and sorting configurations to apply when retrieving the data, created with a!pagingInfo().

Returns

Query

Notes

  • You may specify either the selection parameter or the aggregation parameter but not both. If you do not specify either parameter, all fields are returned.

  • You may specify either the logicalExpression parameter or the filter parameter but not both. If you wish to specify only one condition, use filter. If you wish to specify more than one condition, use logicalExpression.

  • The pagingInfo parameter is required.

See Also

Aggregation: the aggregation data type defines the grouping and aggregation configuration to be applied when querying data.

logicalexpression: the logicalexpression data type defines the filtering configuration to be applied when querying data.

paginginfo: the paginginfo data type defines the paging and sorting configuration to be applied when querying data.

query: the query data type defines the grouping, aggregation, filtering, paging, and sorting configuration to be applied when querying data.

queryfilter: the queryfilter data type defines the filtering configuration to be applied when querying data.

Selection: The Selection data type defines a set of column selection configurations to be applied when querying data.

Open in Github Built: Thu, Feb 23, 2023 (02:59:22 PM)

On This Page

FEEDBACK