Protected
ConfigMap
that defines an EntityManager configuration
's EntityMap
, key properties, and TranscodeMap
. If omitted, defaults to BaseConfigMap
.
Identifies the entity to be queried. Key of Config
entities
.
Partial item object sufficiently populated to generate index hash keys.
Optional
limitThe target maximum number of records to be returned by the query across all shards.
The actual number of records returned will be a product of pageSize
and the
number of shards queried, unless limited by available records in a given
shard.
Optional
pagepageKeyMap
returned by the previous iteration of this query.
Optional
pageThe maximum number of records to be returned by each individual query to a
single shard (i.e. ShardQueryFunction
execution).
Note that, within a given query
method execution, these queries will be
repeated until either available data is exhausted or the limit
value is
reached.
Each key in this object is a valid entity index token. Each value is a valid 'ShardQueryFunction' that specifies the query of a single page of data on a single shard for the mapped index.
This allows simultaneous queries on multiple sort keys to share a single
page key, e.g. to match the same string against firstName
and lastName
properties without performing a table scan for either.
Optional
sortA SortOrder
object specifying the sort order of the result set. Defaults to []
.
Optional
throttleThe maximum number of shards to query in parallel. Overrides options throttle
.
Optional
timestampLower limit to query shard space.
Only valid if the query is constrained along the dimension used by the
EntityManager.config.entities.<entityToken>.sharding.timestamptokens.timestamp
function to generate shardKey
.
Optional
timestampUpper limit to query shard space.
Only valid if the query is constrained along the dimension used by the
EntityManager.config.entities.<entityToken>.sharding.timestamptokens.timestamp
function to generate shardKey
.
Options passed to the
EntityManager.query
method.