AsyncQuery(
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 |
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 |
all_descendants |
Optional[bool]
When false, selects only collections that are immediate children of the |
recursive |
Optional[bool]
When true, returns all documents and all documents in any subcollections below them. Defaults to false. |
Methods
avg
avg(
field_ref: str | FieldPath, alias: str | None = None
) -> Type["firestore_v1.async_aggregation.AsyncAggregationQuery"]
Adds an avg over the nested 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++>. |
Returns | |
---|---|
Type | Description |
AsyncAggregationQuery | An instance of an AsyncAggregationQuery object |
count
count(
alias: str | None = None,
) -> Type["firestore_v1.async_aggregation.AsyncAggregationQuery"]
Adds a count over the nested 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++>. |
Returns | |
---|---|
Type | Description |
AsyncAggregationQuery | An instance of an AsyncAggregationQuery object |
get
get(
transaction: Transaction = None,
retry: retries.Retry = _MethodDefault._DEFAULT_VALUE,
timeout: float = None,
) -> list
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 If a
The timeout for this request. Defaults to a system-specified value. |
Returns | |
---|---|
Type | Description |
list | The documents in the collection that match this query. |
stream
stream(
transaction=None,
retry: google.api_core.retry.Retry = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Optional[float] = None,
) -> typing.AsyncGenerator[
google.cloud.firestore_v1.base_document.DocumentSnapshot, 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.
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.async_aggregation.AsyncAggregationQuery"]
Adds a sum over the nested 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++>. |
Returns | |
---|---|
Type | Description |
AsyncAggregationQuery | An instance of an AsyncAggregationQuery object |