`Collection.where()`

Get a Set of collection definitions that match a provided predicate.

Signature

Collection.where(pred: (CollectionDef => Boolean)) => Set<CollectionDef>

Collection documents are FQL versions of a database’s FSL collection schema. Collection documents have the CollectionDef type. See Collections.

If this method is the last expression in a query, the first page of the Set is returned. See Pagination.

If a database has staged schema, this method interacts with the database’s staged schema, not the active schema.

Parameter Type Required Description

Parameter	Type	Required	Description
pred	Predicate function	Yes	Anonymous predicate function that: Accepts a `Collection` document as its only argument. Supports shorthand-syntax. Returns a Boolean value. The method returns a Set of `Collection` documents for which the predicate returns `true`.

pred

Yes

Accepts a Collection document as its only argument. Supports shorthand-syntax.
Returns a Boolean value.

The method returns a Set of Collection documents for which the predicate returns true.

Type Description

Type	Description
Set<CollectionDef>	Set of `Collection` documents that match the predicate. If there are no matching documents, the Set is empty.

Set of Collection documents that match the predicate. If there are no matching documents, the Set is empty.

Collection.where(.name.includes('Prod'))

{
  data: [
    {
      name: "Product",
      coll: Collection,
      ts: Time("2099-04-10T17:01:11.995Z"),
      ...
    }
  ]
}