Collections

Collections( [database] )
Collections( [database] )
Collections( [database] )
client.query(Collections( [database] )
collections( [database] )
collections [database]
client.query(Collections( [database] )
Collections( [database] )

Description

The Collections function, when executed with Paginate, returns an array of Refs for all collections in the database specified. If no database is provided, it returns an array of references to all collections in the current database.

Parameters

Argument Type Definition and Requirements

database

Ref

Optional - The target database.

Returns

A schema set reference.

Examples

The query below gets the references to all collections in the current database.

curl https://db.fauna.com/ \
    -u fnAChGwBcAACAO70ziE0cfROosNJHdgBmJU1PgpL: \
    -d '{ "paginate": { "collections": null } }'
client.Query(Paginate(Collections()));
System.out.println(client.query(Paginate(Collections())).get());
result, _ := client.Query(f.Paginate(f.Collections()))

fmt.Println(result)
client.query(Paginate(Collections()))
client.query(q.paginate(q.collections()))
$client.query do
  paginate collections
end
client.query(Paginate(Collections()))
client.query(q.Paginate(q.Collections()))
.then((ret) => console.log(ret))
HTTP/1.1 200 OK
{ "resource": [{ "@ref": "classes/spells" }] }
[{ "@ref": "classes/spells" }]
[ref(id = "spells", collection = ref(id = "collections"))]
[{spells 0xc4202cf140 <nil>}]
[{ "@ref": "classes/spells" }]
[{ "@ref": "classes/spells" }]
[{ "@ref": "classes/spells" }]
[{ "@ref": "classes/spells" }]
[Ref(id=spells, collection=Ref(id=collections))]

Was this article helpful?

We're sorry to hear that.
Tell us how we can improve! documentation@fauna.com

Thank you for your feedback!