Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BaseScanOptions

Hierarchy

Index

Properties

Optional filter

filter: ConditionExpression

A string that contains conditions that DynamoDB applies after the Query operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.

A FilterExpression does not allow key attributes. You cannot define a filter expression based on a partition key or a sort key.

Optional indexName

indexName: undefined | string

The name of an index to query. This index can be any local secondary index or global secondary index on the table.

Optional pageSize

pageSize: undefined | number

The maximum number of items to fetch per page of results.

Optional projection

projection: ProjectionExpression

The item attributes to get.

Optional readConsistency

readConsistency: ReadConsistency

The read consistency to require when reading from DynamoDB.