Class Query
A query against a collection.
Implements
Namespace: Google.Cloud.Firestore
Assembly: Google.Cloud.Firestore.dll
Syntax
public class Query : IEquatable<Query>Remarks
CollectionReference derives from this class as a "return-all" query against the collection it refers to.
Properties
Database
The database this query will search over.
Declaration
public virtual FirestoreDb Database { get; }Property Value
| Type | Description |
|---|---|
| FirestoreDb |
Methods
Aggregate(AggregateField, params AggregateField[])
Calculates the specified aggregations to return the aggregate query. Multiple aggregations can be performed in a single query.
Declaration
public AggregateQuery Aggregate(AggregateField aggregateField, params AggregateField[] aggregateFields)Parameters
| Type | Name | Description |
|---|---|---|
| AggregateField | aggregateField | Specifies the AggregateField to be calculated. Must not be null. |
| AggregateField[] | aggregateFields | Additional aggregations to be included in the query, if any. Must not be null, but may be empty. |
Returns
| Type | Description |
|---|---|
| AggregateQuery | Returns an AggregateQuery that performs aggregations on the documents in the result set of this query. |
Aggregate(IEnumerable<AggregateField>)
Calculates the specified aggregations to return the aggregate query. Multiple aggregations can be performed in a single query.
Declaration
public AggregateQuery Aggregate(IEnumerable<AggregateField> aggregateFields)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<AggregateField> | aggregateFields | Aggregations to be included in the query. Must not be null, or empty. |
Returns
| Type | Description |
|---|---|
| AggregateQuery | Returns an AggregateQuery that performs aggregations on the documents in the result set of this query. |
Count()
Returns an AggregateQuery with count(*) aggregation applied on this query.
Declaration
public AggregateQuery Count()Returns
| Type | Description |
|---|---|
| AggregateQuery | An instance of AggregateQuery with count(*) aggregation applied. |
EndAt(DocumentSnapshot)
Creates and returns a new query that ends at the document snapshot provided fields relative to the order of the query.
Declaration
public Query EndAt(DocumentSnapshot snapshot)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentSnapshot | snapshot | The snapshot of the document to end at. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the specified end position. |
Remarks
This call replaces any previously specified end position in the query.
EndAt(params object[])
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.
Declaration
public Query EndAt(params object[] fieldValues)Parameters
| Type | Name | Description |
|---|---|---|
| object[] | fieldValues | The field values. Must not be null or empty, or have more values than query has orderings. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the specified end position. |
Remarks
This call replaces any previously specified end position in the query.
EndBefore(DocumentSnapshot)
Creates and returns a new query that ends before the document snapshot provided fields relative to the order of the query.
Declaration
public Query EndBefore(DocumentSnapshot snapshot)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentSnapshot | snapshot | The snapshot of the document to end before. Must not be null. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the specified end position. |
Remarks
This call replaces any previously specified end position in the query.
EndBefore(params object[])
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.
Declaration
public Query EndBefore(params object[] fieldValues)Parameters
| Type | Name | Description |
|---|---|---|
| object[] | fieldValues | The field values. Must not be null or empty, or have more values than query has orderings. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the specified end position. |
Remarks
This call replaces any previously specified end position in the query.
GetHashCode()
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| int |
Overrides
GetSnapshotAsync(CancellationToken)
Asynchronously takes a snapshot of all documents matching the query.
Declaration
public Task<QuerySnapshot> GetSnapshotAsync(CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | A cancellation token for the operation. |
Returns
| Type | Description |
|---|---|
| Task<QuerySnapshot> | A snapshot of documents matching the query. |
Limit(int)
Specifies the maximum number of results to return.
Declaration
public Query Limit(int limit)Parameters
| Type | Name | Description |
|---|---|---|
| int | limit | The maximum number of results to return. Must be greater than or equal to 0. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the specified limit applied. |
Remarks
This call replaces any previously-specified limit in the query.
LimitToLast(int)
Creates and returns a new query that only returns the last limit matching documents.
Declaration
public Query LimitToLast(int limit)Parameters
| Type | Name | Description |
|---|---|---|
| int | limit | The maximum number of results to return. Must be greater than or equal to 0. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the specified limit applied. |
Remarks
You must specify at least one OrderBy(string) clause for limit-to-last queries. Otherwise, an InvalidOperationException is thrown during execution.
Results for limit-to-last queries are only available once all documents are received, which means that these queries cannot be streamed using the StreamAsync(CancellationToken) method.
Listen(Action<QuerySnapshot>, CancellationToken)
Listen to this query for changes. This method is a convenience method over Listen(Func<QuerySnapshot, CancellationToken, Task>, CancellationToken), wrapping a synchronous callback to create an asynchronous one.
Declaration
public FirestoreChangeListener Listen(Action<QuerySnapshot> callback, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| Action<QuerySnapshot> | callback | The callback to invoke each time the query results change. Must not be null. |
| CancellationToken | cancellationToken | Optional cancellation token which may be used to cancel the listening operation. |
Returns
| Type | Description |
|---|---|
| FirestoreChangeListener | A FirestoreChangeListener which may be used to monitor the listening operation and stop it gracefully. |
Listen(Func<QuerySnapshot, CancellationToken, Task>, CancellationToken)
Listen to this query for changes.
Declaration
public FirestoreChangeListener Listen(Func<QuerySnapshot, CancellationToken, Task> callback, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| Func<QuerySnapshot, CancellationToken, Task> | callback | The callback to invoke each time the query results change. Must not be null. |
| CancellationToken | cancellationToken | Optional cancellation token which may be used to cancel the listening operation. |
Returns
| Type | Description |
|---|---|
| FirestoreChangeListener | A FirestoreChangeListener which may be used to monitor the listening operation and stop it gracefully. |
Offset(int)
Specifies a number of results to skip.
Declaration
public Query Offset(int offset)Parameters
| Type | Name | Description |
|---|---|---|
| int | offset | The number of results to skip. Must be greater than or equal to 0. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the specified offset applied. |
Remarks
This call replaces any previously-specified offset in the query.
OrderBy(FieldPath)
Adds an additional ascending ordering by the specified path.
Declaration
public Query OrderBy(FieldPath fieldPath)Parameters
| Type | Name | Description |
|---|---|---|
| FieldPath | fieldPath | The field path to order by. Must not be null. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the additional specified ordering applied. |
Remarks
Unlike LINQ's OrderBy method, this call adds additional subordinate orderings to any
additionally specified. So query.OrderBy("foo").OrderBy("bar") is similar
to a LINQ query.OrderBy(x => x.Foo).ThenBy(x => x.Bar).
This method cannot be called after a start/end cursor has been specified with StartAt(params object[]), StartAfter(params object[]), EndAt(params object[]) or EndBefore(params object[]).
OrderBy(string)
Adds an additional ascending ordering by the specified path.
Declaration
public Query OrderBy(string fieldPath)Parameters
| Type | Name | Description |
|---|---|---|
| string | fieldPath | The dot-separated field path to order by. Must not be null or empty. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the additional specified ordering applied. |
Remarks
Unlike LINQ's OrderBy method, this call adds additional subordinate orderings to any
additionally specified. So query.OrderBy("foo").OrderBy("bar") is similar
to a LINQ query.OrderBy(x => x.Foo).ThenBy(x => x.Bar).
This method cannot be called after a start/end cursor has been specified with StartAt(params object[]), StartAfter(params object[]), EndAt(params object[]) or EndBefore(params object[]).
OrderByDescending(FieldPath)
Adds an additional descending ordering by the specified path.
Declaration
public Query OrderByDescending(FieldPath fieldPath)Parameters
| Type | Name | Description |
|---|---|---|
| FieldPath | fieldPath | The field path to order by. Must not be null. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the additional specified ordering applied. |
Remarks
Unlike LINQ's OrderBy method, this call adds additional subordinate orderings to any
additionally specified. So query.OrderBy("foo").OrderByDescending("bar") is similar
to a LINQ query.OrderBy(x => x.Foo).ThenByDescending(x => x.Bar).
This method cannot be called after a start/end cursor has been specified with StartAt(params object[]), StartAfter(params object[]), EndAt(params object[]) or EndBefore(params object[]).
OrderByDescending(string)
Adds an additional descending ordering by the specified path.
Declaration
public Query OrderByDescending(string fieldPath)Parameters
| Type | Name | Description |
|---|---|---|
| string | fieldPath | The dot-separated field path to order by. Must not be null or empty. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the additional specified ordering applied. |
Remarks
Unlike LINQ's OrderBy method, this call adds additional subordinate orderings to any
additionally specified. So query.OrderBy("foo").OrderByDescending("bar") is similar
to a LINQ query.OrderBy(x => x.Foo).ThenByDescending(x => x.Bar).
This method cannot be called after a start/end cursor has been specified with StartAt(params object[]), StartAfter(params object[]), EndAt(params object[]) or EndBefore(params object[]).
Select(params FieldPath[])
Specifies the field paths to return in the results.
Declaration
public Query Select(params FieldPath[] fieldPaths)Parameters
| Type | Name | Description |
|---|---|---|
| FieldPath[] | fieldPaths | The field paths to select. Must not be null or contain null elements. If this is empty, the document ID is implicitly selected. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the specified projection applied. |
Remarks
This call replaces any previously-specified projections in the query.
Select(params string[])
Specifies the field paths to return in the results.
Declaration
public Query Select(params string[] fieldPaths)Parameters
| Type | Name | Description |
|---|---|---|
| string[] | fieldPaths | The dot-separated field paths to select. Must not be null or empty, or contain null or empty elements. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the specified projection applied. |
Remarks
This call replaces any previously-specified projections in the query.
StartAfter(DocumentSnapshot)
Creates and returns a new query that starts after the document snapshot provided fields relative to the order of the query.
Declaration
public Query StartAfter(DocumentSnapshot snapshot)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentSnapshot | snapshot | The snapshot of the document to start after. Must not be null. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the specified start position. |
Remarks
This call replaces any previously specified start position in the query.
StartAfter(params object[])
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.
Declaration
public Query StartAfter(params object[] fieldValues)Parameters
| Type | Name | Description |
|---|---|---|
| object[] | fieldValues | The field values. Must not be null or empty, or have more values than query has orderings. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the specified start position. |
Remarks
This call replaces any previously specified start position in the query.
StartAt(DocumentSnapshot)
Creates and returns a new query that starts at the document snapshot provided fields relative to the order of the query.
Declaration
public Query StartAt(DocumentSnapshot snapshot)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentSnapshot | snapshot | The snapshot of the document to start at. Must not be null. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the specified start position. |
Remarks
This call replaces any previously specified start position in the query.
StartAt(params object[])
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.
Declaration
public Query StartAt(params object[] fieldValues)Parameters
| Type | Name | Description |
|---|---|---|
| object[] | fieldValues | The field values. Must not be null or empty, or have more values than query has orderings. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the specified start position. |
Remarks
This call replaces any previously specified start position in the query.
StreamAsync(CancellationToken)
Returns an asynchronous sequence of snapshots matching the query.
Declaration
public IAsyncEnumerable<DocumentSnapshot> StreamAsync(CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | The cancellation token to apply to the streaming operation. Note that even if this is None, a cancellation token can still be applied when iterating over the stream, by passing it into GetAsyncEnumerator(CancellationToken). If a cancellation token is passed both to this method and GetAsyncEnumerator, then cancelling either of the tokens will result in the operation being cancelled. |
Returns
| Type | Description |
|---|---|
| IAsyncEnumerable<DocumentSnapshot> | An asynchronous sequence of document snapshots matching the query. |
Remarks
Each time you iterate over the sequence, a new query will be performed.
Where(Filter)
Add the given filter to this query.
Declaration
public Query Where(Filter filter)Parameters
| Type | Name | Description |
|---|---|---|
| Filter | filter | filter to be applied on query, must not be null. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the additional specified filter applied. |
Remarks
This call adds additional filters to any previously-specified ones.
WhereArrayContains(FieldPath, object)
Returns a query with a filter specifying that the value in fieldPath must be an array containing
value.
Declaration
public Query WhereArrayContains(FieldPath fieldPath, object value)Parameters
| Type | Name | Description |
|---|---|---|
| FieldPath | fieldPath | The field path to filter on. Must not be null. |
| object | value | The value to check in the filter. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the additional specified filter applied. |
Remarks
This call adds additional filters to any previously-specified ones.
WhereArrayContains(string, object)
Returns a query with a filter specifying that the value in fieldPath must be an array containing
value.
Declaration
public Query WhereArrayContains(string fieldPath, object value)Parameters
| Type | Name | Description |
|---|---|---|
| string | fieldPath | The dot-separated field path to filter on. Must not be null or empty. |
| object | value | The value to check in the filter. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the additional specified filter applied. |
Remarks
This call adds additional filters to any previously-specified ones.
WhereArrayContainsAny(FieldPath, IEnumerable)
Returns a query with a filter specifying that fieldPath must be
a field present in the document, with a value which is an array containing at least one value in values.
Declaration
public Query WhereArrayContainsAny(FieldPath fieldPath, IEnumerable values)Parameters
| Type | Name | Description |
|---|---|---|
| FieldPath | fieldPath | The field path to filter on. Must not be null. |
| IEnumerable | values | The values to compare in the filter. Must not be null. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the additional specified filter applied. |
Remarks
This call adds additional filters to any previously-specified ones.
WhereArrayContainsAny(string, IEnumerable)
Returns a query with a filter specifying that fieldPath must be
a field present in the document, with a value which is an array containing at least one value in values.
Declaration
public Query WhereArrayContainsAny(string fieldPath, IEnumerable values)Parameters
| Type | Name | Description |
|---|---|---|
| string | fieldPath | The dot-separated field path to filter on. Must not be null or empty. |
| IEnumerable | values | The values to compare in the filter. Must not be null. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the additional specified filter applied. |
Remarks
This call adds additional filters to any previously-specified ones.
WhereEqualTo(FieldPath, object)
Returns a query with a filter specifying that the value in fieldPath must be
equal to value.
Declaration
public Query WhereEqualTo(FieldPath fieldPath, object value)Parameters
| Type | Name | Description |
|---|---|---|
| FieldPath | fieldPath | The field path to filter on. Must not be null. |
| object | value | The value to compare in the filter. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the additional specified filter applied. |
Remarks
This call adds additional filters to any previously-specified ones.
WhereEqualTo(string, object)
Returns a query with a filter specifying that the value in fieldPath must be
equal to value.
Declaration
public Query WhereEqualTo(string fieldPath, object value)Parameters
| Type | Name | Description |
|---|---|---|
| string | fieldPath | The dot-separated field path to filter on. Must not be null or empty. |
| object | value | The value to compare in the filter. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the additional specified filter applied. |
Remarks
This call adds additional filters to any previously-specified ones.
WhereGreaterThan(FieldPath, object)
Returns a query with a filter specifying that the value in fieldPath must be greater than
value.
Declaration
public Query WhereGreaterThan(FieldPath fieldPath, object value)Parameters
| Type | Name | Description |
|---|---|---|
| FieldPath | fieldPath | The field path to filter on. Must not be null. |
| object | value | The value to compare in the filter. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the additional specified filter applied. |
Remarks
This call adds additional filters to any previously-specified ones.
WhereGreaterThan(string, object)
Returns a query with a filter specifying that the value in fieldPath must be greater than
value.
Declaration
public Query WhereGreaterThan(string fieldPath, object value)Parameters
| Type | Name | Description |
|---|---|---|
| string | fieldPath | The dot-separated field path to filter on. Must not be null or empty. |
| object | value | The value to compare in the filter. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the additional specified filter applied. |
Remarks
This call adds additional filters to any previously-specified ones.
WhereGreaterThanOrEqualTo(FieldPath, object)
Returns a query with a filter specifying that the value in fieldPath must be greater than or
equal to value.
Declaration
public Query WhereGreaterThanOrEqualTo(FieldPath fieldPath, object value)Parameters
| Type | Name | Description |
|---|---|---|
| FieldPath | fieldPath | The field path to filter on. Must not be null. |
| object | value | The value to compare in the filter. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the additional specified filter applied. |
Remarks
This call adds additional filters to any previously-specified ones.
WhereGreaterThanOrEqualTo(string, object)
Returns a query with a filter specifying that the value in fieldPath must be greater than or
equal to value.
Declaration
public Query WhereGreaterThanOrEqualTo(string fieldPath, object value)Parameters
| Type | Name | Description |
|---|---|---|
| string | fieldPath | The dot-separated field path to filter on. Must not be null or empty. |
| object | value | The value to compare in the filter. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the additional specified filter applied. |
Remarks
This call adds additional filters to any previously-specified ones.
WhereIn(FieldPath, IEnumerable)
Returns a query with a filter specifying that fieldPath must be
a field present in the document, with a value which is one of the values in values.
Declaration
public Query WhereIn(FieldPath fieldPath, IEnumerable values)Parameters
| Type | Name | Description |
|---|---|---|
| FieldPath | fieldPath | The field path to filter on. Must not be null. |
| IEnumerable | values | The values to compare in the filter. Must not be null. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the additional specified filter applied. |
Remarks
This call adds additional filters to any previously-specified ones.
WhereIn(string, IEnumerable)
Returns a query with a filter specifying that fieldPath must be
a field present in the document, with a value which is one of the values in values.
Declaration
public Query WhereIn(string fieldPath, IEnumerable values)Parameters
| Type | Name | Description |
|---|---|---|
| string | fieldPath | The dot-separated field path to filter on. Must not be null or empty. |
| IEnumerable | values | The values to compare in the filter. Must not be null. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the additional specified filter applied. |
Remarks
This call adds additional filters to any previously-specified ones.
WhereLessThan(FieldPath, object)
Returns a query with a filter specifying that the value in fieldPath must be less than
value.
Declaration
public Query WhereLessThan(FieldPath fieldPath, object value)Parameters
| Type | Name | Description |
|---|---|---|
| FieldPath | fieldPath | The field path to filter on. Must not be null. |
| object | value | The value to compare in the filter. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the additional specified filter applied. |
Remarks
This call adds additional filters to any previously-specified ones.
WhereLessThan(string, object)
Returns a query with a filter specifying that the value in fieldPath must be less than
value.
Declaration
public Query WhereLessThan(string fieldPath, object value)Parameters
| Type | Name | Description |
|---|---|---|
| string | fieldPath | The dot-separated field path to filter on. Must not be null or empty. |
| object | value | The value to compare in the filter. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the additional specified filter applied. |
Remarks
This call adds additional filters to any previously-specified ones.
WhereLessThanOrEqualTo(FieldPath, object)
Returns a query with a filter specifying that the value in fieldPath must be less than or
equal to value.
Declaration
public Query WhereLessThanOrEqualTo(FieldPath fieldPath, object value)Parameters
| Type | Name | Description |
|---|---|---|
| FieldPath | fieldPath | The field path to filter on. Must not be null. |
| object | value | The value to compare in the filter. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the additional specified filter applied. |
Remarks
This call adds additional filters to any previously-specified ones.
WhereLessThanOrEqualTo(string, object)
Returns a query with a filter specifying that the value in fieldPath must be less than or
equal to value.
Declaration
public Query WhereLessThanOrEqualTo(string fieldPath, object value)Parameters
| Type | Name | Description |
|---|---|---|
| string | fieldPath | The dot-separated field path to filter on. Must not be null or empty. |
| object | value | The value to compare in the filter. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the additional specified filter applied. |
Remarks
This call adds additional filters to any previously-specified ones.
WhereNotEqualTo(FieldPath, object)
Returns a query with a filter specifying that the value in fieldPath must not be
equal to value.
Declaration
public Query WhereNotEqualTo(FieldPath fieldPath, object value)Parameters
| Type | Name | Description |
|---|---|---|
| FieldPath | fieldPath | The field path to filter on. Must not be null. |
| object | value | The value to compare in the filter. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the additional specified filter applied. |
Remarks
This call adds additional filters to any previously-specified ones.
WhereNotEqualTo(string, object)
Returns a query with a filter specifying that the value in fieldPath must not be
equal to value.
Declaration
public Query WhereNotEqualTo(string fieldPath, object value)Parameters
| Type | Name | Description |
|---|---|---|
| string | fieldPath | The dot-separated field path to filter on. Must not be null or empty. |
| object | value | The value to compare in the filter. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the additional specified filter applied. |
Remarks
This call adds additional filters to any previously-specified ones.
WhereNotIn(FieldPath, IEnumerable)
Returns a query with a filter specifying that fieldPath must be
a field present in the document, with a value which is not one of the values in values.
Declaration
public Query WhereNotIn(FieldPath fieldPath, IEnumerable values)Parameters
| Type | Name | Description |
|---|---|---|
| FieldPath | fieldPath | The field path to filter on. Must not be null. |
| IEnumerable | values | The values to compare in the filter. Must not be null. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the additional specified filter applied. |
Remarks
This call adds additional filters to any previously-specified ones.
WhereNotIn(string, IEnumerable)
Returns a query with a filter specifying that fieldPath must be
a field present in the document, with a value which is not one of the values in values.
Declaration
public Query WhereNotIn(string fieldPath, IEnumerable values)Parameters
| Type | Name | Description |
|---|---|---|
| string | fieldPath | The dot-separated field path to filter on. Must not be null or empty. |
| IEnumerable | values | The values to compare in the filter. Must not be null. |
Returns
| Type | Description |
|---|---|
| Query | A new query based on the current one, but with the additional specified filter applied. |
Remarks
This call adds additional filters to any previously-specified ones.