Collection

Copied!
( 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

Parameter Type Definition and Requirements

name

The name of a collection.

database

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:

    Copied!
    ('spells')
    ("spells")
    Query metrics:
    •    bytesIn:  23

    •   bytesOut:  80

    • computeOps:   1

    •    readOps:   0

    •   writeOps:   0

    •  readBytes:   0

    • writeBytes:   0

    •  queryTime: 4ms

    •    retries:   0

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

    Copied!
    ('spells', ('child_db'))
    ("spells", ("child_db"))
    Query metrics:
    •    bytesIn:   55

    •   bytesOut:  159

    • computeOps:    1

    •    readOps:    0

    •   writeOps:    0

    •  readBytes:  155

    • writeBytes:    0

    •  queryTime: 10ms

    •    retries:    0

Is this article helpful? 

Tell Fauna how the article can be improved:
Visit Fauna's forums or email docs@fauna.com

Thank you for your feedback!