Role

This reference topic applies to FQL v4. Go to this page for the latest FQL v10 reference topics.
Copied!
Role( name, [database] )

Description

The Role function returns a Reference for the specified user-defined role’s name in the specified child database. If a child database is not specified, the role returned belongs to the current database.

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

Parameters

Parameter Type Definition and requirements

name

String

The name of a role.

database

Reference

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

Returns

A Reference to a user-defined role with the specified name, in the specified child database (or the current database if database is not specified).

Examples

  1. The following query gets a Reference to the user-defined role named "admin" in the current database:

    Copied!
    Role('admin')
    Role("admin")
    Query metrics:

    •    bytesIn:  16

    •   bytesOut:  73

    • computeOps:   1

    •    readOps:   0

    •   writeOps:   0

    •  readBytes:   0

    • writeBytes:   0

    •  queryTime: 4ms

    •    retries:   0

  2. The following query gets a Reference to the user-defined role named "admin" in a child database named "child_db":

    Copied!
    Role('admin', Database('child_db'))
    Role("admin", Database("child_db"))
    Query metrics:

    •    bytesIn:   48

    •   bytesOut:  152

    • computeOps:    1

    •    readOps:    0

    •   writeOps:    0

    •  readBytes:  155

    • writeBytes:    0

    •  queryTime: 10ms

    •    retries:    0

\