Check out v4 of the Fauna CLI

v4 of the Fauna CLI is now in beta.

The new version introduces enhancements to the developer experience, including an improved authentication workflow. To get started, check out the CLI v4 quick start.

functionDef.replace()

Learn: User-defined functions (UDFs)

We recommend you use FSL to create and update user-defined functions (UDFs). See FSL function schema.

Replace a user-defined function (UDF).

Signature

replace(data: { *: Any }) => FunctionDef

Description

Replaces all fields in a UDF, represented as an Function document, with fields from a provided data object. Fields not present in the data object, excluding the coll and ts metadata fields, are removed.

Function documents are FQL versions of a database’s FSL function schema. Function documents have the FunctionDef type. See User-defined functions (UDFs).

Metadata fields

You can’t use this method to insert or edit the following metadata fields:

  • coll

  • ts

Staged schema

If a database has staged schema, this method interacts with the database’s staged schema, not the active schema.

You can’t rename a function while a database has staged schema.

If the database has no staged schema, using this method is equivalent to making an unstaged schema change. Changes are applied immediately to the database’s active schema.

Avoid concurrent schema changes

Concurrent unstaged schema changes can cause contended transactions, even if the changes affect different resources. This includes unstaged changes made using:

A schema change triggers a transaction that validates the entire database schema. To avoid errors, do one of the following instead:

Parameters

Parameter Type Required Description

data

Object

true

Fields for the Function document. Fields not present, excluding the coll and ts metadata fields, in the object are removed.

For supported document fields, see Function collection.

The object can’t include the following metadata fields:

* coll * ts

Return value

Type Description

FunctionDef

Function document with replaced fields.

Examples

Function.byName("validateOrderStatusTransition")?.replace({
  name: "validateOrderStatusTransition",
  role: "server",
  body: <<-END
    (oldStatus, newStatus) => {
      if (oldStatus == "cart" && newStatus != "processing") {
        abort("Invalid status transition.")
      } else if (oldStatus == "processing" && newStatus != "shipped") {
        abort("Invalid status transition.")
      } else if (oldStatus == "shipped" && newStatus != "delivered") {
        abort("Invalid status transition.")
      }
    }
  END
})
{
  name: "validateOrderStatusTransition",
  coll: Function,
  ts: Time("2099-10-28T15:11:25.460Z"),
  body: <<-END
    (oldStatus, newStatus) => {
      if (oldStatus == "cart" && newStatus != "processing") {
        abort("Invalid status transition.")
      } else if (oldStatus == "processing" && newStatus != "shipped") {
        abort("Invalid status transition.")
      } else if (oldStatus == "shipped" && newStatus != "delivered") {
        abort("Invalid status transition.")
      }
    }
  END,
  role: "server"
}

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!