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

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())
);
ObjectV(data: Arr(RefV(id = "Letters", collection = RefV(id = "collections")), RefV(id = "People", collection = RefV(id = "collections")), RefV(id = "characters", collection = RefV(id = "collections")), RefV(id = "customers", collection = RefV(id = "collections")), RefV(id = "decrepit_huts", collection = RefV(id = "collections")), RefV(id = "magical_creatures", collection = RefV(id = "collections")), RefV(id = "orders", collection = RefV(id = "collections")), RefV(id = "posts", collection = RefV(id = "collections")), RefV(id = "products", collection = RefV(id = "collections")), RefV(id = "spellbooks", collection = RefV(id = "collections")), RefV(id = "spells", collection = RefV(id = "collections")), RefV(id = "storehouses", collection = RefV(id = "collections")), RefV(id = "users", collection = RefV(id = "collections"))))
result, err := client.Query(
	f.Paginate(f.Collections()))

if err != nil {
	fmt.Fprintln(os.Stderr, err)
} else {
	fmt.Println(result)
}
map[data:[{Letters 0xc00013e180 0xc00013e180 <nil>} {People 0xc00013e270 0xc00013e270 <nil>} {characters 0xc00013e360 0xc00013e360 <nil>} {customers 0xc00013e450 0xc00013e450 <nil>} {decrepit_huts 0xc00013e540 0xc00013e540 <nil>} {magical_creatures 0xc00013e630 0xc00013e630 <nil>} {orders 0xc000092150 0xc000092150 <nil>} {posts 0xc000092240 0xc000092240 <nil>} {products 0xc000092330 0xc000092330 <nil>} {spellbooks 0xc000092420 0xc000092420 <nil>} {spells 0xc000092510 0xc000092510 <nil>} {storehouses 0xc000092600 0xc000092600 <nil>} {users 0xc0000926f0 0xc0000926f0 <nil>}]]
System.out.println(
    client.query(
        Paginate(Collections())
    ).get());
{data: [ref(id = "Letters", collection = ref(id = "collections")), ref(id = "People", collection = ref(id = "collections")), ref(id = "characters", collection = ref(id = "collections")), ref(id = "customers", collection = ref(id = "collections")), ref(id = "decrepit_huts", collection = ref(id = "collections")), ref(id = "magical_creatures", collection = ref(id = "collections")), ref(id = "orders", collection = ref(id = "collections")), ref(id = "posts", collection = ref(id = "collections")), ref(id = "products", collection = ref(id = "collections")), ref(id = "spellbooks", collection = ref(id = "collections")), ref(id = "spells", collection = ref(id = "collections")), ref(id = "storehouses", collection = ref(id = "collections")), ref(id = "users", collection = ref(id = "collections"))]}
client.query(
  q.Paginate(q.Collections())
)
.then((ret) => console.log(ret))
.catch((err) => console.error('Error: %s', err))
{
  data: [
    Collection("Letters"),
    Collection("People"),
    Collection("characters"),
    Collection("customers"),
    Collection("decrepit_huts"),
    Collection("magical_creatures"),
    Collection("orders"),
    Collection("posts"),
    Collection("products"),
    Collection("spellbooks"),
    Collection("spells"),
    Collection("storehouses"),
    Collection("users")
  ]
}
result = client.query(
    q.paginate(q.collections())
)
print(result)
{'data': [Ref(id=Letters, collection=Ref(id=collections)), Ref(id=People, collection=Ref(id=collections)), Ref(id=characters, collection=Ref(id=collections)), Ref(id=customers, collection=Ref(id=collections)), Ref(id=decrepit_huts, collection=Ref(id=collections)), Ref(id=magical_creatures, collection=Ref(id=collections)), Ref(id=orders, collection=Ref(id=collections)), Ref(id=posts, collection=Ref(id=collections)), Ref(id=products, collection=Ref(id=collections)), Ref(id=spellbooks, collection=Ref(id=collections)), Ref(id=spells, collection=Ref(id=collections)), Ref(id=storehouses, collection=Ref(id=collections)), Ref(id=users, collection=Ref(id=collections))]}
client.query(Paginate(Collections()))
{data: [ref(id = "Letters", collection = ref(id = "collections")), ref(id = "People", collection = ref(id = "collections")), ref(id = "characters", collection = ref(id = "collections")), ref(id = "customers", collection = ref(id = "collections")), ref(id = "decrepit_huts", collection = ref(id = "collections")), ref(id = "magical_creatures", collection = ref(id = "collections")), ref(id = "orders", collection = ref(id = "collections")), ref(id = "posts", collection = ref(id = "collections")), ref(id = "products", collection = ref(id = "collections")), ref(id = "spellbooks", collection = ref(id = "collections")), ref(id = "spells", collection = ref(id = "collections")), ref(id = "storehouses", collection = ref(id = "collections")), ref(id = "users", collection = ref(id = "collections"))]}

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!