couchbase
    Preparing search index...

    Interface MutateInOptions

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

    Properties

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

    Properties

    cas?: CasInput

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

    durabilityLevel?: DurabilityLevel

    Specifies the level of synchronous durability for this operation.

    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.

    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.

    expiry?: number | Date

    Specifies the expiry time for the document.

    The expiry can be provided as:

    • A number of seconds relative to the current time (recommended).
    • A Date object for an absolute expiry time.

    IMPORTANT: To use a Unix timestamp for expiry, construct a Date from it ( new Date(UNIX_TIMESTAMP * 1000) ).

    preserveExpiry?: boolean

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

    storeSemantics?: StoreSemantics

    Specifies the store semantics to use for this operation.

    timeout?: number

    The timeout for this operation, represented in milliseconds.

    upsertDocument?: boolean

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

    Use MutateInOptions.storeSemantics instead.

    Settings

    Member Visibility

    On This Page

    Properties