collection.firstWhere()

Learn: Documents

Get the first collection document that matches a provided predicate.

Signature

firstWhere(pred: (<Document> => Boolean)) => <Document> | Null

Description

Gets the first collection document that matches a provided predicate function.

Performance hint: collection_scan

Queries that call this method emit a performance hint, if enabled. For example:

performance_hint: collection_scan - Using firstWhere() on collection Product can cause a read of every document. See https://docs.faunadb.org/performance_hint/collection_scan.
at *query*:1:19
  |
1 | Product.firstWhere(.name == "limes")
  |                   ^^^^^^^^^^^^^^^^^^
  |

To address the hint, create an index definition with a terms to look up matching documents instead. For example:

collection Product {
  ...
  // Adds `name` as an index term
  index byName {
    terms [.name]
    values [.name, .price, .description, .stock]
  }
  ...
}

Then call the index in your query. Pass an argument for each term in the index definition. To avoid other performance hints, only project or map field values covered by the index definition’s values:

// Get the first product named "limes"
Product.byName("limes").first() {
  name,
  price,
  description,
  stock
}

Parameters

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 the first collection document for which the predicate returns true.

Return value

One of:

Type Description

<Document>

First collection document that matches the predicate.

A document’s data type is taken from its collection’s name. For example, Product for a document in the Product collection. See Document type.

Null

Document doesn’t exist. Returned when no collection document matches the predicate.

Examples

Product.firstWhere(.stock < 20)
{
  id: "999",
  coll: Product,
  ts: Time("2099-07-30T21:56:38.130Z"),
  name: "taco pinata",
  description: "Giant Taco Pinata",
  price: 2399,
  stock: 10,
  category: Category("123")
}
\