CreateDatabase
CreateDatabase( param_object )
CreateDatabase( param_object )
CreateDatabase( param_object )
CreateDatabase( param_object )
create_database( param_object )
CreateDatabase( param_object )
Description
The CreateDatabase
function adds a new database to the cluster with
the specified parameters. It requires an admin key for authentication.
Parameters
Argument | Type | Definition and Requirements |
---|---|---|
|
The param_object fields are described below. |
param_object
Field Name | Field Type | Definition and Requirements | ||
---|---|---|---|---|
|
The name of a database. Databases cannot be named any of the following
reserved words: |
|||
|
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.
|
Returns
An object containing the metadata of CreateDatabase
operations.
Field Name | Field Type | Definition and Requirements |
---|---|---|
|
The reference is an automatically generated unique identifier for 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:
client.Query(
CreateDatabase(Obj("name", "db-next"))
);
ObjectV(ref: RefV(id = "db-next", collection = RefV(id = "databases")),ts: LongV(1603756177320000),name: StringV(db-next),global_id: StringV(yx1enifpkybyy))
result, err := client.Query(
f.CreateDatabase(f.Obj{"name": "db-next"}))
if err != nil {
fmt.Fprintln(os.Stderr, err)
} else {
fmt.Println(result)
}
map[global_id:yx18tp8ogydyy name:db-next ref:{db-next 0xc0000ad290 0xc0000ad290 <nil>} ts:1603747134420000]
System.out.println(
client.query(
CreateDatabase(Obj("name", Value("db-next")))
).get());
{ref: ref(id = "db-next", collection = ref(id = "databases")), ts: 1593464629200000, name: "db-next", global_id: "yq9nin7xhybyy"}
client.query(
q.CreateDatabase({ name: 'db-next' })
)
.then((ret) => console.log(ret))
.catch((err) => console.error('Error: %s', err))
{
ref: Database("db-next"),
ts: 1592054207370000,
name: 'db-next',
global_id: 'yqhq17umsybyy'
}
result = client.query(
q.create_database({"name": "db-next"})
)
{'ref': Ref(id=db-next, collection=Ref(id=databases)), 'ts': 1592856487080000, 'name': 'db-next', 'global_id': 'yq76pr57aybyy'}
client.query(CreateDatabase(Obj("name" -> "db-next")))
{ref: ref(id = "db-next", collection = ref(id = "databases")), ts: 1594485000640000, name: "db-next", global_id: "yxy9xjqqqybyy"}
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!