Class CollectionGroup (3.1.0)

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.

Inheritance

java.lang.Object > Query > CollectionGroup

Inherited Members

Query.addSnapshotListener(EventListener<QuerySnapshot>)

Query.addSnapshotListener(Executor,EventListener<QuerySnapshot>)

Query.endAt(DocumentSnapshot)

Query.endAt(Object)

Query.endBefore(DocumentSnapshot)

Query.endBefore(Object)

Query.equals(Object)

Query.fromProto(Firestore,RunQueryRequest)

Query.get()

Query.getFirestore()

Query.hashCode()

Query.limit(int)

Query.limitToLast(int)

Query.offset(int)

Query.orderBy(FieldPath)

Query.orderBy(FieldPath,Query.Direction)

Query.orderBy(String)

Query.orderBy(String,Query.Direction)

Query.select(FieldPath)

Query.select(String)

Query.startAfter(DocumentSnapshot)

Query.startAfter(Object)

Query.startAt(DocumentSnapshot)

Query.startAt(Object)

Query.stream(ApiStreamObserver<DocumentSnapshot>)

Query.toProto()

Query.whereArrayContains(FieldPath,Object)

Query.whereArrayContains(String,Object)

Query.whereArrayContainsAny(FieldPath,List<? extends Object>)

Query.whereArrayContainsAny(String,List<? extends Object>)

Query.whereEqualTo(FieldPath,Object)

Query.whereEqualTo(String,Object)

Query.whereGreaterThan(FieldPath,Object)

Query.whereGreaterThan(String,Object)

Query.whereGreaterThanOrEqualTo(FieldPath,Object)

Query.whereGreaterThanOrEqualTo(String,Object)

Query.whereIn(FieldPath,List<? extends Object>)

Query.whereIn(String,List<? extends Object>)

Query.whereLessThan(FieldPath,Object)

Query.whereLessThan(String,Object)

Query.whereLessThanOrEqualTo(FieldPath,Object)

Query.whereLessThanOrEqualTo(String,Object)

Query.whereNotEqualTo(FieldPath,Object)

Query.whereNotEqualTo(String,Object)

Query.whereNotIn(FieldPath,List<? extends Object>)

Query.whereNotIn(String,List<? extends Object>)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

getPartitions(long desiredPartitionCount)

public ApiFuture<List<QueryPartition>> getPartitions(long desiredPartitionCount)

Parameter

Name	Description
desiredPartitionCount	`long`

Returns

Type	Description
ApiFuture<List<QueryPartition>>

getPartitions(long desiredPartitionCount, ApiStreamObserver<QueryPartition> observer) (deprecated)

public void getPartitions(long desiredPartitionCount, 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

Name	Description
desiredPartitionCount	`long` The desired maximum number of partition points. The number must be strictly positive. The actual number of partitions returned may be fewer.
observer	`ApiStreamObserver<QueryPartition>` a stream observer that receives the result of the Partition request.