Class StructuredPipeline (2.27.0)

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

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

This is considered the top-level function which plans and executes a query. It is logically equivalent to query(stages, options), but prevents the client from having to build a function wrapper.

Attributes

Name Description
pipeline google.cloud.firestore_v1.types.Pipeline
Required. The pipeline query to execute.
options MutableMapping[str, google.cloud.firestore_v1.types.Value]
Optional. Optional query-level arguments.

Classes

OptionsEntry

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

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.