Functions

Functions( [database] )
Functions( [database] )
Functions( [database] )
Functions( [database] )
functions( [database] )
functions [database]
Functions( [database] )
Functions( [database] )

Description

The Functions function when executed with Paginate returns an array of Refs for all user-defined functions in the database specified. If a child database is not specified, the returned function references all belong to the current database.

When a child database is specified, an admin key must be used to call Functions (server or client keys, or ABAC tokens, cannot be used to access a child database).

Parameters

Argument Type Definition and Requirements

database

Reference

Optional - A reference to a child database. If not specified, the current database is used.

Returns

A Set reference for the available user-defined functions in the specified child database (or the current database if database is not specified).

Examples

The query below gets the references to all user-defined functions in the current database.

curl https://db.fauna.com/ \
    -u fnAChGwBcAACAO70ziE0cfROosNJHdgBmJU1PgpL: \
    -d '{ "paginate": { "functions": null } }'
client.Query(Paginate(Functions()));
System.out.println(client.query(Paginate(Functions())).get());
result, _ := client.Query(f.Paginate(f.Functions()))

fmt.Println(result)
client.query(Paginate(Functions()))
client.query(q.paginate(q.functions()))
$client.query do
  paginate functions
end
client.query(Paginate(Functions()))
client.query(q.Paginate(q.Functions()))
.then((ret) => console.log(ret))
HTTP/1.1 200 OK
{ "resource": [{ "@ref": "functions/increment" }] }
[{ "@ref": "functions/increment" }]
[ref(id = "increment", collection = ref(id = "functions"))]
[{increment 0xc4202dd9a0 <nil>}]
[{ "@ref": "functions/increment" }]
[{ "@ref": "functions/increment" }]
[{ "@ref": "functions/increment" }]
[{ "@ref": "functions/increment" }]
[Ref(id=increment, collection=Ref(id=functions))]

Was this article helpful?

We're sorry to hear that.
Tell us how we can improve! documentation@fauna.com

Thank you for your feedback!