Function

Function methods and properties.

Description

User-defined Function (UDFs) exist as top-level objects in the FQL global namespace. Each Function object has a UDF document stored in a Fauna database that has an FQL expression.

The Function object provides methods to query or create UDF documents.

The Function.create() method can optionally specify a built-in or user-defined Role. The UDF runs with the privileges of the role field. A UDF without a role assigned has the same privileges as the function caller. While not specifying a role on create() may be acceptable, it can result in an ambiguous security policy. It is prudent to ensure that every UDF has an associated role.

Document definition: Function document definition

See User-defined functions in the migration document for FQL v10 and FQL v4 UDF interoperability.

Static methods

Method Description

Method	Description
`Function()`	Dynamically get the Function by name.
`Function.all()`	Get the Set of all accessible user-defined Function documents.
`Function.byName()`	Get a user-defined Function document by its name.
`Function.create()`	Create a user-defined Function document.
`Function.firstWhere()`	Get the first matching accessible user-defined Function document.
`Function.toString()`	Get the name of the Function collection as a string.
`Function.where()`	Get the Set of matching accessible user-defined Function documents.

Function()

Dynamically get the Function by name.

Function.all()

Get the Set of all accessible user-defined Function documents.

Function.byName()

Get a user-defined Function document by its name.

Function.create()

Create a user-defined Function document.

Function.firstWhere()

Get the first matching accessible user-defined Function document.

Function.toString()

Get the name of the Function collection as a string.