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.

Field Type Definition and Requirements


Cannot be events, sets, self, documents, or _.


The default API version for requests made to this database. Defaults to 2.7.


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


A JSON object. Optional.

Was this article helpful?

We're sorry to hear that.
Tell us how we can improve!

Thank you for your feedback!