`Roles`

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

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).

Parameters

Parameter Type Definition and requirements

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.

database

Reference

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

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

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

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

Paginate(Roles(Database('child_db')))

{ data: [] }