Collections

Collections( [database] )
Collections( [database] )
Collections( [database] )
Collections( [database] )
collections( [database] )
Collections( [database] )

Description

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

When a child database is specified, an admin key must be used to call Collections (server or client keys, or ABAC tokens, cannot be used to access a child database).

Parameters

Argument Type Definition and Requirements

database

Reference

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

Returns

A set reference for the available collections in the specified child database (or the current database if database is not specified).

Examples

The following query gets the references to all collections within the current database:

client.Query(Paginate(Collections()));
[{ "@ref": "classes/spells" }]
curl https://db.fauna.com/ \
    -u fnAChGwBcAACAO70ziE0cfROosNJHdgBmJU1PgpL: \
    -d '{ "paginate": { "collections": null } }'
HTTP/1.1 200 OK
{ "resource": [{ "@ref": "classes/spells" }] }
result, _ := client.Query(f.Paginate(f.Collections()))

fmt.Println(result)
[{spells 0xc4202cf140 <nil>}]
System.out.println(client.query(Paginate(Collections())).get());
[ref(id = "spells", collection = ref(id = "collections"))]
client.query(q.Paginate(q.Collections()))
.then((ret) => console.log(ret))
[Ref(id=spells, collection=Ref(id=collections))]
client.query(q.paginate(q.collections()))
[{ "@ref": "classes/spells" }]
client.query(Paginate(Collections()))
[{ "@ref": "classes/spells" }]

Was this article helpful?

We're sorry to hear that.
Tell us how we can improve!
 Visit Fauna's Discourse forums or email docs@fauna.com

Thank you for your feedback!