Update

Update( ref, param_object )
Update( ref, param_object )
Update( ref, param_object )
Update( ref, param_object )
q.update( ref param_object )
Update( ref param_object )

Description

The Update operation only modifies the specified fields in the documents pointed to by ref. Updates are partial, and only modify values that are specified in the param_object. Changes to scalar values and arrays are entirely replaced by the new data. Modifications to objects are merged. Setting a value to null completely removes the value. Fields in the document not specified in the param_object are not modified.

For performance, Databases, Collections, Functions, Indexes, Keys, and Roles use a cache. When you use Update to modify any of these Fauna schema documents, the modification is not guaranteed to be visible immediately.

Parameters

Argument Type Definition and Requirements

ref

Reference

A Reference identifying the document that should be modified.

param_object

Object

An Object containing the document data to update, as well as optional new credentials and delegates. See the following section for details.

param_object

Field Name Field Type Definition and Requirements

data

Object

The document’s user data to be modified.

credentials

Object

The document’s credentials to be modified.

delegates

Object

The document’s delegates to be modified.

ttl

Timestamp

Optional - A timestamp indicating the document’s time-to-live, which is when the document should be removed. When a document is removed, the document’s existence ceases (as if it never existed); temporal queries cannot recover the document.

Removal is handled by a background task, so once a document (including collections, databases, indexes, keys, roles, and tokens) "expires" due to the setting in the ttl field, it could be some time (hours or days) before the removal occurs. There is no guarantee that removal actually occurs.

As of version 3.0.0, the ttl field is honored on read — a document that should have been removed behaves as if it has been removed. However, until removal actually occurs due to background task processing, you can continue to access the history of the document, provided you have its reference, via the Events function.

Returns

An object containing the metadata about the update operations.

Field Name Field Type Definition and Requirements

ref

Reference

The Reference that identifies the document that was updated.

data

Object

A copy of the new document data.

ts

Integer

The timestamp, with microsecond resolution, of the document update.

Examples

The following query updates the document by changing the name field to the value "Mountains’s Thunder" and removing the cost field from the document. All other fields in the document remain unchanged.

try
{
    Value result = await client.Query(
        Update(
            Ref(Collection("spells"), "181388642581742080"),
            Obj("data", Obj("name", "Mountain's Thunder", "cost", Null()))
        )
    );
    Console.WriteLine(result);
}
catch (Exception e)
{
    Console.WriteLine($"ERROR: {e.Message}");
}
ObjectV(ref: RefV(id = "181388642581742080", collection = RefV(id = "spells", collection = RefV(id = "collections"))),ts: LongV(1603756871700000),data: ObjectV(name: StringV(Mountain's Thunder),element: StringV(air)))
result, err := client.Query(
	f.Update(
		f.Ref(f.Collection("spells"), "181388642581742080"),
		f.Obj{
			"data": f.Obj{"name": "Mountain's Thunder", "cost": nil}}))

if err != nil {
	fmt.Fprintln(os.Stderr, err)
} else {
	fmt.Println(result)
}
map[data:map[element:air name:Mountain's Thunder] ref:{181388642581742080 0xc000146180 0xc000146180 <nil>} ts:1603747313810000]
System.out.println(
    client.query(
        Update(
            Ref(Collection("spells"), Value("181388642581742080")),
            Obj(
                "data", Obj(
                    "name", Value("Mountain's Thunder"),
                    "cost", Null()
                )
            )
        )
    ).get());
{ref: ref(id = "181388642581742080", collection = ref(id = "spells", collection = ref(id = "collections"))), ts: 1593467851740000, data: {name: "Mountain's Thunder", element: "air"}}
client.query(
  q.Update(
    q.Ref(q.Collection('spells'), '181388642581742080'),
    {
      data: {
        name: 'Mountain\'s Thunder',
        cost: null,
      },
    },
  )
)
.then((ret) => console.log(ret))
.catch((err) => console.error('Error: %s', err))
{
  ref: Ref(Collection("spells"), "181388642581742080"),
  ts: 1592112267090000,
  data: { name: "Mountain's Thunder", element: 'air' }
}
result = client.query(
  q.update(
    q.ref(q.collection("spells"), "181388642581742080"),
    {
      "data": {
        "name": "Mountain's Thunder",
        "cost": None
      }
    }
  )
)
print(result)
{'ref': Ref(id=181388642581742080, collection=Ref(id=spells, collection=Ref(id=collections))), 'ts': 1592870397530000, 'data': {'name': "Mountain's Thunder", 'element': 'air'}}
try {
  println(Await.result(
    client.query(
  Update(
    Ref(Collection("spells"), "181388642581742080"),
    Obj(
      "data" -> Obj("name" -> "Mountain's Thunder", "cost" -> Null())
    )
  )
),
    5.seconds
  ))
} catch {
  case unknown: Throwable => println("Error: " + unknown.getMessage())
}
{ref: ref(id = "181388642581742080", collection = ref(id = "spells", collection = ref(id = "collections"))), ts: 1594435307720000, data: {name: "Mountain's Thunder", element: "air"}}

Was this article helpful?

We're sorry to hear that.
Tell us how we can improve!
 Visit Fauna's Discourse forums or email docs@fauna.com

Thank you for your feedback!