async def get_partitions(
self,
partition_count,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
) -> AsyncGenerator[QueryPartition, 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.
Args:
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.
"""
request, kwargs = self._prep_get_partitions(partition_count, retry, timeout)
pager = await self._client._firestore_api.partition_query(
request=request, metadata=self._client._rpc_metadata, **kwargs,
)
start_at = None
async for cursor_pb in pager:
cursor = self._client.document(cursor_pb.values[0].reference_value)
yield QueryPartition(self, start_at, cursor)
start_at = cursor
yield QueryPartition(self, start_at, None)
async def get_partitions(
self, partition_count) -> AsyncGenerator[QueryPartition, 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.
Args:
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.
"""
self._validate_partition_query()
query = AsyncQuery(
self._parent,
orders=self._PARTITION_QUERY_ORDER,
start_at=self._start_at,
end_at=self._end_at,
all_descendants=self._all_descendants,
)
parent_path, expected_prefix = self._parent._parent_info()
pager = await self._client._firestore_api.partition_query(
request={
"parent": parent_path,
"structured_query": query._to_protobuf(),
"partition_count": partition_count,
},
metadata=self._client._rpc_metadata,
)
start_at = None
async for cursor_pb in pager:
cursor = self._client.document(cursor_pb.values[0].reference_value)
yield QueryPartition(self, start_at, cursor)
start_at = cursor
yield QueryPartition(self, start_at, None)