PipelineSnapshot

Represents the results of a Firestore pipeline execution.

A PipelineSnapshot contains zero or more PipelineResult objects representing the documents returned by a pipeline query. It provides methods to iterate over the documents and access metadata about the query results.

Constructor

new PipelineSnapshot()

Example

```typescript
const snapshot: PipelineSnapshot = await firestore
  .pipeline()
  .collection('myCollection')
  .where(field('value').greaterThan(10))
  .execute();

snapshot.results.forEach(doc => {
  console.log(doc.id, '=>', doc.data());
});
```

Members

executionTime

The time at which the pipeline producing this result is executed.

explainStats

Return stats from query explain.

If explainOptions.mode was set to execute or left unset, then this returns undefined.

pipeline

The Pipeline on which you called execute() in order to get this PipelineSnapshot.

results

An array of all the results in the PipelineSnapshot.