FirebaseFirestore Framework Reference
Stay organized with collections
Save and categorize content based on your preferences.
QueryPredicate
public enum QueryPredicate
Query predicates that can be used to filter results fetched by FirestoreQuery.
Construct predicates using one of the following ways:
let onlyFavourites: QueryPredicate = .whereField("isFavourite", isEqualTo: true)
let onlyFavourites2: QueryPredicate = .isEqualTo("isFavourite", true)
let onlyFavourites3: QueryPredicate = .where("isFavourite", isEqualTo: true)
-
Declaration
Swift
case isEqualTo(_: String, _: Any)
-
Declaration
Swift
case isIn(_: String, _: [Any])
-
Declaration
Swift
case isNotIn(_: String, _: [Any])
-
Declaration
Swift
case arrayContains(_: String, _: Any)
-
Declaration
Swift
case arrayContainsAny(_: String, _: [Any])
-
Declaration
Swift
case isLessThan(_: String, _: Any)
-
Declaration
Swift
case isGreaterThan(_: String, _: Any)
-
Declaration
Swift
case isLessThanOrEqualTo(_: String, _: Any)
-
Declaration
Swift
case isGreaterThanOrEqualTo(_: String, _: Any)
-
Declaration
Swift
case orderBy(_: String, _: Bool)
-
Declaration
Swift
case limitTo(_: Int)
-
Declaration
Swift
case limitToLast(_: Int)
-
Declaration
Swift
public static func whereField(_ field: String, isEqualTo value: Any) -> QueryPredicate
-
Declaration
Swift
public static func whereField(_ field: String, isIn values: [Any]) -> QueryPredicate
-
Declaration
Swift
public static func whereField(_ field: String, isNotIn values: [Any]) -> QueryPredicate
-
Declaration
Swift
public static func whereField(_ field: String, arrayContains value: Any) -> QueryPredicate
-
Declaration
Swift
public static func whereField(_ field: String,
arrayContainsAny values: [Any]) -> QueryPredicate
-
Declaration
Swift
public static func whereField(_ field: String, isLessThan value: Any) -> QueryPredicate
-
Declaration
Swift
public static func whereField(_ field: String, isGreaterThan value: Any) -> QueryPredicate
-
Declaration
Swift
public static func whereField(_ field: String,
isLessThanOrEqualTo value: Any) -> QueryPredicate
-
Declaration
Swift
public static func whereField(_ field: String,
isGreaterThanOrEqualTo value: Any) -> QueryPredicate
-
Declaration
Swift
public static func order(by field: String, descending value: Bool = false) -> QueryPredicate
-
Declaration
Swift
public static func limit(to value: Int) -> QueryPredicate
-
Declaration
Swift
public static func limit(toLast value: Int) -> QueryPredicate
-
Declaration
Swift
public static func `where`(_ name: String, isEqualTo value: Any) -> QueryPredicate
-
Declaration
Swift
public static func `where`(_ name: String, isIn values: [Any]) -> QueryPredicate
-
Declaration
Swift
public static func `where`(_ name: String, isNotIn values: [Any]) -> QueryPredicate
-
Declaration
Swift
public static func `where`(field name: String, arrayContains value: Any) -> QueryPredicate
-
Declaration
Swift
public static func `where`(_ name: String, arrayContainsAny values: [Any]) -> QueryPredicate
-
Declaration
Swift
public static func `where`(_ name: String, isLessThan value: Any) -> QueryPredicate
-
Declaration
Swift
public static func `where`(_ name: String, isGreaterThan value: Any) -> QueryPredicate
-
Declaration
Swift
public static func `where`(_ name: String, isLessThanOrEqualTo value: Any) -> QueryPredicate
-
Declaration
Swift
public static func `where`(_ name: String,
isGreaterThanOrEqualTo value: Any) -> QueryPredicate
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-11 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-11 UTC."],[],[],null,["# FirebaseFirestore Framework Reference\n\nQueryPredicate\n==============\n\n public enum QueryPredicate\n\nQuery predicates that can be used to filter results fetched by [FirestoreQuery](../Structs/FirestoreQuery.html).\n\nConstruct predicates using one of the following ways: \n\n let onlyFavourites: QueryPredicate = .whereField(\"isFavourite\", isEqualTo: true)\n let onlyFavourites2: QueryPredicate = .isEqualTo(\"isFavourite\", true)\n let onlyFavourites3: QueryPredicate = .where(\"isFavourite\", isEqualTo: true)\n\n- `\n ``\n ``\n `\n\n ### [isEqualTo(_:_:)](#/s:17FirebaseFirestore14QueryPredicateO9isEqualToyACSS_yptcACmF)\n\n `\n ` \n Undocumented \n\n #### Declaration\n\n Swift \n\n case isEqualTo(_: String, _: Any)\n\n- `\n ``\n ``\n `\n\n ### [isIn(_:_:)](#/s:17FirebaseFirestore14QueryPredicateO4isInyACSS_SayypGtcACmF)\n\n `\n ` \n Undocumented \n\n #### Declaration\n\n Swift \n\n case isIn(_: String, _: [Any])\n\n- `\n ``\n ``\n `\n\n ### [isNotIn(_:_:)](#/s:17FirebaseFirestore14QueryPredicateO7isNotInyACSS_SayypGtcACmF)\n\n `\n ` \n Undocumented \n\n #### Declaration\n\n Swift \n\n case isNotIn(_: String, _: [Any])\n\n- `\n ``\n ``\n `\n\n ### [arrayContains(_:_:)](#/s:17FirebaseFirestore14QueryPredicateO13arrayContainsyACSS_yptcACmF)\n\n `\n ` \n Undocumented \n\n #### Declaration\n\n Swift \n\n case arrayContains(_: String, _: Any)\n\n- `\n ``\n ``\n `\n\n ### [arrayContainsAny(_:_:)](#/s:17FirebaseFirestore14QueryPredicateO16arrayContainsAnyyACSS_SayypGtcACmF)\n\n `\n ` \n Undocumented \n\n #### Declaration\n\n Swift \n\n case arrayContainsAny(_: String, _: [Any])\n\n- `\n ``\n ``\n `\n\n ### [isLessThan(_:_:)](#/s:17FirebaseFirestore14QueryPredicateO10isLessThanyACSS_yptcACmF)\n\n `\n ` \n Undocumented \n\n #### Declaration\n\n Swift \n\n case isLessThan(_: String, _: Any)\n\n- `\n ``\n ``\n `\n\n ### [isGreaterThan(_:_:)](#/s:17FirebaseFirestore14QueryPredicateO13isGreaterThanyACSS_yptcACmF)\n\n `\n ` \n Undocumented \n\n #### Declaration\n\n Swift \n\n case isGreaterThan(_: String, _: Any)\n\n- `\n ``\n ``\n `\n\n ### [isLessThanOrEqualTo(_:_:)](#/s:17FirebaseFirestore14QueryPredicateO19isLessThanOrEqualToyACSS_yptcACmF)\n\n `\n ` \n Undocumented \n\n #### Declaration\n\n Swift \n\n case isLessThanOrEqualTo(_: String, _: Any)\n\n- `\n ``\n ``\n `\n\n ### [isGreaterThanOrEqualTo(_:_:)](#/s:17FirebaseFirestore14QueryPredicateO22isGreaterThanOrEqualToyACSS_yptcACmF)\n\n `\n ` \n Undocumented \n\n #### Declaration\n\n Swift \n\n case isGreaterThanOrEqualTo(_: String, _: Any)\n\n- `\n ``\n ``\n `\n\n ### [orderBy(_:_:)](#/s:17FirebaseFirestore14QueryPredicateO7orderByyACSS_SbtcACmF)\n\n `\n ` \n Undocumented \n\n #### Declaration\n\n Swift \n\n case orderBy(_: String, _: Bool)\n\n- `\n ``\n ``\n `\n\n ### [limitTo(_:)](#/s:17FirebaseFirestore14QueryPredicateO7limitToyACSicACmF)\n\n `\n ` \n Undocumented \n\n #### Declaration\n\n Swift \n\n case limitTo(_: Int)\n\n- `\n ``\n ``\n `\n\n ### [limitToLast(_:)](#/s:17FirebaseFirestore14QueryPredicateO11limitToLastyACSicACmF)\n\n `\n ` \n Undocumented \n\n #### Declaration\n\n Swift \n\n case limitToLast(_: Int)\n\n- `\n ``\n ``\n `\n\n ### [whereField(_:isEqualTo:)](#/s:17FirebaseFirestore14QueryPredicateO10whereField_9isEqualToACSS_yptFZ)\n\n `\n ` \n Undocumented \n\n #### Declaration\n\n Swift \n\n public static func whereField(_ field: String, isEqualTo value: Any) -\u003e QueryPredicate\n\n- `\n ``\n ``\n `\n\n ### [whereField(_:isIn:)](#/s:17FirebaseFirestore14QueryPredicateO10whereField_4isInACSS_SayypGtFZ)\n\n `\n ` \n Undocumented \n\n #### Declaration\n\n Swift \n\n public static func whereField(_ field: String, isIn values: [Any]) -\u003e QueryPredicate\n\n- `\n ``\n ``\n `\n\n ### [whereField(_:isNotIn:)](#/s:17FirebaseFirestore14QueryPredicateO10whereField_7isNotInACSS_SayypGtFZ)\n\n `\n ` \n Undocumented \n\n #### Declaration\n\n Swift \n\n public static func whereField(_ field: String, isNotIn values: [Any]) -\u003e QueryPredicate\n\n- `\n ``\n ``\n `\n\n ### [whereField(_:arrayContains:)](#/s:17FirebaseFirestore14QueryPredicateO10whereField_13arrayContainsACSS_yptFZ)\n\n `\n ` \n Undocumented \n\n #### Declaration\n\n Swift \n\n public static func whereField(_ field: String, arrayContains value: Any) -\u003e QueryPredicate\n\n- `\n ``\n ``\n `\n\n ### [whereField(_:arrayContainsAny:)](#/s:17FirebaseFirestore14QueryPredicateO10whereField_16arrayContainsAnyACSS_SayypGtFZ)\n\n `\n ` \n Undocumented \n\n #### Declaration\n\n Swift \n\n public static func whereField(_ field: String,\n arrayContainsAny values: [Any]) -\u003e QueryPredicate\n\n- `\n ``\n ``\n `\n\n ### [whereField(_:isLessThan:)](#/s:17FirebaseFirestore14QueryPredicateO10whereField_10isLessThanACSS_yptFZ)\n\n `\n ` \n Undocumented \n\n #### Declaration\n\n Swift \n\n public static func whereField(_ field: String, isLessThan value: Any) -\u003e QueryPredicate\n\n- `\n ``\n ``\n `\n\n ### [whereField(_:isGreaterThan:)](#/s:17FirebaseFirestore14QueryPredicateO10whereField_13isGreaterThanACSS_yptFZ)\n\n `\n ` \n Undocumented \n\n #### Declaration\n\n Swift \n\n public static func whereField(_ field: String, isGreaterThan value: Any) -\u003e QueryPredicate\n\n- `\n ``\n ``\n `\n\n ### [whereField(_:isLessThanOrEqualTo:)](#/s:17FirebaseFirestore14QueryPredicateO10whereField_19isLessThanOrEqualToACSS_yptFZ)\n\n `\n ` \n Undocumented \n\n #### Declaration\n\n Swift \n\n public static func whereField(_ field: String,\n isLessThanOrEqualTo value: Any) -\u003e QueryPredicate\n\n- `\n ``\n ``\n `\n\n ### [whereField(_:isGreaterThanOrEqualTo:)](#/s:17FirebaseFirestore14QueryPredicateO10whereField_22isGreaterThanOrEqualToACSS_yptFZ)\n\n `\n ` \n Undocumented \n\n #### Declaration\n\n Swift \n\n public static func whereField(_ field: String,\n isGreaterThanOrEqualTo value: Any) -\u003e QueryPredicate\n\n- `\n ``\n ``\n `\n\n ### [order(by:descending:)](#/s:17FirebaseFirestore14QueryPredicateO5order2by10descendingACSS_SbtFZ)\n\n `\n ` \n Undocumented \n\n #### Declaration\n\n Swift \n\n public static func order(by field: String, descending value: Bool = false) -\u003e QueryPredicate\n\n- `\n ``\n ``\n `\n\n ### [limit(to:)](#/s:17FirebaseFirestore14QueryPredicateO5limit2toACSi_tFZ)\n\n `\n ` \n Undocumented \n\n #### Declaration\n\n Swift \n\n public static func limit(to value: Int) -\u003e QueryPredicate\n\n- `\n ``\n ``\n `\n\n ### [limit(toLast:)](#/s:17FirebaseFirestore14QueryPredicateO5limit6toLastACSi_tFZ)\n\n `\n ` \n Undocumented \n\n #### Declaration\n\n Swift \n\n public static func limit(toLast value: Int) -\u003e QueryPredicate\n\n- `\n ``\n ``\n `\n\n ### [where(_:isEqualTo:)](#/s:17FirebaseFirestore14QueryPredicateO5where_9isEqualToACSS_yptFZ)\n\n `\n ` \n Undocumented \n\n #### Declaration\n\n Swift \n\n public static func `where`(_ name: String, isEqualTo value: Any) -\u003e QueryPredicate\n\n- `\n ``\n ``\n `\n\n ### [where(_:isIn:)](#/s:17FirebaseFirestore14QueryPredicateO5where_4isInACSS_SayypGtFZ)\n\n `\n ` \n Undocumented \n\n #### Declaration\n\n Swift \n\n public static func `where`(_ name: String, isIn values: [Any]) -\u003e QueryPredicate\n\n- `\n ``\n ``\n `\n\n ### [where(_:isNotIn:)](#/s:17FirebaseFirestore14QueryPredicateO5where_7isNotInACSS_SayypGtFZ)\n\n `\n ` \n Undocumented \n\n #### Declaration\n\n Swift \n\n public static func `where`(_ name: String, isNotIn values: [Any]) -\u003e QueryPredicate\n\n- `\n ``\n ``\n `\n\n ### [where(field:arrayContains:)](#/s:17FirebaseFirestore14QueryPredicateO5where5field13arrayContainsACSS_yptFZ)\n\n `\n ` \n Undocumented \n\n #### Declaration\n\n Swift \n\n public static func `where`(field name: String, arrayContains value: Any) -\u003e QueryPredicate\n\n- `\n ``\n ``\n `\n\n ### [where(_:arrayContainsAny:)](#/s:17FirebaseFirestore14QueryPredicateO5where_16arrayContainsAnyACSS_SayypGtFZ)\n\n `\n ` \n Undocumented \n\n #### Declaration\n\n Swift \n\n public static func `where`(_ name: String, arrayContainsAny values: [Any]) -\u003e QueryPredicate\n\n- `\n ``\n ``\n `\n\n ### [where(_:isLessThan:)](#/s:17FirebaseFirestore14QueryPredicateO5where_10isLessThanACSS_yptFZ)\n\n `\n ` \n Undocumented \n\n #### Declaration\n\n Swift \n\n public static func `where`(_ name: String, isLessThan value: Any) -\u003e QueryPredicate\n\n- `\n ``\n ``\n `\n\n ### [where(_:isGreaterThan:)](#/s:17FirebaseFirestore14QueryPredicateO5where_13isGreaterThanACSS_yptFZ)\n\n `\n ` \n Undocumented \n\n #### Declaration\n\n Swift \n\n public static func `where`(_ name: String, isGreaterThan value: Any) -\u003e QueryPredicate\n\n- `\n ``\n ``\n `\n\n ### [where(_:isLessThanOrEqualTo:)](#/s:17FirebaseFirestore14QueryPredicateO5where_19isLessThanOrEqualToACSS_yptFZ)\n\n `\n ` \n Undocumented \n\n #### Declaration\n\n Swift \n\n public static func `where`(_ name: String, isLessThanOrEqualTo value: Any) -\u003e QueryPredicate\n\n- `\n ``\n ``\n `\n\n ### [where(_:isGreaterThanOrEqualTo:)](#/s:17FirebaseFirestore14QueryPredicateO5where_22isGreaterThanOrEqualToACSS_yptFZ)\n\n `\n ` \n Undocumented \n\n #### Declaration\n\n Swift \n\n public static func `where`(_ name: String,\n isGreaterThanOrEqualTo value: Any) -\u003e QueryPredicate"]]
