Collection

Collection( name, [database] )
Collection( name )
ScopedCollection( 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).

Also, Go does not support optional function parameters, nor function overloading. To specify a child database using the Go driver, call the ScopedCollection function instead of Collection.

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.

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.

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

  1. The following query gets a Reference to the collection named "spells" within the current database:

    try
{
    Value result = await client.Query(
        Collection("spells")
    );
    Console.WriteLine(result);
}
catch (Exception e)
{
    Console.WriteLine($"ERROR: {e.Message}");
}
    RefV(id = "spells", collection = RefV(id = "collections"))
    result, err := client.Query(
	f.Collection("spells"))

if err != nil {
	fmt.Fprintln(os.Stderr, err)
} else {
	fmt.Println(result)
}
    {spells 0xc00008e300 0xc00008e300 <nil>}
    System.out.println(
    client.query(
        Collection("spells")
    ).get());
    ref(id = "spells", collection = ref(id = "collections"))
    client.query(
  q.Collection('spells')
)
.then((ret) => console.log(ret))
.catch((err) => console.error('Error: %s', err))
    Collection("spells")
    result = client.query(
    q.collection("spells")
)
print(result)
    Ref(id=spells, collection=Ref(id=collections))
    try {
  println(Await.result(
    client.query(Collection("spells")),
    5.seconds
  ))
} catch {
  case unknown: Throwable => println("Error: " + unknown.getMessage())
}
    ref(id = "spells", collection = ref(id = "collections"))

  2. The following query gets a Reference to the collection named "spells" within a child database named "child_db":

    try
{
    Value result = await client.Query(
        Collection("spells", Database("child_db"))
    );
    Console.WriteLine(result);
}
catch (Exception e)
{
    Console.WriteLine($"ERROR: {e.Message}");
}
    RefV(id = "spells", collection = RefV(id = "collections"), database = RefV(id = "child_db", collection = RefV(id = "databases")))
    result, err := client.Query(
	f.ScopedCollection("spells", f.Database("child_db")))

if err != nil {
	fmt.Fprintln(os.Stderr, err)
} else {
	fmt.Println(result)
}
    {spells 0xc00008f530 0xc00008f530 0xc00008f590}
    System.out.println(
    client.query(
        Collection("spells", Database("child_db"))
    ).get());
    ref(id = "spells", collection = ref(id = "collections"), database = ref(id = "child_db", collection = ref(id = "databases")))
    client.query(
  q.Collection('spells', q.Database('child_db'))
)
.then((ret) => console.log(ret))
.catch((err) => console.error('Error: %s', err))
    Collection("spells", Database("child_db"))
    result = client.query(
    q.collection("spells", q.database("child_db"))
)
print(result)
    Ref(id=spells, collection=Ref(id=collections), database=Ref(id=child_db, collection=Ref(id=databases)))
    try {
  println(Await.result(
    client.query(Collection("spells", Database("child_db"))),
    5.seconds
  ))
} catch {
  case unknown: Throwable => println("Error: " + unknown.getMessage())
}
    ref(id = "spells", collection = ref(id = "collections"), database = ref(id = "child_db", collection = ref(id = "databases")))

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!