Represents the result of put, putIfAbsent, putIfPresent and putIfVersion methods.

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.

existingModificationTime?: Date

Existing modification time if available, otherwise undefined. This value will only be available if the conditional put operation failed and returnExisting was set to true.

Since

5.3.0

existingRow?: TRow

Existing row value if available, otherwise undefined. This value will only be available if the conditional put operation failed and returnExisting was set to true.

existingVersion?: RowVersion

Existing RowVersion if available, otherwise undefined. This value will only be available if the conditional put operation failed and returnExisting was set to true.

generatedValue?: IdentityField

Value generated if the operation created a new value for an identity column or string as uuid column. Present only if a value was generated for that column by this operation.

success: boolean

Whether the put operation was successful, as described in put.

version?: RowVersion

RowVersion of the new row if the put operation was successful, otherwise undefined.

Generated using TypeDoc