FIRQuery


@interface FIRQuery : NSObject

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

  • The FIRFirestore for the Firestore database (useful for performing transactions, etc.).

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic) FIRFirestore *_Nonnull firestore;

Retrieving Data

  • Reads the documents matching this query.

    This method 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. See the getDocuments(source:completion:) method to change this behavior.

    Declaration

    Objective-C

    - (void)getDocumentsWithCompletion:(nonnull FIRQuerySnapshotBlock)completion;

    Parameters

    completion

    a block to execute once the documents have been successfully read. documentSet will be nil only if error is non-nil.

  • Reads the documents matching this query.

    Declaration

    Objective-C

    - (void)getDocumentsWithSource:(FIRFirestoreSource)source
                    completion:(nonnull FIRQuerySnapshotBlock)completion;

    Parameters

    source

    indicates whether the results should be fetched from the cache only (Source.cache), the server only (Source.server), or to attempt the server and fall back to the cache (Source.default).
    completion

    a block to execute once the documents have been successfully read. documentSet will be nil only if error is non-nil.

  • Attaches a listener for QuerySnapshot events.

    Declaration

    Objective-C

    - (nonnull id<FIRListenerRegistration>)addSnapshotListener:
    (nonnull FIRQuerySnapshotBlock)listener;

    Parameters

    listener

    The listener to attach.

    Return Value

    A FIRListenerRegistration that can be used to remove this listener.

  • Attaches a listener for QuerySnapshot events.

    Declaration

    Objective-C

    - (nonnull id<FIRListenerRegistration>)
addSnapshotListenerWithIncludeMetadataChanges:(BOOL)includeMetadataChanges
                                     listener:(nonnull FIRQuerySnapshotBlock)
                                                  listener;

    Parameters

    includeMetadataChanges

    Whether metadata-only changes (i.e. only FIRDocumentSnapshot.metadata changed) should trigger snapshot events.
    listener

    The listener to attach.

    Return Value

    A FIRListenerRegistration that can be used to remove this listener.

Filtering Data

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

    Declaration

    Objective-C

    - (nonnull FIRQuery *)queryWhereField:(nonnull NSString *)field
                            isEqualTo:(nonnull id)value;

    Parameters

    field

    The name of the field to compare.
    value

    The value the field must be equal to.

    Return Value

    The created FIRQuery.

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

    Declaration

    Objective-C

    - (nonnull FIRQuery *)queryWhereFieldPath:(nonnull FIRFieldPath *)path
                                isEqualTo:(nonnull id)value;

    Parameters

    path

    The path of the field to compare.
    value

    The value the field must be equal to.

    Return Value

    The created FIRQuery.

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

    Declaration

    Objective-C

    - (nonnull FIRQuery *)queryWhereField:(nonnull NSString *)field
                           isLessThan:(nonnull id)value;

    Parameters

    field

    The name of the field to compare.
    value

    The value the field must be less than.

    Return Value

    The created FIRQuery.

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

    Declaration

    Objective-C

    - (nonnull FIRQuery *)queryWhereFieldPath:(nonnull FIRFieldPath *)path
                               isLessThan:(nonnull id)value;

    Parameters

    path

    The path of the field to compare.
    value

    The value the field must be less than.

    Return Value

    The created FIRQuery.

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

    Declaration

    Objective-C

    - (nonnull FIRQuery *)queryWhereField:(nonnull NSString *)field
                  isLessThanOrEqualTo:(nonnull id)value;

    Parameters

    field

    The name of the field to compare
    value

    The value the field must be less than or equal to.

    Return Value

    The created FIRQuery.

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

    Declaration

    Objective-C

    - (nonnull FIRQuery *)queryWhereFieldPath:(nonnull FIRFieldPath *)path
                      isLessThanOrEqualTo:(nonnull id)value;

    Parameters

    path

    The path of the field to compare
    value

    The value the field must be less than or equal to.

    Return Value

    The created FIRQuery.

  • Creates and returns a new FIRQuery with the additional filter that documents must contain the specified field and the value must greater than the specified value.

    Declaration

    Objective-C

    - (nonnull FIRQuery *)queryWhereField:(nonnull NSString *)field
                        isGreaterThan:(nonnull id)value;

    Parameters

    field

    The name of the field to compare
    value

    The value the field must be greater than.

    Return Value

    The created FIRQuery.

  • Creates and returns a new FIRQuery with the additional filter that documents must contain the specified field and the value must greater than the specified value.

    Declaration

    Objective-C

    - (nonnull FIRQuery *)queryWhereFieldPath:(nonnull FIRFieldPath *)path
                            isGreaterThan:(nonnull id)value;

    Parameters

    path

    The path of the field to compare
    value

    The value the field must be greater than.

    Return Value

    The created FIRQuery.

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

    Declaration

    Objective-C

    - (nonnull FIRQuery *)queryWhereField:(nonnull NSString *)field
               isGreaterThanOrEqualTo:(nonnull id)value;

    Parameters

    field

    The name of the field to compare
    value

    The value the field must be greater than.

    Return Value

    The created FIRQuery.

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

    Declaration

    Objective-C

    - (nonnull FIRQuery *)queryWhereFieldPath:(nonnull FIRFieldPath *)path
                   isGreaterThanOrEqualTo:(nonnull id)value;

    Parameters

    path

    The path of the field to compare
    value

    The value the field must be greater than.

    Return Value

    The created FIRQuery.

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

    A query can have only one arrayContains filter.

    Declaration

    Objective-C

    - (nonnull FIRQuery *)queryWhereField:(nonnull NSString *)field
                        arrayContains:(nonnull id)value;

    Parameters

    field

    The name of the field containing an array to search
    value

    The value that must be contained in the array

    Return Value

    The created FIRQuery.

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

    A query can have only one arrayContains filter.

    Declaration

    Objective-C

    - (nonnull FIRQuery *)queryWhereFieldPath:(nonnull FIRFieldPath *)path
                            arrayContains:(nonnull id)value;

    Parameters

    path

    The path of the field containing an array to search
    value

    The value that must be contained in the array

    Return Value

    The created FIRQuery.

  • Creates and returns a new FIRQuery with the additional filter that documents must satisfy the specified predicate.

    Declaration

    Objective-C

    - (nonnull FIRQuery *)queryFilteredUsingPredicate:
    (nonnull NSPredicate *)predicate;

    Parameters

    predicate

    The predicate the document must satisfy. Can be either comparison or compound of comparison. In particular, block-based predicate is not supported.

    Return Value

    The created FIRQuery.

Sorting Data

  • Creates and returns a new FIRQuery that’s additionally sorted by the specified field.

    Declaration

    Objective-C

    - (nonnull FIRQuery *)queryOrderedByField:(nonnull NSString *)field;

    Parameters

    field

    The field to sort by.

    Return Value

    The created FIRQuery.

  • Creates and returns a new FIRQuery that’s additionally sorted by the specified field.

    Declaration

    Objective-C

    - (nonnull FIRQuery *)queryOrderedByFieldPath:(nonnull FIRFieldPath *)path;

    Parameters

    path

    The field to sort by.

    Return Value

    The created FIRQuery.

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

    Declaration

    Objective-C

    - (nonnull FIRQuery *)queryOrderedByField:(nonnull NSString *)field
                               descending:(BOOL)descending;

    Parameters

    field

    The field to sort by.
    descending

    Whether to sort descending.

    Return Value

    The created FIRQuery.

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

    Declaration

    Objective-C

    - (nonnull FIRQuery *)queryOrderedByFieldPath:(nonnull FIRFieldPath *)path
                                   descending:(BOOL)descending;

    Parameters

    path

    The field to sort by.
    descending

    Whether to sort descending.

    Return Value

    The created FIRQuery.

Limiting Data

  • Creates and returns a new FIRQuery that’s additionally limited to only return up to the specified number of documents.

    Declaration

    Objective-C

    - (nonnull FIRQuery *)queryLimitedTo:(NSInteger)limit;

    Parameters

    limit

    The maximum number of items to return.

    Return Value

    The created FIRQuery.

Choosing Endpoints

  • Creates and returns a new FIRQuery 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.

    Declaration

    Objective-C

    - (nonnull FIRQuery *)queryStartingAtDocument:
    (nonnull FIRDocumentSnapshot *)document;

    Parameters

    document

    The snapshot of the document to start at.

    Return Value

    The created FIRQuery.

  • Creates and returns a new FIRQuery 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

    Objective-C

    - (nonnull FIRQuery *)queryStartingAtValues:(nonnull NSArray *)fieldValues;

    Parameters

    fieldValues

    The field values to start this query at, in order of the query’s order by.

    Return Value

    The created FIRQuery.

  • Creates and returns a new FIRQuery 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.

    Declaration

    Objective-C

    - (nonnull FIRQuery *)queryStartingAfterDocument:
    (nonnull FIRDocumentSnapshot *)document;

    Parameters

    document

    The snapshot of the document to start after.

    Return Value

    The created FIRQuery.

  • Creates and returns a new FIRQuery 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

    Objective-C

    - (nonnull FIRQuery *)queryStartingAfterValues:(nonnull NSArray *)fieldValues;

    Parameters

    fieldValues

    The field values to start this query after, in order of the query’s order by.

    Return Value

    The created FIRQuery.

  • Creates and returns a new FIRQuery 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.

    Declaration

    Objective-C

    - (nonnull FIRQuery *)queryEndingBeforeDocument:
    (nonnull FIRDocumentSnapshot *)document;

    Parameters

    document

    The snapshot of the document to end before.

    Return Value

    The created FIRQuery.

  • Creates and returns a new FIRQuery 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

    Objective-C

    - (nonnull FIRQuery *)queryEndingBeforeValues:(nonnull NSArray *)fieldValues;

    Parameters

    fieldValues

    The field values to end this query before, in order of the query’s order by.

    Return Value

    The created FIRQuery.

  • Creates and returns a new FIRQuery that ends at 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.

    Declaration

    Objective-C

    - (nonnull FIRQuery *)queryEndingAtDocument:
    (nonnull FIRDocumentSnapshot *)document;

    Parameters

    document

    The snapshot of the document to end at.

    Return Value

    The created FIRQuery.

  • Creates and returns a new FIRQuery 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

    Objective-C

    - (nonnull FIRQuery *)queryEndingAtValues:(nonnull NSArray *)fieldValues;

    Parameters

    fieldValues

    The field values to end this query at, in order of the query’s order by.

    Return Value

    The created FIRQuery.