Role

Role( name, [database] )
Role( name, [database] )
Role( name, [database] )
Role( name, [database] )
role( name, [database] )
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

Argument 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

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

client.Query(
    Role("admin")
);
RefV(id = "admin", collection = RefV(id = "roles"))
result, err := client.Query(
	f.Role("admin"))

if err != nil {
	fmt.Fprintln(os.Stderr, err)
} else {
	fmt.Println(result)
}
{admin 0xc00016e090 0xc00016e090 <nil>}
System.out.println(
    client.query(
        Role("admin")
    ).get());
ref(id = "admin", collection = ref(id = "roles"))
client.query(
  q.Role('admin')
)
.then((result) => console.log(result))
.catch((err) => console.error('Error: %s', err))
Role("admin")
result = client.query(
  q.role("admin")
)
print(result)
Ref(id=admin, collection=Ref(id=roles))
client.query(Role("admin"))
ref(id = "admin", collection = ref(id = "roles"))

Was this article helpful?

We're sorry to hear that.
Tell us how we can improve!
 Visit Fauna's Discourse forums or email docs@fauna.com

Thank you for your feedback!