对多个字段概览使用范围和不等式过滤条件的查询

Firestore 支持在单个查询中对多个字段使用范围和不等式过滤条件。您现在可以对多个字段设置范围和不等式条件,并将过滤后逻辑的实现委托给 Firestore,从而简化应用开发。

针对多个字段的范围和不等式过滤条件

以下查询返回年龄大于 35 且身高介于 60 到 70 之间(使用针对年龄和身高的范围过滤条件)的所有用户。

Web v9 模块化

  const q = query(
      collection(db, "users"),
      where('age', '>', 35),
      where('height', '>', 60),
      where('height', '<', 70)
    );

Swift

 let query = db.collection("users")
   .whereField("age", isGreaterThan: 35)
   .whereField("height", isGreaterThan: 60)
   .whereField("height", isLessThan: 70)

Objective-C

 FIRQuery *query = 
  [[[[self.db collectionWithPath:@"users"]
 queryWhereField:@"age" isGreaterThan:@35]
    queryWhereField:@"height" isGreaterThan:@60] 
        queryWhereField:@"height" isLessThan:@70];

Java Android

 Query query = db.collection("users")
  .whereGreaterThan("age", 35)
  .whereGreaterThan("height", 60)
  .whereLessThan("height", 70);

Kotlin+KTX Android

 val query = db.collection("users")
  .whereGreaterThan("age", 35)
  .whereGreaterThan("height", 60)
  .whereLessThan("height", 70)

Java

  db.collection("users")
    .whereGreaterThan("age", 35)
    .whereGreaterThan("height", 60)
    .whereLessThan("height", 70);

Node.js

db.collection("users")
  .where('age', '>', 35),
  .where('height', '>', 60),
  .where('height', '<', 70)

索引注意事项

开始运行查询之前,请确保您已阅读有关查询和 Firestore 数据模型的内容。

在 Firestore 中,查询的 ORDER BY 子句决定了可以使用哪些索引来处理查询。例如,ORDER BY a ASC, b ASC 查询需要对 a ASC, b ASC 字段使用复合索引。

为了优化 Firestore 查询的性能和费用,您应该优化索引中字段的顺序。为此,您应该确保索引按从左到右的顺序排列,以便查询能够提取到可防止扫描无关索引条目的数据集。

假设您想要搜索一组员工,并查找薪资超过 10 万且工作年数大于 0 的员工。根据您对数据集的了解,您知道工资限制条件比经验限制条件更具选择性。可以减少索引扫描次数的理想索引是 (salary [...], experience [...])。因此,快速且经济高效的查询会将 salary 放在 experience 之前,如下所示:

Java

db.collection("employees")
  .whereGreaterThan("salary", 100000)
  .whereGreaterThan("experience", 0)
  .orderBy("salary")
  .orderBy("experience");

Node.js

db.collection("employees")
  .where("salary", ">", 100000)
  .where("experience", ">", 0)
  .orderBy("salary")
  .orderBy("experience");

Python

db.collection("employees")
  .where("salary", ">", 100000)
  .where("experience", ">", 0)
  .order_by("salary")
  .order_by("experience");

优化索引的最佳实践

优化索引时,请注意以下最佳实践。

按等式顺序对索引字段进行排序,后跟选择性最高的范围或不等式字段

Firestore 使用复合索引的最左边字段来满足 orderBy() 查询的第一个字段的等式约束和范围或不等式约束条件(如果有)。这些约束可以减少 Firestore 扫描的索引条目的数量。Firestore 使用索引的其余字段来满足查询的其他范围或不等式约束。这些限制不会减少 Firestore 扫描的索引条目的数量,但会过滤掉不匹配的文档,以减少返回给客户端的文档数量。

如需详细了解如何创建高效索引,请参阅完美索引的定义

按查询限制条件选择性降序对字段排序

为确保 Firestore 为您的查询选择最佳索引,请指定 orderBy() 子句,以按查询限制选择性降序对字段进行排序。选择性越高,所匹配的文档子集就越小,而选择性越低,所匹配的文档子集就越大。与选择性较低的字段相比,确保在索引排序时尽早选择选择性较高的范围或不等式字段。

为了尽量减少 Firestore 通过网络扫描和返回的文档数量,您应始终按查询限制选择性降序对字段进行排序。如果结果集不符合要求的顺序,并且结果集预计很小,您可以实现客户端逻辑,以按照所需的排序方式对其进行重新排序。

例如,假设您想要搜索一组员工以查找薪资超过 10 万的员工,并按员工的工作年数对结果进行排序。如果您预计只有少数员工的薪资会超过 100, 000,那么编写查询的最有效方式如下所示:

Java

db.collection("employees")
  .whereGreaterThan("salary", 100000)
  .orderBy("salary")
  .get()
  .addOnSuccessListener(new OnSuccessListener<QuerySnapshot>() {
        @Override
        public void onSuccess(QuerySnapshot queryDocumentSnapshots) {
          // Order results by `experience`
        }
    });;

Node.js

const querySnapshot = await db.collection('employees')
                              .where("salary", ">", 100000)
                              .orderBy("salary")
                              .get();

// Order results by `experience`

Python

results = db.collection("employees")
            .where("salary", ">", 100000)
            .order_by("salary")
            .stream()

// Order results by `experience`

虽然为查询添加 experience 排序会生成相同的文档集,并避免对客户端上的结果进行重新排序,但查询可能会比先前的查询读取更多无关的索引条目。这是因为 Firestore 始终优先选择索引字段前缀与查询的 order by 子句相匹配的索引。如果将 experience 添加到排序依据子句中,则 Firestore 将选择 (experience [...], salary [...]) 索引来计算查询结果。由于 experience 没有其他约束条件,因此 Firestore 会先读取 employees 集合的所有索引条目,然后再应用 salary 过滤条件来查找最终结果集。这意味着系统会读取不符合 salary 过滤条件的索引条目,从而提高查询的延迟时间和费用。

价格

针对多个字段使用范围和不等式过滤条件的查询根据读取的文档数和读取的索引条目数计费。

如需了解详情,请参阅价格页面。

限制

在对多个字段使用范围和不等式过滤条件进行查询之前,请注意以下限制,除了查询限制

  • 不支持对文档字段使用范围过滤条件或不等式过滤条件且仅对文档键 (__name__) 施加等式约束的查询。
  • Firestore 将范围或不等式字段的数量限制为 10。这是为了防止查询的运行费用过高。

后续步骤