Databases

Databases are defined as documents of type database. Databases exist within the system-global root database context.

Aside from keys, all other documents exist within the context of a specific database. All queries are limited to a single database as well, and cannot span across databases.

It is possible to rename a database by updating its name field. Renaming a database changes its ref, but preserves inbound references to the database. The data within a database remains accessible via existing keys.

When a database is deleted, its associated data becomes inaccessible and is deleted asynchronously.

To learn more about common database operations and functions, see Database recipes.

Structure

Field Type Definition and Requirements

name

String

The name of the database.

Cannot be events, sets, self, documents, or _. Cannot have the % character.

global_id

String

A read-only string that provides a globally-unique identifier for this database.

data

Object

Optional - A JSON object to contain any additional metadata about this database.

priority

Number

A priority between 1 and 500, inclusive. Defaults to 1.

The priority option is deprecated as of release 2.10.0. You should avoid specifying priority. In some future Fauna release, priority will be removed. See Deprecations for more details.