Class QueryBuilder<C>

constructor

• new QueryBuilder<C>(options): QueryBuilder<C>

• BaseQueryBuilder constructor.

  Type Parameters

  • C extends BaseConfigMap

  Parameters

  • options: BaseQueryBuilderOptions<C, EntityClient<C>>

  Returns QueryBuilder<C>

ReadonlyentityClient

ReadonlyentityToken

ReadonlyhashKeyToken

Optional ReadonlypageKeyMap

addFilterCondition

• addFilterCondition(indexToken, condition): this

• Adds a filter condition to a ShardQueryMap index. See the FilterCondition type for more info.

  Parameters

  • indexToken: string

    The index token.
  • condition: FilterCondition<C>

    The FilterCondition object.

  Returns this

  • The modified ShardQueryMap instance.

addRangeKeyCondition

• addRangeKeyCondition(indexToken, condition): this

• Adds a range key condition to a ShardQueryMap index. See the RangeKeyCondition type for more info.

  Parameters

  • indexToken: string

    The index token.
  • condition: RangeKeyCondition

    The RangeKeyCondition object.

  Returns this

  • The modified ShardQueryMap instance.

build

• build(): ShardQueryMap<C>

• Builds a ShardQueryMap object.

  Returns ShardQueryMap<C>

  • The ShardQueryMap object.

getShardQueryFunction

• getShardQueryFunction(indexToken): ShardQueryFunction<C>

• Parameters

  • indexToken: string

  Returns ShardQueryFunction<C>

query

• query(options): Promise<QueryResult<C>>

• Parameters

  • options: QueryBuilderQueryOptions<C>

  Returns Promise<QueryResult<C>>