Firestore能否通过类似firestore.indexes.json的方式定义TTL并自动部署？

目前Firestore没有官方提供类似firestore.indexes.json的配置文件来定义TTL（文档自动过期）策略，但可以通过以下方式实现跨环境（开发/预发布/生产）的自动化部署：

1. 编写自定义部署脚本 #

使用Firebase Admin SDK编写Node.js脚本，根据当前环境动态设置TTL策略，然后在部署流程中执行该脚本。

示例脚本逻辑： #

• 初始化Firebase Admin SDK（根据环境加载对应的服务账号密钥）
• 读取对应环境的TTL配置文件
• 遍历配置中的集合，调用Admin SDK的API创建/更新TTL策略

const admin = require('firebase-admin');
const config = require(`./ttl-config.${process.env.FIREBASE_ENV}.json`);

// 初始化Admin SDK
admin.initializeApp({
  credential: admin.credential.applicationDefault()
});

async function setCollectionTTL(collectionId, fieldName, expireAfterSeconds) {
  const firestore = admin.firestore();
  try {
    await firestore.collection(collectionId).setTTL({
      field: fieldName,
      expireAfterSeconds: expireAfterSeconds
    });
    console.log(`成功为集合 ${collectionId} 设置TTL`);
  } catch (error) {
    console.error(`设置集合 ${collectionId} TTL失败:`, error);
  }
}

// 批量处理所有集合的TTL配置
async function deployTTL() {
  for (const [collectionId, ttlSettings] of Object.entries(config.collections)) {
    await setCollectionTTL(collectionId, ttlSettings.field, ttlSettings.expireAfterSeconds);
  }
}

deployTTL();

2. 集成到Firebase CLI部署流程 #

在firebase.json中添加预部署脚本，让Firebase CLI在部署资源前自动执行TTL设置脚本：

{
  "functions": {
    "predeploy": ["npm --prefix \"$RESOURCE_DIR\" run lint", "node ../scripts/set-ttl.js"]
  }
}

或者直接在部署命令中指定环境并执行脚本：

FIREBASE_ENV=prod firebase deploy --only firestore && node scripts/set-ttl.js

3. 环境配置文件示例 #

创建不同环境的TTL配置文件，区分不同环境的过期规则：

ttl-config.dev.json（开发环境）：

{
  "collections": {
    "temp-data": {
      "field": "expireAt",
      "expireAfterSeconds": 86400 // 1天过期
    },
    "session-logs": {
      "field": "createdAt",
      "expireAfterSeconds": 3600 // 1小时过期
    }
  }
}

ttl-config.prod.json（生产环境）：

{
  "collections": {
    "temp-data": {
      "field": "expireAt",
      "expireAfterSeconds": 604800 // 7天过期
    },
    "session-logs": {
      "field": "createdAt",
      "expireAfterSeconds": 86400 // 1天过期
    }
  }
}

注意事项 #

• 确保执行脚本的账号拥有datastore.databases.update权限（Firebase Admin服务账号默认具备）
• 重复执行脚本不会报错：如果集合已存在TTL策略，再次调用API会直接更新该策略
• 服务账号密钥建议通过环境变量注入，避免硬编码到代码中

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