Collection

Collection methods and properties.

Description

The Collection object gives ways to query or create collection documents.

Collections exist as top-level objects in the FQL global namespace. A Collection object is analogous to a table in a relational database. Each collection has a collection definition document stored in a Fauna database and has properties and methods to query, create, or change documents in the collection.

See the Aliasing section on collection naming.

Document definition

Collection document definition

Index definition

Indexes definition

Constraint definitions

Computed field definition

Static methods

Method Description

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.

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

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.
`replace()`	Replace the existing fields with the provided fields.
`update()`	Add the provided fields to the existing fields.
`where()`	Get the set of matching accessible documents in the Collection.
`<indexName>()`	Get the Set of matching documents in the defined Collection index.

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.