An enum for the direction of a sort.

Starts listening to theQuerySnapshot events referenced by this query.

Starts listening to theQuerySnapshot events referenced by this query.

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).

Creates and returns a newQuery 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 order by of this query.

Creates and returns a newQuery 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.

Creates and returns a newQuery that ends before 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 order by of this query.

Creates and returns a newQuery 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.

Executes the query and returns the results as aQuerySnapshot.

By default,Get() attempts to provide up-to-date data when possible by waiting for data from the server, but it may return cached data or fail if you are offline and the server cannot be reached. This behavior can be altered via the Source parameter.

Creates and returns a newQuery that only returns the first matching documents up to the specified number.

Creates and returns a newQuery that only returns the last matching documents up to the specified number.

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

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

Creates an invalidQuery that has to be reassigned before it can be used.

Calling any member function on an invalidQuery will be a no-op. If the function returns a value, it will return a zero, empty, or invalid value, depending on the type of the value.

Copy constructor.

Query is immutable and can be efficiently copied.

Move constructor.

Moving is more efficient than copying for aQuery. After being moved from, aQuery is equivalent to its default-constructed state.

Creates and returns a newQuery that starts after 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 order by of this query.

Creates and returns a newQuery 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.

Creates and returns a newQuery 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 order by of this query.

Creates and returns a newQuery 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.

Creates and returns a newQuery with the additional filter.

Creates and returns a newQuery 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.

AQuery can have only oneWhereArrayContains() filter and it cannot be combined withWhereArrayContainsAny() orWhereIn().

Creates and returns a newQuery 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.

AQuery can have only oneWhereArrayContains() filter and it cannot be combined withWhereArrayContainsAny() orWhereIn().

Creates and returns a newQuery 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.

AQuery can have only oneWhereArrayContainsAny() filter and it cannot be combined withWhereArrayContains() orWhereIn().

Creates and returns a newQuery 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.

AQuery can have only oneWhereArrayContainsAny() filter and it cannot be combined withWhereArrayContains() orWhereIn().

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

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

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

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

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

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

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

AQuery can have only oneWhereIn() filter and it cannot be combined withWhereArrayContainsAny().

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

AQuery can have only oneWhereIn() filter and it cannot be combined withWhereArrayContainsAny().

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

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

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

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

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

AQuery can have only oneWhereNotEqualTo() filter, and it cannot be combined withWhereNotIn().

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

AQuery can have only oneWhereNotEqualTo() filter, and it cannot be combined withWhereNotIn().

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

One special case is thatWhereNotIn cannot matchFieldValue::Null() values. To query for documents where a field exists and isFieldValue::Null(), useWhereNotEqualTo, which can handle this special case.

AQuery can have only oneWhereNotIn() filter, and it cannot be combined withWhereArrayContains(),WhereArrayContainsAny(),WhereIn(), orWhereNotEqualTo().

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

One special case is thatWhereNotIn cannot matchFieldValue::Null() values. To query for documents where a field exists and isFieldValue::Null(), useWhereNotEqualTo, which can handle this special case.

AQuery can have only oneWhereNotIn() filter, and it cannot be combined withWhereArrayContains(),WhereArrayContainsAny(),WhereIn(), orWhereNotEqualTo().

Returns theFirestore instance associated with this query.

The pointer will remain valid indefinitely.

Returns theFirestore instance associated with this query.

The pointer will remain valid indefinitely.

Returns true if thisQuery is valid, false if it is not valid.

An invalidQuery could be the result of:

• Creating aQuery using the default constructor.
• Moving from theQuery.
• Deleting yourFirestore instance, which will invalidate all theQuery instances associated with it.

Copy assignment operator.

Query is immutable and can be efficiently copied.

Move assignment operator.

Moving is more efficient than copying for aQuery. After being moved from, aQuery is equivalent to its default-constructed state.