@cumulus/aws-client/DynamoDbSearchQueue.d.ts

Utilities for working with AWS

import { AttributeValue, ScanCommandInput, QueryCommandInput } from '@aws-sdk/client-dynamodb';
declare type SearchType = 'scan' | 'query';
declare type SearchParams = ScanCommandInput | QueryCommandInput;
/**
 * Class to efficiently search all of the items in a DynamoDB table, without loading them all into
 * memory at once.  Handles paging.
 */
declare class DynamoDbSearchQueue {
    private readonly dynamodbDocClient;
    private readonly searchType;
    private readonly params;
    private items;
    constructor(params: SearchParams, searchType?: SearchType);
    /**
     * Drain all values from the searchQueue, and return to the user.
     * Warning: This can be very memory intensive.
     *
     * @returns {Promise<Array>} array of search results.
     */
    empty(): Promise<Record<string, AttributeValue>[]>;
    /**
     * View the next item in the queue
     *
     * This does not remove the object from the queue.  When there are no more
     * items in the queue, returns 'null'.
     *
     * @returns {Promise<Object>} an item from the DynamoDB table
     */
    peek(): Promise<Record<string, AttributeValue> | null>;
    /**
     * Remove the next item from the queue
     *
     * When there are no more items in the queue, returns 'null'.
     *
     * @returns {Promise<Object>} an item from the DynamoDB table
     */
    shift(): Promise<Record<string, AttributeValue> | null | undefined>;
    /**
     * A DynamoDbSearchQueue instance stores the list of items to be returned in
     * the `this.items` array. When that list is empty, the `fetchItems()` method
     * is called to repopulate `this.items`. Typically, the new items are fetched
     * using the `DynamoDBDocument.scan()` method.
     *
     * DynamoDB scans up to 1 MB of items at a time and then filters that 1 MB to
     * look for matching items. If there are more items to be search beyond that
     * 1 MB limit, the scan response will include a `LastEvaluatedKey` property.
     * Future calls to `scan()` should set `ExclusiveStartKey` equal to that
     * `LastEvaluatedKey`, so that DynamoDB knows where to resume the search.
     *
     * Because DynamoDB only applies filtering to 1 MB at a time, it's possible
     * that a particular 1 MB chunk may not contain any items that match the
     * filter. In that case, the response from `scan()` will contain an empty list
     * of items and a `LastEvaluatedKey` indicating that there are still more
     * items to be scanned.
     *
     * The goal of `fetchItems()` is to either add more items to `this.items` or,
     * if the entire Dynamo table has been scanned, push `null` onto the list of
     * items. It will continue to call `scan()` until one of those two conditions
     * has been satisfied.
     *
     * Reference: https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-lib-dynamodb/Class/DynamoDBDocument/
     *
     * @private
     */
    fetchItems(): Promise<void>;
}
export = DynamoDbSearchQueue;
//# sourceMappingURL=DynamoDbSearchQueue.d.ts.map