Class PipelineSource (3.35.1)

A factory for creating Pipeline instances, which provide a framework for building data transformation and query pipelines for Firestore.

Start by calling Firestore#pipeline() to obtain an instance of PipelineSource. From there, you can use the provided methods (like #collection(String)) to specify the data source for your pipeline.

This class is typically used to start building Firestore pipelines. It allows you to define the initial data source for a pipeline.

Example Usage:

 firestore.pipeline() // Get a PipelineSource instance
   .collection("users") // Create a pipeline that operates on a collection
   .select("name"); // Add stages to the pipeline
 

Creates a new Pipeline that operates on the specified Firestore collection.

Creates a new Pipeline that operates on all documents in a collection group.

A collection group consists of all collections with the same ID. For example, if you have collections named "users" under different documents, you can query them together using a collection group query.

Creates a new Pipeline from the given AggregateQuery. Under the hood, this will translate the query semantics (order by document ID, etc.) to an equivalent pipeline.

Creates a new Pipeline from the given Query. Under the hood, this will translate the query semantics (order by document ID, etc.) to an equivalent pipeline.

Creates a new Pipeline that operates on all documents in the Firestore database.

Use this method with caution as it can lead to very large result sets. It is usually only useful at development stage.

Creates a new Pipeline that operates on a specific set of Firestore documents.

Creates a new Pipeline that operates on a specific set of Firestore documents.