CreateDatabase
CreateDatabase( param_object )
Description
The CreateDatabase
function adds a new child database in the current
database with the specified parameters. It requires an
admin key.
It is not possible to create a parent or peer database with this function. To create a database outside of the current database, use the Fauna Dashboard. |
Parameters
Parameter | Type | Definition and Requirements |
---|---|---|
|
The |
param_object
Field Name | Field Type | Definition and Requirements | ||
---|---|---|---|---|
|
The name of a database. Cannot be |
|||
|
Optional - A JSON object to contain user-defined metadata for the database. It is provided for the developer to store information at the database level. |
|||
|
Optional - A relative weight between 1 and 500, inclusive, indicating how many resources this database is allowed to utilize. Defaults to 1. A higher number means more resources.
|
|||
|
Optional - A timestamp that indicates the time-to-live for a document,
which is when the document is removed from the collection and can’t be
queried. The document history can continue to be accessed using
the |
Returns
An object containing the metadata of CreateDatabase
operations.
Field Name | Field Type | Definition and Requirements |
---|---|---|
|
A Reference to the database that was created. |
|
|
The name of the database just created. |
|
|
The timestamp, with microsecond resolution, associated with the creation of the database. |
|
|
Included only when specified during database creation. An object containing user-defined metadata for this database. |
|
|
A read-only string that provides a globally-unique identifier for this database. |
Examples
The following query creates a database named "db-next" and returns the reference to the database, the name of the database, and the time the database was created:
{
ref: Database("db-next"),
ts: 1624310358060000,
name: 'db-next',
global_id: 'yoatgw3icybyy'
}
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!