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:
-
modelNameStringThe model name of the requested entities.
-
idString | NumberThe id of the requested entity.
-
projectionNameStringThe name of used projection for reading the requested entities.
-
predicateBasePredicateThe predicate that contains filtering conditions for requested entities.
-
orderOrderByClauseOrdering conditions for requested entities.
-
topNumberThe number of items in the queried collection to be included in the result.
-
skipNumberThe number of items in the queried collection that are to be skipped and not included in the result.
-
countBooleanFlag indicates to request a count of the matching entities included with the entities in the response.
-
expandObjectSpecifies the related entities to be included in line with retrieved entities.
-
selectObjectA specific set of properties for each requested entity.
-
primaryKeyNameObjectThe name of primary key field for specified model name in modelName property.
-
extendObjectAn additional computed set of properties for each requested entity. Based on properties in predicate and order, but not included in select and expand.
-
customQueryParamsObjectAn additional query parameters.
-
dataTypeStringA data type for the request. Supported types: 'json' and 'blob'.
Flexberry Documentation