Show:

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 String

    The model name of the requested entities.

  • id String | Number

    The id of the requested entity.

  • projectionName String

    The name of used projection for reading the requested entities.

  • predicate BasePredicate

    The predicate that contains filtering conditions for requested entities.

  • order OrderByClause

    Ordering conditions for requested entities.

  • top Number

    The number of items in the queried collection to be included in the result.

  • skip Number

    The number of items in the queried collection that are to be skipped and not included in the result.

  • count Boolean

    Flag indicates to request a count of the matching entities included with the entities in the response.

  • expand Object

    Specifies the related entities to be included in line with retrieved entities.

  • select Object

    A specific set of properties for each requested entity.

  • primaryKeyName Object

    The name of primary key field for specified model name in modelName property.

  • extend Object

    An additional computed set of properties for each requested entity. Based on properties in predicate and order, but not included in select and expand.

  • customQueryParams Object

    An additional query parameters.

  • dataType String

    A data type for the request. Supported types: 'json' and 'blob'.

Item Index