Class Query (2.15.0)

Version 2.15.0

• 2.19.0 (latest)
• 2.18.0
• 2.17.2
• 2.16.1
• 2.15.0
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.1
• 2.10.1
• 2.9.1
• 2.8.0
• 2.7.3
• 2.6.1
• 2.5.3
• 2.4.0
• 2.3.4
• 2.2.0
• 2.1.3
• 2.0.2
• 1.9.2
• 1.8.1
• 1.7.0
• 1.6.2
• 1.5.0
• 1.4.0
• 1.3.0

Query(
    parent,
    projection=None,
    field_filters=(),
    orders=(),
    limit=None,
    limit_to_last=False,
    offset=None,
    start_at=None,
    end_at=None,
    all_descendants=False,
    recursive=False,
)

Represents a query to the Firestore API.

Instances of this class are considered immutable: all methods that would modify an instance instead return a new instance.

Parameters
Name	Description
parent	CollectionReference The collection that this query applies to.
projection	Optional[Projection] A projection of document fields to limit the query results to.
field_filters	Optional[Tuple[FieldFilter, ...]] The filters to be applied in the query.
orders	Optional[Tuple[Order, ...]] The "order by" entries to use in the query.
limit	Optional[int] The maximum number of documents the query is allowed to return.
offset	Optional[int] The number of results to skip.
start_at	Optional[Tuple[dict, bool]] Two-tuple of : * a mapping of fields. Any field that is present in this mapping must also be present in orders * an after flag The fields and the flag combine to form a cursor used as a starting point in a query result set. If the after flag is :data:True, the results will start just after any documents which have fields matching the cursor, otherwise any matching documents will be included in the result set. When the query is formed, the document values will be used in the order given by orders.
end_at	Optional[Tuple[dict, bool]] Two-tuple of: * a mapping of fields. Any field that is present in this mapping must also be present in orders * a before flag The fields and the flag combine to form a cursor used as an ending point in a query result set. If the before flag is :data:True, the results will end just before any documents which have fields matching the cursor, otherwise any matching documents will be included in the result set. When the query is formed, the document values will be used in the order given by orders.
all_descendants	Optional[bool] When false, selects only collections that are immediate children of the parent specified in the containing RunQueryRequest. When true, selects all descendant collections.

Methods

avg

avg(
    field_ref: str | FieldPath, alias: str | None = None
) -> Type["firestore_v1.aggregation.AggregationQuery"]

Adds an avg over the query.

Parameters
Name	Description
field_ref	[Union[str, google.cloud.firestore_v1.field_path.FieldPath] The field to aggregate across.
alias	Optional[str] Optional name of the field to store the result of the aggregation into. If not provided, Firestore will pick a default name following the format field_<incremental_id++>.

count

count(
    alias: typing.Optional[str] = None,
) -> typing.Type[google.cloud.firestore_v1.aggregation.AggregationQuery]

Adds a count over the query.

Parameter
Name	Description
alias	Optional[str] Optional name of the field to store the result of the aggregation into. If not provided, Firestore will pick a default name following the format field_<incremental_id++>.

get

get(
    transaction=None,
    retry: google.api_core.retry.retry_unary.Retry = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Optional[float] = None,
) -> typing.List[google.cloud.firestore_v1.base_document.DocumentSnapshot]

Read the documents in the collection that match this query.

This sends a RunQuery RPC and returns a list of documents returned in the stream of RunQueryResponse messages.

Parameters
Name	Description
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried. Defaults to a system-specified policy.
timeout	float The timeout for this request. Defaults to a system-specified value.

Returns
Type	Description
list	The documents in the collection that match this query.

on_snapshot

on_snapshot(callback: typing.Callable) -> google.cloud.firestore_v1.watch.Watch

Monitor the documents in this collection that match this query.

This starts a watch on this query using a background thread. The provided callback is run on the snapshot of the documents.

Parameter
Name	Description
callback	Callable[[QuerySnapshot], NoneType] Example: .. code-block:: python from google.cloud import firestore_v1 db = firestore_v1.Client() query_ref = db.collection(u'users').where("user", "==", u'Ada') def on_snapshot(docs, changes, read_time): for doc in docs: print(u'{} => {}'.format(doc.id, doc.to_dict())) # Watch this query query_watch = query_ref.on_snapshot(on_snapshot) # Terminate this watch query_watch.unsubscribe() a callback to run when a change occurs.

stream

stream(
    transaction=None,
    retry: google.api_core.retry.retry_unary.Retry = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Optional[float] = None,
) -> typing.Generator[
    google.cloud.firestore_v1.base_document.DocumentSnapshot, typing.Any, None
]

Read the documents in the collection that match this query.

This sends a RunQuery RPC and then returns an iterator which consumes each document returned in the stream of RunQueryResponse messages.

Note: The underlying stream of responses will time out after the max_rpc_timeout_millis value set in the GAPIC client configuration for the RunQuery API. Snapshots not consumed from the iterator before that point will be lost.

Parameters
Name	Description
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried. Defaults to a system-specified policy.
timeout	float :Yields: DocumentSnapshot -- The next document that fulfills the query. The timeout for this request. Defaults to a system-specified value.

sum

sum(
    field_ref: str | FieldPath, alias: str | None = None
) -> Type["firestore_v1.aggregation.AggregationQuery"]

Adds a sum over the query.

Parameters
Name	Description
field_ref	Union[str, google.cloud.firestore_v1.field_path.FieldPath] The field to aggregate across.
alias	Optional[str] Optional name of the field to store the result of the aggregation into. If not provided, Firestore will pick a default name following the format field_<incremental_id++>.