Database.byName()
Gets a Database
collection document by its name.
Description
The Database.byName()
method gets a Database
collection document
by its name
field value, if it exists. Each Database
collection
has a name
value.
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.
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 CLI's
cloud-login
command.
Return value
One of:
Type | Description |
---|---|
Child database document. |
|
NullDatabaseDef |
Database doesn’t exist or is inaccessible. |
Examples
Database.byName("childDB")
{
name: "childDB",
coll: Database,
ts: Time("2099-06-24T21:54:38.890Z"),
global_id: "ysjpykbahyyr1",
priority: 10,
typechecked: true
}
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!