QueryObject Class
addon/query/query-object.js:9
Object that passes as query parameter to DS.Store methods for reading data.
Constructor
QueryObject
-
modelName
-
id
-
projectionName
-
predicate
-
order
-
top
-
skip
-
count
-
expand
-
select
-
primaryKeyName
-
extend
-
customQueryParams
-
dataType
Parameters:
-
modelName
StringThe model name of the requested entities.
-
id
String | NumberThe id of the requested entity.
-
projectionName
StringThe name of used projection for reading the requested entities.
-
predicate
BasePredicateThe predicate that contains filtering conditions for requested entities.
-
order
OrderByClauseOrdering conditions for requested entities.
-
top
NumberThe number of items in the queried collection to be included in the result.
-
skip
NumberThe number of items in the queried collection that are to be skipped and not included in the result.
-
count
BooleanFlag indicates to request a count of the matching entities included with the entities in the response.
-
expand
ObjectSpecifies the related entities to be included in line with retrieved entities.
-
select
ObjectA specific set of properties for each requested entity.
-
primaryKeyName
ObjectThe name of primary key field for specified model name in modelName property.
-
extend
ObjectAn additional computed set of properties for each requested entity. Based on properties in predicate and order, but not included in select and expand.
-
customQueryParams
ObjectAn additional query parameters.
-
dataType
StringA data type for the request. Supported types: 'json' and 'blob'.