Class: QueryFactory

QueryFactory(requestFactorynon-null)

A factory for creating `Query` instances specifying the data to be retrieved from Spine server.

Constructor

new QueryFactory(requestFactorynon-null)

Parameters:
Name Type Description
requestFactory ActorRequestFactory
Source:
See:
  • ActorRequestFactory#query()

Methods

compose(forTargetnon-null, fieldMasknullable, limit) → {Query}

Creates a new `Query` which would return only entities which conform the target specification. An optional field mask can be provided to specify particular fields to be returned for `Query`
Parameters:
Name Type Attributes Description
forTarget Target a specification of type and filters for `Query` result to match
fieldMask FieldMask <nullable>
 a specification of fields to be returned by executing `Query`
limit number max number of entities to fetch
Source:
Returns:
Type
Query

select(entitynon-null) → {QueryBuilder}

Creates a new builder of `Query` instances of the provided type.
Parameters:
Name Type Description
entity Class.<Message> a Protobuf type of the query target entities
Source:
Returns:
Type
QueryBuilder