firebase-firestore/com.google.firebase.firestore/PipelineSource

PipelineSource

class PipelineSource(source)

The sources of the pipelines of a FirebaseFirestore, from FirebaseFirestore.pipeline.

Types

object Companion

Functions

fun collection(ref: CollectionReference): Pipeline

A pipeline over the documents of the collection ref.

fun collection(path: String): Pipeline

A pipeline over the documents of the collection at path.

fun collection(ref: CollectionReference, options: CollectionSourceOptions): Pipeline

A pipeline over the documents of the collection ref, with options.

collectionGroup

fun collectionGroup(collectionId: String): Pipeline

A pipeline over the documents of every collection with the id collectionId.

fun collectionGroup(collectionId: String, options: CollectionGroupOptions): Pipeline

A pipeline over the documents of every collection with the id collectionId, with options.

fun createFrom(aggregateQuery: AggregateQuery): Pipeline

A pipeline computing the aggregations of aggregateQuery, by their aliases.

fun createFrom(query: Query): Pipeline

A pipeline over the results of query, with its filters, order, limits and cursors as stages.

fun database(): Pipeline

A pipeline over every document of the database.

fun documents(vararg documents: DocumentReference): Pipeline

A pipeline over documents.

fun documents(vararg documents: String): Pipeline

A pipeline over the documents at the paths documents.

fun literals(vararg data: Map<String, Any?>): Pipeline

A pipeline over the literal documents data, one per map: values are constants or expressions, also nested in maps and lists (FieldValue sentinels are not supported). To give a document a path, set its __name__ to a DocumentReference.