document.update()
Update document fields.
Description
The update() method updates the document with the object fields
and returns the updated document. During the update, fields from object
are copied to the document, creating new fields or updating existing
fields. The operation is similar to a merge.
Only the fields included in object are updated, all other document fields aren’t updated. Fields with nested objects in object are merged with the identically named nested object in the document.
Remove a field
To remove a document field, set its value in object to null.
Deleted fields aren’t saved.
Default values
A field definition can set a
default field value for
documents in a collection. Default values are not inserted for missing or null
fields during a document update.
Examples
Given the following document:
{
id: "777",
coll: Product,
ts: Time("2099-04-10T16:50:12.850Z"),
name: "limes",
description: "Conventional, 16 oz bag",
price: 2_99,
stock: 30,
category: Category("789")
}Call update() with an object containing updated document fields:
Product.byId("777")?.update({
name: "key limes",
stock: 100
}){
id: "777",
coll: Product,
ts: Time("2099-04-10T16:50:12.850Z"),
name: "key limes",
description: "Conventional, 16 oz bag",
price: 299,
stock: 100,
category: Category("789")
}Remove a field
To remove a document field, set its value to null. Fields with null values
aren’t stored or returned.
Product.byId("777")?.update({
stock: null
}){
id: "777",
coll: Product,
ts: Time("2099-04-10T17:59:50.970Z"),
name: "limes",
description: "Conventional, 16 oz bag",
price: 299,
category: Category("789")
}Is this article helpful?
Tell Fauna how the article can be improved:
Visit Fauna's forums
or email docs@fauna.com
Thank you for your feedback!