Check out v4 of the Fauna CLI

v4 of the Fauna CLI is now in beta.

The new version introduces enhancements to the developer experience, including an improved authentication workflow. To get started, check out the CLI v4 quick start.

Set

Set methods and properties.

Description

A Set represents a group of values, for example, documents in a Collection. When a Set is returned from a query, it is materialized into a page of results that includes a subset of the Set with a pagination cursor.

Lazy vs. Eager loading

To minimize resource consumption, Set methods use lazy loading where possible. These methods defer the materialization of the calling Set and related computations until the data is explicitly needed.

Other Set methods, such as set.includes(), require eager loading. These methods materialize the entire calling Set upfront, even if not all data is returned in the results. For unindexed document Sets, this requires a read of each document in the Set.

Static methods

Method Description

Method	Description
`Set.paginate()`	Get a page of paginated results using an `after` cursor.
`Set.sequence()`	Create an ordered Set of Numbers given start and end values.
`Set.single()`	Create a Set containing a single provided element.

Set.paginate()

Get a page of paginated results using an after cursor.

Set.sequence()

Create an ordered Set of Numbers given start and end values.

Set.single()

Create a Set containing a single provided element.

Instance methods

Method Description

Method	Description
`set.aggregate()`	Aggregate all elements of a Set.
`set.any()`	Test if any element of a Set matches a provided predicate.
`set.changesOn()`	A deprecated alias for `set.eventsOn()`.
`set.concat()`	Concatenate two Sets.
`set.count()`	Get the number of elements in a Set.
`set.distinct()`	Get the unique elements of a Set.
`set.drop()`	Drop the first N elements of a Set.
`set.eventsOn()`	Create an event source that tracks changes to specified document fields in a supported Set.
`set.eventSource()`	Create an event source that tracks changes to documents in a supported Set.
`set.every()`	Test if every element of a Set matches a provided predicate.
`set.first()`	Get the first element of a Set.
`set.firstWhere()`	Get the first element of a Set that matches a provided predicate.
`set.flatMap()`	Apply a provided function to each Set element and flatten the resulting Set by one level.
`set.fold()`	Reduce the Set to a single, accumulated value by applying a provided function to each element. Iterates through elements from left to right. Uses a provided seed as the initial value.
`set.foldRight()`	Reduce a Set to a single, accumulated value by applying a provided function to each element. Iterates through elements from right to left. Uses a provided seed as the initial value.
`set.forEach()`	Run a provided function on each element of a Set. Can perform writes.
`set.includes()`	Test if the Set includes a provided element.
`set.isEmpty()`	Test if a Set is empty.
`set.last()`	Get the last element of a Set.
`set.lastWhere()`	Get the last element of a Set that matches a provided predicate.
`set.map()`	Apply a provided function to each element of a Set. Can’t perform writes.
`set.nonEmpty()`	Test if a Set is not empty.
`set.order()`	Sort a Set's elements.
`set.pageSize()`	Set the maximum elements per page in paginated results.
`set.paginate()`	Convert a Set to an Object with pagination.
`set.reduce()`	Reduce a Set to a single, accumulated value by applying a provided function to each element. Iterates through elements from left to right. Uses the first element as the initial value.
`set.reduceRight()`	Reduce a Set to a single, accumulated value by applying a provided function to each element. Iterates through elements from right to left. Uses the first element as the initial value.
`set.reverse()`	Reverse the order of a Set's elements.
`set.take()`	Get the first N elements of a Set.
`set.toArray()`	Convert a Set to an Array.
`set.toStream()`	A deprecated alias for `set.eventSource()`.
`set.toString()`	Returns the string `"[set]"`.
`set.where()`	Get the elements of a Set that match a provided predicate.

set.aggregate()

Aggregate all elements of a Set.

set.any()

Test if any element of a Set matches a provided predicate.

set.changesOn()

A deprecated alias for set.eventsOn().

set.concat()

Concatenate two Sets.

set.count()

Get the number of elements in a Set.

set.distinct()

Get the unique elements of a Set.

set.drop()

Drop the first N elements of a Set.

set.eventsOn()

Create an event source that tracks changes to specified document fields in a supported Set.

set.eventSource()

Create an event source that tracks changes to documents in a supported Set.

set.every()

Test if every element of a Set matches a provided predicate.

set.first()

Get the first element of a Set.

set.firstWhere()

Get the first element of a Set that matches a provided predicate.

set.flatMap()

Apply a provided function to each Set element and flatten the resulting Set by one level.

set.fold()

Reduce the Set to a single, accumulated value by applying a provided function to each element. Iterates through elements from left to right. Uses a provided seed as the initial value.

set.foldRight()

Reduce a Set to a single, accumulated value by applying a provided function to each element. Iterates through elements from right to left. Uses a provided seed as the initial value.

set.forEach()

Run a provided function on each element of a Set. Can perform writes.

set.includes()

Test if the Set includes a provided element.

set.isEmpty()

Test if a Set is empty.

set.last()

Get the last element of a Set.

set.lastWhere()

Get the last element of a Set that matches a provided predicate.

set.map()

Apply a provided function to each element of a Set. Can’t perform writes.

set.nonEmpty()

Test if a Set is not empty.

set.order()

Sort a Set's elements.

set.pageSize()

Set the maximum elements per page in paginated results.

set.paginate()

Convert a Set to an Object with pagination.

set.reduce()

Reduce a Set to a single, accumulated value by applying a provided function to each element. Iterates through elements from left to right. Uses the first element as the initial value.

set.reduceRight()

Reduce a Set to a single, accumulated value by applying a provided function to each element. Iterates through elements from right to left. Uses the first element as the initial value.

set.reverse()

Reverse the order of a Set's elements.

set.take()

Get the first N elements of a Set.

set.toArray()

Convert a Set to an Array.

set.toStream()

A deprecated alias for set.eventSource().

set.toString()

Returns the string "[set]".

set.where()

Get the elements of a Set that match a provided predicate.