Function.byName()

Signature

Function.byName(name: String) => NamedRef<FunctionDef>

Description

Gets a UDF, represented as an Function document, by its name.

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

Staged schema

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

Parameters

Parameter Type Required Description

name

String

true

name of the Function document to retrieve.

Return value

Type Description

NamedRef<FunctionDef>

Resolved reference to the Function document. Can resolve to an existing document or a NullDoc.

Examples

Function.byName("validateOrderStatusTransition")
{
  name: "validateOrderStatusTransition",
  coll: Function,
  ts: Time("2024-10-25T17:49:28.145Z"),
  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
}
\