Type Alias ShardQueryFunction<Item, EntityToken, M, HashKey, RangeKey, T>

ShardQueryFunction<Item, EntityToken, M, HashKey, RangeKey, T>: ((hashKey: string, pageKey?: Partial<Pick<Item, PropertiesOfType<Item, T[keyof T]>>>, pageSize?: number) => Promise<ShardQueryResult<Item, EntityToken, M, HashKey, RangeKey, T>>)

A query function that returns a single page of results from an individual shard. This function will typically be composed dynamically to express a specific query index & logic. The arguments to this function will be provided by the EntityManager.query method, which assembles many returned pages queried across multiple shards into a single query result.

Type Parameters

Item extends ItemMap<M, HashKey, RangeKey>[EntityToken]
The ItemMap type being queried.
EntityToken extends keyof Exactify<M> & string
M extends EntityMap
HashKey extends string = "hashKey"
RangeKey extends string = "rangeKey"
T extends TranscodeMap = DefaultTranscodeMap
The TranscodeMap identifying property types that can be indexed. Defaults to DefaultTranscodeMap.

Type declaration

- (hashKey, pageKey?, pageSize?): Promise<ShardQueryResult<Item, EntityToken, M, HashKey, RangeKey, T>>
- Parameters
  - hashKey: string
    The this.config.hashKey property value of the shard being queried.
  - OptionalpageKey: Partial<Pick<Item, PropertiesOfType<Item, T[keyof T]>>>
    The page key returned by the previous query on this shard.
  - OptionalpageSize: number
    The maximum number of items to return from this query.
  Returns Promise<ShardQueryResult<Item, EntityToken, M, HashKey, RangeKey, T>>

Type Alias ShardQueryFunction<Item, EntityToken, M, HashKey, RangeKey, T>

Type Parameters

Type declaration

Parameters

Returns Promise<ShardQueryResult<Item, EntityToken, M, HashKey, RangeKey, T>>

Settings