FQL v4 will be decommissioned on June 30, 2025. Ensure that you complete your migration from FQL v4 to FQL v10 by that date.

For more details, review the migration guide. Contact support@fauna.com with any questions.

Databases

This reference topic applies to FQL v4. Go to this page for the latest FQL v10 reference topics.

 
Databases( [database] )
databases( [database] )
Databases( )
ScopedDatabases( database )
Databases( [database] )
Databases( [database] )

Description

The Databases function, when executed with Paginate, returns an Array of References for child databases in the specified child database. If a child database is not specified, the returned child database references all belong to the current database.

The Databases function only reports child databases, so finding a database using this function requires you to use an admin key for the current database (a server or client key cannot be used to access any child database).

Parameters

Parameter Type Definition and Requirements

database

Reference

Optional - A Reference to a child database. If not specified, the current database is used.

A Reference to a child database.

Optional - A Reference to a child database. If not specified, the current database is used.

Optional - A Reference to a child database. If not specified, the current database is used.

Optional - A Reference to a child database. If not specified, the current database is used.

Optional - A Reference to a child database. If not specified, the current database is used.

Optional - A Reference to a child database. If not specified, the current database is used.

Returns

A Set Reference for the available databases in the specified child database (or the current database if database is not specified).

Examples

  1. The following query lists the References for any child databases (up to the pagination limit) within the current database:

    client.query(
  q.Paginate(q.Databases())
)
.then((ret) => console.log(ret))
.catch((err) => console.error(
  'Error: [%s] %s: %s',
  err.name,
  err.message,
  err.errors()[0].description,
))
    {
  data: [ Database("prydain"), Database("child_db") ]
}
    result = client.query(
    q.paginate(q.databases())
)
print(result)
    {'data': [Ref(id=prydain, collection=Ref(id=databases)), Ref(id=child_db, collection=Ref(id=databases))]}
    result, err := client.Query(
	f.Paginate(f.Databases()))

if err != nil {
	fmt.Fprintln(os.Stderr, err)
} else {
	fmt.Println(result)
}
    map[data:[{prydain 0xc0001541e0 0xc0001541e0 <nil>} {child_db 0xc0001542d0 0xc0001542d0 <nil>}]]
    try
{
    Value result = await client.Query(
        Paginate(Databases())
    );
    Console.WriteLine(result);
}
catch (Exception e)
{
    Console.WriteLine($"ERROR: {e.Message}");
}
    ObjectV(data: Arr(RefV(id = "prydain", collection = RefV(id = "databases")), RefV(id = "child_db", collection = RefV(id = "databases"))))
    Paginate(Databases())
    { data: [ Database("prydain"), Database("child_db") ] }
    Query metrics:

    •    bytesIn:   31

    •   bytesOut:  158

    • computeOps:    1

    •    readOps:    8

    •   writeOps:    0

    •  readBytes:  292

    • writeBytes:    0

    •  queryTime: 11ms

    •    retries:    0

  2. The following query lists the References for any child databases (up to the pagination limit) within a child database named "child_db":

    client.query(
  q.Paginate(q.Databases(q.Database('prydain')))
)
.then((ret) => console.log(ret))
.catch((err) => console.error(
  'Error: [%s] %s: %s',
  err.name,
  err.message,
  err.errors()[0].description,
))
    { data: [] }
    result = client.query(
    q.paginate(q.databases(q.database("prydain")))
)
print(result)
    {'data': []}
    result, err := client.Query(
	f.Paginate(f.ScopedDatabases(f.Database("prydain"))))

if err != nil {
	fmt.Fprintln(os.Stderr, err)
} else {
	fmt.Println(result)
}
    map[data:[]]
    try
{
    Value result = await client.Query(
        Paginate(Databases(Database("prydain")))
    );
    Console.WriteLine(result);
}
catch (Exception e)
{
    Console.WriteLine($"ERROR: {e.Message}");
}
    ObjectV(data: Arr())
    Paginate(Databases(Database('prydain')))
    { data: [] }
    Query metrics:

    •    bytesIn:   49

    •   bytesOut:   24

    • computeOps:    1

    •    readOps:    8

    •   writeOps:    0

    •  readBytes:  361

    • writeBytes:    0

    •  queryTime: 11ms

    •    retries:    0

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!