Interface QueryResult<Item, EntityToken, M, HashKey, RangeKey>

A result returned by a query across multiple shards, where each shard may receive multiple page queries via a dynamically-generated ShardQueryFunction.

interface QueryResult<Item, EntityToken, M, HashKey, RangeKey> {
    count: number;
    items: Item[];
    pageKeyMap: string;
}

Type Parameters

Properties

count: number

Total number of records returned across all shards.

items: Item[]

The returned records.

pageKeyMap: string

A compressed, two-layer map of page keys, used to query the next page of data for a given sort key on each shard of a given hash key.