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 function fields.

Signature

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

Description

The replace() method replaces the given object function field values with the given object values. The given fields must exist and be mutable.

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

object

Object

Yes

Replacement function fields.

Return value

Type Description

FunctionDef

Function 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!