FirebaseFirestore Framework Reference

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)

• isEqualTo(_:_:)

  Undocumented

  Declaration

  Swift

  case isEqualTo(_: String, _: Any)

• isIn(_:_:)

  Undocumented

  Declaration

  Swift

  case isIn(_: String, _: [Any])

• isNotIn(_:_:)

  Undocumented

  Declaration

  Swift

  case isNotIn(_: String, _: [Any])

• arrayContains(_:_:)

  Undocumented

  Declaration

  Swift

  case arrayContains(_: String, _: Any)

• arrayContainsAny(_:_:)

  Undocumented

  Declaration

  Swift

  case arrayContainsAny(_: String, _: [Any])

• isLessThan(_:_:)

  Undocumented

  Declaration

  Swift

  case isLessThan(_: String, _: Any)

• isGreaterThan(_:_:)

  Undocumented

  Declaration

  Swift

  case isGreaterThan(_: String, _: Any)

• isLessThanOrEqualTo(_:_:)

  Undocumented

  Declaration

  Swift

  case isLessThanOrEqualTo(_: String, _: Any)

• isGreaterThanOrEqualTo(_:_:)

  Undocumented

  Declaration

  Swift

  case isGreaterThanOrEqualTo(_: String, _: Any)

• orderBy(_:_:)

  Undocumented

  Declaration

  Swift

  case orderBy(_: String, _: Bool)

• limitTo(_:)

  Undocumented

  Declaration

  Swift

  case limitTo(_: Int)

• limitToLast(_:)

  Undocumented

  Declaration

  Swift

  case limitToLast(_: Int)

• whereField(_:isEqualTo:)

  Undocumented

  Declaration

  Swift

  public static func whereField(_ field: String, isEqualTo value: Any) -> QueryPredicate

• whereField(_:isIn:)

  Undocumented

  Declaration

  Swift

  public static func whereField(_ field: String, isIn values: [Any]) -> QueryPredicate

• whereField(_:isNotIn:)

  Undocumented

  Declaration

  Swift

  public static func whereField(_ field: String, isNotIn values: [Any]) -> QueryPredicate

• whereField(_:arrayContains:)

  Undocumented

  Declaration

  Swift

  public static func whereField(_ field: String, arrayContains value: Any) -> QueryPredicate

• whereField(_:arrayContainsAny:)

  Undocumented

  Declaration

  Swift

  public static func whereField(_ field: String,
                                arrayContainsAny values: [Any]) -> QueryPredicate

• whereField(_:isLessThan:)

  Undocumented

  Declaration

  Swift

  public static func whereField(_ field: String, isLessThan value: Any) -> QueryPredicate

• whereField(_:isGreaterThan:)

  Undocumented

  Declaration

  Swift

  public static func whereField(_ field: String, isGreaterThan value: Any) -> QueryPredicate

• whereField(_:isLessThanOrEqualTo:)

  Undocumented

  Declaration

  Swift

  public static func whereField(_ field: String,
                                isLessThanOrEqualTo value: Any) -> QueryPredicate

• whereField(_:isGreaterThanOrEqualTo:)

  Undocumented

  Declaration

  Swift

  public static func whereField(_ field: String,
                                isGreaterThanOrEqualTo value: Any) -> QueryPredicate

• order(by:descending:)

  Undocumented

  Declaration

  Swift

  public static func order(by field: String, descending value: Bool = false) -> QueryPredicate

• limit(to:)

  Undocumented

  Declaration

  Swift

  public static func limit(to value: Int) -> QueryPredicate

• limit(toLast:)

  Undocumented

  Declaration

  Swift

  public static func limit(toLast value: Int) -> QueryPredicate

• where(_:isEqualTo:)

  Undocumented

  Declaration

  Swift

  public static func `where`(_ name: String, isEqualTo value: Any) -> QueryPredicate

• where(_:isIn:)

  Undocumented

  Declaration

  Swift

  public static func `where`(_ name: String, isIn values: [Any]) -> QueryPredicate

• where(_:isNotIn:)

  Undocumented

  Declaration

  Swift

  public static func `where`(_ name: String, isNotIn values: [Any]) -> QueryPredicate

• where(field:arrayContains:)

  Undocumented

  Declaration

  Swift

  public static func `where`(field name: String, arrayContains value: Any) -> QueryPredicate

• where(_:arrayContainsAny:)

  Undocumented

  Declaration

  Swift

  public static func `where`(_ name: String, arrayContainsAny values: [Any]) -> QueryPredicate

• where(_:isLessThan:)

  Undocumented

  Declaration

  Swift

  public static func `where`(_ name: String, isLessThan value: Any) -> QueryPredicate

• where(_:isGreaterThan:)

  Undocumented

  Declaration

  Swift

  public static func `where`(_ name: String, isGreaterThan value: Any) -> QueryPredicate

• where(_:isLessThanOrEqualTo:)

  Undocumented

  Declaration

  Swift

  public static func `where`(_ name: String, isLessThanOrEqualTo value: Any) -> QueryPredicate

• where(_:isGreaterThanOrEqualTo:)

  Undocumented

  Declaration

  Swift

  public static func `where`(_ name: String,
                             isGreaterThanOrEqualTo value: Any) -> QueryPredicate