Class Pipeline (2.27.0) 

Pipeline(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A Firestore query represented as an ordered list of operations / stages.

Attribute
Name Description
stages MutableSequence[google.cloud.firestore_v1.types.Pipeline.Stage]
Required. Ordered list of stages to evaluate.

Classes

Stage

Stage(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A single operation within a pipeline.

A stage is made up of a unique name, and a list of arguments. The exact number of arguments & types is dependent on the stage type.

To give an example, the stage filter(state = "MD") would be encoded as:

::

name: "filter" args { function_value { name: "eq" args { field_reference_value: "state" } args { string_value: "MD" } } }

See public documentation for the full list.