FirebaseFirestoreSwift 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)
  • Undocumented

    Declaration

    Swift

    case isEqualTo(_: String, _: Any)
  • Undocumented

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

    case arrayContains(_: String, _: Any)
  • Undocumented

    Declaration

    Swift

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

    Declaration

    Swift

    case isLessThan(_: String, _: Any)
  • Undocumented

    Declaration

    Swift

    case isGreaterThan(_: String, _: Any)
  • Undocumented

    Declaration

    Swift

    case isLessThanOrEqualTo(_: String, _: Any)
  • Undocumented

    Declaration

    Swift

    case isGreaterThanOrEqualTo(_: String, _: Any)
  • Undocumented

    Declaration

    Swift

    case orderBy(_: String, _: Bool)
  • Undocumented

    Declaration

    Swift

    case limitTo(_: Int)
  • Undocumented

    Declaration

    Swift

    case limitToLast(_: Int)
  • Undocumented

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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