Interface QueryOnePageOptions

interface QueryOnePageOptions {
    consistentRead?: boolean;
    exclusiveStartKey?: DynamoDBValues;
    limit?: number;
    scanIndexForward?: boolean;
}

Properties

consistentRead? exclusiveStartKey? limit? scanIndexForward?

Properties

OptionalconsistentRead

consistentRead?: boolean

Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.

See

https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Query.html#DDB-Query-request-ConsistentRead

Default

DynamoDB's default which is false

OptionalexclusiveStartKey

exclusiveStartKey?: DynamoDBValues

The key of the first item to read

See

ExclusiveStartKey at https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Query.html

Default

DynamoDB's default, which is start at first item

Optionallimit

limit?: number

Max number of items to read

See

Limit at https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Query.html

Default

DynamoDB's default which is no limit set, but a maximum of 1MB of data

OptionalscanIndexForward

scanIndexForward?: boolean

Whether to return results in ascending order

See

ScanIndexForward at https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Query.html

Default

DynamoDB's default which is true, i.e.

Settings

Member Visibility

On This Page

Properties