FQL v4 will be decommissioned on June 30, 2025. Ensure that you complete your migration from FQL v4 to FQL v10 by that date.

Fauna accounts created after August 21, 2024 must use FQL v10. These accounts will not be able to run FQL v4 queries or access the v4 Dashboard.

For more details, see the v4 EOL announcement and migration guide. Contact support@fauna.com with any questions.

Roles

This reference topic applies to FQL v4. Go to this page for the latest FQL v10 reference topics.

 
Roles( [database] )
roles( [database] )
Roles( )
ScopedRole( name, database )
Roles( [database] )
Roles( [database] )
Roles( [database] )

Description

The Roles function, when executed with Paginate, returns an Array of References for user-defined roles in the specified child database. If a child database is not specified, the role references returned all belong to the current database.

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

Also, Go does not support optional function parameters, nor function overloading. To specify a child database using the Go driver, call the ScopedRoles function instead of Roles.

Parameters

Parameter Type Definition and requirements

database

Reference

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

A Reference to a child database.

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

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

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

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

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

Returns

An Set Reference for the available user-defined roles in the specified child database (or the current database if database is not specified).

Examples

  1. The following query lists any user-defined roles (up to the pagination limit) in the current database:

    client.query(
  q.Paginate(q.Roles())
)
.then((result) => console.log(result))
.catch((err) => console.error(
  'Error: [%s] %s: %s',
  err.name,
  err.message,
  err.errors()[0].description,
))
    { data: [ Role("employees") ] }
    result = client.query(
  q.paginate(q.roles())
)
print(result)
    {'data': [Ref(id=employees, collection=Ref(id=roles))]}
    result, err := client.Query(
	f.Paginate(f.Roles()))

if err != nil {
	fmt.Fprintln(os.Stderr, err)
} else {
	fmt.Println(result)
}
    map[data:[{employees 0xc00017e0c0 0xc00017e0c0 <nil>}]]
    try
{
    Value result = await client.Query(
        Paginate(Roles())
    );
    Console.WriteLine(result);
}
catch (Exception e)
{
    Console.WriteLine($"ERROR: {e.Message}");
}
    ObjectV(data: Arr(RefV(id = "employees", collection = RefV(id = "roles"))))
    System.out.println(
    client.query(
        Paginate(Roles())
    ).get());
    {data: [ref(id = "employees", collection = ref(id = "roles"))]}
    Paginate(Roles())
    { data: [ Role("employees") ] }
    Query metrics:

    •    bytesIn:   27

    •   bytesOut:   88

    • computeOps:    1

    •    readOps:    8

    •   writeOps:    0

    •  readBytes:  250

    • writeBytes:    0

    •  queryTime: 15ms

    •    retries:    0

  2. The following query lists the References for any user-defined roles (up to the pagination limit) in a child database named "child_db":

    client.query(
  q.Paginate(q.Roles(q.Database('child_db')))
)
.then((result) => console.log(result))
.catch((err) => console.error(
  'Error: [%s] %s: %s',
  err.name,
  err.message,
  err.errors()[0].description,
))
    { data: [] }
    result = client.query(
  q.paginate(q.roles(q.database("child_db")))
)
print(result)
    {'data': []}
    result, err := client.Query(
	f.Paginate(f.ScopedRoles(f.Database("child_db"))))

if err != nil {
	fmt.Fprintln(os.Stderr, err)
} else {
	fmt.Println(result)
}
    map[data:[]]
    try
{
    Value result = await client.Query(
        Paginate(Roles(Database("child_db")))
    );
    Console.WriteLine(result);
}
catch (Exception e)
{
    Console.WriteLine($"ERROR: {e.Message}");
}
    ObjectV(data: Arr())
    System.out.println(
    client.query(
        Paginate(Roles(Database("child_db")))
    ).get());
    {data: []}
    Paginate(Roles(Database('child_db')))
    { data: [] }
    Query metrics:

    •    bytesIn:   46

    •   bytesOut:   24

    • computeOps:    1

    •    readOps:    8

    •   writeOps:    0

    •  readBytes:  363

    • writeBytes:    0

    •  queryTime: 14ms

    •    retries:    0

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!