• Directly access items from a table by primary key or a secondary index by delegating to DocumentClient.query.

    Example

    df.query('movies', { actor: 'Tom Hanks', movie: 'Toy Story' })
    

    Returns

    The same response returned by query().promise()

    Parameters

    • tableName: string

      The name of the table containing the requested items

    • keyCondition: AttributeMap

      An object describing the comparisons used to generate KeyConditionExpression, ExpressionAttributeNames, and ExpressionAttributeValues

    • Optional options: Partial<FacadeQueryInput>

      The options accepted by the original query method, plus an optional filter field that generates FilterExpression

    Returns Promise<PromiseResult<QueryOutput, AWSError>>

Generated using TypeDoc