Firestore触发索引缺失错误时如何自动创建索引

当Firestore查询同时包含相等条件、范围条件和orderBy时，会触发索引缺失错误：

Error: 9 FAILED_PRECONDITION: The query requires an index

控制台提供的手动创建链接无法满足自动化需求，以下是具体解决思路和实现方法：

关于控制台链接的Base64数据 #

你解码的create_composite参数值是**Protocol Buffer（Protobuf）**格式的二进制数据，对应Firestore的CompositeIndex结构定义。解码后的文本是Protobuf的原始字节表示，其中：

• 开头的路径字符串是索引所属的项目、数据库和集合组
• 每个字段块的\x10\x01代表升序（ASCENDING），\x10\x02代表降序（DESCENDING）
• 你的示例中，索引包含三个字段规则：ownerId升序、lastModifiedOn降序、__name__降序

自动化创建索引的可行方式 #

Firestore Admin SDK确实没有提供直接创建复合索引的API，要实现自动化，推荐以下两种方案：

方案1：调用Firestore Admin REST API #

直接通过REST请求创建索引，步骤如下：

1. 构造POST请求，目标地址：

   https://firestore.googleapis.com/v1/projects/[你的项目ID]/databases/(default)/collectionGroups/[集合组名称]/indexes
   

2. 请求体使用JSON格式的CompositeIndex结构，对应你解码后的索引规则：

   {
     "queryScope": "COLLECTION_GROUP",
     "fields": [
       {
         "fieldPath": "ownerId",
         "order": "ASCENDING"
       },
       {
         "fieldPath": "lastModifiedOn",
         "order": "DESCENDING"
       },
       {
         "fieldPath": "__name__",
         "order": "DESCENDING"
       }
     ]
   }
   

3. 使用服务账号密钥生成身份令牌，添加到请求头的Authorization字段（格式：Bearer [令牌]）

方案2：用基础设施即代码（IaC）工具 #

比如Terraform，通过定义资源文件来管理索引，适合集成到CI/CD流水线：

resource "google_firestore_index" "room_composite_index" {
  project     = "mess-booking-app-serverless"
  collection  = "preview_fstr_Rooms"
  query_scope = "COLLECTION_GROUP"

  fields {
    field_path = "ownerId"
    order      = "ASCENDING"
  }

  fields {
    field_path = "lastModifiedOn"
    order      = "DESCENDING"
  }

  fields {
    field_path = "__name__"
    order      = "DESCENDING"
  }
}

执行terraform apply即可自动创建索引，后续索引变更也能通过版本控制管理。

内容的提问来源于stack exchange，提问作者AvirukBasak