Check out v4 of the Fauna CLI

v4 of the Fauna CLI is now in beta.

The new version introduces enhancements to the developer experience, including an improved authentication workflow. To get started, check out the CLI v4 quick start.

Database

Learn: Databases and multi-tenancy

In Fauna, a database stores data as documents in one or more collections.

Fauna databases support a hierarchical database structure with top-level and child databases.

`Database` collection

Fauna stores metadata and settings for a database’s child databases as documents in the Database system collection. These documents have the DatabaseDef type.

Database documents have the following FQL structure:

{
  name: "child_db",
  coll: Database,
  ts: Time("2099-06-24T21:53:40.670Z"),
  typechecked: true,
  protected: false,
  priority: 10,
  global_id: "ysjpygonryyr1",
  data: {
    desc: "Prod child database"
  }
}

Field Type Read-only Required Description

Field	Type	Read-only	Required	Description
`name`	String		true	Name of the database.
`coll`	String	true		Collection name: `Database`.
`ts`	Time	true		Last time the document was created or updated.
`priority`	Number \| Null			User-defined priority assigned to the database.
`typechecked`	Boolean \| Null			If `true`, typechecking is enabled for the database. If `false`, typechecking is disabled. Inherits the parent database’s typechecking setting.
`protected`	Boolean \| Null			If `true`, protected mode is enabled for the database. If `false`, protected mode is disabled. Inherits the parent database’s protected mode setting.
`global_id`	String	true		Auto-generated, globally unique ID for the database. See Global database ID.
`data`	`{ *: Any }` \| Null			Arbitrary user-defined metadata for the document.

name

String

true

Name of the database.

coll

String

true

Collection name: Database.

ts

Time

true

Last time the document was created or updated.

priority

Number | Null

User-defined priority assigned to the database.

typechecked

Boolean | Null

If true, typechecking is enabled for the database. If false, typechecking is disabled.

Inherits the parent database’s typechecking setting.

protected

Boolean | Null

If true, protected mode is enabled for the database. If false, protected mode is disabled.

Inherits the parent database’s protected mode setting.

global_id

String

true

Auto-generated, globally unique ID for the database. See Global database ID.

data

{ *: Any } | Null

Arbitrary user-defined metadata for the document.

Scope

The Database collection only contains documents for the direct child databases of the database scoped to your authentication secret. You can’t use the Database collection to access parent, peer, or other descendant databases.

Using FQL to create or manage top-level databases is not supported.

Static methods

You can use the following static methods to manage the Database collection in FQL.

Method Description

Method	Description
`Database.all()`	Deletes a child database.
`Database.byName()`	Get a child database by its name.
`Database.create()`	Create a child database.
`Database.firstWhere()`	Get the first child database document that matches a provided predicate.
`Database.toString()`	Get `"Database"` as a String.
`Database.where()`	Get a Set of child databases that match a provided predicate.

Database.all()

Deletes a child database.

Database.byName()

Get a child database by its name.

Database.create()

Create a child database.

Database.firstWhere()

Get the first child database document that matches a provided predicate.

Database.toString()

Get "Database" as a String.

Database.where()

Get a Set of child databases that match a provided predicate.

Instance methods

You can use the following instance methods to manage specific Database documents in FQL.

Method Description

Method	Description
`database.delete()`	Deletes a child database.
`database.exists()`	Test if a child database exists.
`database.replace()`	Replace a child database's metadata and settings.
`database.update()`	Update a child database's metadata and settings.

database.delete()

Deletes a child database.

database.exists()

Test if a child database exists.

database.replace()

Replace a child database's metadata and settings.

database.update()

Update a child database's metadata and settings.

Is this article helpful?

Tell Fauna how the article can be improved:
Visit Fauna's forums or email docs@fauna.com

Thank you for your feedback!