基于Pub/Sub函数实现Firestore定时自动备份的技术方案问询

完全不需要依赖App Engine，用定时触发的Cloud Function就能搞定Firestore自动备份，我来给你详细拆解实现步骤：

一、可行性确认 #

Firestore的exportDocuments REST API本身就支持通过服务账号调用，而Cloud Function可以借助Google Application Default Credentials（ADC）自动获取权限，再配合Cloud Scheduler的定时触发，完美实现自动备份流程。

二、权限配置（关键步骤） #

要让Cloud Function能成功调用备份API并写入GCS存储桶，需要给函数的服务账号配置两个核心权限：

• Cloud Datastore Import Export Admin：允许调用Firestore的导出API
• Storage Object Admin（或更细粒度的权限）：允许将备份文件写入目标GCS存储桶

具体操作：

1. 打开Google Cloud IAM控制台，找到你的Cloud Function使用的服务账号（默认是[你的项目ID]@appspot.gserviceaccount.com）
2. 给该账号添加上述两个角色
3. 同时，调用API需要的OAuth scopes是：https://www.googleapis.com/auth/datastore 和 https://www.googleapis.com/auth/cloud-platform，代码里会配置这些范围

三、代码实现（基于googleapis） #

这里用Node.js为例，先安装依赖：

npm install googleapis

然后编写Cloud Function代码：

const { google } = require('googleapis');
const firestore = google.firestore('v1');

exports.scheduledFirestoreBackup = async (event, context) => {
  // 从环境变量获取项目ID，Cloud Function会自动注入
  const projectId = process.env.GCP_PROJECT;
  // 替换成你的Firestore数据库位置（比如us-central1、europe-west1）
  const location = 'us-central1';
  // 替换成你用来存备份的GCS存储桶名称
  const bucketName = 'your-firestore-backups-bucket';
  // 备份文件的前缀，用日期区分不同备份
  const exportPrefix = `firestore-backup-${new Date().toISOString().split('T')[0]}`;

  // 初始化认证，使用Cloud Function的默认服务账号凭证
  const auth = new google.auth.GoogleAuth({
    scopes: [
      'https://www.googleapis.com/auth/datastore',
      'https://www.googleapis.com/auth/cloud-platform'
    ]
  });
  const authClient = await auth.getClient();
  google.options({ auth: authClient });

  try {
    // 调用Firestore导出API
    const response = await firestore.projects.locations.exportDocuments({
      name: `projects/${projectId}/locations/${location}`,
      requestBody: {
        // 指定备份文件的存储路径
        outputUriPrefix: `gs://${bucketName}/${exportPrefix}`,
        // 可选：只备份特定集合，注释掉就备份所有集合
        // collectionIds: ['users', 'orders', 'products']
      }
    });

    console.log('备份任务已启动，任务ID:', response.data.name);
    return response.data;
  } catch (error) {
    console.error('备份失败:', error.message || error);
    throw error;
  }
};

四、设置定时触发器 #

有两种方式配置定时触发：

方式1：Firebase控制台操作 #

1. 打开Firebase控制台，进入Cloud Functions页面
2. 找到你部署的scheduledFirestoreBackup函数
3. 点击“添加触发器”，选择“定时”
4. 设置cron表达式（比如每天凌晨2点触发：0 2 * * *），保存即可

方式2：gcloud命令行 #

先部署函数：

gcloud functions deploy scheduledFirestoreBackup --runtime nodejs18 --trigger-topic firestore-backup-trigger

然后创建定时任务触发这个主题：

gcloud scheduler jobs create pubsub firestore-daily-backup \
  --schedule "0 2 * * *" \
  --topic firestore-backup-trigger \
  --message-body "Trigger Firestore backup"

五、注意事项 #

• 确保你的GCS存储桶已经创建，并且服务账号有写入权限
• Firestore的位置要和实际数据库位置一致，否则会报错
• 备份任务是异步执行的，函数返回后备份还在后台运行，可以通过Google Cloud Logging查看任务状态
• 可以根据需求调整备份频率，或者通过collectionIds指定要备份的特定集合

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