Type alias SimpleQueryUpdateByExampleOptions

SimpleQueryUpdateByExampleOptions: {
    keepNull?: boolean;
    limit?: number;
    mergeObjects?: boolean;
    waitForSync?: boolean;
}

Options for updating documents by example.

Deprecated

Simple Queries have been deprecated in ArangoDB 3.4 and can be replaced with AQL queries.

Type declaration

  • Optional keepNull?: boolean

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

    Default: true

  • Optional limit?: number

    Maximum number of documents to return.

  • 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 waitForSync?: boolean

    If set to true, the request will wait until all modifications have been synchronized to disk before returning successfully.

    Default: false

Generated using TypeDoc