Key

Description

Keys are linked to a database, allowing access to database contents.

A Key document has no associated credential, so there is no identity. The lack of a credential means that keys grant anonymous access to a database. Any user or process with a Fauna key secret can access the database associated with the key.

A key has a defined Role that determines the access level of operations associated with the key.

Document definition

Key document definition

Static methods

Method Description

Method	Description
`Key.all()`	Get the set of all Key objects.
`Key.byId()`	Get a key by ID.
`Key.create()`	Create a key.
`Key.firstWhere()`	Get the first key matching a predicate function.
`Key.toString()`	Get the name of the Key collection as a string.
`Key.where()`	Get keys matching a predicate function.

Key.all()

Get the set of all Key objects.

Key.byId()

Get a key by ID.

Key.create()

Create a key.

Key.firstWhere()

Get the first key matching a predicate function.

Key.toString()

Get the name of the Key collection as a string.

Key.where()

Get keys matching a predicate function.