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.

Some set methods have lazy loading, as opposed to eager loading, in that they compute the result when the data is needed instead of instantly. Eager methods return a result set instantly. Lazy methods return a result set when the query forces the set to be materialized. See the individual method description for whether it is lazy loading or not. For distinct() and order() the full set is read to get the distinct and ordered version when a page on the set is materialized.

Static methods

Method Description

Method	Description
`Set.paginate()`	Gets a page of paginated results using an `after` cursor.
`Set.sequence()`	Get an ordered set of values given beginning and ending values.
`Set.single()`	Creates a Set containing a single provided element.

Set.paginate()

Gets a page of paginated results using an after cursor.

Set.sequence()

Get an ordered set of values given beginning and ending values.

Set.single()

Creates a Set containing a single provided element.

Instance methods

Method Description

Method	Description
`aggregate()`	Aggregate all the elements in the set.
`any()`	Test if any element passes the test of the given function.
`changesOn()`	Creates a stream that tracks changes to specified document fields in a Set.
`concat()`	Create an Set by concatenating two Sets.
`count()`	Get the number of values in a Set.
`distinct()`	Get unique elements.
`drop()`	Drop elements given a count.
`every()`	Test if every set element passes the given function test.
`first()`	Get the first value in the Set.
`firstWhere()`	Get the first matching value from the Set.
`flatMap()`	Create an Set by applying a Function to each Set element, then flatten the result by one level.
`fold()`	Reduce a set to a single, accumulated value by applying a function to each element. Iterates through elements from left to right. Uses a provided seed as the initial value.
`foldRight()`	Reduce a set to a single, accumulated value by applying a function to each element. Iterates through elements from right to left. Uses a provided seed as the initial value.
`forEach()`	Iterate over all values in a Set, executing a function on each value.
`includes()`	Test if the set includes the given value.
`isEmpty()`	Test if the set is empty.
`last()`	Get the last element in a set.
`lastWhere()`	Get the last element that matches the given predicate.
`map()`	Create a Set by applying a function to each Set value.
`nonEmpty()`	Test if the set is empty.
`order()`	Get a new Set by sorting this Set.
`pageSize()`	Sets the maximum elements per page in paginated results.
`paginate()`	Returns the calling Set as an Object with pagination.
`reduce()`	Reduce a set to a single, accumulated value by applying a function to each element. Iterates through elements from left to right. Uses the first element as the initial value.
`reduceRight()`	Reduce a set to a single, accumulated value by applying a function to each element. Iterates through elements from right to left. Uses the first element as the initial value.
`reverse()`	Reverse the order of the set elements.
`take()`	Get a subset of matching Set values.
`toArray()`	Convert a Set to an Array.
`toStream()`	Creates a stream that tracks changes to documents in a Set.
`toString()`	Returns the string `"[set]"`.
`where()`	Get the next or previous page of Set values that correspond to a previously acquired pagination token.

aggregate()

Aggregate all the elements in the set.

any()

Test if any element passes the test of the given function.

changesOn()

Creates a stream that tracks changes to specified document fields in a Set.

concat()

Create an Set by concatenating two Sets.

count()

Get the number of values in a Set.

distinct()

Get unique elements.

drop()

Drop elements given a count.

every()

Test if every set element passes the given function test.

first()

Get the first value in the Set.

firstWhere()

Get the first matching value from the Set.

flatMap()

Create an Set by applying a Function to each Set element, then flatten the result by one level.

fold()

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

foldRight()

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

forEach()

Iterate over all values in a Set, executing a function on each value.

includes()

Test if the set includes the given value.

isEmpty()

Test if the set is empty.

last()

Get the last element in a set.

lastWhere()

Get the last element that matches the given predicate.

map()

Create a Set by applying a function to each Set value.

nonEmpty()

Test if the set is empty.

order()

Get a new Set by sorting this Set.

pageSize()

Sets the maximum elements per page in paginated results.

paginate()

Returns the calling Set as an Object with pagination.

reduce()

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

reduceRight()

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

reverse()

Reverse the order of the set elements.

take()

Get a subset of matching Set values.

toArray()

Convert a Set to an Array.

toStream()

Creates a stream that tracks changes to documents in a Set.

toString()

Returns the string "[set]".

where()

Get the next or previous page of Set values that correspond to a previously acquired pagination token.