Class Query (3.43.1) (original) (raw)

public class Query extends StreamableQuery<QuerySnapshot>

A Query which you can read or listen to. You can also construct refined Query objects by adding filters and ordering.

Inherited Members

Static Methods

fromProto(Firestore firestore, RunQueryRequest proto)

public static Query fromProto(Firestore firestore, RunQueryRequest proto)

Returns a Query instance that can be used to execute the provided RunQueryRequest.

Only RunQueryRequests that pertain to the same project as the Firestore instance can be deserialized.

Runtime metadata (as required for limitToLast() queries) is not restored and as such, the results for limitToLast() queries will be returned in the original backend order.

Constructors

Query(FirestoreRpcContext<?> rpcContext, Query.QueryOptions queryOptions)

protected Query(FirestoreRpcContext<?> rpcContext, Query.QueryOptions queryOptions)

Methods

addSnapshotListener(EventListener listener)

public ListenerRegistration addSnapshotListener(EventListener<QuerySnapshot> listener)

Starts listening to this query.

addSnapshotListener(Executor executor, EventListener listener)

public ListenerRegistration addSnapshotListener(Executor executor, EventListener<QuerySnapshot> listener)

Starts listening to this query.

aggregate(AggregateField aggregateField1, AggregateField[] aggregateFields)

public AggregateQuery aggregate(AggregateField aggregateField1, AggregateField[] aggregateFields)

Calculates the specified aggregations over the documents in the result set of the given query_without actually downloading the documents_.

Using the returned query to perform aggregations is efficient because only the final aggregation values, not the documents' data, is downloaded. The returned query can perform aggregations of the documents in cases where the result set is prohibitively large to download entirely (thousands of documents).

count()

public AggregateQuery count()

Returns a query that counts the documents in the result set of this query.

The returned query, when executed, counts the documents in the result set of this query_without actually downloading the documents_.

Using the returned query to count the documents is efficient because only the final count, not the documents' data, is downloaded. The returned query can count the documents in cases where the result set is prohibitively large to download entirely (thousands of documents).

endAt(DocumentSnapshot snapshot)

public Query endAt(DocumentSnapshot snapshot)

Creates and returns a new Query that ends at the provided document (inclusive). The end position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of this query.

endAt(Object[] fieldValues)

public Query endAt(Object[] fieldValues)

Creates and returns a new Query that ends at the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

endBefore(DocumentSnapshot snapshot)

public Query endBefore(DocumentSnapshot snapshot)

Creates and returns a new Query that ends before the provided document (exclusive). The end position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of this query.

endBefore(Object[] fieldValues)

public Query endBefore(Object[] fieldValues)

Creates and returns a new Query that ends before the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

equals(Object obj)

public boolean equals(Object obj)

Returns true if this Query is equal to the provided object.

Overrides

explain(ExplainOptions options)

public ApiFuture<ExplainResults<QuerySnapshot>> explain(ExplainOptions options)

Plans and optionally executes this query. Returns an ApiFuture that will be resolved with the planner information, statistics from the query execution (if any), and the query results (if any).

Overrides

explainStream(ExplainOptions options, ApiStreamObserver documentObserver)

public ApiFuture<ExplainMetrics> explainStream(ExplainOptions options, ApiStreamObserver<DocumentSnapshot> documentObserver)

Executes the query, streams the results as a StreamObserver of DocumentSnapshots, and returns an ApiFuture that will be resolved with the associated ExplainMetrics.

findNearest(FieldPath vectorField, VectorValue queryVector, int limit, VectorQuery.DistanceMeasure distanceMeasure)

public VectorQuery findNearest(FieldPath vectorField, VectorValue queryVector, int limit, VectorQuery.DistanceMeasure distanceMeasure)

Returns a VectorQuery that can perform vector distance (similarity) search with given parameters.

The returned query, when executed, performs a distance (similarity) search on the specifiedvectorField against the given queryVector and returns the top documents that are closest to the queryVector.

Only documents whose vectorField field is a VectorValue of the same dimension asqueryVector participate in the query, all other documents are ignored.

VectorValue queryVector = FieldValue.vector(new double[] {41, 42}); VectorQuery vectorQuery = col.findNearest( FieldPath.of("embedding"), queryVector, 10, VectorQuery.DistanceMeasure.EUCLIDEAN); QuerySnapshot querySnapshot = await vectorQuery.get().get(); DocumentSnapshot mostSimilarDocument = querySnapshot.getDocuments().get(0);

findNearest(FieldPath vectorField, VectorValue queryVector, int limit, VectorQuery.DistanceMeasure distanceMeasure, VectorQueryOptions vectorQueryOptions)

public VectorQuery findNearest(FieldPath vectorField, VectorValue queryVector, int limit, VectorQuery.DistanceMeasure distanceMeasure, VectorQueryOptions vectorQueryOptions)

Returns a VectorQuery that can perform vector distance (similarity) search with given parameters.

The returned query, when executed, performs a distance (similarity) search on the specifiedvectorField against the given queryVector and returns the top documents that are closest to the queryVector.

Only documents whose vectorField field is a VectorValue of the same dimension asqueryVector participate in the query, all other documents are ignored.

VectorQuery vectorQuery = col.findNearest( FieldPath.of("embedding"), queryVector, 10, VectorQuery.DistanceMeasure.EUCLIDEAN, FindNearestOptions.newBuilder().setDistanceThreshold(0.11).setDistanceResultField("foo").build()); QuerySnapshot querySnapshot = await vectorQuery.get().get(); DocumentSnapshot mostSimilarDocument = querySnapshot.getDocuments().get(0);

findNearest(String vectorField, double[] queryVector, int limit, VectorQuery.DistanceMeasure distanceMeasure)

public VectorQuery findNearest(String vectorField, double[] queryVector, int limit, VectorQuery.DistanceMeasure distanceMeasure)

Returns a VectorQuery that can perform vector distance (similarity) search with given parameters.

The returned query, when executed, performs a distance (similarity) search on the specifiedvectorField against the given queryVector and returns the top documents that are closest to the queryVector.

Only documents whose vectorField field is a VectorValue of the same dimension asqueryVector participate in the query, all other documents are ignored.

VectorQuery vectorQuery = col.findNearest("embedding", new double[] {41, 42}, 10, VectorQuery.DistanceMeasure.EUCLIDEAN); QuerySnapshot querySnapshot = await vectorQuery.get().get(); DocumentSnapshot mostSimilarDocument = querySnapshot.getDocuments().get(0);

findNearest(String vectorField, double[] queryVector, int limit, VectorQuery.DistanceMeasure distanceMeasure, VectorQueryOptions vectorQueryOptions)

public VectorQuery findNearest(String vectorField, double[] queryVector, int limit, VectorQuery.DistanceMeasure distanceMeasure, VectorQueryOptions vectorQueryOptions)

Returns a VectorQuery that can perform vector distance (similarity) search with given parameters.

The returned query, when executed, performs a distance (similarity) search on the specifiedvectorField against the given queryVector and returns the top documents that are closest to the queryVector.

Only documents whose vectorField field is a VectorValue of the same dimension asqueryVector participate in the query, all other documents are ignored.

VectorQuery vectorQuery = col.findNearest( "embedding", new double[] {41, 42}, 10, VectorQuery.DistanceMeasure.EUCLIDEAN, FindNearestOptions.newBuilder().setDistanceThreshold(0.11).setDistanceResultField("foo").build()); QuerySnapshot querySnapshot = await vectorQuery.get().get(); DocumentSnapshot mostSimilarDocument = querySnapshot.getDocuments().get(0);

get()

public ApiFuture<QuerySnapshot> get()

Executes the query and returns the results as QuerySnapshot.

Overrides

hashCode()

Overrides

limit(int limit)

public Query limit(int limit)

Creates and returns a new Query that only returns the first matching documents.

limitToLast(int limit)

public Query limitToLast(int limit)

Creates and returns a new Query that only returns the last matching documents.

You must specify at least one orderBy clause for limitToLast queries. Otherwise, an java.lang.IllegalStateException is thrown during execution.

Results for limitToLast() queries are only available once all documents are received. Hence, limitToLast() queries cannot be streamed via the #stream(ApiStreamObserver) API.

offset(int offset)

public Query offset(int offset)

Creates and returns a new Query that skips the first n results.

orderBy(FieldPath fieldPath)

public Query orderBy(FieldPath fieldPath)

Creates and returns a new Query that's additionally sorted by the specified field.

orderBy(FieldPath fieldPath, Query.Direction direction)

public Query orderBy(FieldPath fieldPath, Query.Direction direction)

Creates and returns a new Query that's additionally sorted by the specified field, optionally in descending order instead of ascending.

orderBy(String field)

public Query orderBy(String field)

Creates and returns a new Query that's additionally sorted by the specified field.

orderBy(String field, Query.Direction direction)

public Query orderBy(String field, Query.Direction direction)

Creates and returns a new Query that's additionally sorted by the specified field, optionally in descending order instead of ascending.

select(FieldPath[] fieldPaths)

public Query select(FieldPath[] fieldPaths)

Creates and returns a new Query instance that applies a field mask to the result and returns the specified subset of fields. You can specify a list of field paths to return, or use an empty list to only return the references of matching documents.

select(String[] fields)

public Query select(String[] fields)

Creates and returns a new Query instance that applies a field mask to the result and returns the specified subset of fields. You can specify a list of field paths to return, or use an empty list to only return the references of matching documents.

startAfter(DocumentSnapshot snapshot)

public Query startAfter(DocumentSnapshot snapshot)

Creates and returns a new Query that starts after the provided document (exclusive). The starting position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of this query.

startAfter(Object[] fieldValues)

public Query startAfter(Object[] fieldValues)

Creates and returns a new Query that starts after the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

startAt(DocumentSnapshot snapshot)

public Query startAt(DocumentSnapshot snapshot)

Creates and returns a new Query that starts at the provided document (inclusive). The starting position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of this query.

startAt(Object[] fieldValues)

public Query startAt(Object[] fieldValues)

Creates and returns a new Query that starts at the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

stream(ApiStreamObserver responseObserver)

public void stream(ApiStreamObserver<DocumentSnapshot> responseObserver)

Executes the query and streams the results as a StreamObserver of DocumentSnapshots.

toProto()

public RunQueryRequest toProto()

Returns the RunQueryRequest that this Query instance represents. The request contains the serialized form of all Query constraints.

Runtime metadata (as required for limitToLast() queries) is not serialized and as such, the serialized request will return the results in the original backend order.

toRunQueryRequestBuilder(ByteString transactionId, Timestamp readTime, ExplainOptions explainOptions)

protected RunQueryRequest.Builder toRunQueryRequestBuilder(ByteString transactionId, Timestamp readTime, ExplainOptions explainOptions)

where(Filter filter)

public Query where(Filter filter)

Creates and returns a new Query with the additional filter.

whereArrayContains(FieldPath fieldPath, Object value)

public Query whereArrayContains(FieldPath fieldPath, Object value)

Creates and returns a new Query with the additional filter that documents must contain the specified field, the value must be an array, and that the array must contain the provided value.

A Query can have only one whereArrayContains() filter and it cannot be combined with whereArrayContainsAny().

whereArrayContains(String field, Object value)

public Query whereArrayContains(String field, Object value)

Creates and returns a new Query with the additional filter that documents must contain the specified field, the value must be an array, and that the array must contain the provided value.

A Query can have only one whereArrayContains() filter and it cannot be combined with whereArrayContainsAny().

whereArrayContainsAny(FieldPath fieldPath, List<? extends Object> values)

public Query whereArrayContainsAny(FieldPath fieldPath, List<? extends Object> values)

Creates and returns a new Query with the additional filter that documents must contain the specified field, the value must be an array, and that the array must contain at least one value from the provided list.

A Query can have only one whereArrayContainsAny() filter and it cannot be combined with whereArrayContains() or whereIn().

whereArrayContainsAny(String field, List<? extends Object> values)

public Query whereArrayContainsAny(String field, List<? extends Object> values)

Creates and returns a new Query with the additional filter that documents must contain the specified field, the value must be an array, and that the array must contain at least one value from the provided list.

A Query can have only one whereArrayContainsAny() filter and it cannot be combined with whereArrayContains() or whereIn().

whereEqualTo(FieldPath fieldPath, Object value)

public Query whereEqualTo(FieldPath fieldPath, Object value)

Creates and returns a new Query with the additional filter that documents must contain the specified field and the value should be equal to the specified value.

whereEqualTo(String field, Object value)

public Query whereEqualTo(String field, Object value)

Creates and returns a new Query with the additional filter that documents must contain the specified field and the value should be equal to the specified value.

whereGreaterThan(FieldPath fieldPath, Object value)

public Query whereGreaterThan(FieldPath fieldPath, Object value)

Creates and returns a new Query with the additional filter that documents must contain the specified field and the value should be greater than the specified value.

whereGreaterThan(String field, Object value)

public Query whereGreaterThan(String field, Object value)

Creates and returns a new Query with the additional filter that documents must contain the specified field and the value should be greater than the specified value.

whereGreaterThanOrEqualTo(FieldPath fieldPath, Object value)

public Query whereGreaterThanOrEqualTo(FieldPath fieldPath, Object value)

Creates and returns a new Query with the additional filter that documents must contain the specified field and the value should be greater than or equal to the specified value.

whereGreaterThanOrEqualTo(String field, Object value)

public Query whereGreaterThanOrEqualTo(String field, Object value)

Creates and returns a new Query with the additional filter that documents must contain the specified field and the value should be greater than or equal to the specified value.

whereIn(FieldPath fieldPath, List<? extends Object> values)

public Query whereIn(FieldPath fieldPath, List<? extends Object> values)

Creates and returns a new Query with the additional filter that documents must contain the specified field and the value must equal one of the values from the provided list.

A Query can have only one whereIn() filter, and it cannot be combined with whereArrayContainsAny().

whereIn(String field, List<? extends Object> values)

public Query whereIn(String field, List<? extends Object> values)

Creates and returns a new Query with the additional filter that documents must contain the specified field and the value must equal one of the values from the provided list.

A Query can have only one whereIn() filter, and it cannot be combined with whereArrayContainsAny().

whereLessThan(FieldPath fieldPath, Object value)

public Query whereLessThan(FieldPath fieldPath, Object value)

Creates and returns a new Query with the additional filter that documents must contain the specified field and the value should be less than the specified value.

whereLessThan(String field, Object value)

public Query whereLessThan(String field, Object value)

Creates and returns a new Query with the additional filter that documents must contain the specified field and the value should be less than the specified value.

whereLessThanOrEqualTo(FieldPath fieldPath, Object value)

public Query whereLessThanOrEqualTo(FieldPath fieldPath, Object value)

Creates and returns a new Query with the additional filter that documents must contain the specified field and the value should be less or equal to the specified value.

whereLessThanOrEqualTo(String field, Object value)

public Query whereLessThanOrEqualTo(String field, Object value)

Creates and returns a new Query with the additional filter that documents must contain the specified field and the value should be less or equal to the specified value.

whereNotEqualTo(FieldPath fieldPath, Object value)

public Query whereNotEqualTo(FieldPath fieldPath, Object value)

Creates and returns a new Query with the additional filter that documents must contain the specified field and the value does not equal the specified value.

whereNotEqualTo(String field, Object value)

public Query whereNotEqualTo(String field, Object value)

Creates and returns a new Query with the additional filter that documents must contain the specified field and its value does not equal the specified value.

whereNotIn(FieldPath fieldPath, List<? extends Object> values)

public Query whereNotIn(FieldPath fieldPath, List<? extends Object> values)

Creates and returns a new Query with the additional filter that documents must contain the specified field and the value does not equal any of the values from the provided list.

A Query can have only one whereNotIn() filter, and it cannot be combined with whereArrayContains(), whereArrayContainsAny(), whereIn(), or whereNotEqualTo().

whereNotIn(String field, List<? extends Object> values)

public Query whereNotIn(String field, List<? extends Object> values)

Creates and returns a new Query with the additional filter that documents must contain the specified field and the value does not equal any of the values from the provided list.

A Query can have only one whereNotIn() filter and it cannot be combined with whereArrayContains(), whereArrayContainsAny(), whereIn(), or whereNotEqualTo().