Data Store Update Object

An update object is a JavaScript object that specifies changes to top-level properties in stored documents. Use it with a query object that identifies the documents to update. For more information, see Data Store Query Object.

Pass an update object as the second argument to the following methods:

• Collection.updateOne(query, update)

• Collection.updateMany(query, update)

Update objects use update operator names as properties. Assign each operator an object containing the document properties to change and their values. For more information about how to construct an update object, see the following topics:

• Data Store Update Operators

• Data Store Update Rules and Limits

• Syntax

Syntax

The following example combines all three update operators in one update object.

The query selects a document by its _id. The update object makes the following changes:

• Sets status to 'running'.

• Removes temporary.

• Adds 1 to the existing value of completed.

The document's completed property must already contain a number.

Important:

The following code sample shows how to define and use an update object. It isn't a functional example. For a complete script example, see N/dataStore Module Script Samples.

            const result = await collection.updateOne(
    { _id: documentId },
    {
        $set: { status: 'running' },
        $unset: { temporary: true },
        $inc: { completed: 1 }
    }
); 

          

Related Topics

• N/dataStore Module
• Data Store Query Object
• N/dataStore Module Script Samples

General Notices