Replace

Copied!
( ref, param_object )

Description

The replace operation substitutes the user data pointed to by the reference with the data contained in the param_object. Values not specified in the param_object are removed.

For performance, Databases, Collections, Functions, Indexes, Keys, and Roles use a cache. When you use Replace 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 type containing the document that should be modified.

param_object

Object

An object that containing the document’s user data to be modified. 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.

Returns

An object containing the metadata about the replace operations.

Field Name Field Type Definition and Requirements

ref

Reference

The reference that identifies the document just 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:

Copied!
client.query(
  q.(
    q.(q.('spells'), '181388642581742080'),
    {
      data: {
        name: 'Mountain\'s Thunder',
        element: ['air', 'earth'],
      },
    },
  )
)
.then((ret) => console.log(ret))
{ ref:
   (id=181388642581742080, collection=(id=spells, collection=(id=collections))),
  ts: 1527275958680623,
  data:
   { name: 'Mountain\'s Thunder',
     element: [ 'air', 'earth' ]
   } 
}

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!