Class CollectionGroup (2.19.0)
Stay organized with collections
Save and categorize content based on your preferences.
CollectionGroup(
parent,
projection=None,
field_filters=(),
orders=(),
limit=None,
limit_to_last=False,
offset=None,
start_at=None,
end_at=None,
all_descendants=True,
recursive=False,
)Represents a Collection Group in the Firestore API.
This is a specialization of .Query that includes all documents in the
database that are contained in a collection or subcollection of the given
parent.
Parameter |
|
|---|---|
| Name | Description |
parent |
CollectionReference
The collection that this query applies to. |
Methods
get_partitions
get_partitions(
partition_count,
retry: google.api_core.retry.retry_unary.Retry = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Optional[float] = None,
) -> typing.Generator[google.cloud.firestore_v1.base_query.QueryPartition, None, None]Partition a query for parallelization.
Partitions a query by returning partition cursors that can be used to run the query in parallel. The returned partition cursors are split points that can be used as starting/end points for the query results.
| Parameters | |
|---|---|
| Name | Description |
partition_count |
int
The desired maximum number of partition points. The number must be strictly positive. The actual number of partitions returned may be fewer. |
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. |