Represents the result of a writeMany, putMany or deleteMany methods.

If the operation succeeds, the execution result of each sub operation is available in results property.

If the operation is aborted because of the failure of a sub operation with abortOnFail set to true or if abortOnFail is set to true, then the index of failed operation is available as failedOpIndex and the execution result of failed operation is available as failedOpResult. The results property will be undefined in this case. You may check for the success of the entire operation by whether results is defined.

Type Parameters

  • TRow = AnyRow

    Type of table row instance, defaults to AnyRow

Hierarchy

Properties

consumedCapacity?: ConsumedCapacity

Capacity consumed by this operation, see ConsumedCapacity. Undefined if using on-premises service or if this is a result of a put or a delete sub-operation as part of WriteMultipleResult.

failedOpIndex?: number

Index of failed sub operation that resulted in the entire operation aborting. Undefined if the operation was successul.

failedOpResult?: PutOpResult<TRow> | DeleteOpResult<TRow>

Result of failed sub operation that resulted in the entire operation aborting. Undefined if the operation was successful.

results?: (PutOpResult<TRow> | DeleteOpResult<TRow>)[]

Array of results if the operation succeeded, undefined otherwise. Each result in the array is either PutResult or DeleteResult depending on the sub operation and has the same index in the array as its corresponding operation object provided in the operations array to writeMany (same holds for rows and keys provided to putMany and deleteMany methods). Note that sub operation results do not contain ConsumedCapacity.

Generated using TypeDoc