Database document definition

Learn: Databases

Fauna stores metadata and settings for databases as documents in the Database system collection. You can use Database collection methods to create and manage databases in FQL.

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.

If you use an authentication secret scoped to an account’s top-level context, the Database collection contains documents for the account’s top-level databases. You can create a top-level secret using the fauna cloud-login command.

Fields

Field Type Description

name

Name of the database.

coll

Document type name: Database.

ts

Most recent document update timestamp.

global_id

(read-only) Autogenerated, unique database identifier.

priority

User-defined priority assigned to the database.

typechecked

Type checking enablement:
true = Enable type checking.
false = Disable type checking.

data

User-defined document fields. The data field can’t be created.

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!