Interface MutateInOptions

interface MutateInOptions {
    cas?: CasInput;
    durabilityLevel?: DurabilityLevel;
    durabilityPersistTo?: number;
    durabilityReplicateTo?: number;
    expiry?: number;
    preserveExpiry?: boolean;
    storeSemantics?: StoreSemantics;
    timeout?: number;
    upsertDocument?: boolean;
}

Properties

cas? durabilityLevel? durabilityPersistTo? durabilityReplicateTo? expiry? preserveExpiry? storeSemantics? timeout? upsertDocument?

Properties

Optional cas

cas?: CasInput

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 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.

Settings

Member Visibility

Theme

On This Page

casdurabilityLeveldurabilityPersistTodurabilityReplicateToexpirypreserveExpirystoreSemanticstimeoutupsertDocument