Interface PutOpResult<TRow>

Represents the result of put sub-operation in WriteMultipleResult. This is also a base interface for PutResult.

See

PutResult

Type Parameters

  • TRow = AnyRow

    Type of table row instance, defaults to AnyRow

Hierarchy

Properties

existingModificationTime? existingRow? existingVersion? generatedValue? success version?

Properties

Optional Readonly existingModificationTime

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

Optional Readonly existingRow

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.

Optional Readonly existingVersion

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.

Optional Readonly generatedValue

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.

Readonly success

success: boolean

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

Optional Readonly version

version?: RowVersion

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

Settings

Member Visibility

Theme

Generated using TypeDoc