`Database.byName()`

Signature

Database.byName(name: String) => NamedRef<DatabaseDef>

Description

Gets a child database, represented as an Database document, by its name.

Fauna stores child databases as documents in the parent database’s Database system collection. Database documents have the DatabaseDef type.

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.

Using FQL to create or manage top-level databases is not supported.

Parameters

Parameter Type Required Description

Parameter	Type	Required	Description
name	String	true	`name` of the `Database` document to retrieve.

name

String

true

name of the Database document to retrieve.

Return value

Type Description

Type	Description
NamedRef<DatabaseDef>	Resolved reference to the `Database` document. Can resolve to an existing document or a NullDoc.

NamedRef<DatabaseDef>

Resolved reference to the Database document. Can resolve to an existing document or a NullDoc.

Examples

Database.byName("childDB")

{
  name: "childDB",
  coll: Database,
  ts: Time("2099-06-24T21:54:38.890Z"),
  global_id: "ysjpykbahyyr1",
  priority: 10,
  typechecked: true
}