Type alias CollectionUpdateOptions

CollectionUpdateOptions: {
    ifMatch?: string;
    ignoreRevs?: boolean;
    keepNull?: boolean;
    mergeObjects?: boolean;
    refillIndexCaches?: boolean;
    returnNew?: boolean;
    returnOld?: boolean;
    silent?: boolean;
    versionAttribute?: string;
    waitForSync?: boolean;
}

Options for updating a document in a collection.

Type declaration

  • Optional ifMatch?: string

    If set to a document revision, the document will only be updated if its _rev matches the given revision.

  • Optional ignoreRevs?: boolean

    If set to false, the existing document will only be modified if its _rev property matches the same property on the new data.

    Default: true

  • Optional keepNull?: boolean

    If set to false, properties with a value of null will be removed from the new document.

    Default: true

  • Optional mergeObjects?: boolean

    If set to false, object properties that already exist in the old document will be overwritten rather than merged. This does not affect arrays.

    Default: true

  • Optional refillIndexCaches?: boolean

    If set to true, existing entries in in-memory index caches will be updated if document updates affect the edge index or cache-enabled persistent indexes.

    Default: false

  • Optional returnNew?: boolean

    If set to true, the complete new document will be returned as the new property on the result object. Has no effect if silent is set to true.

    Default: false

  • Optional returnOld?: boolean

    If set to true, the complete old document will be returned as the old property on the result object. Has no effect if silent is set to true.

    Default: false

  • Optional silent?: boolean

    If set to true, no data will be returned by the server. This option can be used to reduce network traffic.

    Default: false

  • Optional versionAttribute?: string

    If set, the attribute with the name specified by the option is looked up in the stored document and the attribute value is compared numerically to the value of the versioning attribute in the supplied document that is supposed to update/replace it.

  • Optional waitForSync?: boolean

    If set to true, data will be synchronized to disk before returning.

    Default: false

Settings

Theme

Generated using TypeDoc