The Fauna service will be ending on May 30, 2025.

For more information on the service wind down, see our announcement and the Fauna Service End-of-Life FAQ.

Replace

This reference topic applies to FQL v4. Go to this page for the latest FQL v10 reference topics.
Copied!
Replace( 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, the documents describing AccessProviders, Databases, Collections, Functions, Indexes, Keys, Roles, and Tokens use an object cache. When you use Replace to modify any of these Fauna schema documents, the modification is not guaranteed to be visible immediately.

This does not apply to non-schema documents, such as those in a user-created collection. Non-schema documents are always modified or removed in a strongly consistent manner.

Parameters

Parameter Type Definition and Requirements

ref

Reference

A Reference to 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 that was updated.

data

Object

A copy of the new document data.

ts

Long

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!
Replace(
  Ref(Collection('spells'), '181388642581742080'),
  {
    data: {
      name: 'Mountain\'s Thunder',
      element: ['air', 'earth'],
    },
  },
)
{
  ref: Ref(Collection("spells"), "181388642581742080"),
  ts: 1624310504150000,
  data: { name: "Mountain's Thunder", element: [ 'air', 'earth' ] }
}
Query metrics:

  •    bytesIn:  165

  •   bytesOut:  223

  • computeOps:    1

  •    readOps:    0

  •   writeOps:    1

  •  readBytes:   99

  • writeBytes:  560

  •  queryTime: 20ms

  •    retries:    0

\