@karmaniverous/entity-client-dynamodb
    Preparing search index...

    Interface PurgeTableOptions

    Options for purgeTable.

    interface PurgeTableOptions {
        batchProcessOptions?: Omit<
            BatchProcessOptions<unknown, unknown>,
            "batchHandler" | "unprocessedItemExtractor",
        >;
        ReturnConsumedCapacity?: ReturnConsumedCapacity;
        ReturnItemCollectionMetrics?: ReturnItemCollectionMetrics;
        tableNameOverride?: string;
    }

    Hierarchy

    Index

    Properties

    batchProcessOptions? ReturnConsumedCapacity? ReturnItemCollectionMetrics? tableNameOverride?

    Properties

    batchProcessOptions?: Omit<
        BatchProcessOptions<unknown, unknown>,
        "batchHandler" | "unprocessedItemExtractor",
    >

    Optional BatchProcessOptions override passed to the internal batching loop.

    ReturnConsumedCapacity?: ReturnConsumedCapacity

    Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

    • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

      Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

    • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

    • NONE - No ConsumedCapacity details are included in the response.

    ReturnItemCollectionMetrics?: ReturnItemCollectionMetrics

    Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

    tableNameOverride?: string

    One-off TableName override for purging; supersedes options.tableName. Provided as a distinct option to keep call sites explicit.

    Settings

    Member Visibility

    On This Page

    Properties