Function document definition

Fields

Field Type Description

name

String

Name of the function.

Can’t be documents, events, self, sets, or a single underscore _, and can’t include a space character.

coll

String

Document collection name.

ts

Time

Most recent document update timestamp.

body

String

FQL expression.

role

String

(Optional) Role to use when the function is called. Only included if role is provided when the UDF is created.

Can be a built-in role, admin, server, or server-readonly, or a user-defined role that grants write privilege for Functions.

data

Object

(Optional) Object with metadata fields.

See also

Function.create()

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!