Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MutateInOptions

Hierarchy

  • MutateInOptions

Index

Properties

Optional cas

cas: any

If specified, indicates that operation should be failed if the CAS has changed from this value, indicating that the document has changed.

Optional durabilityLevel

durabilityLevel: DurabilityLevel

Specifies the level of synchronous durability for this operation.

Optional durabilityPersistTo

durabilityPersistTo: number

Specifies the number of nodes this operation should be persisted to before it is considered successful. Note that this option is mutually exclusive of durabilityLevel.

Optional durabilityReplicateTo

durabilityReplicateTo: number

Specifies the number of nodes this operation should be replicated to before it is considered successful. Note that this option is mutually exclusive of durabilityLevel.

Optional expiry

expiry: number

Specifies the expiry time for this document, specified in seconds.

Optional parentSpan

parentSpan: RequestSpan

The parent tracing span that this operation will be part of.

Optional preserveExpiry

preserveExpiry: boolean

Specifies that any existing expiry on the document should be preserved.

Optional storeSemantics

storeSemantics: StoreSemantics

Specifies the store semantics to use for this operation.

Optional timeout

timeout: number

The timeout for this operation, represented in milliseconds.

Optional upsertDocument

upsertDocument: boolean

Specifies whether the operation should be performed with upsert semantics, creating the document if it does not already exist.

deprecated

Use MutateInOptions.storeSemantics instead.

Generated using TypeDoc