Collection

Collection( name, [database] )
Collection( name, [database] )
Collection( name, [database] )
Collection( name, [database] )
collection( name, [database] )
Collection( name, [database] )

Description

The Collection function returns a valid Reference for the specified collection name, in the specified child database. If a child database is not specified, the returned collection reference belongs to the current database.

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

Parameters

Argument Type Definition and Requirements

name

String

The name of a collection.

database

Reference

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

Returns

A reference to a collection with the specified name, in the specified child database (or the current database if database is not specified).

Examples

The following query gets a reference to the collection named "spells" within the current database:

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

fmt.Println(result)
{spells 0xc4202cf140 <nil>}
System.out.println(client.query(Collection(Value("spells"))).get());
ref(id = "spells", collection = ref(id = "collections"))
client.query(q.Collection('spells'))
.then((ret) => console.log(ret))
Ref(id=spells, collection=Ref(id=collections))
client.query(q.collection("spells"))
{ "@ref": "classes/spells" }
client.query(Collection("spells"))
{ "@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!