Role

Learn: Roles

We recommend you use FSL to create and update user-defined roles. See Role schema.

Fauna stores user-defined roles as documents in the Role system collection.

These documents act as an FQL version of the FSL role schema. See Role document definition..

You can use the following methods to handle roles in FQL.

Static methods

Method Description

Role.all()

Get the set of all roles.

Role.byName()

Get a role by its name.

Role.create()

Create a role.

Role.firstWhere()

Get the first role matching a predicate function.

Role.toString()

Get the name of the Role collection as a string.

Role.where()

Get roles matching a predicate function.

Instance methods

Method Description

role.delete()

Delete a role.

role.exists()

Tests if a role exists.

role.replace()

Replace a role.

role.update()

Update a role.

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!