Description
The Query class specifies a complex database query.
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|---|---|---|---|
aggregationFields |
0..* |
A list of zero or more aggregation fields |
|
aggregationFilters |
0..* |
A list of 0 or more aggregation Filters |
|
groupByFields |
string |
0..* |
An array of 'group by' field names in FQL dot notation |
limit |
0..1 |
The query limit to use |
|
outputFields |
string |
0..* |
An array of output field names in FQL dot notation |
resourceType |
0..1 |
The resource type or pseudo-resource type to query |
|
searchFilter |
0..1 |
The search filter to use |
Remarks
The database query acts on a particular type of resource or pseudo-resource, including unit transactions, unit transaction summaries, products, and product purchases. The query can optionally aggregate (e.g. produce sums, counts, minima, maxima and averages) and/or group by one or more fields. Field names are given in FQL dot notation.
The fields returned by the query will be those in the output array and those in the aggregation list. Putting a field within the 'group by' list will not cause it to appear in the output. All field names are given in FQL dot notation. In the query result, aggregated fields will appear with names such as SUM(disk.size), i.e. with the aggregation type enum value followed by the aggregated field in parenthesis.