iter_query `async` ¶

iter_query(
    table_name: TableArn,
    *,
    config_overrides: Optional[AsyncDynamoDBClientConfig] = None,
    index_name: Optional[IndexName] = None,
    select: Optional[Select] = None,
    attributes_to_get: Optional[AttributeNameList] = None,
    limit: Optional[PositiveIntegerObject] = None,
    consistent_read: Optional[ConsistentRead] = None,
    key_conditions: Optional[KeyConditions] = None,
    query_filter: Optional[FilterConditionMap] = None,
    conditional_operator: Optional[ConditionalOperator] = None,
    scan_index_forward: Optional[BooleanObject] = None,
    exclusive_start_key: Optional[Key] = None,
    return_consumed_capacity: Optional[ReturnConsumedCapacity] = None,
    projection_expression: Optional[ProjectionExpression] = None,
    filter_expression: Optional[ConditionExpression] = None,
    key_condition_expression: Optional[KeyExpression] = None,
    expression_attribute_names: Optional[ExpressionAttributeNameMap] = None,
    expression_attribute_values: Optional[ExpressionAttributeValueMap] = None,
) -> AsyncIterator[AttributeMap]

Source code in docs_src/capo_dynamodb/_services/async_dynamo_db.py

async def iter_query(
    self,
    table_name: "capo_dynamodb.types.table_arn.TableArn",
    *,
    config_overrides: Optional[AsyncDynamoDBClientConfig] = None,
    index_name: Optional["capo_dynamodb.types.index_name.IndexName"] = None,
    select: Optional["capo_dynamodb.types.select.Select"] = None,
    attributes_to_get: Optional[
        "capo_dynamodb.types.attribute_name_list.AttributeNameList"
    ] = None,
    limit: Optional[
        "capo_dynamodb.types.positive_integer_object.PositiveIntegerObject"
    ] = None,
    consistent_read: Optional[
        "capo_dynamodb.types.consistent_read.ConsistentRead"
    ] = None,
    key_conditions: Optional[
        "capo_dynamodb.types.key_conditions.KeyConditions"
    ] = None,
    query_filter: Optional[
        "capo_dynamodb.types.filter_condition_map.FilterConditionMap"
    ] = None,
    conditional_operator: Optional[
        "capo_dynamodb.types.conditional_operator.ConditionalOperator"
    ] = None,
    scan_index_forward: Optional[
        "capo_dynamodb.types.boolean_object.BooleanObject"
    ] = None,
    exclusive_start_key: Optional["capo_dynamodb.types.key.Key"] = None,
    return_consumed_capacity: Optional[
        "capo_dynamodb.types.return_consumed_capacity.ReturnConsumedCapacity"
    ] = None,
    projection_expression: Optional[
        "capo_dynamodb.types.projection_expression.ProjectionExpression"
    ] = None,
    filter_expression: Optional[
        "capo_dynamodb.types.condition_expression.ConditionExpression"
    ] = None,
    key_condition_expression: Optional[
        "capo_dynamodb.types.key_expression.KeyExpression"
    ] = None,
    expression_attribute_names: Optional[
        "capo_dynamodb.types.expression_attribute_name_map.ExpressionAttributeNameMap"
    ] = None,
    expression_attribute_values: Optional[
        "capo_dynamodb.types.expression_attribute_value_map.ExpressionAttributeValueMap"
    ] = None,
) -> "AsyncIterator[capo_dynamodb.types.attribute_map.AttributeMap]":
    _token = exclusive_start_key
    while True:
        _response = await self.query(
            table_name,
            config_overrides=config_overrides,
            index_name=index_name,
            select=select,
            attributes_to_get=attributes_to_get,
            limit=limit,
            consistent_read=consistent_read,
            key_conditions=key_conditions,
            query_filter=query_filter,
            conditional_operator=conditional_operator,
            scan_index_forward=scan_index_forward,
            exclusive_start_key=_token,
            return_consumed_capacity=return_consumed_capacity,
            projection_expression=projection_expression,
            filter_expression=filter_expression,
            key_condition_expression=key_condition_expression,
            expression_attribute_names=expression_attribute_names,
            expression_attribute_values=expression_attribute_values,
        )
        _page = _resolve_path(_response, ("items",))
        for _item in _page or []:
            yield _item
        _token = _resolve_path(_response, ("last_evaluated_key",))
        if not _token:
            break

iter_query async ¶

iter_query `async` ¶