Package com.google.cloud.firestore

Class CollectionGroup

java.lang.Object

com.google.cloud.firestore.StreamableQuery<QuerySnapshot>

com.google.cloud.firestore.Query

com.google.cloud.firestore.CollectionGroup

public class CollectionGroup
extends Query

A Collection Group query matches all documents that are contained in a collection or subcollection with a specific collection ID.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.cloud.firestore.Query

Query.Direction

Method Summary

Modifier and Type	Method	Description
com.google.api.core.ApiFuture<List<QueryPartition>>	getPartitions(long desiredPartitionCount)
void	getPartitions(long desiredPartitionCount, com.google.api.gax.rpc.ApiStreamObserver<QueryPartition> observer)	Deprecated. Please use getPartitions(long) instead.

Methods inherited from class com.google.cloud.firestore.Query

addSnapshotListener, addSnapshotListener, aggregate, count, endAt, endAt, endBefore, endBefore, equals, explain, explainStream, findNearest, findNearest, findNearest, findNearest, fromProto, get, hashCode, limit, limitToLast, offset, orderBy, orderBy, orderBy, orderBy, select, select, startAfter, startAfter, startAt, startAt, stream, toProto, toRunQueryRequestBuilder, where, whereArrayContains, whereArrayContains, whereArrayContainsAny, whereArrayContainsAny, whereEqualTo, whereEqualTo, whereGreaterThan, whereGreaterThan, whereGreaterThanOrEqualTo, whereGreaterThanOrEqualTo, whereIn, whereIn, whereLessThan, whereLessThan, whereLessThanOrEqualTo, whereLessThanOrEqualTo, whereNotEqualTo, whereNotEqualTo, whereNotIn, whereNotIn

Methods inherited from class com.google.cloud.firestore.StreamableQuery

getFirestore, internalStream

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Details

getPartitions

public void getPartitions(long desiredPartitionCount,
 com.google.api.gax.rpc.ApiStreamObserver<QueryPartition> observer)

Deprecated.

Please use getPartitions(long) instead. All cursors will be loaded before any value will be provided to observer.

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:

desiredPartitionCount - The desired maximum number of partition points. The number must be strictly positive. The actual number of partitions returned may be fewer.

observer - a stream observer that receives the result of the Partition request.

getPartitions

public com.google.api.core.ApiFuture<List<QueryPartition>> getPartitions(long desiredPartitionCount)