Collection

Learn: Collection schema

We recommend you use FSL to create and update user-defined collections. See Collection schema.

Fauna stores user-defined collections as documents in the Collection system collection.

These documents act as an FQL version of the FSL collection schema. See Collection document definition.

You can use the following methods to access user-defined collections in FQL.

Static methods

Method Description

Collection()

Dynamically get the Collection by name.

Collection.all()

Get the set of all accessible Collection objects.

Collection.byName()

Get a Collection document by its name.

Collection.create()

Create a Collection.

Collection.firstWhere()

Get the first matching accessible Collection.

Collection.toString()

Get the name of the Collection collection as a string.

Collection.where()

Get the set of accessible Collections in the database.

Instance methods

Method Description

all()

Get the set of all documents in the Collection.

byId()

Get a document by its document ID.

create()

Create a document in the Collection.

createData()

Create a document in the Collection with a data field.

delete()

Delete the Collection instance.

exists()

Test if a Collection exists.

firstWhere()

Get the first matching accessible document in the Collection.

where()

Get the set of matching accessible documents in the Collection.

<indexName>()

Get the Set of matching documents in the defined Collection index.

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!