Options
All
  • Public
  • Public/Protected
  • All
Menu

Class QueryIterator

Hierarchy

Implements

  • AsyncIterableIterator<AttributeMap>

Index

Constructors

constructor

  • new QueryIterator(client: DynamoDB, input: QueryInput, limit?: undefined | number): QueryIterator

Accessors

consumedCapacity

  • get consumedCapacity(): ConsumedCapacity | undefined
  • The capacity units consumed by the Scan operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified.

    Returns ConsumedCapacity | undefined

count

  • get count(): number

scannedCount

  • get scannedCount(): number
  • The number of items evaluated, before any ScanFilter is applied. A high scannedCount value with few, or no, Count results indicates an inefficient Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.

    Returns number

Methods

__@asyncIterator

  • __@asyncIterator(): AsyncIterableIterator<AttributeMap>

next

  • next(): Promise<IteratorResult<AttributeMap>>

pages

  • Detaches the underlying paginator from this iterator and returns it. The paginator will yield arrays of unmarshalled items, with each yielded array corresponding to a single call to the underlying API. As with the underlying API, pages may contain a variable number of items or no items, in which case an empty array will be yielded.

    Calling this method will disable further iteration.

    Returns QueryPaginator

return

  • return(): Promise<IteratorResult<AttributeMap>>